smart_cache_store 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5afc7011d21ae7f81c857be6283535b4d036eb126a2a890412c1f98fca5f914a
+  data.tar.gz: cdc421218f4a6963adbd0f7074c83cfa277d3986f29915482b45dc5ff911e8c0
+SHA512:
+  metadata.gz: 70b98d97da2015b7fd4512cf40fdf89aa0b1f3de7b70193cc7db315aaca6055d2754c4dbcd0c465018f9db3866faa48387c76d47eecab9914128f956c2bad5a1
+  data.tar.gz: '08e1b0c805e7343bf4b07cadbb0703ae7d1383888175246b526f89c85f2cda95f707fae42b7c36712c7d96b4eb7c68bae1d78afb5f0adc8597a6588bb9c4bfd7'

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright 2021 thomas morgan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# SmartCacheStore
+
+SmartCacheStore provides variations on ActiveSupport's MemCacheStore and RedisCacheStore to make the default configurations more production ready. It does this by setting better defaults and using a few more ENVs.
+
+
+##### Redis -- SmartRedisCache
+
+Set by default:
+
+    url:                ENV['REDIS_URL']
+    namespace:          ENV['REDIS_NAMESPACE']
+    expires_in:         1.day
+    race_condition_ttl: 5.seconds
+    pool_size:          ENV['RAILS_MAX_THREADS'] || 5
+    connect_timeout:    2
+    read_timeout:       1
+    write_timeout:      1
+    reconnect_attempts: 1
+    reconnect_delay:    0.2
+
+`:url` should be a uri, like: `redis://localhost:6379/0`. For two or more uris, combine with a comma: `redis://host-a,redis://host-b`.
+
+Any of these may still be specified directly, as well as all other support parameters for RedisCacheStore or the Redis gem.
+
+
+##### Memcache -- SmartMemCache
+
+Set by default:
+
+    url:                ENV['MEMCACHE_SERVERS']
+    namespace:          ENV['MEMCACHE_NAMESPACE']
+    expires_in:         1.day
+    race_condition_ttl: 5.seconds
+    failover:           true
+    pool_size:          ENV['RAILS_MAX_THREADS'] || 5
+
+MemCacheStore's legacy initializer with `*addresses` as the first parameter, and the RedisCacheStore compatible `:url` are supported.
+
+`:url` or *addresses should be a uri, like: `memcached://localhost:11211`. For two or more uris, combine with a comma: `memcached://host-a,memcached://host-b`.
+
+
+### Other features
+
+SmartMemCache's increment() and decrement() are also enhanced to be able to act on previously unset keys.
+
+
+## Usage
+
+In `environment/[env].rb`:
+
+#### Redis
+
+    # basic:
+    config.cache_store = :smart_redis_cache
+    # with parameters:
+    config.cache_store = :smart_redis_cache, {url: 'redis://localhost:1234/9'}
+
+#### Memcache
+
+    # basic:
+    config.cache_store = :smart_mem_cache
+    # with parameters:
+    config.cache_store = :smart_mem_cache, 'memcached://localhost:1234'
+    config.cache_store = :smart_mem_cache, 'memcached://localhost:1234', {expires_in: 1.hour}
+    config.cache_store = :smart_mem_cache, {url: 'memcached://localhost:1234', expires_in: 1.hour}
+
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "smart_cache_store"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/zarqman/smart_cache_store/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/active_support/cache/smart_mem_cache.rb

