cache_if_slow 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55de8311ff8c4e0347c00eb3983925e35d4cebd6920e099670d2b308a0595a21
-  data.tar.gz: c1e9f955ce113ecdf532fb2b3412e995fc22b62ac09c0e37cf59606af04b1c3b
+  metadata.gz: c57f6966f90b7576e367a8f31ca6af4ab34c8d0f7e4b787359af4080097c3ce3
+  data.tar.gz: 1701f933c543ba83921fcdf1feb8968f9f6d7289e43d8e79b59d7014a89266ff
 SHA512:
-  metadata.gz: 8195a7315d595e852b0073d1f25277b8bc62633a7d37cac4d1bdb609674d6d1ba225efa8c3dcfa3e169af09351b75ed78dce27fdd17e2ef1cf804d6ba1c12ff2
-  data.tar.gz: 060a7f5bd2d84d6de6296145bb2560a09d8662d8f09588c3ae7515c21993378b50e9e8d18765bba65c478273bed2d4ae82c9f2c4731ef1a69700974ccfada4a0
+  metadata.gz: 164cdd715ab74d08cda1a3b5bdf9b8b686dd194162c4acae2f29fcaba06c4b3c1efe054524ebdc4d6cd05352e4fec7df7e1871c2dfd58a09d396efdd07e859b8
+  data.tar.gz: 5e721f1180965e5516ff90c9952be2c2ca4a2b87b94e7034a8ff3b9d170b606af1ffa412f59b81ad4c1dc646583a6fd1cdd52c6a2998849d3500d5258db5b7f7

data/.rspec_status

@@ -0,0 +1,6 @@
+example_id                              | status | run_time        |
+--------------------------------------- | ------ | --------------- |
+./spec/cache_if_slow_spec.rb[1:1:1:1]   | passed | 0.01229 seconds |
+./spec/cache_if_slow_spec.rb[1:1:2:1:1] | passed | 0.60579 seconds |
+./spec/cache_if_slow_spec.rb[1:1:2:2:1] | passed | 2.1 seconds     |
+./spec/cache_if_slow_spec.rb[1:1:2:3:1] | passed | 0.30148 seconds |

data/README.md

@@ -1 +1,101 @@
 # cache_if_slow
+
+[![Gem Version](https://badge.fury.io/rb/cache_if_slow.png)](https://badge.fury.io/rb/cache_if_slow)
+[![CI Status](https://github.com/cianmce/cache_if_slow/actions/workflows/main.yml/badge.svg)](https://github.com/cianmce/cache_if_slow/actions)
+
+Caches slow blocks of code using a cascading configuration.
+
+## Installation
+
+### Add gem
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cache_if_slow'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cache_if_slow
+
+## Usage
+
+### Create cache instance
+
+`expiry_lookup` can be used to set the ttl for a given block of code.
+
+With the below example, if a block of code took 1 -> 5 seconds, e.g. 2 seconds, then that result will be cached for 10 minutes. If it instead took over 10 seconds, then it would be cached for 30 minutes.
+
+```ruby
+def self.cache
+  @cache ||= CacheIfSlow.new(expiry_lookup: [
+    { slower_than: 1.second, expires_in: 10.minutes },
+    { slower_than: 5.seconds, expires_in: 20.minutes },
+    { slower_than: 10.seconds, expires_in: 30.minutes }
+  ])
+end
+```
+
+### `fetch` the result
+
+This operates as a proxy to the [`Rails.cache.fetch`](https://apidock.com/rails/ActiveSupport/Cache/Store/fetch) method.
+
+```ruby
+returned_value = self.class.cache.fetch("unique-cache-key") do
+  slow_request()
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Testing
+#### Run all specs + standardrb
+
+```sh
+bundle exec rake
+```
+
+#### Run only standardrb
+
+```sh
+bundle exec rake standard
+````
+
+#### Apply standardrb auto fixes
+
+```sh
+bundle exec rake standard:fix
+```
+
+#### Run specs using guard
+
+```sh
+bundle exec guard
+```
+
+This will auto run the related unit tests while you develop and save files.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cianmce/cache_if_slow. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/cianmce/cache_if_slow/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the cache_if_slow project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cianmce/cache_if_slow/blob/master/CODE_OF_CONDUCT.md).
+
+## TODO
+
+- [ ] Update Readme and spec with class method examples

data/cache_if_slow.gemspec

@@ -36,8 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-doc", "~> 1.1"
   spec.add_development_dependency "guard", "~> 2.18"
   spec.add_development_dependency "guard-rspec", "~> 4.7.3"
-  # spec.add_development_dependency "with_model", "~> 2.0"
-  # spec.add_development_dependency "database_cleaner", "~> 1.5"
-  # spec.add_development_dependency "sqlite3"
-  spec.add_dependency "activesupport", ">= 4.0"
+  spec.add_dependency "rails", ">= 4.0"
 end

data/lib/cache_if_slow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class CacheIfSlow
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/cache_if_slow.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "active_support"
+require "rails"
 require "cache_if_slow/version"
 
 class CacheIfSlow
@@ -37,7 +37,7 @@ class CacheIfSlow
     if total_time > max_seconds && @cache.read(name, options).nil?
       expires_in = lookup_expiry(total_time, options)
       options[:expires_in] = expires_in
-      @logger.info "CacheIfSlow :: Storing #{name} as #{total_time} > #{max_seconds} expires_in: #{expires_in}"
+      @logger.info "CacheIfSlow :: Storing '#{name}' as #{total_time} > #{max_seconds} expires_in: #{expires_in}"
       @cache.write(name, value, options)
     end
     value

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cache_if_slow
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Cian McElhinney
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.7.3
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -178,7 +178,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/cianmce/cache_if_slow
   source_code_uri: https://github.com/cianmce/cache_if_slow
-  documentation_uri: https://www.rubydoc.info/gems/cache_if_slow/0.0.1
+  documentation_uri: https://www.rubydoc.info/gems/cache_if_slow/0.0.2
 post_install_message: 
 rdoc_options: []
 require_paths: