rspec_rails3_gen 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kristian Mandrup
+
+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

@@ -0,0 +1,14 @@
+Description:
+  The Rspec Rails 3 generators includes the following generators:
+  
+    rspec:skeleton          - generates an Rspec skeleton directory structure
+    rspec:integration_spec  - generates an Rspec integration test specification for a controller
+    rspec:controller        - generates an Rspec controller specification
+    rspec:model             - generates an Rspec model specification
+    rspec:scaffold          - scaffolds multiple Rspec artifacts for a controller
+    
+NOTE: 
+This is currently a work in progress. Please feel free to join in the effort and fork this project and fix whatever bugs etc.
+This has not yet been tested... haha! I will continue when I get time, and add tests! 
+    
+

data/README.rdoc

@@ -0,0 +1,13 @@
+= Description:
+
+The Rspec Rails 3 generators includes the following generators:
+  
+* rspec:skeleton          - generates an Rspec skeleton directory structure
+* rspec:integration_spec  - generates an Rspec integration test specification for a controller
+* rspec:controller        - generates an Rspec controller specification
+* rspec:model             - generates an Rspec model specification
+* rspec:scaffold          - scaffolds multiple Rspec artifacts for a controller
+
+== Important
+This is currently a work in progress. Please feel free to join in the effort and fork this project and fix whatever bugs etc.
+This has not yet been tested... haha! I will continue when I get time, and add tests! 

data/bin/rspec_controller

@@ -0,0 +1,19 @@
+#!/user/local/bin/ruby
+
+begin
+  require 'rails/ruby_version_check'
+rescue LoadError
+  # If people are not using gems, the load path must still
+  # be correct.
+  # TODO: Remove the begin / rescue block somehow
+  $:.unshift File.expand_path('../../lib', __FILE__)
+  $:.unshift File.expand_path('../../../activesupport/lib', __FILE__)
+  $:.unshift File.expand_path('../../../actionpack/lib', __FILE__)
+end
+
+Signal.trap("INT") { puts; exit }
+
+require 'rails/generators'
+require 'generators/rspec/controller/controller_generator'
+
+RSpec::Generators::ControllerGenerator.start

data/bin/rspec_integration_spec

@@ -0,0 +1,21 @@
+#!/user/local/bin/ruby
+
+begin
+  require 'rails/ruby_version_check'
+rescue LoadError
+  # If people are not using gems, the load path must still
+  # be correct.
+  # TODO: Remove the begin / rescue block somehow
+  $:.unshift File.expand_path('../../lib', __FILE__)
+  $:.unshift File.expand_path('../../../activesupport/lib', __FILE__)
+  $:.unshift File.expand_path('../../../actionpack/lib', __FILE__)
+  require 'rails/ruby_version_check'
+end
+
+Signal.trap("INT") { puts; exit }
+
+require 'rails/version'
+require 'rails/generators'
+require 'generators/rspec/integration_spec/integration_spec_generator'
+
+RSpec::Generators::IntegrationSpecGenerator.start

data/bin/rspec_model

@@ -0,0 +1,19 @@
+#!/user/local/bin/ruby
+
+begin
+  require 'rails/ruby_version_check'
+rescue LoadError
+  # If people are not using gems, the load path must still
+  # be correct.
+  # TODO: Remove the begin / rescue block somehow
+  $:.unshift File.expand_path('../../lib', __FILE__)
+  $:.unshift File.expand_path('../../../activesupport/lib', __FILE__)
+  $:.unshift File.expand_path('../../../actionpack/lib', __FILE__)
+end
+
+Signal.trap("INT") { puts; exit }
+
+require 'rails/generators'
+require 'generators/rspec/model/model_generator'
+
+RSpec::Generators::ModelGenerator.start

data/bin/rspec_scaffold

@@ -0,0 +1,21 @@
+#!/user/local/bin/ruby
+
+begin
+  require 'rails/ruby_version_check'
+rescue LoadError
+  # If people are not using gems, the load path must still
+  # be correct.
+  # TODO: Remove the begin / rescue block somehow
+  $:.unshift File.expand_path('../../lib', __FILE__)
+  $:.unshift File.expand_path('../../../activesupport/lib', __FILE__)
+  $:.unshift File.expand_path('../../../actionpack/lib', __FILE__)
+  require 'rails/ruby_version_check'
+end
+
+Signal.trap("INT") { puts; exit }
+
+require 'rails/version'
+require 'rails/generators'
+require 'generators/rspec/scaffold/scaffold_generator'
+
+RSpec::Generators::ScaffoldGenerator.start

