structx 0.1.0 → 0.1.1

data/README.md

@@ -16,7 +16,7 @@ StructX is an extension of Ruby standard Struct. The diffences are that 1) the c
 StructX.new(:x, :y, :z).new(x: 1, y: 2, z: 3) #=> #<struct x=1, y=10, z=100>
 ```
 
-### Member sentences
+### Member declarations
 
 ```ruby
 class A < StructX
@@ -38,6 +38,21 @@ end
 B.new(1) # => #<struct B x=1, y=10, z=100>
 ```
 
+### Immutable mode
+
+```ruby
+class C < StructX
+  immutable true
+  member :x
+  member :y
+  member :z
+end
+orig = C.new(1, 2, 3) #=> #<struct C x=1, y=2, z=3>
+updated = orig.set(x: 4, y: 5, z: 6) #=> #<struct C x=4, y=5, z=6>
+orig.values    #=> [1, 2, 3]
+updated.values #=> [4, 5, 6]
+```
+
 ## Documentation
 
 - [API Documentation](http://rubydoc.info/gems/structx)

data/lib/structx.rb

@@ -93,15 +93,24 @@ class StructX
       end
     end
 
+    def immutable(b=true)
+      @immutable = b
+    end
+
+    def immutable?
+      @immutable
+    end
+
     private
 
     def inherited(subclass)
       @member.each {|key, data| subclass.member(key, data)} if @member
+      subclass.instance_variable_set(:@immutable, true) if @immutable
     end
   end
 
   # almost methods are forwarded to value table
-  forward :class, :members
+  forward! :class, :members, :immutable?
   forward :@value, :each, :each_pair
   forward! :@value, :values, :length, :size, :hash
   forward! lambda{|x| @value.values}, :each, :values_at
@@ -128,13 +137,41 @@ class StructX
     end
   end
 
+  # Same as Struct#[].
+  alias :get :"[]"
+
   # Same as Struct#[]=.
   def []=(idx, val)
     case idx
     when Integer
-      size > idx && -size <= idx ? @value[members[idx]] = val : (raise IndexError.new(idx))
+      if size > idx && -size <= idx
+        if not(immutable?)
+          @value[members[idx]] = val
+        else
+          self.class.new(@value.merge(members[idx] => val))
+        end
+      else
+        raise IndexError.new(idx)
+      end
     when Symbol, String
-      members.include?(idx.to_sym) ? @value[idx.to_sym] = val : (raise NameError.new(idx.to_s))
+      if members.include?(idx.to_sym)
+        if not(immutable?)
+          @value[idx.to_sym] = val
+        else
+          self.class.new(@value.merge(idx.to_sym => val))
+        end
+      else
+        raise NameError.new(idx.to_s)
+      end
+    end
+  end
+
+  # Same as #[]=, but you can set values by hash.
+  def set(pairs={})
+    if not(immutable?)
+      pairs.each {|idx, val| obj[idx] = val}
+    else
+      pairs.inject(self) {|obj, (idx, val)| obj.send("[]=", idx, val)}
     end
   end
 

data/lib/structx/version.rb

@@ -1,4 +1,4 @@
 class StructX
   # version of StructX
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/spec_structx.rb

@@ -10,6 +10,7 @@ describe "StructX" do
   describe "StructX.new(:x, :y, :z)" do
     before do
       @class = StructX.new(:x, :y, :z)
+      @immutable = Class.new(@class).tap {|subclass| subclass.immutable}
     end
 
     it "should have 3 members" do
@@ -90,6 +91,10 @@ describe "StructX" do
         x[:y].should == 2
         x[:z].should == 3
         should.raise(NameError) { x[:a] }
+        # by #get
+        x.get(:x).should == 1
+        x.get(:y).should == 2
+        x.get(:z).should == 3
       end
     end
 
@@ -111,6 +116,12 @@ describe "StructX" do
         x[:z].should == 5
         should.raise(NameError) { x[:a] = 1}
       end
+      # immutable tests
+      orig = @immutable.new(1, 2, 3)
+      orig.values.should == [1, 2, 3]
+      updated = orig.set(x: 4, y: 5, z: 6)
+      updated.values.should == [4, 5, 6]
+      orig.values.should == [1, 2, 3]
     end
 
     it "should iterate values" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: structx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-25 00:00:00.000000000 Z
+date: 2013-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forwardablex
@@ -144,12 +144,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1674864282059584366
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1674864282059584366
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -164,3 +170,4 @@ test_files:
 - test/ruby/2.0/test_struct.rb
 - test/run.sh
 - test/spec_structx.rb
+has_rdoc: