Merge pull request #2 from icebaker/ib-adapters

adding support for adapters

7 files changed, 277 insertions, 84 deletions

diff --git a/spec/data/cartridges/affixes.yml b/spec/data/cartridges/affixes.yml
new file mode 100644
index 0000000..f593cfe
--- /dev/null
+++ b/spec/data/cartridges/affixes.yml
@@ -0,0 +1,22 @@
+---
+interfaces:
+  input:
+    prefix: A
+    suffix: B
+  output:
+    prefix: C
+    suffix: D
+  repl:
+    input:
+      prefix: E
+      suffix: F
+    output:
+      prefix: G
+      suffix: H
+  eval:
+    input:
+      prefix: I
+      suffix: J
+    output:
+      prefix: K
+      suffix: L
diff --git a/spec/data/cartridges/streaming.yml b/spec/data/cartridges/streaming.yml
new file mode 100644
index 0000000..8234d34
--- /dev/null
+++ b/spec/data/cartridges/streaming.yml
@@ -0,0 +1,14 @@
+---
+interfaces:
+  output:
+    stream: true
+  repl:
+    output:
+      stream: true
+  eval:
+    output:
+      stream: true
+
+provider:
+  settings:
+    stream: true
diff --git a/spec/logic/cartridge/affixes_spec.rb b/spec/logic/cartridge/affixes_spec.rb
new file mode 100644
index 0000000..8f08e1d
--- /dev/null
+++ b/spec/logic/cartridge/affixes_spec.rb
@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require_relative '../../../logic/cartridge/affixes'
+
+RSpec.describe NanoBot::Logic::Cartridge::Affixes do
+  context 'interfaces' do
+    let(:cartridge) { load_cartridge('affixes.yml') }
+
+    it 'gets the expected affixes' do
+      expect(described_class.get(cartridge, :repl, :input, :prefix)).to eq('E')
+      expect(described_class.get(cartridge, :repl, :input, :suffix)).to eq('F')
+      expect(described_class.get(cartridge, :repl, :output, :prefix)).to eq('G')
+      expect(described_class.get(cartridge, :repl, :output, :suffix)).to eq('H')
+
+      expect(described_class.get(cartridge, :eval, :input, :prefix)).to eq('I')
+      expect(described_class.get(cartridge, :eval, :input, :suffix)).to eq('J')
+      expect(described_class.get(cartridge, :eval, :output, :prefix)).to eq('K')
+      expect(described_class.get(cartridge, :eval, :output, :suffix)).to eq('L')
+    end
+  end
+
+  context 'interfaces fallback' do
+    let(:cartridge) { load_cartridge('affixes.yml') }
+
+    it 'gets the expected affixes' do
+      cartridge[:interfaces][:repl][:input].delete(:prefix)
+      cartridge[:interfaces][:repl][:input].delete(:suffix)
+      cartridge[:interfaces][:eval][:input].delete(:prefix)
+      cartridge[:interfaces][:eval][:input].delete(:suffix)
+
+      cartridge[:interfaces][:repl][:output].delete(:prefix)
+      cartridge[:interfaces][:repl][:output].delete(:suffix)
+      cartridge[:interfaces][:eval][:output].delete(:prefix)
+      cartridge[:interfaces][:eval][:output].delete(:suffix)
+
+      expect(described_class.get(cartridge, :repl, :input, :prefix)).to eq('A')
+      expect(described_class.get(cartridge, :repl, :input, :suffix)).to eq('B')
+      expect(described_class.get(cartridge, :repl, :output, :prefix)).to eq('C')
+      expect(described_class.get(cartridge, :repl, :output, :suffix)).to eq('D')
+
+      expect(described_class.get(cartridge, :eval, :input, :prefix)).to eq('A')
+      expect(described_class.get(cartridge, :eval, :input, :suffix)).to eq('B')
+      expect(described_class.get(cartridge, :eval, :output, :prefix)).to eq('C')
+      expect(described_class.get(cartridge, :eval, :output, :suffix)).to eq('D')
+    end
+  end
+
+  context 'interfaces nil' do
+    let(:cartridge) { load_cartridge('affixes.yml') }
+
+    it 'gets the expected affixes' do
+      cartridge[:interfaces][:repl][:input][:prefix] = nil
+      cartridge[:interfaces][:repl][:input][:suffix] = nil
+      cartridge[:interfaces][:eval][:input][:prefix] = nil
+      cartridge[:interfaces][:eval][:input][:suffix] = nil
+
+      cartridge[:interfaces][:repl][:output][:prefix] = nil
+      cartridge[:interfaces][:repl][:output][:suffix] = nil
+      cartridge[:interfaces][:eval][:output][:prefix] = nil
+      cartridge[:interfaces][:eval][:output][:suffix] = nil
+
+      expect(described_class.get(cartridge, :repl, :input, :prefix)).to be_nil
+      expect(described_class.get(cartridge, :repl, :input, :suffix)).to be_nil
+      expect(described_class.get(cartridge, :repl, :output, :prefix)).to be_nil
+      expect(described_class.get(cartridge, :repl, :output, :suffix)).to be_nil
+
+      expect(described_class.get(cartridge, :eval, :input, :prefix)).to be_nil
+      expect(described_class.get(cartridge, :eval, :input, :suffix)).to be_nil
+      expect(described_class.get(cartridge, :eval, :output, :prefix)).to be_nil
+      expect(described_class.get(cartridge, :eval, :output, :suffix)).to be_nil
+    end
+  end
+
+  context 'default' do
+    let(:cartridge) { {} }
+
+    it 'gets the expected affixes' do
+      expect(described_class.get(cartridge, :repl, :input, :prefix)).to be_nil
+      expect(described_class.get(cartridge, :repl, :input, :suffix)).to be_nil
+      expect(described_class.get(cartridge, :repl, :output, :prefix)).to eq("\n")
+      expect(described_class.get(cartridge, :repl, :output, :suffix)).to eq("\n")
+
+      expect(described_class.get(cartridge, :eval, :input, :prefix)).to be_nil
+      expect(described_class.get(cartridge, :eval, :input, :suffix)).to be_nil
+      expect(described_class.get(cartridge, :eval, :output, :prefix)).to be_nil
+      expect(described_class.get(cartridge, :eval, :output, :suffix)).to eq("\n")
+    end
+  end
+end
diff --git a/spec/logic/cartridge/interaction_spec.rb b/spec/logic/cartridge/interaction_spec.rb
new file mode 100644
index 0000000..347ac45
--- /dev/null
+++ b/spec/logic/cartridge/interaction_spec.rb
@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require_relative '../../../logic/cartridge/interaction'
+
+RSpec.describe NanoBot::Logic::Cartridge::Interaction do
+  context 'input' do
+    let(:cartridge) { load_cartridge('affixes.yml') }
+
+    it 'prepares the input' do
+      expect(described_class.input(cartridge, :repl, 'hello')).to eq(
+        { content: 'hello', fennel: nil, lua: nil, prefix: 'E', suffix: 'F' }
+      )
+
+      expect(described_class.input({}, :repl, 'hello')).to eq(
+        { content: 'hello', fennel: nil, lua: nil, prefix: nil, suffix: nil }
+      )
+
+      expect(described_class.input(cartridge, :eval, 'hello')).to eq(
+        { content: 'hello', fennel: nil, lua: nil, prefix: 'I', suffix: 'J' }
+      )
+
+      expect(described_class.input({}, :eval, 'hello')).to eq(
+        { content: 'hello', fennel: nil, lua: nil, prefix: nil, suffix: nil }
+      )
+    end
+
+    it 'prepares the non-streamming output' do
+      expect(described_class.output(cartridge, :repl, { message: 'hello' }, false, true)).to eq(
+        { message: { content: 'hello', fennel: nil, lua: nil } }
+      )
+
+      expect(described_class.output({}, :repl, { message: 'hello' }, false, true)).to eq(
+        { message: { content: 'hello', fennel: nil, lua: nil } }
+      )
+
+      expect(described_class.output(cartridge, :eval, { message: 'hello' }, false, true)).to eq(
+        { message: { content: 'hello', fennel: nil, lua: nil } }
+      )
+
+      expect(described_class.output({}, :eval, { message: 'hello' }, false, true)).to eq(
+        { message: { content: 'hello', fennel: nil, lua: nil } }
+      )
+    end
+  end
+end
diff --git a/spec/logic/cartridge/streaming_spec.rb b/spec/logic/cartridge/streaming_spec.rb
new file mode 100644
index 0000000..e5ad012
--- /dev/null
+++ b/spec/logic/cartridge/streaming_spec.rb
@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require_relative '../../../logic/cartridge/streaming'
+
+RSpec.describe NanoBot::Logic::Cartridge::Streaming do
+  context 'provider' do
+    let(:cartridge) { load_cartridge('streaming.yml') }
+
+    it 'checks if stream is enabled' do
+      cartridge[:provider][:settings][:stream] = false
+      expect(described_class.enabled?(cartridge, :repl)).to be(false)
+    end
+  end
+
+  context 'repl' do
+    let(:cartridge) { load_cartridge('streaming.yml') }
+
+    it 'checks if stream is enabled' do
+      cartridge[:interfaces][:repl][:output][:stream] = false
+      expect(described_class.enabled?(cartridge, :repl)).to be(false)
+    end
+  end
+
+  context 'interface + repl' do
+    let(:cartridge) { load_cartridge('streaming.yml') }
+
+    it 'checks if stream is enabled' do
+      cartridge[:interfaces][:output][:stream] = false
+      cartridge[:interfaces][:repl][:output][:stream] = true
+      expect(described_class.enabled?(cartridge, :repl)).to be(true)
+    end
+  end
+
+  context 'interface' do
+    let(:cartridge) { load_cartridge('streaming.yml') }
+
+    it 'checks if stream is enabled' do
+      cartridge[:interfaces][:output][:stream] = false
+      cartridge[:interfaces][:repl][:output].delete(:stream)
+      expect(described_class.enabled?(cartridge, :repl)).to be(false)
+    end
+  end
+
+  context '- repl' do
+    let(:cartridge) { load_cartridge('streaming.yml') }
+
+    it 'checks if stream is enabled' do
+      cartridge[:interfaces][:repl][:output].delete(:stream)
+      expect(described_class.enabled?(cartridge, :repl)).to be(true)
+    end
+  end
+
+  context '- interface' do
+    let(:cartridge) { load_cartridge('streaming.yml') }
+
+    it 'checks if stream is enabled' do
+      cartridge[:interfaces][:output].delete(:stream)
+      cartridge[:interfaces][:repl][:output].delete(:stream)
+      expect(described_class.enabled?(cartridge, :repl)).to be(true)
+    end
+  end
+
+  context '- provider' do
+    let(:cartridge) { load_cartridge('streaming.yml') }
+
+    it 'checks if stream is enabled' do
+      cartridge[:provider][:settings].delete(:stream)
+      cartridge[:interfaces][:output].delete(:stream)
+      cartridge[:interfaces][:repl][:output].delete(:stream)
+      expect(described_class.enabled?(cartridge, :repl)).to be(true)
+    end
+  end
+end
diff --git a/spec/logic/helpers/hash_spec.rb b/spec/logic/helpers/hash_spec.rb
new file mode 100644
index 0000000..09012c8
--- /dev/null
+++ b/spec/logic/helpers/hash_spec.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../../../logic/helpers/hash'
+
+RSpec.describe NanoBot::Logic::Helpers::Hash do
+  it 'symbolizes keys' do
+    expect(described_class.symbolize_keys({ 'a' => 'b', 'c' => { 'd' => ['e'] } })).to eq(
+      { a: 'b', c: { d: ['e'] } }
+    )
+
+    expect(described_class.fetch({ a: 'b', c: { d: ['e'] } }, %i[c d])).to eq(
+      ['e']
+    )
+
+    expect(described_class.fetch({ a: 'b', c: { d: ['e'] } }, %i[c e])).to be_nil
+
+    expect(described_class.fetch({ a: 'b', c: { d: ['e'] } }, %i[a b])).to be_nil
+  end
+end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
index 4f8c8d9..ad9038d 100644
--- a/spec/spec_helper.rb
+++ b/spec/spec_helper.rb
@@ -1,98 +1,23 @@
 # frozen_string_literal: true
 
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause
-# this file to always be loaded, without a need to explicitly require it in any
-# files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need
-# it.
-#
-# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'yaml'
+
+require_relative '../logic/helpers/hash'
+
 RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
   config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
   config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
     mocks.verify_partial_doubles = true
   end
 
