asset_cloud 2.6.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 134ba5f46359569f492531369197e78de71f48eabc0efef27c60b9f2a9b2a4fd
-  data.tar.gz: 28edd6a34bfb58f3fe796c697a0c58855a65f117c489a4d427711b88386b2df0
+  metadata.gz: 5b202062a28470fab35e4aadafe3600f7944d2cb075d0076274acfd72dd93a6e
+  data.tar.gz: ad42d5f81dbe67cfde24248c3f8f8b2cb5d9bd1694be44d98546f234c8ef703b
 SHA512:
-  metadata.gz: 161578c01372d753f3fe15558bc0f2b446e2cdbab75272c48c72bb3ce3e0a94c67616544b712efafc74eac6a7e0e18f69367712e5a37e87a769723177479c0c8
-  data.tar.gz: a65784b410afe987d821589a631cf16e4b78795b6e07cebf6b6a4252c5631dc35eaca8a1da8ea2cbe4bf37d3308965bd5ed3a6dafe0c57de37a49489d8e11d4d
+  metadata.gz: c22411e548811567b511d54b55b79591835721aefd3a34b89ab504871473a477eddbb0903e7c30292c2fefa0e7c51b54b0a94e8ae3081961b40bfb8a69287de4
+  data.tar.gz: 822630e44304e0e2507d01a9e162898bd0c053ade3eabe785c625e407216c7a54166087c270f5166c63261cc98757664c201a6472cb474034b5c7a3af389679f

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby: ["2.5", "2.6", "2.7"]
+    steps:
+
+    - name: Check out code
+      uses: actions/checkout@v3
+
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        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

data/History.md

@@ -1,5 +1,13 @@
 # Asset Cloud Version History
 
+## Version 2.7.1, 2022-03-18
+
+* Fix incorrect invocation of callbacks defined in external classes (https://github.com/Shopify/asset_cloud/issues/71)
+
+## 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)

data/README.rdoc

@@ -9,7 +9,7 @@ An abstraction layer around arbitrary and diverse asset stores.
 +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)
++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
@@ -30,6 +30,17 @@ 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/asset_cloud.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{asset_cloud}
-  s.version = "2.6.0"
+  s.version = "2.7.1"
 
   s.authors = %w(Shopify)
   s.summary = %q{An abstraction layer around arbitrary and diverse asset stores.}

data/lib/asset_cloud/base.rb

@@ -151,6 +151,12 @@ module AssetCloud
       bucket_for(key).write(key, value)
     end
 
+    def write!(key, value)
+      asset = self[key]
+      asset.value = value
+      asset.store!
+    end
+
     def read(key)
       logger.info { "  [#{self.class.name}] Reading from #{key}" } if logger
 

data/lib/asset_cloud/buckets/gcs_bucket.rb

@@ -17,7 +17,7 @@ module AssetCloud
       bucket.create_file(
         data,
         absolute_key(key),
-        options
+        **options,
       )
     end
 

data/lib/asset_cloud/callbacks.rb

@@ -59,15 +59,15 @@ module AssetCloud
 
     def execute_callbacks(symbol, args)
       callbacks_for(symbol).each do |callback|
-
+        
         result = case callback
         when Symbol
           send(callback, *args)
         when Proc, Method
           callback.call(self, *args)
         else
-          if callback.respond_to?(method)
-            callback.send(method, self, *args)
+          if callback.respond_to?(symbol)
+            callback.send(symbol, self, *args)
           else
             raise StandardError, "Callbacks must be a symbol denoting the method to call, a string to be evaluated, a block to be invoked, or an object responding to the callback method."
           end

data/spec/base_spec.rb

@@ -7,11 +7,18 @@ end
 class LiquidAsset < AssetCloud::Asset
 end
 
+class BrokenBucket < AssetCloud::Bucket
+  def write(*)
+    false
+  end
+end
+
 class BasicCloud < AssetCloud::Base
   bucket :special, AssetCloud::MemoryBucket, asset_class: SpecialAsset
   bucket :conditional, AssetCloud::MemoryBucket, asset_class: proc { |key|
     LiquidAsset if key.ends_with?('.liquid')
   }
