superstructure 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c025de98f670afc858e54a8b6f7be0b0a91a193
+  data.tar.gz: 7bf2df28edf8683689a8b5cc52a08a39c243752d
+SHA512:
+  metadata.gz: b54485982cd3042f02ca18cf6d81e9eaccb6d9a37e610ee124bd66e31cc680f2257aa3298589b571ce8efbd413d9e9af1571d2d343e374522411c89ebb52e576
+  data.tar.gz: 1e935204cc0f528a86dddc15da0ae668d0e33d81e1125f986801cce33ad648973eed473a6075a540f213ca861bafd757e66a827b58a0f8fef3a7ff45cca1c0b9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--require superstructure

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in superstructure.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dan Finnie
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Superstructure
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'superstructure'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install superstructure
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/superstructure/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/superstructure.rb

@@ -0,0 +1,6 @@
+module Superstructure
+end
+
+require "superstructure/version"
+require "superstructure/value_obj"
+require "superstructure/argument_error"

data/lib/superstructure/argument_error.rb

@@ -0,0 +1,16 @@
+module Superstructure
+  ArgumentError = ValueObj.new(
+    :extra_params,
+    :missing_params,
+    :shadowed_params,
+    superclass: ::ArgumentError
+  ) do
+    def message
+      [
+        extra_params.any? ? "Received unexpected options: #{extra_params.inspect}" : nil,
+        missing_params.any? ? "Expected but did not receive: #{missing_params.inspect}" : nil,
+        shadowed_params.any? ? "Received a symbol and string version of: #{shadowed_params.inspect}" : nil
+      ].compact.join("\n")
+    end
+  end
+end

data/lib/superstructure/value_obj.rb

@@ -0,0 +1,67 @@
+module Superstructure
+  class ValueObj
+    class << self
+      def new *arguments, superclass: Object, &blk
+        Class.new(superclass) do
+          attr_reader :to_hash
+
+          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
+              )
+            end
+
+            @to_hash = attributes
+          end
+
+          def inspect
+            opts = to_hash.map do |k, v|
+              "#{k}=#{v.inspect}"
+            end.join(", ")
+            "#<value_obj #{self.class} #{opts}>"
+          end
+
+          def ==(o)
+            self.class == o.class && to_hash == o.to_hash
+          end
+
+          alias :eql? :==
+
+          arguments.each do |argument|
+            define_method(argument) do
+              to_hash[argument]
+            end
+          end
+
+          class_eval(&blk) if blk
+        end
+      end
+    end
+  end
+end

data/lib/superstructure/version.rb

@@ -0,0 +1,3 @@
+module Superstructure
+  VERSION = "0.0.1"
+end

data/spec/argument_error_spec.rb

@@ -0,0 +1,35 @@
+RSpec.describe Superstructure::ArgumentError do
+  let(:argument_error) do
+    described_class.new(
+      extra_params: extra_params,
+      missing_params: missing_params,
+      shadowed_params: shadowed_params
+    )
+  end
+
+  describe "#message" do
+    subject { argument_error.message }
+
+    context "when there is only one type of error" do
+      let(:extra_params) { ["alpha", :beta] }
+      let(:missing_params) { [] }
+      let(:shadowed_params) { [] }
+
+      it "has a description of the error" do
+        expect(subject).to eq 'Received unexpected options: ["alpha", :beta]'
+      end
+    end
+
+    context "when there are multiple errors" do
+      let(:extra_params) { [:elephant] }
+      let(:missing_params) { [:mongoose] }
+      let(:shadowed_params) { [:snake] }
+
+      it "has a description of the all of the errors" do
+        expect(subject).to include 'Received unexpected options: [:elephant]'
+        expect(subject).to include 'Expected but did not receive: [:mongoose]'
+        expect(subject).to include 'Received a symbol and string version of: [:snake]'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+end

data/spec/value_obj_spec.rb

