splendeo-generators 0.1.0

data/CHANGELOG

@@ -0,0 +1,119 @@
+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

@@ -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

@@ -0,0 +1,98 @@
+= Splendeo Generators
+
+A collection of useful Rails generator scripts for scaffolding, layout files, authentication, and more.
+
+
+== Install
+
+  gem install splendeo-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 splendeo_scaffold Recipe name:string index new
+
+
+== Included Generators
+
+* splendeo_layout: generates generic layout, stylesheet, and helper files.
+* splendeo_scaffold: generates a controller and optional model/migration.
+* splendeo_config: generates a config YAML file and loader.
+* splendeo_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 splendeo_layout --help
+
+
+== Troubleshooting and FAQs
+
+<b>What is the difference between splendeo_scaffold and built-in scaffold?</b>
+
+One of the primary differences is that splendeo_scaffold allows you to choose which controller actions to generate.
+
+  script/generate splendeo_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 splendeo_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 Splendeo Generators, first look at the FAQs above. If you still cannot resolve it, please submit an issue here.
+
+http://github.com/ryanb/splendeo-generators/issues
+
+
+== Rails 3
+
+Splendeo Generators does not yet officially work with Rails 3, but a fork is available here.
+
+http://github.com/dvyjones/splendeo-generators

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+desc "Run tests."
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/nifty_generators.rb

@@ -0,0 +1,3 @@
+module SplendeoGenerators
+  # nothing to see here, the real action is under rails_generators
+end

data/rails_generators/splendeo_authentication/USAGE

@@ -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 splendeo_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.
+    
+      config.gem "authlogic"
+
+Examples:
+    script/generate splendeo_authentication
+        
+        Creates user model, users_controller, and sessions_controller.
+    
+    script/generate splendeo_authentication account
+    
+        Creates account model, accounts_controller, and sessions_controller.
+    
+    script/generate splendeo_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/rails_generators/splendeo_authentication/lib/insert_commands.rb

@@ -0,0 +1,74 @@
+Rails::Generator::Commands::Create.class_eval do
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+    
+    logger.route "map.resource #{resource_list}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.resource #{resource_list}\n"
+      end
+    end
+  end
+  
+  def route_name(name, path, route_options = {})
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+    
+    logger.route "map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+      end
+    end
+  end
+  
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+    unless options[:pretend]
+      gsub_file file, /^(class|module) .+$/ do |match|
+        "#{match}\n  #{line}"
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    look_for = "\n  map.resource #{resource_list}\n"
+    logger.route "map.resource #{resource_list}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{look_for})/mi, ''
+    end
+  end
+  
+  def route_name(name, path, route_options = {})
+    look_for =   "\n  map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+    logger.route "map.#{name} '#{path}',     :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+    unless options[:pretend]
+      gsub_file    'config/routes.rb', /(#{look_for})/mi, ''
+    end
+  end
+  
+  def insert_into(file, line)
+    logger.remove "#{line} from #{file}"
+    unless options[:pretend]
+      gsub_file file, "\n  #{line}", ''
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    logger.route "map.resource #{resource_list}"
+  end
+  
+  def route_name(name, path, options = {})
+    logger.route "map.#{name} '#{path}', :controller => '{options[:controller]}', :action => '#{options[:action]}'"
+  end
+  
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+  end
+end

data/rails_generators/splendeo_authentication/splendeo_authentication_generator.rb

@@ -0,0 +1,128 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
+class SplendeoAuthenticationGenerator < Rails::Generator::Base
+  attr_accessor :user_name, :session_name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    
+    @user_name = @args[0] || 'user'
+    @session_name = @args[1] || (options[:authlogic] ? @user_name + '_session' : 'session')
+  end
+  
+  def manifest
+    record do |m|
+      m.directory "app/models"
+      m.directory "app/controllers"
+      m.directory "app/helpers"
+      m.directory "app/views"
+      m.directory "lib"
+      
+      m.directory "app/views/#{user_plural_name}"
+      m.template "user.rb", "app/models/#{user_singular_name}.rb"
+      m.template "authlogic_session.rb", "app/models/#{session_singular_name}.rb" if options[:authlogic]
+      m.template "users_controller.rb", "app/controllers/#{user_plural_name}_controller.rb"
+      m.template "users_helper.rb", "app/helpers/#{user_plural_name}_helper.rb"
+      m.template "views/#{view_language}/signup.html.#{view_language}", "app/views/#{user_plural_name}/new.html.#{view_language}"
+      
+      m.directory "app/views/#{session_plural_name}"
+      m.template "sessions_controller.rb", "app/controllers/#{session_plural_name}_controller.rb"
+      m.template "sessions_helper.rb", "app/helpers/#{session_plural_name}_helper.rb"
+      m.template "views/#{view_language}/login.html.#{view_language}", "app/views/#{session_plural_name}/new.html.#{view_language}"
+      
+      m.template "authentication.rb", "lib/authentication.rb"
+      m.migration_template "migration.rb", "db/migrate", :migration_file_name => "create_#{user_plural_name}"
+      
+      m.route_resources user_plural_name
+      m.route_resources session_plural_name
+      m.route_name :login, 'login', :controller => session_plural_name, :action => 'new'
+      m.route_name :logout, 'logout', :controller => session_plural_name, :action => 'destroy'
+      m.route_name :signup, 'signup', :controller => user_plural_name, :action => 'new'
+      
+      m.insert_into "app/controllers/#{application_controller_name}.rb", 'include Authentication'
+      
+      if test_framework == :rspec
+        m.directory "spec"
+        m.directory "spec/fixtures"
+        m.directory "spec/controllers"
+        m.directory "spec/models"
+        m.template "fixtures.yml", "spec/fixtures/#{user_plural_name}.yml"
+        m.template "tests/rspec/user.rb", "spec/models/#{user_singular_name}_spec.rb"
+        m.template "tests/rspec/users_controller.rb", "spec/controllers/#{user_plural_name}_controller_spec.rb"
+        m.template "tests/rspec/sessions_controller.rb", "spec/controllers/#{session_plural_name}_controller_spec.rb"
+      else
+        m.directory "test"
+        m.directory "test/fixtures"
+        m.directory "test/functional"
+        m.directory "test/unit"
+        m.template "fixtures.yml", "test/fixtures/#{user_plural_name}.yml"
+        m.template "tests/#{test_framework}/user.rb", "test/unit/#{user_singular_name}_test.rb"
+        m.template "tests/#{test_framework}/users_controller.rb", "test/functional/#{user_plural_name}_controller_test.rb"
+        m.template "tests/#{test_framework}/sessions_controller.rb", "test/functional/#{session_plural_name}_controller_test.rb"
+      end
+    end
+  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 application_controller_name
+    Rails.version >= '2.3.0' ? 'application_controller' : 'application'
+  end
+
+protected
+  
+  def view_language
+    options[:haml] ? 'haml' : 'erb'
+  end
+  
+  def test_framework
+    options[:test_framework] ||= File.exist?(destination_path("spec")) ? :rspec : :testunit
+  end
+  
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--testunit", "Use test/unit for test files.") { options[:test_framework] = :testunit }
+    opt.on("--rspec", "Use RSpec for test files.") { options[:test_framework] = :rspec }
+    opt.on("--shoulda", "Use Shoulda for test files.") { options[:test_framework] = :shoulda }
+    opt.on("--haml", "Generate HAML views instead of ERB.") { |v| options[:haml] = true }
+    opt.on("--authlogic", "Use Authlogic for authentication.") { |v| options[:authlogic] = true }
+  end
+  
+  def banner
+    <<-EOS
+Creates user model and controllers to handle registration and authentication.
+
+USAGE: #{$0} #{spec.name} [user_name] [sessions_controller_name]
+EOS
+  end
+end