simple_file_cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e05ca7a4e6938b947b6d2690e2198a506bccc3f
+  data.tar.gz: 65b21f3bfbb53ee063bfa17afd1761cab146334c
+SHA512:
+  metadata.gz: 29af265e9a56c67f903c8035d3f683f02d8876b7dd5fe8e40e6a64e1f10e168879276f6666e78024a064f68f59a1b6c1e5ecc93f3e23205d8ff74fb06949e0ea
+  data.tar.gz: 7d45afe398b05fe7f08dfa1fb3a9adc9fdd08d02206caa01436852ffee7363e669c10ad3dfc9da42b0a8e8e2dc472e3854a20a6f03ea14fd8da5323376d329d5

data/lib/simple_file_cache.rb

@@ -0,0 +1,81 @@
+require 'date'
+
+module SimpleFileCache
+
+  # Check whether a cache file exists and is recent (last modified today). If so,
+  # read the file using Marshal#load and return it. Otherwise, execute the given
+  # block to obtain the new data, save to the cache file using Marshal#dump and
+  # return the updated data.
+  def self.load_or_recompute(cache_file_name, &block)
+    if cache_file_name.include?('/')
+      cache_file_pathname = cache_file_name
+    else
+      cache_file_pathname = "#{configuration.cache_dir_path}/#{cache_file_name}"
+    end
+
+    cache_file_is_recent = file_is_recent?(cache_file_pathname)
+    rails_production_env = defined?(Rails) && Rails.env.production?
+    use_cached_copy = cache_file_is_recent && !rails_production_env
+
+    if use_cached_copy
+      log "File '#{cache_file_pathname}' exists and is recent. Using cached file."
+      cache_file_contents = File.binread(cache_file_pathname)
+      return Marshal.load(cache_file_contents)
+    else
+      log "File '#{cache_file_pathname}' inexistent or out of date. Creating new cache file."
+      data_to_cache = block.call
+      File.binwrite(cache_file_pathname, Marshal.dump(data_to_cache))
+      return data_to_cache
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :cache_dir_path, :cache_expiration_policy, :cache_max_age_in_seconds
+
+    def initialize
+      @cache_dir_path = '.'
+      @cache_expiration_policy = :yesterday_or_earlier # :max_age
+      @cache_max_age_in_seconds = nil
+    end
+  end
+
+private
+
+  # Allow the client code to silence the gem by setting an environment variable
+  def self.log(message)
+    return if ENV['TEST'] != ''
+    puts message
+  end
+
+  def self.file_is_recent?(file_pathname)
+    return false unless File.exists?(file_pathname)
+
+    file_last_changed_at = File.mtime(file_pathname)
+
+    case configuration.cache_expiration_policy
+    when :yesterday_or_earlier
+      return (file_last_changed_at >= Date.today.to_time)
+    when :max_age
+      file_age = Time.now - file_last_changed_at
+      return (file_age <= configuration.cache_max_age_in_seconds)
+    else
+      return false
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: simple_file_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ricardo Jasinski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'SimpleFileCache writes a ruby object to a binary file so that it can
+  be retrieved later from the disk rather than recomputed from scratch. It defines
+  a single method #load_or_recompute that receives a file path and a block. If the
+  file exists and is recent (last changed today), it returns the file contents read
+  with Marshal#load. Otherwise, it executesthe block, saves its return value with
+  Marshal#dump and returns the new data.'
+email: jasinski@solvis.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/simple_file_cache.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: SimpleFileCache writes a ruby object to a binary file so that it can be retrieved
+  later from the disk rather than recomputed from scratch.
+test_files: []