data/bin/rspec_skeleton

@@ -0,0 +1,19 @@
+#!/user/local/bin/ruby
+
+begin
+  require 'rails/ruby_version_check'
+rescue LoadError
+  # If people are not using gems, the load path must still
+  # be correct.
+  # TODO: Remove the begin / rescue block somehow
+  $:.unshift File.expand_path('../../lib', __FILE__)
+  $:.unshift File.expand_path('../../../activesupport/lib', __FILE__)
+  $:.unshift File.expand_path('../../../actionpack/lib', __FILE__)
+end
+
+Signal.trap("INT") { puts; exit }
+
+require 'rails/generators'
+require 'generators/rspec/skeleton/skeleton_generator'
+
+RSpec::Generators::SkeletonGenerator.start

data/lib/generators/rspec/controller/USAGE

@@ -0,0 +1,33 @@
+Description:
+    The rspec_controller generator creates stub specs and files for a new
+    controller and its views.
+
+    The generator takes a controller name and a list of views as arguments.
+    The controller name may be given in CamelCase or under_score and should
+    not be suffixed with 'Controller'.  To create a controller within a
+    module, specify the controller name as 'module/controller'.
+
+    The generator creates stubs for a controller (and spec), a view (and spec)
+    for each view in the argument list, plus a helper. 
+
+Example:
+    ./script/generate rspec_controller dog bark fetch
+        ...
+        create  spec/controllers/dog_controller_spec.rb
+        create  app/controllers/dog_controller.rb
+        create  app/helpers/dog_helper.rb
+        create  spec/views/dog/bark_view_spec.rb
+        create  app/views/dog/bark.rhtml
+        create  spec/views/dog/fetch_view_spec.rb
+        create  app/views/dog/fetch.rhtml
+
+Modules Example:
+    ./script/generate rspec_controller 'pets/dog' bark fetch
+        ...
+        create  spec/controllers/pets/dog_controller_spec.rb
+        create  app/controllers/pets/dog_controller.rb
+        create  app/helpers/pets/dog_helper.rb
+        create  spec/views/pets/dog/bark_view_spec.rb
+        create  app/views/pets/dog/bark.rhtml
+        create  spec/views/pets/dog/fetch_view_spec.rb
+        create  app/views/pets/dog/fetch.rhtml

data/lib/generators/rspec/controller/controller_generator.rb

