key_struct 0.2.1 → 0.3.0

data/README.rdoc

@@ -94,12 +94,19 @@ primary comparison key, and so on down the line.  Thus:
     LastFirst = KeyStruct[:last, :first]
     LastFirst.new(:first => "Abigail", :last => "Zither") <=> LastFirst.new(:first => "Zenobia", :last => "Aardvark") # --> +1
 
+== to_s and inspect
+
+KeyStruct classes define reasonable default +to_s+ and +inspect+ methods, along the lines of:
+
+        Name.new(:first => "Jack", :last => "Ripper").to_s      # --> '[Name first:Jack last:Ripper]'
+        Name.new(:first => "Jack", :last => "Ripper").inspect   # --> '<Name:0x1234abcd first:"Jack" last:"Ripper">'
+
 == Converting to a hash
 
 KeyStruct classes define a +to_hash+ method that returns a hash containing
 all members and their values:
 
-        Name.new(:first => "Jack", :last => "Ripper").to_hash # --> {:first => "Jack", :last => "Ripper")
+        Name.new(:first => "Jack", :last => "Ripper").to_hash   # --> {:first => "Jack", :last => "Ripper")
 
 == Installation
 
@@ -119,6 +126,7 @@ Requires ruby >= 1.9.2.  (Has been tested on MRI 1.9.2 and MRI 1.9.3)
 
 Release Notes:
 
+* 0.3.0 - Introduced to_s and inspect
 * 0.2.1 - Bug fix: return false for == with an incompatible object.  Was raising NoMethodError
 * 0.2.0 - Introduced <=> and to_hash
 * 0.1.0 - Introduced ==

data/lib/key_struct/key_struct.rb

@@ -40,6 +40,12 @@ module KeyStruct
       define_method(:to_hash) do
         Hash[*keys.map{ |key| [key, self.send(key)]}.flatten(2)]
       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

data/lib/key_struct/version.rb

@@ -1,3 +1,3 @@
 module KeyStruct
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/spec/key_struct_spec.rb

@@ -149,5 +149,16 @@ describe "KeyStruct" do
     KeyStruct.accessor(:a => 3, :b => 4).new.to_hash.should == {:a => 3, :b => 4}
   end
 
+  context "display as a string" do
+    PrintMe = KeyStruct[:a => 3, :b => "hello"]
+
+    it "should be nice for :to_s" do
+      PrintMe.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">/
+    end
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: key_struct
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-15 00:00:00.000000000 Z
+date: 2011-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70104882335960 !ruby/object:Gem::Requirement
+  requirement: &70193269639900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70104882335960
+  version_requirements: *70193269639900
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70104882335360 !ruby/object:Gem::Requirement
+  requirement: &70193269639420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70104882335360
+  version_requirements: *70193269639420
 - !ruby/object:Gem::Dependency
   name: simplecov-gem-adapter
-  requirement: &70104882334760 !ruby/object:Gem::Requirement
+  requirement: &70193269638820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70104882334760
+  version_requirements: *70193269638820
 description: Defines KeyStruct analogous to Struct, but constructor takes keyword
   arguments
 email: