ns-options 0.4.1 → 1.0.0.rc1

data/test/unit/{ns-options/proxy_test.rb → proxy_tests.rb}

@@ -141,6 +141,58 @@ module NsOptions::Proxy
       assert_equal @proxy2, @proxy1
     end
 
+  end
+
+  class DynamicOptionWriterTests < BaseTests
+    setup do
+      @mod = Module.new do
+        include NsOptions::Proxy
+
+        option :test
+      end
+    end
+    subject { @mod }
+
+    should "write non-pre-defined values as Object options" do
+      assert_not subject.has_option? :not_pre_defined
+      assert_responds_to :not_pre_defined=, subject
+      assert_not_responds_to :not_pre_defined, subject
+
+      assert_nothing_raised { subject.not_pre_defined = 123 }
+
+      assert subject.has_option? :not_pre_defined
+      assert_responds_to :not_pre_defined, subject
+
+      assert_equal 123, subject.not_pre_defined
+      assert_equal Object, subject.__data__.child_options['not_pre_defined'].type_class
+    end
+
+  end
+
+  class InheritedTests < BaseTests
+    desc "when inherited"
+    setup do
+      @a_super_class = Class.new do
+        include NsOptions::Proxy
+        option_type_class Fixnum
+
+        option :test
+        namespace(:other) { option :stuff }
+      end
+    end
+
+    should "pass its definition to any subclass" do
+      a_sub_class = Class.new(@a_super_class)
+
+      assert a_sub_class.has_option? :test
+      assert a_sub_class.has_namespace? :other
+      assert a_sub_class.other.has_option? :stuff
+
+      a_sub_ns_data = a_sub_class.__proxy_options__.__data__
+      assert_equal Fixnum, a_sub_ns_data.option_type_class
+      other_ns_data = a_sub_class.other.__data__
+      assert_equal Fixnum, other_ns_data.option_type_class
+    end
 
   end
 

data/test/unit/root_methods_tests.rb

@@ -0,0 +1,126 @@
+require 'assert'
+require 'ns-options/root_methods'
+require 'ns-options/namespace'
+
+class NsOptions::RootMethods
+
+  class BaseTests < Assert::Context
+    desc "NsOptions::RootMethods"
+    setup do
+      @rm = NsOptions::RootMethods.new(Module.new, 'whatever')
+    end
+    subject { @rm }
+
+    should have_imeths :define_on_class?, :define, :validate
+
+  end
+
+  class ValidateTests < BaseTests
+    desc "validate meth"
+    setup do
+      @io = StringIO.new(@out = "")
+      @caller = ["a test caller"]
+    end
+
+    should "return false for :options, :opts, :namespace, :ns names" do
+      [:options, :opts, :namespace, :ns].each do |meth|
+        rm = NsOptions::RootMethods.new(Module.new, meth)
+        assert_equal false, rm.validate(@io, @caller)
+      end
+
+      rm = NsOptions::RootMethods.new(Module.new, "anything_else")
+      assert_equal true, rm.validate(@io, @caller)
+    end
+
+    should "write a warning and any caller info" do
+      NsOptions::RootMethods.new(Module.new, :ns).validate(@io, @caller)
+
+      assert_match "WARNING: ", @out
+      assert_match @caller.first, @out
+    end
+
+    should "be called when calling `define'" do
+      NsOptions::RootMethods.new(Module.new, :ns).define(@io, @caller)
+
+      assert_match "WARNING: ", @out
+      assert_match @caller.first, @out
+    end
+
+  end
+
+  class ModuleTests < BaseTests
+    desc "defined on a module"
+    setup do
+      @rm = NsOptions::RootMethods.new(@the_module = Module.new, 'on_module')
+      @rm.define
+    end
+
+    should "know its not defining on a class" do
+      assert_not subject.define_on_class?
+    end
+
+    should "define a singleton method that builds a ns" do
+      assert_responds_to 'on_module', @the_module
+      assert_kind_of NsOptions::Namespace, @the_module.on_module
+    end
+
+  end
+
+  class ClassTests < BaseTests
+    desc "defined on a class"
+    setup do
+      @rm = NsOptions::RootMethods.new(@the_class = Class.new, 'on_class')
+      @rm.define
+    end
+
+    should "know its defining on a class" do
+      assert subject.define_on_class?
+    end
+
+    should "define a singleton method that builds a ns" do
+      assert_responds_to 'on_class', @the_class
+      ns = @the_class.on_class { option :opt1 }
+
+      assert_kind_of NsOptions::Namespace, ns
+      assert ns.__data__.has_option?(:opt1)
+    end
+
+    should "define an instance method that builds a ns from its singleton" do
+      @the_class.on_class { option :opt1 }
+      a_class = @the_class.new
+      assert_responds_to 'on_class', a_class
+      ns = a_class.on_class
+
+      assert_kind_of NsOptions::Namespace, ns
+      assert ns.__data__.has_option?(:opt1)
+    end
+
+  end
+
+  class InheritedClassTests < BaseTests
+    desc "when inherited"
+    setup do
+      @rm = NsOptions::RootMethods.new(@a_super_class = Class.new, 'a_ns')
+      @rm.define
+      @a_super_class.a_ns Fixnum do
+        option :test
+        namespace(:other) { option :stuff }
+      end
+    end
+
+    should "define a singleton method that builds a ns with the same def as its superclass" do
+      a_sub_class = Class.new(@a_super_class)
+
+      assert a_sub_class.a_ns.has_option? :test
+      assert a_sub_class.a_ns.has_namespace? :other
+      assert a_sub_class.a_ns.other.has_option? :stuff
+
+      a_sub_ns_data = a_sub_class.a_ns.__data__
+      assert_equal Fixnum, a_sub_ns_data.option_type_class
+      other_ns_data = a_sub_class.a_ns.other.__data__
+      assert_equal Fixnum, other_ns_data.option_type_class
+    end
+
+  end
+
+end

