dragonfly-cache 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69db42bcdd7613f8f7738bec974e989b3863d508b24757fff67b4e003b6b5a04
-  data.tar.gz: 5b48ec8599fb6aed358fb281d6f4c137aa75c427cc22554557cf61f99e0ee9f1
+  metadata.gz: f3df881ab7d62b87cd00ab7361c614250cc1a8706b9d2cc416a2ddb1f5d34256
+  data.tar.gz: 6cef3e6bdcb69d1e0418060e8db484f6b40dc2ede64ea03ca99f4aefc025e452
 SHA512:
-  metadata.gz: 789d49580b89f059a1086466fc22975e71bcc8cd435467efe4000dc3b1da7609187442f1514687b42df1d5ba1bd5f6543b034a6b5cb046f36a9ff3bcb1b6092c
-  data.tar.gz: cf0a7cd0b9d29a7470ea057e085c2f92cb495bf74cb87cff5d6151776d51db06f1d8b44058a7d8919eba2b0cd261ba363a4c407ac396924dfa242c102b57aacd
+  metadata.gz: 96a06ce4971e5ba10fc15be6789582e5e3202993a69bcc4c92504949033c2ec420f648b4cd61f1de88d41182cdae624fb4c097723b47dd81be637032d7e2dbf2
+  data.tar.gz: e6c1aedbd009728f83dcdbb894116d5f6ad19e938088c17f229ce75679315961d1189123c4614b2c7c92b2db3ca99be8fbf553ee021fce6b60e018502f6507a8

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+sudo: false
+script: "bundle exec rake clean spec"
+
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+
+gemfile:
+  - Gemfile

data/Gemfile.lock

@@ -1,67 +1,70 @@
 PATH
   remote: .
   specs:
-    dragonfly-cache (0.1.2)
-      dragonfly (~> 1.1.5)
+    dragonfly-cache (0.1.7)
+      dragonfly
       i18n
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
-    concurrent-ruby (1.0.5)
-    diff-lcs (1.3)
-    dragonfly (1.1.5)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    dragonfly (1.2.1)
       addressable (~> 2.3)
       multi_json (~> 1.0)
       rack (>= 1.3)
-    i18n (1.1.0)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.1)
-    multi_json (1.13.1)
-    parallel (1.12.1)
-    parser (2.5.1.2)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    public_suffix (3.0.3)
-    rack (2.0.5)
+    multi_json (1.15.0)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rack (2.2.3)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.58.2)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.1.0)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.0.1)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.10.0)
-    unicode-display_width (1.4.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.1)
   dragonfly-cache!
-  rake (~> 10.0)
-  rspec (~> 3.8.0)
+  rake (~> 13.0)
+  rspec (~> 3.10.0)
   rubocop
 
 BUNDLED WITH
-   1.16.2
+   2.1.4

data/README.md

