dragonfly-cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b1e061f17b26657fa84f4c209065c21252cf93506e360f5163bd11275265ead
+  data.tar.gz: ac29268ea5f9f80b0c001756824dc7bec2cba028bef6c11c11a26123b3c76068
+SHA512:
+  metadata.gz: 5770d3c394b80041de1a096948d883f4170d9a69f91c4ab3757b020db2878291f53760bc63ac97a906d52e29841119846770e41224d68d5dc39c3fd0ca34ba30
+  data.tar.gz: bf0aa35be633102f0b1957c4e37849c2c507539c0a656838be955332f7a94a2dfc42270f24e2235175b63e5dfca1ef0f15fc83783cf35e124550a7643291257d

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dragonfly-cache.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    dragonfly-cache (0.1.0)
+      dragonfly (~> 1.1.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    diff-lcs (1.3)
+    dragonfly (1.1.5)
+      addressable (~> 2.3)
+      multi_json (~> 1.0)
+      rack (>= 1.3)
+    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)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.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)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  dragonfly-cache!
+  rake (~> 10.0)
+  rspec (~> 3.8.0)
+  rubocop
+
+BUNDLED WITH
+   1.16.2

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2018 notus.sh
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,45 @@
+# dragonfly-cache
+
+`dragonfly-cache` is a cache adapter for [Dragonfly](http://markevans.github.io/dragonfly/). It allows you to store Dragonfly's jobs results without running them again and again on each call. 
+
+**For now**, `dragonfly-cache` supports only local caching of local files. It will be extended in a near future to support remote cache and file storages. 
+
+## Installation
+
+Add `dragonfly-cache` to your application's Gemfile:
+
+```ruby
+gem 'dragonfly-cache'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install dragonfly-cache
+```
+
+## Configuration
+
+Once installed, you should configure `dragonfly-cache` to set your application's root (`/public` by default, if the directory exists) and your cached url format (`/dragonfly-cache/:sha/:name` by default).
+
+```ruby
+Dragonfly.app.configure do
+  plugin :dragonfly_cache,
+    server_root: Rails.application.root.join('public'),
+    url_format:  '/media-cache/:sha/:name'
+end
+```
+
+Configured as this, cached files will be stored in `/public/media-cache/:sha/:name`, where `:name` is [the Dragonfly `:name` attribute of the attached file](http://markevans.github.io/dragonfly/models#name-and-extension) and `:sha` is a contraction of the job SHA params.
+
+`dragonfly-cache` will try to do its best to shorten the `:sha` part of the url and prevent cache conflicts.
+
+## 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`. 

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.options = ['--config', 'config/linters/ruby.yml']
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task default: :spec

data/config/linters/ruby.yml

@@ -0,0 +1,11 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+Metrics/LineLength:
+  Max: 150
+
+# DSLs produce long blocks.
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'

data/dragonfly-cache.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dragonfly/cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dragonfly-cache'
+  spec.version       = Dragonfly::Cache::VERSION
+  spec.licenses      = ['Apache-2.0']
+  spec.authors       = ['Gaël-Ian Havard']
+  spec.email         = ['gael-ian@notus.sh']
+
+  spec.summary       = 'Cache adapter for Dragonfly'
+  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
+
+  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.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 'rubocop'
+
+  spec.post_install_message = <<~POST_INSTALL_MESSAGE
+    Don't forget to configure Dragonfly::Cache:
+
+        Dragonfly.app.configure do
+          plugin :dragonfly_cache,
+            server_root: Rails.application.root.join('public'),
+            url_format:  '/media-cache/:sha/:name'
+        end
+
+  POST_INSTALL_MESSAGE
+end

data/lib/dragonfly/cache.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'dragonfly'
+
+module Dragonfly
+  module Cache
+    class Error < ::StandardError; end
+  end
+end
+
+require 'dragonfly/cache/plugin'
+Dragonfly::App.register_plugin(:dragonfly_cache) { Dragonfly::Cache::Plugin.new }

data/lib/dragonfly/cache/config.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Dragonfly
+  module Cache
+    class Config
+      attr_accessor :servers_options
+
+      def initialize(servers_options = {})
+        self.servers_options = {
+          url_format: '/dragonfly-cache/:sha/:name',
+          server_root: File.join(Dir.pwd, 'public')
+        }.merge(servers_options)
+
+        validate!
+        rewrite_url_format!
+      end
+
+      protected
+
+      def validate!
+        if servers_options[:server_root].nil? || !File.exist?(servers_options[:server_root])
+          raise Dragonfly::Cache::Error, ':server_root option is missing or directory does not exist'
+        end
+
+        raise Dragonfly::Cache::Error, ':url_format option must include `:sha`' if (servers_options[:url_format] =~ %r{/:sha/}).nil?
+      end
+
+      def rewrite_url_format!
+        servers_options[:url_format] = servers_options[:url_format].gsub(%r{/:sha/}, '/:shaish/')
+      end
+    end
+  end
+end

data/lib/dragonfly/cache/manager.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'dragonfly/cache/storage'
+
+module Dragonfly
+  module Cache
+    class Manager
+      extend Forwardable
+
+      MIN_SHA_SIZE = 2
+      MAX_SHA_SIZE = 16 # Length of SHA identifier generated by Dragonfly
+
+      attr_reader :plugin, :storage, :sha_size
+
+      delegate %i[servers_options] => :plugin
+      delegate %i[write writen? current_max_sha_size base_dir] => :storage
+
+      def initialize(plugin)
+        @plugin   = plugin
+        @storage  = Dragonfly::Cache::Storage.new(self)
+        initialize!
+      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
+
+      protected
+
+      def wrong_key?(job, uri)
+        @cache_map.value?(uri.path) && @cache_map.key(uri.path) != job.sha
+      end
+
+      def wrong_value?(job, uri)
+        @cache_map.key?(job.sha) && @cache_map[job.sha] != uri.path
+      end
+
+      def initialize!
+        detect_sha_size
+        load_map
+      rescue ::StandardError => e
+        raise Dragonfly::Cache::Error, e.message
+      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
+
+        @cache_map.clear
+        save_map
+      end
+
+      def map_path
+        @map_path ||= File.join(base_dir, 'map.yml')
+      end
+
+      def load_map
+        @cache_map = File.size?(map_path) ? YAML.load_file(map_path) : {}
+      end
+
+      def save_map
+        File.open(map_path, 'wb') { |f| YAML.dump(@cache_map, f) }
+      end
+
+      def map(job, uri)
+        @cache_map[job.sha] = uri.path
+        save_map
+      end
+
+      def mapped?(job, _uri)
+        @cache_map.key?(job.sha)
+      end
+    end
+  end
+end

data/lib/dragonfly/cache/plugin.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'dragonfly/cache/config'
+require 'dragonfly/cache/manager'
+
+module Dragonfly
+  module Cache
+    class Plugin
+      extend Forwardable
+
+      @@servers = {}
+
+      attr_reader :config, :manager
+
+      delegate %i[servers_options] => :config
+      delegate %i[sha_size valid_uri? store] => :manager
+
+      def call(app, cache_servers_options = {})
+        @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)
+        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
+      end
+
+      def find_valid_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)
+        end
+      end
+
+      def options_for(job)
+        {
+          shaish: job.sha[0..(sha_size - 1)]
+        }
+      end
+
+      def server_for(app)
+        @@servers[app.name] ||= begin
+          server = app.server.dup
+          servers_options.each do |name, value|
+            server.send("#{name}=", value) if server.respond_to?("#{name}=")
+          end
+          server
+        end
+      end
+    end
+  end
+end

data/lib/dragonfly/cache/storage.rb

@@ -0,0 +1,68 @@
+# 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

data/lib/dragonfly/cache/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Dragonfly
+  module Cache
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: dragonfly-cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gaël-Ian Havard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-07 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Allow Dragonfly to keep a cache of jobs results
+email:
+- gael-ian@notus.sh
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- config/linters/ruby.yml
+- dragonfly-cache.gemspec
+- lib/dragonfly/cache.rb
+- lib/dragonfly/cache/config.rb
+- lib/dragonfly/cache/manager.rb
+- lib/dragonfly/cache/plugin.rb
+- lib/dragonfly/cache/storage.rb
+- lib/dragonfly/cache/version.rb
+homepage: https://github.com/notus-sh/dragonfly-cache
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: |+
+  Don't forget to configure Dragonfly::Cache:
+
+      Dragonfly.app.configure do
+        plugin :dragonfly_cache,
+          server_root: Rails.application.root.join('public'),
+          url_format:  '/media-cache/:sha/:name'
+      end
+
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Cache adapter for Dragonfly
+test_files: []