lightly 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ced5fc7d04bba9051d3e8d07c3a522f47e937d90c2ada27e567fe4f3290e7dc
-  data.tar.gz: 7d02b1c822637ca05b4e1a01c35501c3de1c1505f97a1e9f5561ac8744b146f2
+  metadata.gz: d313f9708367bd12cd91e8a40edfead09bdab9abb923f1ba1b7cbd5129ff61e5
+  data.tar.gz: 6b19b9bf03a20d1725c5a9ef018a1e75fb945860195b158052dc74a0a0cc3de9
 SHA512:
-  metadata.gz: 698a691c809a987cc45ed35ef3cbc3ee5be9d7a8a4e088b079ed04f51c0ae6c48e475bd5421534d53bf03bc905c9d76440b44b83678263307e7d084e7b00ab82
-  data.tar.gz: 9b74b4b54267f15ddbfdaf02645f36c1d6f824726f8af827735a2aac1c5780760212dd64286c8a7284e199e93b5fa653b1e06d507a10ade3c81c4d31b3a0b9db
+  metadata.gz: 0b1836e246ed0b7d2e3212fd9a273f390df4f34c992b1817ba326e11f12a23303c02c40bd398a3d633eb37c0761a59b7b268c125ef6d3b472a436ff93345b52d
+  data.tar.gz: 7023d499f4fa07b16c4580a0f6507970898cd507c097c1c7a88638174afe101c356e0435b290f78f0aedea8d578ccde2cea06fb3390ecf7b530275eaf4b74cf8

data/README.md

@@ -1,10 +1,8 @@
-Lightly - Ruby File Cache
-==================================================
+# Lightly - Ruby File Cache
 
 [![Gem Version](https://badge.fury.io/rb/lightly.svg)](https://badge.fury.io/rb/lightly)
-[![Build Status](https://travis-ci.com/DannyBen/lightly.svg?branch=master)](https://travis-ci.com/DannyBen/lightly)
+[![Build Status](https://github.com/DannyBen/lightly/workflows/Test/badge.svg)](https://github.com/DannyBen/lightly/actions?query=workflow%3ATest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/8296395c9a332a15afc7/maintainability)](https://codeclimate.com/github/DannyBen/lightly/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/8296395c9a332a15afc7/test_coverage)](https://codeclimate.com/github/DannyBen/lightly/test_coverage)
 
 ---
 
@@ -12,10 +10,9 @@ Lightly is a file cache for performing heavy tasks, lightly.
 
 ---
 
-Install
---------------------------------------------------
+## Install
 
-```
+```shell
 $ gem install lightly
 ```
 
@@ -25,8 +22,7 @@ Or with bundler:
 gem 'lightly'
 ```
 
-Usage
---------------------------------------------------
+## Usage
 
 Lightly can be used both as an instance, and as a static class.
 
@@ -34,14 +30,14 @@ Lightly can be used both as an instance, and as a static class.
 require 'lightly'
 
 # Instance
-cache = Lightly.new life: '3h'
-response = cache.get 'key' do
+lightly = Lightly.new life: '3h'
+response = lightly.get 'key' do
   # Heavy operation here
 end
 
 # Static
 Lightly.life = '3h'
-Lightly.get 'key' do
+response = Lightly.get 'key' do
   # Heavy operation here
 end
 ```
@@ -50,8 +46,8 @@ The design intention is to provide both a globally available singleton
 `Lightly` object, as well as multiple caching instances, with different
 settings - depending on the use case.
 
-Note that the examples in this README are all using the instance syntax, but
-all methods are also available statically.
+Note that the examples in this document are all using the instance syntax,
+but all methods are also available statically.
 
 This is the basic usage pattern:
 
@@ -93,11 +89,11 @@ lightly.hash = false
 The `life` property accepts any of these formats:
 
 ```ruby
-cache.life = 10     # 10 seconds
-cache.life = '20s'  # 20 seconds
-cache.life = '10m'  # 10 minutes
-cache.life = '10h'  # 10 hours
-cache.life = '10d'  # 10 days
+lightly.life = 10     # 10 seconds
+lightly.life = '20s'  # 20 seconds
+lightly.life = '10m'  # 10 minutes
+lightly.life = '10h'  # 10 hours
+lightly.life = '10d'  # 10 days
 ```
 
 To check if a key is cached, use the `cached?` method:
@@ -161,21 +157,28 @@ lightly = Lightly.new
 lightly.prune
 ```
 
-If your block returns false or nil, the data will not be cached:
+If your block returns `false` or `nil`, the data will not be cached:
 
 ```ruby
-result = cache.get 'test' do
+result = lightly.get 'test' do
   false
 end
 
-puts cache.cached? 'test'
+puts lightly.cached? 'test'
 # => false
 ```
 
----
+## Related Projects
 
 For a similar gem that provides caching specifically for HTTP downloads,
-see the [WebCache gem][1]
+see the [WebCache gem][webcache].
+
+## Contributing / Support
 
+If you experience any issue, have a question or a suggestion, or if you wish
+to contribute, feel free to [open an issue][issues].
+
+---
 
-[1]: https://github.com/DannyBen/webcache
+[webcache]: https://github.com/DannyBen/webcache
+[issues]: https://github.com/DannyBen/lightly/issues

data/lib/lightly/cache_operations.rb

@@ -88,7 +88,7 @@ class Lightly
     end
 
     def expired?(path)
-      expired = life > 0 && File.exist?(path) && Time.now - File.mtime(path) >= life
+      expired = life >= 0 && File.exist?(path) && Time.now - File.mtime(path) >= life
       FileUtils.rm path if expired
       expired
     end

data/lib/lightly/version.rb

@@ -1,3 +1,3 @@
 class Lightly
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightly
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-23 00:00:00.000000000 Z
+date: 2020-06-12 00:00:00.000000000 Z
 dependencies: []
 description: Easy to use file cache
 email: db@dannyben.com
@@ -40,8 +40,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: File cache for performing heavy tasks, lightly.