nucleon 0.2.2 → 0.2.3

data/spec/nucleon/test.rb

@@ -0,0 +1,59 @@
+module Nucleon
+module Plugin
+class Test < Nucleon.plugin_class(:nucleon, :base)
+
+  #*****************************************************************************
+  # Initialization
+
+  def normalize(reset)
+    super
+  end
+
+  #*****************************************************************************
+  # Plugin accessors / modifiers
+
+  def test1
+    get(:test1, 1)
+  end
+
+  def test1=test
+    set(:test1, test)
+  end
+
+
+  def test2
+    get(:test2, 2)
+  end
+
+  def test2=test
+    set(:test2, test)
+  end
+
+
+  #*****************************************************************************
+  # Plugin test interface
+
+  def say_hello(to_who)
+    logger.info('executing say_hello')
+    yield if block_given?
+    logger.info('goodbye')
+  end
+
+  def math(a, b)
+    result = 0
+    logger.info('executing math')
+    result = yield if block_given?
+    logger.info('goodbye')
+    result
+  end
+
+  def exec_block(a, b, &code)
+    result = nil
+    logger.info('executing exec_block')
+    result = yield if block_given?
+    logger.info('goodbye')
+    result
+  end
+end
+end
+end

data/spec/nucleon/test/first.rb

@@ -0,0 +1,28 @@
+module Nucleon
+module Test
+class First < Nucleon.plugin_class(:nucleon, :test)
+
+  #*****************************************************************************
+  # Plugin test interface
+
+  def say_hello(to_who)
+    super do
+      info("Hello there #{to_who}", { :i18n => false })
+    end
+  end
+
+  def math(a, b)
+    super do
+      a * b * test1 * test2
+    end
+  end
+
+  def exec_block(a, b, &code)
+    super do
+      z = -1
+      z = code.call(test1, test2, a, b, z) if code
+    end
+  end
+end
+end
+end

data/spec/nucleon/test/second.rb

@@ -0,0 +1,28 @@
+module Nucleon
+module Test
+class Second < Nucleon.plugin_class(:nucleon, :test)
+
+  #*****************************************************************************
+  # Plugin test interface
+
+  def say_hello(to_who)
+    super do
+      info("Greetings #{to_who}", { :i18n => false })
+    end
+  end
+
+  def math(a, b)
+    super do
+      a + b + test1 + test2
+    end
+  end
+
+  def exec_block(a, b, &code)
+    super do
+      z = -20
+      z = code.call(test1, test2, a, b, z) if code
+    end
+  end
+end
+end
+end

data/spec/nucleon_codes.rb

@@ -0,0 +1,98 @@
+
+RSpec.shared_context "nucleon_codes" do
+
+  #*****************************************************************************
+  # Code initialization
+
+  let(:codes_registry_clean) do {
+      :success            => 0,
+      :help_wanted        => 1,
+      :unknown_status     => 2,
+      :action_unprocessed => 3,
+      :batch_error        => 4,
+      :validation_failed  => 5,
+      :access_denied      => 6
+    }
+  end
+
+  let(:codes_status_index_clean) do {
+      0 => "success",
+      1 => "help_wanted",
+      2 => "unknown_status",
+      3 => "action_unprocessed",
+      4 => "batch_error",
+      5 => "validation_failed",
+      6 => "access_denied"
+    }
+  end
+
+
+  let(:codes_registry_custom) do {
+      :success            => 0,
+      :help_wanted        => 1,
+      :unknown_status     => 2,
+      :action_unprocessed => 3,
+      :batch_error        => 4,
+      :validation_failed  => 5,
+      :access_denied      => 6,
+      :good               => 7,
+      :bad                => 8,
+      :ok                 => 9,
+      :wow                => 10,
+      :whew               => 11
+    }
+  end
+
+  let(:codes_status_index_custom) do {
+      0 => "success",
+      1 => "help_wanted",
+      2 => "unknown_status",
+      3 => "action_unprocessed",
+      4 => "batch_error",
+      5 => "validation_failed",
+      6 => "access_denied",
+      7 => "good",
+      8 => "bad",
+      9 => "ok",
+      10 => "wow",
+      11 => "whew"
+    }
+  end
+
+
+  before(:each) do
+    # Set custom codes before every test
+    Nucleon::Codes.reset # 0 - 6 reserved
+    Nucleon::Codes.codes(:good, :bad, :ok, :wow, :whew) # 7 - ?
+  end
+
+
+  #*****************************************************************************
+  # Code test utilities
+
+  def codes_rendered_status(status_code = nil)
+    # Basically copied from the Codes class to ensure parity over time.
+    if ! status_code.nil? && codes_status_index_custom.has_key?(status_code)
+      status_name = codes_status_index_custom[status_code]
+    else
+      status_name = codes_status_index_custom[codes_registry_custom[:unknown_status]]
+    end
+    sprintf(" [ %3i ] - %s\n", status_code, status_name.gsub(/_/, ' ').capitalize)
+  end
+
+  def codes_rendered_index(status_code = nil)
+    # Basically copied from the Codes class to ensure parity over time.
+    output = "Status index:\n"
+    codes_status_index_custom.each do |code, name|
+      name = name.gsub(/_/, ' ').capitalize
+
+      if ! status_code.nil? && status_code == code
+        output << sprintf(" [ %3i ] - %s\n", code, name)
+      else
+        output << sprintf("   %3i   - %s\n", code, name)
+      end
+    end
+    output << "\n"
+    output
+  end
+end

