rspec-ensure-unfiltered 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57f652d5c72e52b106ca325b3682357592b00a34
+  data.tar.gz: 1f2b12ae88789e0bbafe3f834682e9da22d6fb3e
+SHA512:
+  metadata.gz: f0980a64fc93768403406b029124cb68eec05b83d30ae871221078c4e245a5fb8982878a4b70962d4d3818db41c0a662e6d245dbd87636276853a0ba44b3c2c8
+  data.tar.gz: f13de0e2f2ecbd6048860b1576e36775c6649d0f641c46466e76420fdf4e31a02e6380ab00a460e22d4fa5027b9d871e1e5b99356a7131f13d515d157de87377

data/.gitignore

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

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 rob@robhoward.id.au. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rspec-ensure-unfiltered.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2018 Rob Howard
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,72 @@
+# rspec-ensure-unfiltered
+
+A plugin for ensuring your RSpec tests don't run with a filter (eg. `focus: true`). Useful for CI runs.
+
+
+## Installation
+
+Add this line to your application's Gemfile, in the `test` group:
+
+```ruby
+gem 'rspec-ensure-unfiltered', group: :test
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+
+## Usage
+
+In your `spec_helper.rb` (eg. `spec/spec_helper.rb`) or other RSpec config file, inside your `RSpec.configure` block:
+
+```ruby
+require 'rspec/ensure/unfiltered'
+RSpec.configure do |config|
+	RSpec::Ensure::Unfiltered.setup!(config)
+end
+```
+
+To have this trigger on CI runs only (recommended), I'd recommend guarding it with a condition that checks the environment. This example should work for [Buildkite](https://buildkite.com), [Travis CI](https://travis-ci.org/) and [CircleCI](https://circleci.com/):
+
+```ruby
+require 'rspec/ensure/unfiltered'
+RSpec.configure do |config|
+	# Block the build if any example filtering is active,
+	# eg. if we left a "focus: true" in a spec somewhere.
+	if ENV['CI']
+		RSpec::Ensure::Unfiltered.setup!(config)
+	end
+end
+```
+
+When triggered, the build will abort and you'll get something like this dumped into your console:
+
+```
+************************************************************************
+Examples have been filtered; you're only running 1 out of 3845 examples.
+
+You may have left a filter (eg. 'focus: true') in one of your *_spec.rb
+files; is it one of these?
+- ./spec/sandbox_spec.rb
+************************************************************************
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/damncabbage/rspec-ensure-unfiltered. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the (https://github.com/damncabbage/rspec-ensure-unfiltered)[code of conduct].
+
+
+## License
+
+The gem is available as open source under the terms of the [Apache-2.0 License](https://opensource.org/licenses/Apache-2.0).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/ensure/unfiltered"
+
+# 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/rspec-ensure-unfiltered.rb

@@ -0,0 +1 @@
+require "rspec/ensure/unfiltered"

data/lib/rspec/ensure/unfiltered.rb

@@ -0,0 +1,30 @@
+require "rspec/ensure/unfiltered/version"
+require "rspec"
+
+module RSpec
+  module Ensure
+    module Unfiltered
+      def self.setup!(config, world: nil)
+        world ||= RSpec.world
+        config.before(:suite) do
+          # Yell if we're filtering, eg. we filter on 'focus: true' somewhere by accident.
+          run_examples = world.example_count
+          all_examples = world.all_examples.count
+          if run_examples != all_examples
+            paths = world.filtered_examples.flat_map(&:second).map(&:file_path).uniq.sort
+            msg = [
+              "Examples have been filtered; you're only running #{run_examples} out of #{all_examples} examples.",
+              "",
+              "You may have left a filter (eg. 'focus: true') in one of your *_spec.rb",
+              "files; is it one of these?"
+            ].concat(
+              paths.map { |p| "- #{p}" }
+            )
+            border = "*" * msg.sort_by(&:length).last.length
+            raise "\n\n#{border}\n#{msg.join("\n")}\n#{border}\n\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/ensure/unfiltered/version.rb

@@ -0,0 +1,7 @@
+module RSpec
+  module Ensure
+    module Unfiltered
+      VERSION = "1.0.0"
+    end
+  end
+end

data/rspec-ensure-unfiltered.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rspec/ensure/unfiltered/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-ensure-unfiltered"
+  spec.version       = RSpec::Ensure::Unfiltered::VERSION
+  spec.authors       = ["Rob Howard"]
+  spec.email         = ["rob@robhoward.id.au"]
+
+  spec.summary       = %q{A plugin for ensuring your RSpec tests don't run with a filter (eg. `focus: true`); useful for CI runs.}
+  spec.homepage      = "https://github.com/damncabbage/rspec-ensure-unfiltered"
+  spec.license       = "Apache-2.0"
+
+  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_dependency "rspec", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rspec-ensure-unfiltered
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rob Howard
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: 
+email:
+- rob@robhoward.id.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec-ensure-unfiltered.rb
+- lib/rspec/ensure/unfiltered.rb
+- lib/rspec/ensure/unfiltered/version.rb
+- rspec-ensure-unfiltered.gemspec
+homepage: https://github.com/damncabbage/rspec-ensure-unfiltered
+licenses:
+- Apache-2.0
+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.2.3
+signing_key: 
+specification_version: 4
+summary: 'A plugin for ensuring your RSpec tests don''t run with a filter (eg. `focus:
+  true`); useful for CI runs.'
+test_files: []