very_nifty_generators 0.1.0

data/lib/generators/nifty/authentication/templates/tests/testunit/user.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+class <%= user_class_name %>Test < ActiveSupport::TestCase
+<%- unless options.authlogic? -%>
+  def new_<%= user_singular_name %>(attributes = {})
+    attributes[:username] ||= 'foo'
+    attributes[:email] ||= 'foo@example.com'
+    attributes[:password] ||= 'abc123'
+    attributes[:password_confirmation] ||= attributes[:password]
+    <%= user_singular_name %> = <%= user_class_name %>.new(attributes)
+    <%= user_singular_name %>.valid? # run validations
+    <%= user_singular_name %>
+  end
+  
+  def setup
+    <%= user_class_name %>.delete_all
+  end
+  
+  def test_valid
+    assert new_<%= user_singular_name %>.valid?
+  end
+  
+  def test_require_username
+    assert new_<%= user_singular_name %>(:username => '').errors.on(:username)
+  end
+  
+  def test_require_password
+    assert new_<%= user_singular_name %>(:password => '').errors.on(:password)
+  end
+  
+  def test_require_well_formed_email
+    assert new_<%= user_singular_name %>(:email => 'foo@bar@example.com').errors.on(:email)
+  end
+  
+  def test_validate_uniqueness_of_email
+    new_<%= user_singular_name %>(:email => 'bar@example.com').save!
+    assert new_<%= user_singular_name %>(:email => 'bar@example.com').errors.on(:email)
+  end
+  
+  def test_validate_uniqueness_of_username
+    new_<%= user_singular_name %>(:username => 'uniquename').save!
+    assert new_<%= user_singular_name %>(:username => 'uniquename').errors.on(:username)
+  end
+  
+  def test_validate_odd_characters_in_username
+    assert new_<%= user_singular_name %>(:username => 'odd ^&(@)').errors.on(:username)
+  end
+  
+  def test_validate_password_length
+    assert new_<%= user_singular_name %>(:password => 'bad').errors.on(:password)
+  end
+  
+  def test_require_matching_password_confirmation
+    assert new_<%= user_singular_name %>(:password_confirmation => 'nonmatching').errors.on(:password)
+  end
+  
+  def test_generate_password_hash_and_salt_on_create
+    <%= user_singular_name %> = new_<%= user_singular_name %>
+    <%= user_singular_name %>.save!
+    assert <%= user_singular_name %>.password_hash
+    assert <%= user_singular_name %>.password_salt
+  end
+  
+  def test_authenticate_by_username
+    <%= user_class_name %>.delete_all
+    <%= user_singular_name %> = new_<%= user_singular_name %>(:username => 'foobar', :password => 'secret')
+    <%= user_singular_name %>.save!
+    assert_equal <%= user_singular_name %>, <%= user_class_name %>.authenticate('foobar', 'secret')
+  end
+  
+  def test_authenticate_by_email
+    <%= user_class_name %>.delete_all
+    <%= user_singular_name %> = new_<%= user_singular_name %>(:email => 'foo@bar.com', :password => 'secret')
+    <%= user_singular_name %>.save!
+    assert_equal <%= user_singular_name %>, <%= user_class_name %>.authenticate('foo@bar.com', 'secret')
+  end
+  
+  def test_authenticate_bad_username
+    assert_nil <%= user_class_name %>.authenticate('nonexisting', 'secret')
+  end
+  
+  def test_authenticate_bad_password
+    <%= user_class_name %>.delete_all
+    new_<%= user_singular_name %>(:username => 'foobar', :password => 'secret').save!
+    assert_nil <%= user_class_name %>.authenticate('foobar', 'badpassword')
+  end
+<%- end -%>
+end

data/lib/generators/nifty/authentication/templates/tests/testunit/users_controller.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class <%= user_plural_class_name %>ControllerTest < ActionController::TestCase
+  def test_new
+    get :new
+    assert_template 'new'
+  end
+  
+  def test_create_invalid
+    <%= user_class_name %>.any_instance.stubs(:valid?).returns(false)
+    post :create
+    assert_template 'new'
+  end
+  
+  def test_create_valid
+    <%= user_class_name %>.any_instance.stubs(:valid?).returns(true)
+    post :create
+    assert_redirected_to root_url
+  <%- unless options.authlogic? -%>
+    assert_equal assigns['<%= user_singular_name %>'].id, session['<%= user_singular_name %>_id']
+  <%- end -%>
+  end
+end

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

