cache_store 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06d887fb2a9be3c965f80c4abcf44b20880ec695
+  data.tar.gz: b28e631bb46f71a12585691c737993392d7e9dd9
+SHA512:
+  metadata.gz: 0c22390d96e6d7fedd435ef3dadd7fefa9e7c1c5f78a0690a9ce97f28aa7cc0e31ca881fbcfe517eb35b1096606842b7532c1a1f4b5bba7e12316c789b34aa2a
+  data.tar.gz: 81a277cb0784b3e17b39d88f43dcd22ece0cfab5b48bd679bf9bc98c42c3663c02185f33fa4deff1fc54d6a5a22f385ecff2e95e61e45a4a1b0b78162f74fbfd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at vaughan.britton@sage.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cache_store.gemspec
+gemspec
+
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 vaughanbrittonsage
+
+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,156 @@
+# CacheStore
+
+Welcome to CacheStore! 
+
+This is the base for a cache framework that includes a basic in memory cache store, along with a dependency contract for additional provider implementations plugins.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cache_store'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cache_store
+
+## Implementations
+
+All cache store implementations adhere to the following contract:
+
+    
+	class CacheStoreContract
+		  
+	  def set(key, value, expires_in = 0)
+	
+	  end
+		  
+	  def get(key, expires_in = 0, &block)
+	
+	  end
+	 
+	  def remove(key)
+	
+	  end
+
+	  def exist?(key)
+	
+	  end
+	end
+	
+
+**#set**
+
+This method is called to store a value in the cache store for a unique key.
+
+Params:
+
+- **key** [String] 
+This is the unique key to reference the value being set within this cache store
+- **value** [Object]
+This is the value to set within this cache store.
+- **expires_in** [Integer] [Optional]
+This is the number of seconds from the current time that this value should expire.
+
+Example:
+
+    #set with expires_in specified
+    cache_store.set('country_code', 'en-GB', 180)
+   
+
+> The above example will store the **value** 'en-GB' under the **key**
+> 'country_code' for **expiry** time of 180 seconds (2minutes). 
+> Any requests to the cache_store for the 'country_code' key within the next 180 seconds (2minutes) will return the 'en-GB' value. 
+> Requests for the key after the expiry time will return **nil** if no hydration block has been specified in the request.
+>  If you don't specify an **expires_in** parameter then the value stored will not expire for the lifespan of the cache_store.
+
+**#get**
+
+This method is called to request a value from the cache store for a unique key.
+
+Params:
+
+- **key** [String]
+This is the unique key of the value you want to fetch from within the cache store.
+- **expires_in** [Integer] [Optional]
+This is the number of seconds from the current time that this value should expire.
+
+> (This is used in conjunction with the hydrate block to populate the cache key if it is empty.)
+
+- **&block** [Block] [Optional]
+This is the hydration block that when specified is used to populate the cache_store with the value for the specified key.
+
+Examples:
+
+    #example without a hydration block
+    value = cache_store.get('country_code')
+
+> This would return the **value** stored for the 'country_code' key or **nil** if the value had expired or was not found.
+
+    #example with a hydration block
+    value = cache_store.get('country_code', 180) do
+    {
+	    return 'en-GB'
+    }
+
+> This would execute the hydration block if the value was not found for the specified key or if the value had expired.
+
+**#remove**
+
+This method is called to remove a value from the cache store by it's unique key.
+
+Params:
+
+- **key** [String] This is the unique key of the item to remove from the cache store.
+
+Example:
+
+    cache_store.remove('country_code')
+
+
+**#exist?**
+
+This method is called to check if a value has been stored in the cache store for a specific key.
+
+Params:
+
+**key** [String]
+This is the unique key of the value to check for.
+
+Example:
+
+    if cache_store.exist?('country_code')
+	    ....do logic here
+	end
+
+
+##LocalCacheStore
+
+The local cache store is a ruby in memory cache store that has no dependency on rails or any other frameworks. Multiple instances of the cache store can be created as required to maintain isolated cache stores, which are perfect for development and testing when your production application cache uses reds or memcached etc as a distributed cache.
+
+    #create a new instance of the cache store
+    cache_store = LocalCacheStore.new
+
+> **CacheStore** works perfectly with **Sinject** a dependency injection framework allowing you to switch the cache store implementations used for different environments.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vaughanbrittonsage/cache_store. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cache_store"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# 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 "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cache_store.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cache_store/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cache_store"
+  spec.version       = CacheStore::VERSION
+  spec.authors       = ["vaughanbrittonsage"]
+  spec.email         = ["vaughan.britton@sage.com"]
+
+  spec.summary       = 'This is the base for a cache framework that includes a basic in memory cache store, along with a dependency contract for additional provider implementations plugins.'
+  spec.description   = 'This is the base for a cache framework that includes a basic in memory cache store, along with a dependency contract for additional provider implementations plugins.'
+  spec.homepage      = "https://github.com/vaughanbrittonsage/cache_store"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/cache_store.rb

