ns-options 0.4.1 → 1.0.0.rc1

data/test/system/type_class_proxy_tests.rb

@@ -0,0 +1,108 @@
+require 'assert'
+
+require 'ns-options/assert_macros'
+require 'test/support/type_class_proxy'
+
+class TypeClassProxyTests < Assert::Context
+  include NsOptions::AssertMacros
+
+  desc "a proxy using option_type_class"
+  setup do
+    set_proxy_for_tests(TypeClassProxy)
+  end
+
+  def set_proxy_for_tests(proxy_class)
+    @proxy = proxy_class
+    proxy_class.value1          = 10
+    proxy_class.more.more1      = 10
+    proxy_class.strings.string1 = 10
+    proxy_class.objs.obj1       = Object.new
+  end
+
+  should "use the option type class for its options" do
+    assert_kind_of DefaultTypeClass, @proxy.value1
+    assert_equal   10, @proxy.value1.value
+  end
+
+  should "use the option type class for its namespaces" do
+    assert_equal DefaultTypeClass, @proxy.more.option_type_class
+  end
+
+  should "recursively use the option type class" do
+    assert_kind_of DefaultTypeClass, @proxy.more.more1
+  end
+
+  should "allow the recursive option type class to be overridden" do
+    assert_equal   String, @proxy.strings.option_type_class
+    assert_kind_of String, @proxy.strings.string1
+  end
+
+  should "allow the recursive option type class to be reset" do
+    assert_equal   Object, @proxy.objs.option_type_class
+    assert_kind_of Object, @proxy.objs.obj1
+  end
+
+end
+
+class InheritedTypeClassProxyTests < TypeClassProxyTests
+  desc "that inherits from another"
+  setup do
+    set_proxy_for_tests(InheritedTypeClassProxy)
+  end
+
+  should "use the option type class for its options" do
+    assert_kind_of DefaultTypeClass, @proxy.value1
+    assert_equal   10, @proxy.value1.value
+  end
+
+  should "use the option type class for its namespaces" do
+    assert_equal DefaultTypeClass, @proxy.more.option_type_class
+  end
+
+  should "recursively use the option type class" do
+    assert_kind_of DefaultTypeClass, @proxy.more.more1
+  end
+
+  should "allow the recursive option type class to be overridden" do
+    assert_equal   String, @proxy.strings.option_type_class
+    assert_kind_of String, @proxy.strings.string1
+  end
+
+  should "allow the recursive option type class to be reset" do
+    assert_equal   Object, @proxy.objs.option_type_class
+    assert_kind_of Object, @proxy.objs.obj1
+  end
+
+end
+
+class DoubleInheritedTypeClassProxyTests < TypeClassProxyTests
+  desc "that inherits from another that inherits from another"
+  setup do
+    set_proxy_for_tests(DoubleInheritedTypeClassProxy)
+  end
+
+  should "use the option type class for its options" do
+    assert_kind_of DefaultTypeClass, @proxy.value1
+    assert_equal   10, @proxy.value1.value
+  end
+
+  should "use the option type class for its namespaces" do
+    assert_equal DefaultTypeClass, @proxy.more.option_type_class
+  end
+
+  should "recursively use the option type class" do
+    assert_kind_of DefaultTypeClass, @proxy.more.more1
+  end
+
+  should "allow the recursive option type class to be overridden" do
+    assert_equal   String, @proxy.strings.option_type_class
+    assert_kind_of String, @proxy.strings.string1
+  end
+
+  should "allow the recursive option type class to be reset" do
+    assert_equal   Object, @proxy.objs.option_type_class
+    assert_kind_of Object, @proxy.objs.obj1
+  end
+
+end
+

data/test/system/user_tests.rb