@@ -0,0 +1,125 @@
+require 'generators/rspec_rails3_gen_base'
+
+# ==================
+# TODO: Make hooks for other generators work!!!
+# see 'hook_for'
+# ==================
+
+module RSpec
+  module Generators
+    class ControllerGenerator < NamedBase
+
+      argument :controller_actions, :type => :array, :default => [], :required => false, :banner => 'controller_actions'
+      check_class_collision :suffix => "Controller"
+
+      # attr_accessor :actions
+
+      no_tasks { attr_accessor :actions }
+
+      class_option :singleton, :type => :boolean, :desc => "Supply to create a singleton controller"
+
+      def self.source_root
+        @source_root ||= File.expand_path('../templates', __FILE__)
+      end
+
+      def initialize(*args, &block)
+        super
+        @actions = []
+
+        controller_actions.each do |arg|
+          @actions << arg
+          @actions << 'create' if arg == 'new'
+          @actions << 'update' if arg == 'edit'
+        end
+
+        @actions.uniq!
+
+        if @actions.empty?
+          @actions = all_actions - @actions
+        end
+      end           
+
+      def create_files
+        # Check for class naming collisions.
+        class_collisions class_path, "#{class_name}Controller", "#{class_name}Helper"
+
+        @default_file_extension = "erb"
+
+        # Controller, helper, views, and spec directories.
+        inside 'app' do
+          empty_directory 'controllers'
+          empty_directory 'helpers'
+          empty_directory 'views'
+        end
+        
+        # use hooks instead!
+        
+        # template 'controller.rb', File.join('app/controllers', class_path, "#{file_name}_controller.rb")
+        # template 'helper.rb', File.join('app/helpers', class_path, "#{file_name}_helper.rb")
+
+        html_actions = actions.reject{|a| %w{create update}.include?(a)}
+        # 
+        # html_actions.each do |action|
+        #   @action = action          
+        #   template "views/#{@default_file_extension}/#{action}.html.#{@default_file_extension}", "app/views/#{action}.html.#{@default_file_extension}"
+        # 
+        #   # add '_form' view for new or update action
+        #   if %w{edit new}.include?(action)
+        #     template "views/#{@default_file_extension}/_form.html.#{@default_file_extension}", "app/views/_form.html.#{@default_file_extension}"
+        #   end
+        # end
+          
+        # spec  
+        inside 'spec' do
+          empty_directory 'controllers'
+          empty_directory 'helpers'
+          empty_directory 'views'
+        end
+          
+        # Controller spec, class, and helper.
+        template 'controller_spec.rb', File.join('spec/controllers', class_path, "#{file_name}_controller_spec.rb")        
+        template 'helper_spec.rb.t', File.join('spec/helpers', class_path, "#{file_name}_helper_spec.rb")
+        
+        # Spec and view template for each action.
+        html_actions.each do |action|
+          @action = action
+          target_file = "spec/views/#{file_name}/actions/#{action}_html_#{@default_file_extension}_spec.rb"
+          puts target_file
+          template 'view_spec.rb', target_file
+        end        
+      end
+
+      # hook into controller and helper generators to have them execute using same arguments!
+      # hook_for :controller, :helper
+
+      no_tasks do
+        def all_actions
+          %w[index show new create edit update destroy]
+        end
+
+        def current_action
+          @action || 'unknown'
+        end
+
+
+        def action?(name)
+          actions.include? name.to_s
+        end
+
+        def actions?(*names)
+          names.all? { |name| action? name }
+        end        
+        
+        def class_name
+          name.camelize
+        end
+        
+        
+        def plural_class_name
+          plural_name.camelize
+        end
+      end
+      
+    end # class
+  end # generators
+end # rspec      

data/lib/generators/rspec/controller/templates/actions/create.rb

@@ -0,0 +1,4 @@
+  def create
+    respond_with(@<%= singular_name %> = <%= class_name %>.create(params[:<%= singular_name %>]))      
+  end
+

data/lib/generators/rspec/controller/templates/actions/destroy.rb

@@ -0,0 +1,4 @@
+  def destroy
+    respond_with(@<%= singular_name %> = <%= class_name %>.find(params[:id]))  
+  end
+

data/lib/generators/rspec/controller/templates/actions/edit.rb

@@ -0,0 +1,3 @@
+  def edit
+    respond_with(@<%= singular_name %> = <%= class_name %>.find(params[:id]))  
+  end

data/lib/generators/rspec/controller/templates/actions/index.rb

@@ -0,0 +1,3 @@
+  def index
+    respond_with(@<%= plural_name %> = <%= class_name %>.all)
+  end

data/lib/generators/rspec/controller/templates/actions/new.rb

@@ -0,0 +1,3 @@
+  def new
+    respond_with(@<%= singular_name %> = <%= class_name %>.new)
+  end

data/lib/generators/rspec/controller/templates/actions/show.rb

@@ -0,0 +1,3 @@
+  def show
+    respond_with(@<%= singular_name %> = <%= class_name %>.find(params[:id]))    
+  end

data/lib/generators/rspec/controller/templates/actions/update.rb

@@ -0,0 +1,5 @@
+  def update
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+    @<%= singular_name %>.update_attributes(params[:<%= singular_name %>])
+    respond_with(@<%= singular_name %>)
+  end

data/lib/generators/rspec/controller/templates/controller.rb

@@ -0,0 +1,4 @@
+class <%= plural_class_name %>Controller < ApplicationController::Base  
+  respond_to :html, :xml, :json
+  <%#= controller_methods :actions %>
+end

data/lib/generators/rspec/controller/templates/controller_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe <%= class_name %>Controller do
+
+<% if actions.empty? -%>
+  #Delete this example and add some real ones
+<% else -%>
+  #Delete these examples and add some real ones
+<% end -%>
+  it "should use <%= class_name %>Controller" do
+    controller.should be_an_instance_of(<%= class_name %>Controller)
+  end
+
+<% unless actions.empty? -%>
+<% for action in actions -%>
+
+  describe "GET '<%= action %>'" do
+    it "should be successful" do
+      get '<%= action %>'
+      response.should be_success
+    end
+  end
+<% end -%>
+<% end -%>
+end

