nochmal 0.2.0

data/lib/nochmal/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Nochmal
+  # This class handles including our rake task
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/nochmal.rake"
+    end
+  end
+end

data/lib/nochmal/reupload.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Nochmal
+  # Handles Reuploading of all attachments
+  # from: (required) = ActiveStorage service name (e.g. local)
+  # to: (optional) = ActiveStorage service name (e.g. aws) if left empty,
+  #                  the currently configured service will be used.
+  class Reupload
+    attr_reader :active_storage, :from_service, :to_service
+
+    def initialize(from: nil, to: nil, helper: nil)
+      @active_storage = helper || Adapters::ActiveStorage.new(from: from, to: to)
+      @notes = []
+    end
+
+    def all
+      handle_each_model(:reupload)
+    end
+
+    def list
+      handle_each_model(:list)
+    end
+
+    def count
+      handle_each_model(:count)
+    end
+
+    private
+
+    def handle_each_model(action) # rubocop:disable Metrics/MethodLength
+      @mode = action
+      active_storage.setup(@mode)
+
+      Output.reupload(models) do
+        models.each do |model|
+          next if skip_model?(model)
+
+          reupload_model(model)
+        end
+      end
+
+      @notes << active_storage.general_notes
+      Output.notes(@notes.compact)
+      active_storage.teardown
+    end
+
+    def reupload_model(model)
+      Output.model(model) do
+        active_storage.attachment_types_for(model).each do |type|
+          reupload_type(model, type)
+        end
+      end
+
+      active_storage.model_completed(model)
+    end
+
+    def reupload_type(model, type) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+      collection = active_storage.collection(model, type)
+      @notes << active_storage.type_notes(model, type)
+
+      Output.type(type, collection.count, @mode) do
+        collection.find_each do |item|
+          result = perform(item, type)
+
+          @notes << result[:message]
+          Output.print_result_indicator(result[:status])
+          active_storage.item_completed(item, type, result[:status])
+        end
+      end
+
+      active_storage.type_completed(model, type)
+    end
+
+    def perform(attachment, type)
+      case @mode
+      when :reupload then active_storage.reupload(attachment, type)
+      when :list     then active_storage.list(attachment)
+      when :count    then active_storage.count
+      end
+    end
+
+    ## helper-functions
+
+    def skip_model?(model)
+      !model.table_exists? || # no table
+        active_storage.attachment_types_for(model).all? do |type| # no uploads of any kind (type)
+          active_storage.empty_collection?(model, type)
+        end
+    end
+
+    def models
+      active_storage.models_with_attachments
+    end
+  end
+end

data/lib/nochmal/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Nochmal
+  VERSION = "0.2.0"
+end

data/lib/nochmal.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+# This module is the base of the nochmal gem
+module Nochmal
+  module Adapters
+    autoload :Base,                 "nochmal/adapters/base"
+    autoload :ActiveStorage,        "nochmal/adapters/active_storage"
+    autoload :Carrierwave,          "nochmal/adapters/carrierwave"
+    autoload :CarrierwaveAnalyze,   "nochmal/adapters/carrierwave_analyze"
+    autoload :CarrierwaveMigration, "nochmal/adapters/carrierwave_migration"
+    autoload :CarrierwaveResume,    "nochmal/adapters/carrierwave_resume"
+  end
+
+  module MigrationData
+    # ar-models to track data
+    autoload :Meta,   "nochmal/migration_data/meta"
+    autoload :Status, "nochmal/migration_data/status"
+
+    # migration to back ar-models
+    autoload :CreateMigrationTables, "nochmal/migration_data/create_tables"
+    autoload :DropMigrationTables,   "nochmal/migration_data/drop_tables"
+
+    # exceptions
+    autoload :Incomplete,   "nochmal/migration_data/incomplete"
+    autoload :StatusExists, "nochmal/migration_data/status_exists"
+  end
+
+  autoload :Reupload, "nochmal/reupload"
+  autoload :Output, "nochmal/output"
+
+  autoload :VERSION, "nochmal/version"
+end
+
+require_relative "nochmal/railtie" if defined?(Rails)

data/lib/tasks/nochmal.rake

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "../nochmal/reupload"
+
+namespace :nochmal do
+  desc "Reuploads attachments from ENV['REUPLOAD_FROM'] to ENV['REUPLOAD_TO'] or configured active_storage service"
+  task :reupload, %i[from to] => :environment do |_t, args|
+    from = args[:from] || ENV["REUPLOAD_FROM"] || raise("The ENV variable REUPLOAD_FROM is required")
+    to = args[:to] || ENV["REUPLOAD_TO"]
+
+    Nochmal::Reupload.new(from: from, to: to).all
+  end
+
+  desc "List attachments that would be reuploaded from ENV['REUPLOAD_FROM']"
+  task :list, [:from] => :environment do |_t, args|
+    from = args[:from] || ENV["REUPLOAD_FROM"] || raise("The ENV variable REUPLOAD_FROM is required")
+
+    Nochmal::Reupload.new(from: from).list
+  end
+
+  desc "Count attachments that would be reuploaded from ENV['REUPLOAD_FROM']"
+  task :count, [:from] => :environment do |_t, args|
+    from = args[:from] || ENV["REUPLOAD_FROM"] || raise("The ENV variable REUPLOAD_FROM is required")
+
+    Nochmal::Reupload.new(from: from).count
+  end
+
+  namespace :carrierwave do
+    desc "Analyse uploaders and suggest change to migrate from carrierwave to active_storage"
+    task :analyze, %i[to] => :environment do |_t, args|
+      to = args[:to] || ENV["REUPLOAD_TO"]
+
+      Nochmal::Reupload.new(to: to, helper: Nochmal::Adapters::CarrierwaveAnalyze.new).all
+    end
+
+    desc "Migrate uploads from carrierwave to active_storage"
+    task :migrate => :environment do
+      Nochmal::Reupload.new(helper: Nochmal::Adapters::CarrierwaveMigration.new).all
+    end
+
+    desc "Resume migrating uploads from carrierwave to active_storage"
+    task :resume => :environment do
+      Nochmal::Reupload.new(helper: Nochmal::Adapters::CarrierwaveResume.new).all
+    end
+
+    desc "Count uploads to be migrated from carrierwave to active_storage"
+    task :count => :environment do
+      Nochmal::Reupload.new(helper: Nochmal::Adapters::CarrierwaveMigration.new).count
+    end
+  end
+end

data/nochmal.gemspec

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "lib/nochmal/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nochmal"
+  spec.version       = Nochmal::VERSION
+  spec.authors       = ["Thomas Burkhalter"]
+  spec.email         = ["new.mysteryman@gmail.com"]
+
+  spec.summary       = "Handles ActiveStorage attachment reuploading."
+  spec.description   = "Adds a rake task to reupload ActiveStorage attachments to a new storage."
+  spec.homepage      = "https://github.com/puzzle/nochmal"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/puzzle/nochmal/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  spec.add_dependency "pastel" # terminal colors
+  spec.add_dependency "rails", ">= 6.0"
+
+  spec.add_development_dependency "codecov"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "rspec-rake"
+  spec.add_development_dependency "rubocop", "~> 1.7"
+  spec.add_development_dependency "rubocop-discourse", "~> 2.4"
+  spec.add_development_dependency "rubocop-performance", "~> 1.6"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.5.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "sqlite3"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,290 @@
+--- !ruby/object:Gem::Specification
+name: nochmal
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Thomas Burkhalter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pastel
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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: dotenv
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: rspec-rails
+  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: rspec-rake
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-discourse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: 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'
+description: Adds a rake task to reupload ActiveStorage attachments to a new storage.
+email:
+- new.mysteryman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- lib/nochmal.rb
+- lib/nochmal/adapters/active_storage.rb
+- lib/nochmal/adapters/base.rb
+- lib/nochmal/adapters/carrierwave.rb
+- lib/nochmal/adapters/carrierwave_analyze.rb
+- lib/nochmal/adapters/carrierwave_migration.rb
+- lib/nochmal/adapters/carrierwave_resume.rb
+- lib/nochmal/migration_data/create_tables.rb
+- lib/nochmal/migration_data/incomplete.rb
+- lib/nochmal/migration_data/meta.rb
+- lib/nochmal/migration_data/status.rb
+- lib/nochmal/migration_data/status_exists.rb
+- lib/nochmal/output.rb
+- lib/nochmal/railtie.rb
+- lib/nochmal/reupload.rb
+- lib/nochmal/version.rb
+- lib/tasks/nochmal.rake
+- nochmal.gemspec
+homepage: https://github.com/puzzle/nochmal
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/puzzle/nochmal
+  source_code_uri: https://github.com/puzzle/nochmal
+  changelog_uri: https://github.com/puzzle/nochmal/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Handles ActiveStorage attachment reuploading.
+test_files: []