rails-crud 0.0.1

data/README

@@ -0,0 +1,51 @@
+# What is rails-crud?
+
+rails-crud is a plugin that abstracts a bunch of the repetitive CRUD actions out. Like scaffold, but I hate scaffold.
+
+# Installation
+
+Install it like a regular plugin.
+
+# Usage
+
+class Pastry < ActiveRecord::Base
+  validates_presence_of :name
+end
+
+class PastriesController
+  include CRUD::Base
+end
+
+Ta-da.
+
+Really, that's it.
+
+Your controller has to be the plural of your model.  Has to.
+
+You'll get the following actions:
+
+* index
+* new
+* create
+* edit
+* update
+* destroy
+
+They're ugly as sin, but they'll work like you want, and they're easily stylable.
+
+# Customizations
+
+You can customize the following views:
+
+* field layout on the forms 
+* column layout on index
+
+You can customize the following behavior:
+
+* some.  seriously, this is new documentation.  I'll get to it.  Or look at the code.  It's not terribly complicated.  Fork, update the docs and send me a pull request
+
+# Requirements:
+
+* haml
+* validation_reflection (not *really* required, but trust me, you'll want it.)
+* formtastic

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'rake'
+require 'rake/gempackagetask'
+
+PKG_FILES = FileList[
+ '[a-zA-Z]*',
+ 'lib/**/*',
+ 'app/**/*',
+ 'rails/**/*' 
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = 'rails-crud'
+  s.version = '0.0.1'
+  s.author = 'Jon Moses'
+  s.email = 'jon@burningbush.us'
+  s.homepage = 'http://github.com/jmoses/rails-crud'
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Rails plugin for making CRUD easier"
+  s.files = PKG_FILES.to_a
+  s.require_path = 'lib'
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README"]
+end
+
+desc 'Build the gem'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/app/views/crud/_fields.html.haml

@@ -0,0 +1 @@
+= form.inputs

data/app/views/crud/_form.html.haml

@@ -0,0 +1,4 @@
+- semantic_form_for object do |form|
+  = form.semantic_errors
+  = crud_fields(form)
+  = form.buttons

data/app/views/crud/edit.html.haml

@@ -0,0 +1,5 @@
+%h1 
+  Edit 
+  = base_name.titleize
+
+= default_form_for get_model_variable

data/app/views/crud/index.html.haml

@@ -0,0 +1,24 @@
+%h1= base_name.pluralize.titleize
+
+= link_to "new", new_polymorphic_path(model)
+
+- if get_collection_variable.empty?
+  %h2 Nothing found
+- else
+  = will_paginate get_collection_variable
+  %table
+    %thead
+      %tr
+        - content_columns.each do |column|
+          %th= header_for_column column
+        %th Actions
+    %tbody
+      - get_collection_variable.each do |obj|
+        %tr
+          - content_columns.each do |column|
+            %td= value_for_column(obj, column)
+          %td
+            = link_to 'edit', edit_polymorphic_path(obj)
+            = link_to 'destroy', polymorphic_path(obj), :method => :delete, :confirm => "Are you sure?"
+            = other_actions( obj )
+  = will_paginate get_collection_variable

data/app/views/crud/new.html.haml

@@ -0,0 +1,5 @@
+%h1 
+  New
+  = base_name.titleize
+
+= default_form_for get_model_variable

data/lib/crud.rb

@@ -0,0 +1,142 @@
+module CRUD
+  module Base
+    def self.included(base)
+      base.send :include, ClassMethods
+    end
+
+    module ClassMethods
+      def self.included(base)
+        base.class_eval do
+          include ActiveSupport::Callbacks
+          
+          before_filter :build_object, :only => [:new, :create]
+          before_filter :load_object, :only => [:edit, :update, :destroy]
+          before_filter :load_collection, :only => :index
+                       
+          helper_method :base_name, :model, :get_model_variable, :get_collection_variable, :header_for_column,
+            :content_columns, :value_for_column
+
+          define_callbacks :before_save
+        end
+      end
+    end
+    
+    def index;
+       crud_render
+    end
+    def new; 
+      crud_render
+    end
+    def edit
+      crud_render
+    end
+    
+    def create
+      run_callbacks(:before_save)
+      
+      if get_model_variable.save
+        redirect_to :action => :index and return
+      else
+        crud_render :new
+      end
+    end
+    
+    def update
+      get_model_variable.attributes = params[param_key]
+      
+      run_callbacks(:before_save)
+      
+      if get_model_variable.save
+        redirect_to :action => :index and return
+      else
+        crud_render :edit
+      end
+    end
+    
+    def destroy
+      if get_model_variable.destroy
+        redirect_to :action => :index and return
+      else
+        crud_render :index
+      end
+    end
+
+    protected
+      def content_columns
+        [
+          [:to_s, "Object"]
+        ]
+      end
+      
+      def header_for_column( col )
+        col[1] or col[0].to_s.humanize.titleize
+      end
+      
+      def value_for_column( object, col )
+        case ( thing = col.first)
+        when Symbol
+          object.send thing
+        when Proc
+          thing.call( object )
+        else
+          thing
+        end
+      end
+    
+      def build_object
+        set_model_variable model.new( params[param_key] )
+      end
+    
+      def load_object
+        set_model_variable model.find( params[:id] )
+      end
+      
+      def load_collection
+        set_collection_variable model.paginate :page => params[:page], :order => collection_order
+      end
+      
+      def collection_order
+        "created_at asc"
+      end
+      
+      def set_collection_variable( obj )
+        instance_variable_set("@#{base_name.pluralize}", obj)
+      end
+      
+      def get_collection_variable
+        instance_variable_get("@#{base_name.pluralize}")
+      end
+    
+      def base_name
+        @base_name ||= controller_name.singularize      
+      end
+    
+      def param_key
+        base_name.to_sym
+      end
+    
+      def model_variable
+        "@#{base_name}"
+      end
+    
+      def set_model_variable( obj )
+        instance_variable_set(model_variable, obj)
+      end
+    
+      def get_model_variable
+        instance_variable_get(model_variable)
+      end
+    
+      def model
+        base_name.classify.constantize
+      end
+      
+      def crud_render( template = action_name )
+        begin
+          render template
+        rescue ActionView::MissingTemplate
+          render :template => "crud/#{template}"
+        end
+      end
+  end
+end

data/lib/crud_helper.rb

@@ -0,0 +1,23 @@
+module CRUD
+  module CrudHelper
+    def default_form_for( object )
+      crud_partial "form", :object => object
+    end
+    
+    def crud_fields( form )
+      crud_partial "fields", :form => form
+    end
+    
+    def crud_partial( partial, locals = {} )
+      begin
+        render :partial => partial, :locals => locals
+      rescue ActionView::MissingTemplate
+        render :partial => "crud/#{partial}", :locals => locals
+      end
+    end
+    
+    def other_actions( object )
+      crud_partial "other_actions", :object => object
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,4 @@
+require 'crud'
+require 'crud_helper'
+
+ActionView::Base.send :include, CRUD::CrudHelper

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: rails-crud
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jon Moses
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-04 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: jon@burningbush.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- Rakefile
+- README
+- lib/crud.rb
+- lib/crud_helper.rb
+- app/views/crud/_fields.html.haml
+- app/views/crud/_form.html.haml
+- app/views/crud/_other_actions.html.haml
+- app/views/crud/edit.html.haml
+- app/views/crud/index.html.haml
+- app/views/crud/new.html.haml
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/jmoses/rails-crud
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rails plugin for making CRUD easier
+test_files: []
+