rspec_for_generators 0.2.0

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 Kristian Mandrup
+
+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.markdown

@@ -0,0 +1,111 @@
+# RSpec 2 library for specifying and testing generators
+
+RSpec 2 matchers, helpers and various utilities to assist in writing generator specs especially Rails 3 generators.
+
+This project was extracted from my experiments with creating generators for jnunemaker's *Canable*, see [My fork of Canable](http://github.com/kristianmandrup/canable).
+
+I attempted to test the generators I built but I noticed, that the only option I could find, was to use a special Rails TestCase class created for Test-Unit. 
+So I thought I could wrap it to be used with RSpec 2; my BDD testing framework of choice!
+
+## Install
+
+<code>gem install rspec_for_generators</code>
+
+To install using edge
+
+<code>rake install</code>
+
+## Usage
+
+The following demonstrates an example usage. There are many more options and cool DSL convenience methods. Check out the code!
+
+<pre>
+# spec/spec_helper.rb
+require 'rspec'
+
+# This is required for rails_spec_helper.rb to work. Not sure how to better set this configuration value. 
+# It's the relative root for which the Rails mock app is created. So if it's set to point to the spec folder, 
+# then rails will be put under ../tmp, relative to /spec, so that /tmp will be a folder in the current project root. 
+# Note: In the near future I will provide a better way to achieve this by hooking into some step in the Rails 3 loading behavior
+
+module Rails
+  def config_root_dir
+    File.dirname(__FILE)
+  end
+end    
+
+# load this rspec toolbox to help spec generators
+require 'rspec_for_generators' 
+
+<pre>
+  
+<pre>
+  # spec/generators/canable.rb
+  require_generators :canable => ['model', 'user']
+</pre>
+
+<pre>
+# spec/generators/model_generator_spec.rb
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+# list of generators to spec are loaded
+require 'generators/canable'
+
+describe 'model_generator' do
+  # include Rails model helpers for AciveRecord
+  # also available are: MongoMapper, Mongoid and DataMapper    
+  # mongo_mapper, :data_mapper, :mongoid
+  
+  model_helper_for :active_record
+  
+  before :each do              
+    # define generator to test
+    RSpec::Generator.setup_generator 'model_generator' do
+      tests Canable::Generators::ModelGenerator
+    end    
+    # ensure clean state before run
+    remove_model 'account'    
+  end
+
+  after :each do              
+    # ensure clean state after run  
+    remove_model 'account'    
+  end
+    
+  it "should not work without an existing Account model file" do            
+    RSpec::Generator.with_generator do |g|   
+      name = 'account'
+      g.run_generator %w{account}
+      g.should_not generate_file name, :model
+    end
+  end
+
+  it "should decorate an existing Account model file with 'include Canable:Ables'" do            
+    RSpec::Generator.with_generator do |g|  
+      name = 'account'
+      create_model name     
+      g.run_generator %w{account}
+      g.should generate_file name, :model do |content|
+        content.should have_class name.camelize do |klass|
+          klass.should include_module 'Canable::Ables'
+        end
+      end
+    end
+  end
+end
+</pre>
+
+## 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 Kristian Mandrup. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rspec_for_generators"
+    gem.summary = %Q{RSpec 2 matchers, helpers and utils for writing generator specs}
+    gem.description = %Q{RSpec 2 matchers, helpers and utils to assist in writing generator specs}
+    gem.email = "kmandrup@gmail.com"
+    gem.homepage = "http://github.com/kristianmandrup/rspec_for_generators"
+    gem.authors = ["Kristian Mandrup"]
+    gem.add_development_dependency "rspec", ">= 2.0.0.beta19"
+    gem.add_dependency "rspec",     ">= 2.0.0.beta.19"
+    gem.add_dependency "rake",      ">= 0.8.7"
+    gem.add_dependency "rails",     ">= 3.0.0.rc" 
+    gem.add_dependency "test-unit", ">= 2.0.9" 
+    gem.add_dependency "require_all", ">= 1.1.0"
+    # 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 'spec/rake/spectask'
+# Spec::Rake::SpecTask.new(:spec) do |spec|
+#   spec.libs << 'lib' << 'spec'
+#   spec.spec_files = FileList['spec/**/*_spec.rb']
+# end
+# 
+# Spec::Rake::SpecTask.new(:rcov) do |spec|
+#   spec.libs << 'lib' << 'spec'
+#   spec.pattern = 'spec/**/*_spec.rb'
+#   spec.rcov = true
+# end
+# 
+# task :spec => :check_dependencies
+# 
+# task :default => :spec
+# 
+# require 'rake/rdoctask'
+# Rake::RDocTask.new do |rdoc|
+#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
+# 
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "rspec_for_generators #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/generators/demo/demo_generator.rb

