crudify 0.0.3 → 0.0.4

data/.gitignore

@@ -1,5 +1,7 @@
 .bundle
 .DS_Store
-pkg/*
 *.gem
-test/db/*.sqlite3
+pkg/*
+test/dummy/log
+test/dummy/tmp
+test/dummy/db/*.sqlite3

data/Gemfile.lock

@@ -1,45 +1,62 @@
 PATH
   remote: .
   specs:
-    crudify (0.0.1)
+    crudify (0.1.0.beta)
       meta_search (>= 1.0.1)
       rails (>= 3.0.0)
+      will_paginate (>= 2.3.15)
 
 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)
+    actionmailer (3.0.5)
+      actionpack (= 3.0.5)
+      mail (~> 2.2.15)
+    actionpack (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
       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)
+      rack-test (~> 0.5.7)
       tzinfo (~> 0.3.23)
-    activemodel (3.0.3)
-      activesupport (= 3.0.3)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
       builder (~> 2.1.2)
       i18n (~> 0.4)
-    activerecord (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
       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)
+    activeresource (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+    activesupport (3.0.5)
+    arel (2.0.9)
     builder (2.1.2)
+    capybara (0.4.1.2)
+      celerity (>= 0.7.9)
+      culerity (>= 0.2.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (>= 0.0.27)
+      xpath (~> 0.1.3)
+    celerity (0.8.8)
+    childprocess (0.1.7)
+      ffi (~> 0.6.3)
+    culerity (0.2.15)
     erubis (2.6.6)
       abstract (>= 1.0.0)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
     i18n (0.5.0)
+    json_pure (1.5.1)
     mail (2.2.15)
       activesupport (>= 2.3.6)
       i18n (>= 0.4.0)
@@ -51,26 +68,33 @@ GEM
       activesupport (~> 3.0.2)
       arel (~> 2.0.2)
     mime-types (1.16)
+    nokogiri (1.4.4)
     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)
+    rails (3.0.5)
+      actionmailer (= 3.0.5)
+      actionpack (= 3.0.5)
+      activerecord (= 3.0.5)
+      activeresource (= 3.0.5)
+      activesupport (= 3.0.5)
       bundler (~> 1.0)
-      railties (= 3.0.3)
-    railties (3.0.3)
-      actionpack (= 3.0.3)
-      activesupport (= 3.0.3)
+      railties (= 3.0.5)
+    railties (3.0.5)
+      actionpack (= 3.0.5)
+      activesupport (= 3.0.5)
       rake (>= 0.8.7)
       thor (~> 0.14.4)
     rake (0.8.7)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.1.3)
+      childprocess (~> 0.1.5)
+      ffi (~> 0.6.3)
+      json_pure
+      rubyzip
     shoulda (2.11.3)
     sqlite3 (1.3.3)
     sqlite3-ruby (1.3.3)
@@ -79,11 +103,16 @@ GEM
     treetop (1.4.9)
       polyglot (>= 0.3.1)
     tzinfo (0.3.24)
+    will_paginate (2.3.15)
+    xpath (0.1.3)
+      nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  capybara (>= 0.4.1)
   crudify!
+  selenium-webdriver (>= 0.1.3)
   shoulda (>= 2.11.3)
   sqlite3-ruby (>= 1.3.3)

data/README.md

@@ -1,14 +1,132 @@
 Crudify
--------
+=======
+
+A dynamic resource controller for Rails 3 that keeps your controllers nice and skinny.
 
-A dynamic resource controller for Rails 3.
+Crudify was shamlessly robbed from [refinerycms](https://github.com/resolve/refinerycms/blob/master/core/lib/refinery/crud.rb)'s internals and customized for use in other projects. Much credit and many thanks to the guys at [resolve digital](http://resolvedigital.com/) for all their hard work on the [refinery cms project](http://resolvedigital.com/development/refinery%C2%A0cms). Keep it up!
 
 
 Usage
 -----
 
-    coming soon!
+In its most basic form, crudify is designed to be use like this:
+
+    class JelliesController < ApplicationController
+      crudify :jelly
+    end
+    
+    
+Ok, so what does it do? The short answer; _everything_ that you'd want it to. In more detail, crudify turns your controller into a full-fledged CRUD controller with `index`, `new`, `create`, `show`, `edit`, `update`, and `destroy`. But wait, there's more! Inside each of these standard methods are several _hook methods_ designed to make customizing your controllers even easier that over-riding crudify's methods. Over-riding; say what? ... 
+
+Say you want to customize an action that's being defined by crudify, simply over-ride 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
+
+Laced into crudify's actions are a module full of methods designed to make customizing your controller quick and simple. Let's examine these methods in further detail starting with create.
+
+Here's what lines #45-59 in `lib/crudify/class_methods.rb` will produce in our Jellies controller:
+
+    def create
+      # if the position field exists, set this object as last object, given the conditions of this class.
+      if Jelly.column_names.include?("position")
+        params[:jelly].merge!({
+          :position => ((Jelly.maximum(:position, :conditions => "")||-1) + 1)
+        })
+      end
+      @instance = @jelly = Jelly.create(params[:jelly])
+      before_create
+      if @instance.valid? && @instance.save
+        successful_create
+      else
+        failed_create
+      end
+    end
+    
+
+Just before the calls to `valid?` and `save`, you'll see `before_create`; the first hook method in the action. Looking further into the source, `before_create` is nothing more than a blank action, waiting to be overwritten:
+
+      def before_create
+        # just a hook!
+        puts "> Crud::before_create" if @crud_options[:log]
+        before_action
+      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 over-riding this method so that the chain of hooks keeps firing. Inside the `before_action` method we'll decide what to use as flash messages with `set_what`. Here's the code for `before_action`:
+
+      def before_action
+        # just a hook!
+        puts "> Crud::before_action" if @crud_options[:log]
+        set_what
+        true
+      end
+      
+
+*Ok Ok, so we're gettin' kind of deep here.* Let's get back to the basic concept; Skinny, sexy and easy on the eyes. (Are we still talking ruby here?) 
+
+    class InquiriesController < ApplicationController
+      crudify :inquiry
+      
+      def before_create
+        @inquiry.ip_address = request.remote_addr
+        super
+      end
+      
+    end
+      
+
+Or an after-action hook:
+
+    class InquiriesController < ApplicationController
+      crudify :inquiry
+      
+      def successful_create
+        InquiryMailer.message(@inquiry).deliver!
+        super
+      end
+      
+    end
+
+
+### To find out more about crudify, read the source! Here's some helpful links:
+
+* For available options: [Crudify::Base](https://github.com/citrus/crudify/blob/master/lib/crudify/base.rb)
+* For available hooks: [Crudify::HookMethods](https://github.com/citrus/crudify/blob/master/lib/crudify/hook_methods.rb)
+* To see which hooks go where: [Cruidfy::ClassMethods](https://github.com/citrus/crudify/blob/master/lib/crudify/class_methods.rb)
+
+Or check out the demo app in `test/dummy`...
+
+
+Testing
+-------
+
+Shoulda and Capybara/Selenium tests can be run by cloning the repo and running `rake`:
+
+    git clone git://github.com/citrus/crudify.git
+    cd crudify
+    bundle install
+    rake    
+
+
+To Do
+-----
 
+* Documentation & Examples
+* Nested set tests and demo (haven't even tried this yet :/)
+* Generally more thorough tests
+* Refactoring/Optimizing
 
 
 License

data/Rakefile

@@ -3,11 +3,10 @@ require 'rake/testtask'
 Bundler::GemHelper.install_tasks
 
 Rake::TestTask.new do |t|
-  t.libs << "lib"
+  t.libs << "lib" << "test"
+  t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
 
-
 desc "Default Task"
-task :default => [ :test ]
-
+task :default => [ :test ]

data/crudify.gemspec

@@ -11,16 +11,19 @@ Gem::Specification.new do |s|
   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.description = %q{Crudify is a dynamic resource controller for Rails 3. The idea is skinny controllers with powerful hooks for easy customization.}
 
   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('will_paginate', '>= 2.3.15')
   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')
+	s.add_development_dependency('capybara', '>= 0.4.1')
+	s.add_development_dependency('selenium-webdriver', '>= 0.1.3')
+	
 end

data/lib/crudify.rb

@@ -1,12 +1,16 @@
 require 'active_support'
 require 'active_record'
 require 'action_controller'
+require 'will_paginate'
+require 'meta_search'
 
 require 'crudify/hook_methods'
 require 'crudify/class_methods'
 require 'crudify/base'
 
-module Crudify  
+module Crudify
+  class Engine < Rails::Engine
+  end
 end
 
 ActionController::Base.send(:include, Crudify::Base)

data/lib/crudify/base.rb

@@ -3,10 +3,10 @@
 # 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
+# Full documentation about CRUD and resources start here:
+# -> http://www.google.com/search?q=rails%20REST
 # Example (add to your controller):
-# crudify :foo, {:title_attribute => 'name'}
+# crudify :foo, { :title_attribute => 'name' }
 
 
 module Crudify
@@ -21,14 +21,15 @@ module Crudify
       {
         :title_attribute => "title",
         :use_class_name_as_title => false,
-        :order => ('position ASC' if this_class.table_exists? and this_class.column_names.include?('position')),
-        :conditions => '',
+        :paginate => true,
         :sortable => true,
         :searchable => true,
         :include => [],
-        :paging => true,
+        :order => ('position ASC' if this_class.table_exists? && this_class.column_names.include?('position')),
+        :conditions => '',
         :search_conditions => '',
-        :redirect_to_url => "admin_#{plural_name}_url"
+        :redirect_to_url => "admin_#{plural_name}_url",
+        :log => Rails.env == 'development'
       }
     end
   

data/lib/crudify/class_methods.rb

@@ -1,3 +1,10 @@
+#
+# Disclaimer:
+#
+# The majority of this was originally written by 
+# the splendid fellows at Resolve Digital for their
+# awesome refinerycms project.
+#
 module Crudify  
 
   module ClassMethods
@@ -9,7 +16,7 @@ module Crudify
        class_name = singular_name.camelize
        plural_name = singular_name.pluralize
        
-       options[:paging] = (options[:paging] && eval(class_name).respond_to?(:paginate))
+       options[:paginate] = (options[:paginate] && eval(class_name).respond_to?(:paginate))
   
        module_eval %(
        
@@ -23,8 +30,20 @@ module Crudify
          def set_crud_options
            @crud_options = #{options}
          end
-                               
-  
+                  
+         def set_what
+           return @what if @what
+           what = @crud_options[:use_class_name_as_title] ? @instance.class.to_s.underscore.humanize : @instance.send(@crud_options[:title_attribute].to_sym).inspect
+           what = @instance.class.to_s.underscore.humanize if what.nil? || what == '""'
+           @what = what
+         end
+                  
+         def index
+         end                      
+          
+         def show
+         end
+          
          def new
            @#{singular_name} = #{class_name}.new
          end
@@ -62,7 +81,6 @@ module Crudify
          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
@@ -110,14 +128,14 @@ module Crudify
            # 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]}
+           paginate_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})
+             paginate_options.update({:per_page => #{class_name}.per_page})
            end
   
-           set_collection(@#{plural_name}.paginate(paging_options), false)
+           set_collection(@#{plural_name}.paginate(paginate_options), false)
          end
   
          # Returns results based on the query specified by the user.
@@ -137,7 +155,14 @@ module Crudify
   
        # Methods that are only included when this controller is searchable.
        if options[:searchable]
-         if options[:paging]
+       
+         module_eval %(
+           def searching?
+             params && !params[:search].nil?
+           end
+         )
+         
+         if options[:paginate]
            module_eval %(
              def index
                search_all_#{plural_name} if searching?
@@ -156,7 +181,7 @@ module Crudify
            )
          end
        else
-         if options[:paging]
+         if options[:paginate]
            module_eval %(
              def index
                paginate_all_#{plural_name}
@@ -223,18 +248,7 @@ module Crudify
   
          )
        end
-  
-       module_eval %(
-         def self.sortable?
-           #{options[:sortable].to_s}
-         end
-  
-         def self.searchable?
-           #{options[:searchable].to_s}
-         end
-       )
-  
-  
+         
      end
   
    end