rails_spec_harness 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0e5f2ef469b8e4605651c07598eb65b53962dee
+  data.tar.gz: 1b3e5f19c0e51591bc490db72f5f48fe1a52114d
+SHA512:
+  metadata.gz: 1f5eab81dd564a1288708c0f6d5871841ad675a4a931580415e90ffad1ef737d376092558928bde32797cad52caae2b215f56fb84a549ef66ba9f340f2237a27
+  data.tar.gz: 141dbc8bc7d25ac2288d1a9e8754eb6fa3aadf181c0403f21cbeeee573264175edff4da1b41216a499d1e98528f44cb79b804637ff34a172a3e24e60019e7b56

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_spec_harness.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 alexpeachey
+
+MIT License
+
+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.md

@@ -0,0 +1,62 @@
+# Rails Spec Harness
+
+A gem with some useful generators for Rails applications.
+Designed to make testing faster and easier.
+It will add some nice gems to your Gemfile (optional), create a Guardfile (optional), and set you up with
+a set of spec helpers and directory structures.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_spec_harness'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_spec_harness
+
+## Usage
+
+Generate everything:
+
+    rails generate spec_harness
+
+Leave out the Gemfile modification and the Guardfile:
+
+    rails generate spec_harness --no-gems --no-guardfile
+
+Only include specific types of specs:
+
+    rails generate spec_harness --only_types=models features
+
+Add additional types of specs:
+
+    rails generate spec_harness --include_types=events
+
+Exclude certain types of specs:
+
+    rails generate spec_harness --exclude_types=decorators
+
+Later you can use the `harness_spec_helper` to add additional types:
+
+    rails generate harness_spec_helper events
+
+## Writing Specs
+
+Instead of `require spec_helper` at the top of your spec file, use the specific helper like `require models_spec_helper`.
+
+These helpers are designed to isolate code and bootstrap a minimum amount of items. As such follow SOLID coding practices.
+You may find in some cases you'll need to require a specific file/library in your spec if you are using something special.
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/rails_spec_harness/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/generators/harness_gems/USAGE

@@ -0,0 +1,29 @@
+Description:
+    Add useful gems to your rails project
+
+Example:
+    rails generate harness_gems
+
+    This will add the following gems to your Gemfile under development/test:
+        rspec-rails
+        shoulda
+        capybara
+        poltergeist
+        factory_girl_rails
+        database_cleaner
+        simplecov
+        simplecov-html
+        guard
+        guard-rspec
+        rb-inotify, require: false
+        rb-fsevent, require: false
+        rb-fchange, require: false
+        better_errors
+        binding_of_caller
+        meta_request
+
+    This will add the following gems ungrouped:
+        draper
+        fob
+        resonsive_service
+

data/lib/generators/harness_gems/harness_gems_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators/base'
+
+class HarnessGemsGenerator < Rails::Generators::Base
+  def update_gemfile
+    gem 'draper'
+    gem 'fob'
+    gem 'responsive_service'
+    gem_group :development, :test do
+      gem 'rspec-rails'
+      gem 'shoulda'
+      gem 'capybara'
+      gem 'poltergeist'
+      gem 'factory_girl_rails'
+      gem 'database_cleaner'
+      gem 'simplecov'
+      gem 'simplecov-html'
+      gem 'guard'
+      gem 'guard-rspec'
+      gem 'rb-inotify', require: false
+      gem 'rb-fsevent', require: false
+      gem 'rb-fchange', require: false
+      gem 'better_errors'
+      gem 'binding_of_caller'
+      gem 'meta_request'
+    end
+  end
+end

data/lib/generators/harness_guardfile/USAGE

@@ -0,0 +1,8 @@
+Description:
+  Generates a Guardfile set to only watch specific spec types
+
+Example:
+    rails generate harness_guardfile
+
+    This will create:
+        Guardfile

data/lib/generators/harness_guardfile/harness_guardfile_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators/base'
+
+class HarnessGuardfileGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  class_option :watch_types, type: :array, default: [], required: true, desc: "Types of specs to watch"
+
+  def generate_guardfile
+    template 'Guardfile', 'Guardfile'
+  end
+
+  private
+  def spec_paths
+    options.watch_types.map { |t| "spec/#{t}" }
+  end
+
+  def spec_type_matcher
+    options.watch_types.join('|')
+  end
+end

data/lib/generators/harness_guardfile/templates/Guardfile

@@ -0,0 +1,9 @@
+guard :rspec, notification: true, cmd: 'rspec --color --format nested --tty', spec_paths: <%= spec_paths %> do
+  watch(%r{^spec/(<%= spec_type_matcher %>)/.+_spec\.rb$})
+  watch(%r{^spec/(<%= spec_type_matcher %>)_spec_helper\.rb$}) { |m| "spec/#{m[1]}" }
+  watch(%r{^spec/support_(<%= spec_type_matcher %>)/(.+)\.rb$}) { |m| "spec/#{m[1]}" }
+  watch(%r{^app/(<%= spec_type_matcher %>)/(.+)\.rb$}) { |m| "spec/#{m[1]}/#{m[2]}_spec.rb" }
+  
+  watch('/spec/base_spec_helper.rb') { <%= spec_paths %> }
+  watch(%r{^spec/support_common/(.+)\.rb$}) { <%= spec_paths %> }
+end

data/lib/generators/harness_spec_helper/USAGE

@@ -0,0 +1,23 @@
+Description:
+  Generates a base spec_helper.rb for inclusion in the various other versions.
+  If a SPEC_TYPE is specified a specific helper for that type will be generated.
+
+Example:
+  rails generate harness_spec_helper
+
+  This will create:
+    spec/spec_helper.rb
+    spec/support/.keep
+    .rspec
+
+Example:
+  rails generate harness_spec_helper models
+
+  This will create:
+    spec/spec_helper.rb
+    spec/support/.keep
+    .rspec
+    spec/models_spec_helper.rb
+    spec/support_models/.keep
+    spec/models/.keep
+    app/models/.keep

data/lib/generators/harness_spec_helper/harness_spec_helper_generator.rb

@@ -0,0 +1,34 @@
+require 'rails/generators/base'
+
+class HarnessSpecHelperGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  argument :spec_type, type: :string, default: 'base'
+
+  def generate_spec_helper
+    copy_file 'base_spec_helper.rb', 'spec/base_spec_helper.rb'
+    copy_file 'dotrspec', '.rspec'
+    create_file 'spec/support_common/.keep'
+  end
+
+  def generate_spec_helpers
+    return if spec_type == 'base'
+    template template_file, "spec/#{spec_type.underscore.pluralize}_spec_helper.rb"
+    create_file "spec/support_#{spec_type.underscore.pluralize}/.keep"
+    create_file "spec/#{spec_type.underscore.pluralize}/.keep"
+    create_file "app/#{spec_type.underscore.pluralize}/.keep" unless spec_type.underscore.pluralize == 'features'
+  end
+
+  private
+  def template_map
+    {
+      'decorators' => 'decorators_spec_helper.rb',
+      'features' => 'features_spec_helper.rb',
+      'forms' => 'forms_spec_helper.rb',
+      'modles' => 'models_spec_helper.rb'
+    }
+  end
+
+  def template_file
+    template_map.fetch(spec_type.underscore.pluralize) { 'light_spec_helper.rb' }
+  end
+end

data/lib/generators/harness_spec_helper/templates/base_spec_helper.rb

@@ -0,0 +1,24 @@
+ENV["RAILS_ENV"] ||= 'test'
+require 'rubygems'
+
+if ENV["COVERAGE"]
+  require 'simplecov'
+  require 'simplecov-rcov'
+  SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+  SimpleCov.start 'rails'
+end
+
+RAILS_ROOT = File.expand_path('../..', __FILE__)
+require 'rspec/autorun'
+
+Dir[File.join(RAILS_ROOT, 'spec/support/**/*.rb')].each {|f| require f}
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end
+
+require 'active_support'
+require 'active_support/dependencies'

data/lib/generators/harness_spec_helper/templates/decorators_spec_helper.rb

@@ -0,0 +1,6 @@
+require 'base_spec_helper'
+require 'responsive_service'
+require 'draper'
+Draper::ViewContext.test_strategy :fast
+Dir[File.join(RAILS_ROOT, "spec/support_decorators/**/*.rb")].each {|f| require f}
+ActiveSupport::Dependencies.autoload_paths << "#{RAILS_ROOT}/app/decorators"

data/lib/generators/harness_spec_helper/templates/dotrspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/lib/generators/harness_spec_helper/templates/features_spec_helper.rb

@@ -0,0 +1,34 @@
+require 'base_spec_helper'
+require File.expand_path('../../config/environment', __FILE__)
+require 'rspec/rails'
+require 'capybara/rspec'
+require 'capybara/poltergeist'
+require 'factory_girl'
+require 'database_cleaner'
+Dir[Rails.root.join('spec/support_features/**/*.rb')].each {|f| require f}
+
+ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)
+
+DatabaseCleaner.strategy = :truncation
+
+Capybara.javascript_driver = :poltergeist
+Capybara.default_wait_time = 5
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = false
+  config.infer_base_class_for_anonymous_controllers = false
+
+  config.include FactoryGirl::Syntax::Methods
+
+  config.before(:suite) do
+    DatabaseCleaner.clean
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/lib/generators/harness_spec_helper/templates/forms_spec_helper.rb

@@ -0,0 +1,5 @@
+require 'base_spec_helper'
+require 'responsive_service'
+require 'fob'
+Dir[File.join(RAILS_ROOT, "spec/support_forms/**/*.rb")].each {|f| require f}
+ActiveSupport::Dependencies.autoload_paths << "#{RAILS_ROOT}/app/forms"

data/lib/generators/harness_spec_helper/templates/light_spec_helper.rb

@@ -0,0 +1,4 @@
+require 'base_spec_helper'
+require 'responsive_service'
+Dir[File.join(RAILS_ROOT, "spec/support_<%= spec_type.underscore.pluralize %>/**/*.rb")].each {|f| require f}
+ActiveSupport::Dependencies.autoload_paths << "#{RAILS_ROOT}/app/<%= spec_type.underscore.pluralize %>"

data/lib/generators/harness_spec_helper/templates/models_spec_helper.rb

@@ -0,0 +1,11 @@
+require 'base_spec_helper'
+require 'active_record'
+require 'rspec/rails/extensions/active_record/base'
+require 'shoulda'
+Dir[File.join(RAILS_ROOT, "spec/support_models/**/*.rb")].each {|f| require f}
+
+ActiveRecord::Base.establish_connection(
+  YAML.load(File.read(RAILS_ROOT + '/config/database.yml'))['test']
+)
+
+ActiveSupport::Dependencies.autoload_paths << "#{RAILS_ROOT}/app/models"

data/lib/generators/spec_harness/USAGE

@@ -0,0 +1,57 @@
+Description:
+  Set up your rails project for fast efficient testing.
+
+Example:
+  rails generate spec_harness
+
+  This will create:
+    spec/spec_helper.rb
+    spec/support/.keep
+    .rspec
+    spec/actions_spec_helper.rb
+    spec/support_actions/.keep
+    spec/actions/.keep
+    app/actions/.keep
+    spec/decorators_spec_helper.rb
+    spec/support_decorators/.keep
+    spec/decorators/.keep
+    app/decorators/.keep
+    spec/features_spec_helper.rb
+    spec/support_features/.keep
+    spec/features/.keep
+    app/features/.keep
+    spec/forms_spec_helper.rb
+    spec/support_forms/.keep
+    spec/forms/.keep
+    app/forms/.keep
+    spec/models_spec_helper.rb
+    spec/support_models/.keep
+    spec/models/.keep
+    app/models/.keep
+    spec/services_spec_helper.rb
+    spec/support_services/.keep
+    spec/services/.keep
+    app/services/.keep
+
+  This will add the following gems to your Gemfile under development/test:
+    rspec-rails
+    shoulda
+    capybara
+    poltergeist
+    factory_girl_rails
+    database_cleaner
+    simplecov
+    simplecov-html
+    guard
+    guard-rspec
+    rb-inotify, require: false
+    rb-fsevent, require: false
+    rb-fchange, require: false
+    better_errors
+    binding_of_caller
+    meta_request
+
+  This will add the following gems ungrouped:
+    draper
+    fob
+    resonsive_service