@@ -0,0 +1,149 @@
+RSpec.describe Superstructure::ValueObj do
+  FooBar = Superstructure::ValueObj.new :foo, :bar
+  Empty = Superstructure::ValueObj.new
+
+  it "accepts parameters from symbol arguments and exposes them as methods" do
+    foobar = FooBar.new(foo: 1, bar: 2)
+    expect(foobar.foo).to eq 1
+    expect(foobar.bar).to eq 2
+  end
+
+  it "accepts parameters from string arguments" do
+    foobar = FooBar.new("foo" => "foo", "bar" => :bar)
+    expect(foobar.foo).to eq "foo"
+    expect(foobar.bar).to eq :bar
+  end
+
+  it "accepts parameters from a mix of string and symbol arguments" do
+    foobar = FooBar.new("foo" => "foo", bar: :bar)
+    expect(foobar.foo).to eq "foo"
+    expect(foobar.bar).to eq :bar
+  end
+
+  it "exposes options in the to_hash method" do
+    foobar = FooBar.new(foo: "foo?", bar: "bar?")
+    expect(foobar.to_hash).to eq({
+      foo: "foo?",
+      bar: "bar?"
+    })
+  end
+
+  it "exposes the parameters as readers" do
+    expect(FooBar.instance_methods).to include :foo, :bar
+  end
+
+  it "does not expose writers" do
+    foobar = FooBar.new(foo: :fruu, bar: :bruu)
+    expect(foobar).not_to respond_to :foo=
+    expect(foobar).not_to respond_to :bar=
+  end
+
+  describe "#inspect" do
+    it "basic stuff" do
+      foobar = FooBar.new(foo: 1, bar: 2)
+      expect(foobar.inspect).to eq '#<value_obj FooBar foo=1, bar=2>'
+    end
+
+    it "handles complicated data structures" do
+      foobar = FooBar.new(foo: [:a, :b], bar: 2)
+      expect(foobar.inspect).to eq '#<value_obj FooBar foo=[:a, :b], bar=2>'
+    end
+  end
+
+  it "can inherit from other classes" do
+    superclass = Class.new
+    subclass = Superstructure::ValueObj.new(:alpha, superclass: superclass)
+    instance = subclass.new(alpha: "alpha")
+    expect(instance).to be_kind_of superclass
+  end
+
+  it "can be passed additional methods" do
+    klass = Superstructure::ValueObj.new(:alpha) do
+      def hello
+        "bonjour"
+      end
+    end
+
+    instance = klass.new(alpha: "Alpharetta")
+    expect(instance.hello).to eq "bonjour"
+  end
+
+  it "does not mutate the input" do
+    opts = { foo: 42, bar: 24 }
+
+    FooBar.new(opts)
+
+    expect(opts[:foo]).to eq 42
+    expect(opts[:bar]).to eq 24
+  end
+
+  describe "equality" do
+    shared_examples_for "equality" do |operator|
+      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
+      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
+      end
+
+      it "is equal only to other instances of the same class" do
+        klass = Superstructure::ValueObj.new(:foo, :bar)
+        opts = { foo: 42, bar: 24 }
+
+        foobar = FooBar.new(opts)
+        barfoo = klass.new(opts)
+
+        expect(foobar.public_send(operator, barfoo)).to be_falsey
+      end
+    end
+
+    describe "==" do
+      it_behaves_like "equality", :==
+    end
+
+    describe "eql?" do
+      it_behaves_like "equality", :eql?
+    end
+  end
+
+  describe "error handling" do
+    it "is an error to not pass all of the parameters" do
+      expect { FooBar.new(foo: 1) }.to raise_error(Superstructure::ArgumentError) do |error|
+        expect(error.missing_params).to eq [:bar]
+        expect(error.extra_params).to be_empty
+        expect(error.shadowed_params).to be_empty
+      end
+    end
+
+    it "it an error to pass an extra parameter" do
+      expect { Empty.new(baz: 3, lolcat: 4) }.to raise_error(Superstructure::ArgumentError) do |error|
+        expect(error.missing_params).to be_empty
+        expect(error.extra_params).to match [:baz, :lolcat]
+        expect(error.shadowed_params).to be_empty
+      end
+    end
+
+    it "is an error to pass a symbol and string version of the same paramter" do
+      expect { FooBar.new(foo: 1, "foo" => 2, bar: 3) }.to raise_error(Superstructure::ArgumentError) do |error|
+        expect(error.missing_params).to be_empty
+        expect(error.extra_params).to be_empty
+        expect(error.shadowed_params).to eq [:foo]
+      end
+    end
+
+    it "does not create symbols for erroneous keys (as this could be a memory leak)" do
+      expect do
+        begin
+          Empty.new("extra_symbol_1" => 1)
+        rescue Superstructure::ArgumentError => e
+          # noop
+        end
+      end.not_to change { Symbol.all_symbols.size }
+    end
+  end
+end

data/superstructure.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'superstructure/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "superstructure"
+  spec.version       = Superstructure::VERSION
+  spec.authors       = ["Dan Finnie"]
+  spec.email         = ["dan@danfinnie.com"]
+  spec.summary       =  "Immutable, keyword-argument based value objects for Ruby"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: superstructure
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Finnie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: 
+email:
+- dan@danfinnie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/superstructure.rb
+- lib/superstructure/argument_error.rb
+- lib/superstructure/value_obj.rb
+- lib/superstructure/version.rb
+- spec/argument_error_spec.rb
+- spec/spec_helper.rb
+- spec/value_obj_spec.rb
+- superstructure.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Immutable, keyword-argument based value objects for Ruby
+test_files:
+- spec/argument_error_spec.rb
+- spec/spec_helper.rb
+- spec/value_obj_spec.rb
+has_rdoc: