RubyGems - corntrace-nifty-generators - Versions diffs - 0.4.0 - Mend

corntrace-nifty-generators 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (193) hide show

data/CHANGELOG ADDED Viewed

@@ -0,0 +1,128 @@
+0.4.0 (April 19th, 2010)
+* adding error_messages_for and f.error_messages helper for Rails 3 nifty:layout
+* adding initial Rails 3 support (thanks Henrik Hodne)
+* adding xmlns to <head> element in nifty_layout
+0.3.2 (February 16th, 2010)
+* Including all files in gem, was missing files in rails_generator directory
+0.3.1 (February 16th, 2010)
+* improving documentation
+* fixing name of generated session model for authlogic in nifty_authorization
+* use "username" instead of "login" for authlogic haml form template in nifty_authorization
+0.3.0 (August 15th, 2009)
+* adding attr_accessible to models in nifty_scaffold
+* adding authlogic support with --authlogic option in nifty_authentication
+* pluralize second argument for controller in nifty_authentication
+* don't convert javascript/stylesheet arguments to strings in nifty_layout
+* store request location and redirect to it when logging in under nifty_authentication
+0.2.4 (May 5th, 2009)
+* using root_url when no index action in nifty_scaffold
+* making password editable in user model in nifty_authentication
+* adding filter_parameter_logging :password in nifty_authentication
+0.2.3 (February 20th, 2009)
+* fixing nifty_authentication to work with Rails 2.3 application_controller.rb
+* fixing password field in HAML signup page in nifty_authentication
+0.2.2 (November 11th, 2008)
+* fixing sessions_path reference in nifty_authentication
+* adding more validations to user model in nifty_authentication
+* cleaning up nifty_layout stylesheet
+0.2.1 (November 10th, 2008)
+* adding missing nifty_authentication files
+0.2.0 (November 4th, 2008)
+* adding nifty_authentication
+0.1.8 (October 3rd, 2008)
+* compatibility with RubyGems 1.3
+* using f.error_messages instead of error_messages_for (thanks Zach Langley)
+0.1.7 (August 15th, 2008)
+* fixing shoulda tests
+0.1.6 (August 7th, 2008)
+* adding option to specify Shoulda as testing framework in nifty_scaffold generator
+* adding options to manually specify rspec or testunit framework in nifty_scaffold generator
+0.1.5 (August 7th, 2008)
+* adding option to nifty layout to generate HAML views and SASS stylesheets
+* adding option to nifty scaffold to generate HAML views
+0.1.4 (July 21st, 2008)
+* using same logic as model spec in model test for scaffold
+* simplifying model spec generated by scaffold
+* adding error_messages_for to form partial
+0.1.3 (June 20th, 2008)
+* using _url in controllers instead of _path
+* improving the nifty_config default example YAML file
+0.1.2 (May 16th, 2008)
+* mentioning nifty_layout in nifty_scaffold generator
+* adding nifty_config generator
+0.1.1 (May 9th, 2008)
+* adding tests and specs to scaffold generator
+0.1.0 (May 8th, 2008)
+* initial release

data/LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2010 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 ADDED Viewed

@@ -0,0 +1,104 @@
+= Nifty Generators
+A collection of useful Rails generator scripts for scaffolding, layout files, authentication, and more.
+== Install
+  gem install nifty-generators
+== Usage
+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.
+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
+== 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.
+To view the README for each generator, run it with the +help+ option.
+  script/generate nifty_layout --help
+== Rails 3
+To use Nifty Generators with Rails 3 you will need to include it in your Gemfile.
+  gem "nifty-generators"
+The generators use a colon as the separator instead of an underscore.
+  rails g nifty:layout
+The Rails 3 support is still in early development, please {report any issues}[http://github.com/ryanb/nifty-generators/issues] you find.
+== Troubleshooting and FAQs
+<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.
+  script/generate 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.
+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.
+<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).
+  map.root :controller => 'foo'
+<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 Nifty Generators, first look at the FAQs above. If you still cannot resolve it, please submit an issue here.
+http://github.com/ryanb/nifty-generators/issues

data/Rakefile ADDED Viewed

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'cucumber'
+require 'cucumber/rake/task'
+desc "Run tests."
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format progress"
+end
+task :default => [:test, :features]

data/features/nifty_authentication.feature ADDED Viewed

@@ -0,0 +1,59 @@
+Feature: Nifty 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 run "rails g nifty: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/controllers/sessions_controller.rb      |
+      | app/helpers/sessions_helper.rb              |
+      | app/views/sessions/new.html.erb             |
+      | lib/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        |
+    And I should see "include Authentication" in file "app/controllers/application_controller.rb"
+    When I run "rails g nifty:layout -f"
+    And I run "rake db:migrate"
+    And I add "gem 'mocha', :group => :test" to file "Gemfile"
+    Then I should successfully run "rake test"
+  Scenario: Generate named authentication
+    Given a new Rails app
+    When I run "rails g nifty: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/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             |
+    When I run "rails g nifty:layout -f"
+    And I run "rake db:migrate"
+    And I add "gem 'mocha', :group => :test" to file "Gemfile"
+    Then I should successfully run "rake test"

data/features/nifty_config.feature ADDED Viewed

@@ -0,0 +1,17 @@
+Feature: Nifty 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 nifty: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 nifty: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/nifty_layout.feature ADDED Viewed

@@ -0,0 +1,19 @@
+Feature: Nifty 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 nifty:layout -f"
+    Then I should see "stylesheet_link_tag "application"" in file "app/views/layouts/application.html.erb"
+    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 nifty: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/nifty_scaffold.feature ADDED Viewed

@@ -0,0 +1,22 @@
+Feature: Nifty 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 nifty: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"
+    When I run "rails g nifty:layout -f"
+    And I run "rake db:migrate"
+    And I add "gem 'mocha', :group => :test" to file "Gemfile"
+    Then I should successfully run "rake test"

data/features/step_definitions/common_steps.rb ADDED Viewed

@@ -0,0 +1,37 @@
+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) }
+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 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

data/features/step_definitions/rails_setup_steps.rb ADDED Viewed

@@ -0,0 +1,6 @@
+Given /^a new Rails app$/ do
+  FileUtils.mkdir_p("tmp")
+  system("rails 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 ADDED Viewed

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

data/features/support/matchers.rb ADDED Viewed

@@ -0,0 +1,7 @@
+Spec::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/nifty/authentication/USAGE ADDED Viewed

@@ -0,0 +1,50 @@
+Description:
+    Generates a user model, users controller, and sessions controller. The
+    users controller handles the registration and the sessions controller
+    handles authentication. This is similar to restful_authentication, but
+    simpler.
+    IMPORTANT: This generator uses the "title" helper method which is generated
+    by the nifty_layout generator. You may want to run that generator first.
+Usage:
+    If you do not pass any arguments, the model name will default to "user", and
+    the authentication controller will default to "session". You can override
+    each of these respectively by passing one or two arguments. Either name can
+    be CamelCased or under_scored.
+    Make sure to setup the authlogic gem if you are using that option.
+      gem "authlogic" # in Gemfile
+Examples:
+    rails generate nifty:authentication
+        Creates user model, users_controller, and sessions_controller.
+    rails generate nifty:authentication account
+        Creates account model, accounts_controller, and sessions_controller.
+    rails generate nifty:authentication Account UserSession
+        Creates account model, accounts_controller, and user_sessions_controller.
+Methods:
+    There are several methods generated which you can use in your application.
+    Here's a common example of what you might add to your layout.
+      <% if logged_in? %>
+        Welcome <%= current_user.username %>! Not you?
+        <%= link_to "Log out", logout_path %>
+      <% else %>
+        <%= link_to "Sign up", signup_path %> or
+        <%= link_to "log in", login_path %>.
+      <% end %>
+    You can also restrict unregistered users from accessing a controller using
+    a before filter. For example.
+      before_filter :login_required, :except => [:index, :show]
+    See the generated file lib/authentication.rb for details.

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

@@ -0,0 +1,145 @@
+require 'generators/nifty'
+require 'rails/generators/migration'
+module Nifty
+  module Generators
+    class AuthenticationGenerator < Base
+      include Rails::Generators::Migration
+      argument :user_name, :type => :string, :default => 'user', :banner => 'user_name'
+      argument :session_name, :type => :string, :default => '[[DEFAULT]]', :banner => 'sessions_controller_name'
+      class_option :testunit, :desc => 'Use test/unit for test files.', :group => 'Test framework', :type => :boolean
+      class_option :rspec, :desc => 'Use RSpec for test files.', :group => 'Test framework', :type => :boolean
+      class_option :shoulda, :desc => 'Use shoulda for test files.', :group => 'Test framework', :type => :boolean
+      class_option :haml, :desc => 'Generate HAML views instead of ERB.', :type => :boolean
+      class_option :authlogic, :desc => 'Use Authlogic for authentication.', :type => :boolean
+      def create_model_files
+        template 'user.rb', "app/models/#{user_singular_name}.rb"
+        template 'authlogic_session.rb', "app/models/#{user_singular_name}_session.rb" if options.authlogic?
+      end
+      def create_controller_files
+        template 'users_controller.rb', "app/controllers/#{user_plural_name}_controller.rb"
+        template 'sessions_controller.rb', "app/controllers/#{session_plural_name}_controller.rb"
+      end
+      def crete_helper_files
+        template 'users_helper.rb', "app/helpers/#{user_plural_name}_helper.rb"
+        template 'sessions_helper.rb', "app/helpers/#{session_plural_name}_helper.rb"
+      end
+      def create_view_files
+        template "views/#{view_language}/signup.html.#{view_language}", "app/views/#{user_plural_name}/new.html.#{view_language}"
+        template "views/#{view_language}/login.html.#{view_language}", "app/views/#{session_plural_name}/new.html.#{view_language}"
+      end
+      def create_lib_files
+        template 'authentication.rb', 'lib/authentication.rb'
+      end
+      def create_routes
+        route "resources #{user_plural_name.to_sym.inspect}"
+        route "resources #{session_plural_name.to_sym.inspect}"
+        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"
+      end
+      def create_migration
+        migration_template 'migration.rb', "db/migrate/create_#{user_plural_name}.rb"
+      end
+      def create_include_line
+        inject_into_class "app/controllers/application_controller.rb", "ApplicationController", "  include Authentication\n"
+      end
+      def create_test_files
+        if test_framework == :rspec
+          template 'fixtures.yml', "spec/fixtures/#{user_plural_name}.yml"
+          template 'tests/rspec/user.rb', "spec/models/#{user_singular_name}_spec.rb"
+          template 'tests/rspec/users_controller.rb', "spec/controllers/#{user_plural_name}_controller_spec.rb"
+          template 'tests/rspec/sessions_controller.rb', "spec/controllers/#{session_plural_name}_controller_spec.rb"
+        else
+          template 'fixtures.yml', "test/fixtures/#{user_plural_name}.yml"
+          template "tests/#{test_framework}/user.rb", "test/unit/#{user_singular_name}_test.rb"
+          template "tests/#{test_framework}/users_controller.rb", "test/functional/#{user_plural_name}_controller_test.rb"
+          template "tests/#{test_framework}/sessions_controller.rb", "test/functional/#{session_plural_name}_controller_test.rb"
+        end
+      end
+      private
+      def session_name
+        @_session_name ||= @session_name == '[[DEFAULT]]' ?
+          (options.authlogic? ? user_name + '_session' : 'session') :
+          @session_name
+      end
+      def user_singular_name
+        user_name.underscore
+      end
+      def user_plural_name
+        user_singular_name.pluralize
+      end
+      def user_class_name
+        user_name.camelize
+      end
+      def user_plural_class_name
+        user_plural_name.camelize
+      end
+      def session_singular_name
+        session_name.underscore
+      end
+      def session_plural_name
+        session_singular_name.pluralize
+      end
+      def session_class_name
+        session_name.camelize
+      end
+      def session_plural_class_name
+        session_plural_name.camelize
+      end
+      def view_language
+        options.haml? ? 'haml' : 'erb'
+      end
+      def test_framework
+        return @test_framework if defined?(@test_framework)
+        if options.testunit?
+          return @test_framework = :testunit
+        elsif options.rspec?
+          return @test_framework = :rspec
+        elsif options.shoulda?
+          return @test_framework = :shoulda
+        else
+          return @test_framework = File.exist?(destination_path('spec')) ? :rspec : :testunit
+        end
+      end
+      def destination_path(path)
+        File.join(destination_root, path)
+      end
+      # FIXME: Should be proxied to ActiveRecord::Generators::Base
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+    end
+  end
+end