maglevcms-shrine 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3658da12d4c22331a5ef2fc56973d3acfd58c9c7b7f83157d6f5bf785d013029
+  data.tar.gz: e2beeefd16aa6534f93ab155f37af56ee8fe71767eda96e1cd2bbb81db031b5b
+SHA512:
+  metadata.gz: df9cc9c64dfe5efdabd79092a2fa1157e8d2573d4e646fd22d560c3d595763ebf1a0b6d375d008cd9e955c320599f0c7ae9c0c685debb28105c9f7648ff9eaa1
+  data.tar.gz: 445844f4cfd8256f54ef75f84251a3f34a8c66069f990f0ff25fb8409c301e510457cb79c4ca37b6fb6583b7a09efe2e9d66f68c3e14b57602aa49117c634ec9

data/README.md

@@ -0,0 +1,40 @@
+# Maglev Shrine
+
+Change [Maglev CMS](https://github.com/maglevhq/maglev-core) uploader (asset management) to use
+Shrine instead of Active Storage.
+
+## Requirements
+
+* Maglev 1.2+ (might work with earlier versions, but it's untested)
+* Shrine 3.5+ (might work with earlier versions, but it's untested)
+
+## Installation
+
+Add the gem to your Gemfile and run `bundle install`:
+
+```
+gem 'maglevcms-shrine'
+```
+
+Generate migration, run migrations and add a new initializer to configure the gem:
+
+```
+bundle exec rails g maglev:shrine:instal
+```
+
+## Usage
+
+No changes are required from the application side. The gem takes care of doing all the necessary
+changes so Maglev starts using Shrine.
+
+**NOTE**: Active Storage needs to still be loaded in the application because `app/controllers/maglev/api/assets_controller.rb` in the maglev-core gem uses it.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## TODO
+
+* Add specs.

data/db/migrate/20231003115104_add_file_data_to_maglev_assets.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class AddFileDataToMaglevAssets < ActiveRecord::Migration[7.0]
+
+  def change
+    add_column :maglev_assets, :file_data, :jsonb
+  end
+
+end

data/lib/generators/maglev/shrine/install_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Shrine
+    class InstallGenerator < Rails::Generators::Base
+
+      desc 'Install Maglev Shrine integration'
+      source_root File.expand_path('templates/install', __dir__)
+
+      def migrations
+        rake 'maglev_shrine:install:migrations'
+        rake 'db:migrate'
+      end
+
+      def create_initializer
+        directory 'config'
+      end
+
+      def instructions
+        $stdout.puts <<~INFO
+          Done! 🎉
+
+          You can now tweak config/initializers/maglev_shrine.rb
+        INFO
+      end
+
+    end
+  end
+end

data/lib/generators/maglev/shrine/templates/install/config/initializers/maglev_shrine.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+Maglev::Shrine.configure do |config|
+  # Change accepted file formats when uploading assets.
+  # Used by the Shrine validation plugin.
+  # config.accepted_mime_types = %w[image/jpeg image/png image/webp image/gif image/heic]
+
+  # Change maximum allowed file size.
+  # Used by the Shrine validation plugin.
+  # config.max_file_size = 20.megabytes
+
+  # Change analyzer used to extract image dimensions.
+  # This value is used by the Shrine store_dimensions plugin. Refer to the plugin
+  # documentation for a list of supported values.
+  # https://shrinerb.com/docs/plugins/store_dimensions
+  # config.store_dimensions_plugin_analyzer = :ruby_vips
+end

data/lib/maglev/shrine/asset_file_uploader.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Shrine
+    class AssetFileUploader < ::Shrine
+
+      plugin :determine_mime_type,
+             analyzer: :marcel,
+             analyzer_options: { filename_fallback: true }
+
+      plugin :store_dimensions,
+             analyzer: Maglev::Shrine.config.store_dimensions_plugin_analyzer
+
+      plugin :validation_helpers
+
+      Attacher.validate do
+        validate_max_size Maglev::Shrine.config.max_file_size
+        validate_mime_type Maglev::Shrine.config.accepted_mime_types
+      end
+
+    end
+  end
+end

data/lib/maglev/shrine/config.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Shrine
+    Config = Struct.new(:accepted_mime_types, :max_file_size,
+                        :store_dimensions_plugin_analyzer)
+  end
+end

data/lib/maglev/shrine/engine.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Shrine
+    class Engine < ::Rails::Engine
+
+      isolate_namespace Maglev::Shrine
+
+    end
+  end
+end

data/lib/maglev/shrine/uploader.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Shrine
+    module Uploader
+      extend ActiveSupport::Concern
+
+      included do
+        before_save :set_metadata
+
+        include AssetFileUploader::Attachment(:file)
+
+        delegate :url, to: :file
+      end
+
+      def download
+        file.download.read
+      end
+
+      private
+
+      def set_metadata
+        metadata = file.metadata
+        assign_attributes(
+          filename: metadata['filename'],
+          content_type: metadata['mime_type'],
+          byte_size: metadata['size'],
+          height: metadata['height'],
+          width: metadata['width']
+        )
+      end
+
+      module ClassMethods
+        def optimized
+          all
+        end
+      end
+    end
+  end
+end

data/lib/maglev/shrine/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Shrine
+    VERSION = '1.0'
+  end
+end

data/lib/maglevcms-shrine.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'maglev/shrine/engine'
+require 'maglev/shrine/config'
+
+module Maglev
+  module Shrine
+    # We use autoload instead of require to load these classes after Rails
+    # initializers have loaded. Shrine uploaders inherit from the Shrine class
+    # At the time of loading the class, it copies all configuration from the
+    # Shrine class. This includes configuration done on the Shrine initializer
+    # by using Shrine.plugin or other method calls.
+    # If we require the AssetFileUploder class when requiring the gem, then it
+    # will not copy any configuration, because the Shrine initializer has not
+    # been run yet.
+    # By delaying requiring until the classes is requested, we make sure the
+    # Shrine base class already has all necessary configuration set up.
+    autoload :AssetFileUploader, 'maglev/shrine/asset_file_uploader'
+    autoload :Uploader, 'maglev/shrine/uploader'
+
+    class << self
+
+      def config
+        @config ||= Config.new.tap do |c|
+          c.accepted_mime_types = %w[image/jpeg image/png image/webp image/gif image/heic]
+          c.max_file_size = 20.megabytes
+          c.store_dimensions_plugin_analyzer = :ruby_vips
+        end
+      end
+
+      def configure
+        yield config
+      end
+
+    end
+  end
+
+  # Maglev allows to change the uploader by changing `config.uploader`.
+  # However it searches the uploader only inside the maglevcms gem, so it's not possible
+  # to specify a custom uploader. We override the `uploader` method to fix.
+  class << self
+
+    def uploader
+      Maglev::Shrine::Uploader
+    end
+
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: maglevcms-shrine
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- MarsBased
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: maglevcms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: shrine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Changes assets management in Maglev CMS to use Shrine.
+email:
+- dev@marsbased.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- db/migrate/20231003115104_add_file_data_to_maglev_assets.rb
+- lib/generators/maglev/shrine/install_generator.rb
+- lib/generators/maglev/shrine/templates/install/config/initializers/maglev_shrine.rb
+- lib/maglev/shrine/asset_file_uploader.rb
+- lib/maglev/shrine/config.rb
+- lib/maglev/shrine/engine.rb
+- lib/maglev/shrine/uploader.rb
+- lib/maglev/shrine/version.rb
+- lib/maglevcms-shrine.rb
+homepage: https://github.com/MarsBased/maglevcms-shrine
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/MarsBased/maglevcms-shrine
+  source_code_uri: https://github.com/MarsBased/maglevcms-shrine
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Integrates Maglev CMS with Shrine.
+test_files: []