@@ -0,0 +1,42 @@
+class <%= user_class_name %> < ActiveRecord::Base
+<%- if options.authlogic? -%>
+  acts_as_authentic
+<%- else -%>
+  # new columns need to be added here to be writable through mass assignment
+  attr_accessible :username, :email, :password, :password_confirmation
+  
+  attr_accessor :password
+  before_save :prepare_password
+  
+  validates_presence_of :username
+  validates_uniqueness_of :username, :email, :allow_blank => true
+  validates_format_of :username, :with => /^[-\w\._@]+$/i, :allow_blank => true, :message => "should only contain letters, numbers, or .-_@"
+  validates_format_of :email, :with => /^[-a-z0-9_+\.]+\@([-a-z0-9]+\.)+[a-z0-9]{2,4}$/i
+  validates_presence_of :password, :on => :create
+  validates_confirmation_of :password
+  validates_length_of :password, :minimum => 4, :allow_blank => true
+  
+  # login can be either username or email address
+  def self.authenticate(login, pass)
+    <%= user_singular_name %> = find_by_username(login) || find_by_email(login)
+    return <%= user_singular_name %> if <%= user_singular_name %> && <%= user_singular_name %>.matching_password?(pass)
+  end
+  
+  def matching_password?(pass)
+    self.password_hash == encrypt_password(pass)
+  end
+  
+  private
+  
+  def prepare_password
+    unless password.blank?
+      self.password_salt = Digest::SHA1.hexdigest([Time.now, rand].join)
+      self.password_hash = encrypt_password(password)
+    end
+  end
+  
+  def encrypt_password(pass)
+    Digest::SHA1.hexdigest([pass, password_salt].join)
+  end
+<%- end -%>
+end

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

@@ -0,0 +1,18 @@
+class <%= user_plural_class_name %>Controller < ApplicationController
+  def new
+    @<%= user_singular_name %> = <%= user_class_name %>.new
+  end
+  
+  def create
+    @<%= user_singular_name %> = <%= user_class_name %>.new(params[:<%= user_singular_name %>])
+    if @<%= user_singular_name %>.save
+    <%- unless options[:authlogic] -%>
+      session[:<%= user_singular_name %>_id] = @<%= user_singular_name %>.id
+    <%- end -%>
+      flash[:notice] = "Thank you for signing up! You are now logged in."
+      redirect_to root_url
+    else
+      render :action => 'new'
+    end
+  end
+end

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

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

data/lib/generators/nifty/config/config_generator.rb

@@ -0,0 +1,29 @@
+require 'generators/nifty'
+
+module Nifty
+  module Generators
+    class ConfigGenerator < Base
+      argument :config_name, :type => :string, :default => 'app'
+
+      def create_files
+        initializer("load_#{file_name}_config.rb") do
+          <<EOF
+raw_config = File.read(RAILS_ROOT + "/config/#{file_name}_config.yml")
+#{constant_name}_CONFIG = YAML.load(raw_config)[RAILS_ENV].symbolize_keys
+EOF
+        end
+        copy_file 'config.yml', "config/#{file_name}_config.yml"
+      end
+
+      no_tasks do
+        def file_name
+          config_name.underscore
+        end
+
+        def constant_name
+          config_name.underscore.upcase
+        end
+      end
+    end
+  end
+end

data/lib/generators/nifty/layout/layout_generator.rb

@@ -0,0 +1,28 @@
+require 'generators/nifty'
+
+module Nifty
+  module Generators
+    class LayoutGenerator < Base
+      argument :layout_name, :type => :string, :default => 'application', :banner => 'layout_name'
+
+      class_option :haml, :desc => 'Generate HAML for view, and SASS for stylesheet.', :type => :boolean
+
+      def create_layout
+        if options.haml?
+          template 'layout.html.haml', "app/views/layouts/#{file_name}.html.haml"
+          copy_file 'stylesheet.sass', "public/stylesheets/sass/#{file_name}.sass"
+        else
+          template 'layout.html.erb', "app/views/layouts/#{file_name}.html.erb"
+          copy_file 'stylesheet.css', "public/stylesheets/#{file_name}.css"
+        end
+        copy_file 'helper.rb', 'app/helpers/layout_helper.rb'
+      end
+
+      no_tasks do
+        def file_name
+          layout_name.underscore
+        end
+      end
+    end
+  end
+end

