asset_cloud 2.7.1 → 2.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b202062a28470fab35e4aadafe3600f7944d2cb075d0076274acfd72dd93a6e
-  data.tar.gz: ad42d5f81dbe67cfde24248c3f8f8b2cb5d9bd1694be44d98546f234c8ef703b
+  metadata.gz: 568dd22b66b6a00beacf0a8d099cad040bcddac422b3932b946573d823e67291
+  data.tar.gz: 8e97aa129cc5c6617722a6f5212ff51562cee437ba22476ceb63d7ad9dc62d25
 SHA512:
-  metadata.gz: c22411e548811567b511d54b55b79591835721aefd3a34b89ab504871473a477eddbb0903e7c30292c2fefa0e7c51b54b0a94e8ae3081961b40bfb8a69287de4
-  data.tar.gz: 822630e44304e0e2507d01a9e162898bd0c053ade3eabe785c625e407216c7a54166087c270f5166c63261cc98757664c201a6472cb474034b5c7a3af389679f
+  metadata.gz: 3cde8568299bb0b63c31ce9affa4880bcc7aa1940a63d1541210289f25dc7766528846d110a9b00ae7d1a412bc5bb2e695294b4bff851fb7aa0cc090856ed2bb
+  data.tar.gz: 821d7f7f2fe4c37df691d52b40217168638ff2d2d5cc3ee2dd056ec231e30f44584b1dbd538dc98d167d07d1a29ac0948bbde798d1b7f1870324f593090ecf88

data/.github/workflows/ci.yml

@@ -3,12 +3,13 @@ name: CI
 on: [push, pull_request]
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
     name: Ruby ${{ matrix.ruby }}
     strategy:
+      fail-fast: false
       matrix:
-        ruby: ["2.5", "2.6", "2.7"]
+        ruby: ["2.5", "2.6", "2.7", "3.0", "3.1", "3.2"]
     steps:
 
     - name: Check out code
@@ -20,8 +21,22 @@ jobs:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
 
-    - name: RuboCop
-      run: bundle exec rubocop || true # until we fix offenses due to outdated config
-
     - name: Tests
       run: bundle exec rspec
+
+  lint:
+    runs-on: ubuntu-latest
+    name: RuboCop
+    steps:
+
+    - name: Check out code
+      uses: actions/checkout@v3
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2'
+        bundler-cache: true
+
+    - name: RuboCop
+      run: bundle exec rubocop

data/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/.rubocop.yml

@@ -1,3 +1,5 @@
 inherit_gem:
   rubocop-shopify: rubocop.yml
-inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.5

data/Gemfile

@@ -1,6 +1,8 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-gem 'aws-sdk-s3', '>= 1.60.2', require: false
-gem 'google-cloud-storage'
+source "https://rubygems.org"
+
+gem "aws-sdk-s3", ">= 1.60.2", require: false
+gem "google-cloud-storage"
 
 gemspec

data/History.md

@@ -1,5 +1,9 @@
 # Asset Cloud Version History
 
