rspec_let_cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b4ce26af49150f5bcdae369e2111051f1e53e8b43d38b765dd79e2dbc1724c3
+  data.tar.gz: 8e71e98b2d9bacafe489ff6251821c071455184e49a6fe6c21e1518bfefe90b7
+SHA512:
+  metadata.gz: 3ae418e2b70a335b7eaa71035ee74de0814807d2208526f62535a47e9936068c4d3029773775393fc49f15b8eb6d0757a57899904b37de2c58f09922b156f3ab
+  data.tar.gz: 5eb0fce3abd82c3cbf1a4b1c31f86f3549ba9caf276a5c0f9e4bd0a4342c6e6163c87e1a492e9656bc4ed96465d5d1a577e887e81315bef77ad2ab0a04f59132

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# RspecLetCache
+This gem permits to cache rspec test values used/shared across tests and thus, it reduces dramatically the time to run involved tests.
+
+Results for "features" example:
+![A test image](docs/image.png)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'rspec_let_cache'
+end
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Load dependency to be available in your tests
+```ruby
+# spec/spec_helper.rb
+require 'rspec_let_cache'
+```
+
+## Examples
+### Reusing controller response
+```ruby
+describe 'when checking response content', type: :controller do
+  render_views
+  let_cache(:articles_cached) do
+    [Article.create!(title: 'article 1'), Article.create!(title: 'article 2')]
+  end
+  let_cache(:response_cached) do
+    articles_cached
+    get :index
+    response
+  end
+
+  it 'includes first article\'s title' do
+    expect(response_cached.body).to include(articles_cached.first.title)
+  end
+
+  it 'includes second article\'s title' do
+    expect(response_cached.body).to include(articles_cached.second.title)
+  end
+end    
+```
+
+### Reusing features page content
+```ruby
+describe 'index page', type: :feature do
+  let_cache(:articles_cached) do
+    [Article.create!(title: 'article 1'), Article.create!(title: 'article 2')]
+  end
+  let_cache(:page_cached) do
+    articles_cached
+    visit articles_path
+    page
+  end
+  before { allow(page_cached).to receive(:reset!) } # Make capybara page to be reusable
+  
+  describe 'when checking page content' do
+    it 'includes first article' do
+      expect(page_cached).to have_content(articles_cached.first.title)
+    end
+  
+    it 'includes second article' do
+      expect(page_cached).to have_content(articles_cached.second.title)
+    end
+  
+    it 'includes button to delete' do
+      expect(page_cached).to have_css('#articles_table .edit_button')
+    end
+  end
+end
+```
+  Note: Articles page is visited just one time.
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/rspec_let_cache/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RspecLetCache
+  VERSION = '0.1.0'
+end

data/lib/rspec_let_cache.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'rspec_let_cache/version'
+require 'rspec'
+module RspecLetCache
+  class RspecLetCacheObj
+  end
+
+  # Permits to cache block results across tests and improve related tests performance
+  # @example
+  #   describe "articles index page" do
+  #     let_cached(:article_cached) { Article.create!(title: 'sample title') }
+  #     let_cached(:page_cached) do
+  #       visit articles_path
+  #       page
+  #     end
+  #     before { allow(page_cached).to receive(:reset!) }
+  #     it 'includes page title' { expect(page_cached).to have_css('header h1', text: "Articles") }
+  #     it 'includes articles' { expect(page_cached).to have_content(article_cached.title) }
+  #     it 'includes button to delete article' { expect(page_cached).to have_css('table.articles_table .btn-delete') }
+  #     it 'includes button to edit article' { expect(page_cached).to have_css('table.articles_table .btn-edit') }
+  #   end
+  def let_cache(attr_name, after_all: nil, &block)
+    var_name = "@#{attr_name}"
+    let(attr_name) do
+      already_saved = RspecLetCacheObj.instance_variable_defined?(var_name)
+      RspecLetCacheObj.instance_variable_set(var_name, instance_exec(&block)) unless already_saved
+      RspecLetCacheObj.instance_variable_get(var_name)
+    end
+    after(:all) { RspecLetCacheObj.instance_variable_get(var_name)&.send(after_all) if after_all }
+    after(:all) { RspecLetCacheObj.remove_instance_variable(var_name) rescue nil } # rubocop:disable Style/RescueModifier
+  end
+end
+
+RSpec.configure do |config|
+  config.extend RspecLetCache
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: rspec_let_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owen Peredo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Permit to cache let variables across tests
+email:
+- owenperedo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rspec_let_cache.rb
+- lib/rspec_let_cache/version.rb
+homepage: http://github.com/owen2345/rspec_let_cache
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/owen2345/rspec_let_cache
+  source_code_uri: http://github.com/owen2345/rspec_let_cache
+  changelog_uri: http://github.com/owen2345/rspec_let_cache
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Permit to cache let variables across tests
+test_files: []