cas-cms 1.0.0.alpha1 → 1.0.0.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f12f0fb6a3b7c3c29caf99a139194aac107be867f347f5738d2b9cc215a5581
-  data.tar.gz: 950fd904a33eb23cd9467cc2324a6bea612a1e920a4c90d227ace4d299276257
+  metadata.gz: 96db3f49e7ef1be93244ed68bf8a6b7a9ed8fd063c7a8eef270028d3c5a0fe49
+  data.tar.gz: 769019cb609a44cb5e10ddae58d9914f6276b373002e8bad542b3988175744b5
 SHA512:
-  metadata.gz: b7f891b42b447860a676e36aa868221a0165d81819f95e3d3ea3f9b88111eeb21eaa3788468156e9818e0d7c119b285faba5538cb47a8b27f76fea776505c7be
-  data.tar.gz: 8c720e1eb5382606cdf7679d242617734efcfb40501c5a813da22fcafe9a0d958c7c4be431805c9d8f262e0dd16725ce106cef2398b290d8c5040cd77ecb3445
+  metadata.gz: b116b21f10eb582ad68d7664d89b15e9619a459f4f83d0bba55701e77da658a7fecae9900ba56b9bf4f68e8621fb6231d619eb3d64fe7bfb295dce508b87fe2d
+  data.tar.gz: 56517fae5fb373605c9c323c1c72a8441564e88419c87af7dbdf73a16b723d81dc38d332680cf8f048a159b894a4ce151ca4fad0b30f22f02a6f74ae99e1147c

data/README.md

@@ -1,5 +1,7 @@
 # Cas
 
