memery 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7bea94e1b42ea3945a0d149eb6842d0c8cd5fb9b
-  data.tar.gz: af0473e8921f36a362a37e5b4b610489b1106f75
+SHA256:
+  metadata.gz: 2592e62955d94ec822ac01546d7914e4a1b1bac3cf767f133c0bb9d2740d797c
+  data.tar.gz: d55627dd3396a960fb16509986b7843b2507cdc522f04b1c16a1b78c2e367dc8
 SHA512:
-  metadata.gz: d87994d56fcaa1b6cde160140b262f96e873ea4663e53e322f1de79661b8ca1c63b5cee5e52a3328245272e9b982d94ac447a01f54ce3dc0681904660ef78a69
-  data.tar.gz: f227cea7e655a3568c046d01d31e56d11dc9dc176261bf906c2b4cdf97d65f9195eb21922ef31da69e6912d59d4cb2012f7d798c44650fec725c1a2c9a7787c5
+  metadata.gz: edbfaefbbfd51dcac0b99a690e065c291f66b20534e5252fa074ee8c7cc83f3256c5cae63abd63f2d1de8c6fb1ca1253e1969ac36c9098ec8fad518d60b39795
+  data.tar.gz: 50617bebf3b45b586a55d41267835dbbecba826bcb9be8c5a7392b6661a7019eaa1de95745a024c3e437796df7e94537b2affe6942597b5a855bcfa1d3c7c30c

data/.rubocop.yml

@@ -3,4 +3,4 @@ inherit_gem:
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5

data/.travis.yml

@@ -1,5 +1,25 @@
-sudo: false
 language: ruby
+
+sudo: false
+
 rvm:
-  - 2.4.2
-before_install: gem install bundler -v 1.16.0
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - ruby-head
+
+before_install: gem install bundler
+
+env: SUITE="rspec"
+
+script: bundle exec $SUITE
+
+matrix:
+  fast_finish: true
+  # Only run RuboCop on the latest Ruby
+  include:
+    - rvm: 2.5
+      env: SUITE="rubocop"
+  allow_failures:
+    - rvm: ruby-head

data/README.md

@@ -1,6 +1,37 @@
-# Memery
+# Memery   [![Gem Version](https://badge.fury.io/rb/memery.svg)](https://badge.fury.io/rb/memery) [![Build Status](https://travis-ci.org/tycooon/memery.svg?branch=master)](https://travis-ci.org/tycooon/memery) [![Coverage Status](https://coveralls.io/repos/github/tycooon/memery/badge.svg?branch=master)](https://coveralls.io/github/tycooon/memery?branch=master)
 
-Memery is a gem for memoization in Ruby.
+Memery is a Ruby gem for memoization of method return values. The normal memoization in Ruby doesn't require any gems and looks like this:
+
+```ruby
+def user
+  @user ||= User.find(some_id)
+end
+```
+
+However, this approach dosn't work if the calculated result can be `nil` or `false` or in case the method is using arguments. You will also require extra `begin`/`end` lines in case your method requires multiple lines:
+
+```ruby
+def user
+  @user ||= begin
+    some_id = calculate_id
+    klass = calculate_klass
+    klass.find(some_id)
+  end
+end
+```
+
+For all these situations memoization gems (like this one) exist. The last example can be rewritten using memery like this:
+
+```ruby
+memoize def user
+  some_id = calculate_id
+  klass = calculate_klass
+  klass.find(some_id)
+end
+```
+
+## Installation
+Juts add `gem "memery"` to your Gemfile.
 
 ## Usage
 
@@ -30,6 +61,26 @@ a.call { 1 } # => 42
 # Will print because passing a block disables memoization
 ```
 
+For class methods:
+
+```ruby
+class B
+  class << self
+    include Memery
+
+    memoize def call
+      puts "calculating"
+      42
+    end
+  end
+end
+
+B.call # => 42
+B.call # => 42
+B.call # => 42
+# Text will be printed only once.
+```
+
 ## 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:
 
@@ -86,5 +137,7 @@ a.users {}
 However, this solution is kind of hacky.
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Author
+Created by Yuri Smirnov.

data/lib/memery.rb

@@ -14,7 +14,7 @@ module Memery
       :private
     when klass.protected_method_defined?(method_name)
       :protected
-    else
+    when klass.public_method_defined?(method_name)
       :public
     end
   end
@@ -36,6 +36,7 @@ module Memery
     def define_memoized_method!(method_name)
       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|

data/lib/memery/version.rb

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

data/memery.gemspec

@@ -21,8 +21,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "coveralls"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop-config-umbrellio"
+  spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memery
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yuri Smirnov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-16 00:00:00.000000000 Z
+date: 2018-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Memery is a gem for memoization.
 email:
 - tycooon@yandex.ru
@@ -95,8 +123,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/memery.rb
 - lib/memery/version.rb
 - memery.gemspec
@@ -120,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A gem for memoization.

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "memery"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here