objective_spec 0.2.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+*.tmproj

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Blake Watters
+
+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,13 @@
+= Objective Spec
+Author: Blake Watters <blake@objective3.com>
+
+Additional RSpec testing goodness for Rails from Objective 3.
+
+Includes:
+  * An example group for testing Mailers
+  * Infrastructure for matchers and spec_helpers
+  * Disable asset timestamping during spec runs
+
+== Copyright
+
+Copyright (c) 2009 Objective 3. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "objective_spec"
+    gem.summary = "A set of extensions to RSpec for building Rails applications against Objective Spec"
+    gem.email = "blake@objective3.com"
+    gem.homepage = "http://github.com/Objective3/objective_spec"
+    gem.authors = ["Blake Watters"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "objective_spec #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+task :rebuild do
+  if File.exist?('VERSION')
+    version = File.read('VERSION').chomp
+  else
+    puts "Unable to rebuild -- no VERSION.yml found"
+    exit 1
+  end
+  command = "sudo gem uninstall objective_spec; rake gemspec; rm objective_spec-#{version}.gem objective_spec.gemspec ; rake gemspec; gem build objective_spec.gemspec && sudo gem install objective_spec-#{version}.gem"
+  puts(`#{command}`)  
+end

data/TODO

@@ -0,0 +1,6 @@
+= TODO
+  * Write generator for spec_helpers
+  * Write generator for matchers
+  * Write generator for mailer specs
+  * Add harness for observer specs
+  * Write generator for observer specs

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/generators/objective_controller/USAGE

@@ -0,0 +1,33 @@
+Description:
+    The objective_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 objective_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.html.haml
+        create  spec/views/dog/fetch_view_spec.rb
+        create  app/views/dog/fetch.html.haml
+
+Modules Example:
+    ./script/generate objective_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.html.haml
+        create  spec/views/pets/dog/fetch_view_spec.rb
+        create  app/views/pets/dog/fetch.html.haml

data/generators/objective_controller/objective_controller_generator.rb

@@ -0,0 +1,45 @@
+require 'rails_generator/generators/components/controller/controller_generator'
+
+class ObjectiveControllerGenerator < ControllerGenerator
+
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, "#{class_name}Controller", "#{class_name}Helper"
+
+      # Controller, helper, views, and spec directories.
+      m.directory File.join('app/controllers', class_path)
+      m.directory File.join('app/helpers', class_path)
+      m.directory File.join('app/views', class_path, file_name)
+      m.directory File.join('spec/controllers', class_path)
+      m.directory File.join('spec/helpers', class_path)
+      m.directory File.join('spec/views', class_path, file_name)
+
+      @default_file_extension = "html.haml"
+
+      # Controller spec, class, and helper.
+      m.template 'controller_spec.rb',
+        File.join('spec/controllers', class_path, "#{file_name}_controller_spec.rb")
+
+      m.template 'helper_spec.rb',
+        File.join('spec/helpers', class_path, "#{file_name}_helper_spec.rb")
+
+      m.template 'controller:controller.rb',
+        File.join('app/controllers', class_path, "#{file_name}_controller.rb")
+
+      m.template 'controller:helper.rb',
+        File.join('app/helpers', class_path, "#{file_name}_helper.rb")
+
+      # Spec and view template for each action.
+      actions.each do |action|
+        m.template 'view_spec.rb',
+          File.join('spec/views', class_path, file_name, "#{action}.#{@default_file_extension}_spec.rb"),
+          :assigns => { :action => action, :model => file_name }
+        path = File.join('app/views', class_path, file_name, "#{action}.#{@default_file_extension}")
+        m.template "view.html.haml",
+          path,
+          :assigns => { :action => action, :path => path }
+      end
+    end
+  end
+end

data/generators/objective_controller/templates/controller_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../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/generators/objective_controller/templates/helper_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../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/generators/objective_controller/templates/view.html.haml

@@ -0,0 +1,3 @@
+%h1 <%= class_name %>#<%= action %>
+%p
+  Find me in <%= path %>

data/generators/objective_controller/templates/view_spec.rb

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

data/generators/objective_model/objective_model_generator.rb

@@ -0,0 +1,40 @@
+require 'rails_generator/generators/components/model/model_generator'
+require File.dirname(__FILE__) + '/../rspec_default_values'
+
+class ObjectiveModelGenerator < ModelGenerator
+
+  def manifest
+
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, class_name
+
+      # Model, spec, and fixture directories.
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('spec/models', class_path)
+
+      # Model class, spec and fixtures.
+      m.template 'model:model.rb',      File.join('app/models', class_path, "#{file_name}.rb")
+      m.template 'model_spec.rb',       File.join('spec/models', class_path, "#{file_name}_spec.rb")
+
+      unless options[:skip_migration]
+        m.migration_template 'model:migration.rb', 'db/migrate', :assigns => {
+          :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}"
+        }, :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
+      end
+      
+      model_factory = "\n\nFactory.define(:#{file_name}) do |f|\n"
+      for attribute in attributes
+        model_factory << "\tf.#{attribute.name} #{attribute.default_value}\n"
+      end
+      model_factory << "end\n"
+      append_file("spec/factories.rb", model_factory)
+      
+    end
+  end
+  
+  def append_file(path, data)
+    File.open(path, 'ab') { |file| file.write(data) }
+  end
+  
+end

