short_circu_it 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fcdddba43f8cac401f3a4d6998089348572453118ac95231bdf25e669b7a8316
+  data.tar.gz: 1077aedbd2bebdc80cf08583e0b2e0ba549cd4b7ff3876b37364494d7e4a550c
+SHA512:
+  metadata.gz: '0388a2743f8cf78f1146fab8843340eb087b0e55c687a525ea543bed09e8db366d162d962937e7fcb80922664aa33f067914ebadc768e414b3c8159bb00ca787'
+  data.tar.gz: 819206d14daa6a4c218262a48754cb270eaa375ab4128b90b332139436f77eb1bd52c8f1a4768325b40838a1a7179a3dcafde440c69d8f0e6f096ff28ccc8f0f

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Allen Rettberg
+
+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,39 @@
+# ShortCircuIt
+
+[![Build Status](https://semaphoreci.com/api/v1/freshly/spicerack/branches/master/badge.svg)](https://semaphoreci.com/freshly/spicerack)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7e089c2617c530a85b17/maintainability)](https://codeclimate.com/github/Freshly/spicerack/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/7e089c2617c530a85b17/test_coverage)](https://codeclimate.com/github/Freshly/spicerack/test_coverage)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'short_circu_it'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install short_circu_it
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Freshly/spicerack.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/short_circu_it.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "short_circu_it/version"
+require "short_circu_it/memoization_store"
+require "active_support/core_ext/module"
+require "active_support/core_ext/array"
+require "active_support/concern"
+require "around_the_world"
+
+module ShortCircuIt
+  extend ActiveSupport::Concern
+  include AroundTheWorld
+
+  PREPEND_MODULE_NAME = "MemoizedMethods"
+
+  included do
+    delegate :memoization_observers, to: :class
+    delegate :clear_memoization, :clear_all_memoization, to: :memoization_store
+  end
+
+  private
+
+  # @return [ShortCircuIt::MemoizationStore]
+  def memoization_store
+    @memoization_store ||= MemoizationStore.new(self)
+  end
+
+  class_methods do
+    attr_internal_reader :memoization_observers
+
+    protected
+
+    # @example
+    #   def expensive_method
+    #     puts "doing some really expensive operation here!"
+    #     "these datas are yuuge"
+    #   end
+    #   memoize :expensive_method
+    #
+    #   expensive_method
+    #   doing some really expensive operation here!
+    #   => "these datas are yuuge"
+    #   expensive_method
+    #   => "these datas are yuuge"
+    #
+    # @example
+    #   def some_association
+    #     SomeAssociation.find(some_association_id)
+    #   end
+    #   memoize :some_association, observes: :some_association_id
+    #
+    #   some_association_id = 1
+    #   some_association
+    #   * database stuff *
+    #   => #<SomeAssociation:1234 id: 1>
+    #
+    #   some_association
+    #   * no database stuff *
+    #   => #<SomeAssociation:1234 id: 1>
+    #
+    #   some_association_id = 2
+    #   some_association
+    #   * database stuff *
+    #   => #<SomeAssociation:2468 id: 2>
+    #
+    # @param method_name [Symbol] The name of the method to be memoized
+    # @param :observes [Symbol, Array<Symbol>] A method or array of methods to be observed to determine memoization
+    #                                          cache validity. If any of the observed values change, the cached
+    #                                          value will be invalidated. By default, the object will observe itself.
+    def memoize(method_name, observes: :itself)
+      add_memoized_observers(method_name.to_sym, observes)
+
+      around_method method_name.to_sym, PREPEND_MODULE_NAME do |*args|
+        memoization_store.memoize(method_name.to_sym, args.hash) do
+          super(*args)
+        end
+      end
+    end
+
+    private
+
+    attr_internal_writer :memoization_observers
+
+    def add_memoized_observers(method_name, observers)
+      # TODO: Raise an error if method has already been memoized? A warning maybe?
+      self.memoization_observers ||= {}
+      self.memoization_observers = memoization_observers.
+        merge(method_name.to_sym => Array.wrap(observers).freeze).
+        freeze
+    end
+  end
+end

data/lib/short_circu_it/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class MemoizationStore
+  class NotMemoizedError < StandardError; end
+end

data/lib/short_circu_it/memoization_store.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/module"
+
+module ShortCircuIt
+  class MemoizationStore
+    delegate :memoization_observers, to: :owner
+
+    # @param owner [*] The object being memoized
+    def initialize(owner)
+      @owner = owner
+    end
+
+    # @param method_name [Symbol] The name of the method being memoized.
+    # @param argument_hash [Integer] The hash value of the arguments passed to the method.
+    # @yield [] Yields to a given block with no arguments. Memoizes the value returned by the block.
+    # @return [*] The value returned either from the memoization cache if present, or yielded block if not.
+    def memoize(method_name, argument_hash)
+      return memoized_value(method_name, argument_hash) if memoized?(method_name, argument_hash)
+
+      clear_memoization(method_name) unless current_memoization_for_method?(method_name)
+
+      yield.tap do |returned_value|
+        current_memoization_for_method(method_name)[argument_hash] = returned_value
+      end
+    end
+
+    # Clears all cached values for the given method
+    #
+    # @param method_name [Symbol] The name of a memoized method
+    # @return [Boolean] True if a value was cleared, false if not
+    def clear_memoization(method_name)
+      !!memoized_hash.delete(method_name)
+    end
+
+    # Clears all memoized values on the object
+    def clear_all_memoization
+      memoized_hash.clear
+    end
+
+    def inspect
+      "#<#{self.class} memoized: #{memoized_hash.keys.inspect}>"
+    end
+
+    private
+
+    def memoized_hash
+      @memoized_hash ||= {}
+    end
+
+    def memoization_for_method(method_name)
+      memoized_hash[method_name] ||= {}
+    end
+
+    # @param method_name [Symbol] The name of the method to memoize
+    # @param argument_hash [Integer] The hash value of the arguments passed to the method
+    # @return [Boolean] True if the method has a current memoized value with the given arguments
+    def memoized?(method_name, argument_hash)
+      current_memoization_for_method?(method_name) && current_memoization_for_method(method_name).key?(argument_hash)
+    end
+
+    # @param method_name [String] The name of the method to memoize
+    # @param argument_hash [Integer] The hash value of the arguments passed to the method
+    # @return [*] The value that has been memoized for the method/argument combination
+    def memoized_value(method_name, argument_hash)
+      raise NotMemoizedError unless memoized?(method_name, argument_hash)
+
+      current_memoization_for_method(method_name)[argument_hash]
+    end
+
+    # @param method_name [Symbol] The name of a memoized method
+    # @return [Hash] A hash of memoized values for the current state of the observed objects for the given method.
+    def current_memoization_for_method(method_name)
+      memoization_for_method(method_name)[state_hash(method_name)] ||= {}
+    end
+
+    # @param method_name [Symbol] The name of a memoized method
+    # @return [Boolean] True if there are any memoized values for the current state of the observed objects.
+    def current_memoization_for_method?(method_name)
+      memoization_for_method(method_name).key?(state_hash(method_name))
+    end
+
+    # @param method_name [Symbol] The name of a memoized method
+    # @return [Integer] The hash value of all observed objects for the given method.
+    def state_hash(method_name)
+      memoization_observers[method_name].map { |observed_method| owner.public_send(observed_method) }.hash
+    end
+
+    attr_reader :owner
+  end
+end

data/lib/short_circu_it/version.rb

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

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: short_circu_it
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Allen Rettberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+- !ruby/object:Gem::Dependency
+  name: around_the_world
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Memoize methods safely with parameter and dependency observation
+email:
+- allen.rettberg@freshly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/short_circu_it.rb
+- lib/short_circu_it/errors.rb
+- lib/short_circu_it/memoization_store.rb
+- lib/short_circu_it/version.rb
+homepage: https://www.freshly.com/
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Effortless memoization
+test_files: []