niftier-generators 0.1.0

data/lib/generators/niftier/authentication/templates/views/haml/signup.html.haml

@@ -0,0 +1,24 @@
+- title "Sign up"
+
+%p== Already have an account? #{link_to "Log in", login_path}.
+
+- form_for @<%= user_singular_name %> do |f|
+  = f.error_messages
+  %p
+    = f.label :username
+    %br
+    = f.text_field :username
+  %p
+    = f.label :email, "Email Address"
+    %br
+    = f.text_field :email
+  %p
+    = f.label :password
+    %br
+    = f.password_field :password
+  %p
+    = f.label :password_confirmation, "Confirm Password"
+    %br
+    = f.password_field :password_confirmation
+  %p
+    = f.submit "Sign up"

data/lib/generators/niftier/config/USAGE

@@ -0,0 +1,23 @@
+Description:
+    The niftier_config generator creates YAML file in your config
+    directory and an initializer to load this config. The config has a
+    separate section for each environment. This is a great place to put
+    any config settings you don't want in your app.
+  
+    The config is loaded into a constant called APP_CONFIG by default,
+    this changes depending on the name you choose to pass the generator.
+    Use this constant to access the config settings like this.
+  
+    APP_CONFIG[:some_setting]
+
+
+Examples:
+    rails generate niftier:config
+
+        Config:      config/app_config.yml
+        Initializer: config/initializers/load_app_config.rb
+
+    rails generate niftier:config passwords
+
+        Config:      config/passwords_config.yml
+        Initializer: config/initializers/load_passwords_config.rb

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

@@ -0,0 +1,24 @@
+require 'generators/niftier'
+
+module Niftier
+  module Generators
+    class ConfigGenerator < Base
+      argument :config_name, :type => :string, :default => 'app', :banner => 'config_name'
+      
+      def create_config
+        template "load_config.rb", "config/initializers/load_#{file_name}_config.rb"
+        copy_file "config.yml", "config/#{file_name}_config.yml"
+      end
+    
+      private
+      
+      def file_name
+        config_name.underscore
+      end
+
+      def constant_name
+        config_name.underscore.upcase
+      end
+    end
+  end
+end

data/lib/generators/niftier/config/templates/config.yml

@@ -0,0 +1,14 @@
+global: &global_settings
+  site_name: Site Name
+
+development:
+  domain: localhost:3000
+  <<: *global_settings  
+
+test:
+  domain: test.host
+  <<: *global_settings
+
+production:
+  domain: example.com
+  <<: *global_settings

data/lib/generators/niftier/config/templates/load_config.rb

@@ -0,0 +1,2 @@
+raw_config = File.read("#{Rails.root}/config/<%= file_name %>_config.yml")
+<%= constant_name %>_CONFIG = YAML.load(raw_config)[Rails.env].symbolize_keys

data/lib/generators/niftier/layout/USAGE

@@ -0,0 +1,25 @@
+Description:
+  The niftier_layout generator creates a basic layout, stylesheet and
+  helper which will give some structure to a starting Rails app.
+  
+  The generator takes one argument which will be the name of the
+	layout and stylesheet files. If no argument is passed then it defaults
+	to "application".
+  
+  The helper module includes some methods which can be called in any
+  template or partial to set variables to be used in the layout, such as
+  page title and javascript/stylesheet includes.
+
+Examples:
+    rails generate niftier:layout
+
+        Layout:     app/views/layouts/application.html.erb
+        Stylesheet: public/stylesheets/application.css
+        Helper:     app/helpers/layout_helper.rb
+
+
+    rails generate niftier:layout admin
+
+        Layout:     app/views/layouts/admin.html.erb
+        Stylesheet: public/stylesheets/admin.css
+        Helper:     app/helpers/layout_helper.rb

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

@@ -0,0 +1,29 @@
+require 'generators/niftier'
+
+module Niftier
+  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 'layout_helper.rb', 'app/helpers/layout_helper.rb'
+        copy_file 'error_messages_helper.rb', 'app/helpers/error_messages_helper.rb'
+      end
+      
+      private
+      
+      def file_name
+        layout_name.underscore
+      end
+    end
+  end
+end

