creators 0.9

data/.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/creators/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "creators"
+  s.version     = Creators::VERSION
+  s.authors     = ["Itay Adler", "Shay Davidson", "Yonatan Bergman"]
+  s.email       = ["itayadler@gmail.com", "shay.h.davidson@gmail.com", "lighthawky@gmail.com"]
+  s.homepage    = "https://github.com/TheGiftsProject/creators"
+  s.summary     = %q{Making it even nicer to manage Form data params in your Controller.}
+  s.description = %q{Creators are used to host code dealing with creation of new models and clean up the controllers. }
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_path  = "lib"
+  s.test_files = Dir.glob('spec/lib/*_spec.rb')
+
+
+  s.add_dependency 'rails'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+end

data/.gitignore

@@ -0,0 +1,2 @@
+.idea
+*.gem

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.2@creators

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    creators (0.9)
+      rails
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.9)
+      actionpack (= 3.2.9)
+      mail (~> 2.4.4)
+    actionpack (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+    activerecord (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.5)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.7)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.9)
+      actionmailer (= 3.2.9)
+      actionpack (= 3.2.9)
+      activerecord (= 3.2.9)
+      activeresource (= 3.2.9)
+      activesupport (= 3.2.9)
+      bundler (~> 1.0)
+      railties (= 3.2.9)
+    railties (3.2.9)
+      actionpack (= 3.2.9)
+      activesupport (= 3.2.9)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    sprockets (2.2.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  creators!
+  rake
+  rspec

data/README.md

@@ -0,0 +1,134 @@
+# Creators 0.9  [![Build Status](https://secure.travis-ci.org/TheGiftsProject/Creators.png)](http://travis-ci.org/TheGiftsProject/Creators)
+
+Creators help to clean up your controllers from the model creation setup code.
+For the most basic situations simply creating a Creator and passing into it the request params, will just work for
+creating a new model, and if you'll require adding custom validations, slicing up garbage params or refining a new
+Hash of params to be used for the Model attributes, then a Creator is the home for all that.
+
+## Installation
+
+Just add the creators gem to your Gemfile
+
+`gem 'creators'`
+
+## Usage
+
+This example shows a very simple happy-sad flow for creating a project model using a creator.
+You can access the newly created project model when the creation is successful or the errors array if it's not.
+
+```ruby
+class ProjectsController < ApplicationController
+
+    def create
+        project_creator = ProjectCreator.new(params, current_user)
+        if project_creator.save
+           redirect_to project_url(project_creator.project)
+        else
+            logger.fatal "Could not create project. Error list: #{project_creator.errors.join(", "}")
+            redirect_to error_page_url
+        end
+    end
+
+end
+```
+
+## Defining a creator
+
+We recommend putting all your creator objects in `app/creators`.
+The model class that's attached to the creator is deduced from the name of the class.
+
+```ruby
+class ProjectCreator < Creators::Base
+
+    def initialize(raw_params, current_user)
+        @user = current_user
+        super(raw_params)
+    end
+
+    def before_build # optional
+        error("project", "must be an hash") unless @params[:project].is_a? Hash
+    end
+
+    def refine_params # optional
+        @params[:project]
+    end
+
+    def after_build # optional
+        project.members.build(refined_admin)
+    end
+
+    private
+
+    def refined_admin
+        {
+        :role => :admin,
+        :name => @user.name
+        }
+    end
+end
+```
+
+A Creator simply requires the `raw_params` from the request, 
+you can also add any other data that you might need. 
+For example in the ProjectsCreator we need the current_user.
+
+The specific behavior of your Creator is defined in the `refine_params` method and the callback methods, that compose
+the Save method Life Cycle. The Creator `save` method is divided into 2 main steps:
+
+1) `build` - This step simply instantiates a new model (Project in our example) and assigns to it the `raw_params` we've
+passed to the Creator. The `refine_params` step by default just uses the `raw_params`, and it can be easily overrided by
+using the `refine_params` method. (As shown in our example)
+Callback methods: `before_build`, `after_build`
+
+2) `save` - Simply calls `@model.save`.
+Callback methods: `before_save`, `after_save`
+
+```
+ |-- Save Life Cycle
+ |--|-- before_build
+ |--|-- refine_params
+ |--|-- after_build
+ |--|-- before_save
+ |--|-- after_save
+```
+
+
+## Want to update your model? No problems!
+
+Here's an example for a creator for the Task model, it relates to the Project model with a belongs_to association.
+
+```ruby
+class TasksController < ApplicationController
+
+    def update
+        current_task = current_project.tasks.find_by_id(params[:task][:id])
+
+        task_creator = TaskCreator.new(params, current_task)
+        if task_creator.save
+            render :json => task_creator.task
+        else
+            logger.fatal "Could not update task for project #{current_project.id}. Error list: #{task_creator.errors.join(", "}")
+        end
+    end
+
+end
+
+class TaskCreator < Creators::Base
+
+    def initialize(raw_params, current_task)
+        @task = task
+        super(raw_params, @task)
+    end
+
+    def refine_params
+        params[:task]
+    end
+
+end
+
+For update operations, if you pass to super a model as the 2nd argument, then that model will be used
+in the build process instead of it creating a new one, in case that model isn't nil.
+
+## Requirements
+
+Ruby 1.8.7+, Rails 3.0+.

data/Rakefile

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

data/lib/creators/creator.rb

@@ -0,0 +1,101 @@
+require 'active_support/core_ext'
+
+# Creators are used to host code dealing with creation of new models and clean up the controllers.
+#
+# EXAMPLE:
+#  class SomeCreator
+#    def refine_params
+#      # a hash with refined parameters required for the model.
+#    end
+#  end
+#
+#  class SomeController
+#    def action
+#      model = SomeCreator.new(params)
+#      if model.save
+#        # good flow
+#      else
+#        # bad flow
+#      end
+#    end
+#  end
+module Creators
+  class Base
+
+    class ErrorInParams < StandardError;end
+
+    def self.inherited(child_class)
+      child_class.class_eval do
+        class_name = child_class.to_s.gsub('Creator', '')
+        define_method :klass do
+          class_name.constantize
+        end
+
+        define_method class_name.underscore do
+          model
+        end
+      end
+    end
+
+    def initialize(raw_params = {}, model = nil)
+      @params = raw_params
+      @model  = model
+      @errors = {}
+    end
+
+    def save
+      build
+      before_save
+      return false unless @model.save
+      after_save
+      true
+    rescue ErrorInParams => e
+      Log.error(e)
+      false
+    end
+
+    def model
+      @model
+    end
+
+    def errors
+      e = @errors
+      return e.merge(@model.errors()) if @model.present? and @model.errors().present?
+      e
+    end
+
+    def error(field, text)
+      @errors[field] = text
+      raise ErrorInParams.new("#{field}: #{text}")
+    end
+
+    protected
+
+    def build
+      before_build
+      build_model
+      after_build
+    end
+
+    def build_model
+      @model ||= klass.new()
+      @model.attributes = refine_params
+    end
+
+    def refine_params
+      @params
+    end
+
+    def before_build
+    end
+
+    def after_build
+    end
+
+    def before_save
+    end
+
+    def after_save
+    end
+  end
+end

data/lib/creators/version.rb

@@ -0,0 +1,3 @@
+module Creators
+  VERSION = 0.9
+end

data/lib/creators.rb

@@ -0,0 +1,13 @@
+require 'active_support/dependencies'
+require 'creators/version'
+require 'rails/engine'
+
+module Creators
+  class Engine < ::Rails::Engine
+    initializer 'creators.autoload', :before => :set_autoload_paths do |app|
+      app.config.autoload_paths += Dir["#{config.root}/app/creators/**/"]
+    end
+  end
+end
+
+require 'creators/creator'

data/spec/lib/creators/creator_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+
+class Log
+  def self.error(exception)
+
+  end
+end
+
+describe Creators::Base do
+
+  class FakeModel
+    attr_reader :an_attribute, :another_attribute
+
+    def initialize(attribute = nil, another = nil)
+      @an_attribute = attribute
+      @another_attribute = another
+    end
+
+    def self.build
+      FakeModel.new
+    end
+
+    def attributes=(attributes)
+    end
+
+    def save
+    end
+
+    def errors
+      nil
+    end
+  end
+
+  class FakeModelCreator < Creators::Base
+  end
+
+  subject { FakeModelCreator.new }
+
+  describe :save do
+
+    context 'params are invalid' do
+      it 'should return false when raw params are invalid' do
+        subject.save.should be_false
+      end
+    end
+
+    context 'params are valid' do
+      before (:all) do
+        subject.stub(:before_build => true)
+        FakeModel.any_instance.stub(:save => true)
+      end
+
+      it 'should return true' do
+        subject.save.should be_true
+      end
+
+      it 'should have the new instance returned by the model method' do
+        subject.model.class.should == FakeModel
+      end
+
+      it 'should have an aliased method for the model named after the the creator name' do
+        subject.send(FakeModel.to_s.underscore).should == subject.model
+      end
+    end
+
+    context 'update existing model' do
+
+      let(:changed_attribute)   { 1 }
+      let(:changing_attribute)  { 2 }
+      let(:static_attribute)    { 3 }
+      let(:old_model)           { FakeModel.new(changed_attribute, static_attribute) }
+      subject { FakeModelCreator.new({:an_attribute => changing_attribute}, old_model)}
+
+      before (:each) do
+        old_model.stub(:validate_params => true)
+        subject.save
+      end
+
+      it 'should not create a new model after save' do
+        subject.model.should == old_model
+      end
+
+      it 'should change only attributes that were passed in the raw params' do
+        subject.model.an_attribute == changing_attribute
+        subject.model.another_attribute == static_attribute
+      end
+    end
+  end
+
+  describe :errors do
+    def error_before_build
+      def subject.before_build
+        error(:field, "text")
+      end
+    end
+
+    def error_during_refine_params
+      def subject.refine_params
+        error(:field, "text")
+      end
+    end
+
+    def error_after_build
+      def subject.after_build
+        error(:field, "text")
+      end
+    end
+
+    it "should return a hash with standard errors" do
+      subject.errors.should == {}
+    end
+
+    it "should fill in an error if an error occurs before build" do
+      error_before_build
+      subject.save.should be_false
+      subject.errors.should == {:field => "text"}
+    end
+
+    it "should fill in an error if an error during refinment " do
+      error_during_refine_params
+      subject.save.should be_false
+      subject.errors.should == {:field => "text"}
+    end
+
+    it "should fill in an error if an error after build " do
+      error_after_build
+      subject.save.should be_false
+      subject.errors.should == {:field => "text"}
+    end
+
+    it "should return a merged error hash of both the model.errors and validation errors" do
+      error_after_build
+      FakeModel.any_instance.stub(:errors => {:field2 => "txet"})
+      subject.save.should be_false
+      subject.errors.should == {:field => "text", :field2 => "txet"}
+    end
+
+    it "should return only model.errors if no validation errors" do
+      FakeModel.any_instance.stub(:errors => {:field2 => "txet"})
+      subject.save.should be_false
+      subject.errors.should == {:field2 => "txet"}
+    end
+
+    it "should log validation errors that happen" do
+      error_before_build
+      Log.should_receive(:error)
+      subject.save
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'creators'
+
+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
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: creators
+version: !ruby/object:Gem::Version
+  version: '0.9'
+  prerelease: 
+platform: ruby
+authors:
+- Itay Adler
+- Shay Davidson
+- Yonatan Bergman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &24302960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *24302960
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &24302540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *24302540
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &24302120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *24302120
+description: ! 'Creators are used to host code dealing with creation of new models
+  and clean up the controllers. '
+email:
+- itayadler@gmail.com
+- shay.h.davidson@gmail.com
+- lighthawky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemspec
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/creators.rb
+- lib/creators/creator.rb
+- lib/creators/version.rb
+- spec/lib/creators/creator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/TheGiftsProject/creators
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Making it even nicer to manage Form data params in your Controller.
+test_files: []