@@ -0,0 +1,146 @@
+require 'assert'
+
+require 'ns-options/assert_macros'
+require 'test/support/user'
+
+class User
+
+  class BaseTests < Assert::Context
+    include NsOptions::AssertMacros
+
+    desc "the User class"
+    setup do
+      @class = User
+    end
+    subject{ @class }
+
+    should have_reader :preferences
+
+  end
+
+  class ClassPreferencesTests < BaseTests
+    desc "preferences"
+    subject{ @class.preferences }
+
+    should have_option :home_url
+    should have_option :show_messages,  NsOptions::Boolean, :required => true
+    should have_option :font_size,      Integer,            :default  => 12
+
+    should have_namespace :view do
+      option :color
+    end
+
+  end
+
+  class ClassInheritedPreferencesTests < ClassPreferencesTests
+    desc "on a subclass of User"
+    setup do
+      User.preferences.home_url = "/home"
+      User.preferences.show_messages = false
+      User.preferences.font_size = 15
+      User.preferences.view.color = "green"
+
+      @a_sub_class = Class.new(User)
+    end
+    subject { @a_sub_class.preferences }
+
+    should have_option :home_url
+    should have_option :show_messages,  NsOptions::Boolean, :required => true
+    should have_option :font_size,      Integer,            :default  => 12
+
+    should have_namespace :view do
+      option :color
+    end
+
+    should "not have the same preference values as its superclass" do
+      assert_not_equal "/home", subject.home_url
+      assert_not_equal false, subject.show_messages
+      assert_not_equal 15, subject.font_size
+      assert_not_equal "green", subject.view.color
+    end
+
+  end
+
+  class InstanceTests < BaseTests
+    desc "instance"
+    setup do
+      @instance = @class.new
+      @class_preferences = @class.preferences
+      @class_preferences.home_url = "/something"
+      @preferences = @instance.preferences
+    end
+    subject{ @instance }
+
+    should have_instance_methods :preferences
+
+    should "have a new namespace that is a different object than the class namespace" do
+      assert_not_same @class_preferences, @preferences
+    end
+
+    should "have the same options as the class namespace, but different objects" do
+      @class_preferences.__data__.child_options.each do |name, class_opt|
+        inst_opt = @preferences.__data__.child_options[name]
+
+        assert_equal    class_opt.name,       inst_opt.name
+        assert_equal    class_opt.type_class, inst_opt.type_class
+        assert_equal    class_opt.rules,      inst_opt.rules
+        assert_not_same class_opt,            inst_opt
+      end
+
+      assert_not_equal @class_preferences.home_url, @preferences.home_url
+    end
+
+    should "have the same named namespaces as the class, but different objects" do
+      @class_preferences.__data__.child_namespaces.each do |name, class_ns|
+        assert_not_same class_ns, @preferences.__data__.child_namespaces[name]
+      end
+    end
+
+  end
+
+  class InstancePreferencesTests < InstanceTests
+    desc "preferences"
+    setup do
+      @instance.preferences.home_url = "/home"
+      @instance.preferences.show_messages = false
+      @instance.preferences.font_size = 15
+      @instance.preferences.view.color = "green"
+    end
+    subject{ @instance.preferences }
+
+    should have_option :home_url
+    should have_option :show_messages,  NsOptions::Boolean, :required => true
+    should have_option :font_size,      Integer,            :default  => 12
+
+    should have_namespace :view do
+      option :color
+    end
+
+    should "have set the preference values" do
+      assert_equal "/home", subject.home_url
+      assert_equal false, subject.show_messages
+      assert_equal 15, subject.font_size
+      assert_equal "green", subject.view.color
+    end
+
+  end
+
+  class InstanceInheritedPreferencesTests < InstancePreferencesTests
+    desc "on an instance of a subclass of User"
+    setup do
+      @a_sub_class = Class.new(User)
+      @the_sub_class = @a_sub_class.new
+    end
+    subject { @the_sub_class.preferences }
+
+    should have_option :home_url
+    should have_option :show_messages,  NsOptions::Boolean, :required => true
+    should have_option :font_size,      Integer,            :default  => 12
+
+    should have_namespace :view do
+      option :color
+    end
+
+  end
+
+end

data/test/unit/{ns-options/boolean_test.rb → boolean_tests.rb}

@@ -1,8 +1,9 @@
 require 'assert'
+require 'ns-options/boolean'
 
 class NsOptions::Boolean
 
-  class BaseTest < Assert::Context
+  class BaseTests < Assert::Context
     desc "NsOptions::Boolean"
     setup do
       @boolean = NsOptions::Boolean.new(true)
@@ -22,7 +23,7 @@ class NsOptions::Boolean
 
   end
 
-  class WithTruthyValuesTest < BaseTest
+  class WithTruthyValuesTests < BaseTests
     desc "with truthy values"
     setup do
       @boolean = NsOptions::Boolean.new(nil)
@@ -54,7 +55,7 @@ class NsOptions::Boolean
     end
   end
 
