rspec_for_generators 0.2.0

data/lib/rspec_for_generators/rails_helpers/rails_mailer.rb

@@ -0,0 +1,29 @@
+module RSpec  
+  module Rails
+    module Mailer
+      def create_mailer name, content
+        file = mailer_file_name(name)
+        unless File.exist?(file)    
+          FileUtils.mkdir_p File.dirname(file)
+          File.open(file, 'w') do |f|  
+            f.puts content
+          end
+        end
+      end  
+
+      def remove_mailer name
+        file = mailer_file_name(name)
+        FileUtils.rm_f(file) if File.exist?(file)
+      end
+
+      def remove_mailers *names
+        names.each{|name| remove_mailer name }
+      end      
+      
+      def mailer_file_name name
+        File.join(::Rails.root, "app/mailers/#{name}.rb")
+      end        
+      
+    end
+  end
+end

data/lib/rspec_for_generators/rails_helpers/rails_model.rb

@@ -0,0 +1,94 @@
+module RSpec  
+  module Rails
+    module Model
+      module ActiveRecord
+        def file_content name
+          %Q{class #{name.camelize} < ActiveRecord::Base
+          end}
+        end
+      end
+
+      module MongoMapper
+        def file_content name
+          %Q{class #{name.camelize}
+            include MongoMapper::Document
+          end}
+        end
+        
+        def field name, type = nil
+          return "key :#{name}, #{type}" if type
+          "key :#{name}"
+        end
+      end
+
+      module Mongoid
+        def file_content name
+          %Q{class #{name.camelize}
+            include Mongoid::Document
+          end}
+        end
+        
+        def field name, type = nil
+          return "field :#{name}, :type => #{type}" if type
+          "field :#{name}"
+        end        
+      end
+
+      module DataMapper
+        def file_content name
+          %Q{class #{name.camelize}
+            include DataMapper::Resource
+          end}
+        end
+        
+        def field name, type = nil
+          return "property :#{name}, #{type}" if type
+          "property :#{name}"
+        end        
+      end
+
+      def set_orm orm
+        orm_module = case orm
+        when :active_record
+          ActiveRecord
+        when :data_mapper
+          DataMapper
+        when :mongo_mapper
+          MongoMapper
+        when :mongoid
+          Mongoid
+        end
+        include orm_module
+      end
+      
+      def create_model name, &block
+        file =  model_file_name(name)
+        unless File.exist?(file)    
+          FileUtils.mkdir_p File.dirname(file)
+          File.open(file, 'w') do |f|  
+            f.puts file_content(name)
+            yield f if block_given?
+          end
+        end
+      end  
+
+      def remove_model name
+        file = model_file_name(name)
+        FileUtils.rm_f(file) if File.exist?(file)
+      end
+
+      def remove_models *names
+        names.each{|name| remove_model name }
+      end      
+      
+      def model_file_name name
+        File.join(::Rails.root, "app/models/#{name}.rb")
+      end        
+    end
+  end
+end
+
+def model_helper_for orm
+  include RSpec::Rails::Model
+  set_orm orm
+end

data/lib/rspec_for_generators/rails_helpers/rails_view.rb

@@ -0,0 +1,29 @@
+module RSpec  
+  module Rails
+    module View
+      def create_view name, content
+        file = view_file_name(name)
+        unless File.exist?(file)    
+          FileUtils.mkdir_p File.dirname(file)
+          File.open(file, 'w') do |f|  
+            f.puts content
+          end
+        end
+      end  
+
+      def remove_view name
+        file = view_file_name(name)
+        FileUtils.rm_f(file) if File.exist?(file)
+      end
+
+      def remove_views *names
+        names.each{|name| remove_view name }
+      end      
+      
+      def view_file_name name
+        File.join(::Rails.root, "app/views/#{name}.rb")
+      end        
+      
+    end
+  end
+end

data/lib/rspec_for_generators/rails_spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rspec_for_generators/rails_helpers/all'
+
+class TestApp < Rails::Application
+  raise StandardError, "You must define a location for Rails.config_root_dir" if !Rails.config_root_dir
+  config.root = Rails.config_root_dir
+end
+
+module Rails
+  def self.root
+    raise StandardError, "You must define a location for Rails.config_root_dir" if !Rails.config_root_dir    
+    @root ||= File.expand_path(File.join(Rails.config_root_dir, '..', 'tmp', 'rails'))
+  end
+end
+
+Rails.application = TestApp
+Rails.application.config.root = Rails.root
+

data/lib/rspec_for_generators/rspec_test_case.rb

