nifty-generators 0.4.2 → 0.4.3

data/CHANGELOG

@@ -1,3 +1,16 @@
+0.4.3 (December 28, 2010)
+
+* display usage documentation when given an invalid model name with nifty:scaffold - issue #76
+
+* add newline when necessary to Gemfile before adding gem - issue #64
+
+* remove extra whitespace between controller methods in nifty:scaffold - issue #62
+
+* renaming edit_user route to edit_current_user - issue #59
+
+* HAML template improvements (thanks IamNaN) - issue #71
+
+
 0.4.2 (October 15, 2010)
 
 * adding mocha to Gemfile automatically if it's not there already

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nifty-generators (0.4.1)
+    nifty-generators (0.4.3)
 
 GEM
   remote: http://rubygems.org/

data/README.rdoc

@@ -3,52 +3,50 @@
 A collection of useful Rails generator scripts for scaffolding, layout files, authentication, and more.
 
 
-== Install
-
-  gem install nifty-generators
+== Setup
 
+=== Rails 3
 
-== Usage
+Add the gem to your Gemfile.
 
-Once you install the gem, the generators will be available to all Rails applications on your system. If you run script/generate without any additional arguments you should see the available generators listed.
+  gem "nifty-generators", :group => :development
 
-To run the generator, go to your rails project directory and call it using the script/generate or script/destroy command.
+Then you can run any of the included generators.
 
-  script/generate nifty_scaffold Recipe name:string index new
+  rails g nifty:scaffold Recipe name:string index new
 
+=== Rails 2
 
-== Included Generators
-
-* nifty_layout: generates generic layout, stylesheet, and helper files.
-* nifty_scaffold: generates a controller and optional model/migration.
-* nifty_config: generates a config YAML file and loader.
-* nifty_authentication: generates user model with sign up and log in.
+First install the gem.
 
-To view the README for each generator, run it with the +help+ option.
+  gem install nifty-generators
 
-  script/generate nifty_layout --help
+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 nifty_scaffold Recipe name:string index new
 
-== Rails 3
+Note an underscore is used instead of a colon for the Rails 2 generators.
 
-To use Nifty Generators with Rails 3 you will need to include it in your Gemfile.
 
-  gem "nifty-generators"
+== Included Generators
 
-The generators use a colon as the separator instead of an underscore.
+* nifty:layout: generates generic layout, stylesheet, and helper files.
+* nifty:scaffold: generates a controller and optional model/migration.
+* nifty:config: generates a config YAML file and loader.
+* nifty:authentication: generates user model with sign up and log in.
 
-  rails g nifty:layout
+To view the README for each generator, run it with the +help+ option.
 
-The Rails 3 support is still in early development, please {report any issues}[http://github.com/ryanb/nifty-generators/issues] you find.
+  rails g nifty:layout --help
 
 
 == Troubleshooting and FAQs
 
-<b>What is the difference between nifty_scaffold and built-in scaffold?</b>
+<b>What is the difference between nifty:scaffold and built-in scaffold?</b>
 
-One of the primary differences is that nifty_scaffold allows you to choose which controller actions to generate.
+One of the primary differences is that nifty:scaffold allows you to choose which controller actions to generate.
 
-  script/generate nifty_scaffold post name:string index new edit
+  rails g nifty: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.
 
@@ -57,7 +55,7 @@ It also offers support for HAML, Shoulda, and RSpec.
 
 <b>I get "undefined method 'title'" error.</b>
 
-Try running nifty_layout, that will generate this helper method. Or you can just change the templates to whatever approach you prefer for setting the title.
+Try running nifty: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>
@@ -69,7 +67,7 @@ Add the attribute to the attr_accessible line in the model.
 
 Some generators default redirecting to the root_url. Set this in your routes.rb file like this (substituting your controller name).
 
-  map.root :controller => 'foo'
+  root :to => "home#index"
 
 
 <b>I get a missing database error.</b>

data/features/nifty_authentication.feature

@@ -22,12 +22,12 @@ Feature: Nifty Authentication Generator
       | 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_user |
+      | 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"
@@ -57,7 +57,7 @@ Feature: Nifty Authentication Generator
       | 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_account |
+      | match 'account/edit' => 'accounts#edit', :as => :edit_current_account |
     When I run "rails g nifty:layout -f"
     And I run "rake db:migrate"
     Then I should successfully run "rake test"

data/features/nifty_scaffold.feature

@@ -38,3 +38,7 @@ Feature: Nifty Scaffold Generator
     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 nifty:scaffold name:string parent_id:integer"

data/features/step_definitions/common_steps.rb

@@ -42,3 +42,7 @@ 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/lib/generators/nifty.rb

@@ -8,7 +8,20 @@ module Nifty
       end
 
       def self.banner
-        "#{$0} nifty:#{generator_name} #{self.arguments.map{ |a| a.usage }.join(' ')} [options]"
+        "rails generate nifty:#{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

data/lib/generators/nifty/authentication/authentication_generator.rb

@@ -17,8 +17,8 @@ module Nifty
       class_option :authlogic, :desc => 'Use Authlogic for authentication.', :type => :boolean
 
       def add_gems
-        gem "bcrypt-ruby", :require => "bcrypt" unless File.read(destination_path("Gemfile")).include? "bcrypt"
-        gem "mocha", :group => :test unless File.read(destination_path("Gemfile")).include? "mocha"
+        add_gem "bcrypt-ruby", :require => "bcrypt"
+        add_gem "mocha", :group => :test
       end
 
       def create_model_files
@@ -53,7 +53,7 @@ module Nifty
         route "match 'login' => '#{session_plural_name}#new', :as => :login"
         route "match 'logout' => '#{session_plural_name}#destroy', :as => :logout"
         route "match 'signup' => '#{user_plural_name}#new', :as => :signup"
-        route "match '#{user_singular_name}/edit' => '#{user_plural_name}#edit', :as => :edit_#{user_singular_name}"
+        route "match '#{user_singular_name}/edit' => '#{user_plural_name}#edit', :as => :edit_current_#{user_singular_name}"
       end
 
       def create_migration

data/lib/generators/nifty/authentication/templates/controller_authentication.rb

@@ -4,7 +4,7 @@
 #
 #   <%% if logged_in? %>
 #     Welcome <%%= current_<%= user_singular_name %>.username %>.
-#     <%%= link_to "Edit profile", edit_<%= user_singular_name %>_path %> or
+#     <%%= link_to "Edit profile", edit_current_<%= user_singular_name %>_path %> or
 #     <%%= link_to "Log out", logout_path %>
 #   <%% else %>
 #     <%%= link_to "Sign up", signup_path %> or

data/lib/generators/nifty/authentication/templates/views/haml/_form.html.haml

@@ -1,4 +1,4 @@
-- form_for @<%= user_singular_name %> do |f|
+= form_for @<%= user_singular_name %> do |f|
   = f.error_messages
   %p
     = f.label :username

data/lib/generators/nifty/authentication/templates/views/haml/login.html.haml

@@ -3,7 +3,7 @@
 %p== Don't have an account? #{link_to "Sign up!", signup_path}
 
 <%- if options[:authlogic] -%>
-- form_for @<%= session_singular_name %> do |f|
+= form_for @<%= session_singular_name %> do |f|
   = f.error_messages
   %p
     = f.label :username

data/lib/generators/nifty/scaffold/USAGE

@@ -21,7 +21,7 @@ Usage:
     model's attributes. Timestamps are added by default, so you don't have to
     specify them by hand as 'created_at:datetime updated_at:datetime'.
 
-    For example, `nifty_scaffold post name:string content:text hidden:boolean`
+    For example, `nifty:scaffold post name:string content:text hidden:boolean`
     gives you a model with those three attributes, a controller that handles
     the create/show/update/destroy, forms to create and edit your posts, and
     an index that lists them all, as well as a map.resources :posts

data/lib/generators/nifty/scaffold/scaffold_generator.rb

@@ -25,6 +25,8 @@ module Nifty
       def initialize(*args, &block)
         super
 
+        print_usage unless model_name =~ /^[a-zA-Z_]+$/
+
         @controller_actions = []
         @model_attributes = []
         @skip_model = options.skip_model?
@@ -62,7 +64,7 @@ module Nifty
       end
 
       def add_gems
-        gem "mocha", :group => :test unless File.read(destination_path("Gemfile")).include? "mocha"
+        add_gem "mocha", :group => :test
       end
 
       def create_model
@@ -147,7 +149,7 @@ module Nifty
       def controller_methods(dir_name)
         controller_actions.map do |action|
           read_template("#{dir_name}/#{action}.rb")
-        end.join("  \n").strip
+        end.join("\n").strip
       end
 
       def render_form

data/lib/generators/nifty/scaffold/templates/views/haml/_form.html.haml

@@ -1,4 +1,4 @@
-- form_for @<%= singular_name %> do |f|
+= form_for @<%= singular_name %> do |f|
   = f.error_messages
   <%- for attribute in model_attributes -%>
   %p

data/rails_generators/nifty_scaffold/nifty_scaffold_generator.rb

@@ -128,7 +128,7 @@ class NiftyScaffoldGenerator < Rails::Generator::Base
   def controller_methods(dir_name)
     controller_actions.map do |action|
       read_template("#{dir_name}/#{action}.rb")
-    end.join("  \n").strip
+    end.join("\n").strip
   end
 
   def render_form

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 2
-  version: 0.4.2
+  - 3
+  version: 0.4.3
 platform: ruby
 authors: 
 - Ryan Bates
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-15 00:00:00 -07:00
+date: 2010-12-28 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency