key_struct 0.0.2 → 0.1.0

data/README.rdoc

@@ -1,7 +1,8 @@
 = key_struct
 
-Defines KeyStruct, which is the same as ruby's Struct, but the initializer
-takes keyword args (using a hash, rails-style).  Use it to define a class via:
+Defines KeyStruct, which acts the same as ruby's Struct but the struct's
+initializer takes keyword args (using a hash, rails-style).  Use it to
+define a class via:
 
   Name = KeyStruct[:first, :last]
 
@@ -19,32 +20,46 @@ Then you can create an instance of the class using keywords for the parameters:
 
 and you have the usal readers and writers:
 
-  name.first            --> "Jack"
-  name.last             --> "Ripper"
+  name.first            # --> "Jack"
+  name.last             # --> "Ripper"
   name.last = "Sprat"
-  name.last             --> "Sprat"
-  name.to_s             --> "Sprat, Jack" for the enhanced class example
+  name.last             # --> "Sprat"
+  name.to_s             # --> "Sprat, Jack" for the enhanced class example
 
-If you leave off a keyword when instantiating, normally the value is nil:
+== Readers and Writers
+
+As per above, the normal behavior is get readers and writers.  But, by analogy with +attr_reader+ vs +attr_accessor+, you can choose whether you want read/write or just read:
+
+  Writeable = KeyStruct.accesor(:first, :last)      # aliased as KeyStruct[]
+  Readonly = KeyStruct.reader(:first, :last)        # class has readers but not writers
+
+== Default values
+
+If you leave off a keyword when instantiating, normally the member value is nil:
 
   name = Name.new(:first => "Jack")
-  name.last             --> nil
+  name.last             # --> nil
 
 But the class definition can specify defaults, e.g.
 
   Name = KeyStruct[:first, :last => "Doe"]
+
   name = Name.new(:first => "John")
-  name.first            --> "John"
-  name.last             --> "Doe"
+  name.first            # --> "John"
+  name.last             # --> "Doe"
+
+== Argument Checking
 
 The struct initializer checks for invalid arguments:
 
-  name = Name.new(:middle => "Xaviar")  --> raises ArgumentError
+  name = Name.new(:middle => "Xaviar")  # --> raises ArgumentError
+
+== Equaltiy
 
-The gem actually provides two types of KeyStruct classes
+KeyStruct classes define the == operator, which returns true iff all corresponding struct members are equal (likewise via ==)
 
-  KeyStruct.accesor(*keys)      # aliased as KeyStruct[]
-  KeyStruct.reader(*keys)       # class has readers but not writers
+    Name.new(:first => "John", :last => "Doe") == Name.new(:first => "John", :last => "Doe")    # --> true
+    Name.new(:first => "John", :last => "Doe") == Name.new(:first => "Jane", :last => "Doe")    # --> false
 
 == Installation
 

data/lib/key_struct.rb

@@ -29,6 +29,9 @@ module KeyStruct
         end
         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| self.send(key) == other.send(key)}
+      end
     end
     klass
   end

data/lib/key_struct/version.rb

@@ -1,3 +1,3 @@
 module KeyStruct
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/key_struct_spec.rb

@@ -109,4 +109,16 @@ describe "KeyStruct" do
     end
   end
 
+  context "==" do
+    before(:all) do 
+      @klass = KeyStruct.accessor(:a, :b)
+    end
+
+    it "returns true iff all members are ==" do
+      @klass.new(:a => 1, :b => 2).should == @klass.new(:a => 1, :b => 2)
+      @klass.new(:a => 1, :b => 2).should_not == @klass.new(:a => 1, :b => 3)
+    end
+  end
+
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: key_struct
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-19 00:00:00.000000000 Z
+date: 2011-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70176913804560 !ruby/object:Gem::Requirement
+  requirement: &70365334363320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70176913804560
+  version_requirements: *70365334363320
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70176913804080 !ruby/object:Gem::Requirement
+  requirement: &70365334361480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70176913804080
+  version_requirements: *70365334361480
 - !ruby/object:Gem::Dependency
   name: simplecov-gem-adapter
-  requirement: &70176913803620 !ruby/object:Gem::Requirement
+  requirement: &70365334359460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70176913803620
+  version_requirements: *70365334359460
 description: Defines KeyStruct analogous to Struct, but constructor takes keyword
   arguments
 email: