dryparams 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Geoffrey Roguelon
+
+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,44 @@
+# DRYParams [![Build Status](https://travis-ci.org/GRoguelon/DRYParams.png?branch=master)](https://travis-ci.org/GRoguelon/DRYParams) [![Coverage Status](https://coveralls.io/repos/GRoguelon/DRYParams/badge.png)](https://coveralls.io/r/GRoguelon/DRYParams) [![Code Climate](https://codeclimate.com/github/GRoguelon/DRYParams.png)](https://codeclimate.com/github/GRoguelon/DRYParams) [![Dependency Status](https://gemnasium.com/GRoguelon/DRYParams.png)](https://gemnasium.com/GRoguelon/DRYParams)
+
+This gem is only compatible with Ruby on Rails 4.0 and the new feature _Strong Parameters_.
+
+The DRYParams gem targets to DRY (Don't Repeat Yourself) the controller code in factoring the private mthods.
+
+## Next
+
+- Support Rails 3 with Strong Parameters gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dryparams'
+```
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install dryparams
+```
+
+## Documentation
+
+To get more informations about this gem, please visit [RubyDoc](http://rubydoc.info/gems/dryparams/frames/).
+
+## Contributing
+
+1. Fork it
+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
+
+## License
+
+MIT License. See the MIT-LICENSE file.

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+  require 'yard'
+  require 'rake/testtask'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = %w{lib/**/*.rb}
+  t.options = %w{-o doc --files README.md}
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task default: :test

data/lib/dryparams/dryable.rb

@@ -0,0 +1,71 @@
+require 'dryparams/naming'
+
+module DRYParams
+  # The main class of the gem DRYParams.
+  #
+  # @author {mailto:geoffrey.roguelon@gmail.com Geoffrey Roguelon}
+  module Dryable
+    extend ActiveSupport::Concern
+
+    # The class methods of the +DRYParams+ concern.
+    #
+    # @author {mailto:geoffrey.roguelon@gmail.com Geoffrey Roguelon}
+    module ClassMethods
+      # The default actions for callback controller.
+      DEFAULT_ACTIONS = [:show, :edit, :update, :destroy]
+
+      # Add to the instance of the controller:
+      # - One method to set properly the instance variable from the model name;
+      # - One method to filter the parameters of the request.
+      #
+      # @param [Array] args the arguments of the generations methods.
+      # @return [void]
+      def set_object_and_filter_params(*args)
+        name, options = Naming.new(self), args.extract_options!
+
+        set_current_object(options, name)
+        filter_params(args, name)
+      end
+
+      # Filter the parameters of the request.
+      #
+      # @param [Array] attributes the attributes to permit in the request.
+      # @param [Naming] name an instance of +Naming+ class.
+      # @return [void]
+      def filter_params(attributes, name = Naming.new(self))
+        if attributes.present?
+          self.class_eval(<<-RUBY, 'dryable.rb', 37)
+            def #{name.object}_params
+              params.require(:#{name.object}).permit(*#{attributes})
+            end
+            private :#{name.object}_params
+          RUBY
+        end
+      end
+
+      # Set properly the instance variable from the model name.
+      #
+      # @param [HashWithIndifferentAccess, Hash] options the option of the
+      #  callback (:only, :except).
+      # @param [Naming] name an instance of +Naming+ class.
+      # @return [void]
+      def set_current_object(options, name = Naming.new(self))
+        if name.model
+          options = options.with_indifferent_access
+          methods = options.slice(:only, :except).presence || {
+            only: DEFAULT_ACTIONS
+          }
+
+          self.class_eval(<<-RUBY, 'dryable.rb', 59)
+            def set_#{name.object}
+              @#{name.object} = #{name.klass}.find(params[:id])
+            end
+            private :set_#{name.object}
+
+            before_action :set_#{name.object}, #{methods}
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/dryparams/engine.rb

@@ -0,0 +1,9 @@
+module DRYParams
+  # The class define a callback to include the main module in
+  #  +ActionController+.
+  #
+  # @author {mailto:geoffrey.roguelon@gmail.com Geoffrey Roguelon}
+  class Engine < ::Rails::Engine
+    ActiveSupport.on_load(:action_controller) { include DRYParams::Dryable }
+  end
+end

data/lib/dryparams/naming.rb

@@ -0,0 +1,32 @@
+module DRYParams
+  # The class returns the different names available for a given controller.
+  #
+  # @author {mailto:geoffrey.roguelon@gmail.com Geoffrey Roguelon}
+  class Naming
+    # @param [ActionController::Base] controller_instance The controller used
+    #  to determine the different names.
+    # @return [self]
+    def initialize(controller_instance)
+      @controller = controller_instance
+    end
+
+    # @return [Class] the model class associated to the controller.
+    def model
+      @model ||= begin
+        klass.constantize
+      rescue NameError
+        nil
+      end
+    end
+
+    # @return [String] the object name from the controller.
+    def object
+      @object ||= klass.downcase
+    end
+
+    # @return [String] the model name associated to the controller.
+    def klass
+      @klass ||= @controller.controller_name.classify
+    end
+  end
+end

data/lib/dryparams/version.rb

@@ -0,0 +1,18 @@
+module DRYParams
+  # The module defines the version of the gem.
+  #
+  # @author {mailto:geoffrey.roguelon@gmail.com Geoffrey Roguelon}
+  module Version
+    # The major number version.
+    MAJOR = 0
+    # The minor number version.
+    MINOR = 1
+    # The tiny number version.
+    TINY  = 0
+    # The pre realese number version.
+    PRE   = nil
+
+    # The complete number version.
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/lib/dryparams.rb

@@ -0,0 +1,8 @@
+# The main module of the gem.
+#
+# @author {mailto:geoffrey.roguelon@gmail.com Geoffrey Roguelon}
+module DRYParams; end
+
+require 'dryparams/dryable'
+require 'dryparams/engine'
+require 'dryparams/naming'

data/lib/tasks/dryparams_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :dryparams do
+#   # Task goes here
+# end

data/test/dryparams/dryable_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class DRYParams::DryableTest < ActiveSupport::TestCase
+  include DRYParams
+
+  test 'dryable should be a module' do
+    assert_kind_of Module, Dryable
+  end
+
+  test 'dryable should be extended by active_support::extended' do
+    assert Dryable.singleton_class.included_modules.include?(ActiveSupport::Concern)
+  end
+
+  test 'dryable should have a submodule class_methods' do
+    assert_kind_of Module, Dryable::ClassMethods
+  end
+
+  test 'class_methods should have a constant default_actions' do
+    assert Dryable::ClassMethods.const_defined?(:DEFAULT_ACTIONS)
+    assert_kind_of Array, Dryable::ClassMethods::DEFAULT_ACTIONS
+  end
+
+  test 'set_object_and_filter_params method should be defined' do
+    assert Dryable::ClassMethods.instance_methods.include?(:set_object_and_filter_params)
+  end
+
+  test 'filter_params method should be defined' do
+    assert Dryable::ClassMethods.instance_methods.include?(:filter_params)
+  end
+
+  test 'set_current_object method should be defined' do
+    assert Dryable::ClassMethods.instance_methods.include?(:set_current_object)
+  end
+end

data/test/dryparams/engine_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class DRYParams::EngineTest < ActiveSupport::TestCase
+  include DRYParams
+
+  test 'engine should be a class' do
+    assert_kind_of Class, Engine
+  end
+
+  test 'engine should be herited from rails::engine' do
+    assert Engine < ::Rails::Engine
+  end
+
+  test 'dryable should be included in action_controller::base' do
+    ActionController::Base.ancestors.include?(DRYParams::Dryable)
+  end
+end

data/test/dryparams/naming_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class DRYParams::NamingTest < ActiveSupport::TestCase
+  include DRYParams
+
+  class Gem < ActiveRecord::Base; end
+  class GemsController < ApplicationController; end
+
+  test 'naming should be a class' do
+    assert_kind_of Class, Naming
+  end
+
+  test 'DRYParams::Naming should have a constructor' do
+    assert_respond_to Naming, :new
+  end
+
+  test 'Constructor should take one argument' do
+    assert_instance_of Naming, Naming.new(GemsController)
+  end
+
+  test 'method model return a class' do
+    assert_equal Gem.name.split('::').last, Naming.new(GemsController).model.name
+  end
+
+  test 'method model return nil if class not found' do
+    assert_equal nil, Naming.new(DRYParams::Naming).model
+  end
+
+  test 'method object return string' do
+    assert_instance_of String, Naming.new(GemsController).object
+    assert_equal 'gem', Naming.new(GemsController).object
+  end
+
+  test 'method klass return string' do
+    assert_instance_of String, Naming.new(GemsController).klass
+    assert_equal 'Gem', Naming.new(GemsController).klass
+  end
+end

data/test/dryparams/version_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class DRYParams::VersionTest < ActiveSupport::TestCase
+  include DRYParams
+
+  test 'version should be a module' do
+    assert_kind_of Module, Version
+  end
+
+  test 'major constant must be defined' do
+    assert Version.const_defined?(:MAJOR)
+  end
+
+  test 'minor constant must be defined' do
+    assert Version.const_defined?(:MINOR)
+  end
+
+  test 'tiny constant must be defined' do
+    assert Version.const_defined?(:TINY)
+  end
+
+  test 'pre constant must be defined' do
+    assert Version.const_defined?(:PRE)
+  end
+
+  test 'string constant must be defined' do
+    assert Version.const_defined?(:STRING)
+    assert_instance_of String, Version::STRING
+  end
+end

data/test/dryparams_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class DRYParamsTest < ActiveSupport::TestCase
+  test 'DRYParams should be a module' do
+    assert_kind_of Module, DRYParams
+  end
+end

data/test/dummy/README.md

@@ -0,0 +1,27 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/javascripts/users.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/test/dummy/app/assets/stylesheets/users.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+class ApplicationController < ActionController::Base
+  include DRYParams::Dryable
+
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/users_controller.rb

@@ -0,0 +1,47 @@
+class UsersController < ApplicationController
+  set_object_and_filter_params :lastname, :firstname, :email
+
+  # GET /users
+  def index
+    @users = User.all
+  end
+
+  # GET /users/1
+  def show
+  end
+
+  # GET /users/new
+  def new
+    @user = User.new
+  end
+
+  # GET /users/1/edit
+  def edit
+  end
+
+  # POST /users
+  def create
+    @user = User.new(user_params)
+
+    if @user.save
+      redirect_to @user, notice: 'User was successfully created.'
+    else
+      render action: 'new'
+    end
+  end
+
+  # PATCH/PUT /users/1
+  def update
+    if @user.update(user_params)
+      redirect_to @user, notice: 'User was successfully updated.'
+    else
+      render action: 'edit'
+    end
+  end
+
+  # DELETE /users/1
+  def destroy
+    @user.destroy
+    redirect_to users_url, notice: 'User was successfully destroyed.'
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/helpers/users_helper.rb

@@ -0,0 +1,2 @@
+module UsersHelper
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/views/users/_form.html.erb

@@ -0,0 +1,29 @@
+<%= form_for(@user) do |f| %>
+  <% if @user.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@user.errors.count, "error") %> prohibited this user from being saved:</h2>
+
+      <ul>
+      <% @user.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :lastname %><br>
+    <%= f.text_field :lastname %>
+  </div>
+  <div class="field">
+    <%= f.label :firstname %><br>
+    <%= f.text_field :firstname %>
+  </div>
+  <div class="field">
+    <%= f.label :email %><br>
+    <%= f.text_field :email %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/test/dummy/app/views/users/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing user</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @user %> |
+<%= link_to 'Back', users_path %>

data/test/dummy/app/views/users/index.html.erb

@@ -0,0 +1,31 @@
+<h1>Listing users</h1>
+
+<table>
+  <thead>
+    <tr>
+      <th>Lastname</th>
+      <th>Firstname</th>
+      <th>Email</th>
+      <th></th>
+      <th></th>
+      <th></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @users.each do |user| %>
+      <tr>
+        <td><%= user.lastname %></td>
+        <td><%= user.firstname %></td>
+        <td><%= user.email %></td>
+        <td><%= link_to 'Show', user %></td>
+        <td><%= link_to 'Edit', edit_user_path(user) %></td>
+        <td><%= link_to 'Destroy', user, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%= link_to 'New User', new_user_path %>

data/test/dummy/app/views/users/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New user</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', users_path %>