@@ -0,0 +1,63 @@
+# requires gems: dalli, connection_pool
+#
+# MEMCACHE_SERVERS can be either
+#   server1:11211,server2
+# or
+#   memcached://user:pass@server1:11211,...
+# default: localhost:11211
+
+
+require 'active_support/cache/mem_cache_store'
+
+module ActiveSupport
+  module Cache
+    class SmartMemCache < MemCacheStore
+
+      # known options:
+      #   ActiveSupport::Cache - universal options
+      #     :namespace{nil}, :compress{true}, :compress_threshold{1k}, :expires_in{0}, :race_condition_ttl{0}
+      #   ActiveSupport::Cache::Store
+      #     :pool_size{5}, :pool_timeout{5}
+      #   Dalli::Client
+      #     :failover{true}, :serializer{Marshall}, :compressor{zlib}, :cache_nils{false}
+      #     :namespace{nil}, :expires_in{0}, :compress{false} (separate from AS::C's same options above)
+      #     :threadsafe{true} (using ConnPool turns this off automatically)
+      def initialize(*addresses, **args)
+        args.reverse_merge!(
+          namespace:          ENV['MEMCACHE_NAMESPACE'],
+          expires_in:         1.day,
+          race_condition_ttl: 5.seconds,
+          failover:           true,
+          pool_size:          ENV.fetch('RAILS_MAX_THREADS'){ 5 }.to_i,
+        )
+        addresses.push Array(args.delete(:url)) if addresses.empty? && args.key?(:url)
+        super(*addresses, args)
+      end
+
+
+      # MemCacheStore#increment docs say it will init any invalid value to 0.
+      # In reality, it will only increment a pre-existing, raw value. everything else returns nil or an error.
+      # This fixes init of missing value on both increment() and decrement().
+      # Preexisting, invalid values still return errors.
+
+      def increment(name, amount = 1, options = nil)
+        options = merged_options(options)
+        instrument(:increment, name, amount: amount) do
+          rescue_error_with nil do
+            @data.with { |c| c.incr(normalize_key(name, options), amount, options[:expires_in], amount) }
+          end
+        end
+      end
+
+      def decrement(name, amount = 1, options = nil)
+        options = merged_options(options)
+        instrument(:decrement, name, amount: amount) do
+          rescue_error_with nil do
+            @data.with { |c| c.decr(normalize_key(name, options), amount, options[:expires_in], 0) }
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/active_support/cache/smart_redis_cache.rb

@@ -0,0 +1,45 @@
+# requires gems: redis, connection_pool
+#
+# REDIS_URL (or :url) can have one or multiple urls:
+#   redis://localhost:1234
+#   redis://host-a,redis://host-b   # automatically uses Redis::Distributed
+
+
+require 'active_support/cache/redis_cache_store'
+
+module ActiveSupport
+  module Cache
+    class SmartRedisCache < RedisCacheStore
+
+      # known options:
+      #   ActiveSupport::Cache - universal options
+      #     :namespace{nil}, :compress{true}, :compress_threshold{1k}, :expires_in{0}, :race_condition_ttl{0}
+      #   ActiveSupport::Cache::Store
+      #     :pool_size{5}, :pool_timeout{5}
+      #   Redis
+      #     :host, :port, :db, :username, :password, :url, :path
+      #     ssl_params: {:ca_file, :cert, :key}
+      #     :sentinels, :role
+      #     :cluster, :replica
+      #     :timeout (sets next 3), :connect_timeout, :read_timeout, :write_timeout
+      #     :reconnect_attempts, :reconnect_delay, :reconnect_delay_max
+      def initialize(**args)
+        args.reverse_merge!(
+          namespace:          ENV['REDIS_NAMESPACE'],
+          expires_in:         1.day,
+          race_condition_ttl: 5.seconds,
+          pool_size:          ENV.fetch('RAILS_MAX_THREADS'){ 5 }.to_i,
+          connect_timeout:    2,
+          read_timeout:       1,
+          write_timeout:      1,
+          reconnect_attempts: 1,
+          reconnect_delay:    0.2,
+        )
+        args[:url] ||= ENV['REDIS_URL'] unless args.key?(:redis) || args.key?(:url)
+        args[:url] = args[:url].split(',') if args[:url].is_a?(String)
+        super(**args)
+      end
+
+    end
+  end
+end

data/lib/smart_cache_store/version.rb

@@ -0,0 +1,3 @@
+module SmartCacheStore
+  VERSION = '0.1.0'
+end

data/lib/smart_cache_store.rb

@@ -0,0 +1 @@
+require 'smart_cache_store/version'

data/lib/tasks/smart_cache_store_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :smart_cache_store do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: smart_cache_store
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- thomas morgan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description:
+email:
+- tm@iprog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_support/cache/smart_mem_cache.rb
+- lib/active_support/cache/smart_redis_cache.rb
+- lib/smart_cache_store.rb
+- lib/smart_cache_store/version.rb
+- lib/tasks/smart_cache_store_tasks.rake
+homepage: https://github.com/zarqman/smart_cache_store
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/zarqman/smart_cache_store
+  changelog_uri: https://github.com/zarqman/smart_cache_store/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Production-ready enhancements for mem_cache_store and redis_cache_store
+test_files: []