saharspec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ae684897f535577827bd53f103f7841c0925501
+  data.tar.gz: 83ab9127597f72ad1aabc84d2eda3847f022f93a
+SHA512:
+  metadata.gz: a69593a2bb4261748e2b2e14027109aa3926d9f5caa4780970a6808c34fab6d95093c57fc250fc315235af5cc75d25194f52ddf3c85dc0b9867732aed3093ef4
+  data.tar.gz: 73d4d55c8b53c45640cf2dd1f1847396c03b1b1d40a8268762f7a0eaec49cddbf2dc723f41c9a0194d8d3f47a67ba83e69a123a229aa2b13b90bec03857346e4

data/.rubocop_todo.yml

@@ -0,0 +1,28 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-08-11 18:02:13 +0300 using RuboCop version 0.49.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
+# SupportedStyles: aligned, indented, indented_relative_to_receiver
+Layout/MultilineMethodCallIndentation:
+  Exclude:
+    - 'lib/saharspec/get_webmock.rb'
+
+# Offense count: 2
+Lint/ShadowingOuterLocalVariable:
+  Exclude:
+    - 'lib/saharspec/get_webmock.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: only_raise, only_fail, semantic
+Style/SignalException:
+  Exclude:
+    - 'lib/saharspec/get_webmock.rb'

data/.yardopts