data/generators/objective_model/templates/model_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../spec_helper')
+
+describe <%= class_name %> do
+  before(:each) do
+    @valid_attributes = {
+      <%= attributes.map{|a| ":#{a.name_or_reference} => #{a.default_value}" }.join(",\n      ") %>
+    }
+  end
+
+  it "should create a new instance given valid attributes" do
+    <%= class_name %>.create!(@valid_attributes)
+  end
+end

data/generators/objective_observer/objective_observer_generator.rb

@@ -0,0 +1,16 @@
+class ObjectiveObserverGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions "#{class_name}Observer"
+
+      # Observer, and test directories.
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('spec/observers', class_path)
+
+      # Observer class and unit test fixtures.
+      m.template 'observer.rb',   File.join('app/models', class_path, "#{file_name}_observer.rb")
+      m.template 'observer_spec.rb',  File.join('spec/observers', class_path, "#{file_name}_observer_spec.rb")
+    end
+  end
+end

data/generators/objective_observer/templates/observer.rb

@@ -0,0 +1,2 @@
+class <%= class_name %>Observer < ActiveRecord::Observer
+end

data/generators/objective_observer/templates/observer_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../spec_helper')
+
+describe <%= class_name %>Observer do
+  
+  it "should observe <%= class_name %>" do
+    <%= file_name %> = Factory(:<%= file_name %>)
+    observer = <%= class_name %>Observer.instance
+    observer.after_create(<%= file_name %>)
+  end
+  
+end

data/generators/objective_resource/objective_resource_generator.rb

