memery 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2592e62955d94ec822ac01546d7914e4a1b1bac3cf767f133c0bb9d2740d797c
-  data.tar.gz: d55627dd3396a960fb16509986b7843b2507cdc522f04b1c16a1b78c2e367dc8
+  metadata.gz: 3a2db1b80dc2da0ad38dea657f09a1f4a029017d5c67610e27a71af3aeb9aef4
+  data.tar.gz: b2e8bc1c499d2462096b0b4045c41de110ea8ea27b5750e23cbdf1a74c57d9f9
 SHA512:
-  metadata.gz: edbfaefbbfd51dcac0b99a690e065c291f66b20534e5252fa074ee8c7cc83f3256c5cae63abd63f2d1de8c6fb1ca1253e1969ac36c9098ec8fad518d60b39795
-  data.tar.gz: 50617bebf3b45b586a55d41267835dbbecba826bcb9be8c5a7392b6661a7019eaa1de95745a024c3e437796df7e94537b2affe6942597b5a855bcfa1d3c7c30c
+  metadata.gz: 813057c9b895b2b789a75c48ea49366a9a951494e90d07a21a628b46ed2bda35e3f9a8407a5efcbf0bf73712ddaff6002d8685e083d6b767e8c52d3102b65743
+  data.tar.gz: 24a8b9ef7c10341336e301f6e9c09644101fd7c593f9535483cdbf8360ac8ac003d94869200303269fb8d3c6b7103675f7691a7c5d46b31acfd74f5f40b19a59

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+.ruby-version
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -4,3 +4,9 @@ inherit_gem:
 AllCops:
   DisplayCopNames: true
   TargetRubyVersion: 2.5
+
+Naming/UncommunicativeMethodParamName:
+  AllowedNames: ["x", "y", "z"]
+
+RSpec/EmptyLineAfterHook:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+## [Unreleased]
+
+## [1.0.0] - 2018-08-31
+### Added
+- Add `:condition` option for `.memoize` method ([@AlexWayfer]) [#7]
+
+## [0.6.0] - 2018-04-20
+### Added
+- Readme example for memoizing class methods. ([@AlexWayfer]) [#3]
+- Memery raises `ArgumentError` if method is not defined when you call `memoize`.
+
+## [0.5.0] - 2017-16-12
+- Initial public version.
+
+[0.5.0]: https://github.com/tycooon/memery/tree/v0.5.0
+[0.6.0]: https://github.com/tycooon/memery/compare/v0.5.0...v0.6.0
+[1.0.0]: https://github.com/tycooon/memery/compare/v0.6.0...v1.0.0
+[Unreleased]: https://github.com/tycooon/memery/compare/v0.6.0...HEAD
+
+[@tycooon]: https://github.com/tycooon
+[@AlexWayfer]: https://github.com/AlexWayfer
+
+[#3]: https://github.com/tycooon/memery/pull/3
+[#7]: https://github.com/tycooon/memery/pull/7

data/Gemfile

@@ -2,3 +2,5 @@
 
 source "https://rubygems.org"
 gemspec
+
+gem "rubocop-config-umbrellio", github: "umbrellio/code-style"

data/README.md

@@ -81,6 +81,41 @@ B.call # => 42
 # Text will be printed only once.
 ```
 
+For conditional memoization:
+
+```ruby
+class A
+  include Memery
+
+  attr_accessor :environment
+
+  def call
+    puts "calculating"
+    42
+  end
+
+  memoize :call, condition: -> { environment == 'production' }
+end
+
+a = A.new
+a.environment = 'development'
+a.call # => 42
+# calculating
+a.call # => 42
+# calculating
+a.call # => 42
+# calculating
+# Text will be printed every time because result of condition block is `false`.
+
+a.environment = 'production'
+a.call # => 42
+# calculating
+a.call # => 42
+a.call # => 42
+# Text will be printed only once because there is memoization
+# with `true` result of condition block.
+```
+
 ## Difference with other gems
 Memery is very similar to [Memoist](https://github.com/matthewrudy/memoist). The difference is that it doesn't override methods, instead it uses Ruby 2 `Module.prepend` feature. This approach is cleaner and it allows subclasses' methods to work properly: if you redefine a memoized method in a subclass, it's not memoized by default, but you can memoize it normally (without using awkward `identifier: ` argument) and it will just work:
 
@@ -136,6 +171,9 @@ a.users {}
 
 However, this solution is kind of hacky.
 
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/tycooon/memery.
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 

data/lib/memery.rb

@@ -20,9 +20,9 @@ module Memery
   end
 
   module ClassMethods
-    def memoize(method_name)
+    def memoize(method_name, condition: nil)
       prepend_memery_module!
-      define_memoized_method!(method_name)
+      define_memoized_method!(method_name, condition: condition)
     end
 
     private
@@ -33,14 +33,16 @@ module Memery
       prepend @_memery_module
     end
 
-    def define_memoized_method!(method_name)
+    def define_memoized_method!(method_name, condition: nil)
       mod_id = @_memery_module.object_id
       visibility = Memery.method_visibility(self, method_name)
       raise ArgumentError, "Method #{method_name} is not defined on #{self}" unless visibility
 
       @_memery_module.module_eval do
         define_method(method_name) do |*args, &block|
-          return super(*args, &block) if block
+          if block || (condition && !instance_exec(&condition))
+            return super(*args, &block)
+          end
 
           @_memery_memoized_values ||= {}
 

data/lib/memery/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Memery
-  VERSION = "0.6.0"
+  VERSION = "1.0.0"
 end

data/memery.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "memery/version"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memery
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Yuri Smirnov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-20 00:00:00.000000000 Z
+date: 2018-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,10 +115,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -146,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A gem for memoization.