crud_actions 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7189f145107ce7b831b50d2f4806433e88871a41
+  data.tar.gz: bc0a2d60e755efedb7461db320594b1bef51e6bf
+SHA512:
+  metadata.gz: 14c9b8fc46caa6c9fb3c09e8d1bc24962ea36175963ecc253a68dffdfd06024ca9dc288a16f62d366d534bf739d6442da11e8d93ab6c9d083f2d611bc5b41d64
+  data.tar.gz: 9343d86db664812008df573054af3b36b7580f4e37f893a481c1feaa7d6841e0c4f0c27a23759f02ddd7258dc5310f56c019632d6103f66a5853893e7eb06807

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Amit Choudhary
+
+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,128 @@
+= CrudActions
+
+CrudActions provides all the seven crud actions(i.e - index, new, create, edit, update, show and destroy) to your controller with basic functionalities.
+
+= Installation
+Write following in your gemfile and bundle install : -
+* gem 'crud_actions'
+
+= Usage
+Define a method named as 'has_inherited_actions' with arguments as action names which you want to include from the gem.
+For example: -
+
+  Class CategoriesController < ActionController::Base
+    has_inherited_actions :index, :new, :create, :edit, :update, :show, :destroy
+  end
+
+CategoriesController will have now all the seven actions which are passed as arguments to the 'has_inherited_actions'.
+
+The action names which are not passed as arguments are not defined for the controller and need to be defined separately in the controller
+
+= index action usage
+index action will be defined like :-
+  def index
+    @categories = Category.all
+  end
+You can also pass some options to the index - 'includes' and 'order'. Like if you define your controller like this: -
+  class CategoriesController < ActionController:: Base
+    has_inherited_actions :index
+    def index
+      super({ includes: :subcategories, order: :name })
+    end
+  end
+Then the action will be defined as
+  def index
+    @categories = Category.includes(:subcategories).order(:name)
+  end
+
+= new action usage
+new action will be defined like : -
+  def new
+    @category = Category.new
+  end
+
+= create action usage
+create action expects controller to define a method named as permitted_params_for_create for permitting params.
+create action will be defined like :-
+  def create
+    @category = Category.new(permitted_params_for_create)
+    if @category.save
+      flash[:notice] = 'Category created successfully.'
+      redirect_to action: :index
+    else
+      flash[:alert] = @category.errors.full_messages.join(', ')
+      redirect_to action: :new
+    end
+  end
+
+You can also pass some options to the create - 'redirect_to', 'notice' and 'alert'. Like if you define your controller like this: -
+  class CategoriesController < ActionController:: Base
+    has_inherited_actions :create
+    def create
+      super({ redirect_to: subcategories_path, notice: 'Successful creation', alert: 'Could not create.' })
+    end
+  end
+'redirect_to' option will be used to redirect to a path after successful creation.
+'success' option will be used to set flash[:notice] instead of default message.
+'alert' option will be used to set flash[:alert] instead of default message.
+
+= edit action usage
+edit action will be defined like : -
+  def edit
+  end
+
+= update action usage
+update action expects controller to define a method named as permitted_params_for_update for permitting params.
+It also expects controller to define an instance variable named properly before update(like: - @category in case of CategoriesController, @exams_question in case of ExamsQuestionController)
+update action will be defined like :-
+  def update
+    if @category.update(permitted_params_for_update)
+      flash[:notice] = 'Category updated successfully.'
+      redirect_to action: :index
+    else
+      flash[:alert] = @category.errors.full_messages.join(', ')
+      redirect_to action: :edit
+    end
+  end
+
+You can also pass some options to the update - 'redirect_to', 'notice' and 'alert'. Like if you define your controller like this: -
+  class CategoriesController < ActionController:: Base
+    has_inherited_actions :update
+    def update
+      super({ redirect_to: subcategories_path, notice: 'Successful updation.', alert: 'Could not update.' })
+    end
+  end
+'redirect_to' option will be used to redirect to a path after successful creation.
+'success' option will be used to set flash[:notice] instead of default message.
+'alert' option will be used to set flash[:alert] instead of default message.
+
+= show action usage
+show action will be defined like : -
+  def show
+  end
+
+= destroy action usage
+destroy action expects controller to define an instance variable named properly before destroy(like: - @category in case of CategoriesController, @exams_question in case of ExamsQuestionController)
+destroy action will be defined like :-
+  def destroy
+    if @category.destroy
+      flash[:notice] = 'Category destroyed successfully.'
+    else
+      flash[:alert] = @category.errors.full_messages.join(', ')
+    end
+    redirect_to action: :index
+  end
+
+You can also pass some options to the destroy - 'redirect_to', 'notice' and 'alert'. Like if you define your controller like this: -
+  class CategoriesController < ActionController:: Base
+    has_inherited_actions :destroy
+    def destroy
+      super({ redirect_to: subcategories_path, notice: 'Successful deletion.', alert: 'Could not destroy.' })
+    end
+  end
+'redirect_to' option will be used to redirect to a path.
+'success' option will be used to set flash[:notice] instead of default message.
+'alert' option will be used to set flash[:alert] instead of default message.
+
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,34 @@
+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    = 'CrudActions'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+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/crud_actions/actions.rb