metadata

@@ -1,13 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: ns-options
 version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: 
+  hash: -1692815510
+  prerelease: 6
   segments: 
+  - 1
+  - 0
   - 0
-  - 4
+  - rc
   - 1
-  version: 0.4.1
+  version: 1.0.0.rc1
 platform: ruby
 authors: 
 - Collin Redding
@@ -15,39 +17,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-05 00:00:00 Z
+date: 2012-11-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  name: assert
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 27
         segments: 
         - 0
-        - 7
-        version: "0.7"
-  version_requirements: *id001
-  name: assert
-- !ruby/object:Gem::Dependency 
+        - 8
+        version: "0.8"
   type: :development
+  requirement: *id001
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 0
-        - 1
-        version: "0.1"
-  version_requirements: *id002
-  name: assert-mocha
-description: Define and use namespaced options with a clean interface.
+description: A DSL for defining, organizing and accessing options.
 email: 
 - collin.redding@reelfx.com
 executables: []
@@ -65,36 +52,39 @@ files:
 - lib/ns-options.rb
 - lib/ns-options/assert_macros.rb
 - lib/ns-options/boolean.rb
-- lib/ns-options/errors/invalid_name.rb
-- lib/ns-options/has_options.rb
-- lib/ns-options/helper.rb
-- lib/ns-options/helper/advisor.rb
 - lib/ns-options/namespace.rb
+- lib/ns-options/namespace_advisor.rb
+- lib/ns-options/namespace_data.rb
 - lib/ns-options/namespaces.rb
 - lib/ns-options/option.rb
 - lib/ns-options/options.rb
 - lib/ns-options/proxy.rb
+- lib/ns-options/proxy_method.rb
+- lib/ns-options/root_methods.rb
 - lib/ns-options/version.rb
 - log/.gitkeep
 - ns-options.gemspec
 - test/helper.rb
-- test/integration/app_test.rb
-- test/integration/proxy_test.rb
-- test/integration/user_test.rb
 - test/irb.rb
 - test/support/app.rb
 - test/support/proxy.rb
+- test/support/type_class_proxy.rb
 - test/support/user.rb
-- test/unit/ns-options/assert_macros_test.rb
-- test/unit/ns-options/boolean_test.rb
-- test/unit/ns-options/has_options_test.rb
-- test/unit/ns-options/helper/advisor_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_test.rb
-- test/unit/ns-options/options_test.rb
-- test/unit/ns-options/proxy_test.rb
+- test/system/app_tests.rb
+- test/system/proxy_tests.rb
+- test/system/type_class_proxy_tests.rb
+- test/system/user_tests.rb
+- test/unit/assert_macros_tests.rb
+- test/unit/boolean_tests.rb
+- test/unit/namespace_advisor_tests.rb
+- test/unit/namespace_data_tests.rb
+- test/unit/namespace_tests.rb
+- test/unit/namespaces_tests.rb
+- test/unit/option_tests.rb
+- test/unit/options_tests.rb
+- test/unit/proxy_method_tests.rb
+- test/unit/proxy_tests.rb
+- test/unit/root_methods_tests.rb
 homepage: 
 licenses: []
 