data/lib/generators/rspec/controller/templates/helper.rb

@@ -0,0 +1,2 @@
+module <%= plural_class_name %>Helper
+end

data/lib/generators/rspec/controller/templates/helper_spec.erb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe <%= class_name %>Helper do
+
+  # Delete this example and add some real ones or delete this file
+  it "should be included in the object returned by #helper" do
+    included_modules = (class << helper; self; end).send :included_modules
+    included_modules.should include(<%= class_name %>Helper)
+  end
+
+end

data/lib/generators/rspec/controller/templates/view_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "/<%= class_name.underscore %>/<%= current_action %>" do
+  before(:each) do
+    render '<%= class_name.underscore %>/<%= current_action %>'
+  end
+
+  #Delete this example and add some real ones or delete this file
+  it "should tell you where to find the file" do
+    response.should have_tag('p', %r[Find me in app/views/<%= class_name.underscore %>/<%= current_action %>])
+  end
+end

data/lib/generators/rspec/controller/templates/views/erb/_form.html.erb

@@ -0,0 +1,4 @@
+<%% form_for @<%= singular_name %> do |f| %>
+  <%%= f.error_messages %>
+  <p><%%= f.submit "Submit" %></p>
+<%% end %>

data/lib/generators/rspec/controller/templates/views/erb/edit.html.erb

@@ -0,0 +1,14 @@
+<%% title "Edit <%= singular_name.titleize %>" %>
+
+<%= render_form %>
+
+<%- if actions? :show, :index -%>
+<p>
+<%- if action? :show -%>
+  <%%= link_to "Show", @<%= singular_name %> %> |
+<%- end -%>
+<%- if action? :index -%>
+  <%%= link_to "View All", <%= plural_name %>_path %>
+<%- end -%>
+</p>
+<%- end -%>

data/lib/generators/rspec/controller/templates/views/erb/index.html.erb

@@ -0,0 +1,10 @@
+<%% title "<%= plural_name.titleize %>" %>
+
+<table>
+  <tr>
+  </tr>
+</table>
+
+<%- if action? :new -%>
+<p><%%= link_to "New <%= singular_name.titleize %>", new_<%= singular_name %>_path %></p>
+<%- end -%>

data/lib/generators/rspec/controller/templates/views/erb/new.html.erb

@@ -0,0 +1,7 @@
+<%% title "New <%= singular_name.titleize %>" %>
+
+<%= render_form %>
+
+<%- if action? :index -%>
+<p><%%= link_to "Back to List", <%= plural_name %>_path %></p>
+<%- end -%>

data/lib/generators/rspec/controller/templates/views/erb/show.html.erb

@@ -0,0 +1,13 @@
+<%% title "<%= singular_name.titleize %>" %>
+
+<p>
+<%- if action? :edit -%>
+  <%%= link_to "Edit", edit_<%= singular_name %>_path(@<%= singular_name %>) %> |
+<%- end -%>
+<%- if action? :destroy -%>
+  <%%= link_to "Destroy", @<%= singular_name %>, :confirm => 'Are you sure?', :method => :delete %> |
+<%- end -%>
+<%- if action? :index -%>
+  <%%= link_to "View All", <%= plural_name %>_path %>
+<%- end -%>
+</p>

data/lib/generators/rspec/controller/templates/views/haml/_form.html.haml

@@ -0,0 +1,4 @@
+- form_for @<%= singular_name %> do |f|
+  = f.error_messages
+  %p
+    = f.submit "Submit"

data/lib/generators/rspec/controller/templates/views/haml/edit.html.haml

@@ -0,0 +1,14 @@
+- title "Edit <%= singular_name.titleize %>"
+
+<%= render_form %>
+
+<%- if actions? :show, :index -%>
+%p
+  <%- if action? :show -%>
+  = link_to "Show", <%= singular_name %>_path(@<%= singular_name %>)
+  |
+  <%- end -%>
+  <%- if action? :index -%>
+  = link_to "View All", <%= plural_name %>_path
+  <%- end -%>
+<%- end -%>

