mconnell-generators 1.0.6

data/.gitignore

@@ -0,0 +1,2 @@
+/rdoc
+/pkg

data/CHANGELOG

@@ -0,0 +1,43 @@
+= Change Log
+
+== Version 1.0.6
+
+* Add Web App Theme to the application (script/generate rubaidh_layout)
+
+* Fix error introduced in last version of a missing comma in a command to add a submodule
+
+== Version 1.0.5
+
+* Add .DS_Store to .gitignore
+
+* Remove cucumber being installed as a submoduled plugin so we don't encounter issues with the gem path
+
+* Added dependancy for grit gem
+
+* Switched out Hoptoad for GetExceptional
+
+* Switched out Remarkable for Shoulda
+
+== Version 1.0.4
+
+* Insert cucumber into the generated application, not a duplicate copy of
+  webrat.
+
+== Version 1.0.3
+
+* The rubaidh_rails application generator now pulls in edge Rails as a
+  submodule.
+
+== Version 1.0.2
+
+* Enhance (ie write) documentation.
+
+== Version 1.0.1
+
+* Modify the model generator to generate an object_daddy examplar too.
+
+* Fix a regression that was causing generated routing spec failure.
+
+== Version 1.0.0
+
+* Initial release.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.rdoc

@@ -0,0 +1,46 @@
+= Rubaidh Generators
+
+Rails ships with its own generators for creating models, controllers and
+complete scaffolds. RSpec ships with its own take on these generators. We ship
+with yet another slightly different take on the generators, suited to
+Rubaidh's tastes.
+
+== Application Generator
+
+The gem ships with a program called +rubaidh_rails+ which generates a Rails
+application and applies the Rubaidh template to it. In short, this will:
+
+* initialize a local Git repository, ignoring the appropriate things and
+  saving the log directory but not its contents;
+
+* install RSpec, RSpec's Rails support, Shoulda and object_daddy
+  for testing support;
+
+* install and enable GetExceptional for watching errors in production; and
+
+* create and migrate all the appropriate databases.
+
+So, for every new application, it'll save us a good hour of boring fiddling.
+:-)
+
+== Component Generators
+
+We currently ship with 4 generators:
+
+* rubaidh_model which generates a model, specification and exemplar.
+
+* rubaidh_controller which generates a controller and specification.
+
+* rubaidh_helper which generates a helper and its specification.
+
+* rubaidh_scaffold which generates the full shebang for a CRUD-operated
+  RESTful resource.
+
+* rubaidh_layout which generates a basic web-app theme
+
+Where possible generators are built in terms of other generators (so the
+scaffold calls on rubaidh_model to generate the model).
+
+== License
+
+Copyright (c) 2009 Rubaidh Ltd, released under the MIT license.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rubaidh Generators'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('CHANGELOG')
+  rdoc.rdoc_files.include('MIT-LICENSE')
+end
+
+Rake::GemPackageTask.new(eval(File.read('generators.gemspec'))) do |p|
+  p.need_tar = false
+  p.need_zip = false
+end

data/TODO

@@ -0,0 +1,11 @@
+= To do
+
+* Fix the scaffold to successfully create singleton resources too.
+
+* Create a layout generator which creates a sensible default layout using YUI
+  grids.
+
+* Figure out how to do automated testing of generators.
+
+* Figure a way to keep track of changes to the Rails (and RSpec) generators
+  used as inspiration so we can merge in changes.

data/bin/rubaidh_rails

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+gem 'rails'
+
+require 'rails/version'
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+
+Rails::Generator::Base.use_application_sources!
+Rails::Generator::Scripts::Generate.new.run(["-d", "mysql", "-m", File.join(File.dirname(__FILE__), '..', 'templates', 'rubaidh.rb')] + ARGV, :generator => 'app')

data/generators.gemspec