@@ -115,35 +105,40 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Define and use namespaced options with a clean interface.
+summary: A DSL for defining, organizing and accessing options.
 test_files: 
 - test/helper.rb
-- test/integration/app_test.rb
-- test/integration/proxy_test.rb
-- test/integration/user_test.rb
 - test/irb.rb
 - test/support/app.rb
 - test/support/proxy.rb
+- test/support/type_class_proxy.rb
 - test/support/user.rb
-- test/unit/ns-options/assert_macros_test.rb
-- test/unit/ns-options/boolean_test.rb
-- test/unit/ns-options/has_options_test.rb
-- test/unit/ns-options/helper/advisor_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_test.rb
-- test/unit/ns-options/options_test.rb
-- test/unit/ns-options/proxy_test.rb
+- test/system/app_tests.rb
+- test/system/proxy_tests.rb
+- test/system/type_class_proxy_tests.rb
+- test/system/user_tests.rb
+- test/unit/assert_macros_tests.rb
+- test/unit/boolean_tests.rb
+- test/unit/namespace_advisor_tests.rb
+- test/unit/namespace_data_tests.rb
+- test/unit/namespace_tests.rb
+- test/unit/namespaces_tests.rb
+- test/unit/option_tests.rb
+- test/unit/options_tests.rb
+- test/unit/proxy_method_tests.rb
+- test/unit/proxy_tests.rb
+- test/unit/root_methods_tests.rb

data/lib/ns-options/errors/invalid_name.rb

@@ -1,15 +0,0 @@
-module NsOptions
-  module Errors
-
-    class InvalidName < StandardError
-      attr_accessor :message
-
-      def initialize(message, backtrace)
-        self.message = message
-        self.set_backtrace(backtrace)
-      end
-
-    end
-
-  end
-end

data/lib/ns-options/has_options.rb

@@ -1,53 +0,0 @@
-module NsOptions
-
-  module HasOptions
-    class << self
-
-      def included(klass)
-        klass.class_eval do
-          extend NsOptions::HasOptions::DSL
-        end
-      end
-
-    end
-
-    module DSL
-
-      # This is the main DSL method for creating a namespace of options for your
-      # class/module. This will define a class method for both classes and
-      # modules and an additional instance method for classes. The namespace is
-      # then created and returned by calling the class method version.  For
-      # classes, the instance method will build an entirely new namespace from
-      # the class level namespace. This is so when you define options at the
-      # class level:
-      #
-      # class Something
-      #   include NsOptions
-      #   options(:settings) do
-      #      option :root
-      #   end
-      # end
-      #
-      # the namespaces at the instance level still get all the defined options,
-      # but are completely separate objects from the class and other instances.
-      # Modules only deal with a single namespace at the module level.
-
-      # The options method takes three args:
-      # * `name` : what to name the defined methods for accessing the namespace
-      # * `key`  : (optional) what to key the created namespace objects with
-      #            - defaults to `name`
-      #            - useful if persisting namespaces into some key-value store
-      # * `block`: (optional) a predefined set of nested options and namespaces
-
-      def options(name, key = nil, &block)
-        NsOptions::Helper.advisor.is_this_namespace_ok?(name, caller)
-        NsOptions::Helper.define_root_namespace_methods(self, name, key)
-        self.send(name, &block)
-      end
-      alias_method :opts, :options
-
-    end
-
-  end
-
-end

data/lib/ns-options/helper/advisor.rb