data/lib/generators/nifty/layout/templates/helper.rb

@@ -0,0 +1,22 @@
+# These helper methods can be called in your template to set variables to be used in the layout
+# This module should be included in all views globally,
+# to do so you may need to add this line to your ApplicationController
+#   helper :layout
+module LayoutHelper
+  def title(page_title, show_title = true)
+    @_content_for[:title] = page_title.to_s
+    @show_title = show_title
+  end
+  
+  def show_title?
+    @show_title
+  end
+  
+  def stylesheet(*args)
+    content_for(:head) { stylesheet_link_tag(*args) }
+  end
+  
+  def javascript(*args)
+    content_for(:head) { javascript_include_tag(*args) }
+  end
+end

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

@@ -0,0 +1,247 @@
+require 'generators/nifty'
+require 'rails/generators/migration'
+
+module Nifty
+  module Generators
+    class ScaffoldGenerator < Base
+      include Rails::Generators::Migration
+      no_tasks { attr_accessor :model_name, :model_attributes, :controller_actions }
+
+      argument :model_name, :type => :string, :required => true, :banner => 'ModelName'
+      argument :args_for_c_m, :type => :array, :default => [], :banner => 'controller_actions and model:attributes'
+
+      class_option :skip_model, :desc => 'Don\'t generate a model or migration file.', :type => :boolean
+      class_option :skip_migration, :desc => 'Dont generate migration file for model.', :type => :boolean
+      class_option :skip_timestamps, :desc => 'Don\'t add timestamps to migration file.', :type => :boolean
+      class_option :skip_controller, :desc => 'Don\'t generate controller, helper, or views.', :type => :boolean
+      class_option :invert, :desc => 'Generate all controller actions except these mentioned.', :type => :boolean
+      class_option :haml, :desc => 'Generate HAML views instead of ERB.', :type => :boolean
+
+      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
+
+      def initialize(*args, &block)
+        super
+
+        @controller_actions = []
+        @model_attributes = []
+
+        args_for_c_m.each do |arg|
+          if arg == '!'
+            options[:invert] = true
+          elsif arg.include?(':')
+            @model_attributes << Rails::Generators::GeneratedAttribute.new(*arg.split(':'))
+          else
+            @controller_actions << arg
+            @controller_actions << 'create' if arg == 'new'
+            @controller_actions << 'update' if arg == 'edit'
+          end
+        end
+
+        @controller_actions.uniq!
+        @model_attributes.uniq!
+
+        if options.invert? || @controller_actions.empty?
+          @controller_actions = all_actions - @controller_actions
+        end
+
+        if @model_attributes.empty?
+          options[:skip_model] = true # default to skipping model if no attributes passed
+          if model_exists?
+            model_columns_for_attributes.each do |column|
+              @model_attributes << Rails::Generators::GeneratedAttribute.new(column.name.to_s, column.type.to_s)
+            end
+          else
+            @model_attributes << Rails::Generators::GeneratedAttribute.new('name', 'string')
+          end
+        end
+      end
+
+      def create_model
+        unless options.skip_model?
+          template 'model.rb', "app/models/#{singular_name}.rb"
+          if options.rspec?
+            template "tests/rspec/model.rb", "spec/models/#{singular_name}_spec.rb"
+            template 'fixtures.yml', "spec/fixtures/#{plural_name}.yml"
+          else
+            template "tests/#{test_framework}/model.rb", "test/unit/#{singular_name}_test.rb"
+            template 'fixtures.yml', "test/fixtures/#{plural_name}.yml"
+          end
+        end
+      end
+
+      def create_migration
+        unless options.skip_model? || options.skip_migration?
+          migration_template 'migration.rb', "db/migrate/create_#{plural_name}.rb"
+        end
+      end
+
+      def create_controller
+        unless options.skip_controller?
+          template 'controller.rb', "app/controllers/#{plural_name}_controller.rb"
+
+          template 'helper.rb', "app/helpers/#{plural_name}_helper.rb"
+
+          controller_actions.each do |action|
+            if %w[index show new edit].include?(action) # Actions with templates
+              template "views/#{view_language}/#{action}.html.#{view_language}", "app/views/#{plural_name}/#{action}.html.#{view_language}"
+            end
+          end
+
+          if form_partial?
+            template "views/#{view_language}/_form.html.#{view_language}", "app/views/#{plural_name}/_form.html.#{view_language}"
+          end
+
+          route "resources #{plural_name.to_sym.inspect}"
+
+          if options.rspec?
+            template "tests/#{test_framework}/controller.rb", "spec/controllers/#{plural_name}_controller_spec.rb"
+          else
+            template "tests/#{test_framework}/controller.rb", "test/functional/#{plural_name}_controller_test.rb"
+          end
+        end
+      end
+
+      no_tasks do
+        def form_partial?
+          actions? :new, :edit
+        end
+
+        def all_actions
+          %w[index show new create edit update destroy]
+        end
+
+        def action?(name)
+          controller_actions.include? name.to_s
+        end
+
+        def actions?(*names)
+          names.all? { |name| action? name }
+        end
+
+        def singular_name
+          model_name.underscore
+        end
+
+        def plural_name
+          model_name.underscore.pluralize
+        end
+
+        def class_name
+          model_name.camelize
+        end
+
+        def plural_class_name
+          plural_name.camelize
+        end
+
+        def controller_methods(dir_name)
+          controller_actions.map do |action|
+            read_template("#{dir_name}/#{action}.rb")
+          end.join("  \n").strip
+        end
+
+        def render_form
+          if form_partial?
+            if options.haml?
+              "= render 'form'"
+            else
+              "<%= render 'form' %>"
+            end
+          else
+            read_template("views/#{view_language}/_form.html.#{view_language}")
+          end
+        end
+
+        def items_path(suffix = 'path')
+          if action? :index
+            "#{plural_name}_#{suffix}"
+          else
+            "root_#{suffix}"
+          end
+        end
+
+        def item_path(suffix = 'path')
+          if action? :show
+            "@#{singular_name}"
+          else
+            items_path(suffix)
+          end
+        end
+
+        def item_path_for_spec(suffix = 'path')
+          if action? :show
+            "#{singular_name}_#{suffix}(assigns[:#{singular_name}])"
+          else
+            items_path(suffix)
+          end
+        end
+
+        def item_path_for_test(suffix = 'path')
+          if action? :show
+            "#{singular_name}_#{suffix}(assigns(:#{singular_name}))"
+          else
+            items_path(suffix)
+          end
+        end
+
+        def model_columns_for_attributes
+          class_name.constantize.columns.reject do |column|
+            column.name.to_s =~ /^(id|created_at|updated_at)$/
+          end
+        end
+      end
+
+      protected
+
+      no_tasks do
+        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 = default_test_framework
+          end
+        end
+
+        def default_test_framework
+          File.exist?(destination_path("spec")) ? :rspec : :testunit
+        end
+
+        def model_exists?
+          File.exist? destination_path("app/models/#{singular_name}.rb")
+        end
+
+        def read_template(relative_path)
+          ERB.new(File.read(find_in_source_paths(relative_path)), nil, '-').result(binding)
+        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 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
+end

data/lib/generators/nifty/scaffold/templates/actions/create.rb

@@ -0,0 +1,9 @@
+  def create
+    @<%= singular_name %> = <%= class_name %>.new(params[:<%= singular_name %>])
+    if @<%= singular_name %>.save
+      flash[:notice] = "Successfully created <%= model_name.underscore.humanize.downcase %>."
+      redirect_to <%= item_path('url') %>
+    else
+      render :action => 'new'
+    end
+  end

data/lib/generators/nifty/scaffold/templates/actions/destroy.rb

@@ -0,0 +1,6 @@
+  def destroy
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+    @<%= singular_name %>.destroy
+    flash[:notice] = "Successfully destroyed <%= model_name.underscore.humanize.downcase %>."
+    redirect_to <%= items_path('url') %>
+  end

data/lib/generators/nifty/scaffold/templates/actions/edit.rb

@@ -0,0 +1,3 @@
+  def edit
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+  end

data/lib/generators/nifty/scaffold/templates/actions/index.rb

@@ -0,0 +1,3 @@
+  def index
+    @<%= plural_name %> = <%= class_name %>.all
+  end

data/lib/generators/nifty/scaffold/templates/actions/new.rb

@@ -0,0 +1,3 @@
+  def new
+    @<%= singular_name %> = <%= class_name %>.new
+  end

data/lib/generators/nifty/scaffold/templates/actions/show.rb

@@ -0,0 +1,3 @@
+  def show
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+  end

data/lib/generators/nifty/scaffold/templates/actions/update.rb

