dynamic_controller 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in dynamic_controller.gemspec
+gemspec

data/README.md

@@ -0,0 +1,43 @@
+# DynamicController
+
+Simple way to add CRUD actions to Rails controllers.
+
+Suppoted formats HTML and JSON.
+
+Tested with Ruby 1.9.3 and Rails 3.2.8.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dynamic_controller'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dynamic_controller
+
+## Adding CRUD actions to resource controller
+
+    class UsersController < ApplicationController
+      has_crud_actions
+    end
+
+has_crud_actions adds index, show, new, edit, create, update and destroy actions to controller
+
+## Nested resources support
+
+    class ProfilesController < ApplicationController
+      has_crud_actions nested_of: User
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dynamic_controller.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dynamic_controller/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'dynamic_controller'
+  s.version     = DynamicController::VERSION
+  s.authors     = ['Gabriel Naiman']
+  s.email       = ['gabynaiman@gmail.com']
+  s.homepage    = 'https://github.com/gabynaiman/dynamic_controller'
+  s.summary     = 'Simple way to add CRUD actions to Rails controllers'
+  s.description = 'Simple way to add CRUD actions to Rails controllers'
+
+  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_dependency 'ransack'
+  s.add_dependency 'kaminari'
+
+  s.add_development_dependency 'rails'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'factory_girl_rails'
+end

data/lib/dynamic_controller.rb

