assembler 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 710b5f3b455cad26bf924085ddb529d5f0f2be3d
+  data.tar.gz: 411e7b9d2ff6cce59cc57b8eb65b236aec9806af
+SHA512:
+  metadata.gz: 0857a9705d3ed323475d2629853ca0aec90bec6572b3e9cf1693a8017202cd12150a23902e07218a191044f5b0c671f49a0c924f1b59121ba10259cd6e26b01d
+  data.tar.gz: 2a26f698cf4103bed5f8521c5e21764731eee1ccacafbbbaba84733a2a9b10f4d1b9f450a7997964ed1b0d2e85ea1bc8fff90ca16589349e809c6093e590c022

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0
+  # - 1.9.3
+  # - jruby-19mode
+script:
+  - bundle exec rake

data/CHANGES.md

@@ -0,0 +1,5 @@
+# Changes
+
+## 1.0.0
+
+* Initial Release. (Ben Hamill)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ben Hamill
+
+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,98 @@
+# Assembler
+[![Build Status](https://travis-ci.org/benhamill/assembler.png)](https://travis-ci.org/benhamill/assembler)
+[![Code Climate](https://codeclimate.com/github/benhamill/assembler.png)](https://codeclimate.com/github/benhamill/assembler)
+
+An [assembler swarm](http://en.wikipedia.org/wiki/Molecular_assembler) is a
+bunch of nanomachines that can build [almost anything](http://en.wikipedia.org/wiki/Molecular_nanotechnology#Assemblers_versus_nanofactories).
+
+Assembler is a library that gives you a DSL to describe a super-handy
+initializer pattern. You specify the parameters your object should take and
+Assembler give you an initializer that takes an options hash as well as yielding
+a [builder object](http://c2.com/cgi/wiki?BuilderPattern) to a block. It takes
+care of storing the parameters and gives you private accessors, too.
+
+
+## Usage
+
+You use it like this:
+
+```ruby
+class AwesomeThing
+  extend Assembler
+
+  assembler_initializer :required_param, optional_param: 'default value'
+
+  # Additional business logic here...
+end
+```
+
+Then you can instantiate your object with either an options hash or via a block.
+For example:
+
+```ruby
+# These two are equivalent:
+AwesomeThing.new(required_param: 'specialness')
+AwesomeThing.new do |aw|
+  aw.required_param = 'specialness'
+end
+
+# These two are equivalent:
+AwesomeThing.new(required_param: 'specialness', optional_param: 'override')
+AwesomeThing.new do |aw|
+  aw.required_param = 'specialness'
+  aw.optional_param = 'override'
+end
+```
+
+This enables some trickery when you're dealing with a world of uncertainty:
+
+```ruby
+class Foo
+  extend Assembler
+  assembler_initializer :name, :awesome, favorite_color: 'green'
+
+  def awesome?
+    !!awesome
+  end
+end
+
+def delegating_method(name, awesome=true, favorite_color=nil)
+  Foo.new do |foo|
+    foo.name = name
+    foo.awesome = awesome
+
+    foo.favorite_color = favorite_color if favorite_color
+  end
+end
+```
+
+The delegating method, here, is empowered to reverse the default for `awesome`,
+but then respect the default for `favorite_color` if the calling code doesn't
+pass anything in (assuming `nil` is unacceptable). It also respects if `awesome`
+has a falsey value passed in.
+
+Especially when you have objects with a lot of potential arguments being passed
+in and don't want to pass keys that you don't have any information about (did
+my caller pass in this `nil`, or is it my own default?), you can use conditional
+logic in the block, rather than conditionally build of a hash just to pass to a
+constructor method.
+
+
+## Contributing
+
+Help is gladly welcomed. If you have a feature you'd like to add, it's much more
+likely to get in (or get in faster) the closer you stick to these steps:
+
+1. Open an Issue to talk about it. We can discuss whether it's the right
+  direction or maybe help track down a bug, etc.
+1. Fork the project, and make a branch to work on your feature/fix. Master is
+  where you'll want to start from.
+1. Turn the Issue into a Pull Request. There are several ways to do this, but
+  [hub](https://github.com/defunkt/hub) is probably the easiest.
+1. Make sure your Pull Request includes tests.
+1. Bonus points if your Pull Request updates `CHANGES.md` to include a summary
+   of your changes and your name like the other entries. If the last entry is
+   the last release, add a new `## Unreleased` heading at the top.
+
+If you don't know how to fix something, even just a Pull Request that includes a
+failing test can be helpful. If in doubt, make an Issue to discuss.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/assembler.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'assembler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "assembler"
+  spec.version       = Assembler::VERSION
+  spec.authors       = ["Ben Hamill"]
+  spec.email         = ["git-commits@benhamill.com"]
+  spec.summary       = %q{Block-based initializers for your objects.}
+  spec.description   = %q{Provides a DSL for describing required and optional (with defaults) parameters for object initialization. The initializer accepts an options hash and/or yields a builder object to a block.}
+  spec.homepage      = "https://github.com/benhamill/assembler#readme"
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+end

data/lib/assembler/builder.rb

@@ -0,0 +1,27 @@
+module Assembler
+  class Builder
+    def initialize(*parameter_names)
+      @parameter_names = parameter_names
+
+      parameter_names.each do |parameter_name|
+        self.singleton_class.class_eval(<<-RUBY)
+          def #{parameter_name}=(value)
+            parameters[:#{parameter_name.to_sym}] = value
+          end
+        RUBY
+      end
+    end
+
+    def to_h
+      parameters
+    end
+
+    private
+
+    attr_reader :parameter_names
+
+    def parameters
+      @parameters ||= {}
+    end
+  end
+end

data/lib/assembler/initializer.rb

@@ -0,0 +1,39 @@
+require "assembler/builder"
+require "assembler/parameters"
+
+module Assembler
+  module Initializer
+    def initialize(options={})
+      builder = Assembler::Builder.new(*self.class.all_param_names)
+
+      yield builder if block_given?
+
+      @full_options = Assembler::Parameters.new(options.merge(builder.to_h))
+
+      missing_required_params = []
+
+      self.class.required_params.each do |param_name|
+        remember_value_or(param_name) { missing_required_params << param_name }
+      end
+
+      self.class.optional_params.each do |param_name, default_value|
+        remember_value_or(param_name) { default_value }
+      end
+
+      raise(ArgumentError, "missing keywords: #{missing_required_params.join(', ')}") if missing_required_params.any?
+    end
+
+    private
+
+    attr_reader :full_options
+
+    def remember_value_or(param_name, &block)
+      instance_variable_set(
+        :"@#{param_name}",
+        full_options.fetch(param_name) do
+          block.call
+        end
+      )
+    end
+  end
+end

data/lib/assembler/parameters.rb

@@ -0,0 +1,19 @@
+module Assembler
+  class Parameters
+    def initialize(params={})
+      @params = params
+    end
+
+    def fetch(key, &block)
+      params.fetch(key.to_sym) do
+        params.fetch(key.to_s) do
+          block.call
+        end
+      end
+    end
+
+    private
+
+    attr_reader :params
+  end
+end

data/lib/assembler/version.rb

@@ -0,0 +1,3 @@
+module Assembler
+  VERSION = "1.0.0"
+end

data/lib/assembler.rb

@@ -0,0 +1,17 @@
+require "assembler/version"
+require "assembler/initializer"
+
+module Assembler
+  attr_reader :required_params, :optional_params, :all_param_names
+
+  def assembler_initializer(*required, **optional)
+    include Assembler::Initializer
+
+    @required_params = required
+    @optional_params = optional
+    @all_param_names = (required + optional.keys).map(&:to_sym)
+
+    attr_reader *all_param_names
+    private *all_param_names
+  end
+end

data/spec/assembler_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+require 'assembler'
+
+describe Assembler do
+  describe "#assembler_initializer" do
+    context "without parameters" do
+      subject do
+        Class.new do
+          extend Assembler
+
+          assembler_initializer
+        end
+      end
+
+      it "throws away all input parameters (method arguments)" do
+        built_object = subject.new(foo: 'foo', bar: 'bar')
+
+        expect(built_object.instance_variables).to_not include(:@foo, :@bar)
+      end
+
+      it "doesn't have methods on the builder object" do
+        subject.new do |builder|
+          expect(builder).to_not respond_to(:foo)
+        end
+      end
+    end
+
+    context "with a mix of required and optional parameters" do
+      subject do
+        Class.new do
+          extend Assembler
+
+          assembler_initializer :foo, bar: 'bar'
+        end
+      end
+
+      it "barfs from missing required parameters" do
+        expect { subject.new }.to raise_error(ArgumentError)
+      end
+
+      it "uses default values for missing parameters (method arguments)" do
+        built_object = subject.new(foo: 'foo')
+
+        expect(built_object.instance_variable_get(:@bar)).to eq('bar')
+      end
+
+      it "uses default values for missing parameters (block)" do
+        built_object = subject.new do |builder|
+          builder.foo = 'foo'
+        end
+
+        expect(built_object.instance_variable_get(:@bar)).to eq('bar')
+      end
+
+      it "holds onto the parameters (method arguments)" do
+        built_object = subject.new(foo: 'baz', bar: 'qux')
+
+        expect(built_object.instance_variable_get(:@foo)).to eq('baz')
+        expect(built_object.instance_variable_get(:@bar)).to eq('qux')
+      end
+
+      it "holds onto the parameters (block)" do
+        built_object = subject.new do |builder|
+          builder.foo = 'baz'
+          builder.bar = 'qux'
+        end
+
+        expect(built_object.instance_variable_get(:@foo)).to eq('baz')
+        expect(built_object.instance_variable_get(:@bar)).to eq('qux')
+      end
+
+      it "ignores un-named parameters in method arguments" do
+        built_object = subject.new(foo: 'bar', baz: 'baz')
+
+        expect(built_object.instance_variables).to_not include(:@baz)
+      end
+
+      it "doesn't create builder methods for un-named parameters" do
+        expect {
+          subject.new do |builder|
+            builder.baz = 'baz'
+          end
+        }.to raise_error(NoMethodError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+  end
+end
+
+require 'pry'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: assembler
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ben Hamill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a DSL for describing required and optional (with defaults) parameters
+  for object initialization. The initializer accepts an options hash and/or yields
+  a builder object to a block.
+email:
+- git-commits@benhamill.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGES.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assembler.gemspec
+- lib/assembler.rb
+- lib/assembler/builder.rb
+- lib/assembler/initializer.rb
+- lib/assembler/parameters.rb
+- lib/assembler/version.rb
+- spec/assembler_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/benhamill/assembler#readme
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Block-based initializers for your objects.
+test_files:
+- spec/assembler_spec.rb
+- spec/spec_helper.rb