dryspec 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86d5786cc24a5f8ff16e60a244b370d657356106
+  data.tar.gz: fcb9867e8779b528ad8452f48a1da114381956cb
+SHA512:
+  metadata.gz: d73cd73b915be44f1f42f64f735cf6668b66fa836b2142dfd76637849756c6d4ef4bc8d7b77351215c41796b5b07fd9b5ecf907cfc8a24065dadee2cb7ac3486
+  data.tar.gz: df876741d6edd5cea736e2598b6c922c6f40ae324d1bd5c63f29a0a21ffb75d25f7542350056e43093a6576362370eb2e77af62515c6abc240d5e6103ab43af9

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,52 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 112
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - Guardfile
+    - 'spec/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/**/*'
+
+# Brian has very strong opinions on this one.  See:
+#   https://github.com/bbatsov/ruby-style-guide/issues/329
+#   https://github.com/bbatsov/ruby-style-guide/pull/325
+Style/NegatedIf:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Performance/Casecmp:
+  Enabled: false
+
+# Special characters in comments is a fundamental human right
+Style/AsciiComments:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+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 brian.underwood@teamnorthwoods.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dryspec.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,66 @@
+guard :rubocop, cli: '--auto-correct --display-cop-names --except Lint/Debugger' do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+
+  callback(:start_begin) { puts '👮 🚨 👮 🚨 👮 🚨 👮 🚨 👮' }
+end
+
+guard 'yard' do
+  watch(%r{app\/.+\.rb})
+  watch(%r{lib\/.+\.rb})
+  watch(%r{ext\/.+\.c})
+end
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w[erb haml slim])
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Brian Underwood
+
+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,95 @@
+# DRYSpec
+
+DRYSpec introduces the `let_context`, `subject_should_raise`, and `subject_should_not_raise` helpers into RSpec which can allow you to have shorter, easier to read spec files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dryspec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dryspec
+
+Then add `config.extend DRYSpec::Helpers` to your RSpec configuration like so:
+
+    RSpec.configure do |config|
+      # ... configuration ...
+
+      config.extend DRYSpec::Helpers
+
+      # ... configuration ...
+
+## Usage
+
+### `let_context`
+
+The `let_context` helper allows you to easily create a `context` block with one or more `let` variables like so:
+
+    # Before
+    context 'The foo is 1' do
+      let(:foo) { 1 }
+    end
+
+    # After
+    let_context foo: 1 do
+    end
+
+In some cases, this case even allow you to have one line per example.  For example, let's say you were testing an `#add_two` method.  You could do:
+
+    subject { add_two(value) }
+
+    let_context(value: 10) { it { should eq 12 } }
+    let_context(value: 1) { it { should eq 3 } }
+    let_context(value: 0) { it { should eq 2 } }
+
+By default when you give `let_context` a `Hash`, the `#inspect` of the `Hash` becomes the description for your example which you see in your test output.  If you'd like something more specific you can add a string like so:
+
+    let_context('Negative number', value: -1) { it { should eq 1 } }
+    let_context('Big negative number', value: -10) { it { should eq -8 } }
+
+### `subject_should_(not_)raise`
+
+The `subject_should_raise` and `subject_should_not_raise` are simply helpers which allow you to create an RSpec example which asserts if the subject of your tests will raise an exception.  For example:
+
+    # Before
+    subject { fail 'Test' }
+    it "should raise 'Test'" do
+      expect { subject }.to raise_error 'Test'
+    end
+
+    # After
+    subject { fail 'Test' }
+    subject_should_raise 'Test'
+
+There is also a `subject_should_not_raise`:
+
+    subject { 1 }
+    subject_should_not_raise
+
+## Documentation
+
+See [the documentation](TODO) for more details
+
+## 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/northwoodspd/dryspec. 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 'dryspec'
+
+# 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/dryspec.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dryspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dryspec'
+  spec.version       = DRYSpec::VERSION
+  spec.authors       = ['Team Northwoods']
+  spec.email         = ['brian.underwood@teamnorthwoods.com']
+
+  spec.summary       = 'A Ruby gem to introduce RSpec helpers which can help you DRY up your specs'
+  spec.description   = 'A Ruby gem to introduce RSpec helpers which can help you DRY up your specs'
+  spec.homepage      = 'https://github.com/northwoodspd/dryspec'
+  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'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.2.0'
+  spec.add_development_dependency 'yard', '~> 0.9.9'
+  spec.add_development_dependency 'guard-yard', '~> 2.2.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7.3'
+end

