restricted_struct 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 701f39867ce9703612900fe3fc7a02a5546860cd
-  data.tar.gz: ec33a9f1adf85537047831ad5f52c7d02be8bc1f
+  metadata.gz: 4990efc33886647ac9d035269794891b1f4a5e7b
+  data.tar.gz: b11ebf6330ea5d3fced870c3c577cd01d61d650b
 SHA512:
-  metadata.gz: 97fc5cf511d82388464d41532d3f41a063de18b89891c1c9ac5cbd728e2337e2dc6ce2825dbe156350a65c59ba66eee5dffdb1a2d627d13d195c9ba75e5a4b9c
-  data.tar.gz: 96fa0f60b0005d2ff5da42137de9bcb8973bafe88e117854209fc532c2db24adb29f89970101f3128bce0a1058062bc0094f8f2dc9b965f95cae0e4bf3d2205b
+  metadata.gz: f2e2200102af51fcd8947504095a5c6b596d23f9b30e66913e2c751f15757d84f7858b53693bb55c29ce044193b42cf2d80174674b3c731acc5e2237bb906c79
+  data.tar.gz: e9a3d4fa4b02bd90a25170ad38c646c1b47d4838bdcb60644dbfebaa528cb73c0143332ae26128743ac6e664f4c6eeba129cf05c96c01164e6615316a4b7e6c7

data/README.md

@@ -42,6 +42,41 @@ end
 
 Available access levels: `:private` and `:protected`.
 
