lightly 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d5ba4144c4735730282bdb82c67439cff20c2a43
-  data.tar.gz: 16f60b591a382c7bf82f8d8ca34f13ff29865ae6
+SHA256:
+  metadata.gz: 0fe5c248715cdc07ad95d167fb7fc58ed07bcdfd90d3e04ce5f0c08915e543db
+  data.tar.gz: 7f9d04869bbb0d5ce0936a838c6b9b93a3ae3b43f4a54e6ae69a3d9d93f53781
 SHA512:
-  metadata.gz: 45209b3cb5ba6a15bf48f614015838e05c84bf0bba483464c429dfbbe422908455a86354c5b35f3ee3cc7e01c477736a844d513622ae1b29331ddbe7856376f6
-  data.tar.gz: 7b87340c8b54e0f462701dd2a3bcbc30c8fd8c72b69fb2ddf478e3100fdacf19571a1108174b3fd531573f57a28dbfa78a531156abc74d0e1e5aed5d52dcb9fc
+  metadata.gz: e70c2a3bbdda138b737eb73026fb0f33358d869abadd798ed5aaa2cd228a5a610637df8bf5622179b63cdedb3f3dc6cea34e6722fba0c0331cc671149a9dd39a
+  data.tar.gz: feb6c476128a58d3787dc868c370d73e11e545fefb134163c900e9e4c16791df536ee071aa07291846d12301ff705e490e994ab4319d9a0361ba980345879baf

data/README.md

@@ -1,10 +1,10 @@
 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://travis-ci.com/DannyBen/lightly.svg?branch=master)](https://travis-ci.com/DannyBen/lightly)
+[![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)
 
 ---
 
@@ -28,6 +28,33 @@ gem 'lightly'
 Usage
 --------------------------------------------------
 
+Lightly can be used both as an instance, and as a static class.
+
+```ruby
+require 'lightly'
+
+# Instance
+cache = Lightly.new life: '3h'
+response = cache.get 'key' do
+  # Heavy operation here
+end
+
+# Static
+Lightly.life = '3h'
+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 README are all using the instance syntax, but
+all methods are also available statically.
+
+This is the basic usage pattern:
+
 ```ruby
 require 'lightly'
 
@@ -59,10 +86,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
+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
+```
+
 To check if a key is cached, use the `cached?` method:
 
 ```ruby

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,104 @@
+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 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.new - 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
-
-  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
+  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.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightly
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-16 00:00:00.000000000 Z
+date: 2018-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: runfile
@@ -88,6 +88,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
@@ -110,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: File cache for performing heavy tasks, lightly.