data/lib/generators/spec_harness/spec_harness_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators/base'
+
+class SpecHarnessGenerator < Rails::Generators::Base
+  class_option :gems, type: :boolean, default: true, desc: "Add gems to Gemfile"
+  class_option :guardfile, type: :boolean, default: true, desc: "Create a Guardfile"
+  class_option :only_types, type: :array, default: [], desc: "The only types which should be set up"
+  class_option :include_types, type: :array, default: [], desc: "Additional types of specs to include"
+  class_option :exclude_types, type: :array, default: [], desc: "Types of specs to exclude"
+
+  def generate_harness
+    generate 'harness_spec_helper'
+    required_spec_types.each do |type|
+      generate "harness_spec_helper #{type}"
+    end
+    generate "harness_guardfile --watch_types=#{watch_types}" if options.guardfile?
+    generate 'harness_gems' if options.gems?
+  end
+
+  private
+  def spec_types
+    [
+      'actions',
+      'decorators',
+      'features',
+      'forms',
+      'models',
+      'services'
+    ]
+  end
+
+  def required_spec_types
+    return (options.only_types.map {|t| t.underscore.pluralize}) if options.only_types.any?
+    spec_types - (options.exclude_types.map {|t| t.underscore.pluralize}) + (options.include_types.map {|t| t.underscore.pluralize})
+  end
+
+  def watch_types
+    required_spec_types.reject {|t| t == 'features'}.join(' ')
+  end
+end

data/lib/rails_spec_harness.rb

@@ -0,0 +1,8 @@
+require 'rails_spec_harness/version'
+require 'generators/harness_gems/harness_gems_generator'
+require 'generators/harness_guardfile/harness_guardfile_generator'
+require 'generators/harness_spec_helper/harness_spec_helper_generator'
+require 'generators/spec_harness/spec_harness_generator'
+
+module RailsSpecHarness
+end

data/lib/rails_spec_harness/version.rb

@@ -0,0 +1,3 @@
+module RailsSpecHarness
+  VERSION = "0.0.1"
+end

data/rails_spec_harness.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_spec_harness/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails_spec_harness'
+  spec.version       = RailsSpecHarness::VERSION
+  spec.authors       = ['alexpeachey']
+  spec.email         = ['alex.peachey@gmail.com']
+  spec.summary       = 'Helpful generators for fast rails specs.'
+  spec.description   = 'Make your specs sane with a set of helpers to isolate code and improve speed.'
+  spec.homepage      = 'https://github.com/alexpeachey/rails_spec_harness'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails', '>= 3.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+end

data/spec/rails_spec_harness_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe RailsSpecHarness do
+  it 'should have a version number' do
+    RailsSpecHarness::VERSION.should_not be_nil
+  end
+
+  it 'should do something useful' do
+    false.should be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rails_spec_harness'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: rails_spec_harness
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- alexpeachey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Make your specs sane with a set of helpers to isolate code and improve
+  speed.
+email:
+- alex.peachey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/harness_gems/USAGE
+- lib/generators/harness_gems/harness_gems_generator.rb
+- lib/generators/harness_guardfile/USAGE
+- lib/generators/harness_guardfile/harness_guardfile_generator.rb
+- lib/generators/harness_guardfile/templates/Guardfile
+- lib/generators/harness_spec_helper/USAGE
+- lib/generators/harness_spec_helper/harness_spec_helper_generator.rb
+- lib/generators/harness_spec_helper/templates/base_spec_helper.rb
+- lib/generators/harness_spec_helper/templates/decorators_spec_helper.rb
+- lib/generators/harness_spec_helper/templates/dotrspec
+- lib/generators/harness_spec_helper/templates/features_spec_helper.rb
+- lib/generators/harness_spec_helper/templates/forms_spec_helper.rb
+- lib/generators/harness_spec_helper/templates/light_spec_helper.rb
+- lib/generators/harness_spec_helper/templates/models_spec_helper.rb
+- lib/generators/spec_harness/USAGE
+- lib/generators/spec_harness/spec_harness_generator.rb
+- lib/rails_spec_harness.rb
+- lib/rails_spec_harness/version.rb
+- rails_spec_harness.gemspec
+- spec/rails_spec_harness_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alexpeachey/rails_spec_harness
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Helpful generators for fast rails specs.
+test_files:
+- spec/rails_spec_harness_spec.rb
+- spec/spec_helper.rb