data/lib/generators/rspec/controller/templates/views/haml/index.html.haml

@@ -0,0 +1,8 @@
+- title "<%= plural_name.titleize %>"
+
+%table
+  %tr
+
+<%- if actions? :new -%>
+%p= link_to "New <%= singular_name.titleize %>", new_<%= singular_name %>_path
+<%- end -%>

data/lib/generators/rspec/controller/templates/views/haml/new.html.haml

@@ -0,0 +1,7 @@
+- title "New <%= singular_name.titleize %>"
+
+<%= render_form %>
+
+<%- if action? :index -%>
+%p= link_to "Back to List", <%= plural_name %>_path
+<%- end -%>

data/lib/generators/rspec/controller/templates/views/haml/show.html.haml

@@ -0,0 +1,14 @@
+- title "<%= singular_name.titleize %>"
+
+%p
+  <%- if action? :edit -%>
+  = link_to "Edit", edit_<%= singular_name %>_path(@<%= singular_name %>)
+  |
+  <%- end -%>
+  <%- if action? :destroy -%>
+  = link_to "Destroy", @<%= singular_name %>, :confirm => 'Are you sure?', :method => :delete
+  |
+  <%- end -%>
+  <%- if action? :index -%>
+  = link_to "View All", <%= plural_name %>_path
+  <%- end -%>

data/lib/generators/rspec/default_values.rb

@@ -0,0 +1,28 @@
+module Rails
+  module Generators
+    class GeneratedAttribute
+      def default_value
+        @default_value ||= case type
+          when :int, :integer               then "1"
+          when :float                       then "1.5"
+          when :decimal                     then "9.99"
+          when :datetime, :timestamp, :time then "Time.now"
+          when :date                        then "Date.today"
+          when :string, :text               then "\"value for #{@name}\""
+          when :boolean                     then "false"
+          when :belongs_to, :references     then "1"
+          else
+            ""
+        end
+      end
+
+      def name_or_reference
+        if ::Rails::VERSION::STRING >= '2.2'
+          reference? ? :"#{name}_id" : name
+        else
+          name
+        end
+      end
+    end
+  end
+end

data/lib/generators/rspec/integration_spec/USAGE

@@ -0,0 +1,19 @@
+Description:
+    This is the rspec:integration_spec generator. It is also available as a global executable rspec_integration_spec.    
+    This generator creates an integration specification for a Rails application.
+
+    The generator creates an integration specification in spec/integration with the name of the controller postfixed with _spec.
+    Like any other RSpec specification, the spec is a ruby file with a standard .rb extension.
+
+Example: Generator
+    ./script/generate rspec:integration_spec person
+
+    This will create an integration specification for person:
+        Spec:      spec/integration/people_spec.rb
+
+Example: Executable
+    rspec_integration_spec person
+    
+    This will create an integration specification for person:
+        Spec:      spec/integration/people_spec.rb
+    

data/lib/generators/rspec/integration_spec/integration_spec_generator.rb

@@ -0,0 +1,13 @@
+# Author: Kristian Mandrup
+# email: kmandrup@gmail.com
+require 'generators/rspec_rails3_gen_base'
+module RSpec
+  module Generators
+    class IntegrationSpecGenerator < NamedBase
+  
+      def create_files
+        template "integration_spec.rb" , File.join('spec/integration', class_path, "#{class_name.tableize}_spec.rb")
+      end  
+    end
+  end
+end

data/lib/generators/rspec/integration_spec/templates/integration_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe "<%= class_name.pluralize %>" do
+end

data/lib/generators/rspec/model/USAGE

@@ -0,0 +1,18 @@
+Description:
+    The rspec_model generator creates stubs for a new model.
+
+    The generator takes a model name as its argument.  The model name may be
+    given in CamelCase or under_score and should not be suffixed with 'Model'.
+
+    The generator creates a model class in app/models, an RSpec spec in
+    spec/models, database fixtures in spec/fixtures/plural_name.yml, and a migration
+    in db/migrate.
+
+Example:
+    ./script/generate rspec_model Account
+
+    This will create an Account model:
+        Model:      app/models/account.rb
+        Spec:       spec/models/account_spec.rb
+        Fixtures:   spec/fixtures/accounts.yml
+        Migration:  db/migrate/XXX_add_accounts.rb