better_storage 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9939f2580116c2a947922d368527cf204fa74aebbc24a517ca1f307202818e13
-  data.tar.gz: 85894eb542fd5e20ddb88debbd0f94e8687992748a16f2238bf70290436dcdf2
+  metadata.gz: 000e62192f58bc6619a6a900e46aeaab4e5877b9d76457e5ba1efec8a90c5c41
+  data.tar.gz: 0ab04353ca0bcc20e1fb8362862c5ad6b16c814db73abfe01693ba08d37bb56b
 SHA512:
-  metadata.gz: 1379973176a5f74b84cbf81dac587dbbb7767ad1e693c578146320b2bc58763d91e96e7876f41f8cf350b5766978255cda8109608466b91f5f282b9f378dcd57
-  data.tar.gz: 7cdb282c50c3f9f5bf1629f3ea9e91396a4d587fc39cbfa4b62c6ff3b88c506f7fcf53df6f1459da75dd254704abe221fd90b2ef66be44434327c99a86b43a74
+  metadata.gz: '08dbfb6408d2ca3859ea751ca3267c7719f2459abe885f2ced3ff38e824fb3148171c9a1d3a4dbfe29ccf953f8ec7fcd6d16ce6b1975a68417d88d42509a77c6'
+  data.tar.gz: 2f9beb8a09522bf7e7234a1177ecefbc02d381b9587069232c3efeeb74e7009c88994fe5d4556843e84639d73971ebc5c303bd380e7356abd555d910ac511236

data/README.md

@@ -10,6 +10,7 @@
 # better_storage.rb initializer
 
 BetterStorage.configure do |config|
+  config.namespace = "storage" # prefix for ActiveStorage uploads default: nil
   config.protect_production_files = true # default: Rails.env.development?
   config.prefix_date_format = "%Y/%m/%d" # default: "%Y%m"
 end