+For branches for specific versions: [rails-5](https://github.com/cas-cms/cas-core/tree/rails-5)
+
 ## Usage
 
 Add this line to your application's Gemfile:
@@ -16,7 +18,7 @@ bin/rails generate cas:install
 
 This adds an `/admin` entry to `config/routes.rb` and generates a new file,
 `config/cas.config.yml` which contains all sections your site is supposed to
-have. 
+have.
 
 Once the file is edited, run
 

data/app/assets/javascripts/cas/fileupload_manifest.js

@@ -77,14 +77,12 @@ var ImageGalleryUploadFunctions = {
     data.progressBar.remove();
 
     var file = {
-      original: {
-        id: data.formData.key.match(/cache\/(.+)/)[1], // we have to remove the prefix part
-        storage: 'cache',
-        metadata: {
-          size:      data.files[0].size,
-          filename:  data.files[0].name.match(/[^\/\\]*$/)[0], // IE returns full path
-          mime_type: data.files[0].type
-        }
+      id: data.formData.key.match(/cache\/(.+)/)[1], // we have to remove the prefix part
+      storage: 'cache',
+      metadata: {
+        size:      data.files[0].size,
+        filename:  data.files[0].name.match(/[^\/\\]*$/)[0], // IE returns full path
+        mime_type: data.files[0].type
       }
     }
 
@@ -148,14 +146,12 @@ var AttachmentUploadFunctions = {
     data.progressBar.remove();
 
     var file = {
-      original: {
-        id: data.formData.key.match(/cache\/(.+)/)[1], // we have to remove the prefix part
-        storage: 'cache',
-        metadata: {
-          size:      data.files[0].size,
-          filename:  data.files[0].name.match(/[^\/\\]*$/)[0], // IE returns full path
-          mime_type: data.files[0].type
-        }
+      id: data.formData.key.match(/cache\/(.+)/)[1], // we have to remove the prefix part
+      storage: 'cache',
+      metadata: {
+        size:      data.files[0].size,
+        filename:  data.files[0].name.match(/[^\/\\]*$/)[0], // IE returns full path
+        mime_type: data.files[0].type
       }
     }
 

data/app/controllers/cas/api/files_controller.rb

@@ -5,17 +5,27 @@ class Cas::Api::FilesController < Cas::ApplicationController
     if ENV.fetch("S3_BUCKET")
       service = "s3"
     end
+
     metadata = resource_params[:attributes][:metadata]
     file = ::Cas::MediaFile.new(
       service: service,
-      size: metadata[:original][:metadata][:size].to_i,
-      original_name: metadata[:original][:metadata][:filename],
-      mime_type: metadata[:original][:metadata][:mime_type],
+      size: metadata[:metadata][:size].to_i,
+      original_name: metadata[:metadata][:filename],
+      mime_type: metadata[:metadata][:mime_type],
       media_type: resource_params[:attributes][:media_type],
       file: metadata.to_json,
-      attachable: attachable_record
+      attachable: attachable_record,
+      author: current_user,
     )
-    file.save
+
+    Rails.logger.debug metadata.inspect
+
+    unless !file.valid?
+      Rails.logger.debug "File upload failed: #{file.errors.inspect}"
+    end
+
+    file.save!
+
     Cas::RemoteCallbacks.callbacks[:after_file_upload].call(file)
     render json: {
       data: {
@@ -53,11 +63,9 @@ class Cas::Api::FilesController < Cas::ApplicationController
           :cover,
           :media_type,
           metadata: [
-            original: [
-              :id,
-              :storage,
-              metadata: [:size, :filename, :mime_type, 'mime-type']
-            ]
+            :id,
+            :storage,
+            metadata: [:size, :filename, :mime_type, 'mime-type']
           ]
         ],
         relationships: [
@@ -68,10 +76,10 @@ class Cas::Api::FilesController < Cas::ApplicationController
       )
 
     if r[:attributes][:metadata].present?
-      if r[:attributes][:metadata][:original][:metadata][:mime_type].blank?
-        r[:attributes][:metadata][:original][:metadata][:mime_type] = r[:attributes][:metadata][:original][:metadata][:"mime-type"]
+      if r[:attributes][:metadata][:metadata][:mime_type].blank?
+        r[:attributes][:metadata][:metadata][:mime_type] = r[:attributes][:metadata][:metadata][:"mime-type"]
       end
-      r[:attributes][:metadata][:original][:metadata].delete(:"mime-type")
+      r[:attributes][:metadata][:metadata].delete(:"mime-type")
     end
     r
   end

data/app/controllers/cas/sites/sections/contents_controller.rb

@@ -25,6 +25,7 @@ module Cas
           @content.section_id = @section.id
           @content.tag_list = content_params[:tag_list] if content_params[:tag_list]
           success = @content.save!
+
           ::Cas::Activity.create!(user: current_user, site: @site, subject: @content, event_name: 'create')
           associate_files(@content, :images)
           associate_files(@content, :attachments)
@@ -96,7 +97,9 @@ module Cas
         # When no file is uploaded, when the content form is submitted the
         # `file` input ends up being sent empty (e.g file: [""]). This confuses
         # Rails.
-        params[:content].delete(:file) if params[:content][:file].map(&:presence).compact.blank?
+        if params[:content][:file].present?
+          params[:content].delete(:file) if params[:content][:file].map(&:presence)&.compact.blank?
+        end
 
         result = params.require(:content).permit(
           :category_id,

data/app/jobs/cas/images/delete_job.rb

@@ -3,8 +3,11 @@ module Cas
     class DeleteJob
       include ::Sidekiq::Worker
 
-      def perform(data)
-        ::Shrine::Attacher.delete(data)
+      def perform(attacher_class, data)
+        attacher_class = Object.const_get(attacher_class)
+
+        attacher = attacher_class.from_data(data)
+        attacher.destroy
       end
     end
   end

data/app/jobs/cas/images/promote_job.rb

@@ -1,10 +1,19 @@
 module Cas
   module Images
     class PromoteJob
-      include ::Sidekiq::Worker
 
-      def perform(data)
-        ::Shrine::Attacher.promote(data)
+      include Sidekiq::Worker
+
+      def perform(attacher_class, record_class, record_id, name, file_data)
+        attacher_class = Object.const_get(attacher_class)
+        record         = Object.const_get(record_class).find(record_id) # if using Active Record
+
+        attacher = attacher_class.retrieve(model: record, name: name, file: file_data)
+        attacher.create_derivatives # call derivatives processor 
+        attacher.atomic_promote
+      rescue Shrine::AttachmentChanged, ActiveRecord::RecordNotFound => e
+        Rails.logger.info e.inspect
+        # attachment has changed or record has been deleted, nothing to do
       end
     end
   end

data/app/models/cas/media_file.rb

@@ -1,12 +1,12 @@
 module Cas
   class MediaFile < ApplicationRecord
-    include FileUploader::Attachment.new(:file)
+    include FileUploader::Attachment.new(:file) # This is for the Shrine gem
 
     class UnknownPath < StandardError; end
     class UnknownFileService < StandardError; end
 
-    belongs_to :attachable, polymorphic: true
-    belongs_to :author, class_name: "::Cas::User"
+    belongs_to :attachable, polymorphic: true, optional: true
+    belongs_to :author, class_name: "::Cas::User", optional: true
 
     before_validation :set_media_type
     before_save :set_image_as_unique_cover
@@ -39,13 +39,37 @@ module Cas
           raise UnknownFileService
         end
 
-      # Shrine gem uses `file_data`
+      # Shrine gem uses `file_data` because `file` is the name we specified for
+      # the Attachment at the top of this model.
       elsif JSON.parse(file_data).present?
-        if cdn.present?
-          file_url(version.to_sym, host: cdn, public: true)
-        else
-          file_url(version.to_sym, public: true).gsub(/\?.*/, "")
-        end
+        params = {
+          public: true
+        }
+        params[:host] = cdn if cdn.present?
+
+        # With Shrine, the default image version is :original. Other versions
+        # are called derivatives. The `file_url` method expects a derivative
+        # name as first argument.
+        #
+        # When we pass :original, it just returns `nil` because the main file is
+        # not considered a derivative. If we had something like :larger, then
+        # that would be the argument.
+        url = if version.to_sym == :original
+                file_url(params)
+              else
+                file_url(version, params)
+              end
+
+        # Shrine 3 returns `nil` when a derivative doesn't exist. It also
+        # returns `nil` when we pass parameters. This is a fallback way of
+        # avoiding any `nil` returns. However, notice that we can't pass
+        # `params` because Shrine just ignores it and returns `nil` if it's
+        # present (it wasn't like that in Shrine 2).
+        url = file_url if url.blank?
+
+        # Amazon S3 has URLs that include some query strings like signatures
+        # which we don't want to include in URLs.
+        url&.gsub(/\?.*/, "")
       else
         raise UnknownPath
       end

data/app/uploaders/file_uploader.rb

@@ -1,14 +1,13 @@
 class ::FileUploader < Shrine
-  plugin :versions
-  plugin :processing
 
-  process(:store) do |io, context|
-    result = {}
+  Attacher.derivatives do |original|
+    result = {
+    }
+
     if context[:record].media_type == 'image'
-      result = Cas::RemoteCallbacks.callbacks[:uploaded_image_versions].call(io, context)
+      result = Cas::RemoteCallbacks.callbacks[:uploaded_image_versions].call(original)
     end
-    original = (io.respond_to?(:[]) && io[:original]) ? io[:original] : io
-    result = result.merge(original: original) unless result.keys.include?(:original)
+
     Rails.logger.info "FileUploader, versions: [#{result.keys.join(", ")}]"
     result
   end

data/config/initializers/shrine.rb

@@ -4,16 +4,15 @@
 require 'shrine'
 
 Shrine.plugin :activerecord
-Shrine.plugin :presign_endpoint
 Shrine.plugin :backgrounding
 
+Shrine.plugin(
+  :derivatives,
+  create_on_promote:      true, # automatically create derivatives on promotion 
+  versions_compatibility: true  # handle versions column format 
+)
+
 if Rails.env.test?
-  s3_options = {
-    access_key_id:     'access_key_id',
-    secret_access_key: 'secret_access_key',
-    region:            'us-east-1',
-    bucket:            'com.bucket'
-  }
   require "shrine/storage/file_system"
 
   Shrine.storages = {
@@ -27,6 +26,7 @@ else
     puts msg
 
   else
+    Shrine.plugin :presign_endpoint
     s3_options = {
       access_key_id:     ENV.fetch("S3_ACCESS_KEY_ID"),
       secret_access_key: ENV.fetch("S3_SECRET_ACCESS_KEY"),
@@ -43,12 +43,19 @@ else
   end
 end
 
-Shrine::Attacher.promote do |data|
-  Rails.logger.info "Shrine promoting file scheduled"
-  ::Cas::Images::PromoteJob.perform_async(data)
+Shrine::Attacher.promote_block do
+  Rails.logger.info "Shrine promoting #{record.class.name} file scheduled"
+  ::Cas::Images::PromoteJob.perform_async(
+    self.class.name,
+    record.class.name,
+    record.id,
+    name.to_s,
+    file_data
+  )
 end
 
-Shrine::Attacher.delete do |data|
+
+Shrine::Attacher.destroy_block do
   Rails.logger.info "Shrine deleting file scheduled"
-  ::Cas::Images::DeleteJob.perform_async(data)
+  ::Cas::Images::DeleteJob.perform_async(self.class.name, data)
 end

data/config/routes.rb

@@ -3,7 +3,12 @@ require 'sidekiq/web'
 #Sidekiq::Web.set :session_secret, Rails.application.secrets[:secret_key_base]
 
 Cas::Engine.routes.draw do
-  mount Shrine.presign_endpoint(:cache) => "/files/cache/presign"
+  if Shrine.respond_to?(:presign_endpoint)
+    mount Shrine.presign_endpoint(:cache) => "/files/cache/presign"
+  else
+    Rails.logger.info "Shrine's presign endpoint is disabled"
+  end
+
   # TODO - fix
   # mount Shrine.upload_endpoint(:cache) => "/files/upload"
 

data/lib/cas/remote_callbacks.rb

@@ -9,9 +9,9 @@ module Cas
       #     big:    big_image
       #   }
       #
-      # `original` should always be present. If it is not, we will merge it
-      # afterwards automatically.
-      uploaded_image_versions: ->(io, context) {
+      # `original` should not be present after Shrine 3.0. If it is not, we will
+      # merge it afterwards automatically.
+      uploaded_image_versions: ->(original) {
         {}
       },
 

data/lib/cas/version.rb

@@ -1,3 +1,3 @@
 module Cas
-  VERSION = '1.0.0.alpha1'
+  VERSION = '1.0.0.alpha2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cas-cms
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha1
+  version: 1.0.0.alpha2
 platform: ruby
 authors:
 - Alexandre de Oliveira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-20 00:00:00.000000000 Z
+date: 2023-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -182,16 +182,16 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: sprockets-rails
   requirement: !ruby/object:Gem::Requirement
@@ -238,16 +238,16 @@ dependencies:
   name: shrine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.19.1
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.19.1
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: roda
   requirement: !ruby/object:Gem::Requirement
@@ -263,21 +263,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: amazing_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -579,7 +579,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -594,8 +594,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Summary of Cas.
 test_files: []