kjohnston-lean_scaffold 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.1.0 2009-07-25
+
+* 1 major enhancement:
+  * Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kenny Johnston
+
+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/Manifest.txt

@@ -0,0 +1,26 @@
+History.txt
+MIT-LICENSE
+Manifest.txt
+PostInstall.txt
+README.textile
+Rakefile
+generators/lean_scaffold/lean_scaffold_generator.rb
+generators/lean_scaffold/templates/controller.rb
+generators/lean_scaffold/templates/functional_test.rb
+generators/lean_scaffold/templates/helper.rb
+generators/lean_scaffold/templates/view_edit.html.erb
+generators/lean_scaffold/templates/view_index.html.erb
+generators/lean_scaffold/templates/view_new.html.erb
+generators/lean_scaffold/templates/view_show.html.erb
+init.rb
+install.rb
+lib/lean_scaffold.rb
+lib/lean_scaffold_helper.rb
+script/console
+script/destroy
+script/generate
+tasks/lean_scaffold_tasks.rake
+test/lean_scaffold_test.rb
+test/test_helper.rb
+test/test_lean_scaffold.rb
+uninstall.rb

data/PostInstall.txt

@@ -0,0 +1 @@
+For more information on lean_scaffold, see http://github.com/kjohnston/lean_scaffold

data/README.textile

@@ -0,0 +1,81 @@
+h1. LeanScaffold
+
+LeanScaffold can be installed as a plugin (recommended your first time) or as a gem.  It allows you to generate a scaffold much like the regular Rails scaffold generator... but leaner... and, well - cooler.
+
+h2. Features
+
+
+* Generates a low fat model, controller and set of views
+* Generates a migration and form fields (including the attributes you pass in)
+* Doesn't include all that other jazz you don't need (particularly in the controller)
+* Generates a fixture and functional and unit tests (like the normal Rails scaffold generator)
+* Automates the use of a spinner image that swaps itself in place of a form's submit button upon submission
+
+
+h2. Usage
+
+script/generate lean_scaffold widget name:string description:text
+
+Attributes and their data types are optional, but will result in populated migrations and generated form fields if provided.
+
+
+h2. Prerequisites
+
+
+* restful_authentication (just becuase it adds 'before_filter :login_required' to the controllers, which you can manually remove)
+* Grab a spinner image from http://www.ajaxload.info, name it spinner.gif and drop it in public/images.  This image will appear in place of the submit button when you submit a form.
+* Add the following JavaScript to your app:
+
+		function spin(){
+			Element.toggle('processing');
+			Element.toggle('submit');
+		}
+
+
+h2. After setup
+
+
+* Add some CSS for the spinner image that appears when you submit a form, just align the image - pretty straightforward.
+
+
+h2. Assumptions
+
+What's a Rails plugin without some assumptions?  Well you may notice that this plugin has made some judgement calls for you.  For example, links such as "New Widget" and headers such as "Listing Widgets" have been omitted.  I use other frameworks/helpers that auto-populate these things, so I intentionally left them out of this generator since we don't want to add stuff to our views that we just have to immediately strip out do we?
+
+
+h2. Using the Gem
+
+
+* Place the methods located in lib/lean_scaffold_helper.rb in a helper in your application.
+* You do not need to have the plugin installed.
+
+
+h2. Generated tests
+
+Currently you'll get (virtually) the same fixtures and functional and unit tests as you would from the normal scaffold generator.  Later I'd like to move this to Shoulda and Factory Girl.
+
+
+h2. License
+
+(The MIT License)
+
+Copyright (c) 2009 Kenny Johnston
+
+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/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/lean_scaffold'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'lean_scaffold' do
+  self.developer 'FIXME full name', 'FIXME email'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/generators/lean_scaffold/lean_scaffold_generator.rb