data/lib/generators/niftier/layout/templates/error_messages_helper.rb

@@ -0,0 +1,23 @@
+module ErrorMessagesHelper
+  # Render error messages for the given objects. The :message and :header_message options are allowed.
+  def error_messages_for(*objects)
+    options = objects.extract_options! 
+    options[:header_message] ||= "Invalid Fields"
+    options[:message] ||= "Correct the following errors and try again."
+    messages = objects.compact.map { |o| o.errors.full_messages }.flatten
+    unless messages.empty?
+      content_tag(:div, :class => "error_messages") do
+        list_items = messages.map { |msg| content_tag(:li, msg) }
+        content_tag(:h2, options[:header_message]) + content_tag(:p, options[:message]) + content_tag(:ul, list_items.join.html_safe)
+      end
+    end
+  end
+  
+  module FormBuilderAdditions
+    def error_messages(options = {})
+      @template.error_messages_for(@object, options)
+    end
+  end
+end
+
+ActionView::Helpers::FormBuilder.send(:include, ErrorMessagesHelper::FormBuilderAdditions)

data/lib/generators/niftier/layout/templates/layout.html.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%%= content_for?(:title) ? yield(:title) : "Untitled" %></title>
+    <%% stylesheet "<%= file_name %>" %>
+    <%% javascript :defaults %>
+    <%%= csrf_meta_tag %>
+    <%%= yield(:stylesheets) %>
+  </head>
+  <body>
+    <div id="container">
+      <%% flash.each do |name, msg| %>
+        <%%= content_tag :div, msg, :id => "flash_#{name}" %>
+      <%% end %>
+      <%%= content_tag :h1, yield(:title) if show_title? %>
+      <%%= yield %>
+    </div>
+    
+    <%%= yield(:javascripts) %>
+    <%% if content_for?(:onload_scripts) %>
+      <%%= javascript_tag "$(document).ready(function() { #{yield(:onload_scripts)} });" %>
+    <%% end %>
+  </body>
+</html>

data/lib/generators/niftier/layout/templates/layout.html.haml

@@ -0,0 +1,26 @@
+!!!
+%html
+  
+  %head
+    %title
+      = content_for?(:title) ? yield(:title) : "Untitled"
+    %meta{"http-equiv"=>"Content-Type", :content=>"text/html; charset=utf-8"}/
+    - stylesheet "<%= file_name %>"
+    - javascript :defaults
+    = csrf_meta_tag
+    = yield(:stylesheets)
+  
+  %body
+    #container
+      - flash.each do |name, msg|
+        = content_tag :div, msg, :id => "flash_#{name}"
+      
+      - if show_title?
+        %h1= yield(:title)
+      
+      = yield
+      
+    = yield(:javascripts)
+    - if content_for?(:onload_scripts)
+      :javascript
+        $(document).ready(function() { #{yield(:onload_scripts)} });

data/lib/generators/niftier/layout/templates/layout_helper.rb

@@ -0,0 +1,26 @@
+# 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(:stylesheets) { stylesheet_link_tag(*args) }
+  end
+  
+  def javascript(*args)
+    content_for(:javascripts) { javascript_include_tag(*args) }
+  end
+  
+  def onload(str)
+    content_for(:onload_scripts) { str + "\n" }
+  end
+end

data/lib/generators/niftier/layout/templates/stylesheet.css

@@ -0,0 +1,75 @@
+body {
+  background-color: #4B7399;
+  font-family: Verdana, Helvetica, Arial;
+  font-size: 14px;
+}
+
+a img {
+  border: none;
+}
+
+a {
+  color: #0000FF;
+}
+
+.clear {
+  clear: both;
+  height: 0;
+  overflow: hidden;
+}
+
+#container {
+  width: 75%;
+  margin: 0 auto;
+  background-color: #FFF;
+  padding: 20px 40px;
+  border: solid 1px black;
+  margin-top: 20px;
+}
+
+#flash_notice, #flash_error, #flash_alert {
+  padding: 5px 8px;
+  margin: 10px 0;
+}
+
+#flash_notice {
+  background-color: #CFC;
+  border: solid 1px #6C6;
+}
+
+#flash_error, #flash_alert {
+  background-color: #FCC;
+  border: solid 1px #C66;
+}
+
+.fieldWithErrors {
+  display: inline;
+}
+
+.error_messages {
+  width: 400px;
+  border: 2px solid #CF0000;
+  padding: 0px;
+  padding-bottom: 12px;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+  font-size: 12px;
+}
+
+.error_messages h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 10px;
+  font-size: 12px;
+  margin: 0;
+  background-color: #c00;
+  color: #fff;
+}
+
+.error_messages p {
+  margin: 8px 10px;
+}
+
+.error_messages ul {
+  margin: 0;
+}

