saharspec 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f36fea6becab89824a594297f3eb830f98277a412b304ba439f8c97cc2d84ff
-  data.tar.gz: c62d07b013183f8425a7775fb653f63958cb9a24c66ae5f84a34717df2c8e06d
+  metadata.gz: 9409e96bf31ffafcb98955b97ab75e2b78547b5d5bf5dc405f22f21fd62ff77c
+  data.tar.gz: b9d1cda3cd2796576612b4e888cf8fd97a9b39357c56417c293628958722bdb3
 SHA512:
-  metadata.gz: 216ee5c533e3e54e05ea03cdb12da2d582d7fa5d5dda82ac5ea9cb83eba22acb2f5eccf3257f644f224f79baa1e4879b6191de4c64d4aafd6be1fc67d58d2372
-  data.tar.gz: 2495db0a5cb29fcde39b6057f2789c0bcb70d71c53254f677ab8e8308abed99a8c2cd3bd70f8051fba29fed3e253e8537704f028ad4edf431ceafb41c8253b8c
+  metadata.gz: e10c863c94b4099cd6322029eda5129aec7cb12ddfae032c71a37436731f86189c8f1494a5f71d29e6eb17764ba4f6ad06e7f9a9ada6486d123aac0036d1d32a
+  data.tar.gz: d229e1aa4ecfa492f15b57b4249e51ae7cdf0805895f4a465a1ade675949a13526d3052e719b4abed0b98c858461aa5b30115642425883df0c66f0039728c766

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # 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))

data/README.md

@@ -250,6 +250,49 @@ 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`).

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 = 9
+  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,13 +23,11 @@ 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 'rubocop', '~> 0.93'
   s.add_development_dependency 'rspec', '>= 3.7.0'
   s.add_development_dependency 'rspec-its'
   s.add_development_dependency 'simplecov', '~> 0.9'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saharspec
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Victor Shepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-17 00:00:00.000000000 Z
+date: 2023-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby2_keywords
@@ -146,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
@@ -161,7 +163,7 @@ 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:
   - - ">="