@@ -0,0 +1,180 @@
+require 'dynamic_controller/version'
+require 'ransack'
+require 'kaminari'
+
+module DynamicController
+
+  module ClassMethods
+
+    attr_reader :dynamic_options
+
+    def has_crud_actions(options={})
+      send :include, CrudActions
+      before_filter :load_nested if options[:nested_of]
+      @dynamic_options = options
+    end
+
+  end
+
+  module CrudActions
+
+    def self.included(base)
+      base.helper_method [:resource_class, :controller_namespace]
+      base.respond_to :html, :json
+      base.rescue_from StandardError, with: :handle_error
+    end
+
+    def index
+      if parent_model
+        self.collection = parent_model.send(controller_name).search(params[:q]).result.page(params[:page])
+      else
+        self.collection = resource_class.search(params[:q]).result.page(params[:page])
+      end
+
+      respond_with collection
+    end
+
+    def show
+      if parent_model
+        self.model = parent_model.send(controller_name).find(params[:id])
+      else
+        self.model = resource_class.find(params[:id])
+      end
+
+      respond_with model
+    end
+
+    def new
+      if parent_model
+        self.model = parent_model.send(controller_name).build
+      else
+        self.model = resource_class.new
+      end
+    end
+
+    def edit
+      if parent_model
+        self.model = parent_model.send(controller_name).find(params[:id])
+      else
+        self.model = resource_class.find(params[:id])
+      end
+    end
+
+    def create
+      if parent_model
+        self.model = parent_model.send(controller_name).build(params[resource_class.model_name.underscore])
+      else
+        self.model = resource_class.new(params[resource_class.model_name.underscore])
+      end
+
+      if model.save
+        flash_message = "#{resource_class.model_name.human} successfully created"
+        if params[:save_and_new]
+          flash[:success] = flash_message
+          redirect_to action: :new
+        else
+          flash.now[:success] = flash_message
+          respond_to do |format|
+            format.html { redirect_to url_for([parent_model, model].compact) }
+            format.json { render json: model, status: :created }
+          end
+        end
+      else
+        respond_to do |format|
+          format.html { render :new }
+          format.json { render json: model.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    def update
+      if parent_model
+        self.model = parent_model.send(controller_name).find(params[:id])
+      else
+        self.model = resource_class.find(params[:id])
+      end
+
+      if model.update_attributes(params[resource_class.model_name.underscore])
+        flash.now[:success] = "#{resource_class.model_name.human} successfully updated"
+        respond_to do |format|
+          format.html { redirect_to url_for([parent_model, model].compact) }
+          format.json { head :no_content }
+        end
+      else
+        respond_to do |format|
+          format.html { render :edit }
+          format.json { render json: model.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    def destroy
+      if parent_model
+        self.model = parent_model.send(controller_name).find(params[:id])
+      else
+        self.model = resource_class.find(params[:id])
+      end
+
+      if model.destroy
+        flash[:warning] = "#{resource_class.model_name.human} successfully removed"
+        respond_to do |format|
+          format.html { redirect_to action: :index }
+          format.json { head :no_content }
+        end
+      else
+        flash[:danger] = "#{resource_class.model_name.human} could not be deleted"
+        respond_to do |format|
+          format.html { redirect_to action: :index }
+          format.json { render json: model.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    def resource_class
+      @resource_class ||= controller_name.classify.constantize
+    end
+
+    def controller_namespace
+      @controller_namespace ||= self.class.name.split('::')[0..-2].map(&:underscore).join('_') unless self.class.name.split('::')[0..-2].empty?
+    end
+
+    private
+
+    def collection=(value)
+      instance_variable_set("@#{controller_name}", value)
+    end
+
+    def collection
+      instance_variable_get("@#{controller_name}")
+    end
+
+    def model=(value)
+      instance_variable_set("@#{controller_name.singularize}", value)
+    end
+
+    def model
+      instance_variable_get("@#{controller_name.singularize}")
+    end
+
+    def load_nested
+      parent_klass = self.class.dynamic_options[:nested_of]
+      instance_variable_set("@#{parent_klass.to_s.underscore}", parent_klass.find(params["#{parent_klass.to_s.underscore}_id"]))
+    end
+
+    def parent_model
+      instance_variable_get("@#{self.class.dynamic_options[:nested_of].to_s.underscore}")
+    end
+
+    def handle_error(error)
+      respond_to do |format|
+        format.html { raise error }
+        format.json { render json: error.message, status: :internal_server_error }
+      end
+    end
+
+  end
+
+end
+
+ActionController::Base.send :extend, DynamicController::ClassMethods
+

data/lib/dynamic_controller/version.rb

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

data/spec/controllers/crud_actions_html_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe CountriesController, '-> HTML', type: :controller do
+
+  it 'Index -> GET /resources' do
+    3.times { create :country }
+
+    get :index
+
+    response.should be_success
+    response.content_type.should eq 'text/html'
+    response.should render_template :index
+    assigns(:countries).should eq Country.all
+  end
+
+  it 'Show -> GET /resources/:id' do
+    country = create :country
+
+    get :show, id: country.id
+
+    response.should be_success
+    response.content_type.should eq 'text/html'
+    response.should render_template :show
+    assigns(:country).should eq country
+  end
+
+  it 'New -> GET /resources/new' do
+    get :new
+
+    response.should be_success
+    response.content_type.should eq 'text/html'
+    response.should render_template :new
+    assigns(:country).should be_a Country
+    assigns(:country).should be_new_record
+  end
+
+  it 'Edit -> GET /resources/:id/edit' do
+    country = create :country
+
+    get :edit, id: country.id
+
+    response.should be_success
+    response.content_type.should eq 'text/html'
+    response.should render_template :edit
+    assigns(:country).should eq country
+  end
+
+  context 'Create -> POST /resources' do
+
+    it 'Successfully' do
+      attributes = attributes_for :country
+
+      post :create, country: attributes
+
+      response.should be_redirect
+      response.content_type.should eq 'text/html'
+      response.should redirect_to assigns(:country)
+      assigns(:country).id.should_not be_nil
+      assigns(:country).name.should eq attributes[:name]
+    end
+
+    it 'With errors' do
+      post :create
+
+      response.should be_success
+      response.content_type.should eq 'text/html'
+      response.should render_template :new
+      assigns(:country).should have(1).errors_on(:name)
+    end
+
+  end
+
+  context 'Update -> PUT /resources/:id' do
+
+    it 'Successfully' do
+      country = create :country
+      attributes = {name: "#{country.name} updated"}
+
+      put :update, id: country.id, country: attributes
+
+      response.should be_redirect
+      response.content_type.should eq 'text/html'
+      response.should redirect_to country
+      assigns(:country).name.should eq attributes[:name]
+    end
+
+    it 'With errors' do
+      country = create :country
+
+      put :update, id: country.id, country: {name: nil}
+
+      response.should be_success
+      response.content_type.should eq 'text/html'
+      response.should render_template :edit
+      assigns(:country).should have(1).errors_on(:name)
+    end
+
+  end
+
+  it 'Destroy -> DELETE /resources/:id' do
+    country = create :country
+
+    delete :destroy, id: country.id
+
+    response.should be_redirect
+    response.content_type.should eq 'text/html'
+    response.should redirect_to countries_path
+
+    Country.find_by_id(country.id).should be_nil
+  end
+
+end

data/spec/controllers/crud_actions_json_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe CountriesController, '-> JSON', type: :controller do
+
+  it 'Index -> GET /resources.json' do
+    3.times { create :country }
+
+    get :index, format: :json
+
+    response.status.should be 200 # OK
+    response.content_type.should eq 'application/json'
+    JSON.parse(response.body).each do |attributes|
+      attributes['name'].should eq Country.find(attributes['id']).name
+    end
+  end
+
+  it 'Show -> GET /resources/:id.json' do
+    country = create :country
+
+    get :show, format: :json, id: country.id
+
+    response.status.should be 200 # OK
+    response.content_type.should eq 'application/json'
+    attributes = JSON.parse(response.body)
+    attributes['id'].should eq country.id
+    attributes['name'].should eq country.name
+  end
+
+  context 'Create -> POST /resources.json' do
+
+    it 'Successfully' do
+      attributes = attributes_for :country
+
+      post :create, format: :json, country: attributes
+
+      response.status.should be 201 # Created
+      response.content_type.should eq 'application/json'
+      country = JSON.parse(response.body)
+      country['id'].should_not be_nil
+      country['name'].should eq attributes[:name]
+
+      Country.find_by_id(country['id']).should_not be_nil
+    end
+
+    it 'With errors' do
+      post :create, format: :json
+
+      response.status.should eq 422 # Unprocessable Entity
+      response.content_type.should eq 'application/json'
+      JSON.parse(response.body).should have_key 'name'
+    end
+
+  end
+
+  context 'Update -> PUT /resources/:id.json' do
+
+    it 'Successfully' do
+      country = create :country
+      attributes = {name: "#{country.name} updated"}
+
+      put :update, format: :json, id: country.id, country: attributes
+
+      response.status.should eq 204 # No Content
+      response.content_type.should eq 'application/json'
+
+      Country.find(country.id).name.should eq attributes[:name]
+    end
+
+    it 'With errors' do
+      country = create :country
+
+      put :update, format: :json, id: country.id, country: {name: nil}
+
+      response.status.should eq 422 # Unprocessable Entity
+      response.content_type.should eq 'application/json'
+      JSON.parse(response.body).should have_key 'name'
+    end
+
+  end
+
+  it 'Destroy -> DELETE /resources/:id.json' do
+    country = create :country
+
+    delete :destroy, format: :json, id: country.id
+
+    response.status.should eq 204 # No Content
+    response.content_type.should eq 'application/json'
+
+    Country.find_by_id(country.id).should be_nil
+  end
+
+end