ns-options 0.1.0

data/test/unit/ns-options/option_test.rb

@@ -0,0 +1,191 @@
+require 'assert'
+
+class NsOptions::Option
+
+  class BaseTest < Assert::Context
+    desc "NsOptions::Option"
+    setup do
+      @rules = { :default => "development", :require => true }
+      @option = NsOptions::Option.new(:stage, String, @rules)
+    end
+    subject{ @option }
+
+    should have_accessors :name, :value, :type_class, :rules
+
+    should "have set the name" do
+      assert_equal "stage", subject.name
+    end
+    should "have set the type class" do
+      assert_equal String, subject.type_class
+    end
+    should "have set the rules" do
+      assert_equal(@rules, subject.rules)
+    end
+    should "have defaulted value based on the rules" do
+      assert_equal subject.rules[:default], subject.value
+    end
+    should "return true with a call to #required?" do
+      assert_equal true, subject.required?
+    end
+  end
+
+  class IsSetTest < BaseTest
+    desc "is_set method"
+    setup do
+      @type_class = Class.new(String) do
+
+        def is_set?
+          self.gsub(/\s+/, '').size != 0
+        end
+
+      end
+      @special = NsOptions::Option.new(:no_blank, @type_class)
+    end
+
+    should "return true/false appropriately for a boolean option with true or false" do
+      @option.value = true
+      assert_equal true, @option.is_set?
+      @option.value = false
+      assert_equal true, @option.is_set?
+      @option.value = nil
+      assert_equal false, @option.is_set?
+    end
+    should "return true/false based on type class's is_set method" do
+      @special.value = "not blank"
+      assert_equal true, @special.is_set?
+      @special.value = " "
+      assert_equal false, @special.is_set?
+    end
+  end
+
+  class EqualityOperatorTest < BaseTest
+    desc "== operator"
+    setup do
+      @first = NsOptions::Option.new(:stage, String)
+      @first.value = "test"
+      @second = NsOptions::Option.new(:stage, String)
+      @second.value = "test"
+    end
+
+    should "return true if their attributes are equal" do
+      [ :name, :type_class, :value, :rules ].each do |attribute|
+        assert_equal @first.send(attribute), @second.send(attribute)
+      end
+      assert_equal @first, @second
+      @first.value = "staging"
+      assert_not_equal @first, @second
+    end
+  end
+
+  class WithNativeTypeClassTest < BaseTest
+    desc "with a native type class (Float)"
+    setup do
+      @option = NsOptions::Option.new(:something, Float)
+    end
+    subject{ @option }
+
+    should "allow setting it's value with a float" do
+      new_value = 12.5
+      subject.value = new_value
+      assert_equal new_value, subject.value
+    end
+    should "allow setting it's value with a string and convert it" do
+      new_value = "13.4"
+      subject.value = new_value
+      assert_equal new_value.to_f, subject.value
+    end
+    should "allow setting it's value with an integer and convert it" do
+      new_value = 1
+      subject.value = new_value
+      assert_equal new_value.to_f, subject.value
+    end
+  end
+
+  class WithTypeClassFixnumTest < BaseTest
+    desc "with the Fixnum as a type class (happens through dynamic writers)"
+    setup do
+      @option = NsOptions::Option.new(:something, Fixnum)
+    end
+    subject{ @option }
+
+    should "have used Integer for it's type class" do
+      assert_equal Integer, subject.type_class
+    end
+    should "allow setting it's value with an integer" do
+      new_value = 1
+      subject.value = new_value
+      assert_equal new_value, subject.value
+    end
+    should "allow setting it's value with a float and convert it" do
+      new_value = 12.5
+      subject.value = new_value
+      assert_equal new_value.to_i, subject.value
+    end
+    should "allow setting it's value with a string and convert it" do
+      new_value = "13"
+      subject.value = new_value
+      assert_equal new_value.to_i, subject.value
+    end
+  end
+
+  class WithHashTypeClassTest < BaseTest
+    desc "with a Hash as a type class"
+    setup do
+      @option = NsOptions::Option.new(:something, Hash)
+    end
+    subject{ @option }
+
+    should "allow setting it with a hash" do
+      new_value = { :another => true }
+      subject.value = new_value
+      assert_equal new_value, subject.value
+    end
+  end
+
+  class WithArrayTypeClassTest < BaseTest
+    desc "with an Array as a type class"
+    setup do
+      @option = NsOptions::Option.new(:something, Array)
+    end
+    subject{ @option }
+
+    should "allow setting it with a array" do
+      new_value = [ :something, :else, :another ]
+      subject.value = new_value
+      assert_equal new_value, subject.value
+    end
+  end
+
+  class WithTrueFalseClassTest < BaseTest
+    desc "with a TrueClass/FalseClass as a type class (happens with dynamic writers)"
+    setup do
+      @true_option = NsOptions::Option.new(:something, TrueClass)
+      @true_option.value = true
+      @false_option = NsOptions::Option.new(:else, FalseClass)
+      @false_option.value = false
+    end
+    subject{ @true_option }
+
+    should "have used NsOptions::Option::Boolean for their type class" do
+      assert_equal NsOptions::Option::Boolean, @true_option.type_class
+      assert_equal NsOptions::Option::Boolean, @false_option.type_class
+    end
+    should "return the 'true' or 'false' value instead of the NsOptions::Option::Boolean object" do
+      assert_equal true, @true_option.value
+      assert_equal false, @false_option.value
+    end
+  end
+
+  class WithoutTypeClassTest < BaseTest
+    desc "without a type class provided"
+    setup do
+      @option = NsOptions::Option.new(:something, nil)
+    end
+    subject{ @option }
+
+    should "have default it to String" do
+      assert_equal String, subject.type_class
+    end
+  end
+
+end

