focus-generator 0.0.1

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ryan Bates
+
+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,109 @@
+= Fcus Generators
+
+A collection of useful Rails generator scripts for scaffolding, layout files, authentication, and more.
+
+
+== Setup
+
+=== Rails 3
+
+Add the gem to your Gemfile.
+
+  gem "focus-generator", :group => :development
+
+Then you can run any of the included generators.
+
+  rails g fcus:scaffold Recipe name:string index new
+
+=== Rails 2
+
+First install the gem.
+
+  gem install focus-generator
+
+The generators will be available in all Rails applications. To run the generator, go to your rails project directory and call it using the script/generate or script/destroy command.
+
+  script/generate fcus_scaffold Recipe name:string index new
+
+Note an underscore is used instead of a colon for the Rails 2 generators.
+
+
+== Included Generators
+
+* fcus:layout: generates generic layout, stylesheet, and helper files.
+* fcus:scaffold: generates a controller and optional model/migration.
+* fcus:config: generates a config YAML file and loader.
+* fcus:authentication: generates user model with sign up and log in.
+
+To view the README for each generator, run it with the +help+ option.
+
+  rails g fcus:layout --help
+
+
+== Troubleshooting and FAQs
+
+<b>What is the difference between fcus:scaffold and built-in scaffold?</b>
+
+One of the primary differences is that fcus:scaffold allows you to choose which controller actions to generate.
+
+  rails g fcus:scaffold post name:string index new edit
+
+There are a few changes to the generated code as well, such as no XML format by default.
+
+It also offers support for HAML, Shoulda, and RSpec.
+
+
+<b>I get "undefined method 'title'" error.</b>
+
+Try running fcus:layout, that will generate this helper method. Or you can just change the templates to whatever approach you prefer for setting the title.
+
+
+<b>I can't set new attributes in my model.</b>
+
+Add the attribute to the attr_accessible line in the model.
+
+
+<b>I get "undefined method 'root_url'" error.</b>
+
+Some generators default redirecting to the root_url. Set this in your routes.rb file like this (substituting your controller name).
+
+  root :to => "home#index"
+
+
+<b>I get a missing database error.</b>
+
+Run <tt>rake db:migrate</tt>.
+
+
+<b>I get a routing error when I try to submit a form.</b>
+
+Try restarting your development server. Sometimes it doesn't detect the change in the routing.
+
+
+<b>The tests/specs don't work.</b>
+
+Make sure you have mocha installed and require it in your spec/test helper.
+
+  gem install mocha
+
+  # in spec_helper.rb
+  config.mock_with :mocha
+
+  # in test_helper.rb
+  require 'mocha'
+
+Also, make sure you're using Rails 2.1 or greater.
+
+
+== Found a bug?
+
+If you are having a problem with Fcus Generators, first look at the FAQs above. If you still cannot resolve it, please submit an issue here.
+
+http://github.com/lihaoalbert/focus-generator/issues
+
+
+== Development
+
+If you want to contribute to this project, you can download the Git repository and get the Cucumber features running by calling +bundle+ then +rake+. I normally develop this using Ruby 1.9.2 however it should work with 1.8.7 as well.
+
+The Rails 3 generators are located under <tt>lib/generators</tt> and are tested with Cucumber. The older Rails 2 generators are under <tt>rails_generators</tt> and are tested with Shoulda under the <tt>test</tt> directory.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'rake'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format progress"
+end
+
+task :default => :features

data/features/fcus_authentication.feature