@@ -0,0 +1,123 @@
+require "cache_store/version"
+require 'date'
+require 'pry'
+#This class is used to define the contract that CacheStore implementations must adhere to.
+class CacheStoreContract
+
+  def initialize(namespace = '')
+    @namespace = namespace
+  end
+
+  #This method is called to set a value within this cache store by it's key.
+  #
+  # @param [String] This is the unique key to reference the value being set within this cache store.
+  # @param [Object] This is the value to set within this cache store.
+  # @param [Integer] This is the number of seconds from the current time that this value should expire.
+  def set(key, value, expires_in = 0)
+
+  end
+
+  #This method is called to get a value from this cache store by it's unique key.
+  #
+  # @param [String] This is the unique key to reference the value to fetch from within this cache store.
+  # @param [Integer] This is the number of seconds from the current time that this value should expire. (This is used in conjunction with the block to hydrate the cache key if it is empty.)
+  # @param [Block] This block is provided to hydrate this cache store with the value for the request key when it is not found.
+  def get(key, expires_in = 0, &block)
+
+  end
+
+  # This method is called to remove a value from this cache store by it's unique key.
+  #
+  # @param [String] This is the unique key to reference the value to remove from this cache store.
+  def remove(key)
+
+  end
+
+  # This method is called to check if a value exists within this cache store for a specific key.
+  #
+  # @param [String] This is the unique key to reference the value to check for within this cache store.
+  def exist?(key)
+
+  end
+end
+
+#This class is used to implement a local in memory cache store.
+class LocalCacheStore
+
+  attr_accessor :store
+
+  def initialize(namespace = '')
+    @store = Array.new
+    @namespace = namespace
+  end
+
+  #This method is called to set a value within this cache store by it's key.
+  #
+  # @param [String] This is the unique key to reference the value being set within this cache store.
+  # @param [Object] This is the value to set within this cache store.
+  # @param [Integer] This is the number of seconds from the current time that this value should expire.
+  def set(key, value, expires_in = 0)
+    remove(build_key(key))
+    expires = nil
+    if expires_in > 0
+      now = DateTime.now
+      expires = DateTime.new(now.year, now.month, now.day, 0, 0, expires_in)
+    end
+    @store.push({ key: build_key(key), value: value, expires: expires})
+  end
+
+  #This method is called to get a value from this cache store by it's unique key.
+  #
+  # @param [String] This is the unique key to reference the value to fetch from within this cache store.
+  # @param [Integer] This is the number of seconds from the current time that this value should expire. (This is used in conjunction with the block to hydrate the cache key if it is empty.)
+  # @param [Block] This block is provided to hydrate this cache store with the value for the request key when it is not found.
+  def get(key, expires_in = 0, &block)
+
+    #look for the cache item in the store
+    items = @store.select { |i| i[:key] == build_key(key) }
+    item = if !items.empty? then items[0] else nil end
+    #check if a valid item was found in the store
+    if item == nil || (item[:expires] != nil && item[:expires] <= DateTime.now)
+      #a valid item wasn't found so check if a hydration block was specified.
+      if block_given?
+        #create the item from the block
+        value = yield
+        #put the item in the store
+        set(build_key(key), value, expires_in)
+        return value
+      else
+        #no hydration block was specified
+
+        #check if an expired item was found
+        if item != nil
+          #remove the expired item from the store
+          remove(build_key(key))
+        end
+        return nil
+      end
+    end
+
+    #return the item
+    return item[:value]
+  end
+
+  # This method is called to remove a value from this cache store by it's unique key.
+  #
+  # @param [String] This is the unique key to reference the value to remove from this cache store.
+  def remove(key)
+    @store.delete_if { |i| i[:key] == build_key(key) }
+  end
+
+  # This method is called to check if a value exists within this cache store for a specific key.
+  #
+  # @param [String] This is the unique key to reference the value to check for within this cache store.
+  def exist?(key)
+    !@store.select { |i| i[:key] == build_key(key) }.empty?
+  end
+
+  private
+
+  def build_key(key)
+    @namespace + key.to_s
+  end
+end

data/lib/cache_store/version.rb

@@ -0,0 +1,3 @@
+module CacheStore
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: cache_store
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- vaughanbrittonsage
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This is the base for a cache framework that includes a basic in memory
+  cache store, along with a dependency contract for additional provider implementations
+  plugins.
+email:
+- vaughan.britton@sage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cache_store.gemspec
+- lib/cache_store.rb
+- lib/cache_store/version.rb
+homepage: https://github.com/vaughanbrittonsage/cache_store
+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.5.1
+signing_key: 
+specification_version: 4
+summary: This is the base for a cache framework that includes a basic in memory cache
+  store, along with a dependency contract for additional provider implementations
+  plugins.
+test_files: []
+has_rdoc: