saharspec 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a363bdb21050423225b98a8dae3d2f8861947426
-  data.tar.gz: 3ace51cf8d457d79caa8fe2c3b12e144c1a5a50a
+SHA256:
+  metadata.gz: 402e6f62d9abc17f1dad82a3a5f38ae8f844ca458ad87a4756192976e4cd5496
+  data.tar.gz: 1541630eb677716d9ab2e58e1a25427ea86b67c5e001a52a25e9641491006971
 SHA512:
-  metadata.gz: a6b1f390d030eeebbaa9ece4efbc64176e24cfd32d748e044a1d47fd8f7862b5a966a83fdcb64474b28496f0d9ea97150e70d725c0b99d9ed47d74d26d4f60b2
-  data.tar.gz: fbf40cbc81e264aeb3f78d14c5c934a3c501e3586e851c32718e4cd2be9eaedd58f5f3e2fc5c4664159bb1abec90b065fb907589bde3395a4b62ae89083d8180
+  metadata.gz: 7923af91fee36b0a8b8c79fdba8d0bf6503598ca62589d8d30a2e8dace0428f9338e892d5e3a0538c4fc857a209b390b6b88eebf8637c41dc68dd6c61d6772d5
+  data.tar.gz: 5b844ac0a0098001638d19a2113e0eca4bf7acb225a87a456133e3d1ff564fc96648b95a0e0c37478c07d2532fc005e9c4db35a15b00f6b92018565c70097175

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Saharspec history
 
+## 0.0.8 -- 2020-10-10
+
+* Better `dont` failure message (just use underlying matchers `failure_message_when_negated`)
+
+## 0.0.7 -- 2020-04-11
+
+* Allow `its_call` to work properly with keyword args on Ruby 2.7
+
+## 0.0.6 -- 2019-10-05
+
+* Fix `dont.send_message` combination behavior (and generally, behavior of `dont.` with matchers
+  defining custom `does_not_matches?`);
+* Better `ret` matcher failure message when there is a complicated matcher on the right side (use
+  its `failure_message` instead of `description`);
+* Update `send_message` matcher description to be more readable;
+* Drop Ruby 2.2 support.
+
+## 0.0.5 -- 2018-03-03
+
+* `be_json` matcher;
+* make `ret` diffable.
+
+## 0.0.4 -- 2017-11-07
+
+* Update `its_call` description generation, looks better with `rspec --format doc`
+
 ## 0.0.3 -- 2017-11-06
 
 * Introduce new `its`-family addition: `its_call(*args)`

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-15 Victor 'Zverok' Shepelev
+Copyright (c) 2017-18 Victor 'Zverok' Shepelev
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -9,7 +9,8 @@ specs dry as a desert.
 
 ## Usage
 
-Install it as a usual gem `saharspec`.
+Install it as a usual gem `saharspec` with `gem install` or `gem "saharspec"` in `:test` group of
+your `Gemfile`.
 
 Then, probably in your `spec_helper.rb`
 
@@ -42,9 +43,9 @@ 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
+# after + its_block
 subject { fetcher }
-its_call { is_expected.to send_message(Net::HTTP, :get).with('http://google.com').returning('not this time') }
+its_block { 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
@@ -102,6 +103,27 @@ end
 
 Plays really well with `its_call` shown below.
 
+#### `be_json(value)` and `be_json_sym(value)` matchers
+
+Simple matcher to check if string is valid JSON and optionally if it matches to expected values:
+
+```ruby
+expect('{}').to be_json # ok
+expect('garbage').to be_json
+# expected value to be a valid JSON string but failed: 765: unexpected token at 'garbage'
+
+expect('{"foo": "bar"}').to be_json('foo' => 'bar') # ok
+
+# be_json_sym is more convenient to check with hash keys, parses JSON to symbols
+expect('{"foo": "bar"}').to be_json_sym(foo: 'bar')
+
+# nested matchers work, too
+expect('{"foo": [1, 2, 3]').to be_json_sym(foo: array_including(3))
+
+# We need to go deeper!
+expect(something_large).to be_json_sym(include(meta: include(next_page: Integer)))
+```
+
 #### `eq_multiline(text)` matcher
 
 Dedicated to checking some multiline text generators.
@@ -135,7 +157,7 @@ require 'saharspec/matchers/eq_multiline'
 
 ### `dont`: matcher negation
 
-Another (exprimental) attempt to get rid of `define_negated_matcher`. `dont` is not 100% grammatically
+Allows to get rid of gazilliions of `define_negated_matcher`. `dont` is not 100% grammatically
 correct, yet short and readable enought. It just negates attached matcher.
 
 ```ruby
@@ -241,4 +263,4 @@ checking them). Stay tuned.
 
 ## License
 
-[MIT](https://github.com/zverok/time_math2/blob/master/LICENSE.txt).
+[MIT](https://github.com/zverok/saharspec/blob/master/LICENSE.txt).

data/lib/saharspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Umbrella module for all Saharspec RSpec DRY-ing features.
 #
 # See {file:README.md} or {Its} and {Matchers} separately.

data/lib/saharspec/its.rb

@@ -1,11 +1,33 @@
+# frozen_string_literal: true
+
 module Saharspec
   # Wrapper module for all `its_*` RSpec additions.
   #
   # See:
   #
-  # * {Map#its_map #its_map}
-  # * {Block#its_block #its_block}
-  # * {Call#its_call #its_call}
+  # ## {Map#its_map #its_map}
+  #
+  # ```ruby
+  # subject { %w[1 2 3] }
+  # its_map(:to_s) { is_expected.to eq [1, 2, 3] }
+  # ```
+  #
+  # ## {Call#its_call #its_call}
+  #
+  # ```ruby
+  # subject { [1, 2, 3].method(:[]) }
+  # its_call(2) { is_expected.to ret 3 }
+  # its_call('foo') { is_expected.to raise_error }
+  # ```
+  #
+  # ## {Block#its_block #its_block}
+  #
+  # ```ruby
+  # subject { something_action }
+  # its_block { is_expected.not_to raise_error }
+  # its_block { is_expected.to change(some, :value).by(1) }
+  # ```
+  #
   module Its
   end
 end

data/lib/saharspec/its/block.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Saharspec
   module Its
     module Block
@@ -53,4 +55,4 @@ RSpec.configure do |rspec|
   rspec.backtrace_exclusion_patterns << %r{/lib/saharspec/its/block}
 end
 
-RSpec::SharedContext.send(:include, Saharspec::Its::Block)
+RSpec::SharedContext.include Saharspec::Its::Block

data/lib/saharspec/its/call.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'ruby2_keywords'
+
 module Saharspec
   module Its
     module Call
@@ -23,11 +27,10 @@ module Saharspec
       #      its_call(5) { is_expected.to change(array, :length).by(1) }
       #    end
       #
-      def its_call(*args, &block)
+      ruby2_keywords def its_call(*args, &block)
         # rubocop:disable Lint/NestedMethodDefinition
-        describe('call') do
+        describe("(#{args.map(&:inspect).join(', ')})") do
           let(:__call_subject) do
-            warn 'No need to use its_call without arguments, just it {} will work' if args.empty?
             -> { subject.call(*args) }
           end
 
@@ -48,4 +51,4 @@ RSpec.configure do |rspec|
   rspec.backtrace_exclusion_patterns << %r{/lib/saharspec/its/call}
 end
 
-RSpec::SharedContext.send(:include, Saharspec::Its::Call)
+RSpec::SharedContext.include Saharspec::Its::Call

data/lib/saharspec/its/map.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Saharspec
   module Its
     module Map
@@ -11,7 +13,7 @@ module Saharspec
       #   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] }
+      #   its_map('reverse.upcase') { is_expected.to eq %w[TSET EM ESAELP] }
       #
       #   # with Hash (or any other object responding to `#[]`)
       #   subject {
@@ -30,12 +32,13 @@ module Saharspec
       # @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
+      def its_map(attribute, *options, &block) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         # rubocop:disable Lint/NestedMethodDefinition
+        # TODO: better desciption for different cases
         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
+            if Array === attribute
+              if subject.all? { |s| Hash === s }
                 subject.map do |s|
                   attribute.inject(s) { |inner, attr| inner[attr] }
                 end
@@ -71,4 +74,4 @@ RSpec.configure do |rspec|
   rspec.backtrace_exclusion_patterns << %r{/lib/saharspec/its/map}
 end
 
-RSpec::SharedContext.send(:include, Saharspec::Its::Map)
+RSpec::SharedContext.include Saharspec::Its::Map

data/lib/saharspec/matchers.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 module Saharspec
   # All Saharspec matchers, when required, included into `RSpec::Matchers` namespace.
   #
   # See:
   #
-  # * {RSpec::Matchers#dont #dont}
-  # * {RSpec::Matchers#send_message #send_message}
-  # * {RSpec::Matchers#eq_multiline #eq_multiline}
-  # * {RSpec::Matchers#ret #ret}
+  # * {RSpec::Matchers#dont #dont}: `expect { block }.to change(this).and dont.change(that)`
+  # * {RSpec::Matchers#send_message #send_message}: `expect { block }.to send_message(File, :write)`
+  # * {RSpec::Matchers#ret #ret}: `expect { block }.to ret value`
+  # * {RSpec::Matchers#be_json #be_json}: `expect(response.body).to be_json('foo' => 'bar')`
+  # * {RSpec::Matchers#eq_multiline #eq_multiline}: multiline equality akin to squiggly heredoc
   #
   module Matchers
   end
@@ -15,3 +18,5 @@ end
 require_relative 'matchers/eq_multiline'
 require_relative 'matchers/send_message'
 require_relative 'matchers/ret'
+require_relative 'matchers/dont'
+require_relative 'matchers/be_json'

data/lib/saharspec/matchers/be_json.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Saharspec
+  module Matchers
+    # @private
+    class BeJson
+      include RSpec::Matchers::Composable
+      include RSpec::Matchers # to have #match
+
+      ANY = Object.new.freeze
+
+      attr_reader :actual, :expected
+
+      def initialize(expected, **parse_opts)
+        @expected_matcher = @expected = expected
+
+        # wrap to make be_json('foo' => matcher) work, too
+        unless expected == ANY || expected.respond_to?(:matches?)
+          @expected_matcher = match(expected)
+        end
+        @parse_opts = parse_opts
+      end
+
+      def matches?(json)
+        @actual = JSON.parse(json, **@parse_opts)
+        @expected_matcher == ANY || @expected_matcher === @actual
+      rescue JSON::ParserError => e
+        @parser_error = e
+        false
+      end
+
+      def does_not_match?(*args)
+        !matches?(*args)
+      end
+
+      def diffable?
+        true
+      end
+
+      def description
+        if @expected == ANY
+          'be a valid JSON string'
+        else
+          expected = @expected.respond_to?(:description) ? @expected.description : @expected
+          "be a valid JSON matching (#{expected})"
+        end
+      end
+
+      def failure_message
+        failed =
+          case
+          when @parser_error
+            "failed: #{@parser_error}"
+          when @expected != ANY
+            "was #{@actual}"
+          end
+        "expected value to #{description} but #{failed}"
+      end
+
+      def failure_message_when_negated
+        'expected value not to be parsed as JSON, but succeeded'
+      end
+    end
+  end
+end
+
+module RSpec
+  module Matchers
+    # `be_json` checks if provided value is JSON, and optionally checks it contents.
+    #
+    # If you need to check against some hashes, it is more convenient to use `be_json_sym`, which
+    # parses JSON with `symbolize_names: true`.
+    #
+    # @example
+    #
+    #   expect('{}').to be_json # ok
+    #   expect('garbage').to be_json
+    #   # expected value to be a valid JSON string but failed: 765: unexpected token at 'garbage'
+    #
+    #   expect('{"foo": "bar"}').to be_json('foo' => 'bar') # ok
+    #   expect('{"foo": "bar"}').to be_json_sym(foo: 'bar') # more convenient
+    #
+    #   expect('{"foo": [1, 2, 3]').to be_json_sym(foo: array_including(3)) # nested matchers work
+    #   expect(something_large).to be_json_sym(include(meta: include(next_page: Integer)))
+    #
+    # @param expected Value or matcher to check JSON against. It should implement `#===` method,
+    #   so all standard and custom RSpec matchers work.
+    def be_json(expected = Saharspec::Matchers::BeJson::ANY)
+      Saharspec::Matchers::BeJson.new(expected)
+    end
+
+    # `be_json_sym` checks if value is a valid JSON and parses it with `symbolize_names: true`. This
+    # way, it is convenient to check hashes content with Ruby's short symbolic keys syntax.
+    #
+    # See {#be_json_sym} for examples.
+    #
+    # @param expected Value or matcher to check JSON against. It should implement `#===` method,
+    #   so all standard and custom RSpec matchers work.
+    def be_json_sym(expected = Saharspec::Matchers::BeJson::ANY)
+      Saharspec::Matchers::BeJson.new(expected, symbolize_names: true)
+    end
+  end
+end

data/lib/saharspec/matchers/dont.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module Saharspec
   module Matchers
     # @private
     class Not < RSpec::Matchers::BuiltIn::BaseMatcher
-      def initialize
+      def initialize(*)
+        super
         @delegator = Delegator.new
       end
 
@@ -11,16 +14,29 @@ module Saharspec
       end
 
       def match(_expected, actual)
-        @matcher or
-          fail(ArgumentError, '`dont` matcher used without any matcher to negate. Usage: dont.other_matcher(args)')
-        !@matcher.matches?(actual)
+        @matcher or fail ArgumentError, '`dont` matcher used without any matcher to negate. '\
+                                        'Usage: dont.other_matcher(args)'
+
+        # https://www.rubydoc.info/github/rspec/rspec-expectations/RSpec%2FMatchers%2FMatcherProtocol:does_not_match%3F
+        # In a negative expectation such as `expect(x).not_to foo`, RSpec will call
+        # `foo.does_not_match?(x)` if this method is defined. If it's not defined it
+        # will fall back to using `!foo.matches?(x)`.
+        if @matcher.respond_to?(:does_not_match?)
+          @matcher.does_not_match?(actual)
+        else
+          !@matcher.matches?(actual)
+        end
+      end
+
+      def failure_message
+        @matcher.failure_message_when_negated
       end
 
       def supports_block_expectations?
         @matcher.supports_block_expectations?
       end
 
-      def method_missing(m, *a, &b) # rubocop:disable Style/MethodMissing
+      def method_missing(m, *a, &b) # rubocop:disable Lint/MissingSuper
         if @matcher
           @matcher.send(m, *a, &b)
         else
@@ -30,7 +46,7 @@ module Saharspec
         self
       end
 
-      def respond_to_missing?(method, include_private = false)
+      def respond_to_missing?(method, include_private = false) # rubocop:disable Lint/MissingSuper
         if @matcher
           @matcher.respond_to?(method, include_private)
         else

data/lib/saharspec/matchers/eq_multiline.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../util'
 
 module Saharspec

data/lib/saharspec/matchers/ret.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 module Saharspec
   module Matchers
     # @private
     class Ret
       include RSpec::Matchers::Composable
 
+      attr_reader :actual, :expected
+
       def initialize(expected)
         @expected = expected
       end
@@ -11,25 +15,41 @@ module Saharspec
       def matches?(subject)
         @subject = subject
         return false unless subject.respond_to?(:call)
+
         @actual = subject.call
-        @expected === @actual # rubocop:disable Style/CaseEquality
+        @expected === @actual
       end
 
       def supports_block_expectations?
         true
       end
 
+      def diffable?
+        true
+      end
+
       def description
         "return #{@expected.respond_to?(:description) ? @expected.description : @expected.inspect}"
       end
 
       def failure_message
-        "expected to #{description}, " +
-          (@subject.respond_to?(:call) ? "but returned #{@actual.inspect}" : 'but was not callable')
+        case
+        when !@subject.respond_to?(:call)
+          "expected to #{description}, but was not callable"
+        when @expected.respond_to?(:failure_message)
+          "return value mismatch: #{@expected.failure_message}"
+        else
+          "expected to #{description}, but returned #{@actual.inspect}"
+        end
       end
 
       def failure_message_when_negated
-        "expected not to #{description}, but returned it"
+        case
+        when @expected.respond_to?(:failure_message_when_negated)
+          "return value mismatch: #{@expected.failure_message_when_negated}"
+        else
+          "expected not to #{description}, but returned it"
+        end
       end
     end
   end
@@ -42,7 +62,8 @@ module RSpec
     # It should be considered instead of simple value matchers (like `eq`) in the situations:
     #
     # 1. Several block behaviors tested in the same test, joined with `.and`, or in separate tests
-    # 2. You test what some block or method returns with arguments, using {Call#its_call #its_call}
+    # 2. You test what some block or method returns with arguments, using
+    #   {Saharspec::Its::Call#its_call #its_call}
     #
     # Values are tested with `===`, which allows chaining other matchers and patterns to the check.
     #

data/lib/saharspec/matchers/send_message.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Saharspec
   module Matchers
     # @private
@@ -16,8 +18,8 @@ module Saharspec
         self
       end
 
-      def returning(res)
-        @res = res
+      def returning(*res)
+        @res = [*res]
         self
       end
 
@@ -33,6 +35,7 @@ module Saharspec
 
       def times
         fail NoMethodError unless @times
+
         self
       end
 
@@ -68,7 +71,7 @@ module Saharspec
       end
 
       def description
-        format('to send %p.%s', @target, @method)
+        format('send %p.%s', @target, @method)
       end
 
       def failure_message
@@ -91,7 +94,7 @@ module Saharspec
 
       def allower
         receive(@method).tap do |a|
-          a.and_return(@res) if @res
+          a.and_return(*@res) if @res
           a.and_call_original if @call_original
         end
       end

data/lib/saharspec/util.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Saharspec
   module Util
     def multiline(string)

data/lib/saharspec/version.rb

@@ -1,9 +1,8 @@
+# frozen_string_literal: true
+
 module Saharspec
-  # @private
   MAJOR = 0
-  # @private
   MINOR = 0
-  # @private
-  PATCH = 3
+  PATCH = 8
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/saharspec.gemspec

@@ -23,10 +23,14 @@ Gem::Specification.new do |s|
   end
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = '>= 2.1.0'
+  s.required_ruby_version = '>= 2.3.0'
 
-  s.add_development_dependency 'rubocop', '>= 0.40'
-  s.add_development_dependency 'rspec'
+  s.add_runtime_dependency 'ruby2_keywords'
+
+  if RUBY_VERSION >= '2.4' # Newest Rubocop fails on 2.3
+    s.add_development_dependency 'rubocop', '~> 0.93'
+  end
+  s.add_development_dependency 'rspec', '~> 3.7.0'
   s.add_development_dependency 'rspec-its'
   s.add_development_dependency 'simplecov', '~> 0.9'
   s.add_development_dependency 'rake'

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: saharspec
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Victor Shepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2020-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: ruby2_keywords
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.40'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.40'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.93'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.93'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -125,6 +139,7 @@ files:
 - lib/saharspec/its/call.rb
 - lib/saharspec/its/map.rb
 - lib/saharspec/matchers.rb
+- lib/saharspec/matchers/be_json.rb
 - lib/saharspec/matchers/dont.rb
 - lib/saharspec/matchers/eq_multiline.rb
 - lib/saharspec/matchers/request_webmock.rb
@@ -145,15 +160,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Several additions for DRYer RSpec code