rspec_in_context 1.0.1.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08306b0c06181ef96f4acdc36980f27792715378cb624eb7ba633c4945e90c7e'
-  data.tar.gz: 2cd8c33b01f3ebcb9720e43bcc4cba0fc4562808681f040ca10cc47816e33c27
+  metadata.gz: 1483e9b55b3cabffad15491bec3e5c3f006b421c4fa62099cce8effc4bf428b3
+  data.tar.gz: 92e35ec980fa84397bb5b33f39e6302825c8ae60aaa581cc009befa507f9b98e
 SHA512:
-  metadata.gz: 0c91690c0ad28afc64c1999a1bcdfa6c0e51556f808b7cf337ea9d2ec59ebf01b50d03a492bd96957596d319a1a69204232a001bc432c6001c5cd6a69e0b4316
-  data.tar.gz: 4d3b90906fbe61f9485c6f415e86b24dbb7d44343e87c0015915899f384bbae10f1044fbcf4b90cb585ef238fbbee65edb1e4b573968804d8f77a8a7203233be
+  metadata.gz: 6f2b2c8e5a4f5b65692b73cb81558a4aaaed3797da5b3aded5b3dc1ff8e943d3968f68df69007d9d15864ca1d14b934f7c51a57fc2a48d6a2757ab63c494ba4f
+  data.tar.gz: 6fd7be08a125054917af01ba365d34a2dcae63895f4aba95731e001dbd7fd757d4d617049e6f9d36ca576d817d35c543f76ae8fb10dc0172ff94bd2289e06217

data/.github/workflows/test_and_publish.yml

@@ -6,7 +6,10 @@ on:
       - main
 
 jobs:
-  test-2_5:
+  tests:
+    strategy:
+      matrix:
+        ruby: [2.5, 2.6, 2.7, 3.0]
     runs-on: ubuntu-latest
 
     steps:
@@ -14,52 +17,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.5
-    - name: Install dependencies
-      run: bundle install
-    - name: Run linter
-      run: bundle exec rubocop
-    - name: Run tests
-      run: bundle exec rspec
-  test-2_6:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.6
-    - name: Install dependencies
-      run: bundle install
-    - name: Run linter
-      run: bundle exec rubocop
-    - name: Run tests
-      run: bundle exec rspec
-  test-2_7:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7
-    - name: Install dependencies
-      run: bundle install
-    - name: Run linter
-      run: bundle exec rubocop
-    - name: Run tests
-      run: bundle exec rspec
-  test-3_0:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.0
+        ruby-version: ${{ matrix.ruby }}
     - name: Install dependencies
       run: bundle install
     - name: Run linter
@@ -67,7 +25,7 @@ jobs:
     - name: Run tests
       run: bundle exec rspec
   release:
-    needs: [test-2_5, test-2_6, test-2_7, test-3_0]
+    needs: [tests]
     runs-on: ubuntu-latest
 
     steps:
@@ -84,5 +42,7 @@ jobs:
       run: "mkdir -p ~/.gem && echo -e \"---\\r\\n:rubygems_api_key: $RUBYGEM_KEY\" > ~/.gem/credentials && chmod 0600 ~/.gem/credentials"
     - name: Setup username/email
       run: "git config --global user.email zaratan@hey.com && git config --global user.name \"Denis <Zaratan> Pasin\""
-    - name: Publish
-      run: rake release
+    - name: Fetch tags from remote
+      run: "git fetch -t"
+    - name: Publish if version change
+      run: 'git diff `git tag | tail -1` lib/rspec_in_context/version.rb | grep -E "^\+.*VERSION" && rake release || echo "No release for now"'

data/.github/workflows/test_only.yml

@@ -6,7 +6,10 @@ on:
       - main
 
 jobs:
-  test-2_5:
+  tests:
+    strategy:
+      matrix:
+        ruby: [2.5, 2.6, 2.7, 3.0]
     runs-on: ubuntu-latest
 
     steps:
@@ -14,52 +17,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.5
-    - name: Install dependencies
-      run: bundle install
-    - name: Run linter
-      run: bundle exec rubocop
-    - name: Run tests
-      run: bundle exec rspec
-  test-2_6:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.6
-    - name: Install dependencies
-      run: bundle install
-    - name: Run linter
-      run: bundle exec rubocop
-    - name: Run tests
-      run: bundle exec rspec
-  test-2_7:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7
-    - name: Install dependencies
-      run: bundle install
-    - name: Run linter
-      run: bundle exec rubocop
-    - name: Run tests
-      run: bundle exec rspec
-  test-3_0:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.0
+        ruby-version: ${{ matrix.ruby }}
     - name: Install dependencies
       run: bundle install
     - name: Run linter

data/.rubocop.yml

@@ -18,6 +18,10 @@ Metrics/BlockLength:
     - 'vendor/bundle'
     - '*.gemspec'
 
+Style/GlobalVars:
+  Exclude:
+    - spec/rspec_in_context/in_context_spec.rb
+
 Naming/MethodParameterName:
   Enabled: false
 

data/CHANGELOG.md

@@ -6,10 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0] - 2020-12-27
+### Added
+- **BREAKING** Option to silence in_context block. They used to always wrap themself into a context block with their name. This is not the case anymore. All in_context are silent unless explicitely declared as not. 
+
 ## [1.0.1.2] - 2020-12-26
 ### Added
 - Changelog
 - Support ruby 3.0
 
-[Unreleased]: https://github.com/zaratan/active_shotgun/compare/v1.0.1.2...HEAD
-[1.0.1.2]: https://github.com/zaratan/active_shotgun/releases/tag/v1.0.1.2
+[Unreleased]: https://github.com/zaratan/rspec_in_context/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/zaratan/rspec_in_context/releases/tag/v1.1.0
+[1.0.1.2]: https://github.com/zaratan/rspec_in_context/releases/tag/v1.0.1.2

data/README.md