@@ -0,0 +1,91 @@
+class DemoGenerator < Rails::Generators::Base
+  desc "Adds Canable::Ables permission system to Model" 
+
+  argument      :name,          :type => :string,   :default => 'User',   :desc => 'Name of model to make Canable:Able', :required => false
+    
+  def self.source_root
+    @source_root ||= File.expand_path("../../templates", __FILE__)
+  end
+
+  def make_canable_able
+    if File.exist?(model_file_name)
+      @model_file_txt  = File.open(model_file_name).read
+      after_txt       = find_after_txt(model_file_txt)        
+      inject_into_file(model_file_name, canable_include_txt, :after => after_txt) if after_txt
+    else
+      say "#{model_file_name} does not exist. Please create it first before you can make it Canable:Able", :red
+    end
+  end
+
+  def post_log
+    say "Your model #{model_class_name} is now Canable:Able. Please define your permission login in #{model_file_name}", :green
+  end
+
+  protected
+
+  attr_accessor :model_file_txt
+
+  def find_after_txt model_file_txt
+    # after first include statement
+    match = (model_file_txt =~ /(include\s+\S+)/)
+    return $1 if match
+
+    # or after class definition if no includes
+    match = model_file_txt =~ /(class\s+#{model_class_name}\s+<\s+ActiveRecord::Base)/ # first try match AR model
+    match = model_file_txt =~ /(class\s+#{model_class_name})/ if !match
+    $1 || nil       
+  end
+
+  def model_class_name
+    name.camelize
+  end
+                     
+  def model_file_name
+    File.join(Rails.root, "app/models/#{name}.rb")
+  end
+
+  def canable_include_txt
+    %Q{
+include Canable::Ables
+#{add_userstamps}
+
+# permission logic
+#{add_methods}
+}
+  end
+
+  def has_userstamps?
+    model_file_txt =~ /userstamps!/       
+  end
+
+  def add_userstamps 
+    if !has_userstamps?       
+      "userstamps! # adds creator and updater\n" if options[:userstamps]
+    end
+  end
+
+  def has_method? name
+    model_file_txt =~ /(def #{name}_by\?)/ 
+  end     
+
+  def add_methods
+    methods = []
+    %w{creatable destroyable updatable viewable}.each do |name|
+      if !has_method?(name)
+        method = add_method(name)
+        methods << method if method
+      end
+    end
+    methods.join("\n  ")
+  end
+
+  def add_method(name)        
+    if options[name.to_sym]
+    %Q{
+def #{name}_by?(user)
+  true
+end
+}     
+    end
+  end      
+end 

data/lib/rspec_for_generators.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'rake'            
+require 'rails'
+require 'require_all'
+require 'rails/generators'
+require 'rspec_for_generators/main'
+
+RSpec.configure do |config|
+  config.include(RSpec::FileMatchers)
+  config.include(RSpec::RubyContentMatchers)  
+end

data/lib/rspec_for_generators/fixtures/routes.rb

@@ -0,0 +1,2 @@
+TestApp.routes.draw do |map|
+end

data/lib/rspec_for_generators/generator_spec_helper.rb

@@ -0,0 +1,73 @@
+require 'test/unit'
+require 'rails/all'
+require 'rails/generators'
+require 'rails/generators/test_case'
+
+require 'rspec_for_generators/rails_spec_helper'
+
+# Call configure to load the settings from
+# Rails.application.config.generators to Rails::Generators
+
+Rails::Generators.configure!
+
+# require the generators
+def require_generators generator_list
+  generator_list.each do |name, generators|
+    generators.each do |generator_name|
+      require File.join('generators', name.to_s, generator_name.to_s, "#{generator_name}_generator")
+    end    
+  end
+end
+
+module RSpec    
+  module Generator
+    class << self  
+      attr_accessor :generator, :test_method_name
+
+      def run_generator *args, &block
+        generator.run_generator *args
+        if block
+          block.arity < 1 ? generator.instance_eval(&block) : block.call(generator, self)  
+        end      
+      end
+
+      def check(&block)
+        if block
+          block.arity < 1 ? self.instance_eval(&block) : block.call(self)  
+        end      
+      end
+
+      def with(generator, &block)
+        if block
+          block.arity < 1 ? generator.instance_eval(&block) : block.call(generator, self, generator.class)  
+        end
+      end
+    
+      def with_generator &block
+        with(get_generator, &block)
+      end
+
+      def setup_generator test_method_name=nil, &block
+        clean! if test_method_name  
+        generator = get_generator(test_method_name).extend(RSpec::Generator::Helpers)
+        if block
+          block.arity < 1 ? generator.class.instance_eval(&block) : block.call(generator.class)  
+        end
+      end
+
+      protected
+      
+      def clean!
+        if generator
+          generator.class.generator_class = nil 
+        end
+        @generator = nil
+      end
+    
+      def get_generator test_method_name=nil
+        @generator ||= RSpec::Generators::TestCase.new(test_method_name + '_spec')
+      end
+      
+    end # class self
+  end
+end

data/lib/rspec_for_generators/main.rb

@@ -0,0 +1,7 @@
+require 'rspec_for_generators/rails_spec_helper'
+require 'rspec_for_generators/rspec_test_case'
+require 'rspec_for_generators/generator_spec_helper'
+
+require_all File.dirname(__FILE__) + '/matchers/helpers'
+require_all File.dirname(__FILE__) + '/matchers/content'
+require_all File.dirname(__FILE__) + '/matchers/file'

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

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

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

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