data/lib/generators/niftier/layout/templates/stylesheet.sass

@@ -0,0 +1,66 @@
+!primary_color = #4B7399
+
+body
+  background-color = !primary_color
+  font:
+    family: Verdana, Helvetica, Arial
+    size: 14px
+
+a
+  color: #0000FF
+  img
+    border: none
+
+.clear
+  clear: both
+  height: 0
+  overflow: hidden
+
+#container
+  width: 75%
+  margin: 0 auto
+  background: #fff
+  padding: 20px 40px
+  border: solid 1px black
+  margin-top: 20px
+
+#flash_notice,
+#flash_error,
+#flash_alert
+  padding: 5px 8px
+  margin: 10px 0
+
+#flash_notice
+  background-color: #CFC
+  border: solid 1px #6C6
+
+#flash_error,
+#flash_alert
+  background-color: #FCC
+  border: solid 1px #C66
+
+.fieldWithErrors
+  display: inline
+
+.error_messages
+  width: 400px
+  border: 2px solid #CF0000
+  padding: 0
+  padding-bottom: 12px
+  margin-bottom: 20px
+  background-color: #f0f0f0
+  font:
+    size: 12px
+  h2
+    text-align: left
+    padding: 5px 5px 5px 15px
+    margin: 0
+    font:
+      weight: bold
+      size: 12px
+    background-color: #c00
+    color: #fff
+  p
+    margin: 8px 10px
+  ul
+    margin: 0

data/lib/generators/niftier/scaffold/USAGE

@@ -0,0 +1,51 @@
+Description:
+    Scaffolds an entire resource, from model and migration to controller and
+    views. The resource is ready to use as a starting point for your restful,
+    resource-oriented application. Tests or specs are also generated depending
+    on if you have a "spec" directory or not.
+    
+    IMPORTANT: This generator uses the "title" helper method which is generated
+    by the niftier_layout generator. You may want to run that generator first.
+
+Usage:
+    Pass the name of the model, either CamelCased or under_scored, as the first
+    argument along with an optional list of attribute pairs and controller actions.
+    
+    If no controller actions are specified, they will default to index, show,
+    new, create, edit, update, and destroy.
+    
+    IMPORTANT: If no attribute pairs are specified, no model will be generated.
+    It will try to determine the attributes from an existing model.
+
+    Attribute pairs are column_name:sql_type arguments specifying the
+    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, `niftier: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
+    declaration in config/routes.rb.
+    
+    Adding an "!" in the mix of arguments will invert the passed controller
+    actions. This will include all 7 controller actitons except the ones
+    mentioned. This option doesn't affect model attributes.
+
+Examples:
+    rails generate niftier:scaffold post
+        
+        Will create a controller called "posts" it will contain all seven
+        CRUD actions along with the views. A model will NOT be created,
+        instead it will look for an existing model and use those attributes.
+    
+    rails generate niftier:scaffold post name:string content:text index new edit
+        
+        Will create a Post model and migration file with the name and content
+        attributes. It will also create a controller with index, new, create,
+        edit, and update actions. Notice the create and update actions are
+        added automatically with new and edit.
+    
+    rails generate niftier:scaffold post ! show new
+        
+        Creates a posts controller (no model) with index, edit, update, and
+        destroy actions.

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

@@ -0,0 +1,241 @@
+require 'generators/niftier'
+require 'rails/generators/migration'
+require 'rails/generators/generated_attribute'
+
+module Niftier
+  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
+
+      private
+      
+      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
+
+      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 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