starter_generators 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cee8a6570c3e44af9bf5881f999f767638f1a590
+  data.tar.gz: 16eedfc1d066c213eb49b40de2c0c380a36fbc2e
+SHA512:
+  metadata.gz: 6f213c9162741d3182898b05c2826d92862858799469840839dececa13629401fdd7f0903aea116cbe09cdb125f1782c4af989a85f27fa6a7d61cbc27477334a
+  data.tar.gz: 1b41a751355e0dc9bea5a8abccaacc56322f7ae0009bd6a93bb431a752d913fc7283f52d9edece3406a79bf8199c6ef528e415b5cde7f4237e4ecece0f369e3f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## Version 0.3.1  (March 30, 2013) ##
+
+* Fix edit templates to use @ivar in the form_tag call.
+
+## Version 0.3 ##
+
+* Add --named-routes option to starter:resource
+* Add --styled option to starter:resource
+
+## Version 0.2 (March 24, 2013) ##
+
+* Add starter:style generator to make it easy to apply a bootswatch.  Not complete but mostly there.
+
+## Version 0.1 (March 24, 2013) ##
+
+* Properly close the erb tag for the link to the show action in the index template.  Also add a leading slash in the url.
+* Added a destroy a link to the index template.
+
+## Version 0.0.1 (March 22, 2013) ##
+
+* First attempt.

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jeff Cohen
+
+MIT License
+
+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.md

@@ -0,0 +1,23 @@
+# StarterGenerators
+
+Rails generators that are helpful in class.
+
+Currently there are two generators, **starter:resource** and **starter::style**.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'starter_generators', git: 'git@github.com:starterleague/starter_generators.git'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+For full usage instructions, run:
+
+    $ rails g starter:resource
+    $ rails g starter:style
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/starter/resource/USAGE

@@ -0,0 +1,35 @@
+Description:
+    Generates an example of one entire database-backed 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.
+
+    Pass the name of the model (in singular form), either CamelCased or
+    under_scored, as the first argument, and an optional list of attribute
+    pairs.
+
+    Attributes are field arguments specifying the model's attributes. You can
+    optionally pass the type and an index to each field. For instance:
+    "title body:text tracking_id:integer:uniq" will generate a title field of
+    string type, a body with text type and a tracking_id as an integer with an
+    unique index. "index" could also be given instead of "uniq" if one desires
+    a non unique index.
+
+    Timestamps are added by default, so you don't have to specify them by hand
+    as 'created_at:datetime updated_at:datetime'.
+
+    You don't have to think up every attribute up front, but it helps to
+    sketch out a few so you can start working with the resource immediately.
+
+    For example, 'starter:resource post title body:text published: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 the Golden Seven "RESTful" routes
+    in config/routes.rb.
+
+    If you want to remove all the generated files, first rollback your migration
+    if you've already run 'rake db:migrate'.  Then run
+    'rails destroy resource ModelName'.
+
+Examples:
+    `rails generate starter:resource post title body:text published:boolean`
+    `rails generate starter:resource purchase amount:decimal tracking_id:integer:uniq`

data/lib/generators/starter/resource/migration.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  module Generators
+    module Migration
+      # Implement the required interface for Rails::Generators::Migration.
+      def next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+    end
+  end
+end

data/lib/generators/starter/resource/resource_generator.rb

@@ -0,0 +1,124 @@
+require 'rails/generators/active_record'
+require_relative './migration'
+module Starter
+  class ResourceGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+    include Rails::Generators::ResourceHelpers
+    include Rails::Generators::Migration
+    extend ActiveRecord::Generators::Migration
+
+    argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+    remove_class_option :old_style_hash
+    class_option :named_routes, :type => :boolean, :default => false
+    class_option :styled, :type => :boolean, :default => false, desc: 'Generates bootstrap-ready view templates'
+
+    def generate_controller
+      template 'controller.rb', "app/controllers/#{plural_name.underscore}_controller.rb"
+    end
+
+    def generate_model
+      template 'model.rb', "app/models/#{singular_name.underscore}.rb"
+    end
+
+    def generate_migration
+      migration_template "migration.rb", "db/migrate/create_#{table_name}.rb"
+    end
+
+    # def create_root_view_folder
+    #   empty_directory File.join("app/views", controller_file_path)
+    # end
+
+    def copy_view_files
+      available_views.each do |view|
+        filename = view_filename_with_extensions(view)
+        template filename, File.join("app/views", controller_file_path, File.basename(filename))
+      end
+    end
+
+
+    def generate_routes
+      if named_routes?
+        route golden_7_named, "Named RESTful routes"
+      else
+        route golden_7, "RESTful routes"
+      end
+    end
+
+protected
+
+  def golden_7
+    ["# Routes for the #{singular_name.capitalize} resource:",
+        "  # CREATE",
+        "  get '/#{plural_name}/new', controller: '#{plural_name}', action: 'new'",
+        "  post '/#{plural_name}', controller: '#{plural_name}', action: 'create'",
+        "",
+        "  # READ",
+        "  get '/#{plural_name}', controller: '#{plural_name}', action: 'index'",
+        "  get '/#{plural_name}/:id', controller: '#{plural_name}', action: 'show'",
+        "",
+        "  # UPDATE",
+        "  get '/#{plural_name}/:id/edit', controller: '#{plural_name}', action: 'edit'",
+        "  put '/#{plural_name}/:id', controller: '#{plural_name}', action: 'update'",
+        "",
+        "  # DELETE",
+        "  delete '/#{plural_name}/:id', controller: '#{plural_name}', action: 'destroy'",
+        "  ##{'-' * 30}"
+      ].join("\n")
+  end
+
+  def golden_7_named
+    ["# Routes for the #{singular_name.capitalize} resource:",
+      "  # CREATE",
+      "  get '/#{plural_name}/new', controller: '#{plural_name}', action: 'new', as: 'new_#{singular_name}'",
+      "  post '/#{plural_name}', controller: '#{plural_name}', action: 'create'",
+      "",
+      "  # READ",
+      "  get '/#{plural_name}', controller: '#{plural_name}', action: 'index', as: '#{plural_name}'",
+      "  get '/#{plural_name}/:id', controller: '#{plural_name}', action: 'show', as: '#{singular_name}'",
+      "",
+      "  # UPDATE",
+      "  get '/#{plural_name}/:id/edit', controller: '#{plural_name}', action: 'edit', as: 'edit_#{singular_name}'",
+      "  put '/#{plural_name}/:id', controller: '#{plural_name}', action: 'update'",
+      "",
+      "  # DELETE",
+      "  delete '/#{plural_name}/:id', controller: '#{plural_name}', action: 'destroy'",
+      "  ##{'-' * 30}"
+      ].join("\n")
+  end
+
+  def named_routes?
+    options[:named_routes]
+  end
+
+  def styled?
+    options[:styled]
+  end
+
+  # Override of Rails::Generators::Actions
+  def route(routing_code, title)
+    log :route, title
+    sentinel = /\.routes\.draw do(?:\s*\|map\|)?\s*$/
+
+    in_root do
+      inject_into_file 'config/routes.rb', "\n  #{routing_code}\n", { :after => sentinel, :verbose => false }
+    end
+  end
+
+  def attributes_with_index
+    attributes.select { |a| a.has_index? || (a.reference? && options[:indexes]) }
+  end
+
+  def available_views
+    %w(index new edit show)
+  end
+
+  def view_filename_with_extensions(name)
+    filename = [name, :html, :erb].compact.join(".")
+    if styled?
+      filename = File.join("bootstrapped", filename)
+    end
+    filename
+  end
+
+  end
+end

data/lib/generators/starter/resource/templates/bootstrapped/edit.html.erb

@@ -0,0 +1,16 @@
+<h1>Editing <%= human_name.titleize %> #<%%= @<%= singular_table_name %>.id %></h1>
+
+<%%= form_tag(<%= singular_table_name %>_url(@<%= singular_table_name %>), method: 'put') do %>
+
+  <% attributes.each do |attribute| -%>
+<div>
+    <%%= label_tag :<%= attribute.name %> %><br />
+    <%%= <%= attribute.field_type %>_tag :<%= attribute.name %>, @<%= singular_table_name %>.<%= attribute.name %><%= "?" if attribute.type == :boolean %> %>
+  </div>
+
+  <% end %>
+  <div>
+    <%%= submit_tag "Update <%= human_name.titleize %>", class: 'btn' %>
+  </div>
+
+<%% end %>