@@ -43,3 +43,7 @@ Configured as this, cached files will be stored in `/public/media-cache/:sha/:na
 ## How does it work?
 
 `dragonfly-cache` use a method similar to [the one described in the Dragonfly documentation to process files on-the-fly and serve them remotely](http://markevans.github.io/dragonfly/cache#processing-on-the-fly-and-serving-remotely) but use only `define_url`. 
+
+## Credits
+
+The dragonfly photography used in specs is a work from [André Karwath](https://commons.wikimedia.org/wiki/User:Aka) and is licensed under the [Creative Commons Attribution-Share Alike 2.5 Generic](https://creativecommons.org/licenses/by-sa/2.5/deed.en) license.

data/dragonfly-cache.gemspec

@@ -15,23 +15,23 @@ Gem::Specification.new do |spec|
   spec.description   = 'Allow Dragonfly to keep a cache of jobs results'
   spec.homepage      = 'https://github.com/notus-sh/dragonfly-cache'
 
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else
-    raise 'RubyGems 2.0 or newer is required.'
-  end
+  raise 'RubyGems 2.0 or newer is required.' unless spec.respond_to?(:metadata)
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.require_paths = ['lib']
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
-  spec.add_dependency 'dragonfly', '~> 1.1.5'
+  spec.required_ruby_version = '>= 2.5'
+
+  spec.add_dependency 'dragonfly'
   spec.add_dependency 'i18n'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.8.0'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
   spec.add_development_dependency 'rubocop'
 
   spec.post_install_message = <<~POST_INSTALL_MESSAGE

data/lib/dragonfly/cache/config.rb

@@ -15,6 +15,13 @@ module Dragonfly
         rewrite_url_format!
       end
 
+      def base_dir
+        @base_dir ||= begin
+          path_format = File.join(servers_options[:server_root], servers_options[:url_format])
+          path_format.split('/').take_while { |p| p != ':shaish' }.join('/')
+        end
+      end
+
       protected
 
       def validate!

data/lib/dragonfly/cache/manager.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require 'dragonfly/cache/storage'
+require 'dragonfly/cache/mapper/yaml'
+require 'dragonfly/cache/storage/local'
 
 module Dragonfly
   module Cache
@@ -10,79 +11,66 @@ module Dragonfly
       MIN_SHA_SIZE = 2
       MAX_SHA_SIZE = 16 # Length of SHA identifier generated by Dragonfly
 
-      attr_reader :plugin, :storage, :sha_size
+      attr_reader :plugin, :storage, :map
 
-      delegate %i[servers_options] => :plugin
-      delegate %i[write writen? current_max_sha_size base_dir] => :storage
+      delegate %i[config] => :plugin
 
       def initialize(plugin)
-        @plugin   = plugin
-        @storage  = Dragonfly::Cache::Storage.new(self)
-        initialize!
+        @plugin = plugin
+        @map = Dragonfly::Cache::Mapper::Yaml.new(config.servers_options)
+        @storage = Dragonfly::Cache::Storage::Local.new(config.servers_options)
       end
 
-      def valid_uri?(job, uri)
-        return true unless wrong_key?(job, uri) || wrong_value?(job, uri)
-        increase_sha_size!
-        false
-      end
-
-      def store(job, uri)
-        write(job, uri) unless writen?(job, uri)
-        map(job, uri)   unless mapped?(job, uri)
-      rescue Dragonfly::Cache::Error => e
-        Dragonfly.warn(e.message)
-      end
+      def cache(job)
+        return @map[job.sha] if @map.key?(job.sha)
 
-      protected
-
-      def wrong_key?(job, uri)
-        @cache_map.value?(uri.path) && @cache_map.key(uri.path) != job.sha
+        store(job, yield)
       end
 
-      def wrong_value?(job, uri)
-        @cache_map.key?(job.sha) && @cache_map[job.sha] != uri.path
+      def valid?(job, uri)
+        valid = (@map.key?(job.sha) && @map[job.sha] == uri) || !@map.key?(job.sha)
+        valid &= (@map.value?(uri) && @map.key(uri) == job.sha) || !@map.value?(uri)
+        increase_sha_size! unless valid
+        valid
       end
 
-      def initialize!
-        detect_sha_size
-        load_map
-      rescue ::StandardError => e
-        raise Dragonfly::Cache::Error, e.message
+      def job_options(job)
+        {
+          shaish: shaish(job),
+          normalized_name: normalized_name(job)
+        }
       end
 
-      def detect_sha_size
-        @sha_size = [current_max_sha_size, MIN_SHA_SIZE].compact.max
-        @sha_size = [@sha_size, MAX_SHA_SIZE].min
-      end
-
-      def increase_sha_size!
-        raise Error, "Can't build longer :sha identifier" if @sha_size == MAX_SHA_SIZE
-        @sha_size += 1
+      protected
 
-        @cache_map.clear
-        save_map
+      def shaish(job)
+        job.sha[0..(sha_size - 1)]
       end
 
-      def map_path
-        @map_path ||= File.join(base_dir, 'map.yml')
+      def normalized_name(job)
+        basename = job.basename || job.signature
+        sanitized = basename.gsub(/[[:space:][:punct:][:cntrl:]]/, ' ').squeeze(' ').strip
+        transliterated = I18n.transliterate(sanitized, replacement: ' ').squeeze(' ').strip
+        downcased = (transliterated.empty? ? job.signature : transliterated).downcase.tr(' ', '-')
+        [downcased, job.ext].compact.join('.')
       end
 
-      def load_map
-        @cache_map = File.size?(map_path) ? YAML.load_file(map_path) : {}
+      def sha_size
+        @sha_size ||= [[storage.sha_size, MIN_SHA_SIZE].compact.max, MAX_SHA_SIZE].min
       end
 
-      def save_map
-        File.open(map_path, 'wb') { |f| YAML.dump(@cache_map, f) }
-      end
+      def increase_sha_size!
+        raise Error, "Can't build longer :sha identifier" if @sha_size == MAX_SHA_SIZE
 
-      def map(job, uri)
-        @cache_map[job.sha] = uri.path
-        save_map
+        @sha_size += 1
       end
 
-      def mapped?(job, _uri)
-        @cache_map.key?(job.sha)
+      def store(job, url)
+        storage.store(url, job)
+        map.store(job.sha, url)
+        url
+      rescue Dragonfly::Cache::Error => e
+        Dragonfly.warn(e.message)
       end
     end
   end

data/lib/dragonfly/cache/mapper/yaml.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Dragonfly
+  module Cache
+    module Mapper
+      class Yaml
+        extend Forwardable
+
+        attr_reader :root, :internal
+
+        delegate %i[[] key? value? key keys values] => :internal
+
+        def initialize(config)
+          @root = config[:server_root]
+          @internal = {}
+          load!
+        end
+
+        def store(key, value)
+          @internal[key] = value
+          save!
+        end
+
+        alias []= store
+
+        protected
+
+        def path
+          @path ||= File.join(root, 'map.yml')
+        end
+
+        def load!
+          @internal = File.size?(path) ? YAML.load_file(path) : {}
+        end
+
+        def save!
+          File.open(path, 'wb') { |f| YAML.dump(@internal, f) }
+        end
+      end
+    end
+  end
+end

data/lib/dragonfly/cache/plugin.rb

@@ -17,56 +17,38 @@ module Dragonfly
 
       attr_reader :config, :manager
 
-      delegate %i[servers_options] => :config
-      delegate %i[sha_size valid_uri? store] => :manager
+      delegate %i[cache valid? job_options] => :manager
 
       def call(app, cache_servers_options = {})
-        @config   = Dragonfly::Cache::Config.new(cache_servers_options)
-        @manager  = Dragonfly::Cache::Manager.new(self)
+        @config = Dragonfly::Cache::Config.new(cache_servers_options)
+        @manager = Dragonfly::Cache::Manager.new(self)
 
-        app.define_url do |app, job, opts|
-          url_for(app, job, opts)
+        app.define_url do |same, job, opts|
+          url_for(same, job, opts)
         rescue Dragonfly::Cache::Error => e
           Dragonfly.warn(e.message)
           app.server.url_for(job, opts) # Fallback to default Dragonfly::App url building
         end
       end
 
-      protected
-
       def url_for(app, job, opts)
-        uri = find_valid_url_for(app, job, opts)
-        # File are stored on url building instead of in a before_serve block to allow use of assets host
-        store(job, uri)
-        uri.to_s
+        cache(job) { build_url_for(app, job, opts) }
       end
 
-      def find_valid_url_for(app, job, opts)
+      protected
+
+      def build_url_for(app, job, opts)
         loop do
-          url = server_for(app).url_for(job, options_for(job).merge(opts))
-          uri = URI.parse(url)
-          uri.query = nil
-          uri.fragment = nil
-          return uri if valid_uri?(job, uri)
+          url = server_for(app).url_for(job, job_options(job).merge(opts))
+          path = URI.parse(url).path
+          return path if valid?(job, path)
         end
       end
 
-      def options_for(job)
-        basename = job.basename || job.signature
-        sanitized = basename.gsub(/[[:space:][:punct:][:cntrl:]]/, ' ').squeeze(' ').strip
-        transliterated = I18n.transliterate(sanitized, replacement: ' ').squeeze(' ').strip
-        downcased = (transliterated.empty? ? job.signature : transliterated).downcase.tr(' ', '-')
-
-        {
-          shaish: job.sha[0..(sha_size - 1)],
-          normalized_name: [downcased, job.ext].join('.')
-        }
-      end
-
       def server_for(app)
         @@servers[app.name] ||= begin
           server = app.server.dup
-          servers_options.each do |name, value|
+          config.servers_options.each do |name, value|
             server.send("#{name}=", value) if server.respond_to?("#{name}=")
           end
           server

data/lib/dragonfly/cache/storage/local.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Dragonfly
+  module Cache
+    module Storage
+      class Local
+        attr_reader :root, :format
+
+        def initialize(config)
+          @root = config[:server_root]
+          @format = config[:url_format]
+        end
+
+        def store(url, job)
+          job.to_file(path(url), mode: 0o644)
+        end
+
+        def sha_size
+          longest = Dir["#{base_dir}/*"].select { |p| File.directory?(p) }.max { |a, b| a <=> b }
+          (longest ? File.basename(longest).size : nil)
+        end
+
+        protected
+
+        def path(url)
+          File.join(root, url)
+        end
+
+        def base_dir
+          @base_dir ||= begin
+            path_format = File.join(root, format)
+            path_format.split('/').take_while { |p| p != ':shaish' }.join('/')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dragonfly/cache/version.rb

@@ -2,6 +2,6 @@
 
 module Dragonfly
   module Cache
-    VERSION = '0.1.2'
+    VERSION = '0.1.7'
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dragonfly-cache
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Gaël-Ian Havard
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-07 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dragonfly
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -44,42 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -113,8 +114,9 @@ files:
 - lib/dragonfly/cache.rb
 - lib/dragonfly/cache/config.rb
 - lib/dragonfly/cache/manager.rb
+- lib/dragonfly/cache/mapper/yaml.rb
 - lib/dragonfly/cache/plugin.rb
-- lib/dragonfly/cache/storage.rb
+- lib/dragonfly/cache/storage/local.rb
 - lib/dragonfly/cache/version.rb
 homepage: https://github.com/notus-sh/dragonfly-cache
 licenses:
@@ -137,16 +139,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Cache adapter for Dragonfly
 test_files: []
+...

data/lib/dragonfly/cache/storage.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module Dragonfly
-  module Cache
-    class Storage
-      extend Forwardable
-
-      attr_reader :manager
-
-      delegate %i[servers_options] => :manager
-
-      def initialize(manager)
-        @manager = manager
-        check_directory!(base_dir)
-      end
-
-      def current_max_sha_size
-        longest = Dir["#{base_dir}/*"].select { |p| File.directory?(p) }.max { |a, b| a <=> b }
-        (longest ? File.basename(longest).size : nil)
-      end
-
-      def write(job, uri)
-        path = cache_path(uri)
-        check_directory!(File.dirname(path))
-        with_umask(0o022) do
-          job.to_file(path, mode: 0o644, mkdirs: false)
-        end
-      end
-
-      def writen?(_job, uri)
-        File.exist?(cache_path(uri))
-      end
-
-      def base_dir
-        @base_dir ||= begin
-          path_format = File.join(servers_options[:server_root], servers_options[:url_format])
-          path_format.split('/').take_while { |p| p != ':shaish' }.join('/')
-        end
-      end
-
-      protected
-
-      def check_directory!(directory)
-        return if File.exist?(directory) && File.directory?(directory) && File.writable?(directory)
-        with_umask(0o022) do
-          File.unlink(directory) if File.exist?(directory) && !File.directory?(directory)
-          FileUtils.mkdir_p(directory, mode: 0o755) unless File.exist?(directory)
-          File.chmod(0o755, directory) unless File.writable?(directory)
-        end
-      rescue ::StandardError => e
-        raise Dragonfly::Cache::Error, e.message
-      end
-
-      def with_umask(umask)
-        original_umask = File.umask(umask)
-        begin
-          yield
-        ensure
-          File.umask(original_umask)
-        end
-      end
-
-      def cache_path(uri)
-        File.join(servers_options[:server_root], uri.path)
-      end
-    end
-  end
-end