saharspec 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 320e576aeec4fa534c88058a6f93a617adffa1ef
-  data.tar.gz: 3bb428585c9c78cb5da1ee565fbf7cfd1e5d8ea4
+  metadata.gz: 627f1f82b546e7a3e096497b74f25cab346d0fa2
+  data.tar.gz: d7efe0bcc330cdd47d426fb502b5114fbffa85e6
 SHA512:
-  metadata.gz: 67c2f6364699e87103723d7a679e07da03a4b53a6a7b57f43cc2c9bd93b496453d3ebfe4923440df94a7d6c61176308aba164254cbcea386e762864af483034a
-  data.tar.gz: c5cbcf7972f063618e66ee9feea61ba80005942cf38cbe9a4735e30cd2a603f623bc25d5bd19b4553cdb21d573f46cac371cbb722aa5fd0e25016e56b3138997
+  metadata.gz: e2249769358166c5b72bee55ca94b9b0ed698715afc71e439e7687fba8f745b63641312e4cb7d52340c3e4f6a805458c0f7e0b7be9b23e4eeccb90487d6699a2
+  data.tar.gz: 945e11582fd5c21b7cb7fd8b0d7f1021611d546bb957446df2f8b1c7b2d5c1b060e19dfd80956b5dec8a0d6a4949cda0981e216d1093d9084d44e005cf25dd49

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`
 
@@ -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.
@@ -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/its.rb

@@ -3,9 +3,29 @@ module Saharspec
   #
   # 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/map.rb

@@ -11,7 +11,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 {
@@ -35,8 +35,8 @@ module Saharspec
         # 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

data/lib/saharspec/matchers.rb

@@ -3,10 +3,11 @@ module Saharspec
   #
   # 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 +16,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,99 @@
+require 'json'
+
+module Saharspec
+  module Matchers
+    # @private
+    class BeJson
+      NONE = Object.new.freeze
+      include RSpec::Matchers::Composable
+      include RSpec::Matchers # to have #match
+
+      attr_reader :actual, :expected
+
+      def initialize(expected, **parse_opts)
+        @expected_matcher = @expected = expected
+        # wrap to make be_json('foo' => matcher) work, too
+        @expected_matcher = match(expected) unless expected == NONE || expected.respond_to?(:matches?)
+        @parse_opts = parse_opts
+      end
+
+      def matches?(json)
+        @actual = JSON.parse(json, **@parse_opts)
+        @expected_matcher == NONE || @expected_matcher === @actual
+      rescue JSON::ParserError => parse_error
+        @parser_error = parse_error
+        false
+      end
+
+      def does_not_match?(*args)
+        !matches?(*args)
+      end
+
+      def diffable?
+        true
+      end
+
+      def description
+        if @expected == NONE
+          '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 != NONE
+            "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::NONE)
+      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::NONE)
+      Saharspec::Matchers::BeJson.new(expected, symbolize_names: true)
+    end
+  end
+end

data/lib/saharspec/matchers/ret.rb

@@ -4,6 +4,8 @@ module Saharspec
     class Ret
       include RSpec::Matchers::Composable
 
+      attr_reader :actual, :expected
+
       def initialize(expected)
         @expected = expected
       end
@@ -12,13 +14,17 @@ module Saharspec
         @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
@@ -42,7 +48,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

@@ -16,8 +16,8 @@ module Saharspec
         self
       end
 
-      def returning(res)
-        @res = res
+      def returning(*res)
+        @res = [*res]
         self
       end
 
@@ -91,7 +91,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/version.rb

@@ -1,9 +1,6 @@
 module Saharspec
-  # @private
   MAJOR = 0
-  # @private
   MINOR = 0
-  # @private
-  PATCH = 4
+  PATCH = 5
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saharspec
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Victor Shepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -125,6 +125,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
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Several additions for DRYer RSpec code