data/lib/generators/starter/resource/templates/bootstrapped/index.html.erb

@@ -0,0 +1,40 @@
+<h1><%= plural_table_name.humanize %></h1>
+
+<% if named_routes? -%>
+<p><%%= link_to 'Add a New <%= human_name.titleize %>', new_<%= singular_table_name %>_url, class: 'btn' %></p>
+<% else -%>
+<p><%%= link_to 'Add a New <%= human_name.titleize %>', "/<%= plural_name %>/new", class: 'btn' %></p>
+<% end -%>
+
+<table class="table table-hover">
+  <thead>
+    <tr>
+<% attributes.each do |attribute| -%>
+      <th><%= attribute.human_name %></th>
+<% end -%>
+      <th></th>
+      <th></th>
+      <th></th>
+    </tr>
+  </thead>
+
+  <tbody>
+  <%% @<%= plural_table_name %>.each do |<%= singular_table_name %>| %>
+    <tr>
+  <% attributes.each do |attribute| -%>
+      <td><%%= <%= singular_table_name %>.<%= attribute.name %> %></td>
+  <% end -%>
+<% if named_routes? %>
+      <td><%%= link_to 'Show', <%= singular_table_name %>_url(<%= singular_table_name %>), class: 'btn' %></td>
+      <td><%%= link_to 'Edit', edit_<%= singular_table_name %>_url(<%= singular_table_name %>), class: 'btn' %></td>
+      <td><%%= link_to 'Destroy', <%= singular_table_name %>_url(<%= singular_table_name %>), method: 'delete', data: { confirm: "Do you really want to delete this <%= singular_table_name %>?" }, class: 'btn btn-danger' %></td>
+<% else %>
+      <td><%%= link_to 'Show', "/<%= plural_name %>/#{<%= singular_table_name %>.id}", class: 'btn' %></td>
+      <td><%%= link_to 'Edit', "/<%= plural_name %>/#{<%= singular_table_name %>.id}/edit", class: 'btn' %></td>
+      <td><%%= link_to 'Destroy', "/<%= plural_name %>/#{<%= singular_table_name %>.id}", method: 'delete', data: { confirm: "Do you really want to delete this <%= singular_table_name %>?" }, class: 'btn btn-danger' %></td>
+<% end %>
+    </tr>
+  <%% end %>
+  </body>
+</table>
+

data/lib/generators/starter/resource/templates/bootstrapped/new.html.erb

@@ -0,0 +1,15 @@
+<h1>New <%= human_name.titleize %></h1>
+
+<%%= form_tag(<%= plural_name %>_url, method: 'post') do %>
+
+<% attributes.each do |attribute| -%>
+  <div>
+    <%%= label_tag :<%= attribute.name %> %><br />
+    <%%= <%= attribute.field_type %>_tag :<%= attribute.name %><%= "?" if attribute.type == :boolean %> %>
+  </div>
+
+  <% end %>
+  <div>
+    <%%= submit_tag "Create <%= human_name.titleize %>", class: 'btn' %>
+  </div>
+<%% end %>

data/lib/generators/starter/resource/templates/bootstrapped/show.html.erb

@@ -0,0 +1,9 @@
+<h1><%= human_name.titleize %> #<%%= @<%= singular_table_name %>.id %></h1>
+
+<% attributes.each do |attribute| -%>
+<p>
+  <b><%= attribute.human_name %>:</b>
+  <%%= @<%= singular_table_name %>.<%= attribute.name %> %>
+</p>
+
+<% end %>

data/lib/generators/starter/resource/templates/controller.rb

@@ -0,0 +1,48 @@
+class <%= plural_name.camelize %>Controller < ApplicationController
+
+  def index
+    @<%= plural_name.underscore %> = <%= class_name %>.all
+  end
+
+  def show
+    @<%= singular_name.underscore %> = <%= class_name %>.find_by_id(params[:id])
+  end
+
+  def new
+    @<%= singular_name.underscore %> = <%= class_name %>.new
+  end
+
+  def create
+    @<%= singular_name.underscore %> = <%= class_name %>.new
+    <% attributes.each do |attribute| -%>
+@<%= singular_name.underscore %>.<%= attribute.name %> = params[:<%= attribute.name %>]
+    <% end %>
+    if @<%= singular_name.underscore %>.save
+      redirect_to "/<%= plural_name %>"
+    else
+      render 'new'
+    end
+  end
+
+  def edit
+    @<%= singular_name.underscore %> = <%= class_name %>.find_by_id(params[:id])
+  end
+
+  def update
+    @<%= singular_name.underscore %> = <%= class_name %>.find_by_id(params[:id])
+    <% attributes.each do |attribute| -%>
+@<%= singular_name.underscore %>.<%= attribute.name %> = params[:<%= attribute.name %>]
+    <% end %>
+    if @<%= singular_name.underscore %>.save
+      redirect_to "/<%= plural_name %>"
+    else
+      render 'edit'
+    end
+  end
+
+  def destroy
+    @<%= singular_name.underscore %> = <%= class_name %>.find_by_id(params[:id])
+    @<%= singular_name.underscore %>.destroy
+    redirect_to "/<%= plural_name %>"
+  end
+end

data/lib/generators/starter/resource/templates/edit.html.erb

@@ -0,0 +1,16 @@
+<h1>Editing <%= human_name.titleize %> #<%%= @<%= singular_table_name %>.id %></h1>
+
+<%%= form_tag(<%= singular_table_name %>_url(@<%= singular_table_name %>), method: 'put') do %>
+
+  <% attributes.each do |attribute| -%>
+<div>
+    <%%= label_tag :<%= attribute.name %> %><br />
+    <%%= <%= attribute.field_type %>_tag :<%= attribute.name %>, @<%= singular_table_name %>.<%= attribute.name %><%= "?" if attribute.type == :boolean %> %>
+  </div>
+
+  <% end %>
+  <div>
+    <%%= submit_tag "Update <%= human_name.titleize %>" %>
+  </div>
+
+<%% end %>

data/lib/generators/starter/resource/templates/index.html.erb

@@ -0,0 +1,40 @@
+<h1><%= plural_table_name.humanize %></h1>
+
+<% if named_routes? -%>
+<p><%%= link_to 'Add a New <%= human_name.titleize %>', new_<%= singular_table_name %>_url %></p>
+<% else -%>
+<p><%%= link_to 'Add a New <%= human_name.titleize %>', "/<%= plural_name %>/new" %></p>
+<% end -%>
+
+<table>
+  <thead>
+    <tr>
+<% attributes.each do |attribute| -%>
+      <th><%= attribute.human_name %></th>
+<% end -%>
+      <th></th>
+      <th></th>
+      <th></th>
+    </tr>
+  </thead>
+
+  <tbody>
+  <%% @<%= plural_table_name %>.each do |<%= singular_table_name %>| %>
+    <tr>
+  <% attributes.each do |attribute| -%>
+      <td><%%= <%= singular_table_name %>.<%= attribute.name %> %></td>
+  <% end -%>
+<% if named_routes? %>
+      <td><%%= link_to 'Show', <%= singular_table_name %>_url(<%= singular_table_name %>) %></td>
+      <td><%%= link_to 'Edit', edit_<%= singular_table_name %>_url(<%= singular_table_name %>) %></td>
+      <td><%%= link_to 'Destroy', <%= singular_table_name %>_url(<%= singular_table_name %>), method: 'delete', data: { confirm: "Do you really want to delete this <%= singular_table_name %>?" } %></td>
+<% else %>
+      <td><%%= link_to 'Show', "/<%= plural_name %>/#{<%= singular_table_name %>.id}" %></td>
+      <td><%%= link_to 'Edit', "/<%= plural_name %>/#{<%= singular_table_name %>.id}/edit" %></td>
+      <td><%%= link_to 'Destroy', "/<%= plural_name %>/#{<%= singular_table_name %>.id}", method: 'delete', data: { confirm: "Do you really want to delete this <%= singular_table_name %>?" } %></td>
+<% end %>
+    </tr>
+  <%% end %>
+  </body>
+</table>
+

