key_cache 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '09335c3db16a6a41f1275e6bddab8821dcf9f79637eea1a1c90497e623649bee'
+  data.tar.gz: 12e94c9f02ae1cf555b5be2e6e58a3ad215dcbb8d76a7164ab75696403e4ce25
+SHA512:
+  metadata.gz: 2991d2c88d08080abc65d3903398ff996895cd5a537444e5a0b76088475ece6cccc55a7fec4f40385f673667a60040f8d8a327019c09c12dc6451c2603706cb8
+  data.tar.gz: 5b7a934925d75ac3b46e85494dca672505848c9a453732eea80a5cb8f3241a8487a8ad21b366a8871248b83c3e724c3bba0068c4c165b2c12b08b7257f45d343

data/README.md

@@ -0,0 +1,44 @@
+# KeyCache::Cache
+
+## Description
+
+This modules is an Rails Concern which provides a simple mechanism for
+caching values in redis.
+
+## Arguments
+
+*key*: key value to store the location. Use "/" to define segments and ":"
+to define segments that you want to be replaced by values returned from methods in your class
+
+*value*: When saving the record, this method will be called to get the value to store in Redis.
+
+*method*: defines a method which can be called to get the value of the stored Redis key
+
+## Usage
+
+```ruby
+class SomeModel < ApplicationRecord
+  include KeyCache::Cache
+
+  cache_key key: "some_model/:id",
+            value: :some_attribute,
+            method: :some_model_cache
+end
+
+s = SomeModel.save!(some_value: "this value")
+
+s.some_attribute
+# > this value
+
+s.some_attribute_key
+# > some_model/:id
+
+s.some_attribute_redis_key
+# > some_model:1
+
+s.save_some_attribute # Saves key to Redis
+
+s.destroy_some_attribute # Deletes key from Redis
+
+s.destory # Delete record and redis key
+```

data/lib/key_cache/cache.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module KeyCache
+  ##
+  # KeyCache::Cache
+  #
+  # Description
+  #
+  # This modules is an Rails Concern which provides a simple mechanism for
+  # caching values in redis.
+  #
+  # Arguments
+  #
+  #   key: key value to store the location. Use "/" to define segments and ":"
+  #        to define segements that you want to be replaced by values returned
+  #        from methods in your class
+  #
+  #   value: When saving the record, this method will be called to get the value
+  #          to store in Redis.
+  #
+  #   method: defines a method which can be called to get the value of the
+  #           stored Redis key
+  #
+  # Usage
+  #
+  # class SomeModel < ApplicationRecord
+  #   include KeyCache::Cache
+  #
+  #   cache_key key: "some_model/:id",
+  #             value: :some_attribute,
+  #             method: :some_model_cache
+  # end
+  #
+  # s = SomeModel.save!(some_value: "this value")
+  #
+  # s.some_attribute
+  # > this value
+  #
+  # s.some_attribute_key
+  # > some_model/:id
+  #
+  # s.some_attribute_redis_key
+  # > some_model:1
+  #
+  # s.save_some_attribute # Saves key to Redis
+  #
+  # s.destroy_some_attribute # Deletes key from Redis
+  #
+  # s.destory # Delete record and redis key
+  module Cache
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def cache_key(options = {})
+        key = options.fetch(:key)
+        value = options.fetch(:value)
+        method = options.fetch(:method)
+
+        class_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def #{method}
+            Redis.current.get(cache_key_decode("#{key}"))
+          end
+
+          def #{method}_key
+            "#{key}"
+          end
+
+          def #{method}_redis_key
+            cache_key_decode("#{key}")
+          end
+
+          def save_#{method}
+            Redis.current.set(cache_key_decode("#{key}"), self.send("#{value.to_sym}"))
+          end
+
+          after_save :save_#{method}
+
+          def destroy_#{method}
+            Redis.current.del(cache_key_decode("#{key}"))
+          end
+
+          after_destroy :destroy_#{method}
+        METHOD
+      end
+    end
+
+    def cache_key_decode(key)
+      key_parts = key.split('/')
+      key_parts.map! do |v|
+        v.match(/^:/) ? send(v.tr(':', '')) : v
+      end
+      key_parts.join(':')
+    end
+  end
+end

data/lib/key_cache/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module KeyCache
+  VERSION = '0.0.2'.freeze
+end

data/lib/key_cache.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'key_cache/version'
+require 'key_cache/cache'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: key_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Nicholas W. Watson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: KeyCache ties in to ActiveRecord callbacks and enables you to store info
+  in redis
+email: nicholas.w.watson@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/key_cache.rb
+- lib/key_cache/cache.rb
+- lib/key_cache/version.rb
+homepage: https://github.com/nwwatson/key_cache
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: KeyCache ties in to ActiveRecord callbacks and enables you to store info
+  in redis
+test_files: []