data/spec/nucleon_config.rb

@@ -0,0 +1,523 @@
+
+RSpec.shared_context "nucleon_config" do
+
+  #*****************************************************************************
+  # Context test data
+
+  let(:config_context_data) do {
+      :context1 => {
+        :greeting => "hello",
+        :nestedkey => {
+          :a => {
+            :test1 => 'yes',
+            :test2 => [ 'please' ]
+          },
+          :x => 'goodbye'
+        },
+        :other => "Something else",
+        :array => [ 128 ]
+      },
+      :context2 => {
+        :greeting  => "hello world",
+        :something => "test",
+        :nestedkey => {
+          :a => {
+            :test1 => [ 23, 55 ]
+          },
+          :b => 'oddball'
+        },
+        :array => [ 128, 1024 ]
+      },
+      :prefix1_context1 => {
+        :greeting  => "how are you",
+        :something => "test5"
+      },
+      :prefix2_context3 => {
+        :thought => "hope this test passes"
+      }
+    }
+  end
+
+  let(:config_context_default_data) do {
+      :greeting   => 'howdy',
+      :array      => [ 4545, :hello ],
+      :extra => 'this should not be set'
+    }
+  end
+
+  let(:config_contexts1) { [ :context1, "context3" ] }
+  let(:config_context_hierarchy1) { :prefix2 }
+
+  let(:config_context_options1) do {
+      :greeting => "hello",
+      :nestedkey => {
+        :a => {
+          :test1 => 'yes',
+          :test2 => [ 'please' ]
+        },
+        :x => 'goodbye'
+      },
+      :other => "Something else",
+      :array => [ 128 ],
+      :thought  => "hope this test passes"
+    }
+  end
+
+  let(:config_flat_contexts1) { [ :context1, "context2" ] }
+
+  let(:config_flat_context_options1) do {
+      :greeting  => "hello world",
+      :nestedkey => {
+        :a => {
+          :test1 => [ 23, 55 ],
+          :test2 => [ 'please' ]
+        },
+        :x => 'goodbye',
+        :b => 'oddball'
+      },
+      :other => "Something else",
+      :array => [ 128, 1024 ],
+      :something => "test"
+    }
+  end
+
+  let(:config_contexts2) { [ "context1", :context2, :context3 ] }
+  let(:config_context_hierarchy2) { [ :prefix1, "prefix2" ] }
+
+  let(:config_context_options2) do {
+      :greeting  => "how are you",
+      :nestedkey => {
+        :a => {
+          :test1 => [ 23, 55 ],
+          :test2 => [ 'please' ]
+        },
+        :b => 'oddball',
+        :x => 'goodbye'
+      },
+      :other => "Something else",
+      :array => [ 128, 1024 ],
+      :something => "test5",
+      :thought   => "hope this test passes"
+    }
+  end
+
+  let(:config_contexts3) { :context1 }
+  let(:config_context_hierarchy3) { [ :prefix1, "prefix2" ] }
+
+  let(:config_context_options3) do {
+      :greeting  => "how are you",
+      :nestedkey => {
+        :a => {
+          :test1 => "yes",
+          :test2 => [ 'please' ]
+        },
+        :x => 'goodbye'
+      },
+      :other => "Something else",
+      :array => [ 128 ],
+      :something => "test5"
+    }
+  end
+
+  let(:config_flat_contexts2) { "context2" }
+
+  let(:config_flat_context_options2) do {
+      :greeting  => "hello world",
+      :something => "test",
+      :nestedkey => {
+        :a => {
+          :test1 => [ 23, 55 ]
+        },
+        :b => 'oddball'
+      },
+      :array => [ 128, 1024 ]
+    }
+  end
+
+
+  before(:each) do
+    Nucleon::Config.clear_options
+    config_context_data.each do |context, options|
+      Nucleon::Config.set_options(context, options)
+    end
+  end
+
+
+  #*****************************************************************************
+  # Source hashes
+
+  let(:config_hash1) do {
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => [ 'no' ]
+        },
+        :x => 'hello',
+        :y => 'again',
+        :z => 'im done now'
+      },
+      :other => [ 1, 2, 3, 4 ],
+      :array => [ 3, 6, 9 ]
+    }
+  end
+
+  let(:config_hash2) do {
+      :testkey1 => 'testval1',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => [ 'yes' ],
+          :test3 => true
+        },
+        :z => 'whew'
+      },
+      :other => 56,
+      :array => [ 12 ]
+    }
+  end
+
+  #*****************************************************************************
+  # Data hashes (symbolization and stingification)
+
+  let(:config_mixed_hash) do {
+      "stringkey" => true,
+      :symbolkey  => true,
+      "inner" => {
+        :good => "almost",
+        "bad" => "maybe sometimes"
+      }
+    }
+  end
+
+  let(:config_symbolized_hash) do {
+      :stringkey => true,
+      :symbolkey => true,
+      :inner => {
+        :good => "almost",
+        :bad  => "maybe sometimes"
+      }
+    }
+  end
+
+  let(:config_stringified_hash) do {
+      "stringkey" => true,
+      "symbolkey" => true,
+      "inner" => {
+        "good" => "almost",
+        "bad"  => "maybe sometimes"
+      }
+    }
+  end
+
+  #*****************************************************************************
+  # Merge results (hash1 overrides context options)
+
+  let(:config_hash_context1_force_basic_merge) do {
+      :greeting => "hello",
+      :thought  => "hope this test passes",
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => [ 'no' ]
+        },
+        :x => 'hello',
+        :y => 'again',
+        :z => 'im done now'
+      },
+      :other => [ 1, 2, 3, 4 ],
+      :array => [ 3, 6, 9 ],
+      :extra => 'this should not be set'
+    }
+  end
+
+  let(:config_hash_context1_force_deep_merge) do {
+      :greeting => "hello",
+      :thought  => "hope this test passes",
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => [ "please", "no" ]
+        },
+        :x => 'hello',
+        :y => 'again',
+        :z => 'im done now'
+      },
+      :other => [ 1, 2, 3, 4 ],
+      :array => [ 4545, :hello, 128, 3, 6, 9 ],
+      :extra => 'this should not be set'
+    }
+  end
+
+  let(:config_hash_context1_no_force_basic_merge) do {
+      :greeting => "hello",
+      :thought  => "hope this test passes",
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => [ 'no' ]
+        },
+        :x => 'hello',
+        :y => 'again',
+        :z => 'im done now'
+      },
+      :other => [ 1, 2, 3, 4 ],
+      :array => [ 3, 6, 9 ],
+      :extra => 'this should not be set'
+    }
+  end
+
+  let(:config_hash_context1_no_force_deep_merge) do {
+      :greeting => "howdy",
+      :thought  => "hope this test passes",
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'yes',
+          :test2 => [ 'please', 'no' ]
+        },
+        :x => 'goodbye',
+        :y => 'again',
+        :z => 'im done now'
+      },
+      :other => "Something else",
+      :array => [ 4545, :hello, 128, 3, 6, 9 ],
+      :extra => 'this should not be set'
+    }
+  end
+
+
+  let(:config_hash_context2_force_basic_merge) do {
+      :greeting  => "how are you",
+      :something => "test5",
+      :thought   => "hope this test passes",
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => [ 'no' ]
+        },
+        :x => 'hello',
+        :y => 'again',
+        :z => 'im done now'
+      },
+      :other => [ 1, 2, 3, 4 ],
+      :array => [ 3, 6, 9 ],
+      :extra => 'this should not be set'
+    }
+  end
+
+  let(:config_hash_context2_force_deep_merge) do {
+      :greeting  => "how are you",
+      :something => "test5",
+      :thought   => "hope this test passes",
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => ["please", "no"]
+        },
+        :x => 'hello',
+        :b => "oddball",
+        :y => 'again',
+        :z => 'im done now'
+      },
+      :other => [ 1, 2, 3, 4 ],
+      :array => [ 4545, :hello, 128, 1024, 3, 6, 9 ],
+      :extra => 'this should not be set'
+    }
+  end
+
+  let(:config_hash_context2_no_force_basic_merge) do {
+      :greeting  => "how are you",
+      :something => "test5",
+      :thought   => "hope this test passes",
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => [ 'no' ]
+        },
+        :x => 'hello',
+        :y => 'again',
+        :z => 'im done now'
+      },
+      :other => [ 1, 2, 3, 4 ],
+      :array => [ 3, 6, 9 ],
+      :extra => 'this should not be set'
+    }
+  end
+
+  let(:config_hash_context2_no_force_deep_merge) do {
+      :greeting  => "howdy",
+      :something => "test5",
+      :thought   => "hope this test passes",
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => [ 23, 55 ],
+          :test2 => [ "please", "no" ]
+        },
+        :x => 'goodbye',
+        :b => "oddball",
+        :y => 'again',
+        :z => 'im done now'
+      },
+      :other => "Something else",
+      :array => [ 4545, :hello, 128, 1024, 3, 6, 9 ],
+      :extra => 'this should not be set'
+    }
+  end
+
+
+  let(:config_hash_context3_force_basic_merge) do {
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => [ 'no' ]
+        },
+        :x => 'hello',
+        :y => 'again',
+        :z => 'im done now'
+      },
+      :other => [ 1, 2, 3, 4 ],
+      :array => [ 3, 6, 9 ],
+      :greeting  => "how are you",
+      :something => "test5",
+      :extra => 'this should not be set'
+    }
+  end
+
+  let(:config_hash_context3_force_deep_merge) do {
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => [ 'please', 'no' ]
+        },
+        :x => 'hello',
+        :y => 'again',
+        :z => 'im done now'
+      },
+      :other => [ 1, 2, 3, 4 ],
+      :array => [ 4545, :hello, 128, 3, 6, 9 ],
+      :greeting  => "how are you",
+      :something => "test5",
+      :extra => 'this should not be set'
+    }
+  end
+
+  let(:config_hash_context3_no_force_basic_merge) do {
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => [ 'no' ]
+        },
+        :x => 'hello',
+        :y => 'again',
+        :z => 'im done now'
+      },
+      :other => [ 1, 2, 3, 4 ],
+      :array => [ 3, 6, 9 ],
+      :greeting  => "how are you",
+      :something => "test5",
+      :extra => 'this should not be set'
+    }
+  end
+
+  let(:config_hash_context3_no_force_deep_merge) do {
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'yes',
+          :test2 => [ 'please', 'no' ]
+        },
+        :x => 'goodbye',
+        :y => 'again',
+        :z => 'im done now'
+      },
+      :other => "Something else",
+      :array => [ 4545, :hello, 128, 3, 6, 9 ],
+      :greeting  => "howdy",
+      :something => "test5",
+      :extra => 'this should not be set'
+    }
+  end
+
+
+  #*****************************************************************************
+  # Merge results (hash2 overrides hash1)
+
+  let(:config_hash_no_force_basic_merge) do {
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => [ 'yes' ],
+          :test3 => true
+        },
+        :z => 'whew'
+      },
+      :other => 56,
+      :array => [ 12 ],
+      :testkey1 => 'testval1'
+    }
+  end
+
+  let(:config_hash_force_basic_merge) do {
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => [ 'yes' ],
+          :test3 => true
+        },
+        :z => 'whew'
+      },
+      :other => 56,
+      :array => [ 12 ],
+      :testkey1 => 'testval1'
+    }
+  end
+
+  let(:config_hash_no_force_deep_merge) do {
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => [ 'no', 'yes' ],
+          :test3 => true
+        },
+        :x => 'hello',
+        :y => 'again',
+        :z => 'im done now'
+      },
+      :other => [ 1, 2, 3, 4 ],
+      :array => [ 3, 6, 9, 12 ],
+      :testkey1 => 'testval1'
+    }
+  end
+
+  let(:config_hash_force_deep_merge) do {
+      :testkey => 'testval',
+      :nestedkey => {
+        :a => {
+          :test1 => 'oh',
+          :test2 => [ 'no', 'yes' ],
+          :test3 => true
+        },
+        :x => 'hello',
+        :y => 'again',
+        :z => 'whew'
+      },
+      :other => 56,
+      :array => [ 3, 6, 9, 12 ],
+      :testkey1 => 'testval1'
+    }
+  end
+end