imedo-dry_plugin_test_helper 0.0.3

data/README.rdoc

@@ -0,0 +1,72 @@
+= dry_plugin_test
+
+Author::    Hendrik Volkmer  - hvolkmer (at) imedo.de
+Copyright:: Copyright (c) 2008 imedo GmbH
+Licence::   MIT
+Git::       http://github.com/imedo/dry_plugin_test_helper
+Bugs::      No dedicated bug tracker yet - Email us or just send pull requests 
+
+Makes your plugin tests dry and isolates plugin tests from you real app.
+
+== Dependencies
+* Rails 2.0.2 (should work also with 1.2)
+* sqlite3 - http://www.sqlite.org/
+
+== Installation
+
+The easiest way to install this gem is directly via the github gem 
+repository:
+
+ $ sudo gem install imedo-dry_plugin_test_helper -s http://gems.github.com
+
+Or
+
+download the source code and build the gem yourself
+
+ $ git clone git://github.com/imedo/dry_plugin_test_helper.git
+ $ cd dry_plugin_test_helper
+ $ rake
+ $ sudo gem install pkg/dry_plugin_test_helper-0.0.3.gem
+
+== Usage
+
+In your plugin test helper use these lines:
+
+ require 'rubygems'
+ require 'dry_plugin_test_helper'
+
+ PluginTestEnvironment.init_env(File.dirname(__FILE__))
+
+
+This sets up the test environment which means you have a stub rails app with 
+you plugin loaded and also the following models:
+
+* Article: belongs_to :author, has_many   :comments
+* Author: has_many :articles
+* Comment: belongs_to :articles, belongs_to :user
+* User: has_many :comments
+
+The models will be added to a sqlite in memory database for fast testing.
+
+You can add your own models using a migration in your test directory like 
+this:
+
+ PluginTestEnvironment::Migration.setup do 
+
+   create_table "animals", :force => true do |t|
+     t.column "name", :string
+     t.column "age",  :integer
+   end
+
+ end
+
+If you don't want the standard models you can initialize the test environment
+like this:
+
+ PluginTestEnvironment.init_env(File.dirname(__FILE__), false)
+
+== TODO
+* Tests for the test gem itself
+* support for RSpec and other testing frameworks (might already work - haven't tried it)
+* Automatic Rails version discovery
+* Clean up / strip down rails env to bare minimum

data/fixtures/articles.yml

@@ -0,0 +1,10 @@
+first:
+  id: 1
+  title: "What's in the package?"
+  body: "Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern. From the Ajax in the view, to the request and response in the controller, to the domain model wrapping the database, Rails gives you a pure-Ruby development environment. To go live, all you need to add is a database and a web server."
+  author_id: 1
+second:
+  id: 2
+  title: "Who is already on Rails?"
+  body: "Everyone from startups to non-profits to enterprise organizations are using Rails. Rails is all about infrastructure so it's a great fit for practically any type of web application. Be it software for collaboration, community, e-commerce, content management, statistics, management, you name it."
+  author_id: 2

data/lib/dry_plugin_test_helper.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'active_support'
+require 'active_record'
+
+ENV['RAILS_ENV'] ||= 'sqlite3'
+
+require File.dirname(__FILE__) + '/silent_logger'
+require File.dirname(__FILE__) + '/plugin_test_environment'
+
+require 'time'
+
+
+# Code by Jay Fields
+# http://blog.jayfields.com/2007/11/ruby-timeis.html
+class Time
+  def self.metaclass
+    class << self; self; end
+  end
+  
+  def self.is(point_in_time)
+    new_time = case point_in_time
+      when String then Time.parse(point_in_time)
+      when Time then point_in_time
+      else raise ArgumentError.new("argument should be a string or time instance")
+    end
+    class << self
+      alias old_now now
+    end
+    metaclass.class_eval do
+      define_method :now do
+        new_time
+      end
+    end
+    yield
+    class << self
+      alias now old_now
+      undef old_now
+    end
+  end
+end
+

data/lib/plugin_test_environment.rb

@@ -0,0 +1,38 @@
+class PluginTestEnvironment
+  
+  cattr_accessor :plugin_path
+  
+  def self.init_env(dir, standard_migration = true)
+    self.plugin_path = "#{dir}/.."
+    require File.dirname(__FILE__) + '/../rails_root/config/environment.rb'
+    ActiveRecord::Migrator.migrate("#{RAILS_ROOT}/db/migrate") if standard_migration
+    plugin_migration
+  end
+  
+  def self.fixture_path
+    if File.exists?(PluginTestEnvironment.plugin_path + '/test/fixtures')
+      PluginTestEnvironment.plugin_path + '/test/fixtures'
+    else
+      File.dirname(__FILE__) + "/../fixtures/"
+    end
+  end
+  
+  def self.log_path
+    PluginTestEnvironment.plugin_path + '/test/log'
+  end
+  
+  def self.plugin_migration
+    begin
+      require "#{PluginTestEnvironment.plugin_path}/test/migration"
+      Migration.up
+    rescue LoadError
+    end
+  end
+   
+ class Migration < ActiveRecord::Migration
+    def self.setup(&block)
+      self.class.send(:define_method, :up, &block)
+    end
+  end
+ 
+end

data/lib/silent_logger.rb

@@ -0,0 +1,11 @@
+class SilentLogger < Logger
+  
+  def initialize
+    super(STDOUT)
+  end
+  
+  def add(severity, message = nil, progname = nil, &block)
+    # shhh
+  end
+  
+end

data/rails_root/app/controllers/application.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/rails_root/app/models/article.rb

@@ -0,0 +1,6 @@
+class Article < ActiveRecord::Base
+  
+  belongs_to :author
+  has_many   :comments
+  
+end

data/rails_root/app/models/author.rb

@@ -0,0 +1,5 @@
+class Author < ActiveRecord::Base
+  
+  has_many :articles
+  
+end

data/rails_root/app/models/comment.rb

@@ -0,0 +1,6 @@
+class Comment < ActiveRecord::Base
+  
+  belongs_to :articles
+  belongs_to :user
+  
+end

data/rails_root/app/models/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+  
+  has_many :comments
+  
+end

data/rails_root/config/boot.rb

@@ -0,0 +1,45 @@
+# Don't change this file. Configuration is done in config/environment.rb and config/environments/*.rb
+
+unless defined?(RAILS_ROOT)
+  root_path = File.join(File.dirname(__FILE__), '..')
+
+  unless RUBY_PLATFORM =~ /(:?mswin|mingw)/
+    require 'pathname'
+    root_path = Pathname.new(root_path).cleanpath(true).to_s
+  end
+
+  RAILS_ROOT = root_path
+end
+
+unless defined?(Rails::Initializer)
+  if File.directory?("#{RAILS_ROOT}/vendor/rails")
+    require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+  else
+    require 'rubygems'
+
+    environment_without_comments = IO.readlines(File.dirname(__FILE__) + '/environment.rb').reject { |l| l =~ /^#/ }.join
+    environment_without_comments =~ /[^#]RAILS_GEM_VERSION = '([\d.]+)'/
+    rails_gem_version = $1
+
+    if version = defined?(RAILS_GEM_VERSION) ? RAILS_GEM_VERSION : rails_gem_version
+      # Asking for 1.1.6 will give you 1.1.6.5206, if available -- makes it easier to use beta gems
+      rails_gem = Gem.cache.search('rails', "~>#{version}.0").sort_by { |g| g.version.version }.last
+
+      if rails_gem
+        gem "rails", "=#{rails_gem.version.version}"
+        require rails_gem.full_gem_path + '/lib/initializer'
+      else
+        STDERR.puts %(Cannot find gem for Rails ~>#{version}.0:
+    Install the missing gem with 'gem install -v=#{version} rails', or
+    change environment.rb to define RAILS_GEM_VERSION with your desired version.
+  )
+        exit 1
+      end
+    else
+      gem "rails"
+      require 'initializer'
+    end
+  end
+
+  Rails::Initializer.run(:set_load_path)
+end

data/rails_root/config/database.yml

@@ -0,0 +1,18 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: ':memory:'
+sqlite3:
+  :adapter: sqlite3
+  :dbfile: ':memory:'
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: most_popular_test
+  :min_messages: ERROR
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: root
+  :password:
+  :database: most_popular_test

data/rails_root/config/environment.rb

@@ -0,0 +1,41 @@
+# Specifies gem version of Rails to use when vendor/rails is not present
+#RAILS_GEM_VERSION = '1.1.6'
+RAILS_GEM_VERSION = '2.0.2' unless defined? RAILS_GEM_VERSION
+
+require File.join(File.dirname(__FILE__), 'boot')
+#require 'plugin_dependencies'
+
+Rails::Initializer.run do |config|
+  config.logger = SilentLogger.new
+  config.log_level = :debug
+
+  config.cache_classes = false
+  config.whiny_nils = true
+  #config.breakpoint_server = true
+  config.load_paths << "#{File.dirname(__FILE__)}/../../../lib/"
+end
+
+Dependencies.log_activity = false
+
+require 'test_help'
+
+
+Test::Unit::TestCase.fixture_path = PluginTestEnvironment.fixture_path
+$LOAD_PATH.unshift(Test::Unit::TestCase.fixture_path)
+
+class Test::Unit::TestCase #:nodoc:
+  def create_fixtures(*table_names)
+    if block_given?
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names) { yield }
+    else
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names)
+    end
+  end
+  
+  self.use_transactional_fixtures = false
+  self.use_instantiated_fixtures  = false
+end
+
+# Load the testing framework
+silence_warnings { RAILS_ENV = ENV['RAILS_ENV'] }
+

data/rails_root/config/routes.rb

@@ -0,0 +1,9 @@
+ActionController::Routing::Routes.draw do |map|
+  # Allow downloading Web Service WSDL as a file with an extension
+  # instead of a file named 'wsdl'
+  map.connect ':controller/service.wsdl', :action => 'wsdl'
+  
+  # Default route
+  map.connect ':controller/:action/:id.:format'
+  map.connect ':controller/:action/:id'
+end

data/rails_root/db/migrate/001_create_environment.rb

@@ -0,0 +1,33 @@
+class CreateEnvironment < ActiveRecord::Migration
+  def self.up
+    create_table :articles do |t|
+      t.column :title, :string
+      t.column :body, :text
+      t.column :author_id, :integer
+      t.column :active, :integer, :default => 1
+      t.column :hidden, :integer, :default => 0
+      t.column :deactivated_at, :datetime
+    end
+
+    create_table :authors do |t|
+      t.column :name, :string
+    end
+
+    create_table :comments do |t|
+      t.column :body, :text
+      t.column :article_id, :integer
+      t.column :user_id, :integer
+    end
+
+    create_table :users do |t|
+      t.column :name, :string
+    end  
+  end
+  
+  def self.down
+    drop_table :articles
+    drop_table :authors
+    drop_table :comments
+    drop_table :users
+  end
+end

data/rails_root/script/console

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/console'

data/rails_root/vendor/plugins/plugin_to_test/init.rb

@@ -0,0 +1,3 @@
+init_path = PluginTestEnvironment.plugin_path + "/init.rb" #
+
+silence_warnings { eval(IO.read(init_path), binding, init_path) }

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: imedo-dry_plugin_test_helper
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Hendrik Volkmer
+autorequire: active_record
+bindir: bin
+cert_chain: []
+
+date: 2008-06-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.15.3
+    version: 
+description: 
+email: hvolkmer@imedo.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/silent_logger.rb
+- lib/dry_plugin_test_helper.rb
+- lib/plugin_test_environment.rb
+- rails_root/db
+- rails_root/db/migrate
+- rails_root/db/migrate/001_create_environment.rb
+- rails_root/app
+- rails_root/app/controllers
+- rails_root/app/controllers/application.rb
+- rails_root/app/models
+- rails_root/app/models/author.rb
+- rails_root/app/models/user.rb
+- rails_root/app/models/article.rb
+- rails_root/app/models/comment.rb
+- rails_root/config
+- rails_root/config/routes.rb
+- rails_root/config/environments
+- rails_root/config/environments/sqlite3.rb
+- rails_root/config/environments/sqlite.rb
+- rails_root/config/environments/postgresql.rb
+- rails_root/config/environments/mysql.rb
+- rails_root/config/database.yml
+- rails_root/config/environment.rb
+- rails_root/config/boot.rb
+- rails_root/script
+- rails_root/script/console
+- rails_root/vendor
+- rails_root/vendor/plugins
+- rails_root/vendor/plugins/plugin_to_test
+- rails_root/vendor/plugins/plugin_to_test/init.rb
+- fixtures/articles.yml
+- README.rdoc
+has_rdoc: true
+homepage: http://opensource.imedo.de/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Providing dry standard test environment for Ruby on Rails plugins
+test_files: []
+