ao_crudify 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle
+.DS_Store
+*.gem
+Gemfile.lock
+pkg/*
+spec/dummy-2-3-12/log
+test/dummy-2-3-12/db/*.tct

data/Gemfile

@@ -0,0 +1,8 @@
+#source "http://rubygems.org"
+source "http://ruby.taobao.org"
+gemspec
+gem 'rails', '~> 2.3.12'
+gem 'activeobject', '~> 0.3.4'
+gem 'generic_connection_pool'
+gem 'rufus-tokyo'
+gem 'spork'

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2005-2010 [kame]
+
+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,93 @@
+AoCrudify
+=======
+
+A dynamic resource controller for Rails > 2.3 and ActiveObject ORM that keeps your controllers nice and skinny.
+
+AoCrudify was inspired from Crudify.
+
+
+Installation
+------------
+
+It's best to install crudify by adding your Rails project's Gemfile:
+
+    # Gemfile
+    source "http://rubygems.org"
+    gem 'crudify', '>= 0.1.0'
+
+Now run:
+
+    bundle install
+
+
+Usage
+-----
+
+In its most basic form, crudify is designed to be use like this:
+
+    class JelliesController < ApplicationController
+      crudify :jelly
+    end
+
+
+Say you want to customize an action that's being defined by crudify, simply overwrite it!
+
+    class JelliesController < ApplicationController
+      crudify :jelly
+
+      def create
+        @jelly = Jelly.new(params[:jelly])
+        # ... the rest of your custom action
+      end
+    end
+
+
+Ok that seems easy enough, but what if my action is just a tiny bit different? That's where the _hook methods_ come in...
+
+### Hook Methods
+
+    `before_create`
+    `before_update`
+    `before_destroy`
+    `before_action`
+
+    `successful_create`
+    `successful_update`
+    `successful_destroy`
+    `after_success`
+
+    `failed_create`
+    `failed_update`
+    `failed_destroy`
+    `after_fail`
+
+You can define hook_methods in your controller just like this:
+
+    def before_create
+      do_something
+      supre
+    end
+
+Notice: that `before_create` calls a second hook; `before_action`. This is a generic hook that fires before every crud method's call to `save`, `update` or `destroy`. This means it might be helpful for you to call `super` when overwriting this method so that the chain of hooks keeps firing.
+
+Notice: if hook_methods return false, the action will return. Because in action it call hook_methods just like this:
+
+    def create
+      ...
+      return if before_create === false
+      ...
+    end
+
+Here's an example of a `before_create` hook:
+
+    class PostsController < ApplicationController
+      crudify :post
+
+      def before_create
+        @post.author == current_user
+        super
+      end
+
+    end
+
+### MIT License

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+require 'spec/rake/spectask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the ao_locked gem.'
+Spec::Rake::SpecTask.new(:test) do |t|
+	t.spec_files = FileList['spec/**/*_spec.rb']
+	t.spec_opts = ['-c','-f','nested']
+end