@@ -0,0 +1,26 @@
+module RSpec         
+  module Generators
+    class TestCase < ::Rails::Generators::TestCase   
+      setup :prepare_destination
+      # setup :copy_routes
+      destination File.join(::Rails.root)      
+            
+      def initialize(test_method_name)
+        @method_name = test_method_name
+        @test_passed = true
+        @interrupted = false
+        routes_file = File.join(File.dirname(__FILE__), 'fixtures', 'routes.rb')        
+        copy_routes routes_file
+      end 
+      
+      def copy_routes routes_file        
+        routes = File.expand_path(routes_file)
+        raise ArgumentError, "No routes file exists at #{routes_file}" if !File.exist?(routes)
+        destination = File.join(::Rails.root, "config")
+        FileUtils.mkdir_p(destination) # create dir
+        FileUtils.cp routes, destination # copy
+      end
+           
+    end
+  end
+end

data/rspec_for_generators.gemspec

@@ -0,0 +1,96 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rspec_for_generators}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2010-08-03}
+  s.description = %q{RSpec 2 matchers, helpers and utils to assist in writing generator specs}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/generators/demo/demo_generator.rb",
+     "lib/rspec_for_generators.rb",
+     "lib/rspec_for_generators/fixtures/routes.rb",
+     "lib/rspec_for_generators/generator_spec_helper.rb",
+     "lib/rspec_for_generators/main.rb",
+     "lib/rspec_for_generators/matchers/content/all.rb",
+     "lib/rspec_for_generators/matchers/content/have_class.rb",
+     "lib/rspec_for_generators/matchers/content/have_method.rb",
+     "lib/rspec_for_generators/matchers/content/have_module.rb",
+     "lib/rspec_for_generators/matchers/content/include_module.rb",
+     "lib/rspec_for_generators/matchers/content/inherit_from.rb",
+     "lib/rspec_for_generators/matchers/file/all.rb",
+     "lib/rspec_for_generators/matchers/file/generate_file.rb",
+     "lib/rspec_for_generators/matchers/file/generate_migration.rb",
+     "lib/rspec_for_generators/matchers/helpers/content.rb",
+     "lib/rspec_for_generators/matchers/helpers/file.rb",
+     "lib/rspec_for_generators/rails_helpers/all.rb",
+     "lib/rspec_for_generators/rails_helpers/rails_app.rb",
+     "lib/rspec_for_generators/rails_helpers/rails_controller.rb",
+     "lib/rspec_for_generators/rails_helpers/rails_helper.rb",
+     "lib/rspec_for_generators/rails_helpers/rails_mailer.rb",
+     "lib/rspec_for_generators/rails_helpers/rails_model.rb",
+     "lib/rspec_for_generators/rails_helpers/rails_view.rb",
+     "lib/rspec_for_generators/rails_spec_helper.rb",
+     "lib/rspec_for_generators/rspec_test_case.rb",
+     "rspec_for_generators.gemspec",
+     "spec/rspec_for_generators/rspec_for_generators_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tmp/rails/config/routes.rb",
+     "wiki/Custom Rails 3 Generators.textile"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/rspec_for_generators}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{RSpec 2 matchers, helpers and utils for writing generator specs}
+  s.test_files = [
+    "spec/rspec_for_generators/rspec_for_generators_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta19"])
+      s.add_runtime_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+      s.add_runtime_dependency(%q<rake>, [">= 0.8.7"])
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.0.rc"])
+      s.add_runtime_dependency(%q<test-unit>, [">= 2.0.9"])
+      s.add_runtime_dependency(%q<require_all>, [">= 1.1.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta19"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+      s.add_dependency(%q<rake>, [">= 0.8.7"])
+      s.add_dependency(%q<rails>, [">= 3.0.0.rc"])
+      s.add_dependency(%q<test-unit>, [">= 2.0.9"])
+      s.add_dependency(%q<require_all>, [">= 1.1.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta19"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+    s.add_dependency(%q<rake>, [">= 0.8.7"])
+    s.add_dependency(%q<rails>, [">= 3.0.0.rc"])
+    s.add_dependency(%q<test-unit>, [">= 2.0.9"])
+    s.add_dependency(%q<require_all>, [">= 1.1.0"])
+  end
+end
+

data/spec/rspec_for_generators/rspec_for_generators_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'generators/demo/demo_generator'
+
+describe 'model_generator' do
+  include RSpec::Rails::Model
+  include RSpec::Rails::Model::ActiveRecord
+  
+  before :each do              
+    RSpec::Generator.setup_generator 'model_generator' do
+      tests DemoGenerator
+    end    
+    remove_model 'account'    
+  end
+
+  after :each do              
+    remove_model 'account'    
+  end
+    
+  it "should not work without an Account model file" do            
+    RSpec::Generator.with_generator do |g|   
+      name = 'account'
+      g.run_generator %w{account}
+      g.should_not generate_file name, :model
+    end
+  end
+
+  it "should decorate an existing Account model file with include Canable:Ables" do            
+    RSpec::Generator.with_generator do |g|  
+      name = 'account'
+      create_model name     
+      g.run_generator %w{account}
+      g.should generate_file name, :model do |content|
+        content.should have_class name.camelize do |klass|
+          klass.should include_module 'Canable::Ables'
+        end
+      end
+    end
+  end
+
+end
+
+
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'rspec/autorun'     
+
+module Rails
+  def self.config_root_dir
+    File.dirname(__FILE__)
+  end
+end
+
+require 'rspec_for_generators'

data/tmp/rails/config/routes.rb

@@ -0,0 +1,2 @@
+TestApp.routes.draw do |map|
+end

data/wiki/Custom Rails 3 Generators.textile

@@ -0,0 +1,110 @@
+h2. Custom generators
+
+<pre>
+# my_plugin/lib/generators/install_generator.rb
+module MyGem
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    # all public methods in here will be run in order
+    def add_my_initializer
+      template "initializer.rb", "config/initializers/my_gem_initializer.rb"
+    end
+  end
+end  
+</pre>
+
+If you inherit from NamedBase, you will have access to several inflections of the name passed in both in the body of your generator class, as well as in your templates.
+
+* class_path and file_name are extracted from the name passed in. For instance, if the user passes in admin/posts, the class_path is admin and the file_name is posts
+* file_path is the class_path and file_name joined by /
+* class_name is the file_path, camelized. For instance, admin/posts becomes Admin::Posts
+* human_name is the file_name, humanized. For instance, admin_posts would become Admin posts
+* plural_name is the file_name, pluralized. For instance, post becomes posts
+* i18n_scope is the file_path, with / replaced with .. For instance, admin/posts becomes admin.posts
+
+<pre>
+# my_plugin/lib/generators/templates/initializer.rb
+Rails.application.configure do
+  # Uncomment this to turn on verbose mode
+  # config.my_gem.verbose = true
+end  
+</pre>
+  
+h2. Overriding and replacing built-in Rails 3 generator
+
+Simply inherit from the generator you want to replace and change the template source root to your own template directory
+<pre>
+require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
+module Rails
+  module Generators
+    class RespondersControllerGenerator < ScaffoldControllerGenerator
+      def self.source_root
+        @_source_root ||= File.expand_path("templates", File.dirname(__FILE__))
+      end
+
+    protected
+
+      def flash?
+        !ApplicationController.responder.ancestors.include?(Responders::FlashResponder)
+      end
+    end
+  end
+end
+</pre>        
+
+To hook a generator into Rails scaffold, all you need to do is to create a Rails::Railtie, which was also introduced in Rails 3. 
+The responders gem *railtie* is only a few lines of code:
+
+<pre>
+module Responders
+  class Railtie < ::Rails::Railtie
+    config.responders = ActiveSupport::OrderedOptions.new
+    config.generators.scaffold_controller = :responders_controller # important! signifies override by ResponderControllerGenerator
+
+    initializer "responders.flash_responder" do |app|
+      if app.config.responders.flash_keys
+        Responders::FlashResponder.flash_keys = app.config.responders.flash_keys
+      end
+    end
+  end
+end
+</pre>
+
+The first line sets an instance of ActiveSupport::OrderedOptions at config.responders. This allows you to do the following inside your 
+Rails::Application at <code>config/application.rb</code>
+
+<pre>
+# config/application.rb
+module Rails
+  class Blog < Rails::Application
+    config.responders.flash_keys = [:success, :failure]
+  end
+end
+</pre>     
+
+The second line is where the generator configuration happens. In case you are wondering, the config.generators object available in 
+Rails::Railtie is exactly the same object as the one in our Rails::Application. 
+That said, any gem can configure and manipulate the whole generators workflow in the application.
+
+In Rails 3, gems are loaded before your application initializes. This is quite easy to notice if you look at the config/application.rb  file:
+
+<pre>
+# config/application.rb
+
+require File.expand_path('../boot', __FILE__)
+require 'rails/all'
+
+# If you have a Gemfile, require the gems listed there, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env) if defined?(Bundler)
+
+module Foo
+  class Application < Rails::Application
+</pre>
+
+By requiring gems earlier, Rails 3 can give more power to gems because we are sure that the final configuration value will be set by the application developer. The official API for configuring a Rails application is a Rails::Railtie as we just saw above. There is much more you can do inside a railtie, like configuring the middleware stack or any other Rails framework. Since all Rails frameworks (like Active Record, Active Resource, Action Pack…) are also railties, they are a great source of knowledge in case you are interested in learning more.
+
+If we want to customize the _form  partial generated on scaffold, all you need to do is to copy the _form  partial template from Rails source code to lib/templates/erb/scaffold/_form.html.erb.
+
+If you want to customize the show view, you just need to copy it as well, and this is true for all generators and all templates! This allows generators to grow and adapt as your application changes! For example, the simple form gem creates a template to change scaffold to use the simple_form_for instead of form_for.