generator-spec 0.4.8 → 0.5.0

data/README.markdown

@@ -22,6 +22,12 @@ To install the gem from the code, simply use the jeweler rake task:
 
 <code>rake install</code>
 
+## TODO
+
+Check out ways to improve the DSL, fx using Macros:
+
+http://gist.github.com/511087
+
 ## Usage
 
 The following demonstrates usage of this library. There are many more options and DSL convenience methods (see wiki, code or specs).

data/VERSION

@@ -1 +1 @@
-0.4.8
+0.5.0

data/generator-spec.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{generator-spec}
-  s.version = "0.4.8"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-08-11}
+  s.date = %q{2010-08-14}
   s.description = %q{RSpec 2 library to assist in writing generator specs}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
@@ -36,6 +36,7 @@ Gem::Specification.new do |s|
      "lib/generator_spec/matchers/content/have_call.rb",
      "lib/generator_spec/matchers/content/have_calls.rb",
      "lib/generator_spec/matchers/content/have_class_self.rb",
+     "lib/generator_spec/matchers/content/have_comment.rb",
      "lib/generator_spec/matchers/content/have_method.rb",
      "lib/generator_spec/matchers/content/have_module.rb",
      "lib/generator_spec/matchers/content/have_region.rb",
@@ -54,6 +55,7 @@ Gem::Specification.new do |s|
      "lib/generator_spec/matchers/migration/have_table.rb",
      "lib/generator_spec/matchers/migration/have_tbl_column.rb",
      "lib/generator_spec/matchers/migration/have_up_down.rb",
+     "lib/generator_spec/rails_helpers/base_helper.rb",
      "lib/generator_spec/rails_helpers/rails_app.rb",
      "lib/generator_spec/rails_helpers/rails_controller.rb",
      "lib/generator_spec/rails_helpers/rails_helper.rb",

data/lib/generator_spec/extensions/core_ext.rb

@@ -15,3 +15,33 @@ class String
     (self =~ /\w+\s+\w+/) ? self.split : self
   end
 end
+         
+class Module
+  def multi_alias name, options={}
+    config_options = options[:options]
+    options.each_pair do |original, aliases|
+      next if original == :options 
+      alias_methods name, original, [aliases].flatten, config_options
+    end            
+  end
+
+  protected
+
+  def alias_methods name, original, aliases, config_options
+    aliases.each do |alias_name| 
+      new_alias     = make_name(name, alias_name.to_s, config_options)
+      original_name = make_name(name, original.to_s, config_options)
+      alias_method new_alias, original_name if respond_to? original_name
+    end
+  end
+
+  def make_name name, alias_name, config_options
+    return alias_name.gsub(/X/, name.to_s) if alias_name =~ /X/
+    case config_options
+    when :after
+      "#{alias_name}_#{name}"
+    when :before
+      "#{name}_#{alias_name}"
+    end
+  end
+end

data/lib/generator_spec/helpers/migration_helper.rb

@@ -17,7 +17,6 @@ module Rails::Generators
         migration_lookup_at(dirname).grep(/\d+_#{file_name}.rb$/).sort.last
       end 
 
-
       def current_migration_number(dirname) #:nodoc:
         migration_lookup_at(dirname).collect do |file|
           File.basename(file).split("_").first.to_i
@@ -37,20 +36,26 @@ module Rails::Generators
       base.extend ClassMethods      
     end
 
+    def reverse_migration_name name
+      name.gsub(/^add_/, 'remove_').gsub(/^create_/, 'drop_')
+    end
+
     def reverse_migration! migration_path
-      reverse_migration_path = migration_path.gsub /^add_/, 'remove_'          
-      reverse_migration_path = migration_path.gsub /^create_/, 'drop_'          
-      FileUtils.mv(migration_path, reverse_migration_path) if migration_path != reverse_migration_path
+      reverse_class_names! migration_path        
+      reverse_up_down_methods! migration_path
+    end
 
-      file = File.new(reverse_migration_path)
+    def reverse_class_names! migration_path
       # Change class name
-      gsub_file reverse_migration_path, /class Add/, 'class Remove'
-      gsub_file reverse_migration_path, /class Create/, 'class Drop'
+      gsub_file migration_path, /class Add/, 'class Remove'
+      gsub_file migration_path, /class Create/, 'class Drop'
+    end
 
+    def reverse_up_down_methods! migration_path
       # swap up and down methods
-      gsub_file reverse_migration_path, /up/, 'dwn'
-      gsub_file reverse_migration_path, /down/, 'up'
-      gsub_file reverse_migration_path, /dwn/, 'down'        
+      gsub_file migration_path, /up/, 'dwn'
+      gsub_file migration_path, /down/, 'up'
+      gsub_file migration_path, /dwn/, 'down'        
     end
 
     def latest_migration_file dir, name

data/lib/generator_spec/main.rb

@@ -25,8 +25,8 @@ module RSpec
 end
 
 require_all File.dirname(__FILE__) + '/extensions'
-require_all File.dirname(__FILE__) + '/rails_helpers'
 require_all File.dirname(__FILE__) + '/helpers'
+require_all File.dirname(__FILE__) + '/rails_helpers'
 require_all File.dirname(__FILE__) + '/rspec_generator'
 
 
@@ -52,8 +52,10 @@ class Class
   
   def helpers *types
     types.each{|type| include_helper type}
-  end    
-
+  end  
+  alias_method :load_helper, :helpers
+  alias_method :load_helpers, :helpers
+  
   protected
   
   def include_helper type

data/lib/generator_spec/matchers/content/content_matcher.rb

@@ -15,10 +15,10 @@ module RSpec
     end
 
     def debug?
-      false
+      RSpec::Generator.debug?
     end
          
-    def matches? content, &block            
+    def matches? content, &block
       @content = content
       match = is_match? content                                                        
       content_to_yield = if indexes
@@ -31,7 +31,7 @@ module RSpec
 
     def is_match? content
       expr = get_expr(content) 
-      puts "match expression: #{expr}" if debug?
+      debug "match expression: #{expr}"
       match = (content =~ expr)
       @content_matches = [$1, $2, $3]
       match
@@ -100,7 +100,11 @@ module RSpec
     end
       
     def debug_content
-      puts "Content: #{content}" if RSpec::Generator.debug?      
+      debug "Content: #{content}"
     end
+    
+    def debug msg
+      puts msg if debug?
+    end      
   end
 end

data/lib/generator_spec/matchers/content/have_call.rb

@@ -9,9 +9,9 @@ module RSpec::RubyContentMatchers
   class HaveCall < RSpec::RubyContentMatcher
     attr_reader :method, :args, :dot
 
-    def initialize(method, args = nil, options = {})
+    def initialize(method, options = {})
       @method = method.to_s
-      @args = args
+      @args = options[:args] || options
       @dot = options[:dot]
     end
 
@@ -49,8 +49,8 @@ module RSpec::RubyContentMatchers
                    
   end
   
-  def have_call(method, args = nil)
-    HaveCall.new(method, args)
+  def have_call(method, options = {})
+    HaveCall.new(method, options)
   end  
 
   def have_dot_call(method, options = {})

data/lib/generator_spec/matchers/content/have_comment.rb

@@ -0,0 +1,42 @@
+# This method tries to see if a specific method is contained in the generated file.
+# It can operate (should) on either a file name or the raw content 
+#
+#   generated_file_name.should have_method "hello" # 'my/path/say_hello.rb'.should have_method "hello"
+#
+#   say_hello_file_content.should have_method "hello"
+#
+module RSpec::RubyContentMatchers
+  class HaveComment < RSpec::RubyContentMatcher
+    attr_accessor :comment
+
+    def initialize comment
+      @comment = comment
+    end
+
+    def matches?(content)
+      @content = content                        
+      (content =~ /#{main_expr}/)
+    end
+  
+    def failure_message
+      super
+      "Expected there to be the comment '# #{comment}'" 
+    end 
+    
+    def negative_failure_message
+      super
+      "Did not expect there to be the comment '# #{comment}'" 
+    end
+
+    protected
+    
+    def main_expr
+      '\s*#\s*' + "#{comment}"
+    end
+  end
+
+  def have_comment comment
+    HaveComment.new comment
+  end
+  
+end

data/lib/generator_spec/matchers/file/generate_file.rb

@@ -13,18 +13,16 @@ module RSpec::FileMatchers
     end
 
     def matches?(generator, &block)          
-      puts "relative_path"    
       file = File.expand_path(relative_path, generator.class.destination_root)
       file_exists = File.exists?(file)
       if block && file_exists
         read = File.read(file)
-        puts "file content: #{read}, #{file}"
         ruby_content = read.extend(RSpec::RubyContent::Helpers)
         yield ruby_content
       else
         file_exists
-      end        
-    end          
+      end
+    end
   
     def failure_message
       "Expected file #{relative_path} to have been generated, but it was not"

data/lib/generator_spec/matchers/file/have_file.rb

@@ -48,7 +48,7 @@ module RSpec::FileMatchers
       
 
     def postfix type
-      "_#{type}" if [:helper, :controller, :observer].include?(type)
+      "_#{type}" if ![:model].include?(type)
     end
 
     def folder type
@@ -96,7 +96,7 @@ module RSpec::FileMatchers
   end
   alias_method :contain_helper, :have_helper
 
-  def have_view(relative, action, ext='html.erb')
+  def have_view(relative, action='show', ext='html.erb')
     HaveFile.new("#{relative}/#{action}.#{ext}", :view)
   end
   alias_method :contain_view, :have_view

data/lib/generator_spec/matchers/migration/have_up_down.rb

@@ -2,10 +2,12 @@ module RSpec::RubyContentMatchers
   def have_up &block
     HaveMethod.new 'up', :class, &block
   end  
+  alias_method :have_up_method, :have_up
 
   def have_down &block
     HaveMethod.new 'down', :class, &block
   end  
+  alias_method :have_down_method, :have_down
 end
 
 

data/lib/generator_spec/rails_helpers/base_helper.rb

@@ -0,0 +1,171 @@
+module RSpec::Rails
+  module BaseHelper
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        include RSpec::Rails::App
+        include Thor::Actions
+      end
+    end
+    
+    module ClassMethods
+      def aliases_for name
+        multi_alias name, 
+                    :create => :new, :insert_into => [:inject_into, :update], :read => :X_content, :remove => :delete, 
+                    :options => :after
+      end
+    end
+
+    def type_postfix type
+      "_#{type}" if ![:model].include?(type)
+    end
+
+    def artifact_path name, type, dir=nil
+      dir ||= send :"#{type}_dir"
+      File.join(dir, "#{name}#{type_postfix type}.rb")
+    end
+         
+    # CREATE
+    def create_artifact name, options={}, &block
+      type = get_type options
+
+      file = file_name name, type
+      return if File.exist?(file)
+
+      debug "create #{type}: #{name}"
+      debug "file: #{file}"
+
+      # make dir        
+      dir = File.dirname(file)
+      FileUtils.mkdir_p dir if !File.directory?(dir)
+
+      content = options[:content]
+      content ||= yield if block
+
+      content_method = :"new_#{type}_content"
+      debug "inner content: #{content}, to inject using ##{content_method}"
+
+      raise "Content method #{content_method} not found #{orm_notify}" if !respond_to?(content_method)
+      insert_content = send content_method, name, content        
+      
+      debug "content to insert: #{insert_content}"
+
+      return if insert_content.blank?
+
+      File.open(file, 'w') do |f|  
+        f.puts insert_content
+      end
+      debug "file created and content inserted"
+    end          
+
+    # READ
+    def read_artifact(name, options, &block)
+      type = get_type options
+      file_name = existing_file_name(name, type)
+      debug "reading from: #{file_name}"
+      content = File.new(file_name).try :read
+      debug "read content: #{content}"
+      yield content if block
+      content
+    end
+
+    # UPDATE
+    def insert_content(name, options={}, &block)
+      type = get_type options
+      file = existing_file_name(name, type)  
+      file_insertion file, marker(name, type, options), options, &block
+    end
+
+    # DELETE
+    def remove_artifact name, type
+      debug "remove artifact: #{name}"            
+      file = file_name name, type
+      debug "removed" if File.exist?(file) && FileUtils.rm_f(file) 
+    end
+
+    def remove_artifacts type,*names
+      names.flatten.each{|name| send :"remove_#{type}", name }
+    end
+
+    def new_artifact_content name, type, content=nil, &block
+      content ||= yield if block
+      %Q{class #{marker(name, type)}
+  #{content}
+end}
+    end
+
+    protected
+
+    def get_type options = {}
+      raise ArgumentError, "No artifact type specified" if !options[:type]
+      options[:type]      
+    end
+
+    def debug?
+      RSpec::Generator.debug?
+    end    
+
+    def debug msg
+      puts msg if debug?
+    end
+
+    def set options, type
+      options.merge!(:type => type)
+      options
+    end
+
+    def orm_notify
+      ''
+    end
+
+    def marker name, type, options={}
+      send :"#{type}_marker", name, options               
+    end
+
+    def file_name name, type, options={}
+      send :"#{type}_file_name", name, options
+    end
+
+    def existing_file_name name, type 
+      # first try finder method
+      finder_method = :"find_#{type}"
+      found = send finder_method, name if respond_to? finder_method      
+      # default
+      file_name(name, type) if !found
+    end
+
+    def file_insertion(file_name, marker, options={}, &block)
+      debug "file insertion: marker = #{marker}"
+      return if !marker
+
+      file = File.new(file_name)
+      return if !File.exist?(file)
+
+      insert_content = options[:content] || (yield if block)
+
+      # already inserted?
+      return if insert_content.blank? || (file.read =~ /#{insert_content}/)
+
+      place = options[:before] ? :before : :after 
+
+      debug "inserted #{place}: '#{marker}'"
+      debug "content: #{insert_content}"
+      
+      mutate_file file.path, marker, place do
+         insert_content
+       end
+     end   
+
+     def mutate_file file, marker, place, &block
+       raise ArgumentError, "You must define a replacement marker for a :before or :after key" if !marker 
+       replace_in_file file, /(#{Regexp.escape(marker)})/mi do |match|
+         place == :after ? "#{match}#{yield}" : "#{yield}#{match}"         
+       end
+     end  
+     
+     def replace_in_file(path, regexp, *args, &block)
+       content = File.read(path).gsub(regexp, *args, &block)
+       File.open(path, 'wb') { |file| file.write(content) }
+     end               
+   end
+ end