key_struct 0.3.1 → 0.4.0

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.rspec
 Gemfile.lock
 InstalledFiles
 _yardoc

data/README.rdoc

@@ -108,6 +108,14 @@ all members and their values:
 
         Name.new(:first => "Jack", :last => "Ripper").to_hash   # --> {:first => "Jack", :last => "Ripper")
 
+== Introspection
+
+KeyStruct classes let you examine their definition:
+
+        Name = KeyStruct[:first, :last => "Doe"]
+        Name.keys       # --> [ :first, :last ]
+        Name.defaults   # --> { :last => "Doe" }
+
 == Installation
 
 Install via:
@@ -126,6 +134,7 @@ Requires ruby >= 1.9.2.  (Has been tested on MRI 1.9.2 and MRI 1.9.3)
 
 Release Notes:
 
+* 0.4.0 - Introduce class introspection
 * 0.3.1 - Bug fix: to_hash when a value is an array.  Was raising ArgumentError for Hash
 * 0.3.0 - Introduced to_s and inspect
 * 0.2.1 - Bug fix: return false for == with an incompatible object.  Was raising NoMethodError

data/lib/key_struct/key_struct.rb

@@ -15,21 +15,29 @@ module KeyStruct
   private
 
   def self.define_key_struct(access, keys) 
-    Class.new.class_eval do
+
+    defaults = (Hash === keys.last) ? keys.pop : {}
+    keys += defaults.keys
+
+    Class.new.tap{ |klass| klass.class_eval do
       include Comparable
-      keyvalues = Hash[*keys.map{|key| (Hash === key) ? key.to_a : [key, nil]}.flatten(2)]
-      keys = keyvalues.keys
       send access, *keys
+
+      define_singleton_method(:keys) { keys }
+      define_singleton_method(:defaults) { defaults }
+
       define_method(:initialize) do |args={}|
-        args = keyvalues.merge(args)
+        args = defaults.merge(args)
         keys.each do |key|
           instance_variable_set("@#{key}".to_sym, args.delete(key))
         end
-        raise ArgumentError, "Invalid argument(s): #{args.keys.map(&:inspect).join(' ')}; KeyStruct accepts #{keys.map(&:inspect).join(' ')}" if args.any?
+        raise ArgumentError, "Invalid argument(s): #{args.keys.map(&:inspect).join(' ')} -- KeyStruct accepts #{keys.map(&:inspect).join(' ')}" if args.any?
       end
+
       define_method(:==) do |other|
         keys.all?{|key| other.respond_to?(key) and self.send(key) == other.send(key)}
       end
+
       define_method(:<=>) do |other|
         keys.each do |key|
           cmp = (self.send(key) <=> other.send(key))
@@ -37,17 +45,21 @@ module KeyStruct
         end
         0
       end
+
       define_method(:to_hash) do
         Hash[*keys.map{ |key| [key, self.send(key)]}.flatten(1)]
       end
+
       define_method(:to_s) do
         "[#{self.class.name} #{keys.map{|key| "#{key}:#{self.send(key)}"}.join(' ')}]"
       end
+
       define_method(:inspect) do
         "<#{self.class.name}:0x#{self.object_id.to_s(16)} #{keys.map{|key| "#{key}:#{self.send(key).inspect}"}.join(' ')}>"
       end
-      self
+
     end
+    }
   end
 
 end

data/lib/key_struct/version.rb

@@ -1,3 +1,3 @@
 module KeyStruct
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/spec/key_struct_spec.rb

@@ -1,83 +1,29 @@
 require 'spec_helper'
 
-describe "KeyStruct" do
-
-  it "creates a class using KeyStruct.accessor" do
-    Class.should === KeyStruct.accessor(:a, :b, :c => 3)
-  end
-
-  it "creates a class using KeyStruct.reader" do
-    Class.should === KeyStruct.reader(:a, :b, :c => 3)
-  end
+shared_examples "a keystruct" do |method|
 
-  it "creates a class using KeyStruct[]" do
-    Class.should === KeyStruct[:a, :b, :c => 3]
-  end
+  context "basic" do
 
-  it "can handle a default that's an array" do
-    expect { KeyStruct.reader(:a => []) }.should_not raise_error
-  end
-
-  it "[] should be an alias for accessor" do
-    KeyStruct.method(:[]).should == KeyStruct.method(:accessor)
-  end
-
-  context "reader" do
-    before(:all) do 
-      @klass = KeyStruct.reader(:a, :b, :c => 3)
+    before(:each) do
+      @klass = KeyStruct.send(method, :a, :b, :c => 3)
     end
 
-    it "provides getters" do
-      @klass.instance_methods.should include(:a)
-      @klass.instance_methods.should include(:b)
-      @klass.instance_methods.should include(:c)
+    it "creates a class" do
+      Class.should === @klass
     end
 
-    it "does not provide setters" do
-      @klass.instance_methods.should_not include(:"a=")
-      @klass.instance_methods.should_not include(:"b=")
-      @klass.instance_methods.should_not include(:"c=")
+    it "should instrospect keys" do
+      @klass.keys.should == [:a, :b, :c]
     end
 
-    it "initializer accepts all key args" do
-      expect { @klass.new(:a => 1, :b => 2, :c => 3) }.should_not raise_error
-    end
-
-    it "initializer accepts some key args" do
-      expect { @klass.new(:a => 1) }.should_not raise_error
-    end
-
-    it "initializer accepts no args" do
-      expect { @klass.new }.should_not raise_error
-    end
-
-    it "initializer raises error for invalid args" do
-      expect { @klass.new(:d => 4) }.should raise_error
-    end
-
-    it "getters returns initial/default argument values" do
-      reader = @klass.new(:a => 1)
-      reader.a.should == 1
-      reader.b.should be_nil
-      reader.c.should == 3
-    end
-  end
-
-  context "accessor" do
-    before(:all) do 
-      @klass = KeyStruct.accessor(:a, :b, :c => 3)
+    it "should instrospect defaults" do
+      @klass.defaults.should == {:c => 3}
     end
 
     it "provides getters" do
