spina-upgrade 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e6f62df1d7ca5718cb17a03faf0be690a10e2f02456dc42b34e46109f090511
+  data.tar.gz: 0ffcb6f05f10e10a2d13d64a2c16b41a8616793d0d6ff4dd344a385c38a3c608
+SHA512:
+  metadata.gz: ffab776d0cf3d83fbc17d95e6c467098c042efa624baec568e653bb5df5c029b51771c0eb8e454d38b31aa4b758180cb7dcedfa89d8e6b8a67a4a2a9916bca06
+  data.tar.gz: 52d2d3980a318f80f2e1c6bb036278cd4bb1db5457fb065d5ce2a6ac410c953d5a691a40d7bb4492ab0859cb109a993ae44abc7b21365b1a7b0d0af0ebb8c042

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Bram Jetten
+
+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,19 @@
+# Spina::Upgrade
+This gem is meant for upgrading your Spina project from 0.X to 1.0 with support for ActiveStorage. All records of `Spina::Photo` will be reuploaded as `Spina::Image`. Make sure that you setup ActiveStorage before running the upgrade.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spina-upgrade'
+```
+
+## Usage
+Simply run the upgrade generator.
+
+```
+rails g spina:upgrade
+```
+
+## 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,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Spina::Upgrade'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_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/app/models/spina/attachment_collection.rb

@@ -0,0 +1,14 @@
+module Spina
+  class AttachmentCollection < ApplicationRecord
+    has_and_belongs_to_many :attachments, join_table: 'spina_attachment_collections_attachments'
+
+    # There's no attachment collection equivalent in Spina 2
+    # Instead, create a line with comma separated ID's of attachments
+    def convert_to_json!
+      json_part = Spina::Parts::Line.new
+      json_part.content = attachments.ids.join(", ")
+      json_part
+    end
+
+  end
+end

data/app/models/spina/image_collection.rb

@@ -0,0 +1,18 @@
+module Spina
+  class ImageCollection < ApplicationRecord
+    has_one :page_part, as: :page_partable
+    has_many :image_collections_images
+    has_many :images, through: :image_collections_images
+    
+    def convert_to_json!
+      json_part = Spina::Parts::ImageCollection.new
+      json_part.images = images.order(:position).map do |image|
+        image_json_part = image.convert_to_json!
+        image_json_part.name = page_part.name
+        image_json_part
+      end
+      json_part
+    end
+
+  end
+end

data/app/models/spina/image_collections_image.rb

@@ -0,0 +1,6 @@
+module Spina
+  class ImageCollectionsImage < ApplicationRecord
+    belongs_to :image
+    belongs_to :image_collection
+  end
+end

data/app/models/spina/line.rb

@@ -0,0 +1,12 @@
+module Spina
+  class Line < ApplicationRecord
+    extend Mobility
+    translates :content, fallbacks: true
+
+    def convert_to_json!
+      text = Spina::Parts::Line.new
+      text.content = content
+      text
+    end
+  end
+end

data/app/models/spina/option.rb

@@ -0,0 +1,11 @@
+module Spina
+  class Option < ApplicationRecord
+
+    def convert_to_json!
+      text = Spina::Parts::Option.new
+      text.value = value
+      text
+    end
+
+  end
+end

data/app/models/spina/page_part.rb

@@ -0,0 +1,12 @@
+module Spina
+  class PagePart < ApplicationRecord
+    belongs_to :page
+    belongs_to :page_partable, polymorphic: true
+
+    def convert_to_json!
+      json_part = page_partable.convert_to_json!
+      json_part.name = name
+      json_part
+    end
+  end
+end

data/app/models/spina/photo.rb

@@ -0,0 +1,28 @@
+module Spina
+  class Photo < ActiveRecord::Base
+    mount_uploader :file, PhotoUploader
+
+    belongs_to :media_folder, optional: true
+
+    has_many :page_parts, as: :page_partable
+    has_many :structure_parts, as: :structure_partable
+    has_many :photo_collections_photos
+    has_many :photo_collections, through: :photo_collections_photos
+
+    validates_presence_of :file
+
+    def name
+      file.file.filename
+    end
+
+    def content
+      self
+    end
+
+    def self.order_by_ids(ids)
+      sql = sanitize_sql_for_assignment({id: ids})
+      order("CASE WHEN #{sql} THEN 0 ELSE 1 END")
+    end
+    
+  end
+end

data/app/models/spina/photo_collection.rb

@@ -0,0 +1,10 @@
+module Spina
+  class PhotoCollection < ActiveRecord::Base
+    has_one :page_part, as: :page_partable
+    has_many :photo_collections_photos
+    has_many :photos, through: :photo_collections_photos
+    has_many :structure_parts, as: :structure_partable
+
+    accepts_nested_attributes_for :photos, allow_destroy: true
+  end
+end

data/app/models/spina/photo_collections_photo.rb

@@ -0,0 +1,6 @@
+module Spina
+  class PhotoCollectionsPhoto < ActiveRecord::Base
+    belongs_to :photo, optional: true
+    belongs_to :photo_collection, optional: true
+  end
+end

data/app/models/spina/structure.rb

@@ -0,0 +1,16 @@
+module Spina
+  class Structure < ApplicationRecord
+    has_one :page_part, as: :page_partable
+    has_many :structure_items
+
+    def convert_to_json!
+      repeater = Spina::Parts::Repeater.new
+      repeater.content = structure_items.order(:position).map do |structure_item|
+        json_structure_item = structure_item.convert_to_json!
+        json_structure_item.name = page_part.name
+        json_structure_item
+      end
+      repeater
+    end
+  end
+end

data/app/models/spina/structure_item.rb

@@ -0,0 +1,17 @@
+module Spina
+  class StructureItem < ApplicationRecord
+    has_many :structure_parts
+
+    def convert_to_json!
+      repeater_content = Spina::Parts::RepeaterContent.new
+      repeater_content.parts = structure_parts.map do |structure_part|
+        next unless structure_part.structure_partable.respond_to?(:convert_to_json!)
+        new_part = structure_part.convert_to_json!
+        new_part.name = structure_part.name
+        new_part
+      end.compact
+      repeater_content
+    end
+
+  end
+end

data/app/models/spina/structure_part.rb

@@ -0,0 +1,11 @@
+module Spina
+  class StructurePart < ApplicationRecord
+    belongs_to :structure_partable, polymorphic: true
+
+    def convert_to_json!
+      new_part = structure_partable.convert_to_json!
+      new_part.name = name
+      new_part
+    end
+  end
+end

data/app/models/spina/text.rb

@@ -0,0 +1,12 @@
+module Spina
+  class Text < ApplicationRecord
+    extend Mobility
+    translates :content, fallbacks: true
+
+    def convert_to_json!
+      text = Spina::Parts::Text.new
+      text.content = content
+      text
+    end
+  end
+end

data/app/uploaders/spina/default_store_uploader.rb

@@ -0,0 +1,15 @@
+module Spina
+  class DefaultStoreUploader < CarrierWave::Uploader::Base
+
+    def store_dir
+      case ::Spina.config.storage
+      when :s3
+        "#{mounted_as}/#{model.class.to_s.underscore}/#{model.id}"
+      when :file
+        "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+      else
+        raise NotImplementedError, "Please set your storage preferences in config/initializers/spina.rb"
+      end
+    end
+  end
+end

data/app/uploaders/spina/photo_uploader.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module Spina
+  class PhotoUploader < Spina::DefaultStoreUploader
+    include CarrierWave::MiniMagick
+
+    version :image do
+      process resize_to_fit: [800, 800], if: :too_large?
+    end
+
+    version :thumb do
+      process resize_to_fill: [150, 150]
+    end
+
+    def too_large?(new_file)
+      new_file.size > 120 * 1000
+    end
+
+    def extension_white_list
+      %w(jpg jpeg gif png)
+    end
+
+  end
+end

data/db/migrate/1_create_spina_upgrade_migration.rb

@@ -0,0 +1,15 @@
+class CreateSpinaUpgradeMigration < ActiveRecord::Migration[5.2]
+
+  def up
+    unless column_exists? :spina_photos, :image_id
+      add_column :spina_photos, :image_id, :integer, foreign_key: { to_table: :spina_images }
+    end
+  end
+
+  def down
+    if column_exists? :spina_photos, :image_id
+      remove_column :spina_photos, :image_id
+    end
+  end
+
+end

data/lib/generators/spina/upgrade_generator.rb

@@ -0,0 +1,22 @@
+module Spina
+  class UpgradeGenerator < Rails::Generators::Base
+
+    def copy_migrations
+      return if Rails.env.production?
+      rake 'spina_upgrade:install:migrations'
+    end
+
+    def run_migrations
+      rake 'db:migrate'
+    end
+
+    def upgrade
+      rake 'spina:photo_to_image'
+    end
+
+    def done
+      puts "Upgrade done"
+    end
+
+  end
+end

data/lib/spina/upgrade.rb

@@ -0,0 +1 @@
+require "spina/upgrade/engine"

data/lib/spina/upgrade/decorators/attachment_decorator.rb

@@ -0,0 +1,15 @@
+module Spina
+  module Upgrade
+    module AttachmentDecorator
+
+      def convert_to_json!
+        attachment = Spina::Parts::Attachment.new
+        attachment.attachment_id = id
+        attachment.signed_blob_id = file&.blob&.signed_id
+        attachment.filename = name
+        attachment
+      end
+      
+    end
+  end
+end

data/lib/spina/upgrade/decorators/image_decorator.rb

@@ -0,0 +1,15 @@
+module Spina
+  module Upgrade
+    module ImageDecorator
+
+      def convert_to_json!
+        image = Spina::Parts::Image.new
+        image.image_id = id
+        image.signed_blob_id = file&.blob&.signed_id
+        image.filename = name
+        image
+      end
+      
+    end
+  end
+end

data/lib/spina/upgrade/engine.rb

@@ -0,0 +1,22 @@
+require 'spina'
+require 'carrierwave'
+
+# Decorators for convert_to_json!
+require 'spina/upgrade/decorators/attachment_decorator'
+require 'spina/upgrade/decorators/image_decorator'
+
+module Spina
+  module Upgrade
+    class Engine < ::Rails::Engine
+      isolate_namespace Spina::Upgrade
+
+      config.autoload_paths += %W( #{config.root}/lib )
+
+      config.to_prepare do
+        Spina::Image.prepend(Spina::Upgrade::ImageDecorator)
+        Spina::Attachment.prepend(Spina::Upgrade::AttachmentDecorator)
+      end
+
+    end
+  end
+end

data/lib/spina/upgrade/version.rb

@@ -0,0 +1,5 @@
+module Spina
+  module Upgrade
+    VERSION = '0.2.0'
+  end
+end

data/lib/tasks/spina/upgrade_tasks.rake

@@ -0,0 +1,128 @@
+def prompt(*args)
+  print(*args)
+  STDIN.gets.chomp
+end
+
+namespace :spina do
+
+  task convert_page_parts_to_json: :environment do
+    page_partable_types = Spina::PagePart.joins(:page).pluck(:page_partable_type).uniq
+    puts "Checking if parts are convertable to JSON..."
+
+    all_set = true
+
+    page_partable_types.each do |partable_type|
+
+      if partable_type.constantize.new.respond_to?(:convert_to_json!)
+        puts "✓ #{partable_type}"
+      else
+        puts "✗ #{partable_type}"
+        all_set = false
+      end
+
+    end
+
+    unless all_set
+      answer = prompt("Not all parts can be converted to JSON. Continue? (y/n) ")
+      answer = false if answer == "n"
+      all_set = ActiveRecord::Type::Boolean.new.cast(answer)
+    end
+
+    if all_set
+      Spina.config.locales.each do |locale|
+        I18n.with_locale(locale) do
+          Spina::Page.all.each do |page|
+            page_parts = Spina::PagePart.where(page_id: page.id)
+            json_content = page_parts.map do |page_part|
+              next if page_part.page_partable.nil? # Skip blank page parts
+
+              json_part = if page_part.page_partable.respond_to?(:convert_to_json!)
+                page_part.convert_to_json!
+              else
+                nil
+              end
+            end.compact
+
+            page.update("#{locale}_content".to_sym => json_content)
+          end
+        end
+      end
+
+      puts "Converted!"
+    end
+  end
+
+  task photo_to_image: :environment do
+    bar = ProgressBar.create title: "Photos", total: Spina::Photo.where(image_id: nil).count
+    Spina::Photo.where(image_id: nil).find_each do |photo|
+      image = Spina::Image.create(media_folder_id: photo.media_folder_id)
+      begin
+        image.file.attach(io: photo.file.sanitized_file.file, filename: photo.name)
+        photo.update_column(:image_id, image.id)
+      rescue Errno::ENOENT
+        image.destroy
+      end
+      bar.increment
+    end
+
+    bar = ProgressBar.create title: "PageParts", total: Spina::PagePart.where(page_partable_type: 'Spina::Photo').count
+    Spina::PagePart.where(page_partable_type: 'Spina::Photo').find_each do |page_part|
+      if page_part.page_partable.present?
+        page_part.update_columns(
+          page_partable_type: 'Spina::Image',
+          page_partable_id: page_part.page_partable.image_id
+        )
+      else
+        page_part.update_column(:page_partable_type, 'Spina::Image')
+      end
+      bar.increment
+    end
+
+    bar = ProgressBar.create title: "StructureParts", total: Spina::StructurePart.where(structure_partable_type: 'Spina::Photo').count
+    Spina::StructurePart.where(structure_partable_type: 'Spina::Photo').find_each do |structure_part|
+      if structure_part.structure_partable.present?
+        structure_part.update_columns(
+          structure_partable_type: 'Spina::Image',
+          structure_partable_id: structure_part.structure_partable.image_id
+        )
+      else
+        structure_part.update_column(:structure_partable_type, 'Spina::Image')
+      end
+      bar.increment
+    end
+
+    bar = ProgressBar.create title: "PhotoCollections", total: Spina::PagePart.where(page_partable_type: 'Spina::PhotoCollection').count
+    Spina::PagePart.where(page_partable_type: 'Spina::PhotoCollection').find_each do |page_part|
+      if page_part.partable.present?
+        image_collection = Spina::ImageCollection.create
+        page_part.partable.photos.each do |photo|
+          image_collection.images << Spina::Image.find(photo.image_id)
+        end
+        page_part.update_columns(
+          page_partable_type: 'Spina::ImageCollection',
+          page_partable_id: image_collection.id
+        )
+      else
+        page_part.update_column :page_partable_type, 'Spina::ImageCollection'
+      end
+      bar.increment
+    end
+
+    bar = ProgressBar.create title: "StructurePart PhotoCollections", total: Spina::StructurePart.where(structure_partable_type: 'Spina::PhotoCollection').count
+    Spina::StructurePart.where(structure_partable_type: 'Spina::PhotoCollection').find_each do |structure_part|
+      if structure_part.partable.present?
+        image_collection = Spina::ImageCollection.create
+        structure_part.partable.photos.each do |photo|
+          image_collection.images << Spina::Image.find(photo.image_id)
+        end
+        structure_part.update_columns(
+          structure_partable_type: 'Spina::ImageCollection',
+          structure_partable_id: image_collection.id
+        )
+      else
+        structure_part.update_column :structure_partable_type, 'Spina::PhotoCollection'
+      end
+      bar.increment
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: spina-upgrade
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Bram Jetten
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Upgrade Spina to 2.0 from a previous version
+email:
+- bram@denkgroot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/spina/attachment_collection.rb
+- app/models/spina/image_collection.rb
+- app/models/spina/image_collections_image.rb
+- app/models/spina/line.rb
+- app/models/spina/option.rb
+- app/models/spina/page_part.rb
+- app/models/spina/photo.rb
+- app/models/spina/photo_collection.rb
+- app/models/spina/photo_collections_photo.rb
+- app/models/spina/structure.rb
+- app/models/spina/structure_item.rb
+- app/models/spina/structure_part.rb
+- app/models/spina/text.rb
+- app/uploaders/spina/default_store_uploader.rb
+- app/uploaders/spina/photo_uploader.rb
+- db/migrate/1_create_spina_upgrade_migration.rb
+- lib/generators/spina/upgrade_generator.rb
+- lib/spina/upgrade.rb
+- lib/spina/upgrade/decorators/attachment_decorator.rb
+- lib/spina/upgrade/decorators/image_decorator.rb
+- lib/spina/upgrade/engine.rb
+- lib/spina/upgrade/version.rb
+- lib/tasks/spina/upgrade_tasks.rake
+homepage: https://www.spinacms.com
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Upgrade Spina to 2.0
+test_files: []