rspec_for_generators 0.2.0

data/lib/rspec_for_generators/matchers/content/have_method.rb

@@ -0,0 +1,49 @@
+# 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
+  module RubyContentMatchers
+    class HaveMethod
+
+      attr_reader :method
+
+      def initialize(method, type)
+        @type = type
+        @method = method
+      end
+
+      def matches?(content)      
+        @content = content
+        case @type
+        when :class
+          @content =~ /def\s+self.#{method}\s*(\(.+\))?(.*?)/m
+        else
+          @content =~ /def\s+#{method}\s*(\(.+\))?(.*?)/m
+        end
+      end          
+    
+      def failure_message
+        return "Expected there to be the class method #{method}, but there wasn't" if @type == :class
+        "Expected there to be the method #{method}, but there wasn't"        
+      end 
+      
+      def negative_failure_message                                      
+        return "Did not expect there to be the method #{method}, but there was" if @type == :class
+        "Did not expect there to be the method #{method}, but there was"
+      end
+                 
+    end
+    
+    def have_method(method, type = nil)
+      HaveMethod.new(method, type)
+    end
+    alias_method :have_instance_method, :have_method 
+    
+  end  
+end
+
+

data/lib/rspec_for_generators/matchers/content/have_module.rb

@@ -0,0 +1,34 @@
+module RSpec
+  module RubyContentMatchers
+    class HaveModule
+
+      attr_reader :module_name
+
+      def initialize(content)
+        @content = content      
+      end
+
+      def matches?(module_name)      
+        @module_name = module_name
+        @content =~ /module\s+#{@module_name}\s+(.*)end/m
+        if block_given?
+          ruby_content = $2.strip.extend(RSpec::RubyContent::Helpers)
+          yield ruby_content
+        end
+      end          
+    
+      def failure_message
+        "Expected there to be the module #{module_name}"
+      end 
+      
+      def negative_failure_message
+        "Did no expected there to be the module #{module_name}"
+      end
+                 
+    end
+    
+    def have_module(module_name)
+      HaveModule.new(module_name)
+    end    
+  end  
+end

data/lib/rspec_for_generators/matchers/content/include_module.rb