@@ -0,0 +1,172 @@
+class ObjectiveResourceGenerator < Rails::Generator::NamedBase
+  attr_reader   :controller_name,
+                :controller_class_path,
+                :controller_file_path,
+                :controller_class_nesting,
+                :controller_class_nesting_depth,
+                :controller_class_name,
+                :controller_singular_name,
+                :controller_plural_name,
+                :resource_edit_path,
+                :default_file_extension,
+                :generator_default_file_extension
+  alias_method  :controller_file_name,  :controller_singular_name
+  alias_method  :controller_table_name, :controller_plural_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+
+    if has_rspec?
+      if ActionController::Base.respond_to?(:resource_action_separator)
+        @resource_edit_path = "/edit"
+      else
+        @resource_edit_path = ";edit"
+      end
+    else
+      raise "You do not have rspec installed. WTF are you doing?"
+    end
+    
+    raise "You don't have haml installed, WTF are you, a joker?" unless defined?(Haml)
+    @generator_default_file_extension = "haml"
+    @default_file_extension = "html.#{@generator_default_file_extension}"
+    
+    @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_singular_name, @controller_plural_name = inflect_names(base_name)
+
+    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_path, "#{controller_class_name}Controller", "#{controller_class_name}Helper")
+      m.class_collisions(class_path, "#{class_name}")
+
+      # Controller, helper, views, and test 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('spec/controllers', controller_class_path))
+      m.directory(File.join('spec/helpers', class_path))
+      m.directory(File.join('spec/models', class_path))
+      m.directory File.join('spec/views', controller_class_path, controller_file_name)
+      
+      scaffold_views.each do |action|
+        m.template(
+          "view_#{action}.#{generator_default_file_extension}",
+          File.join('app/views', controller_class_path, controller_file_name, "#{action}.#{default_file_extension}")
+        )
+      end
+
+      m.template('model.rb', File.join('app/models', class_path, "#{file_name}.rb"))
+      m.template('controller.rb', File.join('app/controllers', controller_class_path, "#{controller_file_name}_controller.rb"))
+      m.template('helper.rb',          File.join('app/helpers',     controller_class_path, "#{controller_file_name}_helper.rb"))
+
+      m.template('rspec/functional_spec.rb',  File.join('spec/controllers', controller_class_path, "#{controller_file_name}_controller_spec.rb"))
+      m.template('rspec/routing_spec.rb',     File.join('spec/controllers', controller_class_path, "#{controller_file_name}_routing_spec.rb"))
+      m.template('rspec/helper_spec.rb',      File.join('spec/helpers',     class_path, "#{controller_file_name}_helper_spec.rb"))
+      m.template('rspec/unit_spec.rb',        File.join('spec/models',      class_path, "#{file_name}_spec.rb"))
+      
+      #Use Factories instead of fixtures
+      model_factory = "\n\nFactory.define(:#{file_name}) do |f|\n"
+      for attribute in attributes
+        model_factory << "\tf.#{attribute.name} #{attribute.default_value}\n"
+      end
+      model_factory << "end\n"
+      append_file("spec/factories.rb", model_factory)
+
+      rspec_views.each do |action|
+        m.template(
+          "rspec/views/#{action}_spec.rb",
+          File.join('spec/views', controller_class_path, controller_file_name, "#{action}_spec.rb")
+        )
+      end
+
+
+      unless options[:skip_migration]
+        migration_template = 'migration.rb'
+        
+        m.migration_template(
+          migration_template, 'db/migrate', 
+          :assigns => {
+            :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}",
+            :attributes     => attributes
+          }, 
+          :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
+        )
+      end
+
+      m.route_resources controller_file_name
+    end
+  end
+
+  # Lifted from Rick Olson's restful_authentication
+  def has_rspec?
+    options[:rspec] || (File.exist?('spec') && File.directory?('spec'))
+  end
+  
+  protected
+    # Override with your own usage banner.
+    def banner
+      "Usage: #{$0} scaffold_resource ModelName [field:type, field:type]"
+    end
+
+    def rspec_views
+      %w[ index show new edit ]
+    end
+    
+    def scaffold_views
+      rspec_views + %w[ _form ]
+    end
+
+    def model_name 
+      class_name.demodulize
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--rspec", "Force rspec mode (checks for RAILS_ROOT/spec by default)") { |v| options[:rspec] = true }
+    end
+    
+    def append_file(path, data)
+      File.open(path, 'ab') { |file| file.write(data) }
+    end
+end
+
+module Rails
+  module Generator
+    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                      then "\"MyString\""
+          when :text                        then "\"MyText\""
+          when :boolean                     then "false"
+          else
+            ""
+        end      
+      end
+
+      def input_type
+        @input_type ||= case type
+          when :text                        then "textarea"
+          else
+            "input"
+        end      
+      end
+    end
+  end
+end

data/generators/objective_resource/templates/controller.rb

@@ -0,0 +1,2 @@
+class <%= controller_class_name %>Controller < ResourceController::Base
+end

data/generators/objective_resource/templates/helper.rb

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

data/generators/objective_resource/templates/migration.rb

@@ -0,0 +1,15 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %>, :force => true do |t|
+<% for attribute in attributes -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/generators/objective_resource/templates/model.rb

@@ -0,0 +1,2 @@
+class <%= class_name %> < ActiveRecord::Base
+end