superstructure 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dba89c3e4aeda5883b1f0512c3f4e785ad206b0
-  data.tar.gz: 27d2fbb43f389b2512ca582e9977c11c9daffe1a
+  metadata.gz: ee6898266d56d163225dc8e36a560df58c775ad5
+  data.tar.gz: 0a54cd4233764e3709894e827a199cb4c6b250a2
 SHA512:
-  metadata.gz: 53a23c060e658cf07599f47ce5009d5b73ce88cfaa285d942fc18591e61371c6cd4982bc29f7e3ac387882d0579201b2aad24cb7d119948f412f527edbecad46
-  data.tar.gz: a99d7e6f99bfce4d57241ed9e7e3a3cf74951f066a50b0234889a477719cde9954889d8aa3a78e12176247553edb207a9001e6658a3087715cbbbbfe0ceadfee
+  metadata.gz: 235118a7fc7df08713a74f8e08ff6fd603f574e73ad1e28af21c25cdd449fa85e5d2a38274efc8c12dd8ae7e87ba1e72eace08ef9a604a9503c6c0192be53edf
+  data.tar.gz: 820253eeb35ff0c77c0572a9b4132c0c3eb7df7e6e70a6631abb2ebf99823a2834489df12ff3bc06acf5e1f079856228e90ff65516c2601dca782520b9fffbb3

data/lib/superstructure/argument_error_builder.rb

@@ -0,0 +1,27 @@
+module Superstructure
+  class ArgumentErrorBuilder
+    def initialize
+      @errors = {
+        extra_params: [],
+        missing_params: [],
+        shadowed_params: []
+      }
+    end
+
+    def add_error(type, key)
+      add_errors(type, [key])
+    end
+
+    def add_errors(type, key)
+      @errors.fetch(type).concat(key)
+    end
+
+    def build
+      ArgumentError.new(@errors)
+    end
+
+    def error?
+      @errors.any? { |k, v| v.any? }
+    end
+  end
+end

data/lib/superstructure/attribute_parser.rb

@@ -0,0 +1,45 @@
+module Superstructure
+  class AttributeParser
+    attr_reader :attributes
+
+    def initialize(arguments, opts)
+      @attributes = {}
+      @possible_error = ArgumentErrorBuilder.new
+      @arguments = arguments
+      @opts = opts
+
+      parse!
+    end
+
+    def error?
+      @possible_error.error?
+    end
+
+    def error
+      @possible_error.build
+    end
+
+    private
+
+    def parse!
+      used_params = []
+
+      @arguments.each do |argument|
+        if @opts.has_key?(argument) && @opts.has_key?(argument.to_s)
+          @possible_error.add_error(:shadowed_params, argument)
+          used_params << argument << argument.to_s
+        elsif @opts.has_key?(argument)
+          @attributes[argument] = @opts[argument]
+          used_params << argument
+        elsif @opts.has_key?(argument.to_s)
+          @attributes[argument] = @opts[argument.to_s]
+          used_params << argument.to_s
+        else
+          @possible_error.add_error(:missing_params, argument)
+        end
+      end
+
+      @possible_error.add_errors(:extra_params, @opts.keys - used_params)
+    end
+  end
+end

data/lib/superstructure/value_obj.rb

@@ -4,35 +4,11 @@ module Superstructure
       def new *arguments, superclass: Object, &blk
         Class.new(superclass) do
           define_method(:initialize) do |opts={}|
-            @attributes = {}
-            missing_params = []
-            shadowed_params = []
-            used_params = []
-
-            arguments.each do |argument|
-              if opts.has_key?(argument) && opts.has_key?(argument.to_s)
-                shadowed_params << argument
-                used_params << argument << argument.to_s
-
-              elsif opts.has_key?(argument)
-                @attributes[argument] = opts[argument]
-                used_params << argument
-              elsif opts.has_key?(argument.to_s)
-                @attributes[argument] = opts[argument.to_s]
-                used_params << argument.to_s
-              else
-                missing_params << argument
-              end
-            end
-
-            extra_params = opts.keys - used_params
-
-            if missing_params.any? || shadowed_params.any? || extra_params.any?
-              raise ArgumentError.new(
-                missing_params: missing_params,
-                shadowed_params: shadowed_params,
-                extra_params: extra_params
-              )
+            attribute_parser = AttributeParser.new(arguments, opts)
+            if attribute_parser.error?
+              raise attribute_parser.error
+            else
+              @attributes = attribute_parser.attributes
             end
           end
 
@@ -44,7 +20,12 @@ module Superstructure
             opts = @attributes.map do |k, v|
               "#{k}=#{v.inspect}"
             end.join(", ")
