yaml_cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc6419739cdc3626128aa721dc4e9553ed43446ae3d065c696537da98ae3a509
+  data.tar.gz: e563f88ad73a3a6f1764a5a1f02faca49e375612d0a2f4b01d992a393bc407c3
+SHA512:
+  metadata.gz: 11aaa878fbd409d3fb8758ee6de6b3b561bf08e1a36526e99dc209e8fcdb0b658f56cf858adbddabff310add6aa014cf922534f443666abbbc232e4348049797
+  data.tar.gz: b724d7102382e6e71a38bfe71558052ca86005f28368ee23c570e84d225aac5eb9bc947a559bcfd1f8ca96248afcd2cee60d2b2c94ad0103074678d32d7e84cf

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in yaml_cache.gemspec
+gemspec

data/Gemfile.lock

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sean Ross Earle
+
+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,39 @@
+# YamlStore
+
+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/yaml_store`. 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 'yaml_store'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yaml_store
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/yaml_store.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yaml_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(__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/yaml_cache/version.rb

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

data/lib/yaml_cache.rb

@@ -0,0 +1,53 @@
+require 'yaml'
+
+class YAMLCache
+  def initialize(path)
+    @path = path
+    @store = load_store
+  end
+
+  def write(key, value=nil, &block)
+    store(key, block ? block.call : value)
+    File.write(@path, @store.to_yaml)
+  end
+
+  def read(key)
+    @store[key][:value]
+  end
+
+  def cache(key, expiration, &block)
+    value = nil
+    if @store.has_key?(key)
+      if @store[key][:expiration] == nil ||
+          (@store[key][:expiration] - Time.now.to_i) <= 0
+        value = block.call
+        store(key, value, expiration)
+      else
+        value = @store[key][:value]
+      end
+    else
+      value = block.call
+      store(key, value, expiration)
+    end
+
+    File.write(@path, @store.to_yaml)
+
+    return value
+  end
+
+  private
+  def load_store
+    if File.exists?(@path)
+      YAML.load(File.read(@path))
+    else
+      {}
+    end
+  end
+
+  def store(key, value, expiration=nil)
+    @store[key] = {
+      value: value,
+      expiration: expiration ? (Time.now.to_i + expiration) : nil
+    }
+  end
+end

data/test.yml

@@ -0,0 +1,7 @@
+---
+hello:
+  :value: there
+  :expiration: 
+cache:
+  :value: snth
+  :expiration: 1523344130

data/title.md

@@ -0,0 +1,16 @@
+# YAML Store
+
+## Purpose
+
+I want a simple gem for keeping data between script runs or simply for caching
+long running blocks.
+
+## What I plan to use
+
+- YAML
+- MiniTest
+
+## Expected Time
+
+30 minutes
+I kinda blew out to 45 minutes, whoops!

data/yaml_cache.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yaml_cache/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yaml_cache"
+  spec.version       = YamlCache::VERSION
+  spec.authors       = ["Sean Ross Earle"]
+  spec.email         = ["sean.earle@oeQuacki.com"]
+
+  spec.summary       = %q{Store and cache data in a YAML file}
+  spec.description   = %q{A simple gem for storing and caching data in a YAML file}
+  spec.homepage      = "https://github.com/HellRok/YAMLCache"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: yaml_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Ross Earle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A simple gem for storing and caching data in a YAML file
+email:
+- sean.earle@oeQuacki.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yaml_cache.rb
+- lib/yaml_cache/version.rb
+- test.yml
+- title.md
+- tmp/.keep
+- yaml_cache.gemspec
+homepage: https://github.com/HellRok/YAMLCache
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Store and cache data in a YAML file
+test_files: []