@@ -0,0 +1,36 @@
+module RSpec
+  module RubyContentMatchers
+    class IncludeModule
+
+      attr_reader :module_name
+
+      def initialize module_name
+        @module_name = module_name
+      end
+
+      def matches?(content)      
+        @content = content        
+        match_res = (@content =~ /include\s+#{module_name}/)
+        if block_given? && match_res
+          ruby_content = content.extend(RSpec::RubyContent::Helpers)
+          yield ruby_content
+        else
+          match_res
+        end
+      end          
+    
+      def failure_message
+        "Expected there to be an inclusion of module #{module_name}"
+      end 
+      
+      def negative_failure_message
+        "Did not expect there to be an inclusion of module #{module_name}"
+      end
+                 
+    end
+    
+    def include_module(module_name)
+      IncludeModule.new(module_name)
+    end    
+  end  
+end

data/lib/rspec_for_generators/matchers/content/inherit_from.rb

@@ -0,0 +1,33 @@
+module RSpec
+  module RubyContentMatchers
+    class InheritFrom
+
+      attr_reader :klass
+
+      def initialize(content)
+        @klass = klass
+      end
+
+      def matches?(content)      
+        @content = content
+        @content =~ /class\s+(.*?)<\s+#{klass}(.*)end/
+        if block_given?
+          ruby_content = $2.strip.extend(RSpec::RubyContent::Helpers)
+          yield ruby_content
+        end
+      end          
+    
+      def failure_message
+        "Expected the class to inherit from #{klass}"
+      end 
+      
+      def negative_failure_message
+        "Did not expect the class to inherit from #{klass}"
+      end
+    end
+    
+    def inherit_from(klass)
+      InheritFrom.new(klass)
+    end    
+  end  
+end

data/lib/rspec_for_generators/matchers/file/all.rb

@@ -0,0 +1 @@
+require_all File.dirname(__FILE__)

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

@@ -0,0 +1,73 @@
+# Asserts a given file exists. You need to supply an absolute path or a path relative
+# to the configured destination:
+#
+#   generator.should have_generated_file "app/controller/products_controller.rb" 
+#            
+
+module RSpec
+  module FileMatchers
+    class GenerateFile
+
+      def initialize(relative_path, type = nil)
+        @relative_path = relative_rails_file relative_path, type
+      end
+
+      def matches?(generator, &block)              
+        @expected = File.expand_path(@relative_path, generator.class.destination_root)
+        ex = File.exists?(@expected)
+        if block && ex
+          read = File.read(@expected)
+          ruby_content = read.extend(RSpec::RubyContent::Helpers)
+          yield ruby_content
+        else
+          ex
+        end        
+      end          
+    
+      def failure_message
+        "Expected file #{@relative_path} to have been generated, but it was not"
+      end
+
+      def negative_failure_message
+        "Did not expected file #{@relative_path} to have been generated, but it was"
+      end
+      
+      protected
+      
+      def relative_rails_file path, type = nil                             
+        return File.join(::Rails.root, base_dir(type), folder(type), "#{path.to_s}.rb") if type        
+        File.join(::Rails.root, path)
+      end
+
+      def folder type
+        case type
+        when :observer
+          'models'
+        else
+          type.to_s.pluralize
+        end
+      end      
+      
+      def base_dir type
+        case type
+        when :model, :controller, :view, :helper, :observer
+          'app'
+        when :migration
+          'db'
+        when :javascript, :stylesheet
+          'public'
+        when :initializer, :locale
+          'config'
+        else
+          ''          
+        end
+      end
+    end
+
+    def generate_file(relative, type = nil)
+      GenerateFile.new(relative, type)
+    end
+    alias_method :generate_directory, :generate_file  
+
+  end
+end

data/lib/rspec_for_generators/matchers/file/generate_migration.rb

@@ -0,0 +1,43 @@
+# This method manipulates the given path and tries to find any migration which
+# matches the migration name. For example, the call above is converted to:
+#
+#   generator.should generate_migration "db/migrate/003_create_products.rb"
+#
+# Consequently it accepts the same arguments as the matcher have_file.
+
+module RSpec
+  module FileMatchers
+    class GenerateMigration
+
+      def initialize(relative)
+        @relative = relative      
+      end
+
+      def matches?(generator)      
+        migration_file_name(relative, generator)        
+      end          
+    
+      def failure_message
+        "Expected migration #{relative} to have been generated, but it was not"
+      end
+
+      def negative_failure_message
+        "Did not expect migration #{relative} to have been generated, but it was"
+      end
+      
+      protected
+      
+      def migration_file_name(relative, generator) #:nodoc:
+        absolute = File.expand_path(relative, generator.class.destination_root)
+        dirname, file_name = File.dirname(absolute), File.basename(absolute).sub(/\.rb$/, '')
+        Dir.glob("#{dirname}/[0-9]*_*.rb").grep(/\d+_#{file_name}.rb$/).first
+      end
+      
+    end
+  
+    def generate_migration(relative)
+      GenerateMigration.new(relative)
+    end
+
+  end   
+end

data/lib/rspec_for_generators/matchers/helpers/content.rb

@@ -0,0 +1,20 @@
+module RSpec
+  module RubyContent
+    module Helpers
+      def check_matchings matchings
+        matchings.each do |matching|
+          self.should match /#{Regexp.escape(matching)}/
+        end
+      end
+      alias_method :matchings, :check_matchings 
+
+
+      def check_methods methods, type=nil
+        methods.each do |method_name|
+          self.should have_method(method_name, type)
+        end
+      end
+      alias_method :methods, :check_methods
+    end
+  end
+end

data/lib/rspec_for_generators/matchers/helpers/file.rb

@@ -0,0 +1,28 @@
+module RSpec
+  module Generator
+    module Helpers
+      def check_file file, type=nil, &block
+        self.should generate_file(file, type, &block)
+      end
+      alias_method :file, :check_file
+
+      def check_view(file_name, matchings)
+        self.should generate_file(filename, :view) do |content|  
+          check_matchings matchings
+        end
+      end
+      alias_method :view, :check_view
+
+      def check_model(name, clazz, options = {})
+        self.should generate_file("#{name.underscore}.rb", :model) do |file_content|
+          file_content.should have_class clazz.camelize do |content|
+            check_matchings options[:matchings]    
+            check_methods(options[:methods])
+            check_class_methods(options[:class_methods])
+          end
+        end            
+      end
+      alias_method :model, :check_model
+    end
+  end
+end

data/lib/rspec_for_generators/rails_helpers/all.rb

@@ -0,0 +1,6 @@
+require 'rspec_for_generators/rails_helpers/rails_app'
+require 'rspec_for_generators/rails_helpers/rails_model'
+require 'rspec_for_generators/rails_helpers/rails_controller'
+require 'rspec_for_generators/rails_helpers/rails_helper'
+require 'rspec_for_generators/rails_helpers/rails_view'
+require 'rspec_for_generators/rails_helpers/rails_mailer'

data/lib/rspec_for_generators/rails_helpers/rails_app.rb

@@ -0,0 +1,55 @@
+module RSpec  
+  module Rails
+    module App 
+      def self.debug!
+        self.extend(Debug)        
+      end      
+      
+      module Debug
+        def rails_files
+          FileList["#{::Rails.root}/**/*.rb"]
+        end  
+
+        def rails_app_files
+          FileList["#{::Rails.root}/app/**/*.rb"]
+        end  
+
+        def rails_model_files
+          FileList["#{::Rails.root}/app/models/**/*.rb"]
+        end  
+
+        def rails_controller_files
+          FileList["#{::Rails.root}/app/controllers/**/*.rb"]
+        end  
+
+        def rails_helper_files
+          FileList["#{::Rails.root}/app/helpers/**/*.rb"]
+        end  
+
+        def rails_view_files
+          FileList["#{::Rails.root}/app/views/**/*.yml"]
+        end
+
+        def rails_initializer_files
+          FileList["#{::Rails.root}/config/initializers/**/*.rb"]
+        end  
+
+        def rails_migration_files
+          FileList["#{::Rails.root}/db/migration/**/*.rb"]
+        end
+
+        def rails_locale_files
+          FileList["#{::Rails.root}/config/locales/**/*.yml"]
+        end
+
+        def rails_javascript_files
+          FileList["#{::Rails.root}/public/javascripts/**/*.yml"]
+        end
+
+        def rails_stylesheet_files
+          FileList["#{::Rails.root}/public/stylesheets/**/*.yml"]
+        end
+      end
+    end
+  end
+end

data/lib/rspec_for_generators/rails_helpers/rails_controller.rb

@@ -0,0 +1,34 @@
+module RSpec  
+  module Rails
+    module Controller
+      def create_controller name
+        file =  controller_file_name(name)
+        unless File.exist?(file)    
+          FileUtils.mkdir_p File.dirname(file)
+          File.open(file, 'w') do |f|  
+            f.puts controller_content
+          end
+        end
+      end  
+
+      def controller_content name
+        %Q{class #{name.camelize}Controller < ActionController::Base
+        end}        
+      end
+
+      def remove_controller name
+        file = controller_file_name(name)
+        FileUtils.rm_f(file) if File.exist?(file)
+      end
+
+      def remove_controllers *names
+        names.each{|name| remove_controller name }
+      end     
+      
+      def controller_file_name name
+        File.join(::Rails.root, "app/controllers/#{name}.rb")
+      end        
+      
+    end
+  end
+end

data/lib/rspec_for_generators/rails_helpers/rails_helper.rb

@@ -0,0 +1,36 @@
+module RSpec  
+  module Rails
+    module Helper
+      def create_helper name
+        file =  helper_file_name(name)
+        unless File.exist?(file)    
+          FileUtils.mkdir_p File.dirname(file)
+          File.open(file, 'w') do |f|  
+            f.puts helper_content
+          end
+        end
+      end  
+
+      def helper_content name
+        %Q{class #{name.camelize}Helper
+        end}        
+      end
+
+      def remove_model name
+        file = helper_file_name(name)
+        FileUtils.rm_f(file) if File.exist?(file)
+      end
+
+      def remove_helpers *names
+        names.each{|name| remove_helper name }
+      end
+      
+      protected
+      
+      def helper_file_name name
+        File.join(::Rails.root, "app/helpers/#{name}.rb")
+      end        
+      
+    end
+  end
+end