+  bucket :broken, BrokenBucket, asset_class: AssetCloud::Asset
 end
 
 describe BasicCloud do
@@ -192,6 +199,20 @@ describe BasicCloud do
     end
   end
 
+  describe "write!" do
+    it "should write through the Asset object (and thus run any callbacks on the asset)" do
+      special_asset = double(:special_asset)
+      expect(special_asset).to(receive(:value=).with('fancy fancy!'))
+      expect(special_asset).to(receive(:store!))
+      expect(SpecialAsset).to(receive(:at).and_return(special_asset))
+      @fs.write!('special/fancy.txt', 'fancy fancy!')
+    end
+
+    it "should raise AssetNotSaved when write fails" do
+      expect { @fs.write!('broken/file.txt', 'n/a') }.to(raise_error(AssetCloud::AssetNotSaved))
+    end
+  end
+
   describe "MATCH_BUCKET" do
     it "should match following stuff " do
       'products/key.txt' =~ AssetCloud::Base::MATCH_BUCKET

data/spec/callbacks_spec.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 require 'spec_helper'
 
+
+class AfterStoreCallback
+  def self.after_store(*args); end
+end
+
 class CallbackAsset < AssetCloud::Asset
   before_store :callback_before_store
   before_delete :callback_before_delete
@@ -9,6 +14,8 @@ class CallbackAsset < AssetCloud::Asset
   after_validate :add_spice
   validate :valid_value
 
+  after_store ::AfterStoreCallback
+
   private
 
   def callback_before_delete(*args); end
@@ -143,4 +150,15 @@ describe CallbackAsset do
 
     expect(@asset.delete).to(eq(nil))
   end
+
+  it "should invoke after_store callback defined in separate class" do
+    local_fs = BasicCloud.new(File.dirname(__FILE__) + '/files', 'http://assets/')
+    local_fs.write('callback_assets/foo', 'bar')
+    local_asset = local_fs.asset_at('callback_assets/foo')
+    
+    expect(local_asset).to(receive(:callback_before_store).and_return(true))
+    expect(::AfterStoreCallback).to(receive(:after_store))
+    
+    expect(local_asset.store).to(eq(true))
+  end
 end

data/spec/gcs_bucket_spec.rb

@@ -38,16 +38,29 @@ describe AssetCloud::GCSBucket do
     expect(file.class).to(eq(Google::Cloud::Storage::File))
   end
 
-  it "#write writes a file into the bucket" do
-    local_path = "#{directory}/products/key.txt"
-    key = 'test/key.txt'
-    expect_any_instance_of(MockGCSBucket).to(receive(:create_file).with(
-      local_path,
-      "s#{@cloud.url}/#{key}",
-      {}
-    ))
-
-    @bucket.write(key, local_path)
+  if RUBY_VERSION >= '2.7'
+    it "#write writes a file into the bucket" do
+      local_path = "#{directory}/products/key.txt"
+      key = 'test/key.txt'
+      expect_any_instance_of(MockGCSBucket).to(receive(:create_file).with(
+        local_path,
+        "s#{@cloud.url}/#{key}",
+      ))
+
+      @bucket.write(key, local_path)
+    end
+  else
+    it "#write writes a file into the bucket" do
+      local_path = "#{directory}/products/key.txt"
+      key = 'test/key.txt'
+      expect_any_instance_of(MockGCSBucket).to(receive(:create_file).with(
+        local_path,
+        "s#{@cloud.url}/#{key}",
+        {}
+      ))
+
+      @bucket.write(key, local_path)
+    end
   end
 
   it "#write writes a file into the bucket with metadata" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asset_cloud
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-22 00:00:00.000000000 Z
+date: 2022-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -101,10 +101,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/probots.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - Gemfile
 - History.md
 - LICENSE
@@ -172,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: An abstraction layer around arbitrary and diverse asset stores.

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-before_install:
-  - gem install bundler
-rvm:
-  - '2.5'
-  - '2.6'