pain_in_the_rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9a6e289ebf6e3d97d06fde8174e8c607a5ba012
+  data.tar.gz: 91ea52a8ca4110f616539662b41597e0624806da
+SHA512:
+  metadata.gz: 4db58b0931069093bffc97caba9df2c8e82a5d0b8c2bce6202c30b7a767f772f45af572bb1d73f818431a02a3c094793c54d29e4a0df890f8acbecf022e18906
+  data.tar.gz: ebdb717d9a76e357498e6c9086196ecc8fd678c1f98759eeef1c74be136ff94e24d699c745354e424c7d9fa6fa04692252a77af926fe1e4b9b31f01543f1a165

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.1
+before_install:
+  - gem install bundler -v "~> 1.9"
+sudo: false
+notifications:
+  email: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Gabe Berke-Williams
+
+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,64 @@
+# A Real Pain in the RSpec
+
+Run your RSpec tests and print out punny spec descriptions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "pain_in_the_rspec"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pain_in_the_rspec
+
+## Usage
+
+Run your specs like this:
+
+    $ rspec --format PainInTheRspec::Formatter spec/
+
+To always run your specs with PainInTheRspec, add the following line to your
+`.rspec` file:
+
+    --format PainInTheRspec::Formatter
+
+## Pitfalls
+
+The formatter uses a web API to get rhymes. It will therefore make a web request
+for each example in your suite.
+
+If you're using WebMock, you'll need to allow external network requests:
+
+```ruby
+# Allow all network requests:
+WebMock.allow_net_connect!
+# Or, to only allow the website that this gem uses:
+WebMock.disable_net_connect!(allow: "rhymebrain.com")
+# Or, if you're already allowing example.com:
+WebMock.disable_net_connect!(allow: ["example.com", "rhymebrain.com"])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits
+and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pain_in_the_rspec/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+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 "pain_in_the_rspec"
+
+# 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

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/lib/pain_in_the_rspec.rb

@@ -0,0 +1,3 @@
+require "pain_in_the_rspec/version"
+require "pain_in_the_rspec/pundit"
+require "pain_in_the_rspec/formatter"

data/lib/pain_in_the_rspec/formatter.rb

@@ -0,0 +1,51 @@
+require "rspec/core"
+require "pain_in_the_rspec"
+
+module PainInTheRspec
+  class Formatter < RSpec::Core::Formatters::DocumentationFormatter
+    RSpec::Core::Formatters.register self, :example_passed, :example_pending,
+      :example_failed
+
+    def example_failed(failure)
+      output.puts failure_output(
+        failure.example,
+        failure.example.execution_result.exception
+      )
+    end
+
+    def example_passed(passed)
+      output.puts passed_output(passed.example)
+    end
+
+    private
+
+    def passed_output(example)
+      wrap(pun_description(example), :success)
+    end
+
+    def pending_output(example, message)
+      wrap(
+        "#{pun_description(example)} (PENDING: #{message})",
+        :pending
+      )
+    end
+
+    def failure_output(example, _exception)
+      message = pun_description(example)
+
+      wrap(
+        "#{message} (FAILED - #{next_failure_index})",
+        :failure
+      )
+    end
+
+    def pun_description(example)
+      current_indentation +
+        Pundit.new(example.description.strip).pun
+    end
+
+    def wrap(message, status)
+      RSpec::Core::Formatters::ConsoleCodes.wrap(message, status)
+    end
+  end
+end

data/lib/pain_in_the_rspec/pundit.rb

@@ -0,0 +1,57 @@
+require "girls_just_want_to_have_puns"
+
+module PainInTheRspec
+  class Pundit
+    BANNED_WORDS = %w(should can and)
+
+    def initialize(original)
+      @original = original
+    end
+
+    def pun
+      if found_pun?
+        [found_pun.new_phrase, rest_of_phrase].join(" ").strip
+      else
+        "[pun of #{original}]"
+      end
+    end
+
+    private
+
+    attr_reader :original
+
+    def found_pun?
+      !found_pun.nil?
+    end
+
+    def found_pun
+      @found_pun ||= GirlsJustWantToHavePuns.pun(pun_word) ||
+        GirlsJustWantToHavePuns.pun(singular_pun_word) ||
+        GirlsJustWantToHavePuns.pun(other_singular_pun_word)
+    end
+
+    def pun_word
+      filtered.first
+    end
+
+    def singular_pun_word
+      pun_word.sub(/s$/, "")
+    end
+
+    def other_singular_pun_word
+      pun_word.sub(/es$/, "")
+    end
+
+    def filtered
+      original.split(" ") - BANNED_WORDS
+    end
+
+    def rest_of_phrase
+      if filtered.size > 0
+        filtered[1..-1].join(" ")
+      else
+        ""
+      end
+    end
+  end
+end

data/lib/pain_in_the_rspec/version.rb

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

data/pain_in_the_rspec.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pain_in_the_rspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pain_in_the_rspec"
+  spec.version       = PainInTheRspec::VERSION
+  spec.authors       = ["Gabe Berke-Williams"]
+  spec.email         = ["gabebw@gabebw.com"]
+
+  spec.summary       = %q{Print out punny spec descriptions}
+  spec.homepage      = "https://github.com/gabebw/pain_in_the_rspec"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec-core", "~> 3.0"
+  spec.add_dependency "girls_just_want_to_have_puns"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: pain_in_the_rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gabe Berke-Williams
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  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: girls_just_want_to_have_puns
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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:
+- gabebw@gabebw.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/pain_in_the_rspec.rb
+- lib/pain_in_the_rspec/formatter.rb
+- lib/pain_in_the_rspec/pundit.rb
+- lib/pain_in_the_rspec/version.rb
+- pain_in_the_rspec.gemspec
+homepage: https://github.com/gabebw/pain_in_the_rspec
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Print out punny spec descriptions
+test_files: []