vileda-generators 0.1.0

data/lib/generators/vileda/layout/templates/style.css

@@ -0,0 +1,279 @@
+/* 
+  style.css contains a reset, font normalization and some base styles.
+  
+  credit is left where credit is due.
+  additionally, much inspiration was taken from these projects:
+    yui.yahooapis.com/2.8.1/build/base/base.css
+    camendesign.com/design/
+    praegnanz.de/weblog/htmlcssjs-kickstart
+*/
+
+/* 
+  html5doctor.com Reset Stylesheet (Eric Meyer's Reset Reloaded + HTML5 baseline)
+  v1.4 2009-07-27 | Authors: Eric Meyer & Richard Clark
+  html5doctor.com/html-5-reset-stylesheet/
+*/
+
+html, body, div, span, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+abbr, address, cite, code,
+del, dfn, em, img, ins, kbd, q, samp,
+small, strong, sub, sup, var,
+b, i,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, figcaption, figure, 
+footer, header, hgroup, menu, nav, section, summary,
+time, mark, audio, video {
+  margin:0;
+  padding:0;
+  border:0;
+  outline:0;
+  font-size:100%;
+  vertical-align:baseline;
+  background:transparent;
+}                  
+
+article, aside, details, figcaption, figure,
+footer, header, hgroup, menu, nav, section { 
+    display:block;
+}
+
+nav ul { list-style:none; }
+
+blockquote, q { quotes:none; }
+
+blockquote:before, blockquote:after,
+q:before, q:after { content:''; content:none; }
+
+a { margin:0; padding:0; font-size:100%; vertical-align:baseline; background:transparent; }
+
+ins { background-color:#ff9; color:#000; text-decoration:none; }
+
+mark { background-color:#ff9; color:#000; font-style:italic; font-weight:bold; }
+
+del { text-decoration: line-through; }
+
+abbr[title], dfn[title] { border-bottom:1px dotted; cursor:help; }
+
+/* tables still need cellspacing="0" in the markup */
+table { border-collapse:collapse; border-spacing:0; }
+
+hr { display:block; height:1px; border:0; border-top:1px solid #ccc; margin:1em 0; padding:0; }
+
+input, select { vertical-align:middle; }
+/* END RESET CSS */
+
+
+/* fonts.css from the YUI Library: developer.yahoo.com/yui/
+   Please refer to developer.yahoo.com/yui/fonts/ for font sizing percentages
+
+  There are three custom edits:
+   * remove arial, helvetica from explicit font stack
+   * we normalize monospace styles ourselves
+   * table font-size is reset in the HTML5 reset above so there is no need to repeat
+*/
+body { font:13px/1.231 sans-serif; *font-size:small; } /* hack retained to preserve specificity */
+
+select, input, textarea, button { font:99% sans-serif; }
+
+/* normalize monospace sizing 
+ * en.wikipedia.org/wiki/MediaWiki_talk:Common.css/Archive_11#Teletype_style_fix_for_Chrome
+ */
+pre, code, kbd, samp { font-family: monospace, sans-serif; }
+ 
+
+/* 
+ * minimal base styles 
+ */
+
+
+body, select, input, textarea { 
+  /* #444 looks better than black: twitter.com/H_FJ/statuses/11800719859 */ 
+  color: #444; 
+  /* set your base font here, to apply evenly 
+  /* font-family: Georgia, serif;  */   
+}
+
+/* Headers (h1,h2,etc) have no default font-size or margin,
+   you'll want to define those yourself. */ 
+h1,h2,h3,h4,h5,h6 { font-weight: bold; }
+
+/* always force a scrollbar in non-IE */ 
+html { overflow-y: scroll; }
+
+ 
+/* Accessible focus treatment: people.opera.com/patrickl/experiments/keyboard/test */
+a:hover, a:active { outline: none; }
+
+a, a:active, a:visited { color: #607890; }
+a:hover { color: #036; }
+
+
+ul, ol { margin-left: 1.8em; }
+ol { list-style-type: decimal; }
+
+small { font-size: 85%; }
+strong, th { font-weight: bold; }
+
+td, td img { vertical-align: top; } 
+
+sub { vertical-align: sub; font-size: smaller; }
+sup { vertical-align: super; font-size: smaller; }
+
+pre { 
+  padding: 15px; 
+  
+  /* www.pathf.com/blogs/2008/05/formatting-quoted-code-in-blog-posts-css21-white-space-pre-wrap/ */
+  white-space: pre; /* CSS2 */
+  white-space: pre-wrap; /* CSS 2.1 */
+  white-space: pre-line; /* CSS 3 (and 2.1 as well, actually) */
+  word-wrap: break-word; /* IE */
+}
+ 
+textarea { overflow: auto; } /* thnx ivannikolic! www.sitepoint.com/blogs/2010/08/20/ie-remove-textarea-scrollbars/ */
+
+.ie6 legend, .ie7 legend { margin-left: -7px; } /* thnx ivannikolic! */
+
+/* align checkboxes, radios, text inputs with their label
+   by: Thierry Koblentz tjkdesign.com/ez-css/css/base.css  */
+input[type="radio"] { vertical-align: text-bottom; }
+input[type="checkbox"] { vertical-align: bottom; }
+.ie7 input[type="checkbox"] { vertical-align: baseline; }
+.ie6 input { vertical-align: text-bottom; }
+
+/* hand cursor on clickable input elements */
+label, input[type=button], input[type=submit], button { cursor: pointer; }
+ 
+/* webkit browsers add a 2px margin outside the chrome of form elements */  
+button, input, select, textarea { margin: 0; }
+
+/* colors for form validity */
+input:valid, textarea:valid   {  }
+input:invalid, textarea:invalid { 
+      border-radius: 1px;
+    -moz-box-shadow: 0px 0px 5px red; 
+ -webkit-box-shadow: 0px 0px 5px red; 
+         box-shadow: 0px 0px 5px red;
+}
+.no-boxshadow input:invalid, 
+.no-boxshadow textarea:invalid { background-color: #f0dddd; }
+
+
+/* These selection declarations have to be separate.
+   No text-shadow: twitter.com/miketaylr/status/12228805301 
+   Also: hot pink. */
+::-moz-selection{ background: #FF5E99; color:#fff; text-shadow: none; }
+::selection { background:#FF5E99; color:#fff; text-shadow: none; } 
+
+/*  j.mp/webkit-tap-highlight-color */
+a:link { -webkit-tap-highlight-color: #FF5E99; } 
+
+/* make buttons play nice in IE:    
+   www.viget.com/inspire/styling-the-button-element-in-internet-explorer/ */
+button {  width: auto; overflow: visible; }
+ 
+/* bicubic resizing for non-native sized IMG: 
+   code.flickr.com/blog/2008/11/12/on-ui-quality-the-little-things-client-side-image-resizing/ */
+.ie7 img { -ms-interpolation-mode: bicubic; }
+
+
+
+/* 
+ * Non-semantic helper classes 
+ */
+
+/* for image replacement */
+.ir { display: block; text-indent: -999em; overflow: hidden; background-repeat: no-repeat; text-align: left; direction: ltr; }
+
+/* Hide for both screenreaders and browsers
+   css-discuss.incutio.com/wiki/Screenreader_Visibility */
+.hidden { display: none; visibility: hidden; } 
+
+/* Hide only visually, but have it available for screenreaders 
+   www.webaim.org/techniques/css/invisiblecontent/ 
+   Solution from: j.mp/visuallyhidden - Thanks Jonathan Neal! */
+.visuallyhidden { position: absolute !important;    
+  clip: rect(1px 1px 1px 1px); /* IE6, IE7 */
+  clip: rect(1px, 1px, 1px, 1px); }
+
+/* Hide visually and from screenreaders, but maintain layout */
+.invisible { visibility: hidden; }
+
+/* >> The Magnificent CLEARFIX << j.mp/phayesclearfix */
+.clearfix:after  { content: "\0020"; display: block; height: 0; clear: both; visibility: hidden; }
+/* Fix clearfix: blueprintcss.lighthouseapp.com/projects/15318/tickets/5-extra-margin-padding-bottom-of-page */
+.clearfix { zoom: 1; }
+
+
+
+
+
+
+ /* Primary Styles
+    Author: 
+ */
+
+#container {
+	margin: 0 auto;
+	width: 960px;
+}
+
+
+
+
+/* 
+ * print styles
+ * inlined to avoid required HTTP connection www.phpied.com/delay-loading-your-print-css/ 
+ */
+@media print {
+  * { background: transparent !important; color: #444 !important; text-shadow: none !important; }
+
+  a, a:visited { color: #444 !important; text-decoration: underline; }
+
+  a:after { content: " (" attr(href) ")"; } 
+
+  abbr:after { content: " (" attr(title) ")"; }
+  
+  .ir a:after { content: ""; }  /* Don't show links for images */
+  
+  pre, blockquote { border: 1px solid #999; page-break-inside: avoid; }
+  
+  thead { display: table-header-group; } /* css-discuss.incutio.com/wiki/Printing_Tables */ 
+  
+  tr, img { page-break-inside: avoid; }
+
+  @page { margin: 0.5cm; }
+
+  p, h2, h3 { orphans: 3; widows: 3; }
+
+  h2, h3{ page-break-after: avoid; }
+}
+
+
+
+/*
+ * Media queries for responsive design
+ */
+
+@media all and (orientation:portrait) { 
+  /* Style adjustments for portrait mode goes here */
+  
+}
+
+@media all and (orientation:landscape) { 
+  /* Style adjustments for landscape mode goes here */
+  
+}
+
+/* Grade-A Mobile Browsers (Opera Mobile, iPhone Safari, Android Chrome)  
+   Consider this: www.cloudfour.com/css-media-query-for-mobile-is-fools-gold/ */
+@media screen and (max-device-width: 480px) {
+  
+  
+  /* Uncomment if you don't want iOS and WinMobile to mobile-optimize the text for you
+     j.mp/textsizeadjust 
+  html { -webkit-text-size-adjust:none; -ms-text-size-adjust:none; } */
+}
+

data/lib/generators/vileda/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 vileda_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, `vileda_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 vileda: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 vileda: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 vileda:scaffold post ! show new
+        
+        Creates a posts controller (no model) with index, edit, update, and
+        destroy actions.

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

@@ -0,0 +1,230 @@
+require 'generators/vileda'
+require 'rails/generators/migration'
+require 'rails/generators/generated_attribute'
+
+module Vileda
+  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 :testunit, :desc => 'Use test/unit 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}"
+
+          template "tests/#{test_framework}/controller.rb", "test/functional/#{plural_name}_controller_test.rb"
+        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
+        else
+          return @test_framework = default_test_framework
+        end
+      end
+
+      def default_test_framework
+        :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

data/lib/generators/vileda/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/vileda/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/vileda/scaffold/templates/actions/edit.rb

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

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

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

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

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

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

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

data/lib/generators/vileda/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/vileda/scaffold/templates/controller.rb

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

data/lib/generators/vileda/scaffold/templates/fixtures.yml

@@ -0,0 +1,9 @@
+one:
+<%- for attribute in model_attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<%- end -%>
+
+two:
+<%- for attribute in model_attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<%- end -%>

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

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

data/lib/generators/vileda/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/vileda/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/vileda/scaffold/templates/tests/testunit/actions/create.rb

@@ -0,0 +1,11 @@
+  def test_create_invalid
+    <%= class_name %>.any_instance.stubs(:valid?).returns(false)
+    post :create
+    assert_template 'new'
+  end
+  
+  def test_create_valid
+    <%= class_name %>.any_instance.stubs(:valid?).returns(true)
+    post :create
+    assert_redirected_to <%= item_path_for_test('url') %>
+  end

data/lib/generators/vileda/scaffold/templates/tests/testunit/actions/destroy.rb

@@ -0,0 +1,6 @@
+  def test_destroy
+    <%= singular_name %> = <%= class_name %>.first
+    delete :destroy, :id => <%= singular_name %>
+    assert_redirected_to <%= items_path('url') %>
+    assert !<%= class_name %>.exists?(<%= singular_name %>.id)
+  end

data/lib/generators/vileda/scaffold/templates/tests/testunit/actions/edit.rb

@@ -0,0 +1,4 @@
+  def test_edit
+    get :edit, :id => <%= class_name %>.first
+    assert_template 'edit'
+  end

data/lib/generators/vileda/scaffold/templates/tests/testunit/actions/index.rb

@@ -0,0 +1,4 @@
+  def test_index
+    get :index
+    assert_template 'index'
+  end

data/lib/generators/vileda/scaffold/templates/tests/testunit/actions/new.rb

@@ -0,0 +1,4 @@
+  def test_new
+    get :new
+    assert_template 'new'
+  end