ckeditor 4.3.0 → 5.1.0

data/lib/generators/ckeditor/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/migration'
 
@@ -13,7 +15,7 @@ module Ckeditor
                          desc: 'Backend processor for upload support'
 
       class_option :backend, type: :string, default: 'paperclip',
-                             desc: 'paperclip (default), carrierwave, refile or dragonfly'
+                             desc: 'paperclip (default), active_storage, carrierwave or dragonfly'
 
       def self.source_root
         @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
@@ -30,6 +32,10 @@ module Ckeditor
         if backend_dragonfly?
           template 'base/dragonfly/initializer.rb', 'config/initializers/ckeditor_dragonfly.rb'
         end
+
+        if backend_shrine?
+          template 'base/shrine/initializer.rb', 'config/initializers/ckeditor_shrine.rb'
+        end
       end
 
       def mount_engine
@@ -52,11 +58,10 @@ module Ckeditor
       end
 
       def create_ckeditor_migration
-        if ['active_record'].include?(orm)
-          migration_template "#{generator_dir}/#{migration_file}.rb",
-                             File.join('db/migrate', 'create_ckeditor_assets.rb'),
-                             migration_version: migration_version
-        end
+        return unless ['active_record'].include?(orm)
+
+        migration_template "#{generator_dir}/migration.rb",
+                           File.join('db/migrate', 'create_ckeditor_assets.rb')
       end
 
       protected
@@ -69,6 +74,10 @@ module Ckeditor
         backend == 'dragonfly'
       end
 
+      def backend_shrine?
+        backend == 'shrine'
+      end
+
       def ckeditor_dir
         'ckeditor'
       end
@@ -88,18 +97,6 @@ module Ckeditor
       def backend
         (options[:backend] || 'paperclip').to_s
       end
-
-      def rails5?
-        Rails.version.start_with? '5'
-      end
-
-      def migration_version
-        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
-      end
-
-      def migration_file
-        rails5? ? 'migration_versioned' : 'migration'
-      end
     end
   end
 end

data/lib/generators/ckeditor/pundit_policy_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 
 module Ckeditor

data/lib/generators/ckeditor/templates/active_record/active_storage/ckeditor/asset.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Ckeditor::Asset < ActiveRecord::Base
+  include Ckeditor::Orm::ActiveRecord::AssetBase
+  include Ckeditor::Backend::ActiveStorage
+
+  attr_accessor :data
+
+  has_one_attached :storage_data
+end

data/lib/generators/ckeditor/templates/active_record/{refile → active_storage}/ckeditor/attachment_file.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class Ckeditor::AttachmentFile < Ckeditor::Asset
-  attachment :data, extension: attachment_file_types
+  # for validation, see https://github.com/igorkasyanchuk/active_storage_validations
 
   def url_thumb
     @url_thumb ||= Ckeditor::Utils.filethumb(filename)

data/lib/generators/ckeditor/templates/active_record/active_storage/ckeditor/picture.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Ckeditor::Picture < Ckeditor::Asset
+  # for validation, see https://github.com/igorkasyanchuk/active_storage_validations
+
+  def url_content
+    rails_representation_url(storage_data.variant(resize: '800>').processed, only_path: true)
+  end
+
+  def url_thumb
+    rails_representation_url(storage_data.variant(resize: '118x100').processed, only_path: true)
+  end
+end

data/lib/generators/ckeditor/templates/active_record/{carrierwave/migration_versioned.rb → active_storage/migration.rb}

@@ -1,14 +1,17 @@
-class CreateCkeditorAssets < ActiveRecord::Migration<%= migration_version %>
-  def self.up
+# frozen_string_literal: true
+
+class CreateCkeditorAssets < ActiveRecord::Migration[5.2]
+  def up
     create_table :ckeditor_assets do |t|
       t.string  :data_file_name, null: false
       t.string  :data_content_type
       t.integer :data_file_size
+      t.string  :data_fingerprint
       t.string  :type, limit: 30
 
       # Uncomment it to save images dimensions, if your need it
-      t.integer :width
-      t.integer :height
+      # t.integer :width
+      # t.integer :height
 
       t.timestamps null: false
     end
@@ -16,7 +19,7 @@ class CreateCkeditorAssets < ActiveRecord::Migration<%= migration_version %>
     add_index :ckeditor_assets, :type
   end
 
-  def self.down
+  def down
     drop_table :ckeditor_assets
   end
 end

data/lib/generators/ckeditor/templates/active_record/carrierwave/ckeditor/asset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::Asset < ActiveRecord::Base
   include Ckeditor::Orm::ActiveRecord::AssetBase
 

data/lib/generators/ckeditor/templates/active_record/carrierwave/ckeditor/attachment_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::AttachmentFile < Ckeditor::Asset
   mount_uploader :data, CkeditorAttachmentFileUploader, mount_on: :data_file_name
 

data/lib/generators/ckeditor/templates/active_record/carrierwave/ckeditor/picture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::Picture < Ckeditor::Asset
   mount_uploader :data, CkeditorPictureUploader, mount_on: :data_file_name
 

data/lib/generators/ckeditor/templates/active_record/carrierwave/migration.rb

@@ -1,5 +1,7 @@
-class CreateCkeditorAssets < ActiveRecord::Migration
-  def self.up
+# frozen_string_literal: true
+
+class CreateCkeditorAssets < ActiveRecord::Migration[5.2]
+  def up
     create_table :ckeditor_assets do |t|
       t.string  :data_file_name, null: false
       t.string  :data_content_type
@@ -7,8 +9,8 @@ class CreateCkeditorAssets < ActiveRecord::Migration
       t.string  :type, limit: 30
 
       # Uncomment it to save images dimensions, if your need it
-      t.integer :width
-      t.integer :height
+      # t.integer :width
+      # t.integer :height
 
       t.timestamps null: false
     end
@@ -16,7 +18,7 @@ class CreateCkeditorAssets < ActiveRecord::Migration
     add_index :ckeditor_assets, :type
   end
 
-  def self.down
+  def down
     drop_table :ckeditor_assets
   end
 end

data/lib/generators/ckeditor/templates/active_record/dragonfly/ckeditor/asset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::Asset < ActiveRecord::Base
   include Ckeditor::Orm::ActiveRecord::AssetBase
   include Ckeditor::Backend::Dragonfly

data/lib/generators/ckeditor/templates/active_record/dragonfly/ckeditor/attachment_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::AttachmentFile < Ckeditor::Asset
   validates_property :ext, of: :data, in: attachment_file_types unless attachment_file_types.empty?
 

data/lib/generators/ckeditor/templates/active_record/dragonfly/ckeditor/picture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::Picture < Ckeditor::Asset
   validates_property :format, of: :data, in: image_file_types unless image_file_types.empty?
   validates_property :image?, of: :data, as: true, message: :invalid

data/lib/generators/ckeditor/templates/active_record/dragonfly/migration.rb

@@ -1,5 +1,7 @@
-class CreateCkeditorAssets < ActiveRecord::Migration
-  def self.up
+# frozen_string_literal: true
+
+class CreateCkeditorAssets < ActiveRecord::Migration[5.2]
+  def up
     create_table :ckeditor_assets do |t|
       t.string  :data_uid, null: false
       t.string  :data_name, null: false
@@ -8,8 +10,8 @@ class CreateCkeditorAssets < ActiveRecord::Migration
       t.string  :type, limit: 30
 
       # Uncomment these to save image dimensions, if your need them.
-      t.integer :data_width
-      t.integer :data_height
+      # t.integer :data_width
+      # t.integer :data_height
 
       t.timestamps null: false
     end
@@ -17,7 +19,7 @@ class CreateCkeditorAssets < ActiveRecord::Migration
     add_index :ckeditor_assets, :type
   end
 
-  def self.down
+  def down
     drop_table :ckeditor_assets
   end
 end

data/lib/generators/ckeditor/templates/active_record/paperclip/ckeditor/asset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::Asset < ActiveRecord::Base
   include Ckeditor::Orm::ActiveRecord::AssetBase
   include Ckeditor::Backend::Paperclip

data/lib/generators/ckeditor/templates/active_record/paperclip/ckeditor/attachment_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::AttachmentFile < Ckeditor::Asset
   has_attached_file :data,
                     url: '/ckeditor_assets/attachments/:id/:filename',

data/lib/generators/ckeditor/templates/active_record/paperclip/ckeditor/picture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::Picture < Ckeditor::Asset
   has_attached_file :data,
                     url: '/ckeditor_assets/pictures/:id/:style_:basename.:extension',

data/lib/generators/ckeditor/templates/active_record/paperclip/migration.rb

@@ -1,5 +1,7 @@
-class CreateCkeditorAssets < ActiveRecord::Migration
-  def self.up
+# frozen_string_literal: true
+
+class CreateCkeditorAssets < ActiveRecord::Migration[5.2]
+  def up
     create_table :ckeditor_assets do |t|
       t.string  :data_file_name, null: false
       t.string  :data_content_type
@@ -7,9 +9,9 @@ class CreateCkeditorAssets < ActiveRecord::Migration
       t.string  :data_fingerprint
       t.string  :type, limit: 30
 
-      # Uncomment	it to save images dimensions, if your need it
-      t.integer :width
-      t.integer :height
+      # Uncomment it to save images dimensions, if your need it
+      # t.integer :width
+      # t.integer :height
 
       t.timestamps null: false
     end
@@ -17,7 +19,7 @@ class CreateCkeditorAssets < ActiveRecord::Migration
     add_index :ckeditor_assets, :type
   end
 
-  def self.down
+  def down
     drop_table :ckeditor_assets
   end
 end

