redmemo 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfa945a3e519a646133f9bac7de73468916a8f1b
-  data.tar.gz: 66f4fd9c12d55870f76794eff422f6e29b889f6a
+  metadata.gz: 6019fd115f496fbe7112652a7c9b054fc2075614
+  data.tar.gz: b11f648088c65c44255d118fa0e2615d507aafae
 SHA512:
-  metadata.gz: 579f03e70a35bbc11372d141d2b06fe4afe60b7bc2c9e66fd024a2f7e796b2425b6b9a6279c868954fe6ea396b787983bb780e38d06508d313ca1b12d2d25e8b
-  data.tar.gz: db83d58a041130902212c24aa20f7961d84a16316c65517e772c801170815a48d2d6a5197ff8b838371051d21ebf3f5e61661c2170a858107100a929b162759f
+  metadata.gz: 7c07975da2a7f1a1d6ddd18a8058aa2b7a01edf0701615a58dbc1940e676d921289740e8fcd18ed1d9f01d580c411727dc9fe4b1aaff6254140913857b45cc6c
+  data.tar.gz: 76b5d46672a664f4c22b382edf402b54fabad1a3af45fb9f1929b486726210fc8d500eae2ca6836728a5ea239e72742f5059de394a76a7c8ac4097d1696e2502

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/README.md

@@ -1,8 +1,7 @@
 # Redmemo
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/redmemo`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Redis based memoization, which should replace your counter caches and caches in
+your views/view models/decorators/exhibits.
 
 ## Installation
 
@@ -22,7 +21,17 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+~~~ruby
+require 'redmemo'
+class Group
+  def intesive_method
+    # intensive work
+    "awesome result"
+  end
+
+  cache_method :intensive_method, cache_key: :id
+end
+~~~
 
 ## Development
 
@@ -32,7 +41,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/redmemo/fork )
+1. Fork it ( https://github.com/minhajuddin/redmemo/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`)

data/bin/console

@@ -7,8 +7,9 @@ require "redmemo"
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+require "pry"
+require "pry-doc"
+Pry.start
 
-require "irb"
-IRB.start
+#require "irb"
+#IRB.start

data/lib/redmemo.rb

@@ -1,5 +1,74 @@
 require "redmemo/version"
 
+require 'redis'
+require 'base64'
+$redis = Redis.new
+
 module Redmemo
-  # Your code goes here...
+  module Cache
+
+    def self.included(base)
+      base.include(InstanceMethods)
+      base.extend(ClassMethods)
+      # creates a custom cache module for the base class
+      # this module will hold the overriding methods
+      base.prepend(const_set("#{base.name}Cache", Module.new))
+    end
+
+    # start of instance methods
+    module InstanceMethods
+      def encode_for_cache(val)
+        Base64.encode64(Marshal.dump(val))
+      end
+
+      def decode_for_cache(encoded_val)
+        Marshal.load(Base64.decode64(encoded_val))
+      end
+
+      def cached_value_for(key, lazy_val)
+        cached_val = $redis.get(key)
+        return decode_for_cache(cached_val) if cached_val
+
+        # cache miss: first execution
+        lazy_val.().tap do |val|
+          $redis.set(key, encode_for_cache(val))
+        end
+      end
+    end
+    # end of instance methods
+
+    # start of class methods
+    module ClassMethods
+      DEFAULT_OPTIONS = {cache_key: :cache_key}
+      # usage:
+      # cache_method :m1, :cache_key => :your_custom_cache_key
+      # :cache_key is set to :cache_key by default, this is the activerecord cache key method
+      def cache_method(method_name, options = {})
+        options = DEFAULT_OPTIONS.merge(options || {})
+        cache_module = const_get("#{self.name}Cache")
+        cache_key_method = options[:cache_key] || options["cache_key"]
+        cache_module.class_eval do
+          define_method(method_name) do
+            key = "#{self.class.name}/#{method_name}/#{self.send(cache_key_method)}"
+            cached_value_for(key, ->{super()})
+          end
+        end
+      end
+
+
+      # usage:
+      # cache_methods :m1, :m2, :m3, :cache_key => :your_custom_cache_key
+      # :cache_key is set to :cache_key by default, this is the activerecord cache key method
+      def cache_methods(args)
+        options = args.pop if args.last.is_a?(Hash)
+        methods = args
+
+        methods.each do |method|
+          self.cache_method(method, options)
+        end
+      end
+    end
+    # end of class methods
+
+  end
 end

data/lib/redmemo/version.rb

@@ -1,3 +1,3 @@
 module Redmemo
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/redmemo.gemspec

@@ -19,6 +19,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  # dependencies
+  spec.add_dependency "redis", "~> 3"
+
   spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "pry-doc", "~> 0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redmemo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Khaja Minhajuddin
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: Redis based memoization, which should replace your counter caches.
 email:
 - minhajuddink@gmail.com