lightly 0.2.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9a343ae5ae80c807c21ae3232b79b9c4f47c17a8
-  data.tar.gz: 7da3c16d45bdb06ce8fb16fdef435536a18950a2
+SHA256:
+  metadata.gz: d313f9708367bd12cd91e8a40edfead09bdab9abb923f1ba1b7cbd5129ff61e5
+  data.tar.gz: 6b19b9bf03a20d1725c5a9ef018a1e75fb945860195b158052dc74a0a0cc3de9
 SHA512:
-  metadata.gz: 06706e26745ca5eae88429319246343919ca64b70c3bbc61b6e33b85059c83121b501d5fdbfb02c4f3c21dd5ca5e44e4d0476286964dd774718b35e0679d73a8
-  data.tar.gz: 424ea5fa471dea9c91e785f69586d365011baa11153eb3702e7032ca0467ccce25ecab823af847609388d95a4d9b2ca66357b5490b56df964aa369336d28e704
+  metadata.gz: 0b1836e246ed0b7d2e3212fd9a273f390df4f34c992b1817ba326e11f12a23303c02c40bd398a3d633eb37c0761a59b7b268c125ef6d3b472a436ff93345b52d
+  data.tar.gz: 7023d499f4fa07b16c4580a0f6507970898cd507c097c1c7a88638174afe101c356e0435b290f78f0aedea8d578ccde2cea06fb3390ecf7b530275eaf4b74cf8

data/README.md

@@ -1,10 +1,8 @@
-Lightly - Ruby File Cache
-==================================================
+# Lightly - Ruby File Cache
 
-[![Gem](https://img.shields.io/gem/v/lightly.svg?style=flat-square)](https://rubygems.org/gems/lightly)
-[![Travis](https://img.shields.io/travis/DannyBen/lightly.svg?style=flat-square)](https://travis-ci.org/DannyBen/lightly)
-[![Code Climate](https://img.shields.io/codeclimate/github/DannyBen/lightly.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/lightly)
-[![Gemnasium](https://img.shields.io/gemnasium/DannyBen/lightly.svg?style=flat-square)](https://gemnasium.com/DannyBen/lightly)
+[![Gem Version](https://badge.fury.io/rb/lightly.svg)](https://badge.fury.io/rb/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)
 
 ---
 
@@ -12,10 +10,9 @@ Lightly is a file cache for performing heavy tasks, lightly.
 
 ---
 
-Install
---------------------------------------------------
+## Install
 
-```
+```shell
 $ gem install lightly
 ```
 
@@ -25,8 +22,34 @@ Or with bundler:
 gem 'lightly'
 ```
 
-Usage
---------------------------------------------------
+## Usage
+
+Lightly can be used both as an instance, and as a static class.
+
+```ruby
+require 'lightly'
+
+# Instance
+lightly = Lightly.new life: '3h'
+response = lightly.get 'key' do
+  # Heavy operation here
+end
+
+# Static
+Lightly.life = '3h'
+response = Lightly.get 'key' do
+  # Heavy operation here
+end
+```
+
+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 document are all using the instance syntax,
+but all methods are also available statically.
+
+This is the basic usage pattern:
 
 ```ruby
 require 'lightly'
@@ -59,10 +82,20 @@ Or later:
 ```ruby
 lightly = Lightly.new
 lightly.dir = 'tmp/my_cache'
-lightly.life = 7200 # seconds
+lightly.life = '1d'
 lightly.hash = false
 ```
 
+The `life` property accepts any of these formats:
+
+```ruby
+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:
 
 ```ruby
@@ -117,21 +150,35 @@ lightly = Lightly.new
 lightly.clear 'example'
 ```
 
-If your block returns false or nil, the data will not be cached:
+To clear all expired keys, call:
+
+```ruby
+lightly = Lightly.new
+lightly.prune
+```
+
+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.rb

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

data/lib/lightly/cache_operations.rb

@@ -0,0 +1,109 @@
+require 'digest/md5'
+require 'fileutils'
+
+class Lightly
+  module CacheOperations
+    attr_writer :dir, :hash
+
+    def initialize(dir: 'cache', life: '1h', hash: true, enabled: true)
+      @dir = dir
+      @life = life_to_seconds life
+      @hash = hash
+      @enabled = enabled
+    end
+
+    def get(key, &block)
+      return load key if cached?(key) && enabled?
+
+      content = block.call
+      save key, content if content && enabled?
+      content
+    end
+
+    def life
+      @life ||= 3600
+    end
+
+    def life=(new_life)
+      @life = life_to_seconds new_life
+    end
+
+    def dir
+      @dir ||= 'cache'
+    end
+
+    def hash?
+      @hash ||= (@hash.nil? ? true : @hash)
+    end
+
+    def enabled?
+      @enabled ||= (@enabled.nil? ? true : @enabled)
+    end
+
+    def clear(key)
+      path = get_path key
+      FileUtils.rm path if File.exist? path
+    end
+
+    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)
+    end
+
+    def enable
+      @enabled = true
+    end
+
+    def disable
+      @enabled = false
+    end
+
+    def get_path(key)
+      key = Digest::MD5.hexdigest(key) if hash?
+      File.join dir, key
+    end
+
+    def save(key, content)
+      FileUtils.mkdir_p dir
+      path = get_path key
+      File.open path, 'wb' do |f| 
+        f.write Marshal.dump content
+      end
+    end
+    
+  private
+
+    def load(key)
+      Marshal.load File.binread(get_path key)
+    end
+
+    def expired?(path)
+      expired = life >= 0 && File.exist?(path) && Time.now - File.mtime(path) >= life
+      FileUtils.rm path if expired
+      expired
+    end
+
+    def life_to_seconds(arg)
+      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
+      end
+    end
+
+  end
+end

data/lib/lightly/lightly.rb

@@ -1,73 +1,7 @@
-require 'digest/md5'
-require 'fileutils'
-
 class Lightly
-  attr_accessor :dir, :life, :hash
-
-  def initialize(opts={})
-    @dir = opts[:dir] || 'cache'
-    @life = opts[:life] || 3600
-    @hash = opts.key?(:hash) ? opts[:hash] : true
-    @enabled = true
-  end
-
-  def get(key, &block)
-    return load key if cached?(key) && enabled?
-
-    content = block.call
-    save key, content if content && enabled?
-    content
-  end
-
-  def clear(key)
-    path = get_path key
-    FileUtils.rm path if File.exist? path
-  end
-
-  def flush
-    return false if dir == '/' || dir.empty?
-    FileUtils.rm_rf dir
-  end
-
-  def enabled?
-    @enabled
-  end
-
-  def cached?(key)
-    path = get_path key
-    File.exist?(path) and File.size(path) > 0 and !expired?(path)
-  end
-
-  def enable
-    @enabled = true
-  end
-
-  def disable
-    @enabled = false
-  end
-
-  def get_path(key)
-    key = Digest::MD5.hexdigest(key) if hash
-    File.join dir, key
-  end
-
-  private
-
-  def save(key, content)
-    FileUtils.mkdir_p dir
-    path = get_path key
-    File.open path, 'wb' do |f| 
-      f.write Marshal.dump content
-    end
-  end
-
-  def load(key)
-    Marshal.load File.binread(get_path key)
-  end
+  include CacheOperations
 
-  def expired?(path)
-    expired = life > 0 && File.exist?(path) && Time.new - File.mtime(path) >= life
-    FileUtils.rm path if expired
-    expired
+  class << self
+    include CacheOperations
   end
 end

data/lib/lightly/version.rb

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

metadata

@@ -1,85 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: lightly
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-15 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: runfile
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: runfile-tasks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
+date: 2020-06-12 00:00:00.000000000 Z
+dependencies: []
 description: Easy to use file cache
 email: db@dannyben.com
 executables: []
@@ -88,6 +18,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/lightly.rb
+- lib/lightly/cache_operations.rb
 - lib/lightly/lightly.rb
 - lib/lightly/version.rb
 homepage: https://github.com/DannyBen/lightly
@@ -109,8 +40,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: File cache for performing heavy tasks, lightly.