@@ -0,0 +1,59 @@
+spec = Gem::Specification.new do |s|
+  s.name = 'generators'
+  s.version = '1.0.6'
+  s.date = '2009-03-17'
+  s.authors = ['Graeme Mathieson', 'Mark Connell' 'Rubaidh Ltd']
+  s.email = 'support@rubaidh.com'
+  s.rubyforge_project = 'rubaidh'
+  s.homepage = 'http://rubaidh.com/portfolio/open-source'
+  s.summary = '[Rails] Generators for building Ruby on Rails projects the Rubaidh Way'
+
+  s.description = 'Generators for building Ruby on Rails projects the Rubaidh Way'
+
+  s.files = %w(
+    .gitignore MIT-LICENSE Rakefile README.rdoc CHANGELOG TODO generators.gemspec
+    bin/rubaidh_rails
+    generators/rubaidh_controller/rubaidh_controller_generator.rb
+    generators/rubaidh_controller/templates/controller.rb
+    generators/rubaidh_controller/templates/controller_spec.rb
+    generators/rubaidh_controller/templates/view.html.erb
+    generators/rubaidh_controller/USAGE
+    generators/rubaidh_helper/rubaidh_helper_generator.rb
+    generators/rubaidh_helper/templates/helper.rb
+    generators/rubaidh_helper/templates/helper_spec.rb
+    generators/rubaidh_helper/USAGE
+    generators/rubaidh_model/rubaidh_model_generator.rb
+    generators/rubaidh_model/templates/migration.rb
+    generators/rubaidh_model/templates/model.rb
+    generators/rubaidh_model/templates/model_exemplar.rb
+    generators/rubaidh_model/templates/model_spec.rb
+    generators/rubaidh_model/USAGE
+    generators/rubaidh_named_base.rb
+    generators/rubaidh_scaffold/rubaidh_scaffold_generator.rb
+    generators/rubaidh_scaffold/templates/controller.rb
+    generators/rubaidh_scaffold/templates/controller_spec.rb
+    generators/rubaidh_scaffold/templates/partial_form.html.erb
+    generators/rubaidh_scaffold/templates/partial_layout.html.erb
+    generators/rubaidh_scaffold/templates/partial_model.html.erb
+    generators/rubaidh_scaffold/templates/routing_spec.rb
+    generators/rubaidh_scaffold/templates/view_edit.html.erb
+    generators/rubaidh_scaffold/templates/view_index.html.erb
+    generators/rubaidh_scaffold/templates/view_new.html.erb
+    generators/rubaidh_scaffold/templates/view_show.html.erb
+    generators/rubaidh_scaffold/USAGE
+    generators/rubaidh_layout/rubaidh_layout_generator.rb
+    generators/rubaidh_layout/templates/base.css
+    generators/rubaidh_layout/templates/style.css
+    generators/rubaidh_layout/templates/layout.html.erb
+    templates/rubaidh.rb
+  )
+
+  s.add_dependency 'rails', '>=2.3.0'
+  s.add_dependency 'grit', '>=1.0.1'
+
+  s.bindir = "bin"
+  s.executables = ["rubaidh_rails"]
+  s.default_executable = "rubaidh_rails"
+
+  s.has_rdoc = false
+end

data/generators/rubaidh_controller/USAGE

@@ -0,0 +1,31 @@
+Description:
+    Stubs out a new controller, along with its helper, views and associated
+    specs. Pass the controller name, either CamelCased or under_scored, and a
+    list of views as arguments.
+
+    To create a controller within a module, specify the controller name as a
+    path like 'parent_module/controller_name'.
+
+    This generates a controller class in app/controllers, view templates in
+    app/views/controller_name, a helper class in app/helpers, a controller
+    spec in spec/controllers and a helper spec in spec/helpers.
+
+Example:
+    `./script/generate controller CreditCard open debit credit close`
+
+    Credit card controller with URLs like /credit_card/debit.
+        Controller:      app/controllers/credit_card_controller.rb
+        Controller Spec: spec/controllers/credit_card_controller_spec.rb
+        Views:           app/views/credit_card/debit.html.erb [...]
+        Helper:          app/helpers/credit_card_helper.rb
+        Helper Spec:     spec/helpers/credit_card_helper_spec.rb
+
+Modules Example:
+    `./script/generate controller 'admin/credit_card' suspend late_fee`
+
+    Credit card admin controller with URLs /admin/credit_card/suspend.
+        Controller:      app/controllers/admin/credit_card_controller.rb
+        Controller Spec: spec/controllers/admin/credit_card_controller_spec.rb
+        Views:           app/views/admin/credit_card/debit.html.erb [...]
+        Helper:          app/helpers/admin/credit_card_helper.rb
+        Helper Spec:     spec/helpers/admin/credit_card_helper_spec.rb

data/generators/rubaidh_controller/rubaidh_controller_generator.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), '..', 'rubaidh_named_base')
+
+class RubaidhControllerGenerator < RubaidhNamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions "#{class_name}Controller"
+
+      # Controller, helper, views, and spec directories.
+      m.directory File.join('app/controllers', class_path)
+      m.directory File.join('app/views', class_path, file_name)
+      m.directory File.join('spec/controllers', class_path)
+
+      # Controller spec, class, and helper.
+      m.template 'controller.rb',
+                 File.join('app/controllers',
+                           class_path,
+                           "#{file_name}_controller.rb")
+
+      m.template 'controller_spec.rb',
+                 File.join('spec/controllers',
+                           class_path,
+                           "#{file_name}_controller_spec.rb")
+
+      # View template for each action.
+      actions.each do |action|
+        path = File.join('app/views', class_path, file_name, "#{action}.html.erb")
+        m.template 'view.html.erb', path,
+          :assigns => { :action => action, :path => path }
+      end
+
+      m.dependency 'rubaidh_helper', [name] + @args
+    end
+  end
+
+  protected
+  def banner
+    "Usage: #{$0} #{spec.name} ControllerName [action]..."
+  end
+end

data/generators/rubaidh_controller/templates/controller.rb

@@ -0,0 +1,17 @@
+# <%= class_name %> Controller
+#
+# Created on <%= Time.now.to_s :long %> by <%= user_full_name %> as part
+# of the "<%= project_name %>" project.
+#
+#--
+# Copyright (c) 2006-<%= Time.now.year %> Rubaidh Ltd.  All rights reserved.
+# See LICENSE in the top level source code folder for permissions.
+#++
+
+class <%= class_name %>Controller < ApplicationController
+<% for action in actions -%>
+
+  def <%= action %>
+  end
+<% end -%>
+end

data/generators/rubaidh_controller/templates/controller_spec.rb

@@ -0,0 +1,29 @@
+# <%= class_name %> Controller Spec
+#
+# Created on <%= Time.now.to_s :long %> by <%= user_full_name %> as part
+# of the "<%= project_name %>" project.
+#
+#--
+# Copyright (c) 2006-<%= Time.now.year %> Rubaidh Ltd.  All rights reserved.
+# See LICENSE in the top level source code folder for permissions.
+#++
+
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../spec_helper')
+
+describe <%= class_name %>Controller do
+<% unless actions.empty? -%>
+<% for action in actions -%>
+
+  describe "responding to GET '<%= action %>'" do
+    def do_get
+      get :<%= action %>
+    end
+
+    it "should be successful" do
+      do_get
+      response.should be_success
+    end
+  end
+<% end -%>
+<% end -%>
+end

data/generators/rubaidh_controller/templates/view.html.erb

@@ -0,0 +1,17 @@
+<div class="block">
+  <div class="content">
+    <h2 class="title"><%= class_name %>#<%= action %></h2>
+    <div class="inner">
+      <p>Find me in <%= path %></p>
+    </div>
+  </div>
+</div>
+
+<%% content_for :sidebar do %>
+  <div class="block notice">
+    <h4>Sample</h4>
+    <p>
+      This is a sample notice for in the sidebar
+    </p>
+  </div>
+<%% end %>

data/generators/rubaidh_helper/USAGE

@@ -0,0 +1,23 @@
+Description:
+    Stubs out a new helper. Pass the helper name, either
+    CamelCased or under_scored.
+
+    To create a helper within a module, specify the helper name as a
+    path like 'parent_module/helper_name'.
+
+    This generates a helper class in app/helpers and a helper spec
+    in spec/helpers.
+
+Example:
+    `./script/generate helper CreditCard`
+
+    Credit card helper.
+        Helper:     app/helpers/credit_card_helper.rb
+        Spec:       spec/helpers/credit_card_helper_spec.rb
+
+Modules Example:
+    `./script/generate helper 'admin/credit_card'`
+
+    Credit card admin helper.
+        Helper:     app/helpers/admin/credit_card_helper.rb
+        Spec:       spec/helpers/admin/credit_card_helper_spec.rb

data/generators/rubaidh_helper/rubaidh_helper_generator.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), '..', 'rubaidh_named_base')
+
+class RubaidhHelperGenerator < RubaidhNamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions "#{class_name}Helper"
+
+      # Helper and helper test directories.
+      m.directory File.join('app/helpers', class_path)
+      m.directory File.join('spec/helpers', class_path)
+
+      # Helper and helper test class.
+
+      m.template 'helper.rb',
+                  File.join('app/helpers',
+                            class_path,
+                            "#{file_name}_helper.rb")
+
+      m.template 'helper_spec.rb',
+                  File.join('spec/helpers',
+                            class_path,
+                            "#{file_name}_helper_spec.rb")
+
+    end
+  end
+end

data/generators/rubaidh_helper/templates/helper.rb

@@ -0,0 +1,12 @@
+# <%= class_name %> Helper
+#
+# Created on <%= Time.now.to_s :long %> by <%= user_full_name %> as part
+# of the "<%= project_name %>" project.
+#
+#--
+# Copyright (c) 2006-<%= Time.now.year %> Rubaidh Ltd.  All rights reserved.
+# See LICENSE in the top level source code folder for permissions.
+#++
+
+module <%= class_name %>Helper
+end

data/generators/rubaidh_helper/templates/helper_spec.rb

@@ -0,0 +1,14 @@
+# <%= class_name %> Helper Spec
+#
+# Created on <%= Time.now.to_s :long %> by <%= user_full_name %> as part
+# of the "<%= project_name %>" project.
+#
+#--
+# Copyright (c) 2006-<%= Time.now.year %> Rubaidh Ltd.  All rights reserved.
+# See LICENSE in the top level source code folder for permissions.
+#++
+
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../spec_helper')
+
+describe <%= class_name %>Helper do
+end