crudify 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+.DS_Store
+pkg/*
+*.gem
+test/db/*.sqlite3

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,94 @@
+PATH
+  remote: .
+  specs:
+    crudify (0.0.1)
+      meta_search (>= 1.0.1)
+      rails (>= 3.0.0)
+      will_paginate (>= 3.0.pre2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.7)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mail (2.2.14)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    meta_search (1.0.1)
+      actionpack (~> 3.0.2)
+      activerecord (~> 3.0.2)
+      activesupport (~> 3.0.2)
+      arel (~> 2.0.2)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    shoulda (2.11.3)
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  crudify!
+  meta_search (>= 1.0.1)
+  rails (>= 3.0.0)
+  shoulda (>= 2.11.3)
+  sqlite3-ruby (>= 1.3.3)
+  will_paginate (>= 3.0.pre2)

data/README.md

@@ -0,0 +1,17 @@
+Crudify
+-------
+
+A dynamic resource controller for Rails 3.
+
+
+Usage
+-----
+
+    coming soon!
+
+
+
+License
+-------
+
+Copyright (c) 2011 Spencer Steffen, released under the New BSD License All rights reserved.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.verbose = true
+end
+
+
+desc "Default Task"
+task :default => [ :test ]
+

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  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/crudify.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "crudify/version"
+
+Gem::Specification.new do |s|
+  s.name        = "crudify"
+  s.version     = Crudify::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Spencer Steffen"]
+  s.email       = ["spencer@citrusme.com"]
+  s.homepage    = "http://github.com/citrus/crudify"
+  
+  s.summary     = %q{Crudify is a dynamic resource controller for Rails 3.}
+  s.description = %q{Crudify is a dynamic resource controller for Rails 3. The goal is to have very skinny controllers with powerful hooks to easily customize.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency('rails',         '>= 3.0.0')
+  # s.add_dependency('will_paginate', '>= ')
+  s.add_dependency('meta_search',   '>= 1.0.1')
+  
+	s.add_development_dependency('shoulda', '>= 2.11.3')
+	s.add_development_dependency('sqlite3-ruby', '>= 1.3.3')
+end

data/lib/crudify.rb

@@ -0,0 +1,12 @@
+require 'active_support'
+require 'active_record'
+require 'action_controller'
+
+require 'crudify/hook_methods'
+require 'crudify/class_methods'
+require 'crudify/base'
+
+module Crudify  
+end
+
+ActionController::Base.send(:include, Crudify::Base)

data/lib/crudify/base.rb

@@ -0,0 +1,42 @@
+# 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.
+# Full documentation about CRUD and resources go here:
+# -> http://caboo.se/doc/classes/ActionController/Resources.html#M003716
+# Example (add to your controller):
+# crudify :foo, {:title_attribute => 'name'}
+
+
+module Crudify
+
+  module Base
+  
+    def self.default_options(model_name)
+      singular_name = model_name.to_s
+      class_name = singular_name.camelize
+      plural_name = singular_name.pluralize
+      this_class = class_name.constantize
+      {
+        :title_attribute => "title",
+        :order => ('position ASC' if this_class.table_exists? and this_class.column_names.include?('position')),
+        :conditions => '',
+        :sortable => true,
+        :searchable => true,
+        :include => [],
+        :paging => true,
+        :search_conditions => '',
+        :redirect_to_url => "admin_#{plural_name}_url"
+      }
+    end
+  
+    def self.append_features(base)
+      super
+      base.send(:include, Crudify::HookMethods)
+      base.extend(Crudify::ClassMethods)
+    end
+  
+  end
+
+end

data/lib/crudify/class_methods.rb

@@ -0,0 +1,242 @@
+module Crudify  
+
+  module ClassMethods
+    
+     def crudify(model_name, options = {})
+       options = ::Crudify::Base.default_options(model_name).merge(options)
+       
+       singular_name = model_name.to_s
+       class_name = singular_name.camelize
+       plural_name = singular_name.pluralize
+       
+       options[:paging] = (options[:paging] && eval(class_name).respond_to?(:paginate))
+  
+       module_eval %(
+       
+         # (Just a comment!)
+         
+         prepend_before_filter :find_#{singular_name},
+                               :only => [:update, :destroy, :edit, :show]
+         
+         prepend_before_filter :set_crud_options                        
+                               
+         def set_crud_options
+           @crud_options = #{options}
+         end
+                               
+  
+         def new
+           @#{singular_name} = #{class_name}.new
+         end
+  
+  
+         def create
+           # if the position field exists, set this object as last object, given the conditions of this class.
+           if #{class_name}.column_names.include?("position")
+             params[:#{singular_name}].merge!({
+               :position => ((#{class_name}.maximum(:position, :conditions => #{options[:conditions].inspect})||-1) + 1)
+             })
+           end
+           @instance = @#{singular_name} = #{class_name}.create(params[:#{singular_name}])
+           before_create
+           if @instance.valid? && @instance.save  
+             successful_create
+           else
+             failed_create
+           end
+         end
+  
+         def edit
+           # object gets found by find_#{singular_name} function
+         end
+  
+         def update
+           before_update
+           if @#{singular_name}.update_attributes(params[:#{singular_name}])
+             successful_update              
+           else
+             failed_update
+           end
+         end
+  
+         def destroy
+           before_destroy
+           # object gets found by find_#{singular_name} function
+           title = @#{singular_name}.#{options[:title_attribute]}
+           if @#{singular_name}.destroy
+             successful_destroy
+           else
+             failed_destroy
+           end
+         end
+  
+  
+  
+  
+         def set_instance(record)
+           @instance = @#{singular_name} = record
+         end
+         
+         def set_collection(scope, with_options=true)
+           @collection = @#{plural_name} = with_options ? scope_with_options(scope) : scope
+         end
+  
+         def scope_with_options(scope)
+           scope.includes(
+             #{options[:include].map(&:to_sym).inspect}
+           ).order("#{options[:order]}")
+         end
+         
+         
+         
+  
+         # Finds one single result based on the id params.
+         def find_#{singular_name}
+           set_instance(#{class_name}.find(params[:id],
+             :include => #{options[:include].map(&:to_sym).inspect}))
+         end
+         
+         
+         # Find the collection of @#{plural_name} based on the conditions specified into crudify
+         # It will be ordered based on the conditions specified into crudify
+         # And eager loading is applied as specified into crudify.
+         def find_all_#{plural_name}(conditions = #{options[:conditions].inspect})
+           set_collection(#{class_name}.where(conditions))
+         end
+                 
+  
+         # Paginate a set of @#{plural_name} that may/may not already exist.
+         def paginate_all_#{plural_name}
+           # If we have already found a set then we don't need to again
+           find_all_#{plural_name} if @#{plural_name}.nil?
+  
+           paging_options = {:page => params[:page]}
+  
+           # Seems will_paginate doesn't always use the implicit method.
+           if #{class_name}.methods.map(&:to_sym).include?(:per_page)
+             paging_options.update({:per_page => #{class_name}.per_page})
+           end
+  
+           set_collection(@#{plural_name}.paginate(paging_options), false)
+         end
+  
+         # Returns results based on the query specified by the user.
+         def search_all_#{plural_name}
+           @search ||= find_all_#{plural_name}.search(params[:search])
+           set_collection(@search, false)
+         end
+  
+  
+         # Ensure all methods are protected so that they should only be called
+         # from within the current controller.
+         protected :find_#{singular_name},
+                   :find_all_#{plural_name},
+                   :paginate_all_#{plural_name},
+                   :search_all_#{plural_name}
+       )
+  
+       # Methods that are only included when this controller is searchable.
+       if options[:searchable]
+         if options[:paging]
+           module_eval %(
+             def index
+               search_all_#{plural_name} if searching?
+               paginate_all_#{plural_name}
+             end
+           )
+         else
+           module_eval %(
+             def index
+               unless searching?
+                 find_all_#{plural_name}
+               else
+                 search_all_#{plural_name}
+               end
+             end
+           )
+         end
+       else
+         if options[:paging]
+           module_eval %(
+             def index
+               paginate_all_#{plural_name}
+             end
+           )
+         else
+           module_eval %(
+             def index
+               find_all_#{plural_name}
+             end
+           )
+         end
+  
+       end
+  
+       if options[:sortable]
+         module_eval %(
+           def reorder
+             find_all_#{plural_name}
+           end
+  
+           # Based upon http://github.com/matenia/jQuery-Awesome-Nested-Set-Drag-and-Drop
+           def update_positions
+             previous = nil
+             # The list doesn't come to us in the correct order. Frustration.
+             0.upto((newlist ||= params[:ul]).length - 1) do |index|
+               hash = newlist[index.to_s]
+               moved_item_id = hash['id'].split(/#{singular_name}\\_?/)
+               @current_#{singular_name} = #{class_name}.find_by_id(moved_item_id)
+  
+               if @current_#{singular_name}.respond_to?(:move_to_root)
+                 if previous.present?
+                   @current_#{singular_name}.move_to_right_of(#{class_name}.find_by_id(previous))
+                 else
+                   @current_#{singular_name}.move_to_root
+                 end
+               else
+                 @current_#{singular_name}.update_attribute(:position, index)
+               end
+  
+               if hash['children'].present?
+                 update_child_positions(hash, @current_#{singular_name})
+               end
+  
+               previous = moved_item_id
+             end
+  
+             #{class_name}.rebuild! if #{class_name}.respond_to?(:rebuild!)
+             render :nothing => true
+           end
+  
+           def update_child_positions(node, #{singular_name})
+             0.upto(node['children'].length - 1) do |child_index|
+               child = node['children'][child_index.to_s]
+               child_id = child['id'].split(/#{singular_name}\_?/)
+               child_#{singular_name} = #{class_name}.find_by_id(child_id)
+               child_#{singular_name}.move_to_child_of(#{singular_name})
+  
+               if child['children'].present?
+                 update_child_positions(child, child_#{singular_name})
+               end
+             end
+           end
+  
+         )
+       end
+  
+       module_eval %(
+         def self.sortable?
+           #{options[:sortable].to_s}
+         end
+  
+         def self.searchable?
+           #{options[:searchable].to_s}
+         end
+       )
+  
+  
+     end
+  
+   end
+
+end

data/lib/crudify/hook_methods.rb

@@ -0,0 +1,120 @@
+module Crudify
+
+  module HookMethods
+    
+    private
+      
+      def before_create
+        # just a hook!
+        puts "> Crud::before_create"
+        before_action
+      end    
+        
+      def before_update
+        # just a hook!
+        puts "> Crud::before_update"
+        before_action
+      end    
+        
+      def before_destroy
+        # just a hook!
+        puts "> Crud::before_destroy"
+        before_action
+      end
+      
+      
+      def before_action
+        # just a hook!
+        puts "> Crud::before_action"
+        @what = @instance.send(@crud_options[:title_attribute].to_sym).inspect
+        true
+      end
+      
+              
+      
+      def successful_create
+        puts "> Crud::successful_create"
+        
+        flash[:notice] = t('crudify.created', :what => @what)
+        
+        after_success
+      end
+      
+      def successful_update
+        puts "> Crud::successful_update"
+        
+        flash[:notice] = t('crudify.updated', :what => @what)
+        
+        after_success
+      end
+      
+      def successful_destroy
+        puts "> Crud::successful_destroy"
+        
+        flash.notice = t('crudify.destroyed', :what => @what)
+        
+        after_success
+      end
+      
+      def after_success
+        puts "> Crud::after_success"
+        
+        unless request.xhr?
+          if params[:commit].match(/continue/)
+            if params[:action] == 'create'
+              redirect_to request.referer.sub('new', "#{what.to_param}/edit")
+            else
+              redirect_to request.referer
+            end            
+          else
+            redirect_back_or_default eval(@crud_options[:redirect_to_url])
+          end
+        else
+          render :partial => "/shared/message"
+        end
+        
+      end
+      
+      
+      
+      
+      def failed_create
+        puts "> Crud::failed_create"
+        
+        flash[:error] = t('crudify.failed_create', :what => @what)
+        
+        after_fail
+      end
+      
+      def failed_update
+        puts "> Crud::failed_update"
+        
+        flash[:error] = t('crudify.failed_update', :what => @what)
+        
+        after_fail
+      end
+      
+      def failed_destroy
+        puts "> Crud::failed_destroy"
+        
+        flash[:error] = t('crudify.failed_destroy', :what => @what)
+        
+        after_fail
+      end
+    
+    
+      def after_fail
+        puts "> Crud::after_fail"
+        
+        unless request.xhr?
+          render :action => request.post? ? 'new' : 'edit'
+        else          
+          flash[:error] = [flash[:error], what.errors.collect{|key,value| "#{key} #{value}"}.join("<br/>")]
+          render :partial => "/shared/message"
+        end
+      end
+      
+  
+    end
+
+end

data/lib/crudify/version.rb

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

data/test/helper.rb

@@ -0,0 +1,40 @@
+begin
+  require 'rubygems'
+  require 'bundler/setup'
+	require 'rails/all'
+  require 'shoulda'
+	require 'crudify'
+  require 'will_paginate'
+	#require 'sqlite3'
+rescue LoadError => e
+	puts "Load error!"
+	puts e.inspect
+	exit
+end
+
+
+class Jelly < ActiveRecord::Base
+  cattr_reader :per_page
+  @@per_page = 2
+end
+
+db = File.expand_path('../db/test.sqlite3', __FILE__)
+`rm #{db}` if File.exists?(db)
+
+config = { 'adapter' => 'sqlite3', 'database' => 'test/db/test.sqlite3' }
+sql = 'CREATE TABLE "jellies" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "name" varchar(255), "created_at" datetime, "updated_at" datetime)'
+ActiveRecord::Base.establish_connection(config)
+ActiveRecord::Base.connection.execute(sql)
+
+
+["blackberry", "blueberry", "strawberry"].each do |jelly|
+  Jelly.create(:title => "#{jelly.capitalize} Jelly", :name => jelly)
+end
+
+
+class CrudifyTestController < ActionController::Base
+    
+  crudify :jelly
+  
+end
+

data/test/test_controller.rb

@@ -0,0 +1,57 @@
+require_relative 'helper'
+
+
+def assert_has_method?(methods, name)
+  
+end
+
+	
+class TestController < Test::Unit::TestCase
+
+  def setup
+    @controller = CrudifyTestController.new 
+    @controller.params = {}
+  end
+  
+  should "have crud methods" do
+    [
+      :find_jelly,
+      :find_all_jellies,
+      :paginate_all_jellies,
+      :search_all_jellies
+    ].each do |method|
+      assert @controller.methods.include?(method), "Should have #{method}"
+    end
+    
+  end
+  
+  should "have private hook methods" do
+    [
+      :before_create,
+      :before_update,
+      :successful_create,
+      :successful_update,
+      :successful_destroy,
+      :after_success,
+      :failed_create,
+      :failed_update,
+      :failed_destroy,
+      :after_fail
+    ].each do |method|
+      assert @controller.private_methods.include?(method), "Should have #{method}"
+    end
+  end
+  
+  should "get collection" do
+    jellies = @controller.send(:find_all_jellies)
+    assert_equal 3, jellies.length
+  end
+  
+  #should "paginate collection" do
+  #  jellies = @controller.send(:paginate_all_jellies)
+  #  assert_equal 2, jellies.total_pages
+  #  assert_equal 3, jellies.total_entries
+  #end
+  
+  
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: crudify
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Spencer Steffen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-25 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: meta_search
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 11
+        - 3
+        version: 2.11.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  type: :development
+  version_requirements: *id004
+description: Crudify is a dynamic resource controller for Rails 3. The goal is to have very skinny controllers with powerful hooks to easily customize.
+email: 
+- spencer@citrusme.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- config/locales/en.yml
+- crudify.gemspec
+- lib/crudify.rb
+- lib/crudify/base.rb
+- lib/crudify/class_methods.rb
+- lib/crudify/hook_methods.rb
+- lib/crudify/version.rb
+- log/development.log
+- test/helper.rb
+- test/test_controller.rb
+has_rdoc: true
+homepage: http://github.com/citrus/crudify
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Crudify is a dynamic resource controller for Rails 3.
+test_files: 
+- test/helper.rb
+- test/test_controller.rb