asset_cloud 2.5.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10260022ec26ff28ffa08e6ce8c2b6842402f560f31388f2842f177b111baa9b
-  data.tar.gz: 158eee048f865ca05cc55f9de8c4987eaed875a6c71d9b42c977bcf0006a7986
+  metadata.gz: d5f21ffc94cb1b9d60698ca150060999dfc3c2e01f347698bb8f0c8e108bf460
+  data.tar.gz: a7d8bddbdbc14473c7eb7d0f8c4d50a4e8db12e72dbb320df3f97025ad08cd90
 SHA512:
-  metadata.gz: 25e4ac0842873db1c15b809bd9fbdbc009331156c3ef171b94b4b557f98e23e600e3539d6643b0165ed758fa7abda6f3b6f3984980d131b9b0286f3036259c58
-  data.tar.gz: 1c276c4b7dda4e5ab72f27860eedaf7d4219d36c493790c3e24efccee078b347c0ffea363072ee3778a2e28cab5c208c4e07fab3685b65edde8813c4ad6faab1
+  metadata.gz: '08454bc3fc53e14b98b69d1a6feee2d57505d26cc61f7b43e52174300704e441faaea4a2710da524ab7136197d5c396de6f53110d66edb4b0a1d89d7cb1339cb'
+  data.tar.gz: 9802fca3c1bcc63a72b3effeca88044df1d1022854a5be72f9da865fb1acea768c57160896ea9930c0eece74c8301120c19fc09c2f1df8867ab530bca5b91a33

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,326 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-05-22 10:33:52 -0400 using RuboCop version 0.82.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAdjacentOneLineDefs, NumberOfEmptyLines.
+Layout/EmptyLineBetweenDefs:
+  Exclude:
+    - 'lib/asset_cloud/asset_extension.rb'
+    - 'lib/asset_cloud/buckets/bucket_chain.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, no_empty_lines
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'lib/asset_cloud/callbacks.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'lib/asset_cloud/base.rb'
+    - 'lib/asset_cloud/buckets/bucket_chain.rb'
+    - 'lib/asset_cloud/buckets/file_system_bucket.rb'
+    - 'lib/asset_cloud/buckets/versioned_memory_bucket.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundModuleBody:
+  Exclude:
+    - 'lib/asset_cloud/asset.rb'
+    - 'lib/asset_cloud/base.rb'
+    - 'lib/asset_cloud/buckets/bucket_chain.rb'
+    - 'lib/asset_cloud/buckets/file_system_bucket.rb'
+    - 'lib/asset_cloud/free_key_locator.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Exclude:
+    - 'lib/asset_cloud/base.rb'
+
+# Offense count: 9
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 187
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/RescueEnsureAlignment:
+  Exclude:
+    - 'lib/asset_cloud/buckets/bucket_chain.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+Layout/SpaceAfterComma:
+  Exclude:
+    - 'lib/asset_cloud/asset.rb'
+    - 'lib/asset_cloud/base.rb'
+    - 'lib/asset_cloud/buckets/bucket_chain.rb'
+    - 'lib/asset_cloud/buckets/memory_bucket.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, no_space
+Layout/SpaceAroundEqualsInParameterDefault:
+  Exclude:
+    - 'lib/asset_cloud/base.rb'
+    - 'lib/asset_cloud/bucket.rb'
+    - 'lib/asset_cloud/buckets/active_record_bucket.rb'
+    - 'lib/asset_cloud/buckets/bucket_chain.rb'
+    - 'lib/asset_cloud/buckets/memory_bucket.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
+# SupportedStylesForExponentOperator: space, no_space
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'lib/asset_cloud/base.rb'
+    - 'lib/asset_cloud/buckets/bucket_chain.rb'
+
+# Offense count: 22
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideBlockBraces:
+  Exclude:
+    - 'lib/asset_cloud/base.rb'
+    - 'lib/asset_cloud/buckets/bucket_chain.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'lib/asset_cloud/buckets/active_record_bucket.rb'
+
+# Offense count: 9
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/asset_cloud/asset.rb'
+    - 'lib/asset_cloud/base.rb'
+    - 'lib/asset_cloud/buckets/active_record_bucket.rb'
+    - 'lib/asset_cloud/buckets/bucket_chain.rb'
+    - 'lib/asset_cloud/buckets/s3_bucket.rb'
+
+# Offense count: 2
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/asset_cloud/asset.rb'
+
+# Offense count: 1
+Lint/IneffectiveAccessModifier:
+  Exclude:
+    - 'lib/asset_cloud/base.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowComments.
+Lint/SuppressedException:
+  Exclude:
+    - 'lib/asset_cloud/buckets/file_system_bucket.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
+Lint/UnusedBlockArgument:
+  Exclude:
+    - 'lib/asset_cloud/buckets/memory_bucket.rb'
+
+# Offense count: 9
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/asset_cloud/base.rb'
+    - 'lib/asset_cloud/buckets/blackhole_bucket.rb'
+    - 'lib/asset_cloud/buckets/bucket_chain.rb'
+    - 'lib/asset_cloud/buckets/invalid_bucket.rb'
+
+# Offense count: 6
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/asset_cloud/buckets/bucket_chain.rb'
+    - 'lib/asset_cloud/buckets/file_system_bucket.rb'
+    - 'spec/gcs_bucket_spec.rb'
+
+# Offense count: 1
+Naming/ConstantName:
+  Exclude:
+    - 'lib/asset_cloud/buckets/invalid_bucket.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, conditionals
+Style/AndOr:
+  Exclude:
+    - 'lib/asset_cloud/asset.rb'
+    - 'lib/asset_cloud/buckets/active_record_bucket.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, AllowInnerBackticks.
+# SupportedStyles: backticks, percent_x, mixed
+Style/CommandLiteral:
+  Exclude:
+    - 'asset_cloud.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SingleLineConditionsOnly, IncludeTernaryExpressions.
+# SupportedStyles: assign_to_condition, assign_inside_condition
+Style/ConditionalAssignment:
+  Exclude:
+    - 'lib/asset_cloud/base.rb'
+
+# Offense count: 22
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  Exclude:
+    - 'lib/asset_cloud/asset_extension.rb'
+    - 'lib/asset_cloud/buckets/active_record_bucket.rb'
+
+# Offense count: 17
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoreMacros, IgnoredMethods, IgnoredPatterns, IncludedMacros, AllowParenthesesInMultilineCall, AllowParenthesesInChaining, AllowParenthesesInCamelCaseMethod, EnforcedStyle.
+# SupportedStyles: require_parentheses, omit_parentheses
+Style/MethodCallWithArgsParentheses:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'asset_cloud.gemspec'
+    - 'lib/asset_cloud.rb'
+    - 'lib/asset_cloud/asset.rb'
+    - 'lib/asset_cloud/base.rb'
+    - 'lib/asset_cloud/buckets/file_system_bucket.rb'
+    - 'lib/asset_cloud/metadata.rb'
+
+# Offense count: 2
+Style/MethodMissingSuper:
+  Exclude:
+    - 'lib/asset_cloud/buckets/bucket_chain.rb'
+    - 'spec/callbacks_spec.rb'
+
+# Offense count: 2
+Style/MissingRespondToMissing:
+  Exclude:
+    - 'lib/asset_cloud/buckets/bucket_chain.rb'
+    - 'spec/callbacks_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/ParallelAssignment:
+  Exclude:
+    - 'lib/asset_cloud/base.rb'
+    - 'lib/asset_cloud/bucket.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/PerlBackrefs:
+  Exclude:
+    - 'lib/asset_cloud/base.rb'
+    - 'lib/asset_cloud/buckets/s3_bucket.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: short, verbose
+Style/PreferredHashMethods:
+  Exclude:
+    - 'lib/asset_cloud/buckets/memory_bucket.rb'
+    - 'lib/asset_cloud/buckets/versioned_memory_bucket.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantBegin:
+  Exclude:
+    - 'lib/asset_cloud/buckets/file_system_bucket.rb'
+    - 'lib/asset_cloud/buckets/gcs_bucket.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+Style/RedundantPercentQ:
+  Exclude:
+    - 'asset_cloud.gemspec'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleReturnValues.
+Style/RedundantReturn:
+  Exclude:
+    - 'lib/asset_cloud/buckets/bucket_chain.rb'
+    - 'lib/asset_cloud/buckets/gcs_bucket.rb'
+    - 'lib/asset_cloud/buckets/s3_bucket.rb'
+
+# Offense count: 14
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/asset_cloud/asset.rb'
+    - 'lib/asset_cloud/buckets/active_record_bucket.rb'
+    - 'lib/asset_cloud/callbacks.rb'
+    - 'lib/asset_cloud/metadata.rb'
+    - 'lib/asset_cloud/validations.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Exclude:
+    - 'lib/asset_cloud/base.rb'
+    - 'lib/asset_cloud/buckets/file_system_bucket.rb'
+    - 'lib/asset_cloud/buckets/s3_bucket.rb'
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - 'lib/asset_cloud/base.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowIfMethodIsEmpty.
+Style/SingleLineMethods:
+  Exclude:
+    - 'lib/asset_cloud/asset_extension.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: use_perl_names, use_english_names
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'asset_cloud.gemspec'

