lightly 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5956b20bd30f21389e0f3dc3daf5c5a2362b7224
+  data.tar.gz: 5449ea6caf3d6388f32237911dde0efff5e58b9b
+SHA512:
+  metadata.gz: 8fafa50075e2d06872960f7903567a3d2b90a35df632dc068df554e3e471408131a7345ed48d65ac53dfe4b649faf867fdc5f7f7a8bab7a6b403a021dbbdd7f6
+  data.tar.gz: edc55cef7671a634ee7fdffa6e8187f6811511a2b48b683ff20ddbd63c7e74342ad0cfe0351bd01c3eae6299767b948c854736dc3017b665d4f2293c8f77ee75

data/README.md

@@ -0,0 +1,117 @@
+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)
+
+---
+
+Lightly is a file cache for performing heavy tasks, lightly.
+
+---
+
+Install
+--------------------------------------------------
+
+```
+$ gem install lightly
+```
+
+Or with bundler:
+
+```ruby
+gem 'lightly'
+```
+
+Usage
+--------------------------------------------------
+
+```ruby
+require 'lightly'
+
+lightly = Lightly.new
+
+content = lightly.with 'key' do
+  # Heavy operation here
+end
+```
+
+This will look for a cached object with the given key and return it 
+if it exists and not older than 1 hour. Otherwise, it will perform the
+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.
+
+You can change these settings on initialization:
+
+```ruby
+lightly = Lightly.new dir: 'tmp/my_cache', life: 7200, hash: false
+```
+
+Or later:
+
+```ruby
+lightly = Lightly.new
+lightly.dir = 'tmp/my_cache'
+lightly.life = 7200 # seconds
+lightly.hash = false
+```
+
+To check if a key is cached, use the `cached?` method:
+
+```ruby
+lightly = Lightly.new
+lightly.cached? 'example'
+# => false
+
+content = lightly.with 'example' do
+  open('http://example.com').read
+end
+lightly.cached? 'example'
+# => true
+```
+
+You can enable/disable the cache at any time:
+
+```ruby
+lightly = Lightly.new
+lightly.disable
+lightly.enabled? 
+# => false
+
+content = lightly.with 'example' do
+  open('http://example.com').read
+end
+lightly.cached? 'example'
+# => false
+
+lightly.enable
+content = lightly.with 'example' do
+  open('http://example.com').read
+end
+lightly.cached? 'example'
+# => true
+```
+
+The `key` method is an alias to `with`, if you prefer a different wording:
+
+```ruby
+cache = Lightly.new
+
+content = cache.key 'example' do
+  # Heavy operation here
+end
+```
+
+---
+
+For a similar gem that provides caching specifically for HTTP downloads,
+see the [WebCache gem][1]
+
+
+[1]: https://github.com/DannyBen/webcache

data/lib/lightly.rb

@@ -0,0 +1,2 @@
+require 'lightly/version'
+require 'lightly/lightly'

data/lib/lightly/lightly.rb

@@ -0,0 +1,69 @@
+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 with(key, &block)
+    return load key if cached?(key) && enabled?
+
+    content = block.call
+    save key, content if enabled?
+    content
+  end
+  alias_method :key, :with
+
+  def flush
+    return false if dir == '/' || dir.empty?
+    FileUtils.rm_rf dir
+  end
+
+  def enabled?
+    @enabled
+  end
+
+  def enable
+    @enabled = true
+  end
+
+  def disable
+    @enabled = false
+  end
+
+  def cached?(key)
+    path = get_path key
+    File.exist? path and !expired? path
+  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
+
+  def get_path(key)
+    key = Digest::MD5.hexdigest(key) if hash
+    File.join dir, key
+  end
+
+  def expired?(path)
+    expired = life > 0 && File.exist?(path) && Time.new - File.mtime(path) >= life
+    FileUtils.rm path if expired
+    expired
+  end
+end

data/lib/lightly/version.rb

@@ -0,0 +1,3 @@
+class Lightly
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: lightly
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-25 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'
+description: Easy to use file cache
+email: db@dannyben.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/lightly.rb
+- lib/lightly/lightly.rb
+- lib/lightly/version.rb
+homepage: https://github.com/DannyBen/lightly
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: File cache for performing heavy tasks, lightly.
+test_files: []