+### Keyword arguments
+
+```ruby
+class Rectangle < RestrictedStruct.new(:protected, :x1, :y1, :x2, :y2, :color => :white)
+  # ...
+end
+```
+
+This will create a struct with 5 fields: x1, y1, x2, y2 and color. But color will default to `:white` if not provided.
+And color can be assigned while instantiating a value of this class either as 5th parameter or as keyword argument, i.e.:
+
+```ruby
+rect = Rectangle[20, 30, 60, 50, :red]
+# is the same as:
+rect = Rectangle[20, 30, 60, 50, :color => :red]
+```
+
+By the way, nothing forbids you from specifying any fields as keyword arguments:
+
+```ruby
+rect = Rectangle[20, 30, :x2 => 60, :y2 => 50]
+# or even all of them:
+rect = Rectangle[:x1 => 20, :y1 => 30, :x2 => 60, :y2 => 50, :color => :black]
+```
+
+Just be careful when specifying the same fields simultaneously as normal params and as part of keyword arguments hash, for example:
+
+```ruby
+rect = Rectangle[20, 30, 60, 50, :x2 => 55]
+# is essentially the same as
+rect = Rectangle[20, 30, 55, 50]
+```
+
+Which means 3rd argument was overwritten by corresponding keyword argument.
+
 ## Contributing
 
 1. Fork it ( https://github.com/waterlink/restricted_struct/fork )

data/lib/restricted_struct.rb

@@ -1,2 +1,3 @@
 require "restricted_struct/definition"
+require "restricted_struct/support"
 require "restricted_struct/version"

data/lib/restricted_struct/definition.rb

@@ -7,7 +7,20 @@ class RestrictedStruct < Struct
 
   class << self
     def new(access_level, *properties)
-      super(*properties, &access_restriction(access_level, properties))
+      properties, defaults = Support.extract_keyword_args(properties)
+      properties.concat(defaults.keys)
+      super(*properties, &access_restriction(access_level, properties)).with_defaults(defaults)
+    end
+
+    def defaults
+      @defaults ||= {}
+    end
+
+    protected
+
+    def with_defaults(defaults)
+      @defaults = defaults
+      self
     end
 
     private
@@ -26,4 +39,15 @@ class RestrictedStruct < Struct
       properties + properties.map { |name| :"#{name}=" }
     end
   end
+
+  def initialize(*values)
+    values, keyword_args = Support.extract_keyword_args(values)
+    members.each_with_index do |name, index|
+      # 1.8 compatibility
+      key = name.to_sym
+      values[index] ||= self.class.defaults[key]
+      values[index] = keyword_args[key] if keyword_args.has_key?(key)
+    end
+    super(*values)
+  end
 end

data/lib/restricted_struct/support.rb

@@ -0,0 +1,9 @@
+module RestrictedStruct::Support
+  class << self
+    def extract_keyword_args(array)
+      array = array.dup
+      keyword_args = Hash === array[-1] ? array.pop : {}
+      [array, keyword_args]
+    end
+  end
+end

data/lib/restricted_struct/version.rb

@@ -1 +1 @@
-RestrictedStruct::VERSION = "0.1.0"
+RestrictedStruct::VERSION = "0.2.0"

data/restricted_struct.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = RestrictedStruct::VERSION
   spec.authors       = ["Alexey Fedorov", "Anselm Helbig"]
   spec.email         = ["alexey.fedorov@wimdu.com", "anselm.helbig@wimdu.com"]
-  spec.summary       = %q{Create Struct-s with private or protected attributes}
+  spec.summary       = %q{Create Struct-s with private or protected attributes. Reduce your boilerplate code to nothing}
   spec.description   = %q{This gem allows to use ruby's Struct, but automatically hides all the attributes as private or protected, which provides higher level of encapsulation.}
   spec.homepage      = ""
   spec.license       = "MIT"

data/spec/restricted_struct/support_spec.rb

@@ -0,0 +1,25 @@
+RSpec.describe RestrictedStruct::Support do
+  describe ".extract_keyword_args" do
+    it "splits into list and last parameter if it is a hash" do
+      expect(described_class.extract_keyword_args(
+        [1, 2, 3, { :color => :red }]
+      )).to eq([[1, 2, 3], { :color => :red }])
+    end
+
+    it "last parameter defaults to an empty hash" do
+      expect(described_class.extract_keyword_args(
+        [1, 2, 3, 4]
+      )).to eq([[1, 2, 3, 4], {}])
+    end
+
+    it "list defaults to an empty list if only hash provided" do
+      expect(described_class.extract_keyword_args(
+        [{ :color => :red }]
+      )).to eq([[], { :color => :red }])
+    end
+
+    it "returns empty list and hash if provided array is empty" do
+      expect(described_class.extract_keyword_args([])).to eq([[], {}])
+    end
+  end
+end

data/spec/restricted_struct_spec.rb

@@ -21,6 +21,33 @@ RSpec.describe RestrictedStruct do
         }.to raise_error(NoMethodError, /#{access_level} method `properties='/)
       end
     end
+  end
+
+  describe "keyword arguments" do
+    let(:rectangle) { RestrictedStruct.new(:protected, :x1, :y1, :x2, :y2, :color => :white) }
+
+    it "equals to specified default if omitted" do
+      expect(rectangle.new(1, 2, 3, 4)).to eq(rectangle.new(1, 2, 3, 4, :white))
+    end
 
+    it "can be overriden by specifying as normal argument" do
+      expect(rectangle.new(1, 2, 3, 4, :red)).not_to eq(rectangle.new(1, 2, 3, 4))
+    end
+
+    it "can be overriden by specifying as keyword argument" do
+      expect(rectangle.new(1, 2, 3, 4, :color => :red)).not_to eq(rectangle.new(1, 2, 3, 4))
+    end
+
+    it "being specified as keyword argument is equivalent to specifying as normal argument" do
+      expect(rectangle.new(1, 2, 3, 4, :red)).to eq(rectangle.new(1, 2, 3, 4, :color => :red))
+    end
+
+    it "can be used instead of normal arguments" do
+      expect(rectangle.new(1, 2, :x2 => 3, :y2 => 4)).to eq(rectangle.new(1, 2, 3, 4))
+    end
+
+    it "overrides value of normal argument" do
+      expect(rectangle.new(1, 2, 3, 4, :x2 => 5)).to eq(rectangle.new(1, 2, 5, 4))
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restricted_struct
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexey Fedorov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-21 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,8 +57,10 @@ files:
 - Rakefile
 - lib/restricted_struct.rb
 - lib/restricted_struct/definition.rb
+- lib/restricted_struct/support.rb
 - lib/restricted_struct/version.rb
 - restricted_struct.gemspec
+- spec/restricted_struct/support_spec.rb
 - spec/restricted_struct_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -84,7 +86,9 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Create Struct-s with private or protected attributes
+summary: Create Struct-s with private or protected attributes. Reduce your boilerplate
+  code to nothing
 test_files:
+- spec/restricted_struct/support_spec.rb
 - spec/restricted_struct_spec.rb
 - spec/spec_helper.rb