@@ -219,6 +219,54 @@ in_context "namespaced context", namespace: "namespace name"
 in_context "namespaced context", ns: "namespace name"
 ```
 
+#### Making `in_context` adverstise itself
+
+The fact that a `in_context` block is used inside the test is silent and invisible by default.
+
+But, there's some case where it helps to make the `in_context` to wrap its execution in a `context` block.
+For example:
+```ruby
+define_context "with my_var defined" do
+  before do
+    described_class.set_my_var(true)
+  end
+
+  it "works"
+end
+
+define_context "without my_var defined" do
+  it "doesn't work"
+end
+
+RSpec.describe MyNiceClass do
+  in_context "with my_var defined"
+  in_context "without my_var defined"
+end
+```
+Using a `rspec -f doc` will only print "MyNiceClass works" and "MyNiceClass doesn't work" which is not really a good documentation.
+
+So, you can define a context specifying it not to be `silent` or to `print_context`.
+For example :
+```ruby
+define_context "with my_var defined", silent: false do
+  before do
+    described_class.set_my_var(true)
+  end
+
+  it "works"
+end
+
+define_context "without my_var defined", print_context: true do
+  it "doesn't work"
+end
+
+RSpec.describe MyNiceClass do
+  in_context "with my_var defined"
+  in_context "without my_var defined"
+end
+```
+Will print "MyNiceClass with my_var defined works" and "MyNiceClass without my_var defined doesn't work". Which is valid and readable documentation.
+
 ## Development
 
 

data/lib/rspec_in_context.rb

@@ -21,9 +21,12 @@ module RSpec
   # @param name [String, Symbol] Name of the defined context
   # @param namespace [String, Symbol] Namespace where to store your context
   # @param ns Alias of namespace
+  # @param silent [Boolean] Does the in_context should wrap itself into a context block with its name
+  # @param print_context [Boolean] Reverse alias of silent
   # @param block [Proc] code that will be injected later
-  def self.define_context(name, namespace: nil, ns: nil, &block)
+  def self.define_context(name, namespace: nil, ns: nil, silent: true, print_context: nil, &block)
     namespace ||= ns
-    RspecInContext::InContext.outside_define_context(name, namespace, &block)
+    silent = print_context.nil? ? silent : !print_context
+    RspecInContext::InContext.outside_define_context(name, namespace, silent, &block)
   end
 end

data/lib/rspec_in_context/in_context.rb

@@ -6,7 +6,12 @@ module RspecInContext
   class NoContextFound < StandardError; end
 
   # Context struct
-  Context = Struct.new(:block, :owner, :name, :namespace)
+  # @attr [Proc] block what will be executed in the test context
+  # @attr [Class] owner current rspec context class. This will be used to know where a define_context has been defined
+  # @attr [String | Symbol] name represent the name by which the context can be find.
+  # @attr [String | Symbol] namespace namespace for context names to avoid collisions
+  # @attr [Boolean] silent does the in_context should wrap itself into a context with its name upon execution
+  Context = Struct.new(:block, :owner, :name, :namespace, :silent)
 
   # Main module containing almost every methods
   module InContext
@@ -29,10 +34,10 @@ module RspecInContext
       # @api private
       #
       # @note Will warn if a context is overriden
-      def add_context(context_name, owner = nil, namespace = nil, &block)
+      def add_context(context_name, owner = nil, namespace = nil, silent = true, &block) # rubocop:disable Style/OptionalBooleanParameter
         namespace ||= GLOBAL_CONTEXT
         warn("Overriding an existing context: #{context_name}@#{namespace}") if contexts[namespace][context_name]
-        contexts[namespace][context_name] = Context.new(block, owner, context_name, namespace)
+        contexts[namespace][context_name] = Context.new(block, owner, context_name, namespace, silent)
       end
 
       # Find a context.
@@ -63,8 +68,8 @@ module RspecInContext
 
       # @api private
       # Define a context from outside a RSpec.describe block
-      def outside_define_context(context_name, namespace, &block)
-        InContext.add_context(context_name, nil, namespace, &block)
+      def outside_define_context(context_name, namespace, silent, &block)
+        InContext.add_context(context_name, nil, namespace, silent, &block)
       end
     end
 
@@ -80,8 +85,13 @@ module RspecInContext
       def in_context(context_name, *args, namespace: nil, ns: nil, &block)
         namespace ||= ns
         Thread.current[:test_block] = block
+        context_to_exec = InContext.find_context(context_name, namespace)
+        if context_to_exec.silent
+          return instance_exec(*args, &context_to_exec.block)
+        end
+
         context(context_name.to_s) do
-          instance_exec(*args, &InContext.find_context(context_name, namespace).block)
+          instance_exec(*args, &context_to_exec.block)
         end
       end
 
@@ -102,12 +112,15 @@ module RspecInContext
       #   It helps reducing colisions when you define "global" contexts
       # @param ns [String, Symbol] Alias of namespace
       # @param block [Proc] Contain the code that will be injected with #in_context later
+      # @param silent [Boolean] Does the in_context should wrap itself into a context block with its name
+      # @param print_context [Boolean] Reverse alias of silent
       #
       # @note contexts are scoped to the block they are defined in.
-      def define_context(context_name, namespace: nil, ns: nil, &block)
+      def define_context(context_name, namespace: nil, ns: nil, silent: true, print_context: nil, &block)
         namespace ||= ns
+        silent = print_context.nil? ? silent : !print_context
         instance_exec do
-          InContext.add_context(context_name, hooks.instance_variable_get(:@owner), namespace, &block)
+          InContext.add_context(context_name, hooks.instance_variable_get(:@owner), namespace, silent, &block)
         end
       end
     end

data/lib/rspec_in_context/version.rb

@@ -2,5 +2,5 @@
 
 module RspecInContext
   # Version of the gem
-  VERSION = "1.0.1.2"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_in_context
 version: !ruby/object:Gem::Version
-  version: 1.0.1.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Denis <Zaratan> Pasin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-25 00:00:00.000000000 Z
+date: 2020-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport