db_memoize 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e6c10e2d8dffe1ff21a88e3f1349df1402a4df5
-  data.tar.gz: ee681aef3dc8e05bd34877dc1ec9717486f8000d
+  metadata.gz: 2134329e831a84420b606a2f64aeae8703ebcd7a
+  data.tar.gz: 2abf35de9b06d53424513a0432cb884c73f1f4cd
 SHA512:
-  metadata.gz: 27051ef728eeeeb41e3e5b7927fd1abaa464f7ac3f22e3ab5536a7788f86670f754f0c08feb3768aa4107c1d19f4ce2df38b156bbb3900651f1e29cb7ff19229
-  data.tar.gz: e4ea6308907c9627a61fca6981d0dbc78ac5c179f7425cd2235061a7ebf5a78e692143748cc3cde5eafdfe60147ae082dfd277b726efe0550eae08703bce4f0a
+  metadata.gz: 208ba78d6912596d059e40e4f77f9393025a926c4c973a2599882a6980ce836c008442466d3db0c84fd8e1a9e2a625ca901f26d697f64054abdccf7976c700f9
+  data.tar.gz: 994bdc8506e1886f57276380da78431812d9c74b99c66ea9f02ce9bffef87b1f13e27182c556ba5dab8363f8896de9c4ae9d2442be214a1c324cf007cb416c9f

data/db_memoize.gemspec

@@ -22,12 +22,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'railties', '~> 4.2'
-  spec.add_development_dependency 'activemodel', '~> 4.2'
-  spec.add_development_dependency 'actionpack', '~> 4.2'
-  spec.add_development_dependency 'activesupport', '~> 4.2'
   spec.add_development_dependency 'activerecord', '~> 4.2'
-  spec.add_development_dependency 'activejob', '~> 4.2'
-  spec.add_development_dependency 'arel', '6.0.0'
+
   spec.add_development_dependency 'rake', '~> 10.5'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'rspec-rails', '~> 3.4'
@@ -39,7 +35,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'database_cleaner', '~> 1.5.3'
   spec.add_development_dependency 'factory_girl', '~> 4.7.0'
   spec.add_development_dependency 'ruby-progressbar', '~> 1.7'
-  spec.add_development_dependency 'ffaker'
   spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'gem-release'
 end

data/lib/db_memoize.rb

@@ -4,15 +4,20 @@ require 'digest'
 require 'benchmark'
 require 'db_memoize/version'
 require 'db_memoize/value'
+require 'db_memoize/helpers'
 require 'db_memoize/model'
 require 'db_memoize/railtie' if defined?(Rails)
 
 module DbMemoize
   class << self
-    attr_writer :logger
+    attr_writer :logger, :log_level
 
     def logger
       @logger ||= ::Logger.new(STDOUT)
     end
+
+    def log_level
+      @log_level ||= :debug
+    end
   end
 end

data/lib/db_memoize/helpers.rb

@@ -0,0 +1,18 @@
+module DbMemoize
+  # The Helpers module contains some helper methods, mostly to not pollute
+  # the namespace of memoized objects and classes.
+  module Helpers
+    module_function
+
+    def find_ids(records_or_ids)
+      records_or_ids = Array(records_or_ids)
+      return [] if records_or_ids.empty?
+
+      records_or_ids.first.is_a?(ActiveRecord::Base) ? records_or_ids.map(&:id) : records_or_ids
+    end
+
+    def log(model, method_name, msg)
+      DbMemoize.logger.send(DbMemoize.log_level, "DbMemoize <#{model.class.name} id: #{model.id}>##{method_name} - #{msg}")
+    end
+  end
+end

data/lib/db_memoize/model.rb

@@ -12,18 +12,14 @@ module DbMemoize
       cached_value  = find_memoized_value(method_name, args_hash)
 
       if cached_value
-        log(method_name, 'cache hit')
         value = Marshal.load(cached_value.value)
+        Helpers.log(self, method_name, 'cache hit')
       else
         time = ::Benchmark.realtime do
           value = send("#{method_name}_without_memoize", *args)
+          create_memoized_value(method_name, args_hash, value)
         end
-        # dear rubocop, we can't use `format` here, since some of our models have a
-        # `format` method themselves.
-        # rubocop:disable Style/FormatString
-        log(method_name, "cache miss. took #{sprintf('%.2f', time * 1_000)}ms")
-        # rubocop:enable Style/FormatString
-        create_memoized_value(method_name, args_hash, value)
+        Helpers.log(self, method_name, "cache miss. took #{Kernel.format '%.2f msecs', time * 1_000}")
       end
 
       value
@@ -31,13 +27,22 @@ module DbMemoize
 
     def unmemoize(method_name = :all)
       if method_name != :all
-        # FIXME: this works, but isn't immediately visible on the record
+        # FIXME: this works, but isn't immediately visible on the record.
+        # See also note in create_memoized_value.
         memoized_values.where(method_name: method_name).delete_all
       else
         memoized_values.clear
       end
     end
 
+    #
+    # Used to set multiple memoized values in one go.
+    #
+    # Example:
+    #
+    #   product.memoize_values full_title: "my full title",
+    #                          autocomplete_info: "my autocomplete_info"
+    #
     def memoize_values(values, *args)
       args_hash = ::Digest::MD5.hexdigest(Marshal.dump(args))
 
@@ -49,6 +54,9 @@ module DbMemoize
     private
 
     def create_memoized_value(method_name, args_hash, value)
+      # [TODO] - It would be nice to have an optimized, pg-based inserter
+      #          here, for up to 10 times speed. However, the memoized_values
+      #          array must then be properly reset.
       memoized_values.create!(
         entity_table_name: self.class.table_name,
         method_name: method_name.to_s,
@@ -58,22 +66,22 @@ module DbMemoize
     end
 
     def find_memoized_value(method_name, args_hash)
+      method_name = method_name.to_s
+
       memoized_values.detect do |rec|
-        rec.method_name == method_name.to_s &&
+        rec.method_name == method_name &&
           rec.arguments_hash == args_hash
       end
     end
 
-    def log(method_name, msg)
-      DbMemoize.logger.info "DbMemoize <#{self.class.name} id: #{id}>##{method_name} - #{msg}"
-    end
-
     module ClassMethods
       def db_memoize(method_name)
         @db_memoized_methods ||= []
         @db_memoized_methods.push(method_name.to_sym)
 
-        create_alias_method(method_name)
+        # [TODO] - should the create_memoized_** functions really be called
+        # when the method_name is in @db_memoized_methods already?
+        create_memoized_alias_method(method_name)
         create_memoized_values_association
       end
 
@@ -85,7 +93,7 @@ module DbMemoize
       def unmemoize(records_or_ids, method_name = :all)
         conditions = {
           entity_table_name: table_name,
-          entity_id: find_ids(records_or_ids)
+          entity_id: Helpers.find_ids(records_or_ids)
         }
         conditions[:method_name] = method_name unless method_name == :all
 
@@ -94,7 +102,7 @@ module DbMemoize
 
       def memoize_values(records_or_ids, values, *args)
         transaction do
-          ids        = find_ids(records_or_ids)
+          ids        = Helpers.find_ids(records_or_ids)
           args_hash  = ::Digest::MD5.hexdigest(Marshal.dump(args))
 
           ids.each do |id|
@@ -113,14 +121,7 @@ module DbMemoize
 
       private
 
-      def find_ids(records_or_ids)
-        records_or_ids = Array(records_or_ids)
-        return [] if records_or_ids.empty?
-
-        records_or_ids.first.is_a?(ActiveRecord::Base) ? records_or_ids.map(&:id) : records_or_ids
-      end
-
-      def create_alias_method(method_name)
+      def create_memoized_alias_method(method_name)
         define_method "#{method_name}_with_memoize" do |*args|
           memoized_value(method_name, args)
         end

data/lib/db_memoize/version.rb

@@ -1,3 +1,3 @@
 module DbMemoize
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.1.6'.freeze
 end

data/lib/tasks/warmup.rake

@@ -1,11 +1,15 @@
 namespace :db_memoize do
-  desc "generates memoized values (pass e.g. 'class=Product methods=to_document,to_hash')"
+  desc "generates memoized values (pass e.g. 'CLASS=Product [ METHODS=to_document,to_hash ]')"
   task warmup: :environment do
     require 'ruby-progressbar'
 
-    klass_name = ENV['class']
-    methods    = ENV['methods'].split(',')
+    klass_name = ENV['class'] || ENV['CLASS'] || raise('Missing CLASS environment value')
     klass      = klass_name.constantize
+
+    methods    = ENV['methods'] || ENV['METHODS']
+    methods    = methods.split(',') if methods
+    methods    ||= klass.db_memoized_methods.map(&:to_s)
+
     count      = klass.count
 
     progressbar = ProgressBar.create(
@@ -17,7 +21,8 @@ namespace :db_memoize do
       remainder_mark: '.'
     )
 
-    klass_name.constantize.find_each do |record|
+    klass.find_each do |record|
+      # calling each method will build the cached entries for these objects.
       methods.each do |meth|
         record.send(meth)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_memoize
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - johannes-kostas goetzinger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,48 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: activemodel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -80,34 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: activejob
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: arel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 6.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -262,20 +192,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: ffaker
-  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: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -323,6 +239,7 @@ files:
 - bin/setup
 - db_memoize.gemspec
 - lib/db_memoize.rb
+- lib/db_memoize/helpers.rb
 - lib/db_memoize/migrations.rb
 - lib/db_memoize/model.rb
 - lib/db_memoize/railtie.rb