Merge pull request #6 from splitwise/ar/update_gems

Update gems and code compliance

Author: rofreg

Gemfile

@@ -1,13 +1,13 @@
 source 'https://rubygems.org'
 
 group :development, :test do
-  gem 'guard', '~> 2.14'
+  gem 'guard', '~> 2.15'
   gem 'guard-rspec', '~> 4.7'
   gem 'guard-rubocop', '~> 1.3'
   gem 'pry-byebug', '~> 3.6'
-  gem 'rspec', '~> 3.7'
-  gem 'rubocop', '~> 0.58'
-  gem 'rubocop-rspec', '~> 1.27'
+  gem 'rspec', '~> 3.8'
+  gem 'rubocop', '~> 0.63'
+  gem 'rubocop-rspec', '~> 1.31'
 end
 
 gemspec

Gemfile.lock

@@ -10,9 +10,9 @@ GEM
     byebug (10.0.2)
     coderay (1.1.2)
     diff-lcs (1.3)
-    ffi (1.9.25)
+    ffi (1.10.0)
     formatador (0.2.5)
-    guard (2.14.2)
+    guard (2.15.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -29,72 +29,72 @@ GEM
     guard-rubocop (1.3.0)
       guard (~> 2.0)
       rubocop (~> 0.20)
-    jaro_winkler (1.5.1)
+    jaro_winkler (1.5.2)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
-    method_source (0.9.0)
+    method_source (0.9.2)
     nenv (0.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.12.1)
-    parser (2.5.1.2)
+    parallel (1.13.0)
+    parser (2.6.0.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
-    pry (0.11.3)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     pry-byebug (3.6.0)
       byebug (~> 10.0)
       pry (~> 0.10)
     rainbow (3.0.0)
     rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.58.2)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.63.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-rspec (1.27.0)
-      rubocop (>= 0.56.0)
-    ruby-progressbar (1.9.0)
+      unicode-display_width (~> 1.4.0)
+    rubocop-rspec (1.31.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
-    thor (0.20.0)
-    unicode-display_width (1.4.0)
+    thor (0.20.3)
+    unicode-display_width (1.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   cacheable!
-  guard (~> 2.14)
+  guard (~> 2.15)
   guard-rspec (~> 4.7)
   guard-rubocop (~> 1.3)
   pry-byebug (~> 3.6)
-  rspec (~> 3.7)
-  rubocop (~> 0.58)
-  rubocop-rspec (~> 1.27)
+  rspec (~> 3.8)
+  rubocop (~> 0.63)
+  rubocop-rspec (~> 1.31)
 
 BUNDLED WITH
-   1.16.3
+   1.16.6

README.md

@@ -40,7 +40,7 @@ require 'net/http'
 
 class GitHubApiAdapter
   def star_count
-    puts "Fetching data from GitHub"
+    puts 'Fetching data from GitHub'
     url = 'https://api.github.com/repos/splitwise/cacheable'
 
     JSON.parse(Net::HTTP.get(URI.parse(url)))['stargazers_count']
@@ -63,7 +63,7 @@ class GitHubApiAdapter
   cacheable :star_count
 
   def star_count
-    puts "Fetching data from GitHub"
+    puts 'Fetching data from GitHub'
     url = 'https://api.github.com/repos/splitwise/cacheable'
 
 
@@ -78,9 +78,9 @@ end
 > a = GitHubApiAdapter.new
 > a.star_count
 Fetching data from GitHub
- => 2
+ => 19
 > a.star_count
- => 2
+ => 19
 
 # Notice that "Fetching data from GitHub" was not output the 2nd time the method was invoked.
 # The network call and result parsing would also not be performed again.
@@ -98,12 +98,12 @@ The cache can intentionally be skipped by appending `_without_cache` to the meth
 > a = GitHubApiAdapter.new
 > a.star_count
 Fetching data from GitHub
- => 2
+ => 19
 > a.star_count_without_cache
 Fetching data from GitHub
- => 2
+ => 19
 > a.star_count
- => 2
+ => 19
 ```
 
 #### Remove the Value via `clear_#{method}_cache`
@@ -114,15 +114,15 @@ The cached value can be cleared at any time by calling `clear_#{your_method_name
 > a = GitHubApiAdapter.new
 > a.star_count
 Fetching data from GitHub
- => 2
+ => 19
 > a.star_count
- => 2
+ => 19
 
 > a.clear_star_count_cache
  => true
 > a.star_count
 Fetching data from GitHub
- => 2
+ => 19
 ```
 
 ## Additional Configuration
@@ -151,7 +151,7 @@ require 'net/http'
 class GitHubApiAdapter
   include Cacheable
 
-  cacheable :star_count, key_format: -> (target, method_name, method_args) do
+  cacheable :star_count, key_format: ->(target, method_name, method_args) do
     [target.class, method_name, method_args.first, Time.now.strftime('%Y-%m-%d')].join('/')
   end
 
@@ -176,14 +176,14 @@ In addition, we're including the current date in the cache key so calling this m
 > a = GitHubApiAdapter.new
 > a.star_count('cacheable')
 Fetching data from GitHub for cacheable
- => 2
+ => 19
 > a.star_count('cacheable')
- => 2
+ => 19
 > a.star_count('tokenautocomplete')
 Fetching data from GitHub for tokenautocomplete
- => 1142
+ => 1164
 > a.star_count('tokenautocomplete')
- => 1142
+ => 1164
 
  # In this example the follow cache keys are generated:
  # GitHubApiAdapter/star_count/cacheable/2018-09-21
@@ -204,7 +204,7 @@ require 'net/http'
 class GitHubApiAdapter
   include Cacheable
 
-  cacheable :star_count, unless: :growing_fast?, key_format: -> (target, method_name, method_args) do
+  cacheable :star_count, unless: :growing_fast?, key_format: ->(target, method_name, method_args) do
     [target.class, method_name, method_args.first].join('/')
   end
 
@@ -227,16 +227,16 @@ Cacheable is new so we don't want to cache the number of stars it has as we expe
 > a = GitHubApiAdapter.new
 > a.star_count('tokenautocomplete')
 Fetching data from GitHub for tokenautocomplete
- => 1142
+ => 1164
 a.star_count('tokenautocomplete')
- => 1142
+ => 1164
 
 > a.star_count('cacheable')
 Fetching data from GitHub for cacheable
- => 2
+ => 19
 > a.star_count('cacheable')
 Fetching data from GitHub for cacheable
- => 2
+ => 19
 ```
 
 ### Cache Options
@@ -298,15 +298,15 @@ end
 ```irb
 > GitHubApiAdapter.star_count_for_cacheable
 Fetching data from GitHub for cacheable
- => 2
+ => 19
 > GitHubApiAdapter.star_count_for_cacheable
- => 2
+ => 19
 
 > GitHubApiAdapter.star_count_for_tokenautocomplete
 Fetching data from GitHub for tokenautocomplete
- => 1142
+ => 1164
 > GitHubApiAdapter.star_count_for_tokenautocomplete
- => 1142
+ => 1164
 ```
 
 ### Other Notes / Frequently Asked Questions

examples/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: ../.rubocop.yml
+
+Style/Lambda:
+  EnforcedStyle: literal

examples/class_method_example.rb

@@ -29,12 +29,12 @@ def self.star_count_for_tokenautocomplete
 
 GitHubApiAdapter.star_count_for_cacheable
 # Fetching data from GitHub for cacheable
-# => 2
+# => 19
 GitHubApiAdapter.star_count_for_cacheable
-# => 2
+# => 19
 
 GitHubApiAdapter.star_count_for_tokenautocomplete
 # Fetching data from GitHub for tokenautocomplete
-# => 1142
+# => 1164
 GitHubApiAdapter.star_count_for_tokenautocomplete
-# => 1142
+# => 1164

examples/conditional_example.rb

@@ -5,7 +5,7 @@
 class GitHubApiAdapter
   include Cacheable
 
-  cacheable :star_count, unless: :growing_fast?, key_format: -> (target, method_name, method_args) do
+  cacheable :star_count, unless: :growing_fast?, key_format: ->(target, method_name, method_args) do
     [target.class, method_name, method_args.first].join('/')
   end
 
@@ -24,13 +24,13 @@ def growing_fast?(_method_name, method_args)
 a = GitHubApiAdapter.new
 a.star_count('tokenautocomplete')
 # Fetching data from GitHub for tokenautocomplete
-# => 1142
+# => 1164
 a.star_count('tokenautocomplete')
-# => 1142
+# => 1164
 
 a.star_count('cacheable')
 # Fetching data from GitHub for cacheable
-# => 2
+# => 19
 a.star_count('cacheable')
 # Fetching data from GitHub for cacheable
-# => 2
+# => 19

examples/custom_key_example.rb

@@ -5,7 +5,7 @@
 class GitHubApiAdapter
   include Cacheable
 
-  cacheable :star_count, key_format: -> (target, method_name, method_args) do
+  cacheable :star_count, key_format: ->(target, method_name, method_args) do
     [target.class, method_name, method_args.first, Time.now.strftime('%Y-%m-%d')].join('/')
   end
 
@@ -20,11 +20,11 @@ def star_count(repo)
 a = GitHubApiAdapter.new
 a.star_count('cacheable')
 # Fetching data from GitHub for cacheable
-# => 2
+# => 19
 a.star_count('cacheable')
-# => 2
+# => 19
 a.star_count('tokenautocomplete')
 # Fetching data from GitHub for tokenautocomplete
-# => 1142
+# => 1164
 a.star_count('tokenautocomplete')
-# => 1142
+# => 1164

examples/simple_example.rb

@@ -8,7 +8,7 @@ class GitHubApiAdapter
   cacheable :star_count
 
   def star_count
-    puts "Fetching data from GitHub"
+    puts 'Fetching data from GitHub'
     url = 'https://api.github.com/repos/splitwise/cacheable'
 
     JSON.parse(Net::HTTP.get(URI.parse(url)))['stargazers_count']
@@ -18,18 +18,18 @@ def star_count
 a = GitHubApiAdapter.new
 a.star_count
 # Fetching data from GitHub
-# => 2
+# => 19
 a.star_count
-# => 2
+# => 19
 
 a.star_count_without_cache
 # Fetching data from GitHub
-# => 2
+# => 19
 a.star_count
-# => 2
+# => 19
 
 a.clear_star_count_cache
 # => true
 a.star_count
 # Fetching data from GitHub
-# => 2
+# => 19