asset_cloud 2.5.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a71b62c2f478fc40fdb09ab52eccfe6ca023710082b69c656a7be5e5e73b78a2
-  data.tar.gz: 813c07e4b4e89d17fde3488d2f8d127d843cdeea5ae9f3d4310b3eae52bd32fa
+  metadata.gz: 8573a0d845bd6022d3540cbb6e28027637bea815896060a6637ed70402fb0614
+  data.tar.gz: df5f502bd556e2414ee896327ba18c54ce679faa2a2ebcf5b50a630803454719
 SHA512:
-  metadata.gz: 5665996149043348177e3f15f5d95d83ee98b074ca28f8650a20dd9a5fa5a8a3102465602620f2289a72202128c7cdd53fe2c91c5cf9bcfbf1095a4dadedfca2
-  data.tar.gz: d5f61fa661547b5851e99ce6db394aa3930640d94e83bd59b13edc436f06394f97dffd75ccf5c67306624132f3b8a33730987febf66d5f61e55c36c075bbd94c
+  metadata.gz: 7302dd7d0e4e4ca392b344c530d3ebd3e610c25e5e6aa45658582944e2333ca66371e511e911f93e38f471815fb184a7d2c52d38dadfdda172a33ff7ff90e6ec
+  data.tar.gz: 91a7fcfaf2dddbb1b855d6b25cadd563c414e09a625ceafdaaecf68faf07d4b89a6e80b89ab9cd2f264098f3ab9f1f387cf08f8ec8bcde19b67179045989bf40

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,15 @@
 # Asset Cloud Version History
 
+## Version 2.7.0, 2020-07-15
+
+* Add `Asset#write!` which raises on validation failure (https://github.com/Shopify/asset_cloud/pull/67)
+
+## 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 algorithm is documented (e.g. MD5)
+and is not expected to change.
+
 == Installation
 
 === as a Gem
@@ -22,6 +30,18 @@ With GCS Remote test:
 
     GCS_PROJECT_ID="<project_id>" GCS_KEY_FILEPATH="<path_to_key>" GCS_BUCKET="<bucket_name>" bundle exec rake spec
 
+== Releasing
+
+Releasing is handled by Shopify's internal Shipit server.
+
+After merging a change, a separate PR should be opened to update `History.md` and bump the version
+(following [Semantic Versioning](https://semver.org/))
+
+When merged, the new release will be automatically tagged and deployed to rubygems.org.
+
+Note that the automatic process does not create a new [release](https://github.com/Shopify/asset_cloud/releases) on
+GitHub.
+
 == Copyright
 
 Copyright (c) 2008-2014 Tobias Lütke & Shopify, Inc. Released under the MIT license (see LICENSE for details).

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.1"
+  s.version = "2.7.0"
 
   s.authors = %w(Shopify)
   s.summary = %q{An abstraction layer around arbitrary and diverse asset stores.}
@@ -18,13 +18,12 @@ Gem::Specification.new do |s|
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
 
   s.add_dependency 'activesupport'
-  s.add_dependency 'addressable'
 
   s.metadata['allowed_push_host'] = "https://rubygems.org"
 
   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/asset.rb

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