RubyGems - datalab-generators - Versions diffs - 0.1.0 - Mend

datalab-generators 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (51) hide show

data/lib/generators/datalab/layout/templates/public.css.scss ADDED Viewed

@@ -0,0 +1,83 @@
+html, 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;
+}
+.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;
+}
+.field_with_errors {
+  display: inline;
+}
+form .field, form .actions {
+  margin: 10px 0;
+}
+form label {
+  display: block;
+}

data/lib/generators/datalab/layout/templates/public.html.erb ADDED Viewed

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%%= content_for?(:title) ? yield(:title) : "Untitled" %></title>
+    <%%= stylesheet_link_tag "<%= file_name %>" %>
+    <%%= javascript_include_tag :defaults %>
+    <%%= csrf_meta_tag %>
+    <%%= yield(:head) %>
+  </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>
+  </body>
+</html>

data/lib/generators/datalab/layout/templates/public_helper.rb ADDED Viewed

@@ -0,0 +1,18 @@
+module PublicHelper
+  def title(page_title, show_title = true)
+    content_for(:title) { h(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) }
+  end
+  def javascript(*args)
+    content_for(:head) { javascript_include_tag(*args) }
+  end
+end

data/lib/generators/datalab/layout/templates/stylesheet.css.scss ADDED Viewed

@@ -0,0 +1,83 @@
+html, 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;
+}
+.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;
+}
+.field_with_errors {
+  display: inline;
+}
+form .field, form .actions {
+  margin: 10px 0;
+}
+form label {
+  display: block;
+}

data/lib/generators/datalab/scaffold/USAGE ADDED Viewed

@@ -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 datalab_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, `datalab: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 datalab: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 datalab: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 datalab:scaffold post ! show new
+        Creates a posts controller (no model) with index, edit, update, and
+        destroy actions.

data/lib/generators/datalab/scaffold/scaffold_generator.rb ADDED Viewed

@@ -0,0 +1,301 @@
+require 'generators/datalab'
+require 'rails/generators/migration'
+require 'rails/generators/generated_attribute'
+module Datalab
+  module Generators
+    class ScaffoldGenerator < Base
+      include Rails::Generators::Migration
+      no_tasks { attr_accessor :scaffold_name, :model_attributes, :controller_actions }
+      argument :scaffold_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 => 'Don\'t 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 :namespace_model, :desc => 'If the resource is namespaced, include the model in the namespace.', :type => :boolean
+      class_option :rspec, :desc => 'Use RSpec for test files.', :group => 'Test framework', :type => :boolean
+      def initialize(*args, &block)
+        super
+        print_usage unless scaffold_name.underscore =~ /^[a-z][a-z0-9_\/]+$/
+        @controller_actions = []
+        @model_attributes = []
+        @skip_model = options.skip_model?
+        @namespace_model = options.namespace_model?
+        @invert_actions = options.invert?
+        args_for_c_m.each do |arg|
+          if arg == '!'
+            @invert_actions = 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 @invert_actions || @controller_actions.empty?
+          @controller_actions = all_actions - @controller_actions
+        end
+        if @model_attributes.empty?
+          @skip_model = true # skip model if no attributes
+          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 add_gems
+        add_gem "mocha", :group => :test
+      end
+      def create_model
+        unless @skip_model
+          template 'model.rb', "app/models/#{model_path}.rb"
+          if test_framework == :rspec
+            template "tests/rspec/model.rb", "spec/models/#{model_path}_spec.rb"
+            template 'fixtures.yml', "spec/fixtures/#{model_path.pluralize}.yml"
+          else
+            template "tests/#{test_framework}/model.rb", "test/unit/#{model_path}_test.rb"
+            template 'fixtures.yml', "test/fixtures/#{model_path.pluralize}.yml"
+          end
+        end
+      end
+      def create_migration
+        unless @skip_model || options.skip_migration?
+          migration_template 'migration.rb', "db/migrate/create_#{model_path.pluralize.gsub('/', '_')}.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
+          namespaces = plural_name.split('/')
+          resource = namespaces.pop
+          route namespaces.reverse.inject("resources :#{resource}") { |acc, namespace|
+            "namespace(:#{namespace}){ #{acc} }"
+          }
+          if test_framework == :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
+        scaffold_name.underscore
+      end
+      def plural_name
+        scaffold_name.underscore.pluralize
+      end
+      def table_name
+        if scaffold_name.include?('::') && @namespace_model
+          plural_name.gsub('/', '_')
+        end
+      end
+      def class_name
+        if @namespace_model
+          scaffold_name.camelize
+        else
+          scaffold_name.split('::').last.camelize
+        end
+      end
+      def model_path
+        class_name.underscore
+      end
+      def plural_class_name
+        plural_name.camelize
+      end
+      def instance_name
+        if @namespace_model
+          singular_name.gsub('/','_')
+        else
+          singular_name.split('/').last
+        end
+      end
+      def instances_name
+        instance_name.pluralize
+      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?
+          "<%= render \"form\" %>"
+        else
+          read_template("views/#{view_language}/_form.html.#{view_language}")
+        end
+      end
+      def item_resource
+        scaffold_name.underscore.gsub('/','_')
+      end
+      def items_path
+        if action? :index
+          "#{item_resource.pluralize}_path"
+        else
+          "root_path"
+        end
+      end
+      def item_path(options = {})
+        name = options[:instance_variable] ? "@#{instance_name}" : instance_name
+        suffix = options[:full_url] ? "url" : "path"
+        if options[:action].to_s == "new"
+          "new_#{item_resource}_#{suffix}"
+        elsif options[:action].to_s == "edit"
+          "edit_#{item_resource}_#{suffix}(#{name})"
+        else
+          if scaffold_name.include?('::') && !@namespace_model
+            namespace = singular_name.split('/')[0..-2]
+            "[:#{namespace.join(', :')}, #{name}]"
+          else
+            name
+          end
+        end
+      end
+      def item_url
+        if action? :show
+          item_path(:full_url => true, :instance_variable => true)
+        else
+          items_url
+        end
+      end
+      def items_url
+        if action? :index
+          item_resource.pluralize + '_url'
+        else
+          "root_url"
+        end
+      end
+      def item_path_for_spec(suffix = 'path')
+        if action? :show
+          "#{item_resource}_#{suffix}(assigns[:#{instance_name}])"
+        else
+          if suffix == 'path'
+            items_path
+          else
+            items_url
+          end
+        end
+      end
+      def item_path_for_test(suffix = 'path')
+        if action? :show
+          "#{item_resource}_#{suffix}(assigns(:#{instance_name}))"
+        else
+          if suffix == 'path'
+            items_path
+          else
+            items_url
+          end
+        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
+        'erb'
+      end
+      def test_framework
+        return @test_framework = :rspec
+      end
+      def default_test_framework
+        :rspec
+      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