@@ -1,88 +0,0 @@
-require 'ns-options/errors/invalid_name'
-
-module NsOptions
-  module Helper
-
-    class Advisor
-      attr_accessor :namespace
-
-      def initialize(namespace)
-        self.namespace = namespace
-      end
-
-      # root namespace advisor
-
-      def is_this_namespace_ok?(name, from = nil)
-        if [:options].include?(name.to_sym)
-          puts self.not_recommended_method_message('namespace', name)
-        else
-          return true
-        end
-        puts "From: #{(from || caller).first}"
-        false
-      end
-
-      # sub-namespace / namespace-option advisors
-
-      def is_this_sub_namespace_ok?(name, from = nil)
-        self.is_this_ok?(:'sub-namespace', name, (from || caller))
-      end
-
-      def is_this_option_ok?(name, from = nil)
-        self.is_this_ok?(:option, name, (from || caller))
-      end
-
-      # helper methods
-
-      def is_this_ok?(kind, name, from)
-        display = kind.to_s
-        if self.bad_methods.include?(name.to_sym)
-          message = self.bad_method_message(display, name)
-          exception = NsOptions::Errors::InvalidName.new(message, from)
-          raise(exception)
-        elsif self.is_already_defined?(name)
-          puts self.duplicate_message(name)
-        elsif self.not_recommended_methods.include?(name.to_sym)
-          puts self.not_recommended_method_message(display, name)
-        else
-          return true
-        end
-        puts "From: #{from.first}"
-        false
-      end
-
-      def is_already_defined?(name)
-        self.namespace.options.is_defined?(name) ||
-        self.namespace.options.is_namespace_defined?(name)
-      end
-
-      def bad_methods
-        @bad_methods ||= [ :option, :namespace, :define, :options ]
-      end
-
-      def not_recommended_methods
-        @not_recommended_methods ||= NsOptions::Namespace.instance_methods(false).map(&:to_sym)
-      end
-
-      def bad_method_message(kind, name)
-        [ "The #{kind} '#{name}' overwrites a namespace method that NsOptions depends on.",
-          "Please choose a different name for your #{kind}."
-        ].join(" ")
-      end
-
-      def duplicate_message(name)
-        [ "WARNING! '#{name}' has already been defined and will be overwritten.",
-          "It's likely that it will not behave as expected."
-        ].join(" ")
-      end
-
-      def not_recommended_method_message(kind, name)
-        [ "WARNING! The #{kind} '#{name}' overwrites a method NsOptions depends on.",
-          "This will limit some of the functionality of NsOptions."
-        ].join(" ")
-      end
-
-    end
-
-  end
-end

data/lib/ns-options/helper.rb

@@ -1,87 +0,0 @@
-require 'ns-options/helper/advisor'
-
-module NsOptions
-
-  module Helper
-
-    module_function
-
-    def find_and_define_namespace(namespace, name)
-      sub_namespace = namespace.options.get_namespace(name)
-      self.define_namespace_methods(namespace, name)
-      sub_namespace
-    end
-
-    def define_namespace_methods(namespace, name)
-      namespace.metaclass.class_eval <<-DEFINE_METHOD
-
-        def #{name}(&block)
-          namespace = self.options.namespaces.get("#{name}")
-          namespace.define(&block) if block
-          namespace
-        end
-
-      DEFINE_METHOD
-    end
-
-    def find_and_define_option(namespace, option_name)
-      option = namespace.options[option_name]
-      self.define_option_methods(namespace, option)
-      option
-    end
-
-    def define_option_methods(namespace, option)
-      namespace.metaclass.class_eval <<-DEFINE_METHOD
-
-        def #{option.name}(*args)
-          if !args.empty?
-            self.send("#{option.name}=", *args)
-          else
-            self.options.get(:#{option.name})
-          end
-        end
-
-        def #{option.name}=(*args)
-          value = args.size == 1 ? args.first : args
-          self.options.set(:#{option.name}, value)
-        end
-
-      DEFINE_METHOD
-    end
-
-    def advisor(namespace=nil)
-      NsOptions::Helper::Advisor.new(namespace)
-    end
-
-    def define_root_namespace_methods(define_on, name, key=nil)
-      key ||= name.to_s
-
-      # covers defining on Modules and at the class-level of Classes
-      method_definitions = <<-CLASS_METHOD
-
-        def self.#{name}(&block)
-          @#{name} ||= NsOptions::Namespace.new('#{key}', &block)
-        end
-
-      CLASS_METHOD
-
-      if define_on.kind_of?(Class)
-        # covers defining at the instance-level of Classes
-        method_definitions += <<-INSTANCE_METHOD
-
-          def #{name}(&block)
-            unless @#{name}
-              @#{name} = NsOptions::Namespace.new('#{key}', &block)
-              @#{name}.options.build_from(self.class.#{name}.options, @#{name})
-            end
-            @#{name}
-          end
-
-        INSTANCE_METHOD
-      end
-      define_on.class_eval(method_definitions)
-    end
-
-  end
-
-end