spec_snap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f82e9ec502dea9d9a988afb8f527889aaaea7dc
+  data.tar.gz: ac6063431babac47ba0bbf1e9857da097301cb1c
+SHA512:
+  metadata.gz: 624ac8fe4698b0b91f105823bd10fcb3cfaff19cc22258930cdb2a83146e9f40f5127df10d57974c3ee4ff0e1fc0b1b0b76f3d7fbb1ba44f8230ed53a83b15de
+  data.tar.gz: 2eb3ab2be6f83aa5f0239d6975dd739b157142ac3c53a139847f719ca24c600010968584e0e4d9f2aa2d346975d4ebf2cf24b1d4a27b5591d6c3a028bf0d99e0

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at adam.whittingham@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Adam Whittingham
+
+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,51 @@
+# SpecSnap
+
+Handy starter config for RSpec helpers.
+
+Many of us end up with a toolset we like to use during our builds and end up with a huge `spec_helper.rb` file that gets copied from project to project.
+To make this a little more controlled and quicker to get started with, we at [Developer Mountain](http://devmountain.co.uk) are collecting our most frequently used configurations into this gem to share them and see if they are useful to other people.
+
+This gem provides a number of files which can be required in your `spec_helper.rb` or `rails_helper.rb` files to quickly get a reasonable config for integrating a tool or helper in rspec.
+A good example is `database_cleaner`, a popular way of rolling back changes to your DB during tests. A common configuration is provided, so you can simply add `require 'spec_snap/database_cleaner'` to your spec_helper and be on your way.
+
+If you find SpecSnap useful, you might also enjoy [Rake-n-Bake](https://rubygems.org/gems/rake-n-bake), where we make our rake build configs modular and reusable in a similar way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spec_snap'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spec_snap
+
+
+## Usage
+
+1. Look in `lib/spec_snap` for any tools you want to drop in to your project quickly.
+2. Install this gem and any gems required for the tool (ie. add the [Database Cleaner]() gem to your Gemfile)
+2. In your `spec_helper.rb` or `rails_helper.rb`, require the config file. For example: `require 'spec_snap/database_cleaner'`
+3. Enjoy having your tooling setup that little bit quicker and more consistently.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dvmtn/spec_snap. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "spec_snap"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/spec_snap/capybara.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rack_session_access/capybara'
+require 'capybara/poltergeist'
+
+Capybara.server_port = 3443
+Capybara.app_host = 'https://localhost:3443'
+Capybara.exact = true
+
+Capybara.register_driver :poltergeist do |app|
+  Capybara::Poltergeist::Driver.new(app, phantomjs_options: ['--local-to-remote-url-access=yes'])
+end
+
+Capybara.register_driver :rack_test do |app|
+  Capybara::RackTest::Driver.new(app, headers: { 'HTTP_USER_AGENT' => 'Capybara' })
+end
+
+Capybara.default_driver    = :rack_test
+Capybara.javascript_driver = :poltergeist
+
+module CapybaraHelper
+  # By default, capybara will ignore all hidden fields. This lets us disable that temporarily.
+  #
+  # Example
+  #
+  #   include_hidden_fields do
+  #     attach_file('hidden-input', 'spec/fixtures/files/file.jpg')
+  #   end
+  #
+  def include_hidden_elemements
+    Capybara.ignore_hidden_elements = false
+    yield
+    Capybara.ignore_hidden_elements = true
+  end
+end

data/lib/spec_snap/controller_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ControllerHelper
+
+  def sign_in(user)
+    if user.nil?
+      not_signed_in
+    else
+      allow(request.env['warden']).to receive(:authenticate!).and_return(user)
+      allow(controller).to receive(:current_user).and_return(user)
+    end
+  end
+
+  def not_signed_in
+    allow(request.env['warden']).to receive(:authenticate!).and_throw(:warden, {:scope => :user})
+    allow(controller).to receive(:current_user).and_return(nil)
+  end
+
+  RSpec.configure do |config|
+    config.include self, type: :controller
+  end
+
+end

data/lib/spec_snap/database_cleaner.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, js: true) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/lib/spec_snap/devise_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.include Devise::Test::ControllerHelpers, type: :controller
+end

data/lib/spec_snap/factory_girl.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'factory_girl_rails'
+
+module FactoryGirl
+  module Syntax
+    module Methods
+      alias create_large_list create_list
+
+      def create_list(name, amount, *traits_and_overrides, &block)
+        unless small_amount_or_special_build?(amount)
+          raise ArgumentError, "You asked to create #{amount} records. For the sake of test speed (and sanity), don't do this."
+        end
+
+        create_large_list(name, amount, *traits_and_overrides, &block)
+      end
+
+      private def small_amount_or_special_build? amount
+        amount < 3 || ENV['NIGHTLY'] || ENV['CI']
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/lib/spec_snap/feature_login_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module FeatureLoginHelper
+
+  class Login
+    include Warden::Test::Helpers
+  end
+
+  def logged_in_as(user)
+    Login.new.login_as user, scope: :user, run_callbacks: false
+  end
+
+end

data/lib/spec_snap/kanimari_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.around(:example, :pagination_set_to_one) do |test|
+    original_per_page = Kaminari.config.default_per_page
+    Kaminari.config.default_per_page = 1
+    test.run
+    Kaminari.config.default_per_page = original_per_page
+  end
+end

data/lib/spec_snap/policy_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'tableware'
+require 'pundit'
+
+def test_policy_table permission_matrix, klass = nil, policy_object_defined: false
+  Tableware.hashes(permission_matrix).each do |perms|
+    action = "#{perms[:action]}?".to_sym
+    roles = User::ROLES.map(&:to_sym)
+
+    permissions action do
+      roles.each do |role|
+        allowed = perms[role] == 'yes'
+        user = User.new(role: role)
+
+        unless policy_object_defined
+          let(:policy_object) { klass.nil? ? nil : klass.new }
+        end
+
+        it "#{allowed ? 'allows' : 'denies'} access to #{role} users" do
+          if allowed
+            expect(described_class).to permit(user, policy_object)
+          else
+            expect(described_class).to_not permit(user, policy_object)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spec_snap/required_seeds.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RequiredSeeds
+  def self.populate(seeds)
+    Array(seeds).each { |seed| load Rails.root.join('db', 'seeds', "#{seed}.rb") }
+  end
+end

data/lib/spec_snap/rspec_output.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'fuubar'
+
+RSpec.configure do |config|
+  config.default_formatter = 'Fuubar'
+  config.default_formatter = 'doc' if config.files_to_run.one?
+  config.default_formatter = 'RspecJunitFormatter' if ENV['CI']
+  config.example_status_persistence_file_path = 'log/rspec-run.log'
+
+  config.fuubar_progress_bar_options = {
+    format:        ' %c/%C |%w%i| %e ',
+    progress_mark: '█',
+  }
+end

data/lib/spec_snap/simplecov.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+
+if ENV['CIRCLE_ARTIFACTS']
+  dir = File.join(ENV['CIRCLE_ARTIFACTS'], 'coverage')
+  SimpleCov.coverage_dir(dir)
+else
+  SimpleCov.coverage_dir 'log/coverage/spec'
+end
+
+SimpleCov.minimum_coverage ENV['COVERAGE_PERCENT']
+SimpleCov.refuse_coverage_drop
+
+unless ENV['NO_COVERAGE']
+  SimpleCov.start 'rails' do
+    add_group 'Collaborators',     'app/collaborators'
+    add_group 'Creators',          'app/creators'
+    add_group 'Policies',          'app/policies'
+    add_group 'Presenters',        'app/presenters'
+    add_group 'Queriers',          'app/queriers'
+    add_group 'Report Generators', 'app/report_generators'
+    add_group 'Services',          'app/services'
+    add_group 'Workers',           'app/workers'
+
+    add_filter 'vendor/'
+  end
+end

data/lib/spec_snap/test_prof.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'test-prof'
+
+TestProf.configure do |config|
+  config.output_dir = 'tmp/test_prof'
+  config.timestamps = true
+  config.color = true
+end

data/lib/spec_snap/vcr.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'webmock/rspec'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.ignore_localhost = true
+end

data/lib/spec_snap/version.rb

@@ -0,0 +1,3 @@
+module SpecSnap
+  VERSION = "0.1.0"
+end

data/lib/spec_snap.rb

@@ -0,0 +1,5 @@
+require "spec_snap/version"
+
+module SpecSnap
+  # Your code goes here...
+end

data/spec_snap.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spec_snap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spec_snap"
+  spec.version       = SpecSnap::VERSION
+  spec.authors       = ["Adam Whittingham"]
+  spec.email         = ["adam@devmountain.co.uk", "adam.whittingham@gmail.com"]
+
+  spec.summary       = %q{RSpec helpers ready configured to make life easier.}
+  spec.homepage      = "https://github.com/dvmtn/spec_snap"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: spec_snap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Whittingham
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- adam@devmountain.co.uk
+- adam.whittingham@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/spec_snap.rb
+- lib/spec_snap/capybara.rb
+- lib/spec_snap/controller_helper.rb
+- lib/spec_snap/database_cleaner.rb
+- lib/spec_snap/devise_controller.rb
+- lib/spec_snap/factory_girl.rb
+- lib/spec_snap/feature_login_helper.rb
+- lib/spec_snap/kanimari_helper.rb
+- lib/spec_snap/policy_helper.rb
+- lib/spec_snap/required_seeds.rb
+- lib/spec_snap/rspec_output.rb
+- lib/spec_snap/simplecov.rb
+- lib/spec_snap/test_prof.rb
+- lib/spec_snap/vcr.rb
+- lib/spec_snap/version.rb
+- spec_snap.gemspec
+homepage: https://github.com/dvmtn/spec_snap
+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.5.1
+signing_key: 
+specification_version: 4
+summary: RSpec helpers ready configured to make life easier.
+test_files: []