cache_with_settings 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d44fc8b425cf60789dbf23b7ba588d2b70d57717162e486b45f833fc8a3ead51
-  data.tar.gz: '0396f825129a23dfc5c732e24c0951f281c7107f78bb16f3b6b9177c249dd936'
+  metadata.gz: c0afd8964a34b654ac33eb73501f28bff8e170667452b409749e48902bca8e7a
+  data.tar.gz: 3adbf5daaad4d0c8213205aab8b6ec24c38c1f123df18b64707b8429816709b4
 SHA512:
-  metadata.gz: 412ae33ce3aa025d4932ad39e18a382a14853f98c0f9326de9fc90f923cb549c84e8001e80ad25f1fc66f3dfb793d91642a0fd63875ca2972a5320f23f3bb4f1
-  data.tar.gz: b5a18a25e2f0426c61660a46e8ec02248e4a1cb20308d5518671dd8ade8b6e2036c6bc77abc4729f3bad7b6d7f39841b5ef718f2498c1c1b58951c560d88e7e7
+  metadata.gz: 12e521466bbbe4494339c7e79ebebee5b3ba40d3e568f60bc56eb0116e69adc5ad703f81d9974e7873c23fec05c38f8bdf71404405ffdc58e932a9ec3cb7a542
+  data.tar.gz: bbfcbac8a8dde1644024bf5353ed6d618574a23baad684a8c7cc1dfd23592ba110d94e1288effecc7f0141db6dbd610f35642c6e73c71eeec18e4fd4ba9d932e

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2018 Igor Kasyanchuk
+Copyright 2018 Richard Venneman
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,33 +1,35 @@
 [![Build Status](https://travis-ci.org/richardvenneman/cache_with_settings.svg?branch=master)](https://travis-ci.org/richardvenneman/cache_with_settings)
 
-# Rails cache with settings
-This project started as a fork of [cache_with_locale](https://github.com/igorkasyanchuk/cache_with_locale). Besides the locale I also needed the current currency as part of our cache keys. So this gem automatically adds the current locale (I18n.locale) and currency (MoneyRails.default_currency) as parts of caching keys in Rails views.
+# Rails cache_with_settings
+CacheWithSettings allows you to add any keys to partial caching cache keys. This is useful if your website is multilingual or allows the user to choose a display currency.
 
 ## Problem & Solution
-For example you have:
-- Rails app with different locales and currencies
-- you want to add fragment caching in views
-
-When you add locales and currencies to your cache keys:
+If you find yourself adding dynamic values, such as locales and currencies to your cache keys, this gem could be useful for you. Instead of:
 
 ```
   = cache [@user, I18n.locale, MoneyRails.default_currency] do
     = render @user
 ```
 
-As you see you need to add `I18n.locale` and `MoneyRails.default_currency` as a part of the cache key. And you need to do it everywhere. What if you forget about it in some view?
-
-This gem is a simple solution which allows you to DRY your code. So now you can write
+Configure this gem once and just write:
 
 ```
   = cache @user do
     = render @user
 ```
 
-And let gem handle all work. You don't need to specify locale as a cache sufix/prefix.
+This gem allows you to DRY up your code and forget about including dynamic values in your cache keys.
 
 ## Usage
-Just add this gem to your Gemfile.
+After adding the gem to your Gemfile, configure CacheWithSettings in an initializer. You can specify any dynamic cache keys, such as `I18n.locale`.
+
+```ruby
+CacheWithSettings.configure do |config|
+  config.cache_keys = [I18n.locale.to_s, MoneyRails.default_currency.to_s]
+end
+```
+
+That's it! Your template `cache` calls now automatically include the specified cache keys.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -41,8 +43,8 @@ And then execute:
 $ bundle
 ```
 
-## Contributing
-Contribution directions go here.
+## Credit
+This project started as a fork of [cache_with_locale](https://github.com/igorkasyanchuk/cache_with_locale). Besides the locale I also needed the current currency as part of our cache keys, which led to the creation of this gem.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,26 +1,28 @@
+# frozen_string_literal: true
+
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'CacheWithSettings'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "CacheWithSettings"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 

data/lib/cache_with_settings/configuration.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CacheWithSettings
+  mattr_accessor :cache_keys
+  self.cache_keys = []
+
+  def self.configure
+    yield self
+  end
+end

data/lib/cache_with_settings/railtie.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module CacheWithSettings
   class Railtie < ::Rails::Railtie
-    initializer 'rails_db.helpers' do
+    initializer "rails_db.helpers" do
       ActiveSupport.on_load :action_view do
         ActionView::Base.send :include, CacheWithSettings::Helpers
       end

data/lib/cache_with_settings/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CacheWithSettings
-  VERSION = '0.0.1'
+  VERSION = "1.0.0"
 end

data/lib/cache_with_settings.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
+require "cache_with_settings/configuration"
 require "cache_with_settings/railtie"
-require "money-rails"
 
 module CacheWithSettings
   module Helpers
@@ -10,8 +12,8 @@ module CacheWithSettings
     end
 
     private
-    def cache_with_settings_compose_key(key)
-      Array.wrap(key).concat([I18n.locale.to_s, MoneyRails.default_currency.to_s])
-    end
+      def cache_with_settings_compose_key(key)
+        Array.wrap(key).concat(CacheWithSettings.cache_keys)
+      end
   end
 end

data/lib/tasks/cache_with_settings_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # desc "Explaining what the task does"
 # task :cache_with_settings do
 #   # Task goes here

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: cache_with_settings
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
-- Igor Kasyanchuk
+- Richard Venneman
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -25,13 +25,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: money-rails
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.68'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.68'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -52,10 +66,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Automatically add application locale (I18n.locale) as a part of cache
-  key in Rails views.
+description: Configure any values such as the application locale to be part of Rails
+  fragment caching cache keys.
 email:
-- igorkasyanchuk@gmail.com
+- richardvenneman@me.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -64,10 +78,11 @@ files:
 - README.md
 - Rakefile
 - lib/cache_with_settings.rb
+- lib/cache_with_settings/configuration.rb
 - lib/cache_with_settings/railtie.rb
 - lib/cache_with_settings/version.rb
 - lib/tasks/cache_with_settings_tasks.rake
-homepage: https://github.com/igorkasyanchuk
+homepage: https://github.com/richardvenneman
 licenses:
 - MIT
 metadata: {}
@@ -89,5 +104,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Automatic fragment caching in Rails with locales
+summary: Configurable Rails fragment caching
 test_files: []