dragonfly-cache 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 561fa0bea39eade52c3ee69a15a630ddbc7241ef2a35541fac85203885bcd5a9
-  data.tar.gz: aef5435adb61fbde4c8415f9347564bb60c995f49f521e3ed8dc831002668e8e
+  metadata.gz: c8ff08670c9d9c9d4c8e0a98d947fb0c60c0296b1637de15372360641ca76baa
+  data.tar.gz: 75dee33b161617d4f2111b1d775f81675fda51229a223b5794fd327e777b0269
 SHA512:
-  metadata.gz: 52f872f835d64278e48732f144496f262337207195040b7277e1b2869f0c99552002c056cce188baf272d51ecfe875688e12f9798212f687b63cc6b605339ba6
-  data.tar.gz: 617e6ef49815dd8d0c7e214893f168d431da0343679049adf4a9f786ed4dddf49652d675ccbac13f484176e257815b40e6f71fbd34ef033c0d475f9c510fdafe
+  metadata.gz: 71fc18dd9cbf1a3b92f63643a9a487f8cc6a3509b117235affb7cb4371713720ecbc50110d7ba19a0740f17f90824756476652be2da31bdda821875c34012ae5
+  data.tar.gz: 9e6df8971b08644ff5a5595c5f1e0b8caf2e40fef07e3db92fad87274afca0cb24e96aa05fb0193904a339b1bb56ee548637cba9633c0a2bec3dbea54aa61a98

data/CHANGELOG.md