@@ -0,0 +1,99 @@
+class LeanScaffoldGenerator < Rails::Generator::NamedBase
+  default_options :skip_timestamps => false, :skip_migration => false, :force_plural => false
+ 
+  attr_reader   :controller_name,
+                :controller_class_path,
+                :controller_file_path,
+                :controller_class_nesting,
+                :controller_class_nesting_depth,
+                :controller_class_name,
+                :controller_underscore_name,
+                :controller_singular_name,
+                :controller_plural_name
+  alias_method  :controller_file_name,  :controller_underscore_name
+  alias_method  :controller_table_name, :controller_plural_name
+ 
+  def initialize(runtime_args, runtime_options = {})
+    super
+ 
+    if @name == @name.pluralize && !options[:force_plural]
+      logger.warning "Plural version of the model detected, using singularized version.  Override with --force-plural."
+      @name = @name.singularize
+    end
+ 
+    @controller_name = @name.pluralize
+ 
+    base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
+    @controller_class_name_without_nesting, @controller_underscore_name, @controller_plural_name = inflect_names(base_name)
+    @controller_singular_name=base_name.singularize
+    if @controller_class_nesting.empty?
+      @controller_class_name = @controller_class_name_without_nesting
+    else
+      @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
+    end
+  end
+ 
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions("#{controller_class_name}Controller", "#{controller_class_name}Helper")
+      m.class_collisions(class_name)
+ 
+      # Controller, helper, views, test and stylesheets directories.
+      m.directory(File.join('app/models', class_path))
+      m.directory(File.join('app/controllers', controller_class_path))
+      m.directory(File.join('app/helpers', controller_class_path))
+      m.directory(File.join('app/views', controller_class_path, controller_file_name))
+      m.directory(File.join('app/views/layouts', controller_class_path))
+      m.directory(File.join('test/functional', controller_class_path))
+      m.directory(File.join('test/unit', class_path))
+      m.directory(File.join('test/unit/helpers', class_path))
+      m.directory(File.join('public/stylesheets', class_path))
+ 
+      for action in scaffold_views
+        m.template(
+          "view_#{action}.html.erb",
+          File.join('app/views', controller_class_path, controller_file_name, "#{action}.html.erb")
+        )
+      end
+      
+      m.template("partial_form.html.erb", File.join('app/views', controller_class_path, controller_file_name, '_form.html.erb'))
+ 
+      m.template(
+        'controller.rb', File.join('app/controllers', controller_class_path, "#{controller_file_name}_controller.rb")
+      )
+ 
+      m.template('functional_test.rb', File.join('test/functional', controller_class_path, "#{controller_file_name}_controller_test.rb"))
+      m.template('helper.rb',          File.join('app/helpers',     controller_class_path, "#{controller_file_name}_helper.rb"))
+ 
+      m.route_resources controller_file_name
+ 
+      m.dependency 'model', [name] + @args, :collision => :skip
+    end
+  end
+ 
+  protected
+    # Override with your own usage banner.
+    def banner
+      "Usage: #{$0} scaffold ModelName [field:type, field:type]"
+    end
+ 
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--skip-timestamps",
+             "Don't add timestamps to the migration file for this model") { |v| options[:skip_timestamps] = v }
+      opt.on("--skip-migration",
+             "Don't generate a migration file for this model") { |v| options[:skip_migration] = v }
+      opt.on("--force-plural",
+             "Forces the generation of a plural ModelName") { |v| options[:force_plural] = v }
+    end
+ 
+    def scaffold_views
+      %w[ index show new edit ]
+    end
+ 
+    def model_name
+      class_name.demodulize
+    end
+end

data/generators/lean_scaffold/templates/controller.rb

@@ -0,0 +1,43 @@
+class <%= controller_class_name %>Controller < ApplicationController
+
+  before_filter :login_required
+  before_filter :find_<%= file_name %>, :only => [:destroy, :edit, :show, :update]
+
+  def index
+    @<%= table_name %> = <%= class_name %>.find(:all)
+  end
+ 
+  def show
+  end
+ 
+  def new
+    @<%= file_name %> = <%= class_name %>.new
+  end
+ 
+  def edit
+  end
+ 
+  def create
+    @<%= file_name %> = <%= class_name %>.new(params[:<%= file_name %>])
+    flash[:notice] = '<%= class_name %> was successfully created.' and redirect_to <%= table_name %>_path and return if @<%= file_name %>.save
+    render :action => 'new'
+  end
+ 
+  def update
+    flash[:notice] = '<%= class_name %> was successfully updated.' and redirect_to <%= table_name %>_path and return if @<%= file_name %>.update_attributes(params[:<%= file_name %>])
+    render :action => 'edit'
+  end
+ 
+  def destroy
+    flash[:notice] = '<%= class_name %> was successfully updated.' if @<%= file_name %>.destroy
+    redirect_to <%= table_name %>_path
+  end
+  
+  
+  private
+  
+  def find_<%= file_name %>
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+  end
+  
+end

data/generators/lean_scaffold/templates/functional_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+ 
+class <%= controller_class_name %>ControllerTest < ActionController::TestCase
+  test "should get index" do
+    get :index
+    assert_response :success
+    assert_not_nil assigns(:<%= table_name %>)
+  end
+ 
+  test "should get new" do
+    get :new
+    assert_response :success
+  end
+ 
+  test "should create <%= file_name %>" do
+    assert_difference('<%= class_name %>.count') do
+      post :create, :<%= file_name %> => { }
+    end
+    assert_redirected_to <%= table_name %>_path
+  end
+ 
+  test "should show <%= file_name %>" do
+    get :show, :id => <%= table_name %>(:one).to_param
+    assert_response :success
+  end
+ 
+  test "should get edit" do
+    get :edit, :id => <%= table_name %>(:one).to_param
+    assert_response :success
+  end
+ 
+  test "should update <%= file_name %>" do
+    put :update, :id => <%= table_name %>(:one).to_param, :<%= file_name %> => { }
+    assert_redirected_to <%= table_name %>_path
+  end
+ 
+  test "should destroy <%= file_name %>" do
+    assert_difference('<%= class_name %>.count', -1) do
+      delete :destroy, :id => <%= table_name %>(:one).to_param
+    end
+ 
+    assert_redirected_to <%= table_name %>_path
+  end
+end

data/generators/lean_scaffold/templates/helper.rb

@@ -0,0 +1,5 @@
+module <%= controller_class_name %>Helper
+  
+  
+  
+end

data/generators/lean_scaffold/templates/partial_form.html.erb

@@ -0,0 +1,10 @@
+<%%= f.error_messages %>
+
+<% for attribute in attributes -%>
+<div class="full">
+  <label><%= attribute.name %></label>
+  <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+</div>
+
+<% end -%>
+<%%= submit_or_cancel(f.object) %>

data/generators/lean_scaffold/templates/view_edit.html.erb

@@ -0,0 +1,3 @@
+<%% form_for(@<%= singular_name %>, :html => { :onsubmit => "spin()" }) do |f| %>
+	<%%= render :partial => 'form', :locals => { :f => f } %>
+<%% end %>

data/generators/lean_scaffold/templates/view_index.html.erb

@@ -0,0 +1,21 @@
+<table>
+  <tr>
+<% for attribute in attributes -%>
+    <th><%= attribute.column.human_name %></th>
+<% end -%>
+    <th>&nbsp;</th>
+  </tr>
+ 
+<%% @<%= plural_name %>.each do |<%= singular_name %>| %>
+  <tr>
+<% for attribute in attributes -%>
+    <td><%%=h <%= singular_name %>.<%= attribute.name %> %></td>
+<% end -%>
+    <td>
+			<%%= link_to 'Show', <%= singular_name %> %>
+    	<%%= link_to 'Edit', edit_<%= singular_name %>_path(<%= singular_name %>) %>
+    	<%%= delete_link(<%= singular_name %>) %>
+		</td>
+  </tr>
+<%% end %>
+</table>

data/generators/lean_scaffold/templates/view_new.html.erb

@@ -0,0 +1,3 @@
+<%% form_for(@<%= singular_name %>, :html => { :onsubmit => "spin()" }) do |f| %>
+	<%%= render :partial => 'form', :locals => { :f => f } %>
+<%% end %>

data/generators/lean_scaffold/templates/view_show.html.erb

@@ -0,0 +1,6 @@
+<% for attribute in attributes -%>
+<p>
+  <strong><%= attribute.column.human_name %>:</strong>
+  <%%=h @<%= singular_name %>.<%= attribute.name %> %>
+</p>
+<% end -%>

data/init.rb

@@ -0,0 +1,4 @@
+require 'lean_scaffold'
+require 'lean_scaffold_helper'
+ActionView::Base.send :include, LeanScaffoldHelper
+ActionController::Base.send :include, LeanScaffold

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/lean_scaffold.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module LeanScaffold
+  VERSION = '0.0.1'
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/lean_scaffold.rb'}"
+puts "Loading lean_scaffold gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/tasks/lean_scaffold_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :lean_scaffold do
+#   # Task goes here
+# end

data/test/lean_scaffold_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class LeanScaffoldTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/lean_scaffold'

data/test/test_lean_scaffold.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestLeanScaffold < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: kjohnston-lean_scaffold
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kenny Johnston
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: LeanScaffold can be installed as a plugin (recommended your first time) or as a gem.  It allows you to generate a scaffold much like the regular Rails scaffold generator... but leaner... and, well - cooler.
+email: 
+- info@appcreations.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- MIT-LICENSE
+- Manifest.txt
+- PostInstall.txt
+- README.textile
+- Rakefile
+- generators/lean_scaffold/lean_scaffold_generator.rb
+- generators/lean_scaffold/templates/controller.rb
+- generators/lean_scaffold/templates/functional_test.rb
+- generators/lean_scaffold/templates/helper.rb
+- generators/lean_scaffold/templates/partial_form.html.erb
+- generators/lean_scaffold/templates/view_edit.html.erb
+- generators/lean_scaffold/templates/view_index.html.erb
+- generators/lean_scaffold/templates/view_new.html.erb
+- generators/lean_scaffold/templates/view_show.html.erb
+- init.rb
+- install.rb
+- lib/lean_scaffold.rb
+- script/console
+- script/destroy
+- script/generate
+- tasks/lean_scaffold_tasks.rake
+- test/lean_scaffold_test.rb
+- test/test_helper.rb
+- test/test_lean_scaffold.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/kjohnston/lean_scaffold
+post_install_message: PostInstall.txt
+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: lean_scaffold
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: LeanScaffold can be installed as a plugin (recommended your first time) or as a gem.  It allows you to generate a scaffold much like the regular Rails scaffold generator... but leaner... and, well - cooler.
+test_files: 
+- test/test_helper.rb
+- test/test_lean_scaffold.rb