data/lib/dryspec.rb

@@ -0,0 +1,5 @@
+require 'dryspec/version'
+
+module DRYSpec
+  autoload :Helpers, 'dryspec/helpers'
+end

data/lib/dryspec/helpers.rb

@@ -0,0 +1,104 @@
+module DRYSpec
+  module Helpers
+    # This allows us to simplify the case where we want to
+    # have a context which contains one or more `let` statements
+    #
+    # Supports giving either a Hash or a String and a Hash as arguments
+    # In both cases the Hash will be used to define `let` statements
+    # When a String is specified that becomes the context description
+    # If String isn't specified, Hash#inspect becomes the context description
+    #
+    # @example Defining a simple let variable
+    #   # Before
+    #   subject { a + 1 }
+    #   context('a is 1') do
+    #     let(:a) { 1 }
+    #     it { should eq 2 }
+    #   end
+    #
+    #   # After
+    #   subject { a + 1 }
+    #   let_context(a: 1) { it { should eq 2 } }
+    #
+    # @example Giving a descriptive string
+    #   subject { a + 1 }
+    #   let_context('Negative number', a: -1) { it { should eq 0 } }
+    #
+    # @example Multiple variables
+    #   subject { a + b }
+    #   let_context(a: 1, b: 2) { it { should eq 3 } }
+    def let_context(*args, &block)
+      context_string, hash =
+        case args.map(&:class)
+        when [String, Hash] then ["#{args[0]} #{args[1]}", args[1]]
+        when [Hash] then [args[0].inspect, args[0]]
+        end
+
+      context(context_string) do
+        hash.each { |var, value| let(var) { value } }
+
+        instance_eval(&block)
+      end
+    end
+
+    # Allows you to simply specify that the subject should raise an exception
+    # Takes no arguments or arguments of an exception class, a string, or both.
+    #
+    # As with RSpec's basic `to raise_error` matcher, if you don't give an error
+    # then the an unexpected error may cause your test to pass incorrectly
+    #
+    # @example Raising a string
+    #   # Before
+    #   subject { fail 'Test' }
+    #   it "should raise 'Test'" do
+    #     expect { subject }.to raise_error 'Test'
+    #   end
+    #
+    #   # After
+    #   subject { fail 'Test' }
+    #   subject_should_raise 'Test'
+    #
+    # @example Raising an exception class
+    #   subject { fail ArgumentError }
+    #   subject_should_raise ArgumentError
+    #
+    # @example Raising an exception class and string
+    #   subject { fail ArgumentError, 'Test' }
+    #   subject_should_raise ArgumentError, 'Test'
+    def subject_should_raise(*args)
+      error, message = args
+      it_string = "subject should raise #{error}"
+      it_string += " (#{message.inspect})" if message
+
+      it it_string do
+        expect { subject }.to raise_error error, message
+      end
+    end
+
+    # Allows you to simply specify that the subject should not raise an exception.
+    # Takes no arguments or arguments of an exception class, a string, or both.
+    #
+    # As with RSpec's basic `not_to raise_error` matcher, if you give a specific error, other
+    # unexpected errors may be swallowed silently
+    #
+    # @example Subject does not raise an error
+    #   # Before
+    #   subject { 1 }
+    #   it 'should not raise an exception' do
+    #     expect { subject }.not_to raise_error
+    #   end
+    #
+    #   # After
+    #   subject { 1 }
+    #   subject_should_not_raise
+    def subject_should_not_raise(*args)
+      error, message = args
+      it_string = "subject should not raise #{error}"
+      it_string += " (#{message.inspect})" if message
+
+      it it_string do
+        expect { subject }.not_to raise_error error, message
+      end
+    end
+  end
+end

data/lib/dryspec/version.rb

@@ -0,0 +1,3 @@
+module DRYSpec
+  VERSION = '0.1.1'.freeze
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: dryspec
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Team Northwoods
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-24 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'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: guard-yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+description: A Ruby gem to introduce RSpec helpers which can help you DRY up your
+  specs
+email:
+- brian.underwood@teamnorthwoods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dryspec.gemspec
+- lib/dryspec.rb
+- lib/dryspec/helpers.rb
+- lib/dryspec/version.rb
+homepage: https://github.com/northwoodspd/dryspec
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A Ruby gem to introduce RSpec helpers which can help you DRY up your specs
+test_files: []