-  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
-  # have no way to turn it off -- the option exists only for backwards
-  # compatibility in RSpec 3). It causes shared context metadata to be
-  # inherited by the metadata hash of host groups and examples, rather than
-  # triggering implicit auto-inclusion in groups with matching metadata.
   config.shared_context_metadata_behavior = :apply_to_host_groups
+end
+
+def load_cartridge(path)
+  cartridge = YAML.safe_load(File.read("spec/data/cartridges/#{path}"), permitted_classes: [Symbol])
 
-  # The settings below are suggested to provide a good initial experience
-  # with RSpec, but feel free to customize to your heart's content.
-  #   # This allows you to limit a spec run to individual examples or groups
-  #   # you care about by tagging them with `:focus` metadata. When nothing
-  #   # is tagged with `:focus`, all examples get run. RSpec also provides
-  #   # aliases for `it`, `describe`, and `context` that include `:focus`
-  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
-  #   config.filter_run_when_matching :focus
-  #
-  #   # Allows RSpec to persist some state between runs in order to support
-  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
-  #   # you configure your source control system to ignore this file.
-  #   config.example_status_persistence_file_path = "spec/examples.txt"
-  #
-  #   # Limits the available syntax to the non-monkey patched syntax that is
-  #   # recommended. For more details, see:
-  #   # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
-  #   config.disable_monkey_patching!
-  #
-  #   # This setting enables warnings. It's recommended, but in some cases may
-  #   # be too noisy due to issues in dependencies.
-  #   config.warnings = true
-  #
-  #   # Many RSpec users commonly either run the entire suite or an individual
-  #   # file, and it's useful to allow more verbose output when running an
-  #   # individual spec file.
-  #   if config.files_to_run.one?
-  #     # Use the documentation formatter for detailed output,
-  #     # unless a formatter has already been configured
-  #     # (e.g. via a command-line flag).
-  #     config.default_formatter = "doc"
-  #   end
-  #
-  #   # Print the 10 slowest examples and example groups at the
-  #   # end of the spec run, to help surface which specs are running
-  #   # particularly slow.
-  #   config.profile_examples = 10
-  #
-  #   # Run specs in random order to surface order dependencies. If you find an
-  #   # order dependency and want to debug it, you can fix the order by providing
-  #   # the seed, which is printed after each run.
-  #   #     --seed 1234
-  #   config.order = :random
-  #
-  #   # Seed global randomization in this process using the `--seed` CLI option.
-  #   # Setting this allows you to use `--seed` to deterministically reproduce
-  #   # test failures related to randomization by passing the same `--seed` value
-  #   # as the one that triggered the failure.
-  #   Kernel.srand config.seed
+  NanoBot::Logic::Helpers::Hash.symbolize_keys(cartridge)
 end