@@ -34,6 +35,12 @@ Add this line to your application's Gemfile:
 gem "better_storage"
 ```
 
+## Warning
+
+`ActiveStorage.track_variants = true` is assumed. This gem is not tested with `ActiveStorage.track_variants = false`.
+With the false setting, `variant_class` is ActiveStorage::Variant instead of ActiveStorage::VariantWithRecord.
+ActiveStorage::Variant implements its own special blob key.
+
 ## Contributing
 Contribution directions go here.
 

data/lib/better_storage/attachment.rb

@@ -6,11 +6,20 @@ module BetterStorage
       key = if style == :original
         self.key
       else
-        variants = record.attachment_reflections[name]&.variants
-        transformations = variants.fetch(style) do
-          record_model_name = record.to_model.model_name.name
-          raise ArgumentError, "Cannot find variant :#{style} for #{record_model_name}##{name}"
+        transformations = if Rails.version.to_f >= 7.1
+          variants = record.attachment_reflections[name]&.named_variants
+          variants.fetch(style) do
+            record_model_name = record.to_model.model_name.name
+            raise ArgumentError, "Cannot find variant :#{style} for #{record_model_name}##{name}"
+          end.transformations
+        else
+          variants = record.attachment_reflections[name]&.variants
+          variants.fetch(style) do
+            record_model_name = record.to_model.model_name.name
+            raise ArgumentError, "Cannot find variant :#{style} for #{record_model_name}##{name}"
+          end
         end
+
         transformation_key = ActiveStorage::Variation.wrap(transformations).digest
         variant_cache_key = "#{id}-#{transformation_key}"
 

data/lib/better_storage/blob.rb

@@ -2,16 +2,23 @@ module BetterStorage
   module Blob
     def key
       self[:key] ||= begin
-        parts = []
-        parts << "dev" if Rails.env.development?
-        parts << Date.today.strftime(BetterStorage.prefix_date_format) if BetterStorage.prefix_date_format
-        parts << self.class.generate_unique_secure_token(length: self.class::MINIMUM_TOKEN_LENGTH)
-        parts.join("/")
+        key = self.class.generate_unique_secure_token(length: self.class::MINIMUM_TOKEN_LENGTH)
+        BetterStorage.generate_blob_key(key)
       end
     end
 
     def public_url
       BetterStorage.public_url(key)
     end
+
+    def delete
+      service.delete(key)
+      # original implementation is `service.delete_prefixed("variants/#{key}/") if image?`
+      service.delete_prefixed(variant_prefix) if image?
+    end
+
+    def variant_prefix
+      "#{key}/variants/"
+    end
   end
 end

data/lib/better_storage/railtie.rb

@@ -3,7 +3,9 @@ module BetterStorage
 
     initializer "better_storage.configs" do
       config.after_initialize do |app|
-        BetterStorage.s3_endpoint ||= ActiveStorage::Blob.service.bucket.url
+        BetterStorage.s3_endpoint ||= if ActiveStorage::Blob.service.respond_to?(:bucket)
+          ActiveStorage::Blob.service.bucket.url
+        end
       end
     end
 
@@ -13,6 +15,12 @@ module BetterStorage
       end
     end
 
+    initializer "better_storage.variant" do
+      ActiveSupport.on_load(:active_storage_blob) do
+        ActiveStorage::Variant.prepend BetterStorage::Variant
+      end
+    end
+
     initializer "better_storage.attachment" do
       ActiveSupport.on_load(:active_storage_blob) do
         ActiveStorage::Attachment.include BetterStorage::Attachment

data/lib/better_storage/s3_service_proxy.rb

@@ -1,18 +1,18 @@
 module BetterStorage
   # protect production files from deletion in development
   module S3ServiceProxy
-    def is_protected?(key)
-      BetterStorage.protect_production_files && !key.start_with?("dev/")
-    end
-
     def delete(key)
-      return true if is_protected?(key)
+      return false if should_protect?(key)
       super
     end
 
     def delete_prefixed(prefix)
-      return true if is_protected?(prefix)
+      return false if should_protect?(prefix)
       super
     end
+
+    def should_protect?(key)
+      BetterStorage.protect_production_files && BetterStorage.protected_key?(key)
+    end
   end
 end

data/lib/better_storage/variant.rb

@@ -0,0 +1,11 @@
+module BetterStorage
+  module Variant
+    # original implementation:
+    # def key
+    #   "variants/#{blob.key}/#{OpenSSL::Digest::SHA256.hexdigest(variation.key)}"
+    # end
+    def key
+      "#{blob.key}/variants/#{OpenSSL::Digest::SHA256.hexdigest(variation.key)}"
+    end
+  end
+end

data/lib/better_storage/version.rb

@@ -1,3 +1,3 @@
 module BetterStorage
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/better_storage.rb

@@ -7,8 +7,10 @@ module BetterStorage
   autoload :Blob
   autoload :S3ServiceProxy
   autoload :Attachment
+  autoload :Variant
 
   mattr_accessor :s3_endpoint
+  mattr_accessor :namespace
   mattr_accessor :protect_production_files, default: Rails.env.development?
   mattr_accessor :prefix_date_format, default: "%Y%m"
 
@@ -16,10 +18,31 @@ module BetterStorage
     yield self
   end
 
+  def namespace=(value)
+    @namespace = value.gsub(/\/$/, "")
+  end
+
   def self.public_url(key)
     url = URI.parse(s3_endpoint)
     url.path += '/' unless url.path[-1] == '/'
     url.path += key
     url.to_s
   end
+
+  def self.protected_key?(key)
+    dev_prefix = [namespace, "dev"].compact.join("/")
+    !key.start_with?(dev_prefix)
+  end
+
+  def self.prefix
+    parts = []
+    parts << namespace if namespace
+    parts << "dev" if Rails.env.development?
+    parts << Date.today.strftime(prefix_date_format) if prefix_date_format
+    parts.join("/")
+  end
+
+  def self.generate_blob_key(*key)
+    [BetterStorage.prefix, key].compact.join("/")
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_storage
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Yi Feng Xie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2023-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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'
 description: enhance active_storage
 email:
 - yfxie@me.com
@@ -95,6 +109,7 @@ files:
 - lib/better_storage/blob.rb
 - lib/better_storage/railtie.rb
 - lib/better_storage/s3_service_proxy.rb
+- lib/better_storage/variant.rb
 - lib/better_storage/version.rb
 homepage: https://github.com/yfxie/better_storage/
 licenses:
@@ -115,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: enhance active_storage