RubyGems - nifty-generators - Versions diffs - 0.1.7 - Mend

nifty-generators 0.1.7

Files changed (76) hide show

data/rails_generators/nifty_config/templates/config.yml ADDED

@@ -0,0 +1,8 @@
+development:
+  domain: localhost:3000
+test:
+  domain: test.host
+production:
+  domain: example.com

data/rails_generators/nifty_config/templates/load_config.rb ADDED

	@@ -0,0 +1,2 @@
1	+ raw_config = File.read(RAILS_ROOT + "/config/<%= file_name %>_config.yml")
2	+ <%= constant_name %>_CONFIG = YAML.load(raw_config)[RAILS_ENV].symbolize_keys

data/rails_generators/nifty_layout/USAGE ADDED

@@ -0,0 +1,25 @@
+Description:
+  The nifty_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:
+    script/generate nifty_layout
+        Layout:     app/views/layouts/application.html.erb
+        Stylesheet: public/stylesheets/application.css
+        Helper:     app/helpers/layout_helper.rb
+    script/generate nifty_layout admin
+        Layout:     app/views/layouts/admin.html.erb
+        Stylesheet: public/stylesheets/admin.css
+        Helper:     app/helpers/layout_helper.rb

data/rails_generators/nifty_layout/nifty_layout_generator.rb ADDED

@@ -0,0 +1,44 @@
+class NiftyLayoutGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @name = @args.first || 'application'
+  end
+  def manifest
+    record do |m|
+      m.directory 'app/views/layouts'
+      m.directory 'public/stylesheets'
+      m.directory 'app/helpers'
+      if options[:haml]
+        m.directory 'public/stylesheets/sass'
+        m.template "layout.html.haml", "app/views/layouts/#{file_name}.html.haml"
+        m.file     "stylesheet.sass",  "public/stylesheets/sass/#{file_name}.sass"
+      else
+        m.template "layout.html.erb", "app/views/layouts/#{file_name}.html.erb"
+        m.file     "stylesheet.css",  "public/stylesheets/#{file_name}.css"
+      end
+      m.file "helper.rb", "app/helpers/layout_helper.rb"
+    end
+  end
+  def file_name
+    @name.underscore
+  end
+  protected
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--haml", "Generate HAML for view, and SASS for stylesheet.") { |v| options[:haml] = v }
+    end
+    def banner
+      <<-EOS
+Creates generic layout, stylesheet, and helper files.
+USAGE: #{$0} #{spec.name} [layout_name]
+EOS
+    end
+end

data/rails_generators/nifty_layout/templates/helper.rb ADDED

@@ -0,0 +1,23 @@
+# 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.map(&:to_s)) }
+  end
+  def javascript(*args)
+    args = args.map { |arg| arg == :defaults ? arg : arg.to_s }
+    content_for(:head) { javascript_include_tag(*args) }
+  end
+end

data/rails_generators/nifty_layout/templates/layout.html.erb ADDED

@@ -0,0 +1,22 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+  <head>
+    <title><%%= h(yield(:title) || "Untitled") %></title>
+    <%%= stylesheet_link_tag '<%= file_name %>' %>
+    <%%= yield(:head) %>
+  </head>
+  <body>
+    <div id="container">
+      <%%- flash.each do |name, msg| -%>
+        <%%= content_tag :div, msg, :id => "flash_#{name}" %>
+      <%%- end -%>
+      <%%- if show_title? -%>
+        <h1><%%=h yield(:title) %></h1>
+      <%%- end -%>
+      <%%= yield %>
+    </div>
+  </body>
+</html>

data/rails_generators/nifty_layout/templates/layout.html.haml ADDED

@@ -0,0 +1,19 @@
+!!! Strict
+%html{html_attrs}
+  %head
+    %title
+      = h(yield(:title) || "Untitled")
+    %meta{"http-equiv"=>"Content-Type", :content=>"text/html; charset=utf-8"}/
+    = stylesheet_link_tag '<%= file_name %>'
+    = yield(:head)
+  %body
+    #container
+      - flash.each do |name, msg|
+        = content_tag :div, msg, :id => "flash_#{name}"
+      - if show_title?
+        %h1=h yield(:title)
+      = yield

data/rails_generators/nifty_layout/templates/stylesheet.css ADDED

@@ -0,0 +1,80 @@
+body {
+  background-color: #4B7399;
+  font-family: Verdana, Helvetica, Arial;
+  font-size: 14px;
+}
+a img {
+  border: none;
+}
+a {
+  color: #0000FF;
+}
+.clear {
+  clear: both;
+  height: 0px;
+  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 {
+  padding: 5px 8px;
+  margin: 10px 0;
+}
+#flash_notice {
+  background-color: #CFC;
+  border: solid 1px #6C6;
+}
+#flash_error {
+  background-color: #FCC;
+  border: solid 1px #C66;
+}
+.fieldWithErrors {
+  display: inline;
+}
+#errorExplanation {
+  width: 400px;
+  border: 2px solid #CF0000;
+  padding: 0px;
+  padding-bottom: 12px;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+#errorExplanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+#errorExplanation p {
+  color: #333;
+  margin-bottom: 0;
+  padding: 8px;
+}
+#errorExplanation ul {
+  margin: 2px 24px;
+}
+#errorExplanation ul li {
+  font-size: 12px;
+  list-style: disc;
+}

data/rails_generators/nifty_layout/templates/stylesheet.sass ADDED

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

data/rails_generators/nifty_scaffold/USAGE ADDED