data/test/unit/ns-options/options_test.rb

@@ -0,0 +1,227 @@
+require 'assert'
+
+class NsOptions::Options
+
+  class BaseTest < Assert::Context
+    desc "NsOptions::Options"
+    setup do
+      @options = NsOptions::Options.new(:something)
+    end
+    subject{ @options }
+
+    should have_accessors :key, :parent, :children
+    should have_instance_method :namespaces, :add, :del, :remove, :get, :set, :fetch, :is_defined?,
+      :parent_options
+
+    should "be a kind of Hash" do
+      assert_kind_of Hash, subject
+    end
+    should "only use symbols for keys" do
+      subject["string_key"] = true
+      subject[:symbol_key] = true
+
+      assert_includes :string_key, subject.keys
+      assert_includes :symbol_key, subject.keys
+      assert_not_includes "string_key", subject.keys
+    end
+    should "have set the key" do
+      assert_equal "something", subject.key
+    end
+    should "have set the parent to nil" do
+      assert_nil subject.parent
+    end
+    should "return a kind of NsOption::Namespaces with a call to #children" do
+      assert_kind_of NsOptions::Namespaces, subject.children
+    end
+  end
+
+  class AddTest < BaseTest
+    desc "add method"
+    setup do
+      @options.add(:my_string)
+      @options.add(:my_integer, Integer)
+      @options.add(:my_float, Float, { :default => 1.0 })
+    end
+    subject{ @options }
+
+    should "have added a string option on itself when adding :my_string" do
+      assert(option = subject[:my_string])
+      assert_equal String, option.type_class
+      assert_equal({}, option.rules)
+    end
+    should "have added an integer option on itself when adding :my_integer" do
+      assert(option = subject[:my_integer])
+      assert_equal Integer, option.type_class
+      assert_equal({}, option.rules)
+    end
+    should "have added a float option on itself when adding :my_float" do
+      assert(option = subject[:my_float])
+      assert_equal Float, option.type_class
+      assert_equal({ :default => 1.0 }, option.rules)
+    end
+  end
+
+  class DelTest < BaseTest
+    desc "add method"
+    setup do
+      @options.add(:my_string)
+      @options.del(:my_string)
+    end
+    subject{ @options }
+
+    should "remove the option definition from the collection" do
+      assert_nil subject[:my_string]
+    end
+  end
+
+  class GetTest < BaseTest
+    desc "get method"
+    setup do
+      option = @options.add(:my_string)
+      option.value = @value = "something"
+      @result = @options.get(:my_string)
+    end
+    subject{ @result }
+
+    should "have returned the option's value" do
+      assert_equal @value, subject
+    end
+
+    class WithParentTest < GetTest
+      desc "with a parent"
+      setup do
+        @parent = NsOptions::Namespace.new(:child)
+        @parent.options = @options
+        @options = NsOptions::Options.new(:child, @parent)
+        @result = @options.get(:my_string)
+      end
+      subject{ @result }
+
+      should "have returned the parent's option's value" do
+        assert_equal @value, subject
+      end
+    end
+  end
+
+  class SetTest < BaseTest
+    desc "set method"
+    setup do
+      option = @options.add(:my_string)
+      @options.set(:my_string, "something")
+    end
+    subject{ @options }
+
+    should "have set the option's value" do
+      assert_equal "something", subject.get(:my_string)
+    end
+  end
+
+  class FetchTest < BaseTest
+    desc "fetch method"
+    setup do
+      option = @options.add(:my_string)
+      @result = @options.fetch(:my_string)
+    end
+    subject{ @result }
+
+    should "return the option definition for my_string" do
+      assert_kind_of NsOptions::Option, subject
+      assert_equal "my_string", subject.name
+    end
+
+    class WithAParentTest < FetchTest
+      desc "with a parent"
+      setup do
+        @parent = NsOptions::Namespace.new(:child)
+        @parent.options = @options
+        @options = NsOptions::Options.new(:child, @parent)
+        @result = @options.fetch(:my_string)
+      end
+      subject{ @result }
+
+      should "return the option definition for my_string from it's parent" do
+        assert_kind_of NsOptions::Option, subject
+        assert_equal "my_string", subject.name
+      end
+    end
+  end
+
+  class IsDefinedTest < BaseTest
+    desc "fetch method"
+    setup do
+      option = @options.add(:my_string)
+    end
+    subject{ @options }
+
+    should "return true for a defined option" do
+      assert_equal true, subject.is_defined?(:my_string)
+    end
+    should "return false for an undefined option" do
+      assert_equal false, subject.is_defined?(:undefined)
+    end
+
+    class WithAParentTest < IsDefinedTest
+      desc "with a parent"
+      setup do
+        @parent = NsOptions::Namespace.new(:child)
+        @parent.options = @options
+        @options = NsOptions::Options.new(:child, @parent)
+      end
+
+      should "return true for an option defined on it's parent" do
+        assert_equal true, subject.is_defined?(:my_string)
+      end
+    end
+  end
+
+  class ParentOptionsTest < BaseTest
+    desc "parent_options method"
+    subject{ @options }
+
+    should "return nil" do
+      assert_nil subject.parent_options
+    end
+
+    class WithAParentTest < ParentOptionsTest
+      desc "with a parent"
+      setup do
+        @parent = NsOptions::Namespace.new(:child)
+        @parent.options = @options
+        @options = NsOptions::Options.new(:child, @parent)
+      end
+
+      should "return it's parent's options" do
+        assert_equal @parent.options, subject.parent_options
+      end
+    end
+  end
+
+  class RequiredSetTest < BaseTest
+    desc "required_set? method"
+    setup do
+      @options.add(:first, String, { :require => true })
+      @options.add(:second, String, { :required => true })
+      @options.add(:third, String)
+    end
+
+    should "return true when all required options are set" do
+      @options.set(:first, "first")
+      @options.set(:second, "second")
+      assert_equal true, subject.required_set?
+    end
+    should "return false if one required option is not set" do
+      @options.set(:first, "first")
+      @options.set(:third, "third")
+      assert_equal false, subject.required_set?
+    end
+    should "not change because of options that aren't required" do
+      @options.set(:first, "first")
+      @options.set(:second, "second")
+      @options.set(:third, "third")
+      assert_equal true, subject.required_set?
+      @options.set(:third, nil)
+      assert_equal true, subject.required_set?
+    end
+  end
+
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: ns-options
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Collin Redding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  version_requirements: *id001
+  name: assert
+description: Define and use namespaced options with a clean interface.
+email: 
+- collin.redding@reelfx.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/ns-options.rb
+- lib/ns-options/has_options.rb
+- lib/ns-options/helper.rb
+- lib/ns-options/namespace.rb
+- lib/ns-options/namespaces.rb
+- lib/ns-options/option.rb
+- lib/ns-options/option/boolean.rb
+- lib/ns-options/options.rb
+- lib/ns-options/version.rb
+- ns-options.gemspec
+- test/helper.rb
+- test/integration/app_test.rb
+- test/integration/user_test.rb
+- test/support/app.rb
+- test/support/user.rb
+- test/unit/ns-options/has_options_test.rb
+- test/unit/ns-options/helper_test.rb
+- test/unit/ns-options/namespace_test.rb
+- test/unit/ns-options/namespaces_test.rb
+- test/unit/ns-options/option/boolean_test.rb
+- test/unit/ns-options/option_test.rb
+- test/unit/ns-options/options_test.rb
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Define and use namespaced options with a clean interface.
+test_files: 
+- test/helper.rb
+- test/integration/app_test.rb
+- test/integration/user_test.rb
+- test/support/app.rb
+- test/support/user.rb
+- test/unit/ns-options/has_options_test.rb
+- test/unit/ns-options/helper_test.rb
+- test/unit/ns-options/namespace_test.rb
+- test/unit/ns-options/namespaces_test.rb
+- test/unit/ns-options/option/boolean_test.rb
+- test/unit/ns-options/option_test.rb
+- test/unit/ns-options/options_test.rb