+## Version 2.7.2, 2023-04-20
+
+* Swap the order of operations for checking UUID and asset exist logic in free key locator (https://github.com/Shopify/asset_cloud/pull/83)
+
 ## Version 2.7.1, 2022-03-18
 
 * Fix incorrect invocation of callbacks defined in external classes (https://github.com/Shopify/asset_cloud/issues/71)

data/Rakefile

@@ -1,28 +1,30 @@
-require 'bundler/gem_tasks'
-require 'rspec'
+# frozen_string_literal: true
 
-require 'rake'
-require 'rake/testtask'
-require 'rdoc/task'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
+require "bundler/gem_tasks"
+require "rspec"
 
-desc 'Default: run unit tests and style checks.'
+require "rake"
+require "rake/testtask"
+require "rdoc/task"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+desc "Default: run unit tests and style checks."
 task default: [:spec, :rubocop]
 
 desc "Run all spec examples"
 RSpec::Core::RakeTask.new do |t|
-  t.pattern = 'spec/**/*_spec.rb'
-  t.rspec_opts = ['--color']
+  t.pattern = "spec/**/*_spec.rb"
+  t.rspec_opts = ["--color"]
 end
 
-desc 'Generate documentation for the asset_cloud plugin.'
+desc "Generate documentation for the asset_cloud plugin."
 Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'AssetCloud'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "AssetCloud"
+  rdoc.options << "--line-numbers" << "--inline-source"
+  rdoc.rdoc_files.include("README")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 RuboCop::RakeTask.new

data/asset_cloud.gemspec

@@ -1,29 +1,30 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
+require "English"
 Gem::Specification.new do |s|
-  s.name = %q{asset_cloud}
-  s.version = "2.7.1"
+  s.name = "asset_cloud"
+  s.version = "2.7.2"
 
-  s.authors = %w(Shopify)
-  s.summary = %q{An abstraction layer around arbitrary and diverse asset stores.}
-  s.description = %q{An abstraction layer around arbitrary and diverse asset stores.}
+  s.authors = ["Shopify"]
+  s.summary = "An abstraction layer around arbitrary and diverse asset stores."
+  s.description = "An abstraction layer around arbitrary and diverse asset stores."
 
-  s.required_ruby_version = '>= 2.5.0'
+  s.required_ruby_version = ">= 2.5.0"
 
-  s.email = %q{developers@shopify.com}
-  s.homepage = %q{http://github.com/Shopify/asset_cloud}
-  s.require_paths = %w(lib)
+  s.email = "developers@shopify.com"
+  s.homepage = "http://github.com/Shopify/asset_cloud"
+  s.require_paths = ["lib"]
 
-  s.files = `git ls-files`.split($/)
-  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.files = %x(git ls-files).split($INPUT_RECORD_SEPARATOR)
 
-  s.add_dependency 'activesupport'
+  s.add_dependency("activesupport")
 
-  s.metadata['allowed_push_host'] = "https://rubygems.org"
+  s.metadata["allowed_push_host"] = "https://rubygems.org"
 
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'pry-byebug'
-  s.add_development_dependency 'rubocop-shopify'
+  s.add_development_dependency("pry")
+  s.add_development_dependency("pry-byebug")
+  s.add_development_dependency("rake")
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("rubocop-shopify")
 end

data/dev.yml

@@ -2,7 +2,7 @@ name: asset-cloud
 
 up:
   - ruby:
-      version: 2.5.0
+      version: 3.2.2
   - bundler
 
 commands:

data/lib/asset_cloud/asset.rb

@@ -1,5 +1,6 @@
-module AssetCloud
+# frozen_string_literal: true
 
+module AssetCloud
   class AssetError < StandardError
   end
 
@@ -8,8 +9,9 @@ module AssetCloud
 
   class Asset
     include Comparable
-    attr_accessor :key, :value, :cloud, :metadata, :new_asset
+    attr_accessor :key, :cloud, :new_asset
     attr_reader   :extensions
+    attr_writer   :value, :metadata
 
     def initialize(cloud, key, value = nil, metadata = Metadata.non_existing)
       @new_asset = true
@@ -27,10 +29,12 @@ module AssetCloud
       yield self if block_given?
     end
 
-    def self.at(cloud, key, value = nil, metadata = nil, &block)
-      file = self.new(cloud, key, value, metadata,  &block)
-      file.new_asset = false
-      file
+    class << self
+      def at(cloud, key, value = nil, metadata = nil, &block)
+        file = new(cloud, key, value, metadata, &block)
+        file.new_asset = false
+        file
+      end
     end
 
     def <=>(other)
@@ -42,11 +46,11 @@ module AssetCloud
     end
 
     def relative_key
-      @key.split("/",2).last
+      @key.split("/", 2).last
     end
 
     def relative_key_without_ext
-      relative_key.gsub(/\.[^.]+$/,"")
+      relative_key.gsub(/\.[^.]+$/, "")
     end
 
     def dirname
@@ -58,7 +62,7 @@ module AssetCloud
     end
 
     def format
-      extname.sub('.', '')
+      extname.sub(".", "")
     end
 
     def basename
@@ -122,7 +126,7 @@ module AssetCloud
     end
 
     def store!
-      store or raise(AssetNotSaved, "Validation failed: #{errors.join(', ')}")
+      store || raise(AssetNotSaved, "Validation failed: #{errors.join(", ")}")
     end
 
     def to_param
@@ -134,11 +138,11 @@ module AssetCloud
     end
 
     def url(options = {})
-      cloud.url_for key, options
+      cloud.url_for(key, options)
     end
 
     def bucket_name
-      @key.split('/').first
+      @key.split("/").first
     end
 
     def bucket
@@ -169,7 +173,7 @@ module AssetCloud
     end
 
     def method_missing(method, *args)
-      if extension = @extensions.find { |e| e.respond_to?(method) }
+      if (extension = @extensions.find { |e| e.respond_to?(method) })
         extension.public_send(method, *args)
       else
         super

data/lib/asset_cloud/asset_extension.rb

@@ -1,9 +1,17 @@
+# frozen_string_literal: true
+
 module AssetCloud
   class AssetExtension
     class AssetMismatch < StandardError
     end
-    def store; true; end
-    def delete; true; end
+
+    def store
+      true
+    end
+
+    def delete
+      true
+    end
 
     include AssetCloud::Callbacks
     include AssetCloud::Validations
@@ -11,31 +19,35 @@ module AssetCloud
     callback_methods :store, :delete, :validate
 
     attr_reader :asset
-    delegate :add_error, :to => :asset
+
+    delegate :add_error, to: :asset
 
     class_attribute :extnames
 
-    def self.applies_to(*args)
-      extnames = args.map do |arg|
-        arg = arg.to_s.downcase
-        arg = ".#{arg}" unless arg.starts_with?('.')
-        arg
+    class << self
+      def applies_to(*args)
+        extnames = args.map do |arg|
+          arg = arg.to_s.downcase
+          arg = ".#{arg}" unless arg.starts_with?(".")
+          arg
+        end
+        self.extnames = extnames
       end
-      self.extnames = extnames
-    end
 
-    def self.applies_to_asset?(asset)
-      extnames = self.extnames || []
-      extnames.each do |extname|
-        return true if asset.key.downcase.ends_with?(extname)
+      def applies_to_asset?(asset)
+        extnames = self.extnames || []
+        extnames.each do |extname|
+          return true if asset.key.downcase.ends_with?(extname)
+        end
+        false
       end
-      false
     end
 
     def initialize(asset)
       unless self.class.applies_to_asset?(asset)
         raise AssetMismatch, "Instances of #{self.class.name} cannot be applied to asset #{asset.key.inspect}"
       end
+
       @asset = asset
     end
   end

data/lib/asset_cloud/base.rb

@@ -1,42 +1,44 @@
-require 'uri/rfc2396_parser'
+# frozen_string_literal: true
 
-module AssetCloud
+require "uri/rfc2396_parser"
 
+module AssetCloud
   class IllegalPath < StandardError
   end
 
   class Base
     cattr_accessor :logger
 
-    VALID_PATHS = /\A
+    VALID_PATHS = %r{\A
       (
-        (\w)                #Filename can be a single letter or underscore
-        |                     #OR it is many and follows the below rules
+        (\w)                        # Filename can be a single letter or underscore
+        |                           # OR it is many and follows the below rules
         (
-          (\.?[\w\[\]\(\)\-\@])       #It can start with a dot but it must have a following character
+          (\.?[\w\[\]\(\)\-\@])     # It can start with a dot but it must have a following character
           (
-            [\w\[\]\(\)\-\@]          #You can have a letter without any following conditions
+            [\w\[\]\(\)\-\@]        # You can have a letter without any following conditions
             |
-            [\ ][\w\[\]\(\)\-\@\.]      #If there is a space you need to have a normal letter afterward or a dot
+            [\ ][\w\[\]\(\)\-\@\.]  # If there is a space you need to have a normal letter afterward or a dot
             |
-            [\/][\w\[\]\(\)\-\@]      #If there is a slash you need to have a normal letter afterward
+            [/][\w\[\]\(\)\-\@]     # If there is a slash you need to have a normal letter afterward
             |
-            [\/][\.][\w\[\]\(\)\-\@]  #Though a slash could be followed by a dot so long as there is a normal letter afterward
+            [/][\.][\w\[\]\(\)\-\@] # Though a slash could be followed by a dot
+                                    # so long as there is a normal letter afterward
             |
-            [\.]+[\w\[\]\(\)\-\@]+     #One or more dots must be followed by one (or more) normal letters
-          )*                  #Zero to many of these combinations.
+            [\.]+[\w\[\]\(\)\-\@]+  # One or more dots must be followed by one (or more) normal letters
+          )*                        # Zero to many of these combinations.
         )
-      )\z/x
-    MATCH_BUCKET = /^(\w+)(\/|$)/
+      )\z}x
+    MATCH_BUCKET = %r{^(\w+)(/|$)}
 
     URI_PARSER = URI::RFC2396_Parser.new
 
     attr_accessor :url, :root
 
     class_attribute :root_bucket_class
-    self.root_bucket_class = 'AssetCloud::FileSystemBucket'.freeze
+    self.root_bucket_class = "AssetCloud::FileSystemBucket"
     class_attribute :root_asset_class
-    self.root_asset_class  = 'AssetCloud::Asset'.freeze
+    self.root_asset_class = "AssetCloud::Asset"
 
     class_attribute :bucket_classes
     self.bucket_classes = {}.freeze
@@ -45,56 +47,68 @@ module AssetCloud
     class_attribute :asset_extension_classes
     self.asset_extension_classes = {}.freeze
 
-    def self.bucket(*args)
-      asset_class = if args.last.is_a? Hash
-        convert_to_class_name_if_possible(args.pop[:asset_class])
-      end
+    class << self
+      def bucket(*args)
+        asset_class = if args.last.is_a?(Hash)
+          convert_to_class_name_if_possible(args.pop[:asset_class])
+        end
 
-      bucket_class = if args.last.is_a? Class
-        convert_to_class_name_if_possible(args.pop)
-      else
-        raise ArgumentError, 'requires a bucket class'
-      end
+        bucket_class = if args.last.is_a?(Class)
+          convert_to_class_name_if_possible(args.pop)
+        else
+          raise ArgumentError, "requires a bucket class"
+        end
 
-      if bucket_name = args.first
-        self.bucket_classes = bucket_classes.merge(bucket_name.to_sym => bucket_class).freeze
-        self.asset_classes = asset_classes.merge(bucket_name.to_sym => asset_class).freeze if asset_class
-      else
-        self.root_bucket_class = bucket_class
-        if asset_class
-          raise ArgumentError, 'asset_class on the root bucket cannot be a proc' if asset_class.is_a?(Proc)
-          self.root_asset_class  = asset_class
+        if (bucket_name = args.first)
+          self.bucket_classes = bucket_classes.merge(bucket_name.to_sym => bucket_class).freeze
+          self.asset_classes = asset_classes.merge(bucket_name.to_sym => asset_class).freeze if asset_class
+        else
+          self.root_bucket_class = bucket_class
+          if asset_class
+            raise ArgumentError, "asset_class on the root bucket cannot be a proc" if asset_class.is_a?(Proc)
+
+            self.root_asset_class = asset_class
+          end
         end
       end
-    end
 
-    def self.asset_extensions(*args)
-      opts = args.last.is_a?(Hash) ? args.pop.slice(:only, :except) : {}
-      opts.each do |k,v|
-        opts[k] = [v].flatten.map(&:to_sym)
+      def asset_extensions(*args)
+        opts = args.last.is_a?(Hash) ? args.pop.slice(:only, :except) : {}
+        opts.each do |k, v|
+          opts[k] = [v].flatten.map(&:to_sym)
+        end
+
+        args.each do |klass|
+          klass = convert_to_class_name_if_possible(klass)
+          self.asset_extension_classes = asset_extension_classes.merge(klass => opts).freeze
+        end
       end
 
-      args.each do |klass|
-        klass = convert_to_class_name_if_possible(klass)
-        self.asset_extension_classes = asset_extension_classes.merge(klass => opts).freeze
+      private
+
+      def convert_to_class_name_if_possible(klass)
+        if klass.is_a?(Class) && klass.name.present?
+          klass.name
+        else
+          klass
+        end
       end
     end
 
     def buckets
       @buckets ||= Hash.new do |hash, key|
-        if klass = self.class.bucket_classes[key]
-          hash[key] = constantize_if_necessary(klass).new(self, key)
-        else
-          hash[key] = nil
+        hash[key] = if (klass = self.class.bucket_classes[key])
+          constantize_if_necessary(klass).new(self, key)
         end
       end
     end
 
-    def initialize(root, url = '/')
-      @root, @url = root, url
+    def initialize(root, url = "/")
+      @root = root
+      @url = url
     end
 
-    def url_for(key, options={})
+    def url_for(key, options = {})
       File.join(@url, URI_PARSER.escape(key))
     end
 
@@ -140,13 +154,13 @@ module AssetCloud
     end
 
     def build(key, value = nil, &block)
-      logger.info { "  [#{self.class.name}] Building asset #{key}" } if logger
+      logger&.info { "  [#{self.class.name}] Building asset #{key}" }
       asset_class_for(key).new(self, key, value, Metadata.non_existing, &block)
     end
 
     def write(key, value)
       check_key_for_errors(key)
-      logger.info { "  [#{self.class.name}] Writing #{value.size} bytes to #{key}" } if logger
+      logger&.info { "  [#{self.class.name}] Writing #{value.size} bytes to #{key}" }
 
       bucket_for(key).write(key, value)
     end
@@ -158,25 +172,25 @@ module AssetCloud
     end
 
     def read(key)
-      logger.info { "  [#{self.class.name}] Reading from #{key}" } if logger
+      logger&.info { "  [#{self.class.name}] Reading from #{key}" }
 
       bucket_for(key).read(key)
     end
 
     def stat(key)
-      logger.info { "  [#{self.class.name}] Statting #{key}" } if logger
+      logger&.info { "  [#{self.class.name}] Statting #{key}" }
 
       bucket_for(key).stat(key)
     end
 
     def ls(key)
-      logger.info { "  [#{self.class.name}] Listing objects in #{key}" } if logger
+      logger&.info { "  [#{self.class.name}] Listing objects in #{key}" }
 
       bucket_for(key).ls(key)
     end
 
     def exist?(key)
-      if fp = stat(key)
+      if (fp = stat(key))
         fp.exist?
       else
         false
@@ -188,7 +202,7 @@ module AssetCloud
     end
 
     def delete(key)
-      logger.info { "  [#{self.class.name}] Deleting #{key}" } if logger
+      logger&.info { "  [#{self.class.name}] Deleting #{key}" }
 
       bucket_for(key).delete(key)
     end
@@ -211,17 +225,17 @@ module AssetCloud
     # versioning
 
     def read_version(key, version)
-      logger.info { "  [#{self.class.name}] Reading from #{key} at version #{version}" } if logger
+      logger&.info { "  [#{self.class.name}] Reading from #{key} at version #{version}" }
       bucket_for(key).read_version(key, version)
     end
 
     def versions(key)
-      logger.info { "  [#{self.class.name}] Getting all versions for #{key}" } if logger
+      logger&.info { "  [#{self.class.name}] Getting all versions for #{key}" }
       bucket_for(key).versions(key)
     end
 
     def version_details(key)
-      logger.info { "  [#{self.class.name}] Getting all version details for #{key}" } if logger
+      logger&.info { "  [#{self.class.name}] Getting all version details for #{key}" }
       bucket_for(key).version_details(key)
     end
 
@@ -239,40 +253,31 @@ module AssetCloud
       klasses = extensions.keys.select do |ext|
         opts = extensions[ext]
         (opts.key?(:only) ? opts[:only].include?(bucket) : true) &&
-        (opts.key?(:except) ? !opts[:except].include?(bucket) : true)
+          (opts.key?(:except) ? !opts[:except].include?(bucket) : true)
       end
-      klasses.map {|klass| constantize_if_necessary(klass)}
+      klasses.map { |klass| constantize_if_necessary(klass) }
     end
 
     protected
 
     def bucket_symbol_for_key(key)
-      $1.to_sym if key =~ MATCH_BUCKET
+      Regexp.last_match(1).to_sym if key =~ MATCH_BUCKET
     end
 
     def root_bucket
-      @default_bucket ||= constantize_if_necessary(self.class.root_bucket_class).new(self, '')
+      @default_bucket ||= constantize_if_necessary(self.class.root_bucket_class).new(self, "")
     end
 
     def constantize_if_necessary(klass)
       klass.is_a?(Class) ? klass : klass.constantize
     end
 
-    def self.convert_to_class_name_if_possible(klass)
-      if klass.is_a?(Class) && klass.name.present?
-        klass.name
-      else
-        klass
-      end
-    end
-
     def check_key_for_errors(key)
       raise IllegalPath, "key cannot be empty" if key.blank?
       raise IllegalPath, "#{key.inspect} contains illegal characters" unless supports?(key)
     rescue => e
-      logger.info { "  [#{self.class.name}]   bad key #{e.message}" } if logger
+      logger&.info { "  [#{self.class.name}]   bad key #{e.message}" }
       raise
     end
-
   end
 end