@@ -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 nifty_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, and 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, `nifty_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 effect model attributes.
+Examples:
+    script/generate nifty_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.
+    script/generate nifty_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.
+    script/generate nifty_scaffold post ! show new
+        Creates a posts controller (no model) with index, edit, update, and
+        destroy actions.

data/rails_generators/nifty_scaffold/nifty_scaffold_generator.rb ADDED

@@ -0,0 +1,224 @@
+class NiftyScaffoldGenerator < Rails::Generator::Base
+  attr_accessor :name, :attributes, :controller_actions
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if @args.empty?
+    @name = @args.first
+    @controller_actions = []
+    @attributes = []
+    @args[1..-1].each do |arg|
+      if arg == '!'
+        options[:invert] = true
+      elsif arg.include? ':'
+        @attributes << Rails::Generator::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!
+    @attributes.uniq!
+    if options[:invert] || @controller_actions.empty?
+      @controller_actions = all_actions - @controller_actions
+    end
+    if @attributes.empty?
+      options[:skip_model] = true # default to skipping model if no attributes passed
+      if model_exists?
+        model_columns_for_attributes.each do |column|
+          @attributes << Rails::Generator::GeneratedAttribute.new(column.name.to_s, column.type.to_s)
+        end
+      else
+        @attributes << Rails::Generator::GeneratedAttribute.new('name', 'string')
+      end
+    end
+  end
+  def manifest
+    record do |m|
+      unless options[:skip_model]
+        m.directory "app/models"
+        m.template "model.rb", "app/models/#{singular_name}.rb"
+        unless options[:skip_migration]
+          m.migration_template "migration.rb", "db/migrate", :migration_file_name => "create_#{plural_name}"
+        end
+        if rspec?
+          m.directory "spec/models"
+          m.template "tests/#{test_framework}/model.rb", "spec/models/#{singular_name}_spec.rb"
+          m.directory "spec/fixtures"
+          m.template "fixtures.yml", "spec/fixtures/#{plural_name}.yml"
+        else
+          m.directory "test/unit"
+          m.template "tests/#{test_framework}/model.rb", "test/unit/#{singular_name}_test.rb"
+          m.directory "test/fixtures"
+          m.template "fixtures.yml", "test/fixtures/#{plural_name}.yml"
+        end
+      end
+      unless options[:skip_controller]
+        m.directory "app/controllers"
+        m.template "controller.rb", "app/controllers/#{plural_name}_controller.rb"
+        m.directory "app/helpers"
+        m.template "helper.rb", "app/helpers/#{plural_name}_helper.rb"
+        m.directory "app/views/#{plural_name}"
+        controller_actions.each do |action|
+          if File.exist? source_path("views/#{view_language}/#{action}.html.#{view_language}")
+            m.template "views/#{view_language}/#{action}.html.#{view_language}", "app/views/#{plural_name}/#{action}.html.#{view_language}"
+          end
+        end
+        if form_partial?
+          m.template "views/#{view_language}/_form.html.#{view_language}", "app/views/#{plural_name}/_form.html.#{view_language}"
+        end
+        m.route_resources plural_name
+        if rspec?
+          m.directory "spec/controllers"
+          m.template "tests/#{test_framework}/controller.rb", "spec/controllers/#{plural_name}_controller_spec.rb"
+        else
+          m.directory "test/functional"
+          m.template "tests/#{test_framework}/controller.rb", "test/functional/#{plural_name}_controller_test.rb"
+        end
+      end
+    end
+  end
+  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? { |n| action? n.to_s }
+  end
+  def singular_name
+    name.underscore
+  end
+  def plural_name
+    name.underscore.pluralize
+  end
+  def class_name
+    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 :partial => 'form'"
+      else
+        "<%= render :partial => 'form' %>"
+      end
+    else
+      read_template("views/#{view_language}/_form.html.#{view_language}")
+    end
+  end
+  def item_path(suffix = 'path')
+    if action? :show
+      "@#{singular_name}"
+    else
+      "#{plural_name}_#{suffix}"
+    end
+  end
+  def item_path_for_spec(suffix = 'path')
+    if action? :show
+      "#{singular_name}_#{suffix}(assigns[:#{singular_name}])"
+    else
+      "#{plural_name}_#{suffix}"
+    end
+  end
+  def item_path_for_test(suffix = 'path')
+    if action? :show
+      "#{singular_name}_#{suffix}(assigns(:#{singular_name}))"
+    else
+      "#{plural_name}_#{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 rspec?
+    test_framework == :rspec
+  end
+protected
+  def view_language
+    options[:haml] ? 'haml' : 'erb'
+  end
+  def test_framework
+    options[:test_framework] ||= default_test_framework
+  end
+  def default_test_framework
+    File.exist?(destination_path("spec")) ? :rspec : :testunit
+  end
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--skip-model", "Don't generate a model or migration file.") { |v| options[:skip_model] = v }
+    opt.on("--skip-migration", "Don't generate migration file for model.") { |v| options[:skip_migration] = v }
+    opt.on("--skip-timestamps", "Don't add timestamps to migration file.") { |v| options[:skip_timestamps] = v }
+    opt.on("--skip-controller", "Don't generate controller, helper, or views.") { |v| options[:skip_controller] = v }
+    opt.on("--invert", "Generate all controller actions except these mentioned.") { |v| options[:invert] = v }
+    opt.on("--haml", "Generate HAML views instead of ERB.") { |v| options[:haml] = v }
+    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 }
+  end
+  # is there a better way to do this? Perhaps with const_defined?
+  def model_exists?
+    File.exist? destination_path("app/models/#{singular_name}.rb")
+  end
+  def read_template(relative_path)
+    ERB.new(File.read(source_path(relative_path)), nil, '-').result(binding)
+  end
+  def banner
+    <<-EOS
+Creates a controller and optional model given the name, actions, and attributes.
+USAGE: #{$0} #{spec.name} ModelName [controller_actions and model:attributes] [options]
+EOS
+  end
+end