data/ao_crudify.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ao_crudify/version"
+
+Gem::Specification.new do |s|
+
+  s.name        = "ao_crudify"
+  s.version     = AoCrudify::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["kame"]
+  s.email       = ["kamechb@gmail.com"]
+  s.homepage    = "http://github.com/kamechb/ao_crudify"
+
+  s.summary     = %q{A dynamic resource controller for Rails > 2.3 and ActiveObject ORM that keeps your controllers nice and skinny.}
+  s.description = %q{A dynamic resource controller for Rails > 2.3 and ActiveObject ORM that keeps your controllers nice and skinny.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency('rails', '>= 2.3.12')
+  s.add_dependency('activeobject', '>= 0.3.4')
+  s.add_dependency('rspec', '~> 1.3.0')
+  s.add_dependency('rspec-rails', '~> 1.3.2')
+
+end

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  ao_crudify:
+    created: "%{what} was successfully created."
+    updated: "%{what} was successfully updated."
+    destroyed: "%{what} was successfully removed."
+    failed_create: "%{what} could not be created."
+    failed_update: "%{what} could not be updated."
+    failed_destroy: "%{what} could not be removed."

data/config/locales/zh-cn.yml

@@ -0,0 +1,8 @@
+zh-cn:
+  ao_crudify:
+    created: "%{what} 创建成功."
+    updated: "%{what} 更新成功."
+    destroyed: "%{what} 删除成功."
+    failed_create: "%{what} 创建失败."
+    failed_update: "%{what} 更新失败."
+    failed_destroy: "%{what} 删除失败."

data/lib/ao_crudify.rb

@@ -0,0 +1,20 @@
+require 'active_support'
+require 'action_controller'
+
+module AoCrudify
+
+  if Rails.version > '3'
+    class Engine < Rails::Engine
+    end
+  end
+
+  autoload :HookMethods, 'ao_crudify/hook_methods'
+  autoload :ClassMethods, 'ao_crudify/class_methods'
+  autoload :Base, 'ao_crudify/base'
+
+end
+
+I18n.load_path << File.expand_path('../../config/locales/en.yml', __FILE__)
+I18n.load_path << File.expand_path('../../config/locales/zh-cn.yml', __FILE__)
+
+ActionController::Base.send(:include, AoCrudify::Base)

data/lib/ao_crudify/base.rb

@@ -0,0 +1,43 @@
+# Base methods for CRUD actions
+# Simply override any methods in your action controller you want to be customised
+# Don't forget to add:
+#   resources :plural_model_name_here
+# to your routes.rb file.
+# Example (add to your controller):
+# crudify :foo, { :title_attribute => 'name' }
+
+
+module AoCrudify
+  module ResponseCode
+    SUCCESS = 1
+    ERROR   = 0
+  end
+
+  module Base
+    def self.default_options(model_name)
+      singular_name = model_name.to_s
+      plural_name = singular_name.pluralize
+      class_name = singular_name.camelize
+      {
+        :title_attribute => singular_name,
+        :singular_name => singular_name,
+        :plural_name => plural_name,
+        :class_name => class_name,
+        :paginate => true,
+        :order_by => :created_at,
+        :direction => :numdesc,
+        :conditions => {},
+        :redirect_to_url => "admin_#{plural_name}_path",
+        :log => Rails.env == 'development'
+      }
+    end
+
+    def self.append_features(base)
+      super
+      base.send(:include, AoCrudify::HookMethods)
+      base.extend(AoCrudify::ClassMethods)
+    end
+
+  end
+
+end

data/lib/ao_crudify/class_methods.rb

@@ -0,0 +1,137 @@
+#
+# Disclaimer:
+#
+# The majority of this was originally written by
+# the splendid fellows at Resolve Digital for their
+# awesome refinerycms project.
+#
+
+module AoCrudify
+
+  module ClassMethods
+
+    def crudify(model_name, options = {})
+
+      options = ::AoCrudify::Base.default_options(model_name).merge(options)
+
+      singular_name = options[:singular_name]
+      plural_name   = options[:plural_name]
+      class_name    = options[:class_name]
+      klass         = class_name.constantize
+
+      options[:paginate] = options[:paginate] && klass.respond_to?(:paginate)
+
+      module_eval %(
+
+        # (Just a comment!)
+
+        before_filter :find_#{singular_name},
+                      :only => [:update, :destroy, :edit, :show]
+
+        before_filter :set_crud_options
+
+        def set_crud_options
+          @crud_options ||= #{options.inspect}
+        end
+
+        def what
+          @what ||= '#{options[:title_attribute]}'
+        end
+
+        def index
+        end
+
+        def show
+        end
+
+        def new
+          @#{singular_name} = #{class_name}.new
+        end
+
+
+        def create
+          @instance = @#{singular_name} = #{class_name}.new(params[:#{singular_name}])
+          return if before_create === false
+          if @instance.save
+            successful_create
+          else
+            failed_create
+          end
+        end
+
+        def edit
+
+        end
+
+        def update
+          return if before_update === false
+          if @#{singular_name}.update_attributes(params[:#{singular_name}])
+            successful_update
+          else
+            failed_update
+          end
+        end
+
+        def destroy
+          return if before_destroy === false
+          if @#{singular_name}.destroy
+            successful_destroy
+          else
+            failed_destroy
+          end
+        end
+
+        # Finds one single result based on the id params.
+        def find_#{singular_name}
+          set_instance(#{class_name}.find(params[:id]))
+        end
+
+        def paginate_all_#{plural_name}
+          set_collection(#{class_name}.paginate paginate_options.merge(conditions))
+        end
+
+        def find_all_#{plural_name}
+          set_collection(#{class_name}.all conditions)
+        end
+
+        def paginate_options
+          @paginate_options ||= {
+            :page => params[:page],
+            :per_page => params[:per_page],
+            :order_by => :#{options[:order_by]},
+            :direction => :#{options[:direction]}
+          }
+        end
+
+        def conditions
+          @conditions ||= @crud_options[:conditions]
+        end
+
+        def set_instance(record)
+          @instance = @#{singular_name} = record
+        end
+
+        def set_collection(records)
+          @collection = @#{plural_name} = records
+        end
+
+      )
+
+
+      if options[:paginate]
+        module_eval %(
+          def index
+            paginate_all_#{plural_name}
+          end
+        )
+      else
+        module_eval %(
+          def index
+            find_all_#{plural_name}
+          end
+        )
+      end
+    end
+
+  end
+end

data/lib/ao_crudify/hook_methods.rb

@@ -0,0 +1,117 @@
+module AoCrudify
+
+  module HookMethods
+
+    private
+
+      def before_create
+        # just a hook!
+        puts "> Crud::before_create" if @crud_options[:log]
+        before_action
+      end
+
+      def before_update
+        # just a hook!
+        puts "> Crud::before_update" if @crud_options[:log]
+        before_action
+      end
+
+      def before_destroy
+        # just a hook!
+        puts "> Crud::before_destroy" if @crud_options[:log]
+        before_action
+      end
+
+      def before_action
+        # just a hook!
+        puts "> Crud::before_action" if @crud_options[:log]
+        true
+      end
+
+
+      def successful_create
+        puts "> Crud::successful_create" if @crud_options[:log]
+
+        flash[:notice] = t('ao_crudify.created', :what => what)
+
+        after_success
+      end
+
+      def successful_update
+        puts "> Crud::successful_update" if @crud_options[:log]
+
+        flash[:notice] = t('ao_crudify.updated', :what => what)
+
+        after_success
+      end
+
+      def successful_destroy
+        puts "> Crud::successful_destroy" if @crud_options[:log]
+        flash[:notice] = t('ao_crudify.destroyed', :what => what)
+
+        after_success
+      end
+
+      def after_success
+        puts "> Crud::after_success" if @crud_options[:log]
+        respond_to do |f|
+          f.html {
+            if request.xhr?
+              render @ajax_render_options and return if @ajax_render_options
+              render :layout => false
+            else
+              redirect_to params[:redirect] and return if params[:redirect] && whitelist_redirect(params[:redirect])
+              redirect_to @redirect_to_url and return if @redirect_to_url
+              redirect_to @crud_options[:redirect_to_url] and return if @crud_options[:redirect_to_url]
+              render
+            end
+          }
+          f.json { render :json => {:code => ResponseCode::SUCCESS} }
+        end
+      end
+
+
+
+
+      def failed_create
+        puts "> Crud::failed_create" if @crud_options[:log]
+        flash[:error] = t('ao_crudify.failed_create', :what => what)
+        after_fail
+      end
+
+      def failed_update
+        puts "> Crud::failed_update" if @crud_options[:log]
+        flash[:error] = t('ao_crudify.failed_update', :what => what)
+        after_fail
+      end
+
+      def failed_destroy
+        puts "> Crud::failed_destroy" if @crud_options[:log]
+        flash[:error] = t('ao_crudify.failed_destroy', :what => what)
+        after_fail
+      end
+
+      def after_fail
+        puts "> Crud::after_fail" if @crud_options[:log]
+        respond_to do |f|
+          f.html {
+            if request.xhr?
+              render :text => 'error'
+            else
+              render :text => 'error' and return if request.delete?
+              render :action => :new and return if request.post?
+              render :action => :edit
+            end
+          }
+          f.json { render :json => {:code => ResponseCode::ERROR} }
+        end
+      end
+
+      # 对redirect url进行白名单过滤，防止跳转到attack的网站, default true.
+      def whitelist_redirect(url)
+        true
+      end
+
+    end
+
+end