immutable-struct 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89bdf872c24c20ae1e37d7401e9ba4a5c4c464bb
-  data.tar.gz: 521fa49dfeed67bba17e67df389ad5f228ad7b71
+  metadata.gz: 4e4b4a2c3e90fd194dd9f1085251225de29879d3
+  data.tar.gz: 3e28dc475148a8fe9c6513c057ca405e303fc052
 SHA512:
-  metadata.gz: 2cec1d2b58020662208393fffbdad46b0082a1007edeab7478e69c67ec764b7c3a1231898c4314032d748bfe0767fb1787c7f2c4e1465e73e24c3b0a40e65e13
-  data.tar.gz: c7251a13f171e5418d84e4aab6d36c35a18ce9d35a4c19788b5dfea888a5360657728de99999fde97c7dff624e3f17d12505480510396c4a25a1f12b0cb4959b
+  metadata.gz: debc18bb3ae8aefdf002b22725e2fb67e6b9fdcb32a550831e25c336eeeaaa5d6d6fc539d3f0fa7e7e3b6972116516128f20dcbbee439ade9d320a3f439bd208
+  data.tar.gz: 52c21f88124f4de2edaf137fad39100b8f85e91cc89878b3570998b40f53df8f108261807c5df3432a8b754614bbb1c56ba9a7d699a18cde6d4733c767fb641d

data/README.rdoc

@@ -23,7 +23,7 @@ If not using bundler, just use RubyGems:
 
 == To use
 
-    Person = StitchFix::ImmutableStruct.new(:name, :age, :job, :active?) do
+    Person = ImmutableStruct.new(:name, :age, :job, :active?, [:addresses]) do
       def minor?
         age < 18
       end
@@ -33,10 +33,13 @@ If not using bundler, just use RubyGems:
                    age: 40,        # age will be 40
                                    # job is omitted, so will be nil
                    active: true)   # active and active? will be true
-    p.name    # => "Dave"
-    p.age     # => 40
-    p.active? # => true
-    p.minor?  # => false
+                                   # addresses is omitted, but since we've selected
+                                   # Array coercion, it'll be []
+    p.name      # => "Dave"
+    p.age       # => 40
+    p.active?   # => true
+    p.minor?    # => false
+    p.addresses # => []
 
 You can also treat the interior as a normal class definition.  
 

data/lib/immutable-struct.rb

@@ -6,7 +6,7 @@
 # will be evaluated as if it were inside a class definition, allowing you
 # to add methods, include or extend modules, or do whatever else you want.
 class ImmutableStruct
-  VERSION='2.0.0' #:nodoc:
+  VERSION='2.1.0' #:nodoc:
   # Create a new class with the given read-only attributes.
   #
   # attributes:: list of symbols or strings that can be used to create attributes.
@@ -14,6 +14,9 @@ class ImmutableStruct
   #              an attribute without a question mark that passes through the raw
   #              value and an attribute *with* the question mark that coerces that
   #              value to a boolean.  You would initialize it with the non-question-mark value
+  #              An attribute that is an array of one symbol will create an attribute named for
+  #              that symbol, but that doesn't return nil, instead returning the +to_a+ of the
+  #              value passed to the construtor.
   # block:: if present, evaluates in the context of the new class, so +def+, +def.self+, +include+
   #         and +extend+ should all work as in a normal class definition.
   #
@@ -42,6 +45,8 @@ class ImmutableStruct
           define_method(attribute) do
             !!instance_variable_get("@#{raw_name}")
           end
+        elsif attribute.kind_of?(Array) and attribute.size == 1
+          attr_reader attribute[0]
         else
           attr_reader attribute
         end
@@ -50,8 +55,13 @@ class ImmutableStruct
       define_method(:initialize) do |*args|
         attrs = args[0] || {}
         attributes.each do |attribute|
-          ivar_name = attribute.to_s.gsub(/\?$/,'')
-          instance_variable_set("@#{ivar_name}",attrs[ivar_name.to_s] || attrs[ivar_name.to_sym])
+          if attribute.kind_of?(Array) and attribute.size == 1
+            ivar_name = attribute[0].to_s
+            instance_variable_set("@#{ivar_name}", (attrs[ivar_name.to_s] || attrs[ivar_name.to_sym]).to_a)
+          else
+            ivar_name = attribute.to_s.gsub(/\?$/,'')
+            instance_variable_set("@#{ivar_name}",attrs[ivar_name.to_s] || attrs[ivar_name.to_sym])
+          end
         end
       end
     end

data/spec/immutable_struct_spec.rb

@@ -53,6 +53,15 @@ describe ImmutableStruct do
 
     end
 
+    context "allows for values that should be coerced to collections" do
+      it "can define an array value that should never be nil" do
+        klass = ImmutableStruct.new([:foo], :bar)
+        instance = klass.new
+        instance.foo.should == []
+        instance.bar.should == nil
+      end
+    end
+
     it "allows defining instance methods" do
       klass = ImmutableStruct.new(:foo, :bar) do
         def derived; self.foo + ":" + self.bar; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: immutable-struct
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Stitch Fix Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-03 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.rc.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Easily create value objects without the pain of Ruby's Struct (or its setters)