-  class WithFalsyValuesTest < BaseTest
+  class WithFalsyValuesTests < BaseTests
     desc "with falsy values"
     setup do
       @boolean = NsOptions::Boolean.new(nil)
@@ -90,7 +91,7 @@ class NsOptions::Boolean
     end
   end
 
-  class ComparatorTests < BaseTest
+  class ComparatorTests < BaseTests
     desc "when comparing for equality"
     setup do
       @true_bool   = NsOptions::Boolean.new true

data/test/unit/namespace_advisor_tests.rb

@@ -0,0 +1,69 @@
+require 'assert'
+require 'ns-options/namespace_advisor'
+require 'ns-options/namespace_data'
+require 'ns-options/namespace'
+
+class NsOptions::NamespaceAdvisor
+
+  class BaseTests < Assert::Context
+    desc "NsOptions::NamespaceAdvisor"
+    setup do
+      @ns = NsOptions::Namespace.new 'test'
+      @ns.option 'opt1'
+      @ns.namespace 'ns1'
+      @ns_data = @ns.__data__
+      @na = ns_advisor_for 'test'
+    end
+    subject { @na }
+
+    def ns_advisor_for(name, kind='an option')
+      NsOptions::NamespaceAdvisor.new(@ns_data, name, kind)
+    end
+
+    should have_imeths :run, :not_recommended?, :duplicate?, :not_recommended_names
+
+    should "know its not recommended names" do
+      exp = NsOptions::Namespace.instance_methods(false).map(&:to_sym)
+      assert_equal exp, subject.not_recommended_names
+    end
+
+    should "know if a name is not recommended" do
+      assert     ns_advisor_for('option').not_recommended?
+      assert     ns_advisor_for('to_hash').not_recommended?
+      assert_not ns_advisor_for('test').not_recommended?
+    end
+
+    should "know if a name is a duplicate" do
+      assert_not ns_advisor_for('option').duplicate?
+      assert_not ns_advisor_for('to_hash').duplicate?
+      assert_not ns_advisor_for('test').duplicate?
+      assert     ns_advisor_for('opt1').duplicate?
+      assert     ns_advisor_for('ns1').duplicate?
+    end
+
+  end
+
+  class RunTests < BaseTests
+    desc "run meth"
+    setup do
+      @io = StringIO.new(@out = "")
+      @caller = ["a test caller"]
+    end
+
+    should "write a warning and any caller info on not recommended names" do
+      ns_advisor_for('to_hash').run(@io, @caller)
+
+      assert_match "WARNING: ", @out
+      assert_match @caller.first, @out
+    end
+
+    should "write a warning and any caller info on duplicate names" do
+      ns_advisor_for('opt1').run(@io, @caller)
+
+      assert_match "WARNING: ", @out
+      assert_match @caller.first, @out
+    end
+
+  end
+
+end

data/test/unit/namespace_data_tests.rb

@@ -0,0 +1,336 @@
+require 'assert'
+require 'ns-options/namespace_data'
+require 'ns-options/namespace'
+
+class NsOptions::NamespaceData
+
+  class BaseTests < Assert::Context
+    desc "NsOptions::NamespaceData"
+    setup do
+      @ns = NsOptions::Namespace.new('thing')
+      @data = @ns.__data__
+    end
+    subject { @data }
+
+    should have_readers :ns, :option_type_class
+    should have_readers :child_options, :child_namespaces
+    should have_imeths  :has_option?, :has_namespace?, :required_set?
+    should have_imeths  :add_option, :get_option, :set_option
+    should have_imeths  :add_namespace, :get_namespace
+    should have_imeths  :set_option_type_class
+    should have_imeths  :to_hash, :apply, :each, :define, :build_from, :reset
+
+    should "know its namespace" do
+      assert_equal @ns, subject.ns
+    end
+
+    should "know its type class" do
+      assert_equal Object, subject.option_type_class
+    end
+
+    should "know its child options" do
+      assert_kind_of NsOptions::Options, subject.child_options
+      assert_empty subject.child_options
+    end
+
+    should "know its child namespaces" do
+      assert_kind_of NsOptions::Namespaces, subject.child_namespaces
+      assert_empty subject.child_namespaces
+    end
+
+    should "be able to change its option_type_class" do
+      assert_equal Object, subject.option_type_class
+      subject.set_option_type_class(Fixnum)
+
+      assert_equal Fixnum, subject.option_type_class
+    end
+
+    should "add options" do
+      an_option = subject.add_option 'an_option'
+
+      assert_equal an_option, subject.child_options['an_option']
+      assert_equal Object, an_option.type_class
+    end
+
+    should "add options with its type class" do
+      subject.set_option_type_class(Fixnum)
+      an_option = subject.add_option 'an_option'
+
+      assert_equal Fixnum, an_option.type_class
+    end
+
+    should "get option values" do
+      an_option = subject.add_option 'an_option'
+      an_option.value = 123
+
+      assert_equal 123, subject.get_option('an_option')
+    end
+
+    should "set option values" do
+      an_option = subject.add_option 'an_option'
+      an_option.value = 123
+      subject.set_option('an_option', 456)
+
+      assert_equal 456, an_option.value
+    end
+
+    should "add namespaces" do
+      a_namespace = subject.add_namespace 'a_namespace'
+      assert_equal a_namespace, subject.child_namespaces['a_namespace']
+
+      a_ns_data   = a_namespace.__data__
+      assert_equal Object, a_ns_data.option_type_class
+    end
+
+    should "add namespaces with its type class" do
+      subject.set_option_type_class(Fixnum)
+      a_namespace = subject.add_namespace 'a_namespace'
+      a_ns_data   = subject.child_namespaces['a_namespace'].__data__
+
+      assert_equal Fixnum, a_ns_data.option_type_class
+    end
+
+    should "get namespaces" do
+      a_namespace = subject.add_namespace 'a_namespace'
+      assert_equal a_namespace, subject.get_namespace('a_namespace')
+    end
+
+  end
+
+  class HandlingTests < BaseTests
+    setup do
+      @data.define do
+        option :first; option :second; option :third
+        namespace(:child_a) do
+          option(:fourth); option(:fifth)
+          namespace(:child_b) { option(:sixth) }
+        end
+      end
+
+      @named_values = {
+        :first => "1", :second => "2", :third => "3", :twenty_one => "21",
+        :child_a => {
+          :fourth => "4", :fifth => "5",
+          :child_b => { :sixth => "6" }
+        },
+        :child_c => { :what => "?" }
+      }
+    end
+
+    should "know if it has an option" do
+      assert subject.has_option? 'first'
+      assert_not subject.has_option? 'blashalksjdglasjasdga'
+    end
+
+    should "know if it has a namespace" do
+      assert subject.has_namespace? 'child_a'
+      assert_not subject.has_namespace? 'dlakjsglasdjgaklsdgjas'
+    end
+
+    should "return its Hash representation" do
+      exp_hash = {
+        :first => nil, :second => nil, :third => nil,
+        :child_a => {
+          :fourth => nil, :fifth => nil,
+          :child_b => { :sixth => nil }
+        }
+      }
+      assert_equal(exp_hash, subject.to_hash)
+    end
+
+    should "apply a given hash value to itself" do
+      subject.apply(@named_values)
+      assert_equal @named_values, subject.to_hash
+    end
+
+  end
+
+  class EachTests < HandlingTests
+    desc "iterated with the each method"
+    setup do
+      subject.apply(@named_values)
+      @exp = "".tap do |exp|
+        subject.to_hash.each do |k,v|
+          exp << "#{k}=#{v};"
+        end
+      end
+      @act = "".tap do |exp|
+        subject.each do |k,v|
+          exp << "#{k}=#{v};"
+        end
+      end
+    end
+
+    should "yield k/v pairs by iterating over the #to_hash" do
+      assert_equal @exp, @act
+    end
+
+  end
+
+  class DefineTests < BaseTests
+    desc "define method"
+
+    should "instance eval in the scope of the ns if given a no-arity-block" do
+      scope = nil; subject.define{ scope = self }
+      assert_equal @ns, scope
+    end
+
+    should "yield the ns to the block if given an arity-block" do
+      yielded = nil; subject.define{|ns| yielded = ns}
+      assert_equal @ns, yielded
+    end
+
+    should "return the namespace, if given no block" do
+      assert_equal @ns, subject.define
+    end
+
+  end
+
+  class BuildFromTests < BaseTests
+    desc "build_from method"
+    setup do
+      @from_ns = NsOptions::Namespace.new(:other_thing)
+      @from_child_opt = @from_ns.option :opt1
+      @from_child_ns  = @from_ns.namespace(:ns1) { option :sub_opt1 }
+    end
+
+    should "copy the options" do
+      assert_not subject.has_option? :opt1
+      @data.build_from(@from_ns.__data__)
+
+      assert subject.has_option? :opt1
+      assert_not_same @from_child_opt, subject.child_options[:opt1]
+    end
+
+    should "copy the namespaces" do
+      assert_not subject.has_namespace?(:ns1)
+      @data.build_from(@from_ns.__data__)
+
+      assert subject.has_namespace?(:ns1)
+      assert subject.child_namespaces[:ns1].__data__.has_option? :sub_opt1
+      assert_not_same @from_child_ns, subject.child_namespaces[:ns1]
+    end
+
+  end
+
+  class ApplyTests < BaseTests
+    setup do
+      @data.define do
+        option :first; option :second; option :third
+        namespace(:child_a) do
+          option(:fourth); option(:fifth)
+          namespace(:child_b) { option(:sixth) }
+        end
+      end
+
+      @named_values = {
+        :first => "1", :second => "2", :third => "3", :twenty_one => "21",
+        :child_a => {
+          :fourth => "4", :fifth => "5",
+          :child_b => { :sixth => "6" }
+        },
+        :child_c => { :what => "?" }
+      }
+    end
+
+    should "apply a given hash value to itself" do
+      subject.apply(@named_values)
+      assert_equal @named_values, subject.to_hash
+    end
+
+    should "ignore applying non-hash values to namespaces" do
+      assert_nil subject.ns.child_a.fourth
+      prev_child_b = subject.ns.child_a.child_b.dup
+
+      subject.apply(:child_a => {
+        :fourth => 4,
+        :child_b => 'something'
+      })
+      assert_equal 4, subject.ns.child_a.fourth
+      assert_not_equal 'something', subject.ns.child_a.child_b
+      assert_equal prev_child_b, subject.ns.child_a.child_b
+    end
+
+  end
+
+  class ResetTests < BaseTests
+    desc "reset method"
+    setup do
+      @data.add_option 'fixnum', Fixnum, :default => 10
+      @data.add_option 'something'
+      @data.add_namespace 'sub' do
+        option 'subopt'
+      end
+
+      @data.set_option 'fixnum', 9999
+      @data.set_option 'something', 'else'
+      @data.get_namespace('sub').subopt = "a subopt"
+    end
+
+    should "set the options back to their default values" do
+      assert_equal 9999, subject.get_option('fixnum')
+      assert_equal 'else', subject.get_option('something')
+      assert_equal 'a subopt', subject.get_namespace('sub').subopt
+
+      subject.reset
+
+      assert_equal 10, subject.get_option('fixnum')
+      assert_nil subject.get_option('something')
+      assert_nil subject.get_namespace('sub').subopt
+    end
+
+  end
+
+  class SameNameTests < BaseTests
+
+    should "replace a same-named option when adding a new option" do
+      subject.add_option :something, String
+      assert subject.has_option? :something
+
+      subject.add_option :something, Fixnum, :default => 10
+      assert subject.has_option? :something
+
+      opt = subject.child_options[:something]
+      assert_equal Fixnum, opt.type_class
+      assert_equal 10,     opt.rules[:default]
+    end
+
+    should "replace a same-named option when adding a new namespace" do
+      subject.add_option :something, String
+      assert subject.has_option? :something
+
+      subject.add_namespace :something
+      assert_not subject.has_option?    :something
+      assert     subject.has_namespace? :something
+
+      assert_equal Hash.new, subject.child_namespaces[:something].to_hash
+    end
+
+    should "replace a same-named namespace when adding a new namespace" do
+      subject.add_namespace :something do
+        option :a, :default => 10
+      end
+      assert subject.has_namespace? :something
+      assert_equal({:a => 10}, subject.child_namespaces[:something].to_hash)
+
+      subject.add_namespace :something
+      assert subject.has_namespace? :something
+      assert_equal Hash.new, subject.child_namespaces[:something].to_hash
+    end
+
+    should "replace a same-named namespace when adding a new option" do
+      subject.add_namespace :something
+      assert subject.has_namespace? :something
+
+      subject.add_option :something, Fixnum, :default => 10
+      assert_not subject.has_namespace? :something
+      assert     subject.has_option?    :something
+
+      opt = subject.child_options[:something]
+      assert_equal Fixnum, opt.type_class
+      assert_equal 10,     opt.rules[:default]
+    end
+
+  end
+
+end