restful_controller 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15e4f8de8ab53f6ca410c248e9b84d4ba7afe2c4
+  data.tar.gz: 21f2de7e065969b0f56fda318a94bca1aacdb428
+SHA512:
+  metadata.gz: fcb5302fa9589c455bb6c4e0ee34e5e7320e041d08746c2abbb377beb8d4fd7f1a03068046feb3758cfb653b22892a9f5a6681cc55301ab9b4dae3cb8ec222a9
+  data.tar.gz: ccd5c3dafaab3fb91b0df5da70da7a74aa3b43849b2fddfe28ea65983b86ba86fbff0eeec3af493aae03ced53dc134cfd854e10597b137e5b98b670412653edd

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.rdoc

@@ -0,0 +1,151 @@
+{<img src="https://travis-ci.org/mariochavez/restful.png?branch=master" alt="Build Status" />}[https://travis-ci.org/mariochavez/restful]
+= Restful
+Restful helps to keep Controllers DRY, removing repetitive code from basic REST actions.
+
+Very basic controllers repeat over and over the same code for REST actions, but if you do TDD - and should be doing it -, the code to test these controllers is also repetitive and boring.
+
+Restful helps you to get rid of that repetitive and boring code with a very simple defaults for RESTful controllers.
+
+But wait, this is not a new idea, there is already Inherited Resources (https://github.com/josevalim/inherited_resources) gem that allows you to do the same and maybe even more; so why write another library?
+
+It's simple, I had the time and I wanted to try it. This library does not cover all the cases that Inherited Resources cover, but it's good enough for so many controllers. Also all the source code is documented and quite simple to follow in case that you want to learn how is it implemented.
+
+== Installation
+Resful requires Ruby on Rails 4.0 and Ruby 2.0.
+
+To install it, just add the Restful gem to your Gemfile:
+
+  gem 'restful'
+
+Run bundler command and you are all set.
+
+== Usage
+Restful module must be included on each controller that you want to become Restful. Also it's need for these controllers to include the respond_to macro, which will especify the format to which our controllers will respond to.
+
+Finally the resful macro is need it to setup our controller.
+This macro accepts 3 params:
+
+=== Params
+* model: A requires parameter which is a symbol of the model name.
+* strong_params: A symbol, a string or a proc for the method that should apply the strong parameters to allow Active Model mass assignments.
+* actions: An array of actions that a controller should implement, if none is passed then all seven REST actions are defined.
+
+=== Examples
+
+Simple:
+
+  class DocumentsController < ApplicationController
+    include restful
+    respond_to :html
+
+    restful model: :document, strong_params: :document_params
+  end
+
+This definition will create the seven REST actions for Document model,
+this setup a single object instance variable @document and a collection
+variable @documents.
+
+It's expected that this controller will provide a method
+document_params which will be used to allow mass assignments.
+
+Strong params variation:
+
+  class DocumentsController < ApplicationController
+    include restful
+    respond_to :html
+
+    restful model: :document,
+      strong_params: ->(params){ params.require(:document).permit :name  }
+  end
+
+In this example instead of providing a strong params method by string
+or symbol, a proc is passed to do the same job.
+
+Listed actions variation:
+
+The last parameter *actions* allows you to list in an array the actions
+that you want your controller to have:
+
+  class DocumentsController < ApplicationController
+    include restful
+    respond_to :html
+
+    restful model: :document, strong_params: :document_params,
+      actions: [:index, :show]
+  end
+
+In this case our controller will only respond to those 2 actions. We
+can do it the other way, indicate list of actions that shouldn't be
+defined:
+
+  class DocumentsController < ApplicationController
+    include restful
+    respond_to :html
+
+    restful model: :document, strong_params: :document_params,
+      actions: [:all, except: [:destroy, :show]]
+  end
+
+For this last example all seven REST actions will be defined but :destroy and :show
+
+== Actions
+
+Used as a template for all Restful controller actions
+
+By default an action is created with an alias method with a bang(!).
+If you need to override an action, just redefine it in you controller,
+to call this base action, just call the bang version:
+
+  def index
+    @documents = Document.all
+    index!
+  end
+
+This will allow you to let Restful to continue with the action flow.
+
+When overriding an action, just be sure to have inside de action variables
+with the name of the defined model, doing this will allow you to call the
+bang action version:
+
+  def new
+    @document = Document.new name: 'Default name'
+    new!
+  end
+
+For actions like :create and :update a notice or alert can be passed as
+option to be set in flash object:
+
+  def create
+    @document = Document.new secure_params
+    create!(notice: 'Hey a new document was created!')
+  end
+
+Also a block can be passed for the happy path to tell the application to
+where redirect:
+
+  def update
+    @document = Document.find params[:id]
+    @document.update_attributes secure_params
+
+    update!(notice: 'Document has been updated'){ root_path }
+  end
+
+It's also possible to supply a block for the non-happy path, this means
+proving a dual block for success and failure results from our action:
+
+  def update
+    @document = Document.find params[:id]
+    @document = update_attributes secure_params
+
+    update! do |success, failure|
+      success.html { redirect_to root_path }
+      failure.html { render :custom }
+    end
+  end
+
+== Bugs and feedback
+Use issues at Github to report bugs or give feedback.
+
+For detailed documentation look at http://rdoc.info/github/mariochavez/restful/master/frames
+
+Copyright © 2013 Mario Alberto Chavez. This project uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,44 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Restful'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+desc 'Run rubocop checks'
+task :rubocop do
+    sh 'rubocop lib test'
+end
+
+desc 'Run flay checks'
+task :flay do
+    sh 'find lib -name \*.rb | xargs flog'
+end
+
+desc 'Run flog checks'
+task :flog do
+    sh 'flay lib/*.rb'
+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/restful/actions.rb

@@ -0,0 +1,168 @@
+module Restful
+  ##
+  # = Actions
+  #
+  # Used as a template for all Restful controller actions
+  #
+  # By default an action is created with an alias method with a bang(!).
+  # If you need to override an action, just redefine it in you controller,
+  # to call this base action, just call the bang version:
+  #
+  #   def index
+  #     @documents = Document.all
+  #     index!
+  #   end
+  #
+  # This will allow you to let Restful to continue with the action flow.
+  #
+  # When overriding an action, just be sure to have inside de action variables
+  # with the name of the defined model, doing this will allow you to call the
+  # bang action version:
+  #
+  #   def new
+  #     @document = Document.new name: 'Default name'
+  #     new!
+  #   end
+  #
+  # For actions like :create and :update a notice or alert can be passed as
+  # option to be set in flash object:
+  #
+  #   def create
+  #     @document = Document.new secure_params
+  #     create!(notice: 'Hey a new document was created!')
+  #   end
+  #
+  # Also a block can be passed for the happy path to tell the application to
+  # where redirect:
+  #
+  #   def update
+  #     @document = Document.find params[:id]
+  #     @document.update_attributes secure_params
+  #
+  #     update!(notice: 'Document has been updated'){ root_path }
+  #   end
+  #
+  # It's also possible to supply a block for the non-happy path, this means
+  # proving a dual block for success and failure results from our action:
+  #
+  #   def update
+  #     @document = Document.find params[:id]
+  #     @document = update_attributes secure_params
+  #
+  #     update! do |success, failure|
+  #       success.html { redirect_to root_path }
+  #       failure.html { render :custom }
+  #     end
+  #   end
+  #
+  # Be aware that Restful require that your controllers define to what they
+  # respond, it could be :html, :json or anything else, just remember to add
+  # the respond_to macro to the top of your controller's definition:
+  #
+  #  class DocumentsController < ApplicationController
+  #    respond_to :html
+  #  end
+  #
+  module Actions
+    ##
+    # index action, this set a collection of objects to an instance variable
+    # which can be accessed from the view using the collection helper method.
+    # The instance variable name is a pluralization of the model name defined
+    # in the restful macro.
+    def index(options = {}, &block)
+      respond_with(collection, options,  &block)
+    end
+    alias_method :index!, :index
+
+    ##
+    # new action, creates a new object and sets an instance variable which can
+    # be accessed from the view using the resource helper method. The instance
+    # variable is named after the model name defined in the restful macro.
+    def new(options = {}, &block)
+      respond_with(build_resource, options, &block)
+    end
+    alias_method :new!, :new
+
+    ##
+    # create action, creates a new object off the received params and sets an
+    # instance variable if record is saved then a redirect to index action is
+    # made.
+    #
+    # If record fail to be saved, the new form is renderd and the instance
+    # variable can be accessed from the view using the resource
+    # helper method. The instance variable is named after the model name
+    # defined in the restful macro.
+    def create(options = {}, &block)
+      object = get_resource_ivar || create_resource
+
+      options[:location] = collection_path if object.errors.empty?
+
+      respond_with_dual(object, options, &block)
+    end
+    alias_method :create!, :create
+
+    ##
+    # edit action, finds an object based on the passed id, if no object is
+    # found an ActiveRecord::RecordNotFound is raised.
+    #
+    # If the record is found then an instance variable, based on the model
+    # name set in the restful macro.
+    #
+    # This variable can be accessed in teh form using the resource helper
+    # method.
+    def edit(options = {}, &block)
+      object = get_resource_ivar || find_resource
+
+      respond_with(object, options, &block)
+    end
+    alias_method :edit!, :edit
+
+    ##
+    # update action, finds an object based on the passed id, if no object is
+    # found an ActiveRecord::RecordNotFound is raised. If the record is found
+    # then it's updated from params using ActiveRecord update_attributes method
+    # and an instance variable is set with the object, variable name is based
+    # on the model name set in the restful macro.
+    #
+    # If update_attributes fail, then edit form is displayed, and the instance
+    # variable can be accessed in teh form using the resource helper method.
+    #
+    # If update_attributes success, a redirect to the index action is made.
+    def update(options = {}, &block)
+      object = get_resource_ivar || find_and_update_resource
+
+      options[:location] = collection_path if object.errors.empty?
+
+      respond_with_dual(object, options, &block)
+    end
+    alias_method :update!, :update
+
+    ##
+    # show action, finds an object based on the passed id, if no object is
+    # found an ActiveRecord::RecordNotFound is raised. If the record is found
+    # then an instance variable is set with the object, variable name is based
+    # on the model name set in the restful macro.
+    def show(options = {}, &block)
+      object = get_resource_ivar || find_resource
+
+      respond_with(object, options, &block)
+    end
+    alias_method :show!, :show
+
+    ##
+    # destroy action, finds an object based on the passed id, if no object is
+    # found an ActiveRecord::RecordNotFound is raised. If the record is found
+    # then it's destroyed and a redirect to the index action is made.
+    def destroy(options = {}, &block)
+      object = get_resource_ivar || find_resource
+
+      object.destroy
+      options[:location] = collection_path
+
+      respond_with(object, options, &block)
+    end
+    alias_method :destroy!, :destroy
+
+    protected :index!, :new!, :create!, :edit!, :update!, :show!, :destroy!
+  end
+end