yaml_cache 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc6419739cdc3626128aa721dc4e9553ed43446ae3d065c696537da98ae3a509
-  data.tar.gz: e563f88ad73a3a6f1764a5a1f02faca49e375612d0a2f4b01d992a393bc407c3
+  metadata.gz: 54b25d047ecaa020d7407977c6b4b0a5c4b05cb56fd65c1d134f9f501c760151
+  data.tar.gz: 0c42a0c84a153bcfcfa4f6c50148882053d726678ccd93c6934e5f29073cc172
 SHA512:
-  metadata.gz: 11aaa878fbd409d3fb8758ee6de6b3b561bf08e1a36526e99dc209e8fcdb0b658f56cf858adbddabff310add6aa014cf922534f443666abbbc232e4348049797
-  data.tar.gz: b724d7102382e6e71a38bfe71558052ca86005f28368ee23c570e84d225aac5eb9bc947a559bcfd1f8ca96248afcd2cee60d2b2c94ad0103074678d32d7e84cf
+  metadata.gz: 76250821c9eda52063a789012ee52123e1a15d51dfffa19b7b7dac9537e3d5afea8a9df5a0f8d5fe76785dac507f8eaee1576ee08bacf2ea4b792ad0728082cc
+  data.tar.gz: cb3b347381cdc24d592c72853cb23cb5d332c1eab735beb0e6c7eaaabaa7115dcca365ca16d834a620ad863672ae3fe39593b86dc2c51c10c63205912f7398f2

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+Gemfile.lock

data/.travis.yml

@@ -1,5 +1,10 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.0
-before_install: gem install bundler -v 1.16.1
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - ruby-head
+before_install: gem install bundler

data/README.md

@@ -1,16 +1,13 @@
-# YamlStore
+# YAML Cache ![TravisCI](https://travis-ci.org/HellRok/YAMLCache.svg?branch=master)
 
-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
+This is a simple gem written in plain ruby just to store and cache data in a
+yaml file.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'yaml_store'
-```
+```ruby gem 'yaml_cache' ```
 
 And then execute:
 
@@ -18,22 +15,64 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install yaml_store
+    $ gem install yaml_cache
 
 ## Usage
 
-TODO: Write usage instructions here
+To save and retrieve simple data all you need to do is:
+
+```
+require 'yaml_cache'
+
+store = YAMLCache.new('store.yml')
+store.write('example', 'Here is some example text')
+store.read('example')
+```
+
+`#write` will return the amount of bytes written to the file, this may change
+in the past.
+
+To cache a block you'll need to do something more like:
+
+```
+require 'yaml_cache'
+
+store = YAMLCache.new('store.yml')
+
+store.cache('key_1', 3600) {
+  'Some data'
+}
+
+# or
+
+store.cache('key_2', 60) do
+  'Some other data'
+end
+```
+
+The first argument is the key to store the data under while the second argument
+is how many seconds to cache this for. If you call `#cache` with the same key
+again before it expires it will just return the value intsead of running the
+block.
 
 ## 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.
+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).
+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.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/HellRok/YAMLCache
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/lib/yaml_cache.rb

@@ -37,7 +37,7 @@ class YAMLCache
 
   private
   def load_store
-    if File.exists?(@path)
+    if File.exist?(@path)
       YAML.load(File.read(@path))
     else
       {}

data/lib/yaml_cache/version.rb

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

data/yaml_cache.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: yaml_cache
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sean Ross Earle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-10 00:00:00.000000000 Z
+date: 2019-12-29 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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 description: A simple gem for storing and caching data in a YAML file
 email:
 - sean.earle@oeQuacki.com
@@ -62,7 +62,6 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -70,7 +69,6 @@ files:
 - bin/setup
 - lib/yaml_cache.rb
 - lib/yaml_cache/version.rb
-- test.yml
 - title.md
 - tmp/.keep
 - yaml_cache.gemspec
@@ -93,8 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Store and cache data in a YAML file

data/Gemfile.lock

@@ -1,22 +0,0 @@
-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/test.yml

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