controller_setter_pattern 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36ee901377eb976f73cfc39346aa635c7063af71
+  data.tar.gz: 7740bd3b21ee8af6e282fb182ac75cdb33026c5c
+SHA512:
+  metadata.gz: 1fff224ca7116cf0773456103b329f60d4186a3c1ea176f35cd84f5ba8b048b5ba14104e302c17f4970ec4685e931ca0b0a82cec52e4220cd5a53f2996365420
+  data.tar.gz: 1fdbb3904400d9b320a4b10ad7918cf1bdb50d5b78c2b6531bb8cd895b518dd5f5c60630ec9b06bdbd41447883a86be49b5ae9b455a004776e79523ac2bc76dd

data/.gitignore

@@ -0,0 +1,3 @@
+.project
+Gemfile.lock
+log/*

data/.rspec

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rails', '~> 4.2.1'

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Rodrigo Casara
+
+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,178 @@
+# controller_setter_pattern
+Pattern for assign instance variables in controllers for use in views, etc.
+
+## Instalation
+
+Add `controller_setter_pattern` to your Gemfile:
+
+```ruby
+gem "controller_setter_pattern"
+```
+
+## Basic usage
+
+Before setter pattern:
+
+```ruby
+class ArticlesController < ApplicationController
+  before_action :set_article, except: [:index, :new, :create]
+
+  # GET /articles
+  def index
+    @articles = Article.all
+  end
+
+  # GET /articles/:id
+  def show; end
+
+  # GET /articles/new
+  def new
+    @article = Article.new
+  end
+
+  # GET /articles/:id/edit
+  def edit; end
+
+  # POST /articles
+  def create
+    @article = Article.new(article_params)
+
+    if @article.save
+      redirect_to @article
+    else
+      render :new
+    end
+  end
+  
+  # PATCH/PUT /articles/:id
+  def update
+    if @article.update(article_params)
+      redirect_to @article
+    else
+      render :edit
+    end
+  end
+  
+  # DELETE /articles/:id
+  def destroy
+    @article.destroy
+    redirect_to articles_path
+  end
+
+  private
+    def set_article
+      @article = Article.find(params[:id])
+    end
+
+    def article_params
+      params.require(:article).permit(:title, :text)
+    end
+end
+
+class CommentsController < ApplicationController
+  before_action :set_article
+  before_action :set_comment, except: [:index, :new, :create]
+
+  # POST /articles/:article_id/comments
+  def create
+    @comment = @article.comments.create(comment_params)
+    redirect_to article_path(@article)
+  end
+
+  # DELETE /articles/:article_id/comments/:id
+  def destroy
+    @comment.destroy
+    redirect_to article_path(@article)
+  end
+
+  private
+    def set_article
+      @article = Article.find(params[:article_id])
+    end
+
+    def set_comment
+      @comment = @article.comments.find(params[:id])
+    end
+
+    def comment_params
+      params.require(:comment).permit(:commenter, :body)
+    end
+end
+```
+
+After setter pattern:
+
+```ruby
+class ArticlesController < ApplicationController
+  set :article, except: [:index, :new, :create]
+
+  # actions methods ...
+
+  private
+    # setter method no more necessary
+
+    def article_params
+      params.require(:article).permit(:title, :text)
+    end
+end
+
+class CommentsController < ApplicationController
+  set :article
+  set :comment, ancestor: :article, except: [:index, :new, :create]
+
+  # actions methods ...
+
+  private
+    def comment_params
+      params.require(:comment).permit(:commenter, :body)
+    end
+end
+```
+
+In file `app/views/articles/show.html.erb`:
+
+```erb
+<p>
+  <strong>Title:</strong>
+  <%= @article.title %>
+</p>
+
+<p>
+  <strong>Text:</strong>
+  <%= @article.text %>
+</p>
+
+<h2>Comments</h2>
+<%= render @article.comments %>
+
+<h2>Add a comment:</h2>
+<%= render 'comments/form' %>
+
+<%= link_to 'Edit', edit_article_path(@article) %> |
+<%= link_to 'Back', articles_path %>
+```
+
+## Further configuration
+
+**Specify the model name:**
+
+```ruby
+set :ebook, model: Book
+# @ebook = Book.find(params[:id])
+```
+
+**Specify the parameters key to use to fetch the object:**
+```ruby
+set :ebook, model: Book, finder_params: :isbn
+# @ebook = Book.find_by_isbn(params[:isbn])
+
+set :ebook, model: Book, finder_params: [:author, :title]
+# @ebook = Book.find_by_author_and_title(params[:author], params[:title])
+```
+
+**Specify the scope:**
+
+```ruby
+set :user, scope: :active, finder_params: :email
+# @user = User.active.find_by_email(params[:email])
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--format progress']
+end
+
+task default: :spec

data/controller_setter_pattern.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'controller_setter_pattern/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'controller_setter_pattern'
+  s.version     = ControllerSetterPattern::VERSION
+  s.authors     = ['Rodrigo Casara']
+  s.email       = ['rodrigocasara@gmail.com']
+  s.homepage    = 'https://github.com/Casara/controller_setter_pattern'
+  s.summary     = 'Pattern for assign instance variables in controllers for use in views, etc.'
+  s.description = s.summary
+  s.license     = 'MIT'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rspec', '~> 3.2.0'
+  s.add_development_dependency 'rspec-rails', '~> 3.2.1'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'database_cleaner', '~> 1.4.1'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'actionpack', '~> 4.2.1'
+  s.add_development_dependency 'activesupport', '~> 4.2.1'
+  s.add_development_dependency 'factory_girl_rails', '~> 4.5.0'
+  s.add_development_dependency 'faker', '~> 1.4.3'
+end

data/lib/controller_setter_pattern.rb

@@ -0,0 +1,5 @@
+require 'controller_setter_pattern/action_controller'
+
+ActiveSupport.on_load :action_controller do
+  ActionController::Base.send :include, ControllerSetterPattern::ActionController
+end

data/lib/controller_setter_pattern/action_controller.rb

@@ -0,0 +1,67 @@
+module ControllerSetterPattern
+  module ActionController
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def set(*names)
+        options = names.extract_options!
+
+        model = options.delete(:model)
+        model = model.to_s.camelize.constantize unless model.nil?
+
+        finder_params = normalize_finder_params(options.delete(:finder_params) || [])
+        finder_method = 'find' + (finder_params.empty? ? '' : '_by_' + finder_params.join('_and_'))
+
+        ancestor = options.delete(:ancestor)
+        scope = options.delete(:scope)
+
+        names.each do |variable|
+          before_action options do |controller|
+            if !ancestor.nil?
+              if controller.instance_variable_defined?("@#{ancestor}")
+                resource = controller.instance_variable_get("@#{ancestor}")
+                model_class = resource.class
+              else
+                model_class = ancestor.to_s.camelize.constantize
+                resource = model_class.find(params["#{model_class.name.underscore}_id".to_sym])
+              end
+              reflection_name = (model || variable).to_s.underscore.pluralize.to_sym
+              resource = resource.send(reflection_name) if resource.respond_to?(reflection_name)
+            elsif !model.nil? && model.descends_from_active_record?
+              model_class = model
+            elsif
+              model_class = variable.to_s.camelize.constantize
+            end
+
+            resource ||= model_class
+
+            unless scope.nil?
+              scope = [scope] unless scope.is_a?(Array)
+              scope.each { |s| resource = resource.send(s) }
+            end
+
+            if finder_params.empty?
+              values_for_find = controller.params["#{variable}_id".to_sym] || controller.params[:id]
+            else
+              defaults = finder_params.inject({}) { |h, v| h.merge(v.to_s => nil) }
+              values_for_find = defaults.merge(controller.params.permit(finder_params)).values
+            end
+
+            resource = resource.send(finder_method, *values_for_find)
+
+            var_name = "@#{variable}".to_sym
+            controller.instance_variable_set(var_name, resource)
+          end
+        end
+      end
+
+      private
+        def normalize_finder_params(finder_params)
+          finder_params = [finder_params] unless finder_params.is_a?(Array)
+          finder_params = finder_params.compact.uniq
+          finder_params.clear if finder_params.one? && finder_params.join.eql?('id')
+          finder_params
+        end
+    end
+  end
+end

data/lib/controller_setter_pattern/version.rb

@@ -0,0 +1,6 @@
+module ControllerSetterPattern #:nodoc:
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 0
+  VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
+end

data/spec/controller_setter_pattern_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'rspec/rails'
+
+describe ControllerSetterPattern do
+  it 'is a model' do
+    expect(ControllerSetterPattern).to be_a(Module)
+  end
+end
+
+describe UsersController, type: :controller do
+  before { FactoryGirl.create_list(:user, 3) }
+
+  let(:user) { User.first }
+
+  subject { assigns(:user) }
+
+  it 'finds the instance with params[:id]' do
+    get :show, id: user.id
+    should be_a(User)
+  end
+
+  it 'finds the instance with params[:model_id]' do
+    get :show, user_id: user.id
+    should be_a(User)
+  end
+end
+
+describe AccountController, type: :controller do
+  before { FactoryGirl.create_list(:user, 3) }
+
+  let(:user) { User.first }
+
+  subject { assigns(:account) }
+
+  context 'with a model name and a parameter key' do
+    it 'finds an instance' do
+      get :resend_password, email: user.email
+      should be_a(User)
+    end
+
+    it 'finds an instance with scope' do
+      user.active!
+      get :profile, username: user.username
+      should be_a(User)
+    end
+  end
+end
+
+describe OrdersController, type: :controller do
+  let(:customer) { FactoryGirl.create(:customer) }
+
+  context 'with ancestor' do
+    it 'finds an instance' do
+      get :show, customer_id: customer.id, id: customer.orders.first.id
+      expect(assigns(:order)).to be_a(Order)
+    end
+
+    it 'assigns based on ancestor model class and model name' do
+      get :edit, customer_id: customer.id, id: customer.orders.last.id
+      expect(assigns(:other_order)).to be_a(Order)
+    end
+  end
+
+  it 'finds the instance with params keys' do
+    xhr :get, :order_by_customer_date, customer_id: customer.id, order_date: customer.orders.last.order_date.to_date
+    expect(assigns(:order)).to be_a(Order)
+  end
+end

data/spec/factories.rb

@@ -0,0 +1,17 @@
+FactoryGirl.define do
+  factory :user do
+    name     { Faker::Name.name }
+    username { Faker::Internet.user_name(name) }
+    email    { Faker::Internet.safe_email(username) }
+  end
+
+  factory :customer do
+    name { Faker::Company.name }
+    after(:create) { |customer| create_list(:order, 3, customer: customer) }
+  end
+
+  factory :order do
+    customer
+    order_date { Faker::Date.forward(90) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+require 'action_controller'
+require 'active_model'
+require 'active_record'
+require 'database_cleaner'
+require 'logger'
+require 'faker'
+require 'factory_girl_rails'
+require 'controller_setter_pattern'
+
+module Rails
+  class App
+    def env_config; {} end
+    def routes
+      @routes ||= ActionDispatch::Routing::RouteSet.new
+    end
+  end
+
+  def self.application
+    @app ||= App.new
+  end
+end
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), '../log/debug.log'))
+
+# now that we have the database configured, we can create the models and
+# migrate the database
+require 'support/models'
+require 'support/controllers'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  config.before(:suite) do
+    begin
+      DatabaseCleaner.strategy = :transaction
+      DatabaseCleaner.clean_with(:truncation)
+      DatabaseCleaner.start
+      FactoryGirl.find_definitions
+      FactoryGirl.lint
+    ensure
+      DatabaseCleaner.clean
+    end
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/controllers.rb

@@ -0,0 +1,43 @@
+load File.dirname(__FILE__) + '/routes.rb'
+
+ActionController::Base.include Rails.application.routes.url_helpers
+
+class UsersController < ActionController::Base
+  set :user, only: :show
+
+  def show
+    render json: @user
+  end
+end
+
+class AccountController < ActionController::Base
+  set :account, model: User, finder_params: :email, only: :resend_password
+  set :account, model: User, scope: :active, finder_params: :username, only: :profile
+
+  def resend_password
+    render text: "An email containing the new password was sent to your inbox (#{@account.email})."
+  end
+
+  def profile
+    render json: @account
+  end
+end
+
+class OrdersController < ActionController::Base
+  set :customer, only: :show
+  set :order, ancestor: :customer, only: :show
+  set :other_order, model: Order, ancestor: :customer, only: :edit
+  set :order, finder_params: [:customer_id, :order_date], only: :order_by_customer_date
+
+  def show
+    render json: @order
+  end
+
+  def edit
+    render text: 'Edit'
+  end
+
+  def order_by_customer_date
+    render json: @order
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,25 @@
+load File.dirname(__FILE__) + '/schema.rb'
+
+class User < ActiveRecord::Base
+  has_many :social_networks
+
+  enum status: {
+    passive: 0,
+    pending: 1,
+    active: 2,
+    locked: 3
+  }
+
+  validates_uniqueness_of :email, case_sensitive: false
+  validates_uniqueness_of :username, case_sensitive: false
+
+  before_save { |record| record.status = 'pending' if record.passive? }
+end
+
+class Customer < ActiveRecord::Base
+  has_many :orders, dependent: :destroy
+end
+
+class Order < ActiveRecord::Base
+  belongs_to :customer
+end

data/spec/support/routes.rb

@@ -0,0 +1,10 @@
+Rails.application.routes.draw do
+  get 'user/(:id)' => 'users#show'
+
+  get 'resend_password/:email' => 'account#resend_password'
+  get 'profile/:username' => 'account#profile'
+
+  get 'customers/:customer_id/orders/:id' => 'orders#show'
+  get 'customers/:customer_id/orders/:id/edit' => 'orders#edit', as: :edit
+  get 'order_by_customer_date' => 'orders#order_by_customer_date'
+end

data/spec/support/schema.rb

@@ -0,0 +1,22 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, force: true do |t|
+    t.integer :status, default: 0
+    t.string :name
+    t.string :username, unique: true
+    t.string :email, unique: true
+    t.timestamps null: false
+  end
+
+  create_table :customers, force: true do |t|
+    t.string :name
+    t.timestamps null: false
+  end
+
+  create_table :orders, force: true do |t|
+    t.belongs_to :customer, index: true
+    t.datetime :order_date
+    t.timestamps null: false
+  end
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: controller_setter_pattern
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodrigo Casara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-04 00:00:00.000000000 Z
+dependencies:
+- !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
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !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: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+description: Pattern for assign instance variables in controllers for use in views,
+  etc.
+email:
+- rodrigocasara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- controller_setter_pattern.gemspec
+- lib/controller_setter_pattern.rb
+- lib/controller_setter_pattern/action_controller.rb
+- lib/controller_setter_pattern/version.rb
+- spec/controller_setter_pattern_spec.rb
+- spec/factories.rb
+- spec/spec_helper.rb
+- spec/support/controllers.rb
+- spec/support/models.rb
+- spec/support/routes.rb
+- spec/support/schema.rb
+homepage: https://github.com/Casara/controller_setter_pattern
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Pattern for assign instance variables in controllers for use in views, etc.
+test_files: []