zoo-generators 0.1.0

data/features/zoo_config.feature

@@ -0,0 +1,17 @@
+Feature: Zoo 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 zoo: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 zoo: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/zoo_layout.feature

@@ -0,0 +1,13 @@
+Feature: Zoo 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 zoo:layout -f"
+    Then I should see "stylesheet_link_tag "application"" in file "app/views/layouts/application.html.haml"
+    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/sass/application.sass"

data/features/zoo_scaffold.feature

@@ -0,0 +1,84 @@
+Feature: Zoo 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 zoo: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.haml      |
+      | app/views/projects/show.html.haml       |
+      | app/views/projects/new.html.haml        |
+      | app/views/projects/edit.html.haml       |
+      | 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 zoo:layout -f"
+    And I run "rake db:migrate"
+    And I should successfully run "rails g zoo:scaffold Project -f" 
+    And I run "bundle install"
+    Then I should successfully run "rake test"
+
+  Scenario: Generate scaffold with rspec tests
+    Given a new Rails app
+    When I run "rails g zoo: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 zoo: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 zoo: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"
+    And I run "bundle install"
+    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 zoo:scaffold name:string parent_id:integer"
+
+  Scenario: Generate scaffold for namespaced resource
+    Given a new Rails app
+    When I run "rails g zoo: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.haml      |
+      | app/views/admin/users/show.html.haml       |
+      | app/views/admin/users/new.html.haml        |
+      | app/views/admin/users/edit.html.haml       |
+      | 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 zoo:layout -f"
+    And I run "rake db:migrate"
+    And I should successfully run "rails g zoo:scaffold Admin::User -f"    
+    And I run "bundle install"
+    Then I should successfully run "rake test"
+
+  Scenario: Generate scaffold with a namespaced model
+    Given a new Rails app
+    When I run "rails g zoo: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 zoo:layout -f"
+    And I run "rake db:migrate"
+    And I should successfully run "rails g zoo:scaffold Admin::User -f --namespace_model"   
+    And I run "bundle install"
+    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 zoo:scaffold Project name:string index new"
+    Then I should see "class Project" in file "app/models/project.rb"
+    And I should see "= semantic_form_for @project do |f|" in file "app/views/projects/new.html.haml"

data/lib/generators/zoo.rb

@@ -0,0 +1,28 @@
+require 'rails/generators/base'
+
+module Zoo
+  module Generators
+    class Base < Rails::Generators::Base #:nodoc:
+      def self.source_root
+        @_haml_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'zoo', generator_name, 'templates'))
+      end
+
+      def self.banner
+        "rails generate zoo:#{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

data/lib/generators/zoo/authentication/USAGE

@@ -0,0 +1,46 @@
+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 haml_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.
+
+Examples:
+    rails generate zoo:authentication
+
+        Creates user model, users_controller, and sessions_controller.
+
+    rails generate zoo:authentication account
+
+        Creates account model, accounts_controller, and sessions_controller.
+
+    rails generate zoo: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/zoo/authentication/authentication_generator.rb

@@ -0,0 +1,151 @@
+require 'generators/zoo'
+require 'rails/generators/migration'
+
+module Zoo
+  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 => 'session', :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
+ 
+      def add_gems                        
+         add_gem "haml-rails"
+         add_gem "bcrypt-ruby", :require => "bcrypt"
+         add_gem "mocha", :group => :test  
+       end   
+
+      def create_model_files
+        template 'user.rb', "app/models/#{user_singular_name}.rb"
+      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 create_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}/edit.html.#{view_language}", "app/views/#{user_plural_name}/edit.html.#{view_language}"
+        template "views/#{view_language}/_form.html.#{view_language}", "app/views/#{user_plural_name}/_form.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 'controller_authentication.rb', 'lib/controller_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"
+        route "match '#{user_singular_name}/edit' => '#{user_plural_name}#edit', :as => :edit_current_#{user_singular_name}"
+      end
+
+      def create_migration
+        migration_template 'migration.rb', "db/migrate/create_#{user_plural_name}.rb"
+      end
+
+      def load_and_include_authentication
+        inject_into_class "config/application.rb", "Application", "    config.autoload_paths << \"\#{config.root}/lib\""
+        inject_into_class "app/controllers/application_controller.rb", "ApplicationController", "  include ControllerAuthentication\n"
+      end
+
+      def create_test_files
+        if test_framework == :rspec
+          template 'factory.rb', "spec/factories/#{user_plural_name}.rb"  
+          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 'factory.rb', "test/factories/#{user_plural_name}.rb"          
+          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
+      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
+        'haml'
+      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

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

