dememoize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8c7f5057cf01e4f06611fad7b1545f4594adcd564b8b094563c9eeee6e278628
+  data.tar.gz: db3ce11f1c3fc50f9bd35ad37992114730acdcd130dd102110fb7e7ad99db0c2
+SHA512:
+  metadata.gz: ab5799fb52990b8d84280542a29cb73d04a6d77bbc71e17f7a706262ac0620868b74f6d605c67c03e78947fb08bb6896b2c5c3b43790c28e5c77e27347f32dc7
+  data.tar.gz: b07ab5360ea302854486dc6bf27b1b13de458394733eb2448b086b3be088853de00cd19cae2a629ff948c0395e63b3b137cf92748fb0bf764956f000efeb6277

data/README.md

@@ -0,0 +1,126 @@
+dememoize
+=========
+
+[![Gem Version](https://badge.fury.io/rb/dememoize.svg)](https://badge.fury.io/rb/dememoize)
+
+## Description
+
+`dememoize` is a gem that provides a method to remove a memoized value (an instance variable) from a
+class or an object instance.
+
+The primary use case is usage in spec tests. If you have a code that memoizes a value, but you
+would like to check that the value is calculated differently under different circumstances, you can
+use `dememoize` to remove the memoized value, leaving you free to add another spec that can check
+the value again.
+
+eg:
+
+```ruby
+class Product
+  class << self 
+    def categories
+      @categories ||= expensive_calculation
+    end
+  end
+end
+
+describe "test different memoized values based on environment" do
+  # Here is the shared_context that dememoize provides that aids with the specs
+  include_context "with dememoized class variable", :@categories
+  
+  it "should return one value for prelive" do
+    expect(Rails).to receive(:env).and_return("prelive")
+    expect(Product.categories).to eq(1)
+  end
+  
+  it "should return another value for production" do
+    expect(Rails).to receive(:env).and_return("production")
+    expect(Product.categories).to eq(2)
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dememoize'
+```
+
+## Simple usage
+
+You can dememoize an instance:
+
+```ruby
+class Car
+  def bolts
+    @bolts ||= expensive_calculation
+  end
+end
+
+car = Car.new
+car.bolts # => 28376
+car.dememoize(:@bolts)
+car.instance_variable_defined?(:@bolts) # => false
+
+# You can also specify the instance variable name as a string
+car.bolts # => 28376
+car.dememoize("@bolts")
+car.instance_variable_defined?(:@bolts) # => false
+```
+
+You can dememoize a class variable:
+
+```ruby
+class Product
+  class << self
+    def categories
+      @categories ||= expensive_calculation
+    end
+  end
+end
+
+Product.categories # => 4324
+Product.dememoize(:@categories)
+Product.instance_variable_defined?(:@categories) # => false
+```
+
+## Usage with RSpec
+
+`dememoize` comes with rspec context helpers to dememoize a class variable in a spec:
+
+```ruby
+# In this example, dememoize assumes that the class under test is the object that should have the
+# class instance variable removed.
+describe "without specifying a class it uses described_class" do
+  include_context "with dememoized class variable", :@categories
+  
+  it "should return one value for prelive" do
+    expect(Rails).to receive(:env).and_return("prelive")
+    expect(Product.categories).to eq(1234)
+  end
+  
+  it "should return another value for production" do
+    expect(Rails).to receive(:env).and_return("production")
+    expect(Product.categories).to eq(5678)
+  end
+end
+
+# If you want to dememoize a class variable on a different class, you can pass the class as the
+# first argument to dememoized.
+
+describe "specify a different class (Bar) to dememoize" do
+  include_context "with dememoized class variable", :@categories, Bar # <-- Bar is the class
+  # ...
+end
+```
+
+## Upgrading
+
+`dememoize` uses [semantic versioning](https://semver.org/), so major version changes will usually 
+require additional actions to be taken upgrading from one major version to another. 
+
+## Changelog
+
+A full changelog can be found here: [CHANGELOG.md](https://github.com/hlascelles/dememoize/blob/master/CHANGELOG.md)

data/lib/dememoize/rspec_dememoize.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+return unless Gem.loaded_specs["rspec"]
+
+require "rspec/core"
+
+module RSpec
+  module Dememoize
+    class << self
+      def included(base)
+        base.extend Dememoize
+      end
+    end
+  end
+end
+
+RSpec.shared_context "with dememoized variable" do |name, object:|
+  around(:each) do |example|
+    Dememoize.remove_instance_variable_if_defined(object, name)
+    example.run
+    Dememoize.remove_instance_variable_if_defined(object, name)
+  end
+end
+
+RSpec.shared_context "with dememoized class variable" do |name, clazz: described_class|
+  around(:each) do |example|
+    Dememoize.remove_instance_variable_if_defined(clazz, name)
+    example.run
+    Dememoize.remove_instance_variable_if_defined(clazz, name)
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Dememoize
+end

data/lib/dememoize/version.rb

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

data/lib/dememoize.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "dememoize/version"
+require "dememoize/rspec_dememoize"
+
+module Dememoize
+  def dememoize(obj, *instance_variables)
+    use_names = if instance_variables.empty?
+                  obj.instance_variables
+                else
+                  instance_variables
+                end
+    use_names.each do |name|
+      remove_instance_variable_if_defined(obj, name)
+    end
+  end
+
+  def remove_instance_variable_if_defined(obj, name)
+    return unless obj.instance_variable_defined?(name)
+
+    obj.remove_instance_variable(name)
+  end
+
+  module_function :dememoize, :remove_instance_variable_if_defined
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: dememoize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Harry Lascelles
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fasterer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  A gem to clean up memoization. This is useful for testing, where you want to
+  ensure that a method is called again after a change to the object.
+email:
+- harry@harrylascelles.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/dememoize.rb
+- lib/dememoize/rspec_dememoize.rb
+- lib/dememoize/version.rb
+homepage: https://github.com/hlascelles/dememoize
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hlascelles/dememoize
+  documentation_uri: https://github.com/hlascelles/dememoize
+  changelog_uri: https://github.com/hlascelles/dememoize/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/hlascelles/dememoize/
+  bug_tracker_uri: https://github.com/hlascelles/dememoize/issues
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A gem to clean up memoization
+test_files: []