@@ -0,0 +1,81 @@
+require 'crud_actions/base_helper'
+require 'crud_actions/actions_helper'
+
+module CrudActions
+  module Actions
+
+    include ::CrudActions::BaseHelper
+    include ::CrudActions::ActionsHelper
+    extend ActiveSupport::Concern
+
+    DEFAULT_ACTIONS = [:index, :new, :create, :edit, :update, :show, :destroy]
+
+    def self.included(class_name)
+      model_name = class_name.to_s.split('Controller').first.split('::').last.singularize
+      class_name.instance_variable_set('@resource_class', model_name.constantize)
+      class_name.instance_variable_set('@resource_name', model_name.underscore)
+    end
+
+    module ClassMethods
+      def has_inherited_actions(*actions)
+        excluded_actions = DEFAULT_ACTIONS - actions
+        self.send(:undef_method, *excluded_actions)
+      end
+    end
+
+    def index(options = { order: nil, includes: nil })
+      index_helper(controller_name, options)
+    end
+
+    def new
+      resource_name = self.class.instance_variable_get('@resource_name')
+      instance_variable_set("@#{ resource_name }", self.class.instance_variable_get('@resource_class').new)
+    end
+
+    def create(options = { notice: nil, alert: nil })
+      resource_name = self.class.instance_variable_get('@resource_name')
+      resource_class = self.class.instance_variable_get('@resource_class')
+      instance_variable_set("@#{ resource_name }", resource_class.new(permitted_params_for_create))
+      resource = instance_variable_get("@#{ resource_name }")
+      if resource.public_send(:save)
+        flash[:notice] = options[:notice] || "#{ resource_class.to_s } created successfully."
+        redirect_to (options[:redirect_to] || path_maker)
+      else
+        flash[:alert] = options[:alert] || resource.errors.full_messages.join(', ')
+        render action: :new
+      end
+    end
+
+    def edit
+    end
+
+    def show
+    end
+
+    def update(options = { notice: nil, alert: nil })
+      resource_name = self.class.instance_variable_get('@resource_name')
+      resource_class = self.class.instance_variable_get('@resource_class')
+      resource = instance_variable_get("@#{ resource_name }")
+      if resource.public_send(:update, permitted_params_for_update)
+        flash[:notice] = options[:notice] || "#{ resource_class.to_s } updated successfully."
+        redirect_to (options[:redirect_to] || path_maker)
+      else
+        flash[:alert] = options[:alert] || resource.errors.full_messages.join(', ')
+        render action: :edit
+      end
+    end
+
+    def destroy(options = { notice: nil, alert: nil })
+      resource_name = self.class.instance_variable_get('@resource_name')
+      resource_class = self.class.instance_variable_get('@resource_class')
+      resource = instance_variable_get("@#{ resource_name }")
+      if resource.public_send(:destroy)
+        flash[:notice] = options[:notice] || "#{ resource_class.to_s } destroyed successfully."
+      else
+        flash[:alert] = options[:alert] || resource.errors.full_messages.join(', ')
+      end
+      redirect_to (options[:redirect_to] || path_maker)
+    end
+
+  end
+end

