ns-options 1.0.1 → 1.1.0

data/README.md

@@ -393,6 +393,60 @@ t = Thing.new(:one => 1, :two => 2, :three => 3)
 t.to_hash  # => {:one => 1, :two => 2, :three => 3}
 ```
 
+## NsOptions::Struct
+
+Much like a traditional ruby `Struct`, `NsOptions::Struct` is a class that creates other classes.  However, `NsOptions::Struct` creates _proxy_ classes.  There are a number of ways to do this:
+
+```ruby
+NsOptions::Struct.new                     #=> #<#<Class:0x1076166d0>:#<NsOptions::
+Thing = NsOptions::Struct.new             #=> #<Thing:#<NsOptions::
+Thing = Class.new(NsOptions::Struct.new)  #=> #<Thing:#<NsOptions::
+class Thing < NsOptions::Struct.new; end  #=> #<Thing:#<NsOptions::
+```
+
+`NsOptions::Struct` objects, being proxies, can be created with a hash of values and support dynamic writers (much like an `OpenStruct`).
+
+```ruby
+Thing = NsOptions::Struct.new
+
+thing = Thing.new(:something => 1)
+thing.something   #=> 1
+thing.otherthing  #=> NoMethodError
+thing.otherthing = 2
+thing.otherthing  #=> 2
+```
+
+You can pre-define the structure, including default values and type-casting info.
+
+```ruby
+Thing = NsOptions::Struct.new do
+  option :something,  Integer, :default => 1
+  option :otherthing, String
+end
+
+thing = Thing.new(:yet_another => 12.5)
+thing.something    #=> 1
+thing.otherthing   #=> nil
+thing.otherthing = 2
+thing.otherthing   #=> '2'
+thing.yet_another  #=> 12.5
+```
+
+And since struct classes are proxies, you don't have to create instances of them if you don't need to.
+
+```ruby
+thing = NsOptions::Struct.new(:yet_another => 12.5) do
+  option :something,  Integer, :default => 1
+  option :otherthing, String
+end
+
+thing.something    #=> 1
+thing.otherthing   #=> nil
+thing.otherthing = 2
+thing.otherthing   #=> '2'
+thing.yet_another  #=> 12.5
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/ns-options/struct.rb

@@ -0,0 +1,13 @@
+require 'ns-options/proxy'
+
+module NsOptions::Struct
+
+  def self.new(opts=nil, &block)
+    Class.new.tap do |klass|
+      klass.class_eval { include NsOptions::Proxy }
+      klass.define(&block)
+      klass.apply(opts)
+    end
+  end
+
+end

data/lib/ns-options/version.rb

@@ -1,3 +1,3 @@
 module NsOptions
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/ns-options.rb

@@ -1,5 +1,6 @@
 require 'ns-options/root_methods'
 require 'ns-options/proxy'
+require 'ns-options/struct'
 
 module NsOptions
 

data/test/unit/struct_tests.rb

@@ -0,0 +1,66 @@
+require 'assert'
+require 'ns-options/proxy'
+require 'ns-options/struct'
+
+module NsOptions::Struct
+
+  class BaseTests < Assert::Context
+    desc "NsOptions::Struct"
+    setup do
+      @struct = NsOptions::Struct.new
+    end
+    subject { @struct }
+
+    should "be a proxy class" do
+      assert_kind_of ::Class, subject
+      assert subject.ancestors.include?(::NsOptions::Proxy)
+    end
+
+  end
+
+  class StructGlobalTests < BaseTests
+    desc "assigned to a global"
+    setup do
+      Thing = NsOptions::Struct.new
+    end
+    subject { Thing }
+
+    should "be a proxy class" do
+      assert_kind_of ::Class, subject
+      assert subject.ancestors.include?(::NsOptions::Proxy)
+    end
+
+  end
+
+  class StructClassTests < BaseTests
+    desc "used as the superclass to another class"
+    setup do
+      Thing = Class.new(NsOptions::Struct.new)
+    end
+    subject { Thing }
+
+    should "be a proxy class" do
+      assert_kind_of ::Class, subject
+      assert subject.ancestors.include?(::NsOptions::Proxy)
+    end
+
+  end
+
+  class StructureTests < BaseTests
+    desc "created with a structure and values"
+    setup do
+      @struct = NsOptions::Struct.new(:a => 'aye') do
+        option :b, Symbol, :default => :bee
+        option :c
+      end
+    end
+
+    should "should define the structure and apply the values" do
+      assert_equal 'aye', subject.a
+      assert_equal :bee,  subject.b
+      assert_nil subject.c
+    end
+
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ns-options
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Collin Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-05 00:00:00 Z
+date: 2012-12-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: assert
@@ -61,6 +61,7 @@ files:
 - lib/ns-options/proxy.rb
 - lib/ns-options/proxy_method.rb
 - lib/ns-options/root_methods.rb
+- lib/ns-options/struct.rb
 - lib/ns-options/version.rb
 - log/.gitkeep
 - ns-options.gemspec
@@ -85,6 +86,7 @@ files:
 - test/unit/proxy_method_tests.rb
 - test/unit/proxy_tests.rb
 - test/unit/root_methods_tests.rb
+- test/unit/struct_tests.rb
 homepage: https://github.com/redding/ns-options
 licenses: []
 
@@ -140,3 +142,4 @@ test_files:
 - test/unit/proxy_method_tests.rb
 - test/unit/proxy_tests.rb
 - test/unit/root_methods_tests.rb
+- test/unit/struct_tests.rb