data/.travis.yml

@@ -4,3 +4,9 @@ before_install:
 rvm:
   - '2.5'
   - '2.6'
+  - '2.7'
+
+matrix:
+  exclude:
+    rvm: '2.7'
+    gemfile: gemfiles/Gemfile.activerecord52

data/History.md

@@ -1,5 +1,11 @@
 # Asset Cloud Version History
 
+## Version 2.6.0, 2020-05-22
+
+* Add checksum to metadata (https://github.com/Shopify/asset_cloud/pull/57)
+
+**Note:** There are versions between 2.2.2 and 2.6.0 not covered by the History.
+
 ## Version 2.2.2, 2016-02-11
 
 * Allow asset_class to be a proc which determines the class to use within a bucket (https://github.com/Shopify/asset_cloud/pull/15)

data/README.rdoc

@@ -4,6 +4,14 @@
 
 An abstraction layer around arbitrary and diverse asset stores.
 
+== Value Hash vs Checksum
+
++value_hash+ is intended as a *private* hash/checksum, not exposed to end users. Its underlying algorithm is private, and
+could change over time so should not be relied on by clients.
+
++checksum+ is intended as a *public* hash/checksum, exposed to end users. Its underlying algorithms is documented (e.g. MD5)
+and is not expected to change.
+
 == Installation
 
 === as a Gem

data/Rakefile

@@ -5,9 +5,10 @@ require 'rake'
 require 'rake/testtask'
 require 'rdoc/task'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-desc 'Default: run unit tests.'
-task :default => [:spec]
+desc 'Default: run unit tests and style checks.'
+task default: [:spec, :rubocop]
 
 desc "Run all spec examples"
 RSpec::Core::RakeTask.new do |t|
@@ -23,3 +24,5 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+RuboCop::RakeTask.new

data/asset_cloud.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{asset_cloud}
-  s.version = "2.5.0"
+  s.version = "2.6.1"
 
   s.authors = %w(Shopify)
   s.summary = %q{An abstraction layer around arbitrary and diverse asset stores.}
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'mocha'
   s.add_development_dependency 'pry'
   s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'rubocop-shopify'
 end

data/lib/asset_cloud.rb

@@ -1,3 +1,4 @@
+require 'addressable'
 require 'active_support'
 
 # Core

data/lib/asset_cloud/asset.rb

@@ -89,6 +89,10 @@ module AssetCloud
       metadata.value_hash
     end
 
+    def checksum
+      metadata.checksum
+    end
+
     def delete
       if new_asset?
         false

data/lib/asset_cloud/base.rb

@@ -1,4 +1,4 @@
-require 'uri'
+require 'uri/rfc2396_parser'
 
 module AssetCloud
 
@@ -29,6 +29,8 @@ module AssetCloud
       )\z/x
     MATCH_BUCKET = /^(\w+)(\/|$)/
 
+    URI_PARSER = URI::RFC2396_Parser.new
+
     attr_accessor :url, :root
 
     class_attribute :root_bucket_class
@@ -93,7 +95,7 @@ module AssetCloud
     end
 
     def url_for(key, options={})
-      File.join(@url, URI.encode(key))
+      File.join(@url, URI_PARSER.escape(key))
     end
 
     def path_for(key)