data/lib/generators/ckeditor/templates/base/carrierwave/uploaders/ckeditor_attachment_file_uploader.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'carrierwave'
 
 class CkeditorAttachmentFileUploader < CarrierWave::Uploader::Base

data/lib/generators/ckeditor/templates/base/carrierwave/uploaders/ckeditor_picture_uploader.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 class CkeditorPictureUploader < CarrierWave::Uploader::Base
   include Ckeditor::Backend::CarrierWave
 
@@ -28,8 +29,6 @@ class CkeditorPictureUploader < CarrierWave::Uploader::Base
   #   # do something
   # end
 
-  process :extract_dimensions
-
   # Create different versions of your uploaded files:
   version :thumb do
     process resize_to_fill: [118, 100]

data/lib/generators/ckeditor/templates/base/dragonfly/initializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Load Dragonfly if it isn't loaded already.
 require 'dragonfly'
 

data/lib/generators/ckeditor/templates/base/shrine/initializer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'shrine'
+require 'shrine/storage/file_system'
+require 'ckeditor/backend/shrine'
+
+# Choose your favorite image processor
+require 'image_processing/mini_magick'
+SHRINE_PICTURE_PROCESSOR = ImageProcessing::MiniMagick
+
+# require 'image_processing/vips'
+# SHRINE_PICTURE_PROCESSOR = ImageProcessing::Vips
+
+Shrine.storages = {
+  cache: Shrine::Storage::FileSystem.new('public', prefix: 'uploads/cache'),
+  store: Shrine::Storage::FileSystem.new('public', prefix: 'system')
+}
+
+Shrine.plugin :determine_mime_type
+Shrine.plugin :mongoid
+Shrine.plugin :instrumentation
+
+Shrine.plugin :validation_helpers
+Shrine.plugin :processing
+Shrine.plugin :versions

data/lib/generators/ckeditor/templates/ckeditor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Use this hook to configure ckeditor
 Ckeditor.setup do |config|
   # ==> ORM configuration
@@ -23,7 +25,7 @@ Ckeditor.setup do |config|
 
   # Setup authorization to be run as a before filter
   # By default: there is no authorization.
-  # config.authorize_with :cancan
+  # config.authorize_with :cancancan
 
   # Override parent controller CKEditor inherits from
   # By default: 'ApplicationController'
@@ -41,11 +43,6 @@ Ckeditor.setup do |config|
   # By default: nil
   # config.asset_path = 'http://www.example.com/assets/ckeditor/'
 
-  # To reduce the asset precompilation time, you can limit plugins and/or languages to those you need:
-  # By default: nil (no limit)
-  # config.assets_languages = ['en', 'uk']
-  # config.assets_plugins = ['image', 'smiley']
-
   # CKEditor CDN
   # More info here http://cdn.ckeditor.com/
   # By default: nil (CDN disabled)

data/lib/generators/ckeditor/templates/mongoid/carrierwave/ckeditor/asset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::Asset
   include Ckeditor::Orm::Mongoid::AssetBase
 

data/lib/generators/ckeditor/templates/mongoid/carrierwave/ckeditor/attachment_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::AttachmentFile < Ckeditor::Asset
   mount_uploader :data, CkeditorAttachmentFileUploader, mount_on: :data_file_name
 

data/lib/generators/ckeditor/templates/mongoid/carrierwave/ckeditor/picture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::Picture < Ckeditor::Asset
   mount_uploader :data, CkeditorPictureUploader, mount_on: :data_file_name
 

data/lib/generators/ckeditor/templates/mongoid/paperclip/ckeditor/asset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::Asset
   include Ckeditor::Orm::Mongoid::AssetBase
   include Mongoid::Paperclip

data/lib/generators/ckeditor/templates/mongoid/paperclip/ckeditor/attachment_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::AttachmentFile < Ckeditor::Asset
   has_mongoid_attached_file :data,
                             url: '/ckeditor_assets/attachments/:id/:filename',

data/lib/generators/ckeditor/templates/mongoid/paperclip/ckeditor/picture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::Picture < Ckeditor::Asset
   has_mongoid_attached_file :data,
                             url: '/ckeditor_assets/pictures/:id/:style_:basename.:extension',

data/lib/generators/ckeditor/templates/mongoid/shrine/ckeditor/asset.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Ckeditor::Asset
+  include Ckeditor::Orm::Mongoid::AssetBase
+  include Ckeditor::Backend::Shrine
+
+  field :data_data, type: Hash
+end

data/lib/generators/ckeditor/templates/mongoid/shrine/ckeditor/attachment_file.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Ckeditor
+  class AttachmentFileUploader < Shrine
+    plugin :validation_helpers
+
+    Attacher.validate do
+      validate_max_size 100.megabytes
+    end
+  end
+
+  class AttachmentFile < Ckeditor::Asset
+    include AttachmentFileUploader.attachment(:data)
+
+    validates :data, presence: true
+
+    def url_thumb
+      @url_thumb ||= Ckeditor::Utils.filethumb(filename)
+    end
+  end
+end