data/lib/generators/starter/resource/templates/migration.rb

@@ -0,0 +1,15 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :<%= table_name %> do |t|
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+<% if options[:timestamps] %>
+      t.timestamps
+<% end -%>
+    end
+<% attributes_with_index.each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+<% end -%>
+  end
+end

data/lib/generators/starter/resource/templates/model.rb

@@ -0,0 +1,2 @@
+class <%= singular_name.camelize %> < ActiveRecord::Base
+end

data/lib/generators/starter/resource/templates/new.html.erb

@@ -0,0 +1,15 @@
+<h1>New <%= human_name.titleize %></h1>
+
+<%%= form_tag(<%= plural_name %>_url, method: 'post') do %>
+
+<% attributes.each do |attribute| -%>
+  <div>
+    <%%= label_tag :<%= attribute.name %> %><br />
+    <%%= <%= attribute.field_type %>_tag :<%= attribute.name %><%= "?" if attribute.type == :boolean %> %>
+  </div>
+
+  <% end %>
+  <div>
+    <%%= submit_tag "Create <%= human_name.titleize %>" %>
+  </div>
+<%% end %>

data/lib/generators/starter/resource/templates/show.html.erb

@@ -0,0 +1,9 @@
+<h1><%= human_name.titleize %> #<%%= @<%= singular_table_name %>.id %></h1>
+
+<% attributes.each do |attribute| -%>
+<p>
+  <b><%= attribute.human_name %>:</b>
+  <%%= @<%= singular_table_name %>.<%= attribute.name %> %>
+</p>
+
+<% end %>

data/lib/generators/starter/style/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Injects a bootswatch with FontAwesome support into your app.
+
+    BOOTSTRAP_NAME must be one of:
+        amelia, cerulian, cyborg, journal, readable, simplex, slate, spacelab, spruce, superhero, united
+
+    LAYOUT_FILE defaults to "application".
+
+Examples:
+    `rails generate starter:style united`
+

data/lib/generators/starter/style/style_generator.rb

@@ -0,0 +1,45 @@
+module Starter
+  class StyleGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :bootswatch_name, :type => :string#, :default => 'spacelab'
+
+    class_option :layout, :type => :boolean, :default => true, :desc => "Generate a new application layout."
+    class_option :navbar, :type => :boolean, :default => true, :desc => "Generate a model-based navbar."
+    argument :layout_file, :type => :string, :default => 'application', :desc => "Layout filename"
+
+    def inject_styles
+      template "bootstrap-css/#{bootswatch_name}.min.css", "app/assets/stylesheets/#{bootswatch_name}.css"
+      directory "font", "app/assets/stylesheets/font", verbose: false
+      template "font-awesome-css/font-awesome.min.css", "app/assets/stylesheets/font-awesome.css", verbose: false
+      log :insert, 'FontAwesome stylesheet and fonts'
+      copy_file 'bootstrap_overrides.css', 'app/assets/stylesheets/bootstrap_overrides.css'
+      inject_into_file "app/assets/stylesheets/application.css",
+                        "\n\n/*= require #{bootswatch_name} */\n/*= require bootstrap_overrides */",
+                        after: %r{\*\/}
+      log :insert, 'Stylesheet manifest directives'
+    end
+
+    def generate_layout
+      template "layout.html.erb", "app/views/layouts/#{layout_file}.html.erb" if options[:layout]
+    end
+
+  protected
+
+    def app_tables
+      ActiveRecord::Base.connection.tables - ['schema_migrations']
+    end
+
+    def application_name
+      if defined?(Rails) && Rails.application
+        Rails.application.class.name.split('::').first.humanize.titleize
+      else
+        "application"
+      end
+    end
+
+    def available_styles
+      Dir["bootstrap-css/*"].entries
+    end
+  end
+end