-            "#<value_obj #{self.class} #{opts}>"
+
+            unless opts.empty?
+              opts.prepend(" ")
+            end
+
+            "#<value_obj #{self.class}#{opts}>"
           end
 
           def ==(o)
@@ -53,6 +34,10 @@ module Superstructure
 
           alias :eql? :==
 
+          def hash
+            self.class.hash ^ @attributes.hash
+          end
+
           arguments.each do |argument|
             define_method(argument) do
               to_hash[argument]

data/lib/superstructure/version.rb

@@ -1,3 +1,3 @@
 module Superstructure
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/superstructure.rb

@@ -4,3 +4,5 @@ end
 require "superstructure/version"
 require "superstructure/value_obj"
 require "superstructure/argument_error"
+require "superstructure/argument_error_builder"
+require "superstructure/attribute_parser"

data/spec/argument_error_builder_spec.rb

@@ -0,0 +1,30 @@
+RSpec.describe Superstructure::ArgumentErrorBuilder do
+  let(:builder) { described_class.new }
+
+  describe "#error?" do
+    subject { builder.error? }
+
+    context "when at least one error has been added" do
+      before do
+        builder.add_error(:missing_params, :hello)
+      end
+
+      it { should be_truthy }
+    end
+
+    context "when no errors have been added" do
+      it { should be_falsy }
+    end
+  end
+
+  it "builds an ArgumentError with all of the added errors" do
+    builder.add_error(:extra_params, :alpha)
+    builder.add_errors(:missing_params, [:beta, :charlie])
+
+    expect(builder.build).to have_attributes(
+      extra_params: [:alpha],
+      missing_params: [:beta, :charlie],
+      shadowed_params: []
+    )
+  end
+end

data/spec/value_obj_spec.rb

@@ -64,6 +64,12 @@ RSpec.describe Superstructure::ValueObj do
       foobar = FooBar.new(foo: [:a, :b], bar: 2)
       expect(foobar.inspect).to eq '#<value_obj FooBar foo=[:a, :b], bar=2>'
     end
+
+    context "when there are no attributes" do
+      it "omits the attibutes" do
+        expect(Empty.new.inspect).to eq "#<value_obj Empty>"
+      end
+    end
   end
 
   it "can inherit from other classes" do
@@ -94,17 +100,17 @@ RSpec.describe Superstructure::ValueObj do
   end
 
   describe "equality" do
-    shared_examples_for "equality" do |operator|
+    shared_examples_for "equality" do |sameness_proc|
       it "is equal if all arguments are equal" do
         alpha = FooBar.new(foo: 1, bar: 2)
         beta = FooBar.new("foo" => 1, "bar" => 2)
-        expect(alpha.public_send(operator, beta)).to be_truthy
+        expect(sameness_proc.(alpha, beta)).to be_truthy
       end
 
       it "is not equal if any argument doesn't equal" do
         alpha = FooBar.new(foo: 1, bar: 2000)
         beta = FooBar.new("foo" => 1, "bar" => 2)
-        expect(alpha.public_send(operator, beta)).to be_falsey
+        expect(sameness_proc.(alpha, beta)).to be_falsey
       end
 
       it "is equal only to other instances of the same class" do
@@ -114,16 +120,20 @@ RSpec.describe Superstructure::ValueObj do
         foobar = FooBar.new(opts)
         barfoo = klass.new(opts)
 
-        expect(foobar.public_send(operator, barfoo)).to be_falsey
+        expect(sameness_proc.(foobar, barfoo)).to be_falsey
       end
     end
 
     describe "==" do
-      it_behaves_like "equality", :==
+      it_behaves_like "equality", proc { |a, b| a == b }
     end
 
     describe "eql?" do
-      it_behaves_like "equality", :eql?
+      it_behaves_like "equality", proc { |a, b| a.eql? b }
+    end
+
+    describe "hash" do
+      it_behaves_like "equality", proc { |a, b| a.hash == b.hash }
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: superstructure
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Dan Finnie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-15 00:00:00.000000000 Z
+date: 2018-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,8 +67,11 @@ files:
 - Rakefile
 - lib/superstructure.rb
 - lib/superstructure/argument_error.rb
+- lib/superstructure/argument_error_builder.rb
+- lib/superstructure/attribute_parser.rb
 - lib/superstructure/value_obj.rb
 - lib/superstructure/version.rb
+- spec/argument_error_builder_spec.rb
 - spec/argument_error_spec.rb
 - spec/spec_helper.rb
 - spec/value_obj_spec.rb
@@ -93,12 +96,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Immutable, keyword-argument based value objects for Ruby
 test_files:
+- spec/argument_error_builder_spec.rb
 - spec/argument_error_spec.rb
 - spec/spec_helper.rb
 - spec/value_obj_spec.rb
-has_rdoc: