simple_builder 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 737ab2a3d98af032aaaf155e5866c4995f133470
+  data.tar.gz: 9e11f0d7330398dca7ea6131f97cc96e58df1a3b
+SHA512:
+  metadata.gz: b903db9e4a8be46c88e1203b938eeb52de47f149487378c360f3e7879ff2a6caaa596855a16297cb6643b63810cce87ec7e90f0f54ae0c7cab219bf094763029
+  data.tar.gz: d26e600d8bbd709c357d72d3542edd80686107d8673a0972153f9f57c6934aee81d3bdcb3d5d9fbdc189d9ba1407667e8cb0755c8a46cc4296e24e1f4c2ec3f6

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/.ruby-gemset

@@ -0,0 +1 @@
+simple_builder_gem

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,15 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matt Wilson
+
+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,84 @@
+# SimpleBuilder
+
+Dead-simple base class to build create/update service objects from. I got tired of reinventing something like this is every ruby/rails/sinatra app I write, so here's a gem, cruel world :).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_builder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_builder
+
+## Usage
+
+It's quite simple. Your implementing class has to implement two methods:
+
+1. `#new_instance`
+2. `#set_attributes`
+
+Hopefully, it is obvious what those two methods should do. `#build!` and it's alias `#update!` both call `#save` on the instance to persist the changes, so you should implement or alias that as appropriate.
+
+The initializer optionally takes a block (to which we `yield self`) so you can do interesting things like support additional parameters or set stuff up for later.
+
+Here are some examples, both from the world of Rails, though this does not depend on anything rails-y:
+
+```ruby
+# The simplest possible builder
+class ChapterBuilder < SimpleBuilder
+  def new_instance
+    Chapter.new
+  end
+
+  def set_attributes
+    self.object.attributes = {
+      name: params[:name]
+    }
+  end
+end
+c = ChapterBuilder.build({ name: 'foo' }) # => #<Chapter id: 9, name: "foo">
+ChapterBuilder.update(c, { name: 'bar' }) # => #<Chapter id: 9, name: "bar">
+
+# A more complex example, illustrating the point of the block *and* new_instance
+# Assume rails and a normal, nested-resource style controller scheme
+class EventBuilder < SimpleBuilder
+  attr_accessor :league
+
+  def new_instance
+    league.events.build
+  end
+
+  def set_attributes
+    self.object.attributes = {
+      name: params[:name],
+      date: params[:date],
+      category: params[:category]
+    }
+  end
+end
+
+event = EventBuilder.build(params[:event]) { |eb| eb.league = @league }
+EventBuilder.update(event, params[:event])
+```
+
+## Why do this?
+
+I don't like the hassle of `strong_parameters`, but I like object security. I like explicit constructors and updates in order to ensure I can write solid, comprehensive unit tests for any business logic around updating and creating business objects.
+
+This approach lets me have strong tests, confidence that I am only accepting parameters I explicitly told it too, *and* lets me keep my controllers super-tidy.
+
+It's a win-win-win.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/simple_builder/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 new Pull Request

data/Rakefile

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

data/lib/simple_builder.rb

@@ -0,0 +1,37 @@
+class SimpleBuilder
+  VERSION = "1.0.0"
+
+  attr_accessor :params, :object
+
+  def initialize params, object = nil, &block
+    self.params = params
+    if block_given?
+      yield self
+    end
+    self.object = object || new_instance
+  end
+
+  # Builder Contract:
+  def new_instance
+  end
+
+  def set_attributes
+  end
+  # end of Contract
+
+  def self.build params, &block
+    new(params, &block).build!
+  end
+
+  def self.update object, params
+    new(params, object).update!
+  end
+
+  def build!
+    set_attributes
+    object.save
+    object
+  end
+  alias_method :update!, :build!
+
+end

data/simple_builder.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_builder'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_builder"
+  spec.version       = SimpleBuilder::VERSION
+  spec.authors       = ["Matt Wilson"]
+  spec.email         = ["mhw@hypomodern.com"]
+  spec.summary       = %q{Simple, PORO object builder/updater service}
+  spec.description   = %q{I got tired of reinventing a basic builder service in every project.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-bundler'
+end

data/spec/simple_builder/simple_builder_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe SimpleBuilder do
+  let(:params) {
+    { foo: 'bar' }
+  }
+  let(:test_builder) {
+    Class.new(SimpleBuilder) do
+      def new_instance; "HI THERE"; end
+    end
+  }
+
+  context "initialization" do
+
+    it "yields itself to a block if one is given" do
+      SimpleBuilder.new(params) do |new_object|
+        new_object.should be_an_instance_of(SimpleBuilder)
+      end
+    end
+
+    context "without a given object" do
+      it "sets self.object to the results of the #new_instance method" do
+        builder = test_builder.new params
+        builder.object.should == "HI THERE"
+      end
+    end
+
+    context "with a given object" do
+      it "sets self.object to the given object" do
+        builder = test_builder.new params, "A Dummy Object"
+        builder.object.should == "A Dummy Object"
+      end
+    end
+
+  end
+
+  describe "#build!" do
+    let(:builder) { test_builder.new params }
+    before do
+      builder.object.stub(:save)
+    end
+
+    it "calls #set_attributes" do
+      builder.should_receive(:set_attributes)
+      builder.build!
+    end
+
+    it "attempts to save self.object" do
+      builder.object.should_receive(:save)
+      builder.build!
+    end
+
+    it "returns self.object" do
+      builder.build!.should == builder.object
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'simple_builder'
+
+# 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'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: simple_builder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matt Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: guard-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'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  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: I got tired of reinventing a basic builder service in every project.
+email:
+- mhw@hypomodern.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_builder.rb
+- simple_builder.gemspec
+- spec/simple_builder/simple_builder_spec.rb
+- spec/spec_helper.rb
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Simple, PORO object builder/updater service
+test_files:
+- spec/simple_builder/simple_builder_spec.rb
+- spec/spec_helper.rb