better_storage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9939f2580116c2a947922d368527cf204fa74aebbc24a517ca1f307202818e13
+  data.tar.gz: 85894eb542fd5e20ddb88debbd0f94e8687992748a16f2238bf70290436dcdf2
+SHA512:
+  metadata.gz: 1379973176a5f74b84cbf81dac587dbbb7767ad1e693c578146320b2bc58763d91e96e7876f41f8cf350b5766978255cda8109608466b91f5f282b9f378dcd57
+  data.tar.gz: 7cdb282c50c3f9f5bf1629f3ea9e91396a4d587fc39cbfa4b62c6ff3b88c506f7fcf53df6f1459da75dd254704abe221fd90b2ef66be44434327c99a86b43a74

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Yi Feng Xie
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# BetterStorage
+
+* Prefix ActiveStorage uploads with `dev` and customized datetime format.
+* Protect production files from deletion in development environment.
+* `public_url` method for ActiveStorage attachments and blobs. 
+
+## Usage
+
+```ruby
+# better_storage.rb initializer
+
+BetterStorage.configure do |config|
+  config.protect_production_files = true # default: Rails.env.development?
+  config.prefix_date_format = "%Y/%m/%d" # default: "%Y%m"
+end
+```
+
+```ruby
+class User < ApplicationRecord
+  has_one_attached :avatar do |attachable|
+    attachable.variant :thumb, resize_to_limit: [120, 120]
+  end
+end
+
+user = User.first
+user.avatar.public_url
+user.avatar.public_url(:thumb)
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "better_storage"
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/better_storage/attachment.rb

@@ -0,0 +1,24 @@
+module BetterStorage
+  module Attachment
+    def public_url(style = :original)
+      return nil unless persisted?
+
+      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}"
+        end
+        transformation_key = ActiveStorage::Variation.wrap(transformations).digest
+        variant_cache_key = "#{id}-#{transformation_key}"
+
+        Rails.cache.fetch([:better_storage_public_url, variant_cache_key, BetterStorage::VERSION]) do
+          variant(style).processed.key
+        end
+      end
+      BetterStorage.public_url(key)
+    end
+  end
+end

data/lib/better_storage/blob.rb

@@ -0,0 +1,17 @@
+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("/")
+      end
+    end
+
+    def public_url
+      BetterStorage.public_url(key)
+    end
+  end
+end

data/lib/better_storage/railtie.rb

@@ -0,0 +1,29 @@
+module BetterStorage
+  class Railtie < ::Rails::Railtie
+
+    initializer "better_storage.configs" do
+      config.after_initialize do |app|
+        BetterStorage.s3_endpoint ||= ActiveStorage::Blob.service.bucket.url
+      end
+    end
+
+    initializer "better_storage.blob" do
+      ActiveSupport.on_load(:active_storage_blob) do
+        prepend BetterStorage::Blob
+      end
+    end
+
+    initializer "better_storage.attachment" do
+      ActiveSupport.on_load(:active_storage_blob) do
+        ActiveStorage::Attachment.include BetterStorage::Attachment
+      end
+    end
+
+    initializer "better_storage.service" do
+      config.after_initialize do
+        require "active_storage/service/s3_service"
+        ActiveStorage::Service::S3Service.prepend BetterStorage::S3ServiceProxy
+      end
+    end
+  end
+end

data/lib/better_storage/s3_service_proxy.rb

@@ -0,0 +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)
+      super
+    end
+
+    def delete_prefixed(prefix)
+      return true if is_protected?(prefix)
+      super
+    end
+  end
+end

data/lib/better_storage/version.rb

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

data/lib/better_storage.rb

@@ -0,0 +1,25 @@
+require "better_storage/version"
+require "better_storage/railtie"
+
+module BetterStorage
+  extend ActiveSupport::Autoload
+
+  autoload :Blob
+  autoload :S3ServiceProxy
+  autoload :Attachment
+
+  mattr_accessor :s3_endpoint
+  mattr_accessor :protect_production_files, default: Rails.env.development?
+  mattr_accessor :prefix_date_format, default: "%Y%m"
+
+  def self.configure
+    yield self
+  end
+
+  def self.public_url(key)
+    url = URI.parse(s3_endpoint)
+    url.path += '/' unless url.path[-1] == '/'
+    url.path += key
+    url.to_s
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: better_storage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yi Feng Xie
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.5
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/better_storage.rb
+- lib/better_storage/attachment.rb
+- lib/better_storage/blob.rb
+- lib/better_storage/railtie.rb
+- lib/better_storage/s3_service_proxy.rb
+- lib/better_storage/version.rb
+homepage: https://github.com/yfxie/better_storage/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: enhance active_storage
+test_files: []