generator-spec 0.3.3

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,144 @@
+# RSpec 2 library for specifying and testing generators
+
+This project contains RSpec 2 matchers, helpers and various utilities to assist in writing Rails 3 generator specs.
+
+Rails 3 has a Rails::Generators::TestCase class for use with Test-Unit, to help test generators, containing specific assertion methods that can be used to assert generator behavior. Theres was no RSpec 2 equivalent, so I wrapped Rails::Generators::TestCase for use with RSpec 2 and created some RSpec 2 matchers that mimic the assertion methods
+of TestCase and also added some extra goodies to the mix. It should now be pretty easy to test your Rails 3 generators with RSpec 2 :)
+
+Please advice if you find any issues or have suggestions for improvements. The code is not as pretty as it could be, so feel free to refactor and improve it to your hearts desire!
+
+## Install
+
+<code>gem install rspec_for_generators</code>
+
+The gem is a jewel (using jeweler), so to install the gem from the code - simply use the jeweler rake task:
+
+<code>rake install</code>
+
+## Usage
+
+The following demonstrates an example usage. There are many more options and DSL convenience methods.
+
+### Configuration
+
+First setup the *spec_helper.rb*. Here is an example configuration.
+
+<pre># spec/spec_helper.rb
+  
+require 'rspec'
+require 'rspec_for_generators'
+
+# configure it like this to use default settings
+RSpec::Generator.configure_root_dir __FILE__
+
+# or customize the location of the temporary Rails 3 app dir used
+RSpec::Generator.configure_root_dir '~/my/rails/folder', :custom
+</pre>
+
+### Specs for generators
+
+I recommend having a separate spec for each generator. A generator spec can include *this* file to ensure all generators are loaded.
+Put a *require_generator* statement in each spec file, to ensure that particular generator is loaded and thus available for the spec.
+
+<pre>require_generator :canable</pre>
+
+This will load the generator : `generators/canabale_generator.rb`
+
+If the generator is namespaced, use a nested approach like so:
+
+<pre>require_generators :canable => ['model', 'user']</pre>
+
+This will load the generators: `generators/canable/model_generator.rb` and `generators/canable/user_generator.rb`
+
+If you have multiple generators in a shared namespace, the following approach can be used. 
+Create a file that loads all the generators in the namespace. Include this file for each spec that tests a particular generator in that namespace:
+  
+<pre># spec/generators/canable.rb
+require_generators :canable => ['model', 'user']</pre>
+
+<pre># spec/generators/canable/model_generator_spec.rb
+...
+# load generators to spec
+require 'generators/canable'
+
+describe 'model_generator' do
+  ...   
+end
+</pre>
+
+<pre># spec/generators/canable/user_generator_spec.rb
+...
+# load generators to spec
+require 'generators/canable'
+
+describe 'user_generator' do
+  ...   
+end
+</pre>
+
+
+
+### Example of full generator spec
+
+<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 ActiveRecord
+  # available: MongoMapper, Mongoid and DataMapper
+  
+  include RSpec::Rails::Orm::ActiveRecord
+  
+  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 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 = "generator-spec"
+    gem.summary = %Q{RSpec 2 library for writing generator specs}
+    gem.description = %Q{RSpec 2 library 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.3.3

data/generator-spec.gemspec

@@ -0,0 +1,106 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{generator-spec}
+  s.version = "0.3.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2010-08-04}
+  s.description = %q{RSpec 2 library to assist in writing generator specs}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "generator-spec.gemspec",
+     "lib/generators/demo/demo_generator.rb",
+     "lib/rspec_for_generators.rb",
+     "lib/rspec_for_generators/fixtures/routes.rb",
+     "lib/rspec_for_generators/generator_spec_helper.rb",
+     "lib/rspec_for_generators/main.rb",
+     "lib/rspec_for_generators/matchers/content/have_block.rb",
+     "lib/rspec_for_generators/matchers/content/have_call.rb",
+     "lib/rspec_for_generators/matchers/content/have_class.rb",
+     "lib/rspec_for_generators/matchers/content/have_method.rb",
+     "lib/rspec_for_generators/matchers/content/have_module.rb",
+     "lib/rspec_for_generators/matchers/content/include_module.rb",
+     "lib/rspec_for_generators/matchers/content/inherit_from.rb",
+     "lib/rspec_for_generators/matchers/file/generate_directory.rb",
+     "lib/rspec_for_generators/matchers/file/generate_file.rb",
+     "lib/rspec_for_generators/matchers/file/generate_migration.rb",
+     "lib/rspec_for_generators/matchers/helpers/content.rb",
+     "lib/rspec_for_generators/matchers/helpers/file.rb",
+     "lib/rspec_for_generators/matchers/helpers/migration.rb",
+     "lib/rspec_for_generators/matchers/migration/have_column.rb",
+     "lib/rspec_for_generators/matchers/migration/have_index.rb",
+     "lib/rspec_for_generators/matchers/migration/have_migration.rb",
+     "lib/rspec_for_generators/matchers/migration/have_table.rb",
+     "lib/rspec_for_generators/matchers/migration/have_tbl_column.rb",
+     "lib/rspec_for_generators/matchers/migration/have_up_down.rb",
+     "lib/rspec_for_generators/rails_helpers/all.rb",
+     "lib/rspec_for_generators/rails_helpers/rails_app.rb",
+     "lib/rspec_for_generators/rails_helpers/rails_controller.rb",
+     "lib/rspec_for_generators/rails_helpers/rails_helper.rb",
+     "lib/rspec_for_generators/rails_helpers/rails_mailer.rb",
+     "lib/rspec_for_generators/rails_helpers/rails_model.rb",
+     "lib/rspec_for_generators/rails_helpers/rails_orm.rb",
+     "lib/rspec_for_generators/rails_helpers/rails_view.rb",
+     "lib/rspec_for_generators/rails_spec_helper.rb",
+     "lib/rspec_for_generators/rspec_test_case.rb",
+     "rspec_for_generators.gemspec",
+     "spec/rspec_for_generators/rspec_for_generators_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "wiki/Custom Rails 3 Generators.textile",
+     "wiki/rails_view_helpers.textile"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/rspec_for_generators}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{RSpec 2 library for writing generator specs}
+  s.test_files = [
+    "spec/rspec_for_generators/rspec_for_generators_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta19"])
+      s.add_runtime_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+      s.add_runtime_dependency(%q<rake>, [">= 0.8.7"])
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.0.rc"])
+      s.add_runtime_dependency(%q<test-unit>, [">= 2.0.9"])
+      s.add_runtime_dependency(%q<require_all>, [">= 1.1.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta19"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+      s.add_dependency(%q<rake>, [">= 0.8.7"])
+      s.add_dependency(%q<rails>, [">= 3.0.0.rc"])
+      s.add_dependency(%q<test-unit>, [">= 2.0.9"])
+      s.add_dependency(%q<require_all>, [">= 1.1.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta19"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+    s.add_dependency(%q<rake>, [">= 0.8.7"])
+    s.add_dependency(%q<rails>, [">= 3.0.0.rc"])
+    s.add_dependency(%q<test-unit>, [">= 2.0.9"])
+    s.add_dependency(%q<require_all>, [">= 1.1.0"])
+  end
+end
+

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.to_s.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