rspec-when 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63b5e2cc54a288d461b1fbfecc5e6415e4d6cc39
+  data.tar.gz: 0980ba0c3c700c501d6f92e68fa13a7ea755809c
+SHA512:
+  metadata.gz: 8869c96cc00b12d1d9b3fbd25003a7402dfba007499fea695af368d1027f5c9234279989fbe3569681aadea1d4e3841691891c8168b67d34bc5b1fee6066d7f7
+  data.tar.gz: af92ba4fa7a1c544a22062e94959cab594607eab294bf6eebf5982dd4ffd38436e925b74278dbedf95b8ff1a77bfe45d90cf0097fad5f8f0a4a0359fc8d2ab85

data/README.md

@@ -0,0 +1,45 @@
+# RSpec when syntax
+
+RSpec::When lets you describe both optional expectations and expectations
+with inverses. This helps DRY up otherwise complicated or repetitive tests.
+
+## Installation
+
+```sh
+$ gem install rspec-when
+```
+
+## Usage
+
+#### Plain `when` syntax
+
+```rb
+expect(user).when(an_admin).to have_all_access
+```
+
+Provides syntactic sugar for
+
+```rb
+if an_admin
+  expect(user).to have_all_access
+end
+```
+
+#### Compound `when.with_inverse` syntax
+
+```rb
+expect(user).when(an_admin).with_inverse.to have_all_access
+```
+
+Provides syntactic sugar for
+
+```rb
+if an_admin
+  expect(user).to have_all_access
+else
+  expect(user).not_to have_all_access
+end
+```
+
+Typical usage is when abstracting common expectations into a helper method to
+DRY up tests where testing the inverse expectation is also required.

data/lib/rspec/expectations/when_expectation_extensions.rb

@@ -0,0 +1,11 @@
+module RSpec
+  module Expectations
+    # DSL extension to expectation target allowing optional expectations
+    module WhenExpectationExtensions
+      def when(expected)
+        WhenExpectationTarget.new @target, expected
+      end
+    end
+    ExpectationTarget.include WhenExpectationExtensions
+  end
+end

data/lib/rspec/expectations/when_expectation_target.rb

@@ -0,0 +1,92 @@
+module RSpec
+  module Expectations
+    # Wraps the target of an expectation and allowing of optional expectations
+    # as well as testing expectation inverses
+    #
+    # @example
+    #   expect(something).when(flag) # => WhenExpectationTarget testing when `flag`
+    #
+    #   # `when` used with `to`
+    #   expect(actual).when(flag).to eq(3)
+    #   # is the equivalent of
+    #   if flag
+    #     expect(actual).to eq(3)
+    #   end
+    #
+    #   # `when` used with `with_inverse` and `to`
+    #   expect(actual).when(flag).with_inverse.to eq(3)
+    #   # is the equivalent of
+    #   if flag
+    #     expect(actual).to eq(3)
+    #   else
+    #     expect(actual).not_to eq(3)
+    #   end
+    #
+    # @note `WhenExpectationTarget` is not intended to be instantiated
+    #   directly. Use `expect(target).when(flag)` instead
+
+    class WhenExpectationTarget < ExpectationTarget
+      # @return [Object] the target of the expectation
+      attr_reader :target
+
+      # @return [Boolean] is the target expected?
+      attr_reader :when_expected
+
+      def initialize(value, when_expected)
+        @target = value
+        @when_expected = when_expected
+        @with_inverse = false
+      end
+
+      # Indicates whether the inverse of the expectation should be applied
+      # should the `when` flag be false
+      def with_inverse
+        @with_inverse = true
+        self
+      end
+
+      alias_method :expect_to, :to
+      alias_method :expect_not_to, :not_to
+
+      # When expected, it will run the given expectation, passing if `matcher` returns true.
+      # When not expected and we're also testing the inverse, it will run the given expectation,
+      # passing if `matcher` returns false.
+      # @example
+      #   expect(value).when(flag).to eq(5)
+      #   expect(value).when(flag).with_inverse.to eq(5)
+      #   expect { perform }.when(flag).to raise_error
+      # @param [Matcher]
+      #   matcher
+      # @param [String or Proc] message optional message to display when the expectation fails
+      # @return [Boolean] true if the expectation succeeds (else raises)
+      # @see RSpec::Matchers
+      def to(matcher = nil, message = nil, &block)
+        if @when_expected
+          super
+        elsif @with_inverse
+          expect_not_to matcher, message, &block
+        end
+      end
+
+      # When expected, it will run the given expectation, passing if `matcher` returns false.
+      # When not expected and we're also testing the inverse, it will run the given expectation,
+      # passing if `matcher` returns true.
+      # @example
+      #   expect(value).when(flag).not_to eq(5)
+      #   expect(value).when(flag).with_inverse.not_to eq(5)
+      # @param [Matcher]
+      #   matcher
+      # @param [String or Proc] message optional message to display when the expectation fails
+      # @return [Boolean] false if the negative expectation succeeds (else raises)
+      # @see RSpec::Matchers
+      def not_to(matcher = nil, message = nil, &block)
+        if @when_expected
+          super
+        elsif @with_inverse
+          expect_to matcher, message, &block
+        end
+      end
+      alias to_not not_to
+    end
+  end
+end

data/lib/rspec/when.rb

@@ -0,0 +1,3 @@
+require 'rspec/expectations/expectation_target'
+require_relative 'expectations/when_expectation_extensions'
+require_relative 'expectations/when_expectation_target'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: rspec-when
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Bromwich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email: a.bromwich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/rspec/expectations/when_expectation_extensions.rb
+- lib/rspec/expectations/when_expectation_target.rb
+- lib/rspec/when.rb
+homepage: http://github.com/abrom/rspec-when
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+- "--markup"
+- markdown
+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.8
+signing_key: 
+specification_version: 4
+summary: RSpec extension for when syntax
+test_files: []
+has_rdoc: