lightly 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ced5fc7d04bba9051d3e8d07c3a522f47e937d90c2ada27e567fe4f3290e7dc
-  data.tar.gz: 7d02b1c822637ca05b4e1a01c35501c3de1c1505f97a1e9f5561ac8744b146f2
+  metadata.gz: 1218707c4bb8d9de7bcc161073fde7a1f8af1e0f2539cec99e8600f14fa7f2b8
+  data.tar.gz: e06982d22591a13c917d8c91d91f70ad9606b0b4a19addea29a21c7db68b27cc
 SHA512:
-  metadata.gz: 698a691c809a987cc45ed35ef3cbc3ee5be9d7a8a4e088b079ed04f51c0ae6c48e475bd5421534d53bf03bc905c9d76440b44b83678263307e7d084e7b00ab82
-  data.tar.gz: 9b74b4b54267f15ddbfdaf02645f36c1d6f824726f8af827735a2aac1c5780760212dd64286c8a7284e199e93b5fa653b1e06d507a10ade3c81c4d31b3a0b9db
+  metadata.gz: d0e07e0f3b6a90c78b2a27564ab457b702a169cd5fcd4665d4bba39e7a2701817dc0896a5beacc911c8df2deb0cbbf26c04c29e57485efa782fd07b50fe213ce
+  data.tar.gz: 95d72071ede043c885fc9e86945a520d48697a4ac56af6b045739eafe711f4cb5d371cd3a557cb3263fe1a03c575a46c8f75832abc967c40afe06a386217b7a5

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:
 
@@ -73,12 +69,14 @@ operation inside the block, and save it to the cache object.
 By default, the cached objects are stored in the `./cache` directory, and
 expire after 60 minutes. The cache directory will be created as needed.
 
-In addition, the provided key is hashed to its MD5 representation.
+In addition, the provided key is hashed to its MD5 representation, and the file
+permissions are optionally set.
 
 You can change these settings on initialization:
 
 ```ruby
-lightly = Lightly.new dir: 'tmp/my_cache', life: 7200, hash: false
+lightly = Lightly.new dir: 'tmp/my_cache', life: 7200,
+  hash: false, permissions: 0o640
 ```
 
 Or later:
@@ -88,16 +86,17 @@ lightly = Lightly.new
 lightly.dir = 'tmp/my_cache'
 lightly.life = '1d'
 lightly.hash = false
+lightly.permissions = 0o640
 ```
 
 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 +160,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

@@ -3,19 +3,21 @@ require 'fileutils'
 
 class Lightly
   module CacheOperations
+    attr_accessor :permissions
     attr_writer :dir, :hash
 
-    def initialize(dir: 'cache', life: '1h', hash: true, enabled: true)
+    def initialize(dir: 'cache', life: '1h', hash: true, enabled: true, permissions: nil)
       @dir = dir
       @life = life_to_seconds life
       @hash = hash
       @enabled = enabled
+      @permissions = permissions
     end
 
-    def get(key, &block)
+    def get(key)
       return load key if cached?(key) && enabled?
 
-      content = block.call
+      content = yield
       save key, content if content && enabled?
       content
     end
@@ -47,17 +49,19 @@ class Lightly
 
     def flush
       return false if dir == '/' || dir.empty?
+
       FileUtils.rm_rf dir
     end
 
     def prune
       return false if dir == '/' || dir.empty?
+
       Dir["#{dir}/*"].each { |file| expired? file }
     end
 
     def cached?(key)
       path = get_path key
-      File.exist?(path) and File.size(path) > 0 and !expired?(path)
+      File.exist?(path) and File.size(path).positive? and !expired?(path)
     end
 
     def enable
@@ -76,11 +80,11 @@ class Lightly
     def save(key, content)
       FileUtils.mkdir_p dir
       path = get_path key
-      File.open path, 'wb' do |f| 
-        f.write Marshal.dump content
+      File.open path, 'wb', permissions do |file|
+        file.write Marshal.dump(content)
       end
     end
-    
+
   private
 
     def load(key)
@@ -88,7 +92,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
@@ -97,13 +101,13 @@ class Lightly
       arg = arg.to_s
 
       case arg[-1]
-      when 's'; arg[0..-1].to_i
-      when 'm'; arg[0..-1].to_i * 60
-      when 'h'; arg[0..-1].to_i * 60 * 60
-      when 'd'; arg[0..-1].to_i * 60 * 60 * 24
-      else;     arg.to_i
+      when 's' then arg[0..].to_i
+      when 'm' then arg[0..].to_i * 60
+      when 'h' then arg[0..].to_i * 60 * 60
+      when 'd' then arg[0..].to_i * 60 * 60 * 24
+      else
+        arg.to_i
       end
     end
-
   end
 end

data/lib/lightly/lightly.rb

@@ -1,7 +1,7 @@
-class Lightly
-  include CacheOperations
-
-  class << self
-    include CacheOperations
-  end
-end
+class Lightly
+  include CacheOperations
+
+  class << self
+    include CacheOperations
+  end
+end

data/lib/lightly/version.rb

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

data/lib/lightly.rb

@@ -1,4 +1,2 @@
 require 'lightly/cache_operations'
 require 'lightly/lightly'
-
-require 'byebug' if ENV['BYEBUG']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightly
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-23 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies: []
 description: Easy to use file cache
 email: db@dannyben.com
@@ -24,7 +24,8 @@ files:
 homepage: https://github.com/DannyBen/lightly
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -33,15 +34,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: File cache for performing heavy tasks, lightly.