easy_cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7e12c249c9d5282beb1b5ab61fda6e2e158ed01
+  data.tar.gz: e7a87df9e71cc3f64161cff970c4284b51686dce
+SHA512:
+  metadata.gz: 6afdd3972907a9a70af3300550ecfb66a55f87aa173d614a83d4e73607eea9dba032cc109d51285fccd70c71aaace415313ac44dc790840c26947fc6ccd7bac2
+  data.tar.gz: 28dba49cea5db4b2b78e476121a15edec97d4e90adc97d27ce05d6f8a54d20ce11014b89fe9a7b7dea7aa334d4b3ed1bf56994ca519b3d938dde8fb13f8e9e58

data/README.md

@@ -0,0 +1,42 @@
+EasyCache is a way to easily cache method calls to a readable YAML file.
+
+Internally it uses the [gemmy](http://github.com/maxpleaner/gemmy) library I made.
+
+Specifically, the PersistedHash (which syncs a hash's state to YAML file) is
+extended with a `get_or_set(key, &blk)` method where the block result gets cached as `key`.
+
+The return value of `get_or_set` is the block result. So it can easily be placed as a wrapper
+around any synchronous method:
+
+```rb
+
+require 'easy_cache'
+                # The ~/gemmy path will be automatically created
+                # However the cache path can be overridden with:
+                # ENV["GEMMY_CACHE_PATH"]
+
+my_method_cad(arg)
+  my_method_cache.get_or_set(arg) do
+    "#{arg} result is saved" 
+  end
+end
+
+def my_method(arg)
+  my_method_cache.get_or_set(arg) do
+    "#{arg} result is saved"
+  end
+end
+```
+
+There are other methods in the API, too.
+
+- `#clear`
+- `#set_state(hash)`
+- `#get(*nested_keys)`
+- `#set(*nested_keys, val)`
+- `#data` (the entire state)
+
+Note that `[]` and `[]=` only interact with the in-memory hash. They don't touch the YAML file.
+
+
+

data/bin/easy_cache

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require 'easy_cache'
+class EasyCache::CLI < Thor
+  desc "test", "run tests"
+  def test
+    puts "No tests have been wrritten"
+    exit
+  end
+end
+EasyCache::CLI.start ARGV

data/lib/easy_cache.rb

@@ -0,0 +1,25 @@
+require 'gemmy'
+
+class EasyCache
+
+  module HashPatch
+    def cache(db_name)
+      EasyCacheModule.cache self, db_name
+    end
+
+    def self.cache(hash, db_name)
+      Gemmy.component("cache").new db_name
+    end
+
+    refine Hash do
+      include HashPatch
+    end
+  end
+  
+  def self.new(hash={}, db_name)
+    HashPatch.cache hash, db_name
+  end
+
+end
+
+Gem.find_files("easy_cache/**/*.rb").each &method(:require)

data/lib/version.rb

@@ -0,0 +1,3 @@
+module EasyCache
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: easy_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- maxpleaner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gemmyrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: maxpleaner@gmail.com
+executables:
+- easy_cache
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/easy_cache
+- lib/easy_cache.rb
+- lib/version.rb
+homepage: http://github.com/maxpleaner/easy_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: 2.5.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: super easy way to cache results of a method (saves to yaml file)
+test_files: []