saharspec 0.0.8 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 402e6f62d9abc17f1dad82a3a5f38ae8f844ca458ad87a4756192976e4cd5496
-  data.tar.gz: 1541630eb677716d9ab2e58e1a25427ea86b67c5e001a52a25e9641491006971
+  metadata.gz: 9409e96bf31ffafcb98955b97ab75e2b78547b5d5bf5dc405f22f21fd62ff77c
+  data.tar.gz: b9d1cda3cd2796576612b4e888cf8fd97a9b39357c56417c293628958722bdb3
 SHA512:
-  metadata.gz: 7923af91fee36b0a8b8c79fdba8d0bf6503598ca62589d8d30a2e8dace0428f9338e892d5e3a0538c4fc857a209b390b6b88eebf8637c41dc68dd6c61d6772d5
-  data.tar.gz: 5b844ac0a0098001638d19a2113e0eca4bf7acb225a87a456133e3d1ff564fc96648b95a0e0c37478c07d2532fc005e9c4db35a15b00f6b92018565c70097175
+  metadata.gz: e10c863c94b4099cd6322029eda5129aec7cb12ddfae032c71a37436731f86189c8f1494a5f71d29e6eb17764ba4f6ad06e7f9a9ada6486d123aac0036d1d32a
+  data.tar.gz: d229e1aa4ecfa492f15b57b4249e51ae7cdf0805895f4a465a1ade675949a13526d3052e719b4abed0b98c858461aa5b30115642425883df0c66f0039728c766

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Saharspec history
 