-      @klass.instance_methods.should include(:a)
-      @klass.instance_methods.should include(:b)
-      @klass.instance_methods.should include(:c)
-    end
-
-    it "provides setters" do
-      @klass.instance_methods.should include(:"a=")
-      @klass.instance_methods.should include(:"b=")
-      @klass.instance_methods.should include(:"c=")
+      @klass.instance_methods.should include :a
+      @klass.instance_methods.should include :b
+      @klass.instance_methods.should include :c
     end
 
     it "initializer accepts all key args" do
@@ -96,26 +42,19 @@ describe "KeyStruct" do
       expect { @klass.new(:d => 4) }.should raise_error
     end
 
-    it "getters return initial argument values" do
+    it "getters returns initial/default argument values" do
       reader = @klass.new(:a => 1)
       reader.a.should == 1
       reader.b.should be_nil
       reader.c.should == 3
     end
 
-    it "setters work as expected" do
-      reader = @klass.new(:a => 1)
-      reader.b = 2
-      reader.c = 4
-      reader.a.should == 1
-      reader.b.should == 2
-      reader.c.should == 4
-    end
   end
 
   context "comparison" do
-    before(:all) do 
-      @klass = KeyStruct.accessor(:a, :b, :c)
+
+    before(:each) do 
+      @klass = KeyStruct.send(method, :a, :b, :c)
     end
 
     it "returns true iff all members are ==" do
@@ -146,23 +85,85 @@ describe "KeyStruct" do
   end
 
   it "returns hash using to_hash" do
-    KeyStruct.accessor(:a => 3, :b => 4).new.to_hash.should == {:a => 3, :b => 4}
+    KeyStruct.send(method, :a => 3, :b => 4).new.to_hash.should == {:a => 3, :b => 4}
   end
 
   it "returns hash using to_hash when value is array" do
-    KeyStruct.accessor(:a => 3, :b => [[1,2], [3,4]]).new.to_hash.should == {:a => 3, :b => [[1,2],[3,4]]}
+    KeyStruct.send(method, :a => 3, :b => [[1,2], [3,4]]).new.to_hash.should == {:a => 3, :b => [[1,2],[3,4]]}
+  end
+
+  it "can handle a default that's an array" do
+    expect { KeyStruct.send(method, :a => []) }.should_not raise_error
   end
 
   context "display as a string" do
-    PrintMe = KeyStruct[:a => 3, :b => "hello"]
+
+    around(:each) do |example|
+      PrintMe = @klass = KeyStruct.send(method, :a => 3, :b => "hello")
+      example.run
+      Object.send(:remove_const, :PrintMe)
+    end
 
     it "should be nice for :to_s" do
-      PrintMe.new.to_s.should == "[PrintMe a:3 b:hello]"
+      @klass.new.to_s.should == "[PrintMe a:3 b:hello]"
     end
 
     it "should be detailed for :inspect" do
-      PrintMe.new.inspect.should match /<PrintMe:0x[0-9a-f]+ a:3 b:"hello">/
+      @klass.new.inspect.should match /<PrintMe:0x[0-9a-f]+ a:3 b:"hello">/
+    end
+  end
+
+end
+
+describe "KeyStruct" do
+
+  context "reader" do
+
+    it_behaves_like "a keystruct", :reader
+
+    context "basic" do
+      before(:each) do 
+        @klass = KeyStruct.reader(:a, :b, :c => 3)
+      end
+
+      it "does not provide setters" do
+        @klass.instance_methods.should_not include :"a="
+        @klass.instance_methods.should_not include :"b="
+        @klass.instance_methods.should_not include :"c="
+      end
+    end
+
+  end
+
+  context "accessor" do
+    it_behaves_like "a keystruct", :accessor
+
+    it "[] should be an alias for accessor" do
+      KeyStruct.method(:[]).should == KeyStruct.method(:accessor)
+    end
+
+    context "basic" do
+
+      before(:each) do 
+        @klass = KeyStruct.accessor(:a, :b, :c => 3)
+      end
+
+      it "does provides setters" do
+        @klass.instance_methods.should include :"a="
+        @klass.instance_methods.should include :"b="
+        @klass.instance_methods.should include :"c="
+      end
+
+      it "setters work as expected" do
+        reader = @klass.new(:a => 1)
+        reader.b = 2
+        reader.c = 4
+        reader.a.should == 1
+        reader.b.should == 2
+        reader.c.should == 4
+      end
     end
   end
 
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: key_struct
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-20 00:00:00.000000000 Z
+date: 2012-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70145079063240 !ruby/object:Gem::Requirement
+  requirement: &70338235182700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70145079063240
+  version_requirements: *70338235182700
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70145079062540 !ruby/object:Gem::Requirement
+  requirement: &70338235177160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70145079062540
+  version_requirements: *70338235177160
 - !ruby/object:Gem::Dependency
   name: simplecov-gem-adapter
-  requirement: &70145079062020 !ruby/object:Gem::Requirement
+  requirement: &70338235172560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70145079062020
+  version_requirements: *70338235172560
 description: Defines KeyStruct analogous to Struct, but constructor takes keyword
   arguments
 email:
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.12
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Defines KeyStruct analogous to Struct, but constructor takes keyword arguments