@@ -0,0 +1,80 @@
+Feature: Fcus Authentication Generator
+  In order to authenticate users
+  As a rails developer
+  I want to generate some user authentication
+
+  Scenario: Generate default authentication
+    Given a new Rails app
+    When I insert "root :to => 'users#new'" into "config/routes.rb" after line 1
+    And I run "rails g fcus:authentication"
+    Then I should see the following files
+      | app/models/user.rb                          |
+      | app/controllers/users_controller.rb         |
+      | app/helpers/users_helper.rb                 |
+      | app/views/users/new.html.erb                |
+      | app/views/users/edit.html.erb               |
+      | app/controllers/sessions_controller.rb      |
+      | app/helpers/sessions_helper.rb              |
+      | app/views/sessions/new.html.erb             |
+      | lib/controller_authentication.rb            |
+      | test/fixtures/users.yml                     |
+      | test/unit/user_test.rb                      |
+      | test/functional/users_controller_test.rb    |
+      | test/functional/sessions_controller_test.rb |
+      | db/migrate                                  |
+    And I should see the following in file "config/routes.rb"
+      | resources :sessions                                          |
+      | resources :users                                             |
+      | match 'login' => 'sessions#new', :as => :login               |
+      | match 'logout' => 'sessions#destroy', :as => :logout         |
+      | match 'signup' => 'users#new', :as => :signup                |
+      | match 'user/edit' => 'users#edit', :as => :edit_current_user |
+    And I should see "include ControllerAuthentication" in file "app/controllers/application_controller.rb"
+    And I should see "gem "mocha", :group => :test" in file "Gemfile"
+    And I should see "gem "bcrypt-ruby", :require => "bcrypt"" in file "Gemfile"
+    When I run "rails g fcus:layout -f"
+    And I run "rake db:migrate"
+    Then I should successfully run "rake test"
+
+  Scenario: Generate named authentication
+    Given a new Rails app
+    When I insert "root :to => 'accounts#new'" into "config/routes.rb" after line 1
+    And I run "rails g fcus:authentication Account CurrentSession"
+    Then I should see the following files
+      | app/models/account.rb                               |
+      | app/controllers/accounts_controller.rb              |
+      | app/helpers/accounts_helper.rb                      |
+      | app/views/accounts/new.html.erb                     |
+      | app/views/accounts/edit.html.erb                    |
+      | app/controllers/current_sessions_controller.rb      |
+      | app/helpers/current_sessions_helper.rb              |
+      | app/views/current_sessions/new.html.erb             |
+      | test/fixtures/accounts.yml                          |
+      | test/unit/account_test.rb                           |
+      | test/functional/accounts_controller_test.rb         |
+      | test/functional/current_sessions_controller_test.rb |
+    And I should see the following in file "config/routes.rb"
+      | resources :current_sessions                                   |
+      | resources :accounts                                           |
+      | match 'login' => 'current_sessions#new', :as => :login        |
+      | match 'logout' => 'current_sessions#destroy', :as => :logout  |
+      | match 'signup' => 'accounts#new', :as => :signup              |
+      | match 'account/edit' => 'accounts#edit', :as => :edit_current_account |
+    When I run "rails g fcus:layout -f"
+    And I run "rake db:migrate"
+    Then I should successfully run "rake test"
+
+  Scenario: Generate named authentication with rspec
+    Given a new Rails app
+    When I insert "root :to => 'accounts#new'" into "config/routes.rb" after line 1
+    And I run "rails g fcus:authentication Account CurrentSession --rspec"
+    Then I should see the following files
+      | spec/models/account_spec.rb                          |
+      | spec/controllers/accounts_controller_spec.rb         |
+      | spec/controllers/current_sessions_controller_spec.rb |
+    When I run "rails g fcus:layout -f"
+    And I run "rake db:migrate"
+    And I add "gem 'rspec-rails', '>= 2.0.1'" to file "Gemfile"
+    And I run "rails g rspec:install"
+    And I replace "mock_with :rspec" with "mock_with :mocha" in file "spec/spec_helper.rb"
+    Then I should successfully run "rake spec"

data/features/fcus_config.feature

@@ -0,0 +1,17 @@
+Feature: Fcus Config Generator
+  In order to have configure an app
+  As a rails developer
+  I want to generate a config file and manager
+
+  Scenario: Generate normal config
+    Given a new Rails app
+    When I run "rails g fcus:config"
+    Then I should see file "config/app_config.yml"
+    And I should see file "config/initializers/load_app_config.rb"
+
+  Scenario: Generate named config
+    Given a new Rails app
+    When I run "rails g fcus:config FooBar"
+    Then I should see "FOO_BAR_CONFIG" in file "config/initializers/load_foo_bar_config.rb"
+    And I should see "config/foo_bar_config.yml" in file "config/initializers/load_foo_bar_config.rb"
+    And I should see file "config/foo_bar_config.yml"

data/features/fcus_layout.feature

