ruby_cream 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21e2768f002dc10a42ecb043e0a64a01c53a96155c415ef1281ac9e0f46f9c5b
+  data.tar.gz: 5414ed8530469c7a891c0b60012e132bb27fc6aaaaa8f07030729181c4e9a9cf
+SHA512:
+  metadata.gz: f979f0cf4ebd13ba9fdeb0bf9bb65a440f646fd1abbbd86eb2fa4b5a3ca1f42daa79eefca170e01878050117da852abd760bc97f2f6c71be3862d73a735cd468
+  data.tar.gz: 39495e30487be5c5a118fdaa8109fc9b7bd7dd4990123e0b073cc4f29956c49a9c9b1ae7da0a491d0e1503bcb7b84decd61d608e72040f820a80e99d5a2a7a0a

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    ruby_cream (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17.3)
+  minitest (~> 5.11.3)
+  rake (~> 10.0)
+  ruby_cream!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jonathan Thom
+
+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,68 @@
+# C.R.E.A.M.
+
+Cache Rules Everything Around Me.
+
+Simple in-memory Ruby cache. Inspired by [go-cache](https://github.com/patrickmn/go-cache).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ruby_cream"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cream
+
+
+## Usage
+
+```
+# Create a new cache instance with item duration in seconds as the argument:
+cache = Cream::Cache.new(10)
+
+# Set a cache value:
+cache.set(:test, "result")
+
+# Get a cache value:
+cache.get(:test)
+=> "result"
+
+# After some time as has passed, the item will expire:
+cache.get(:test)
+=> nil
+
+# Reset a key. Time to expiration will reset.
+cache.set(:test, "original")
+cache.set(:test, "reset")
+cache.get(:test)
+=> "reset"
+
+# Cache#items and Cache#duration_seconds are both publicly readable for debugging.
+cache.items
+=> {:test=>#<Cream::CacheItem:0x00007ffac103f4d0 @value="result", @expires_at=2019-02-07 08:24:57 -0800>}
+
+cache.duration_seconds
+=> 10
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` 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/JonathanWThom/cream.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require "rake/testtask"
+require "bundler/gem_tasks"
+
+task default: "test"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/*_test.rb"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cream"
+
+# 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(__FILE__)

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/cream/cache.rb

@@ -0,0 +1,29 @@
+require "cream/cache_item"
+
+module Cream
+  class Cache
+    attr_reader :duration_seconds, :items
+
+    def initialize(duration_seconds)
+      @duration_seconds = duration_seconds
+      @items = {}
+    end
+
+    def set(key, value)
+      expires_at = Time.now + duration_seconds
+      item = Cream::CacheItem.new(value, expires_at)
+      items.merge!(Hash[key, item])
+    end
+
+    def get(key)
+      item = items[key]
+
+      if item&.expired?
+        items.delete(key)
+        return nil
+      end
+
+      item&.value
+    end
+  end
+end

data/lib/cream/cache_item.rb

@@ -0,0 +1,14 @@
+module Cream
+  class CacheItem
+    attr_reader :value, :expires_at
+
+    def initialize(value, expires_at)
+      @value = value
+      @expires_at = expires_at
+    end
+
+    def expired?
+      Time.now > expires_at
+    end
+  end
+end

data/lib/cream/version.rb

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

data/lib/cream.rb

@@ -0,0 +1,2 @@
+require "cream/version"
+require "cream/cache"

data/ruby_cream.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cream/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_cream"
+  spec.version       = Cream::VERSION
+  spec.authors       = ["Jonathan Thom"]
+  spec.email         = ["jonathan.thom1990@gmail.com"]
+  spec.summary       = "Simple in-memory Ruby cache"
+  spec.homepage      = "https://github.com/JonathanWThom/cream"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.11.3"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ruby_cream
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Thom
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+description: 
+email:
+- jonathan.thom1990@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/cream.rb
+- lib/cream/cache.rb
+- lib/cream/cache_item.rb
+- lib/cream/version.rb
+- ruby_cream.gemspec
+homepage: https://github.com/JonathanWThom/cream
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/JonathanWThom/cream
+  source_code_uri: https://github.com/JonathanWThom/cream
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Simple in-memory Ruby cache
+test_files: []