+## 0.0.10 -- 2023-02-18
+
+* Add `lets:` metadata helper for DRYer defining of simple `let`s in multiple contexts;
+* Minimum supported Ruby version is 2.7
+* Add a handler for when `saharspec` is called before/without `rspec`, to provide an informative error message ([@Vagab](https://github.com/Vagab))
+
+## 0.0.9 -- 2022-05-17
+
+* Properly lint RSpec specs using `its_block`/`its_call`/`its_map` with `rubocop-rspec` >= 2.0 ([@ka8725](https://github.com/ka8725))
+* Fix `its_block` and `its_call` to support RSpec 3.11
+
 ## 0.0.8 -- 2020-10-10
 
 * Better `dont` failure message (just use underlying matchers `failure_message_when_negated`)

data/README.md

@@ -73,18 +73,18 @@ context 'when incompatible' do
 end
 
 # option 2. subject is block
-subject { -> {2 + x } }
-
-context 'when incompatible' do
-  let(:x) { '3' }
-  it { is_expected.to raise_error } # DRY
-end
+subject { -> { 2 + x } }
 
 context 'when numeric' do
   let(:x) { 3 }
   it { expect(subject.call).to eq 5 } # not DRY
 end
 
+context 'when incompatible' do
+  let(:x) { '3' }
+  it { is_expected.to raise_error } # DRY
+end
+
 # after
 require 'saharspec/matchers/ret'
 
@@ -250,6 +250,59 @@ describe '#delete_at' do
 end
 ```
 
+### Metadata handlers
+
+(Experimental.) Those aren't required by default, or by `require 'saharspec/metadata'`, you need to require each by its own. This is done to lessen the confusion if metadata processing isn't expected.
+
+#### `lets:`
+
+A shortcut for defining simple `let`s in the description
+
+```ruby
+let(:user) { create(:user, role: role) }
+
+# before: a lot of code to say simple things:
+
+context 'when admin' do
+ let(:role) { :admin }
+
+ it { is_expected.to be_allowed }
+end
+
+context 'when user' do
+ let(:role) { :user }
+
+ it { is_expected.to be_denied }
+end
+
+# after
+
+context 'when admin', lets: {role: :admin} do
+ it { is_expected.to be_allowed }
+end
+
+context 'when user', lets: {role: :user} do
+ it { is_expected.to be_denied }
+end
+
+# you can also give empty descriptions, then they would be auto-generated
+
+# generates a context with description "with role=:admin"
+context '', lets: {role: :admin} do
+ it { is_expected.to be_allowed }
+end
+```
+
+### Linting with RuboCop RSpec
+
+`rubocop-rspec` fails to properly detect RSpec constructs that Saharspec defines (`its_call`, `its_block`, `its_map`).
+Make sure to use `rubocop-rspec` 2.0 or newer and add the following to your `.rubocop.yml`:
+
+```yaml
+inherit_gem:
+  saharspec: config/rubocop-rspec.yml
+```
+
 ## State & future
 
 I use all of the components of the library on daily basis. Probably, I will extend it with other

data/config/rubocop-rspec.yml

@@ -0,0 +1,13 @@
+RSpec:
+  Language:
+    Includes:
+      Examples:
+        - its_block
+        - its_call
+        - its_map
+        - fits_block
+        - fits_call
+        - fits_map
+        - xits_block
+        - xits_call
+        - xits_map

data/lib/saharspec/its/block.rb

@@ -3,7 +3,7 @@
 module Saharspec
   module Its
     module Block
-      # Creates nested example which converts current subject to a block-subject.
+      # Creates nested example that redefines implicit `is_expected` to use subject as a block.
       #
       # @example
       #
@@ -34,12 +34,13 @@ module Saharspec
       def its_block(*options, &block)
         # rubocop:disable Lint/NestedMethodDefinition
         describe('as block') do
+          # FIXME: Not necessary? (Previously, wrapped the subject in lambda, now just repeats it)
           let(:__call_subject) do
-            -> { subject }
+            subject
           end
 
           def is_expected
-            expect(__call_subject)
+            expect { __call_subject }
           end
 
           example(nil, *options, &block)

data/lib/saharspec/its/call.rb

@@ -31,11 +31,11 @@ module Saharspec
         # rubocop:disable Lint/NestedMethodDefinition
         describe("(#{args.map(&:inspect).join(', ')})") do
           let(:__call_subject) do
-            -> { subject.call(*args) }
+            subject.call(*args)
           end
 
           def is_expected
-            expect(__call_subject)
+            expect { __call_subject }
           end
 
           example(nil, &block)

data/lib/saharspec/its/map.rb

@@ -32,7 +32,7 @@ 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, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def its_map(attribute, *options, &block) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         # rubocop:disable Lint/NestedMethodDefinition
         # TODO: better desciption for different cases
         describe("map(&:#{attribute})") do

data/lib/saharspec/metadata/lets.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Saharspec
+  module Metadata
+    # Is included in `context`s and `describe`s that have `lets: Hash` defined, as a shortcut to
+    # define simple `let`s in a simple one-line way:
+    #
+    # ```ruby
+    # let(:user) { create(:user, role: role) }
+    #
+    # # before: a lot of code to say simple things:
+    # context 'when admin' do
+    #   let(:role) { :admin }
+    #
+    #   it { is_expected.to be_allowed }
+    # end
+    #
+    # context 'when user' do
+    #   let(:role) { :user }
+    #
+    #   it { is_expected.to be_denied }
+    # end
+    #
+    # # after
+    # context 'when admin', lets: {role: :admin} do
+    #   it { is_expected.to be_allowed }
+    # end
+    #
+    # context 'when user', lets: {role: :user} do
+    #   it { is_expected.to be_denied }
+    # end
+    #
+    # # you can also give empty descriptions, then they would be auto-generated
+    #
+    # # generates a context with description "with role=:admin"
+    # context '', lets: {role: :admin} do
+    #   it { is_expected.to be_allowed }
+    # end
+    # ```
+    #
+    module Lets
+      def self.included(ctx)
+        lets = ctx.metadata[:lets]
+                  .tap { _1.is_a?(Hash) or fail ArgumentError, "lets: is expected to be a Hash, got #{_1.class}" }
+
+        lets.each { |name, val| ctx.let(name) { val } }
+        ctx.metadata[:description].to_s.empty? and
+          ctx.metadata[:description] = lets.map { "#{_1}=#{_2.inspect}" }.join(', ').prepend('with ')
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Saharspec::Metadata::Lets, :lets
+end

data/lib/saharspec/metadata.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Saharspec
+  # Wrapper module for all RSpec additions available via example or context metadata.
+  #
+  # Note: because including some functionality by context metadata is not obvious,
+  # saharspec doesn't require them by default when you `require 'saharspec'` or
+  # `require 'saharspec/metadata'`, you need to require specifically the functionality
+  # you are planning to use.
+  #
+  # See:
+  #
+  # ## {Lets}
+  #
+  # ```ruby
+  # context 'with admin', lets: {role: :admin} do
+  #   it { is_expected.to be_allowed }
+  # end
+  #
+  # # this is the same as
+  # context 'with admin' do
+  #   let(:role) { :admin }
+  #
+  #   it { is_expected.to be_allowed }
+  # end
+  # ```
+  #
+  module Metadata
+  end
+end

data/lib/saharspec/version.rb

@@ -3,6 +3,6 @@
 module Saharspec
   MAJOR = 0
   MINOR = 0
-  PATCH = 8
+  PATCH = 10
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/lib/saharspec.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+defined?(RSpec) or
+  fail 'RSpec is not present in the current environment, check that `rspec` ' \
+        'is present in your Gemfile and is in the same group as `saharspec`' \
+
 # Umbrella module for all Saharspec RSpec DRY-ing features.
 #
-# See {file:README.md} or {Its} and {Matchers} separately.
+# See {file:README.md} or {Its}, {Matchers}, and {Metadata} separately.
 #
 module Saharspec
 end

data/saharspec.gemspec

@@ -23,14 +23,12 @@ Gem::Specification.new do |s|
   end
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = '>= 2.3.0'
+  s.required_ruby_version = '>= 2.7.0'
 
   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 'rubocop', '~> 0.93'
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saharspec
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
 platform: ruby
 authors:
 - Victor Shepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-10 00:00:00.000000000 Z
+date: 2023-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby2_keywords
@@ -42,14 +42,14 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.7.0
 - !ruby/object:Gem::Dependency
@@ -133,6 +133,7 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- config/rubocop-rspec.yml
 - lib/saharspec.rb
 - lib/saharspec/its.rb
 - lib/saharspec/its/block.rb
@@ -145,6 +146,8 @@ files:
 - lib/saharspec/matchers/request_webmock.rb
 - lib/saharspec/matchers/ret.rb
 - lib/saharspec/matchers/send_message.rb
+- lib/saharspec/metadata.rb
+- lib/saharspec/metadata/lets.rb
 - lib/saharspec/util.rb
 - lib/saharspec/version.rb
 - saharspec.gemspec
@@ -160,14 +163,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Several additions for DRYer RSpec code