barking_iguana-cache_bucket 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c90c21ce4ef8a040fa432ce3f00a5359388039da
+  data.tar.gz: 499b20e6a2c0bd512fc110a8fb6e2f61491d1008
+SHA512:
+  metadata.gz: 8ee6d900f6a57a301115a604ddd4fd6cb0c23ef10e9bd9621491fa7b6677e0fd7de73c79c188019f21b8ec8446ea0837d6aa82fad094bdd3620df9d03294fa80
+  data.tar.gz: 17faf5648ae72761f58156c506b55965d50c40e170ed508db8827af80b57d680541a6077ee674d3bcb106b522e5b4819b32907d8eececb718441087174df2e92

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in barking_iguana-cache_bucket.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# BarkingIguana::CacheBucket
+
+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/barking_iguana/cache_bucket`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'barking_iguana-cache_bucket'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install barking_iguana-cache_bucket
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/[USERNAME]/barking_iguana-cache_bucket.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/barking_iguana-cache_bucket.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'barking_iguana/cache_bucket/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "barking_iguana-cache_bucket"
+  spec.version       = BarkingIguana::CacheBucket::VERSION
+  spec.authors       = ["Craig R Webster"]
+  spec.email         = ["craig@barkingiguana.com"]
+
+  spec.summary       = %q{Naive in-memory cache with expiry}
+  spec.description   = %q{Naive in-memory cache with expiry}
+  spec.homepage      = "https://github.com/barkingiguana/cache_bucket"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_dependency "null_logger"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "barking_iguana/cache_bucket"
+
+# 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/lib/barking_iguana/cache_bucket.rb

@@ -0,0 +1,33 @@
+require "barking_iguana/cache_bucket/version"
+require "barking_iguana/cache_bucket/cache_bucket"
+require "barking_iguana/cache_bucket/dsl"
+
+module BarkingIguana
+  module CacheBucket
+    class << self
+      attr_accessor :logger
+    end
+    self.logger = NullLogger.instance
+
+    class << self
+      attr_accessor :maximum_age
+    end
+    self.maximum_age = 3600
+
+    def self.get name, options = {}
+      buckets[name] ||= create_bucket name, options
+    end
+
+    def self.buckets
+      @bucket ||= {}
+    end
+    private_class_method :buckets
+
+    def self.create_bucket name, options
+      o = options.dup
+      o[:logger] ||= logger
+      o[:maximum_age] ||= maximum_age
+      CacheBucket.new o
+    end
+  end
+end

data/lib/barking_iguana/cache_bucket/cache_bucket.rb

@@ -0,0 +1,78 @@
+require 'null_logger'
+
+module BarkingIguana
+  module CacheBucket
+    class CacheBucket
+      KEY_DIVIDER = '__'.freeze
+
+      attr_accessor :maximum_age
+      private :maximum_age=, :maximum_age
+
+      attr_accessor :logger
+      private :logger=, :logger
+
+      attr_accessor :last_cleaned
+      private :last_cleaned=, :last_cleaned
+
+      attr_accessor :cache
+      private :cache=, :cache
+
+      def initialize maximum_age: 3600, logger: nil
+        self.maximum_age = maximum_age.to_i
+        self.logger = logger || NullLogger.instance
+        self.cache = {}
+      end
+
+      def get key
+        logger.debug { "Getting #{key}" }
+        evict_expired_keys
+        k = generation_key(key)
+        if cache.key? k
+          logger.debug { "Key #{k.inspect} found in the cache" }
+          cache[k].tap do |v|
+            logger.debug { "Value is #{v.inspect}" }
+          end
+        else
+          logger.debug { "Key #{k.inspect} is not in the cache" }
+          return unless block_given?
+          logger.debug { "I was passed a block to calculate the value" }
+          yield.tap do |v|
+            logger.debug { "Calculated value: #{v.inspect}" }
+            set key, v
+          end
+        end
+      end
+
+      def set key, value
+        evict_expired_keys
+        k = generation_key(key)
+        logger.debug { "Setting value to #{value.inspect}" }
+        cache[k] = value
+      end
+
+      private
+
+      def evict_expired_keys
+        g = generation_id
+        return if g == last_cleaned
+        logger.debug { "Performing cache maintenance at generation #{g}" }
+        count = cache.keys.size
+        cache.delete_if do |k, _v|
+          k !~ %r{^#{g}#{KEY_DIVIDER}}
+        end
+        logger.debug { "Deleted #{count - cache.keys.size} keys" }
+        self.last_cleaned = g
+      end
+
+      def generation_id
+        Time.now.to_i / maximum_age
+      end
+
+      def generation_key key
+        [ generation_id, key ].join(KEY_DIVIDER).tap do |k|
+          logger.debug { "Current generation key for #{key.inspect} is #{k.inspect}" }
+        end
+      end
+    end
+  end
+end

data/lib/barking_iguana/cache_bucket/dsl.rb

@@ -0,0 +1,22 @@
+module BarkingIguana
+  module CacheBucket
+    module DSL
+      def self.included into
+        into.extend ClassMethods
+        into.include InstanceMethods
+      end
+
+      module InstanceMethods
+        def class_cache options = {}
+          BarkingIguana::CacheBucket.get self.class.name, options
+        end
+      end
+
+      module ClassMethods
+        def class_cache options = {}
+          BarkingIguana::CacheBucket.get name, options
+        end
+      end
+    end
+  end
+end

data/lib/barking_iguana/cache_bucket/version.rb

@@ -0,0 +1,5 @@
+module BarkingIguana
+  module CacheBucket
+    VERSION = "0.4.0"
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: barking_iguana-cache_bucket
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Craig R Webster
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: null_logger
+  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'
+- !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: Naive in-memory cache with expiry
+email:
+- craig@barkingiguana.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- barking_iguana-cache_bucket.gemspec
+- bin/console
+- bin/setup
+- lib/barking_iguana/cache_bucket.rb
+- lib/barking_iguana/cache_bucket/cache_bucket.rb
+- lib/barking_iguana/cache_bucket/dsl.rb
+- lib/barking_iguana/cache_bucket/version.rb
+homepage: https://github.com/barkingiguana/cache_bucket
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Naive in-memory cache with expiry
+test_files: []