data/lib/crud_actions/actions_helper.rb

@@ -0,0 +1,9 @@
+module CrudActions
+  module ActionsHelper
+
+    def index_helper(resource_name, options)
+      instance_variable_set("@#{ resource_name.pluralize }", self.class.instance_variable_get('@resource_class').includes(options[:includes]).order(options[:order]))
+    end
+
+  end
+end

data/lib/crud_actions/base_helper.rb

@@ -0,0 +1,9 @@
+module CrudActions
+  module BaseHelper
+
+    private
+      def path_maker
+        { action: :index, controller: controller_name }
+      end
+  end
+end

data/lib/crud_actions/version.rb

@@ -0,0 +1,3 @@
+module CrudActions
+  VERSION = "0.0.1"
+end

data/lib/crud_actions.rb

@@ -0,0 +1,4 @@
+require 'crud_actions/actions'
+
+module CrudActions
+end

data/test/crud_actions_test.rb

@@ -0,0 +1,144 @@
+require 'test_helper'
+
+class CrudActionsTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, CrudActions
+  end
+end
+
+class Category < ActiveRecord::Base
+end
+
+class CategoriesController < ActionController::Base
+  include CrudActions::Actions
+  has_inherited_actions :index, :new, :create, :show, :destroy, :update, :edit
+
+  def permitted_params_for_create
+    params.require(:category).permit!
+  end
+
+  def permitted_params_for_update
+    params.require(:category).permit!
+  end
+end
+
+
+class CategoriesControllerTest < ActionController::TestCase
+
+  def setup
+    @controller = CategoriesController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+
+  test 'controller should have an index action' do
+    get :index
+    assert_response :success
+  end
+
+  test 'an instance variable should be assigned inside index' do
+    get :index
+    assert assigns(:categories)
+  end
+
+  test 'index action should render index page' do
+    get :index
+    assert_template :index
+  end
+
+  test 'controller should have an edit action and render edit template' do
+    get :edit, {id: 2}
+    assert_template :edit
+  end
+
+  test 'controller should have an update action and renders edit page on erroneous submission' do
+    @controller.instance_variable_set('@category', Category.new({id: '1', text: 'Crud Actions'}))
+    @controller.instance_variable_get('@category').expects(:update).returns(false)
+    patch :update, ({id: 1, category: {text: 'New Crud Actions'}})
+    assert_template :edit
+    assert_match @controller.flash[:notice].to_s, ''
+  end
+
+  test 'controller should have update method and redirects on successful submission' do
+    @controller.instance_variable_set('@category', Category.new({id: '1', text: 'Crud Actions'}))
+    @controller.instance_variable_get('@category').expects(:update).returns(true)
+    patch :update, ({id: 1, category: {text: 'New Crud Actions'}})
+    assert_redirected_to categories_path
+    assert_match @controller.flash[:notice], 'Category updated successfully.'
+  end
+
+  test 'controller should have a new action and assigns an instance variable' do
+    get :new
+    assert_response :success
+    assert_equal 'New HTML', @response.body.strip
+    assert assigns(:category)
+  end
+
+  test 'controller should have a create action and redirects on successful submission' do
+    Category.any_instance.stubs(:save).returns(true)
+    put :create, category: {text: 'Crud Actions'}
+    assert assigns(:category)
+    assert_redirected_to categories_path
+    assert_match @controller.flash[:notice], 'Category created successfully.'
+  end
+
+  test 'controller should have a create action and renders new page on erroneous submission' do
+    Category.any_instance.stubs(:save).returns(false)
+    get :create, category: {text: 'Crud Actions'}
+    assert assigns(:category)
+    assert_response :success
+    assert_template :new
+  end
+
+  test 'controller should have a show action' do
+    get :show, {id: '2'}
+    assert_template :show
+  end
+
+  test 'controller should have a destroy action and shows flash[:notice] for successful submission' do
+    @controller.instance_variable_set('@category', Category.new({id: '1', text: 'Crud Actions'}))
+    @controller.instance_variable_get('@category').expects(:destroy).returns(true)
+    delete :destroy, {id: '2'}
+    assert_redirected_to categories_path
+    assert_match @controller.flash[:notice], 'Category destroyed successfully.'
+  end
+
+  test 'controller should have a destroy method and shows flash[:errors] for erroneous submission' do
+    @controller.instance_variable_set('@category', Category.new({id: '1', text: 'Crud Actions'}))
+    @controller.instance_variable_get('@category').expects(:destroy).returns(false)
+    delete :destroy, {id: '2'}
+    assert_redirected_to categories_path
+    assert_match @controller.flash[:notice].to_s, ''
+  end
+
+end
+
+class Product < ActiveRecord::Base
+end
+
+class ProductsController < ActionController::Base
+  include CrudActions::Actions
+  has_inherited_actions :index, :new, :create, :show, :destroy
+
+  def permitted_params_for_update
+    params.require(:category).permit!
+  end
+end
+
+class ProductsControllerTest < ActionController::TestCase
+  test 'controller should raise exception when action not defined' do
+    begin
+      patch :update, ({id: 1, product: {name: 'New Crud Actions'}})
+    rescue Exception => e
+      assert_match "The action 'update' could not be found for ProductsController", e.message
+    end
+  end
+
+  test 'should indicate absence of "permitted_params_for_create" for create action when not defined' do
+    begin
+      put :create
+    rescue Exception => e
+      assert_match /undefined local variable or method `permitted_params_for_create'/, e.message
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,52 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require 'minitest/autorun'
+require 'mocha/mini_test'
+require 'minitest/rg'
+require "active_support"
+require "active_record"
+require "action_controller"
+require 'crud_actions'
+
+# Filter out Minitest backtrace while allowing backtrace from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+#Establish connection to test instance creation for models
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :categories, :force => true do |t|
+    t.string :text
+  end
+
+  create_table :products, :force => true do |t|
+    t.string :name
+  end
+end
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+ActionController::Base.view_paths = File.join(File.dirname(__FILE__), 'views')
+
+#Create Routes to test assertions on routings
+
+CrudActions::Routes = ActionDispatch::Routing::RouteSet.new
+
+CrudActions::Routes.draw do
+  resources :categories
+  resources :products
+end
+
+ActionController::Base.send :include, CrudActions::Routes.url_helpers
+
+class ActionController::TestCase
+  setup do
+    @routes = CrudActions::Routes
+  end
+end

data/test/views/categories/edit.html.erb

@@ -0,0 +1 @@
+Edit HTML

data/test/views/categories/index.html.erb

@@ -0,0 +1 @@
+This is index page

data/test/views/categories/new.html.erb

@@ -0,0 +1 @@
+New HTML

data/test/views/categories/show.html.erb

@@ -0,0 +1 @@
+Show HTML

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: crud_actions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Amit Choudhary
+- Shruti Gupta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+description: A method named as has_inherited_actions is added which receives action
+  names as paremeters which need to be defined on controller.
+email:
+- amitchoudhary1008@gmail.com
+- inklingviashruti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/crud_actions.rb
+- lib/crud_actions/actions.rb
+- lib/crud_actions/actions_helper.rb
+- lib/crud_actions/base_helper.rb
+- lib/crud_actions/version.rb
+- test/crud_actions_test.rb
+- test/test_helper.rb
+- test/views/categories/edit.html.erb
+- test/views/categories/index.html.erb
+- test/views/categories/new.html.erb
+- test/views/categories/show.html.erb
+homepage: https://github.com/amit-vinsol/crud_actions
+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: CrudActions gem provides seven crud actions with basic definitions.
+test_files:
+- test/crud_actions_test.rb
+- test/test_helper.rb
+- test/views/categories/edit.html.erb
+- test/views/categories/index.html.erb
+- test/views/categories/new.html.erb
+- test/views/categories/show.html.erb