@@ -0,0 +1,20 @@
+Feature: Fcus Layout Generator
+  In order to have a layout
+  As a rails developer
+  I want to generate a simple layout
+
+  Scenario: Generate normal application layout
+    Given a new Rails app
+    When I run "rails g fcus:layout -f"
+    Then I should see "stylesheet_link_tag "application"" in file "app/views/layouts/application.html.erb"
+    Then I should see "h(page_title" in file "app/helpers/layout_helper.rb"
+    And I should see file "app/helpers/layout_helper.rb"
+    And I should see file "app/helpers/error_messages_helper.rb"
+    And I should see file "public/stylesheets/application.css"
+
+  Scenario: Generate named layout with haml and sass
+    Given a new Rails app
+    When I run "rails g fcus:layout FooBar --haml -f"
+    Then I should see "stylesheet_link_tag "foo_bar"" in file "app/views/layouts/foo_bar.html.haml"
+    And I should see file "public/stylesheets/sass/foo_bar.sass"
+    And I should see file "app/helpers/layout_helper.rb"

data/features/fcus_scaffold.feature

@@ -0,0 +1,80 @@
+Feature: Fcus Scaffold Generator
+  In order to manage a resource
+  As a rails developer
+  I want to generate a model, controller, and views for that resource
+
+  Scenario: Generate scaffold for simple resource
+    Given a new Rails app
+    When I run "rails g fcus:scaffold Project name:string"
+    Then I should see the following files
+      | app/models/project.rb                  |
+      | app/controllers/projects_controller.rb |
+      | app/helpers/projects_helper.rb         |
+      | app/views/projects/index.html.erb      |
+      | app/views/projects/show.html.erb       |
+      | app/views/projects/new.html.erb        |
+      | app/views/projects/edit.html.erb       |
+      | db/migrate                             |
+    And I should see "resources :projects" in file "config/routes.rb"
+    And I should see "gem "mocha", :group => :test" in file "Gemfile"
+    When I run "rails g fcus:layout -f"
+    And I run "rake db:migrate"
+    And I should successfully run "rails g fcus:scaffold Project -f"
+    Then I should successfully run "rake test"
+
+  Scenario: Generate scaffold with rspec tests
+    Given a new Rails app
+    When I run "rails g fcus:scaffold Project name:string --rspec"
+    Then I should see the following files
+      | spec/models/project_spec.rb                  |
+      | spec/controllers/projects_controller_spec.rb |
+    When I run "rails g fcus:scaffold Task project_id:integer"
+    Then I should see the following files
+      | spec/models/task_spec.rb                  |
+      | spec/controllers/tasks_controller_spec.rb |
+    When I run "rails g fcus:layout -f"
+    And I run "rake db:migrate"
+    And I add "gem 'rspec-rails', '>= 2.0.0.beta.19'" to file "Gemfile"
+    And I run "rails g rspec:install"
+    And I replace "mock_with :rspec" with "mock_with :mocha" in file "spec/spec_helper.rb"
+    Then I should successfully run "rake spec"
+
+  Scenario: Report error when invalid model name
+    Given a new Rails app
+    Then I should see "Usage:" when running "rails g fcus:scaffold name:string parent_id:integer"
+
+  Scenario: Generate scaffold for namespaced resource
+    Given a new Rails app
+    When I run "rails g fcus:scaffold Admin::User name:string"
+    Then I should see the following files
+      | app/models/user.rb                        |
+      | app/controllers/admin/users_controller.rb |
+      | app/helpers/admin/users_helper.rb         |
+      | app/views/admin/users/index.html.erb      |
+      | app/views/admin/users/show.html.erb       |
+      | app/views/admin/users/new.html.erb        |
+      | app/views/admin/users/edit.html.erb       |
+      | db/migrate                                |
+    And I should see "class User" in file "app/models/user.rb"
+    And I should not see "set_table_name :" in file "app/models/user.rb"
+    And I should see "namespace(:admin){ resources :users }" in file "config/routes.rb"
+    When I run "rails g fcus:layout -f"
+    And I run "rake db:migrate"
+    And I should successfully run "rails g fcus:scaffold Admin::User -f"
+    Then I should successfully run "rake test"
+
+  Scenario: Generate scaffold with a namespaced model
+    Given a new Rails app
+    When I run "rails g fcus:scaffold Admin::User name:string --namespace_model"
+    Then I should see "class Admin::User" in file "app/models/admin/user.rb"
+    And I should see "set_table_name :admin_users" in file "app/models/admin/user.rb"
+    When I run "rails g fcus:layout -f"
+    And I run "rake db:migrate"
+    And I should successfully run "rails g fcus:scaffold Admin::User -f --namespace_model"
+    Then I should successfully run "rake test"
+
+  Scenario: Given scaffold with a new and index action
+    Given a new Rails app
+    When I run "rails g fcus:scaffold Project name:string index new"
+    Then I should see "class Project" in file "app/models/project.rb"
+    And I should see "<%= form_for @project do |f| %>" in file "app/views/projects/new.html.erb"

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,62 @@
+When /^I run "([^\"]*)"$/ do |command|
+  system("cd #{@current_directory} && #{command}").should be_true
+end
+
+When /^I add "([^\"]*)" to file "([^\"]*)"$/ do |content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  File.open(path, 'a') { |f| f.write(content + "\n") }
+end
+
+When /^I replace "([^\"]*)" with "([^\"]*)" in file "([^\"]*)"$/ do |old_content, new_content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  content = File.read(path).gsub(old_content, new_content)
+  File.open(path, 'w') { |f| f.write(content) }
+end
+
+When /^I insert "([^\"]*)" into "([^\"]*)" after line (\d+)$/ do |content, short_path, after_line|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  lines = File.read(path).split("\n")
+  lines[after_line.to_i, 0] = content
+  File.open(path, 'w') { |f| f.write(lines.join("\n")) }
+end
+
+Then /^I should see file "([^\"]*)"$/ do |path|
+  File.should exist(File.join(@current_directory, path))
+end
+
+Then /^I should see "(.*)" in file "([^\"]*)"$/ do |content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  File.readlines(path).join.should include(content)
+end
+
+Then /^I should not see "(.*)" in file "([^\"]*)"$/ do |content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  File.readlines(path).join.should_not include(content)
+end
+
+Then /^I should see the following files$/ do |table|
+  table.raw.flatten.each do |path|
+    File.should exist(File.join(@current_directory, path))
+  end
+end
+
+Then /^I should see the following in file "([^\"]*)"$/ do |short_path, table|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  table.raw.flatten.each do |content|
+    File.readlines(path).join.should include(content)
+  end
+end
+
+Then /^I should successfully run "([^\"]*)"$/ do |command|
+  system("cd #{@current_directory} && #{command}").should be_true
+end
+
+Then /^I should see "([^\"]*)" when running "([^\"]*)"$/ do |expected_response, command|
+  `cd #{@current_directory} && #{command}`.should include(expected_response)
+end

data/features/step_definitions/rails_setup_steps.rb

@@ -0,0 +1,6 @@
+Given /^a new Rails app$/ do
+  FileUtils.mkdir_p("tmp")
+  system("rails new tmp/rails_app").should be_true
+  system("ln -s ../../../lib/generators tmp/rails_app/lib/generators").should be_true
+  @current_directory = File.expand_path("tmp/rails_app")
+end

data/features/support/env.rb

@@ -0,0 +1,6 @@
+require 'cucumber'
+require 'rspec'
+
+Before do
+  FileUtils.rm_rf "tmp/rails_app"
+end

data/features/support/matchers.rb

@@ -0,0 +1,7 @@
+RSpec::Matchers.define :exist do |path|
+  match do
+    File.exist?(path)
+  end
+  failure_message_for_should { "Expected #{path} to exist but no file found" }
+  failure_message_for_should_not { "Expected #{path} to not exist but file was found" }
+end

data/lib/generators/fcus.rb

@@ -0,0 +1,28 @@
+require 'rails/generators/base'
+
+module Fcus
+  module Generators
+    class Base < Rails::Generators::Base #:nodoc:
+      def self.source_root
+        @_fcus_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'fcus', generator_name, 'templates'))
+      end
+
+      def self.banner
+        "rails generate fcus:#{generator_name} #{self.arguments.map{ |a| a.usage }.join(' ')} [options]"
+      end
+
+      private
+
+      def add_gem(name, options = {})
+        gemfile_content = File.read(destination_path("Gemfile"))
+        File.open(destination_path("Gemfile"), 'a') { |f| f.write("\n") } unless gemfile_content =~ /\n\Z/
+        gem name, options unless gemfile_content.include? name
+      end
+
+      def print_usage
+        self.class.help(Thor::Base.shell.new)
+        exit
+      end
+    end
+  end
+end