@@ -0,0 +1,48 @@
+# This module is included in your application controller which makes
+# several methods available to all controllers and views. Here's a
+# common example you might add to your application layout file.
+#
+#   <%% if logged_in? %>
+#     Welcome <%%= current_<%= user_singular_name %>.username %>.
+#     <%%= 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
+#     <%%= 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]
+module ControllerAuthentication
+  def self.included(controller)
+    controller.send :helper_method, :current_<%= user_singular_name %>, :logged_in?, :redirect_to_target_or_default
+  end
+
+  def current_<%= user_singular_name %>
+    @current_<%= user_singular_name %> ||= <%= user_class_name %>.find(session[:<%= user_singular_name %>_id]) if session[:<%= user_singular_name %>_id]
+  end
+
+  def logged_in?
+    current_<%= user_singular_name %>
+  end
+
+  def login_required
+    unless logged_in?
+      store_target_location
+      redirect_to login_url, :alert => "You must first log in or sign up before accessing this page."
+    end
+  end
+
+  def redirect_to_target_or_default(default, *args)
+    redirect_to(session[:return_to] || default, *args)
+    session[:return_to] = nil
+  end
+
+  private
+
+  def store_target_location
+    session[:return_to] = request.url
+  end
+end

data/lib/generators/zoo/authentication/templates/factory.rb

@@ -0,0 +1,6 @@
+Factory.define :<%= user_singular_name %> do |<%= user_singular_name %>|
+  <%= user_singular_name %>.username 'bar'
+  <%= user_singular_name %>.email 'bar@example.com'
+  <%= user_singular_name %>.password_hash '3488f5f7efecab14b91eb96169e5e1ee518a569f''
+  <%= user_singular_name %>.password_salt 'bef65e058905c379436d80d1a32e7374b139e7b0'
+end

data/lib/generators/zoo/authentication/templates/fixtures.yml

@@ -0,0 +1,12 @@
+# password: "secret"
+foo:
+  username: foo
+  email: foo@example.com
+  password_hash: 3488f5f7efecab14b91eb96169e5e1ee518a569f
+  password_salt: bef65e058905c379436d80d1a32e7374b139e7b0
+
+bar:
+  username: bar
+  email: bar@example.com
+  password_hash: 3488f5f7efecab14b91eb96169e5e1ee518a569f
+  password_salt: bef65e058905c379436d80d1a32e7374b139e7b0

data/lib/generators/zoo/authentication/templates/migration.rb

@@ -0,0 +1,15 @@
+class Create<%= user_plural_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= user_plural_name %> do |t|
+      t.string :username
+      t.string :email
+      t.string :password_hash
+      t.string :password_salt
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :<%= user_plural_name %>
+  end
+end

data/lib/generators/zoo/authentication/templates/sessions_controller.rb

@@ -0,0 +1,20 @@
+class <%= session_plural_class_name %>Controller < ApplicationController
+  def new
+  end
+
+  def create
+    <%= user_singular_name %> = <%= user_class_name %>.authenticate(params[:login], params[:password])
+    if <%= user_singular_name %>
+      session[:<%= user_singular_name %>_id] = <%= user_singular_name %>.id
+      redirect_to_target_or_default root_url, :notice => "Logged in successfully."
+    else
+      flash.now[:alert] = "Invalid login or password."
+      render :new
+    end
+  end
+
+  def destroy
+    session[:<%= user_singular_name %>_id] = nil
+    redirect_to root_url, :notice => "You have been logged out."
+  end
+end