@@ -0,0 +1,2 @@
+--markup=markdown
+--no-private

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-15 Victor 'Zverok' Shepelev
+
+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,134 @@
+# Saharspec: Specs DRY as Sahara
+
+[![Gem Version](https://badge.fury.io/rb/saharspec.svg)](http://badge.fury.io/rb/saharspec)
+[![Build Status](https://travis-ci.org/zverok/saharspec.svg?branch=master)](https://travis-ci.org/zverok/saharspec)
+
+**saharspec** is a set of additions to RSpec. It's name is a pun on Russian word "сахар"
+("sahar", means "sugar") and Sahara desert. So, it is a set of RSpec sugar, to make your
+specs dry as a desert.
+
+## Usage
+
+Install it as a usual gem `saharspec`.
+
+Then, probably in your `spec_helper.rb`
+
+```ruby
+require 'saharspec'
+# or feature-by-feature
+require 'saharspec/its/map'
+# or some part of a library
+require 'saharspec/its'
+```
+
+## Parts
+
+### Matchers
+
+Just a random matchers I've found useful in my studies.
+
+#### `send_message(object, method)` matcher
+
+```ruby
+# before
+it {
+  expect(Net::HTTP).to receive(:get).with('http://google.com').and_return('not this time')
+  fetcher
+}
+
+# after
+require 'saharspec/matchers/send_message'
+
+it {
+  expect { fetcher }.to send_message(Net::HTTP, :get).with('http://google.com').returning('not this time')
+}
+# after + its_call
+subject { fetcher }
+its_call { is_expected.to send_message(Net::HTTP, :get).with('http://google.com').returning('not this time') }
+```
+
+Note: there is [reasons](https://github.com/rspec/rspec-expectations/issues/934) why it is not in rspec-mocks, though, not very persuative for
+me.
+
+#### `eq_multiline(text)` matcher
+
+Dedicated to checking some multiline text generators.
+
+```ruby
+# before: one option
+
+  it { expect(generated_code).to eq("def method\n  a = @b**2\n  return a + @b\nend") }
+
+# before: another option
+  it {
+    expect(generated_code).to eq(%{def method
+  a = @b**2
+  return a + @b
+end})
+  }
+
+# after
+require 'saharspec/matchers/eq_multiline'
+
+  it {
+    expect(generated_code).to eq_multiline(%{
+      |def method
+      |  a = @b**2
+      |  return a + @b
+      |end
+    })
+  }
+```
+(empty lines before/after are removed, text deindented up to `|` sign)
+
+### `its`-addons
+
+**Notice**: There are different opinions on usability/reasonability of `its(:attribute)` syntax,
+extracted from RSpec core and currently provided by [rspec-its](https://github.com/rspec/rspec-its)
+gem. Some find it (and a notion of description-less examples) bad practice. But if you are like me
+and love DRY-ness of it, probably you'll love those two ideas, taking `its`-syntax a bit further.
+
+#### `its_map`
+
+Like `rspec/its`, but for processing arrays:
+
+```ruby
+subject { html_document.search('ul#menu > li') }
+
+# before
+it { expect(subject.map(&:text)).to all not_be_empty }
+
+# after
+require 'saharspec/its/map'
+
+its_map(:text) { are_expected.to all not_be_empty }
+```
+
+#### `its_call`
+
+```ruby
+subject { some_operation_that_may_fail }
+
+# before
+it { expect { subject }.to raise_error(...) }
+
+# after
+require 'saharspec/its/call'
+
+its_call { is_expected.to raise_error(...) }
+```
+
+## State & future
+
+I use all of the components of the library on daily basis. Probably, I will extend it with other
+ideas and findings from time to time (next thing that needs gemification is WebMock DRY-er, allowing
+code like `expect { code }.to request_webmock(url, params)` instead of preparing stubs and then
+checking them). Stay tuned.
+
+## Author
+
+[Victor Shepelev](http://zverok.github.io/)
+
+## License
+
+[MIT](https://github.com/zverok/time_math2/blob/master/LICENSE.txt).

data/lib/saharspec/its/call.rb

@@ -0,0 +1,56 @@
+module Saharspec
+  module Its
+    module Call
+      # Creates nested example which converts current subject to a block-subject.
+      #
+      # @example
+      #
+      #    subject { calc_something(params) }
+      #
+      #    # without its_call
+      #    context 'with this params'
+      #      it { expect { subject }.to change(some, :value).by(1) }
+      #    end
+      #
+      #    context 'with that params'
+      #      it { expect { subject }.to raise_error(SomeError) }
+      #    end
+      #
+      #    # with its_call
+      #    context 'with this params'
+      #      its_call { is_expected.to change(some, :value).by(1) }
+      #    end
+      #
+      #    context 'with that params'
+      #      its_call { is_expected.to raise_error(SomeError) }
+      #    end
+      #
+      # @param options Other options that can be passed to usual RSpec example.
+      # @param block [Proc] The test itself. Inside it, `is_expected` (or `are_expected`) is analog of
+      #   `expect { subject }`.
+      #
+      def its_call(*options, &block)
+        # rubocop:disable Lint/NestedMethodDefinition
+        describe('call') do
+          let(:__call_subject) do
+            -> { subject }
+          end
+
+          def is_expected
+            expect(__call_subject)
+          end
+
+          example(nil, *options, &block)
+        end
+        # rubocop:enable Lint/NestedMethodDefinition
+      end
+    end
+  end
+end
+
+RSpec.configure do |rspec|
+  rspec.extend Saharspec::Its::Call
+  rspec.backtrace_exclusion_patterns << %r{/lib/saharspec/its/call}
+end
+
+RSpec::SharedContext.send(:include, Saharspec::Its::Call)

data/lib/saharspec/its/map.rb

@@ -0,0 +1,74 @@
+module Saharspec
+  module Its
+    module Map
+      # Creates nested example which has current subject mapped
+      # by specified attribute as its subject.
+      #
+      # @example
+      #
+      #   # with attribute
+      #   subject { %w[test me please] }
+      #   its_map(:length) { is_expected.to eq [4, 2, 6] }
+      #
+      #   # with attribute chain
+      #   its_map(:'reverse.upcase') { is_expected.to eq %w[TSET EM ESAELP] }
+      #
+      #   # with Hash (or any other object re sponding to `#[]`)
+      #   subject {
+      #     [
+      #       {title: 'Slaughterhouse Five', author: {first: 'Kurt', last: 'Vonnegut'}},
+      #       {title: 'Hitchhickers Guide To The Galaxy', author: {first: 'Duglas', last: 'Adams'}}
+      #     ]
+      #   }
+      #   its_map([:title]) { are_expected.to eq ['Slaughterhouse Five', 'Hitchhickers Guide To The Galaxy'] }
+      #   # multiple attributes for nested hashes
+      #   its_map([:author, :last]) { are_expected.to eq ['Vonnegut', 'Adams'] }
+      #
+      # @param attribute [String, Symbol, Array<String, Symbol>] Attribute name (String or Symbol), attribute chain
+      #   (string separated with dots) or arguments to `#[]` method (Array)
+      # @param options Other options that can be passed to usual RSpec example.
+      # @param block [Proc] The test itself. Inside it, `is_expected` (or `are_expected`) is related to result
+      #  of `map`ping the subject.
+      #
+      def its_map(attribute, *options, &block) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        # rubocop:disable Lint/NestedMethodDefinition
+        describe("map(&:#{attribute})") do
+          let(:__its_map_subject) do
+            if Array === attribute # rubocop:disable Style/CaseEquality
+              if subject.all? { |s| Hash === s } # rubocop:disable Style/CaseEquality
+                subject.map do |s|
+                  attribute.inject(s) { |inner, attr| inner[attr] }
+                end
+              else
+                subject.map { |inner| inner[*attribute] }
+              end
+            else
+              attribute_chain = attribute.to_s.split('.').map(&:to_sym)
+              attribute_chain.inject(subject) do |inner_subject, attr|
+                inner_subject.map(&attr)
+              end
+            end
+          end
+
+          def is_expected
+            expect(__its_map_subject)
+          end
+
+          alias_method :are_expected, :is_expected
+
+          options << {} unless options.last.is_a?(Hash)
+
+          example(nil, *options, &block)
+        end
+        # rubocop:enable Lint/NestedMethodDefinition
+      end
+    end
+  end
+end
+
+RSpec.configure do |rspec|
+  rspec.extend Saharspec::Its::Map
+  rspec.backtrace_exclusion_patterns << %r{/lib/saharspec/its/map}
+end
+
+RSpec::SharedContext.send(:include, Saharspec::Its::Map)

data/lib/saharspec/its.rb

@@ -0,0 +1,10 @@
+module Saharspec
+  # Wrapper module for all `its_*` RSpec additions.
+  #
+  # See {Map#its_map #its_map} and {Call#its_call #its_call}
+  module Its
+  end
+end
+
+require_relative 'its/map'
+require_relative 'its/call'

data/lib/saharspec/matchers/eq_multiline.rb

@@ -0,0 +1,48 @@
+module Saharspec
+  module Matchers
+    # @private
+    class EqMultiline < RSpec::Matchers::BuiltIn::Eq
+      def initialize(expected)
+        # 1. for all lines looking like "<spaces>|" -- remove this.
+        # 2. remove trailing spaces
+        # 3. preserve trailing spaces ending with "|", but remove the pipe
+        # 4. remove one empty line before & after, allows prettier %Q{}
+        # TODO: check if all lines start with "|"?
+        super(
+          expected
+            .gsub(/^ *\|/, '')
+            .gsub(/ +$/, '')
+            .gsub(/\|$/, '')
+            .gsub(/(\A *\n|\n *\z)/, '')
+        )
+      end
+    end
+  end
+end
+
+module RSpec
+  module Matchers
+    # Allows to pretty test multiline strings with complex indentation (for example, results of
+    # code generation).
+    #
+    # In provided string, removes first and last empty line, trailing spaces and leading spaces up
+    # to `|` character.
+    #
+    # If you need to preserve trailing spaces, end them with another `|`.
+    #
+    # @example
+    #     require 'saharspec/matchers/eq_multiline'
+    #
+    #     expect(some_code_gen).to eq_multiline(%{
+    #       |def something
+    #       |  a = 5
+    #       |  a**2
+    #       |end
+    #     })
+    #
+    # @param [String]
+    def eq_multiline(expected)
+      Saharspec::Matchers::EqMultiline.new(expected)
+    end
+  end
+end

data/lib/saharspec/matchers/send_message.rb

@@ -0,0 +1,138 @@
+module Saharspec
+  module Matchers
+    # @private
+    class SendMessage
+      include RSpec::Mocks::ExampleMethods
+
+      def initialize(target, method)
+        @target = target
+        @method = method
+      end
+
+      # DSL
+      def with(*arguments)
+        @arguments = arguments
+        self
+      end
+
+      def returning(res)
+        @res = res
+        self
+      end
+
+      def calling_original
+        @call_original = true
+        self
+      end
+
+      def exactly(n)
+        @times = n
+        self
+      end
+
+      def times
+        raise NoMethodError unless @times
+        self
+      end
+
+      def once
+        exactly(1)
+      end
+
+      def twice
+        exactly(2)
+      end
+
+      # Matching
+      def matches?(subject)
+        run(subject)
+        expect(@target).to expectation
+        true
+      end
+
+      def does_not_match?(subject)
+        run(subject)
+        expect(@target).not_to expectation
+        true
+      end
+
+      # Static properties
+      def supports_block_expectations?
+        true
+      end
+
+      def description
+        format('to send %p.%s', @target, @method)
+      end
+
+      def failure_message
+        "expected #{description}, but sent nothing"
+      end
+
+      def failure_message_when_negated
+        "expected not #{description}, but sent it"
+      end
+
+      private
+
+      def run(subject)
+        @target.respond_to?(@method) or
+          raise NoMethodError,
+                "undefined method `#{@method}' for#{@target.inspect}:#{@target.class}"
+        allow(@target).to allower
+        subject.call
+      end
+
+      def allower
+        receive(@method).tap do |a|
+          a.and_return(@res) if @res
+          a.and_call_original if @call_original
+        end
+      end
+
+      def expectation
+        have_received(@method).tap do |e|
+          e.with(*@arguments) if @arguments
+          e.exactly(@times).times if @times
+        end
+      end
+    end
+  end
+end
+
+module RSpec
+  module Matchers
+    # Checks if the (block) subject sends specified message to specified object.
+    #
+    # @example
+    #   # before:
+    #   specify {
+    #      allow(double).to receive(:fetch)
+    #      code_being_tested
+    #      expect(double).to have_received(:fetch).with(something)
+    #   }
+    #
+    #   # after:
+    #   require 'saharspec/matchers/send_message'
+    #   it { expect { code_being_tested }.to send_message(double, :fetch).with(something) }
+    #   # after + its_call
+    #   require 'saharspec/its/call'
+    #   subject { code_being_tested }
+    #   its_call { is_expected.to send_message(double, :fetch).with(something) }
+    #
+    #
+    # @param target Object which expects message, double or real object
+    # @param method [Symbol] Message being expected
+    #
+    # @return Instance of a matcher, allowing the following additional methods:
+    #
+    #   * `once`, `twice`, `exactly(n).times`;
+    #   * `with(arguments)`;
+    #   * `calling_original`;
+    #   * `returning(response)`.
+    #
+    def send_message(target, method)
+      Saharspec::Matchers::SendMessage.new(target, method)
+    end
+  end
+end

data/lib/saharspec/matchers.rb

@@ -0,0 +1,11 @@
+module Saharspec
+  # All Saharspec matchers, when required, included into `RSpec::Matchers` namespace.
+  #
+  # See {RSpec::Matchers#send_message #send_message} and {RSpec::Matchers#eq_multiline #eq_multiline}.
+  #
+  module Matchers
+  end
+end
+
+require_relative 'matchers/eq_multiline'
+require_relative 'matchers/send_message'

data/lib/saharspec.rb

@@ -0,0 +1,9 @@
+# Umbrella module for all Saharspec RSpec DRY-ing features.
+#
+# See {file:README.md} or {Its} and {Matchers} separately.
+#
+module Saharspec
+end
+
+require_relative 'saharspec/its'
+require_relative 'saharspec/matchers'

data/saharspec.gemspec

@@ -0,0 +1,34 @@
+Gem::Specification.new do |s|
+  s.name     = 'saharspec'
+  s.version  = '0.0.1'
+  s.authors  = ['Victor Shepelev']
+  s.email    = 'zverok.offline@gmail.com'
+  s.homepage = 'https://github.com/zverok/saharspec'
+
+  s.summary = 'Several additions for DRYer RSpec code'
+  s.licenses = ['MIT']
+
+  s.files = `git ls-files`.split($RS).reject do |file|
+    file =~ /^(?:
+    spec\/.*
+    |Gemfile
+    |Rakefile
+    |\.rspec
+    |\.gitignore
+    |\.rubocop.yml
+    |\.travis.yml
+    )$/x
+  end
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 2.1.0'
+
+  s.add_development_dependency 'rubocop', '>= 0.40'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-its'
+  s.add_development_dependency 'simplecov', '~> 0.9'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rubygems-tasks'
+  s.add_development_dependency 'yard'
+  #s.add_development_dependency 'coveralls'
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: saharspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Victor Shepelev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: zverok.offline@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop_todo.yml"
+- ".yardopts"
+- LICENSE.txt
+- README.md
+- lib/saharspec.rb
+- lib/saharspec/its.rb
+- lib/saharspec/its/call.rb
+- lib/saharspec/its/map.rb
+- lib/saharspec/matchers.rb
+- lib/saharspec/matchers/eq_multiline.rb
+- lib/saharspec/matchers/send_message.rb
+- saharspec.gemspec
+homepage: https://github.com/zverok/saharspec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Several additions for DRYer RSpec code
+test_files: []