my_generators 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tyler Gannon
+
+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.rdoc

@@ -0,0 +1,17 @@
+= my_generators
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Tyler Gannon. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "my_generators"
+    gem.summary = %Q{Generators that I use for rails apps}
+    gem.description = %Q{Just a replacement for default rails generators, specifig to my configuration of mongoid, inherited_resources, etc.}
+    gem.email = "tgannon@gmail.com"
+    gem.homepage = "http://github.com/tylergannon/my_generators"
+    gem.authors = ["Tyler Gannon"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "my_generators #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/generators/my_generators/controller/controller_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/erb/controller/controller_generator'
+require 'generators/my_scaffold_generator'
+
+module MyGenerators
+  module Generators
+    class ControllerGenerator < Erb::Generators::ControllerGenerator
+      include MyGenerators::Generators::MyScaffoldGenerator
+      source_root File.expand_path("../templates", __FILE__)
+
+    protected
+
+      def handler
+        :haml
+      end
+
+    end
+  end
+end

data/lib/generators/my_generators/controller/templates/view.html.haml

@@ -0,0 +1,2 @@
+%h1 <%= class_name %>#<%= @action %>
+%p Find me in <%= @path %>

data/lib/generators/my_generators/model/model_generator.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+require "rails/generators/mongoid_generator"
+require 'generators/my_scaffold_generator'
+
+module MyGenerators #:nodoc:
+  module Generators #:nodoc:
+    class ModelGenerator < Mongoid::Generators::Base #:nodoc:
+      include MyGenerators::Generators::MyScaffoldGenerator
+      desc "Creates a Mongoid model"
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+      class_option :timestamps, :type => :boolean
+      class_option :parent,     :type => :string, :desc => "The parent class for the generated model"
+      class_option :versioning, :type => :boolean, :default => false, :desc => "Enable mongoid versioning"
+
+      def create_model_file
+        template "model.rb", File.join("app/models", class_path, "#{file_name}.rb")
+      end
+
+      hook_for :test_framework
+      
+      def self.source_root
+        @source_root ||= File.expand_path("templates", File.dirname(__FILE__))
+      end
+        
+    end
+  end
+end

data/lib/generators/my_generators/model/templates/model.rb

@@ -0,0 +1,26 @@
+class <%= class_name %><%= " < #{options[:parent].classify}" if options[:parent] %>
+<% unless options[:parent] -%>
+  include Mongoid::Document
+<% end -%>
+<% if options[:timestamps] -%>
+  include Mongoid::Timestamps
+<% end -%>
+<%= 'include Mongoid::Versioning' if options[:versioning] -%>
+<% if options[:embedded_in] %>
+  embedded_in :<%= options[:embedded_in] %>, :inverse_of => :<%= options[:singleton] ? class_name.underscore : class_name.tableize %>
+<% end %>
+<% if options[:referenced_in] %>
+  referenced_in :<%= options[:referenced_in] %>, :inverse_of => :<%= options[:singleton] ? class_name.underscore : class_name.tableize %>
+<% end %>
+<% attributes.reject{|attr| attr.reference?}.each do |attribute| -%>
+  field :<%= attribute.name %>, :type => <%= attribute.type_class %>
+<% end -%>
+<% attributes.select{|attr| attr.reference? }.each do |attribute| -%>
+  embedded_in :<%= attribute.name%>, :inverse_of => :<%= class_name.tableize %>
+<% end -%>
+<% if references_one -%>  references_one :<%=references_one%> <% end %>
+<% if references_many -%>  references_many :<%=references_many%> <% end %>
+<% if embeds_one -%>  embeds_one :<%=embeds_one%> <% end %>
+<% if embeds_many -%>  embeds_many :<%=embeds_many%> <% end %>
+
+end

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

@@ -0,0 +1,49 @@
+require 'rails/generators/base'
+require 'generators/my_scaffold_generator'
+
+module MyGenerators::Generators
+    class ScaffoldGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+      include MyScaffoldGenerator
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+      def create_root_folder
+        empty_directory File.join("app/views", controller_file_path)
+      end
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_view_files
+        available_views.each do |view|
+          filename = filename_with_extensions(view)
+          template "#{view}.html.haml", File.join("app/views", controller_file_path, filename)
+        end
+      end
+
+      hook_for :form_builder, :as => :scaffold
+
+      def copy_form_file
+        if options[:form_builder].nil?
+          filename = filename_with_extensions("_form")
+          template "_form.html.haml", File.join("app/views", controller_file_path, filename)
+        end
+      end
+
+    protected
+
+      def available_views
+        %w(index edit show new)
+      end
+
+      def handler
+        :haml
+      end
+      def format
+        :html
+      end
+      
+      def filename_with_extensions(name)
+        [name, format, handler].compact.join(".")
+      end
+    end
+end

data/lib/generators/my_generators/scaffold/templates/_form.html.haml

@@ -0,0 +1,15 @@
+= form_for <%= belongs_to ? "[@#{parent_name}, @#{model_name}]" : "@#{model_name}" %> do |f|
+  -if @<%= singular_table_name %>.errors.any?
+    #error_explanation
+      %h2= "#{pluralize(@<%= singular_table_name %>.errors.count, "error")} prohibited this <%= singular_table_name %> from being saved:"
+      %ul
+        - @<%= singular_table_name %>.errors.full_messages.each do |msg|
+          %li= msg
+
+<% for attribute in attributes -%>
+  .field
+    = f.label :<%= attribute.name %>
+    = f.<%= attribute.field_type %> :<%= attribute.name %>
+<% end -%>
+  .actions
+    = f.submit 'Save'

data/lib/generators/my_generators/scaffold/templates/edit.html.haml

@@ -0,0 +1,7 @@
+%h1 Editing <%= singular_table_name %>
+
+= render 'form'
+
+= link_to 'Show', <%= resource_url_helper %>
+\|
+= link_to 'Back', <%= index_url_helper %>

data/lib/generators/my_generators/scaffold/templates/index.html.haml

@@ -0,0 +1,23 @@
+%h1 Listing <%= plural_table_name %>
+
+%table
+  %tr
+<% for attribute in attributes -%>
+    %th <%= attribute.human_name %>
+<% end -%>
+    %th
+    %th
+    %th
+
+  - @<%= plural_table_name %>.each do |<%= singular_table_name %>|
+    %tr
+<% for attribute in attributes -%>
+      %td= <%= singular_table_name %>.<%= attribute.name %>
+<% end -%>
+      %td= link_to 'Show', <%= resource_url_helper(model_name) %>
+      %td= link_to 'Edit', edit_<%= resource_url_helper(model_name) %>
+      %td= link_to 'Destroy', <%= resource_url_helper(model_name) %>, :confirm => 'Are you sure?', :method => :delete
+
+%br
+
+= link_to 'New <%= human_name %>', new_<%= resource_url_helper() %>

data/lib/generators/my_generators/scaffold/templates/new.html.haml

@@ -0,0 +1,5 @@
+%h1 New <%= singular_table_name %>
+
+= render 'form'
+
+= link_to 'Back', <%= index_url_helper %>

data/lib/generators/my_generators/scaffold/templates/show.html.haml

@@ -0,0 +1,11 @@
+%p#notice= notice
+
+<% for attribute in attributes -%>
+%p
+  %b <%= attribute.human_name %>:
+  = @<%= singular_table_name %>.<%= attribute.name %>
+<% end -%>
+
+= link_to 'Edit', edit_<%= resource_url_helper %>
+\|
+= link_to 'Back', <%= index_url_helper %>

data/lib/generators/my_scaffold_generator.rb

@@ -0,0 +1,161 @@
+module MyGenerators
+  module Generators
+    module MyScaffoldGenerator
+      extend ActiveSupport::Concern
+      
+      included do
+        class_option :embedded_in, :type => :string, :default=>nil
+        class_option :referenced_in, :type => :string, :default=>nil
+        class_option :belongs_to, :type => :boolean, :default=>false
+
+        class_option :embeds_one, :type => :string, :default=>nil
+        class_option :embeds_many, :type => :string, :default=>nil
+        class_option :references_one, :type => :string, :default=>nil
+        class_option :references_many, :type => :string, :default=>nil
+
+        class_option :orm, :desc => "ORM used to generate the controller"
+        class_option :template_engine, :default=>'haml', :desc => "Template engine to generate view files"
+        class_option :singleton, :type => :boolean, :desc => "Supply to create a singleton controller"
+        class_option :controller_specs, :type => :boolean, :default => true,  :desc => "Generate controller specs"
+        class_option :view_specs,       :type => :boolean, :default => true,  :desc => "Generate view specs"
+        class_option :webrat_matchers,  :type => :boolean, :default => true, :desc => "Use webrat matchers in view specs"
+        class_option :helper_specs,     :type => :boolean, :default => true,  :desc => "Generate helper specs"
+        class_option :routing_specs,    :type => :boolean, :default => true,  :desc => "Generate routing specs"
+      end
+
+      def method_missing(method, *args)
+        options[method.to_sym]
+      end
+      
+      protected
+        def resource_url_helper(resource=nil)
+          belongs_to ? 
+            "#{parent_name}_#{model_name}_path(@#{parent_name}, #{resource||'@'+model_name})" :
+            "#{resource||'@'+model_name}"
+        end
+        
+        def new_resource_url_helper
+          belongs_to ? "new_#{parent_name}_#{model_name}_path(@#{parent_name})" :
+            "new_#{model_name}_path"
+        end
+        
+        def index_url_helper
+          belongs_to ? "#{parent_name}_#{table_name}_path(@#{parent_name})" : "#{table_name}_path"
+        end
+
+        def webrat?
+          options[:webrat_matchers] || @webrat_matchers_requested
+        end
+
+        def copy_view(view)
+          template "#{view}_spec.rb",
+                   File.join("spec/views", controller_file_path, "#{view}.html.haml_spec.rb")
+        end
+
+        def params
+          "{'these' => 'params'}"
+        end
+
+        # Returns the name of the mock. For example, if the file name is user,
+        # it returns mock_user.
+        #
+        # If a hash is given, it uses the hash key as the ORM method and the
+        # value as response. So, for ActiveRecord and file name "User":
+        #
+        #   mock_file_name(:save => true)
+        #   #=> mock_user(:save => true)
+        #
+        # If another ORM is being used and another method instead of save is
+        # called, it will be the one used.
+        #
+        def mock_file_name(hash=nil)
+          if hash
+            method, and_return = hash.to_a.first
+            method = orm_instance.send(method).split('.').last.gsub(/\(.*?\)/, '')
+            "mock_#{file_name}(:#{method} => #{and_return})"
+          else
+            "mock_#{file_name}"
+          end
+        end
+
+        # Receives the ORM chain and convert to expects. For ActiveRecord:
+        #
+        #   should! orm_class.find(User, "37")
+        #   #=> User.should_receive(:find).with(37)
+        #
+        # For Datamapper:
+        #
+        #   should! orm_class.find(User, "37")
+        #   #=> User.should_receive(:get).with(37)
+        #
+        def should_receive!(chain)
+          stub_or_should_chain(:should_receive, chain)
+        end
+
+        # Receives the ORM chain and convert to stub. For ActiveRecord:
+        #
+        #   stub! orm_class.find(User, "37")
+        #   #=> User.stub!(:find).with(37)
+        #
+        # For Datamapper:
+        #
+        #   stub! orm_class.find(User, "37")
+        #   #=> User.stub!(:get).with(37)
+        #
+        def stub!(chain)
+          stub_or_should_chain(:stub, chain)
+        end
+
+        def stub_or_should_chain(mode, chain)
+          receiver, method = chain.split(".")
+          method.gsub!(/\((.*?)\)/, '')
+
+          response = "#{receiver}.#{mode}(:#{method})"
+          response << ".with(#{$1})" unless $1.blank?
+          response
+        end
+
+        def value_for(attribute)
+          case attribute.type
+          when :string
+            "#{attribute.name.titleize}".inspect
+          else
+            attribute.default.inspect
+          end
+        end
+
+        def parent_name
+          embedded_in || referenced_in
+        end
+        def parent_class
+          parent_name.camelize
+        end
+        def parents_name
+          parent_name.tableize
+        end
+        def parent_id
+          parent_name + "_id"
+        end
+
+        def association_matcher
+          embedded_in ? "be_embedded_in" : "be_referenced_in"
+        end
+        def parent_association
+          singleton ? class_name.underscore : class_name.tableize
+        end
+        def parent_association_matcher
+          singleton ? (embedded_in ? "embed_one" : "reference_one") :
+                      (embedded_in ? "embed_many" : "reference_many")
+                      
+        end
+        def model_name
+          class_name.underscore
+        end
+        
+        def child_model?
+          embedded_in || referenced_in
+        end
+    end
+  end
+end
+

data/lib/generators/my_spec/controller/controller_generator.rb

@@ -0,0 +1,33 @@
+require 'generators/my_scaffold_generator'
+
+module MySpec
+  module Generators
+    class ControllerGenerator < ::Rails::Generators::NamedBase
+      include MyScaffoldGenerator
+      argument :actions, :type => :array, :default => [], :banner => "action action"
+
+      def generate_controller_spec
+        return unless options[:controller_specs]
+
+        template 'controller_spec.rb',
+                 File.join('spec/controllers', class_path, "#{file_name}_controller_spec.rb")
+      end
+
+      def generate_view_specs
+        return if actions.empty?
+        return unless options[:view_specs]
+
+        empty_directory File.join("spec", "views", file_path)
+
+        actions.each do |action|
+          @action = action
+          template 'view_spec.rb',
+                   File.join("spec", "views", file_path, "#{@action}.html.#{options[:template_engine]}_spec.rb")
+        end
+      end
+      def self.source_root
+        @source_root ||= File.expand_path("templates", File.dirname(__FILE__))
+      end
+    end
+  end
+end

data/lib/generators/my_spec/controller/templates/controller_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe <%= class_name %>Controller do
+
+<% for action in actions -%>
+  describe "GET '<%= action %>'" do
+    it "should be successful" do
+      get '<%= action %>'
+      response.should be_success
+    end
+  end
+
+<% end -%>
+end

data/lib/generators/my_spec/controller/templates/view_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe "<%= file_name %>/<%= @action %>.html.<%= options[:template_engine] %>" do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/lib/generators/my_spec/helper/helper_generator.rb

@@ -0,0 +1,20 @@
+require 'generators/my_scaffold_generator'
+
+module MySpec
+  module Generators
+    class HelperGenerator < Rails::Generators::NamedBase
+      include MyGenerators::Generators::MyScaffoldGenerator
+
+      def generate_helper_spec
+        return unless options[:helper_specs]
+
+        template 'helper_spec.rb', File.join('spec/helpers', class_path, "#{file_name}_helper_spec.rb")
+      end
+
+      def self.source_root
+        @source_root ||= File.expand_path("templates", File.dirname(__FILE__))
+      end
+
+    end
+  end
+end

data/lib/generators/my_spec/helper/templates/helper_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+# Specs in this file have access to a helper object that includes
+# the <%= class_name %>Helper. For example:
+#
+# describe <%= class_name %>Helper do
+#   describe "string concat" do
+#     it "concats two strings with spaces" do
+#       helper.concat_strings("this","that").should == "this that"
+#     end
+#   end
+# end
+describe <%= class_name %>Helper do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/lib/generators/my_spec/integration/integration_generator.rb

@@ -0,0 +1,20 @@
+require 'generators/my_scaffold_generator'
+
+module MySpec
+  module Generators
+    class IntegrationGenerator < Rails::Generators::NamedBase
+      include MyGenerators::Generators::MyScaffoldGenerator
+      class_option :request_specs, :type => :boolean, :default => true,  :desc => "Generate request specs"
+
+      def generate_request_spec
+        return unless options[:request_specs]
+
+        template 'request_spec.rb',
+                 File.join('spec/requests', class_path, "#{table_name}_spec.rb")
+      end
+      def self.source_root
+        @source_root ||= File.expand_path("templates", File.dirname(__FILE__))
+      end
+    end
+  end
+end

data/lib/generators/my_spec/integration/templates/request_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe "<%= class_name.pluralize %>" do
+  describe "GET /<%= table_name %>" do
+    before :each do
+      <% if child_model? %>
+      <%=parent_class%>.stub(:find).with(anything()) {john_q :<%=parent_name%>}
+      <% end %>
+    end
+    it "works! (now write some real specs)" do
+      get <%= table_name %>_path
+    end
+  end
+end

data/lib/generators/my_spec/model/model_generator.rb

@@ -0,0 +1,33 @@
+require 'generators/my_scaffold_generator'
+
+module MySpec
+  module Generators
+    class ModelGenerator < Rails::Generators::NamedBase
+      include MyGenerators::Generators::MyScaffoldGenerator
+      class_option :fixture, :type => :boolean
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+      def copy_spec_support_files
+        empty_directory 'spec/support'
+        template 'mongoid.rb', 'spec/support/mongoid.rb'
+      end
+
+      def create_model_spec
+        template 'model_spec.rb', File.join('spec/models', class_path, "#{file_name}_spec.rb")
+      end
+
+      hook_for :fixture_replacement
+
+      def create_fixture_file
+        if options[:fixture] && options[:fixture_replacement].nil?
+          template 'fixtures.yml', File.join('spec/fixtures', "#{table_name}.yml")
+        end
+      end
+
+      def self.source_root
+        @source_root ||= File.expand_path("templates", File.dirname(__FILE__))
+      end
+
+    end
+  end
+end

data/lib/generators/my_spec/model/templates/fixtures.yml

@@ -0,0 +1,19 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+<% unless attributes.empty? -%>
+one:
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+
+two:
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+<% else -%>
+# one:
+#   column: value
+#
+# two:
+#   column: value
+<% end -%>