@@ -0,0 +1,89 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## Version 0.2.0 (2025-10-23)
+
+### Changed
+
+* Configure Dependabot to automatically update Github Actions (#27)
+* Bump minimum required Ruby version to 3.2 (#25)
+* Remove Ruby 3.0 and Ruby 3.1 from the test matrix (#23)
+* Add Ruby 3.4 to the test matrix (#20)
+* Update test matrix (#14)  
+  Add Ruby 3.3. Drop Ruby 2.6 and Ruby 2.7
+* Migrate from Travis CI to Github Actions
+* Add Ruby 3.2 to the test matrix
+* Introduce `rubocop-performance` and simplify configuration
+
+### Fixed
+
+* Fix tests to be compatible Dragonfly 1.4
+
+## Version 0.1.8 (2021-04-03)
+
+### Breaking changes
+
+* Drop support for Ruby 2.5
+
+### Changed
+
+* Compatibility with Ruby 3.0
+
+## Version 0.1.7 (2020-11-02)
+
+### Breaking changes
+
+* Drop support for Ruby < 2.5
+
+### Added
+
+* Introduce Travis CI to run unit tests on all supported Ruby versions
+
+## Version 0.1.6 (2019-04-29)
+
+### Changed
+
+* Loosen version constraint to Dragonfly
+
+## Version 0.1.5 (2018-12-17)
+
+### Fixed
+
+* Strengthen cache key validation to avoid collisions (#1)
+
+## Version 0.1.4 (2018-10-08)
+
+### Fixed
+
+* Load existing map on startup
+
+## Version 0.1.3 (2018-09-13)
+
+### Fixed
+
+* Ensure job are only processed once
+
+### Other changes
+
+* Refactor cache logic
+
+## Version 0.1.2 (2018-09-07)
+
+### Fixed
+
+* Ensure normalized filenames keep their extension
+
+## Version 0.1.1 (2018-09-07)
+
+### Added
+
+* Add automatic filenames cleaning
+
+## Version 0.1.0 (2028-09-07)
+
+Initial release.

data/README.md

@@ -1,5 +1,8 @@
 # dragonfly-cache
 
+[![Unit tests](https://github.com/notus-sh/dragonfly-cache/actions/workflows/unit-tests.yml/badge.svg?branch=main)](https://github.com/notus-sh/dragonfly-cache/actions/workflows/unit-tests.yml)
+[![Gem Version](https://badge.fury.io/rb/dragonfly-cache.svg)](https://badge.fury.io/rb/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. 

data/dev/gemfiles/ci.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec path: '../..'
+gem 'base64'
+gem 'logger'

data/dragonfly-cache.gemspec

@@ -17,24 +17,33 @@ Gem::Specification.new do |spec|
 
   raise 'RubyGems 2.0 or newer is required.' unless spec.respond_to?(:metadata)
 
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'rubygems_mfa_required' => 'true',
+
+    'bug_tracker_uri' => 'https://github.com/notus-sh/dragonfly-cache/issues',
+    'changelog_uri' => 'https://github.com/notus-sh/dragonfly-cache/blob/main/CHANGELOG.md',
+    'homepage_uri' => 'https://github.com/notus-sh/dragonfly-cache',
+    'source_code_uri' => 'https://github.com/notus-sh/dragonfly-cache',
+    'funding_uri' => 'https://opencollective.com/notus-sh'
+  }
 
   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)/}) }
+
+  excluded_dirs = %r{^(.github|spec)/}
+  excluded_files = %w[.gitignore .rspec .rubocop.yml Gemfile Gemfile.lock Rakefile]
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(excluded_dirs) || excluded_files.include?(f)
   end
 
-  spec.required_ruby_version = '>= 2.6'
+  spec.required_ruby_version = '>= 3.2'
 
   spec.add_dependency 'dragonfly'
   spec.add_dependency 'i18n'
 
   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.add_development_dependency 'rubocop-rake'
-  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rspec', '~> 3.13.0'
 
   spec.post_install_message = <<~POST_INSTALL_MESSAGE
     Don't forget to configure Dragonfly::Cache:

data/lib/dragonfly/cache/config.rb

@@ -2,7 +2,7 @@
 
 module Dragonfly
   module Cache
-    class Config
+    class Config # :nodoc:
       attr_accessor :servers_options
 
       def initialize(servers_options = {})
@@ -29,7 +29,10 @@ module Dragonfly
           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?
+        return if servers_options[:url_format].include?('/:sha/')
+
+        raise Dragonfly::Cache::Error,
+              ':url_format option must include `:sha`'
       end
 
       def rewrite_url_format!

data/lib/dragonfly/cache/manager.rb

@@ -5,7 +5,7 @@ require 'dragonfly/cache/storage/local'
 
 module Dragonfly
   module Cache
-    class Manager
+    class Manager # :nodoc:
       extend Forwardable
 
       MIN_SHA_SIZE = 2

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

@@ -5,7 +5,7 @@ require 'yaml'
 module Dragonfly
   module Cache
     module Mapper
-      class Yaml
+      class Yaml # :nodoc:
         extend Forwardable
 
         attr_reader :root, :internal

data/lib/dragonfly/cache/plugin.rb

@@ -10,10 +10,12 @@ require 'dragonfly/cache/manager'
 
 module Dragonfly
   module Cache
-    class Plugin
+    class Plugin # :nodoc:
       extend Forwardable
 
+      # rubocop:disable Style/ClassVars
       @@servers = {}
+      # rubocop:enable Style/ClassVars
 
       attr_reader :config, :manager
 
@@ -49,7 +51,7 @@ module Dragonfly
         @@servers[app.name] ||= begin
           server = app.server.dup
           config.servers_options.each do |name, value|
-            server.send("#{name}=", value) if server.respond_to?("#{name}=")
+            server.send(:"#{name}=", value) if server.respond_to?(:"#{name}=")
           end
           server
         end

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

@@ -3,7 +3,7 @@
 module Dragonfly
   module Cache
     module Storage
-      class Local
+      class Local # :nodoc:
         attr_reader :root, :format
 
         def initialize(config)

data/lib/dragonfly/cache/version.rb

@@ -2,6 +2,6 @@
 
 module Dragonfly
   module Cache
-    VERSION = '0.1.8'
+    VERSION = '0.2.0'
   end
 end

data/lib/dragonfly/cache.rb

@@ -4,7 +4,7 @@ require 'openssl'
 require 'dragonfly'
 
 module Dragonfly
-  module Cache
+  module Cache # :nodoc:
     class Error < ::StandardError; end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dragonfly-cache
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Gaël-Ian Havard
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dragonfly
@@ -72,56 +71,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.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'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  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'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  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'
+        version: 3.13.0
 description: Allow Dragonfly to keep a cache of jobs results
 email:
 - gael-ian@notus.sh
@@ -129,16 +86,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
-- Gemfile.lock
+- CHANGELOG.md
 - LICENSE
 - README.md
-- Rakefile
-- config/linters/ruby.yml
+- dev/gemfiles/ci.gemfile
 - dragonfly-cache.gemspec
 - lib/dragonfly/cache.rb
 - lib/dragonfly/cache/config.rb
@@ -153,6 +104,12 @@ licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  bug_tracker_uri: https://github.com/notus-sh/dragonfly-cache/issues
+  changelog_uri: https://github.com/notus-sh/dragonfly-cache/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/notus-sh/dragonfly-cache
+  source_code_uri: https://github.com/notus-sh/dragonfly-cache
+  funding_uri: https://opencollective.com/notus-sh
 post_install_message: |+
   Don't forget to configure Dragonfly::Cache:
 
@@ -169,15 +126,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Cache adapter for Dragonfly
 test_files: []

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-
-/tmp/*
-!/tmp/.keep

data/.rspec

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

data/.rubocop.yml

@@ -1,6 +0,0 @@
-require:
-  - rubocop-rake
-  - rubocop-rspec
-
-AllCops:
-  TargetRubyVersion: 3.0

data/.travis.yml

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

data/Gemfile

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

data/Gemfile.lock

@@ -1,77 +0,0 @@
-PATH
-  remote: .
-  specs:
-    dragonfly-cache (0.1.8)
-      dragonfly
-      i18n
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.2)
-    concurrent-ruby (1.1.8)
-    diff-lcs (1.4.4)
-    dragonfly (1.3.0)
-      addressable (~> 2.3)
-      multi_json (~> 1.0)
-      rack (>= 1.3)
-    i18n (1.8.10)
-      concurrent-ruby (~> 1.0)
-    multi_json (1.15.0)
-    parallel (1.20.1)
-    parser (3.0.1.1)
-      ast (~> 2.4.1)
-    public_suffix (4.0.6)
-    rack (2.2.3)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.13.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.5.0)
-      parser (>= 3.0.1.1)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.3.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.1)
-  dragonfly-cache!
-  rake (~> 13.0)
-  rspec (~> 3.10.0)
-  rubocop
-  rubocop-rake
-  rubocop-rspec
-
-BUNDLED WITH
-   2.2.3

data/Rakefile

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

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