@@ -0,0 +1,9 @@
+  def update
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+    if @<%= singular_name %>.update_attributes(params[:<%= singular_name %>])
+      flash[:notice] = "Successfully updated <%= model_name.underscore.humanize.downcase %>."
+      redirect_to <%= item_path('url') %>
+    else
+      render :action => 'edit'
+    end
+  end

data/lib/generators/nifty/scaffold/templates/controller.rb

@@ -0,0 +1,3 @@
+class <%= plural_class_name %>Controller < ApplicationController
+  <%= controller_methods :actions %>
+end

data/lib/generators/nifty/scaffold/templates/helper.rb

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

data/lib/generators/nifty/scaffold/templates/migration.rb

@@ -0,0 +1,16 @@
+class Create<%= plural_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= plural_name %> do |t|
+    <%- for attribute in model_attributes -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+    <%- end -%>
+    <%- unless options[:skip_timestamps] -%>
+      t.timestamps
+    <%- end -%>
+    end
+  end
+  
+  def self.down
+    drop_table :<%= plural_name %>
+  end
+end

data/lib/generators/nifty/scaffold/templates/model.rb

@@ -0,0 +1,3 @@
+class <%= class_name %> < ActiveRecord::Base
+  attr_accessible <%= model_attributes.map { |a| ":#{a.name}" }.join(", ") %>
+end

data/lib/generators/nifty/scaffold/templates/tests/rspec/actions/create.rb

@@ -0,0 +1,11 @@
+  it "create action should render new template when model is invalid" do
+    <%= class_name %>.any_instance.stubs(:valid?).returns(false)
+    post :create
+    response.should render_template(:new)
+  end
+  
+  it "create action should redirect when model is valid" do
+    <%= class_name %>.any_instance.stubs(:valid?).returns(true)
+    post :create
+    response.should redirect_to(<%= item_path_for_spec('url') %>)
+  end

data/lib/generators/nifty/scaffold/templates/tests/rspec/actions/destroy.rb

@@ -0,0 +1,6 @@
+  it "destroy action should destroy model and redirect to index action" do
+    <%= singular_name %> = <%= class_name %>.first
+    delete :destroy, :id => <%= singular_name %>
+    response.should redirect_to(<%= items_path('url') %>)
+    <%= class_name %>.exists?(<%= singular_name %>.id).should be_false
+  end

data/lib/generators/nifty/scaffold/templates/tests/rspec/actions/edit.rb

@@ -0,0 +1,4 @@
+  it "edit action should render edit template" do
+    get :edit, :id => <%= class_name %>.first
+    response.should render_template(:edit)
+  end

data/lib/generators/nifty/scaffold/templates/tests/rspec/actions/index.rb

@@ -0,0 +1,4 @@
+  it "index action should render index template" do
+    get :index
+    response.should render_template(:index)
+  end

data/lib/generators/nifty/scaffold/templates/tests/rspec/actions/new.rb

@@ -0,0 +1,4 @@
+  it "new action should render new template" do
+    get :new
+    response.should render_template(:new)
+  end

data/lib/generators/nifty/scaffold/templates/tests/rspec/actions/show.rb

@@ -0,0 +1,4 @@
+  it "show action should render show template" do
+    get :show, :id => <%= class_name %>.first
+    response.should render_template(:show)
+  end

data/lib/generators/nifty/scaffold/templates/tests/rspec/actions/update.rb

@@ -0,0 +1,11 @@
+  it "update action should render edit template when model is invalid" do
+    <%= class_name %>.any_instance.stubs(:valid?).returns(false)
+    put :update, :id => <%= class_name %>.first
+    response.should render_template(:edit)
+  end
+  
+  it "update action should redirect when model is valid" do
+    <%= class_name %>.any_instance.stubs(:valid?).returns(true)
+    put :update, :id => <%= class_name %>.first
+    response.should redirect_to(<%= item_path_for_spec('url') %>)
+  end

data/lib/generators/nifty/scaffold/templates/tests/rspec/controller.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+ 
+describe <%= plural_class_name %>Controller do
+  fixtures :all
+  integrate_views
+  
+  <%= controller_methods 'tests/rspec/actions' %>
+end

data/lib/generators/nifty/scaffold/templates/tests/rspec/model.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe <%= class_name %> do
+  it "should be valid" do
+    <%= class_name %>.new.should be_valid
+  end
+end