nochmal 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b70999f48275f14acd8a9d6fe2e04b5cd0c5d7aec648a667456135b088fc65f2
+  data.tar.gz: be84cc7695bc93daa47292eb0fafb57bffa774cef0b45228a3d33d1052754522
+SHA512:
+  metadata.gz: 9255a50d4a7b0fc7d9cd378eb2515bf5af52e84b7427c946cc1043cf70f61865b54d96d8e462784f32963b99c96992c903a98e9f1eae4a778c07cae9bed1a679
+  data.tar.gz: 17977431f4aaa86a73e228be840cee3ffa4fa44e316acc13eb0745c0cfbbde83d1bc78a17527f940aea1783e34539af6206233d8a5664348f97ce0a3262e347b

data/.envrc

@@ -0,0 +1 @@
+PATH_add bin

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,27 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor
+
+# rspec failure tracking
+.rspec_status
+
+*.gem
+coverage/*
+Gemfile.lock
+*~
+.bundle
+.rvmrc
+log/*
+measurement/*
+pkg/*
+.DS_Store
+.env
+spec/dummy/tmp/*
+spec/dummy/log/*.log
+.vscode/

data/.rspec

@@ -0,0 +1,5 @@
+--format documentation
+--color
+--require spec_helper
+--order rand
+--exclude-pattern spec/dummy/**/*.rb

data/.rubocop.yml

@@ -0,0 +1,35 @@
+---
+require: rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+  Exclude:
+    - spec/dummy/**/*
+    - vendor/**/*
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Metrics/AbcSize:
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+    - nochmal.gemspec
+    - lib/tasks/nochmal.rake
+
+Style/HashSyntax:
+  Exclude:
+    - lib/tasks/nochmal.rake
+
+Layout/LineLength:
+  Max: 120
+...

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.5.5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-09-16
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at new.mysteryman@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nochmal.gemspec
+gemspec
+
+gem "rubocop-performance", require: false
+gem "rubocop-rspec", require: false
+
+group :test do
+  gem "tzinfo-data", platforms: %i[mingw mswin x64_mingw jruby]
+end
+
+group :development, :test do
+  gem "pry", "~> 0.14.1"
+  gem "pry-byebug", "~> 3.8"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Thomas Burkhalter
+
+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,99 @@
+# Nochmal
+
+This gem adds a rake task to your application that finds all your models that have attachments and reuploads the attachments to the newly configured (or specified) storage service.
+
+You can use this to switch to a different storage service. The keys of the uploaded files stay the same, so your app can remain ignorant.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nochmal'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nochmal
+
+## Usage
+
+### Reuploading from one service to another
+
+1. Update your `config/storage.yml` with the new service:
+   ```yaml
+    local:
+      service: Disk
+      root: <%= Rails.root.join("storage") %>
+
+    remote:
+      service: Disk
+      root: <%= Rails.root.join("tmp/remote_storage") %>
+   ```
+1. Update your configured storage `config/environments/production.rb`:
+   ```ruby
+     config.active_storage.service = :remote
+   ```
+1. Run the rake task:
+   ```bash
+     rake nochmal:reupload REUPLOAD_FROM=local REUPLOAD_TO=remote # or rake nochmal:reupload[local,remote]
+   ```
+
+### Migrating from Carrierwave (Disk-Storage) to ActiveStorage
+
+The migration from Carrierwave is mostly series manual steps, nochmal provides some advice for preparation and helps with the copying of data. No automated code-changes are made, you are the master of your ~~fate~~_app_, you are the captain of your ~~soul~~_code_. The journey includes mostly these steps:
+
+1. Analyze your application for exisiting uploaders and needed changes
+   ```bash
+     rake nochmal:carrierwave:analyze
+   ```
+2. Change your application and test it automatically and manually
+   With the provided helper, you can read from active_storage and carrierwave and upload to active_storage
+
+3. Deploy your application with this hybrid setup
+
+4. Reupload all carrierwave-uploads to active_storage
+   ```bash
+     NOCHMAL_MIGRATION=yay rake nochmal:carrierwave:migrate
+   ```
+   Nochmal store some metadata to allow resuming a migration if the process dies or gets interrupted. If you want to keep this data either way, you can pass the environment-variable `NOCHMAL_KEEP_METADATA` with any value:
+   ```bash
+     NOCHMAL_MIGRATION=yay NOCHMAL_KEEP_METADATA=any rake nochmal:carrierwave:migrate
+   ```
+   If you want or need to resume a migration, run the command again and follow the suggestion that works best for you.
+
+5. Remove all remainders of carrierwave, deploy that, remove all carrierwave-uploads
+
+## Project Scope
+
+- [x] Works for `has_one_attached` attachments
+- [x] Works for `has_many_attached` attachments
+- [x] Works for single-file disk-based carrierwave-uploaders
+- [ ] Does not yet work for multi-file carrierwave-uploaders
+- [ ] Does not yet help you with migrating from paperclip
+
+## What about the name?
+
+Imagine a little child that does something dangerous or exhausting, but yells "again!" at the end. "Nochmal" is german for "again" and uploading files is fun, but also (bandwidth) exhausting. And if we switch the storage for uploaded files, we, the devs also yell "nochmal!" at the app. The app does not care, but this gem does.
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/puzzle/nochmal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/puzzle/nochmal/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Nochmal project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/puzzle/nochmal/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "rake"
+
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new do |task|
+  task.requires << "rubocop-performance"
+  task.requires << "rubocop-rspec"
+end
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "nochmal"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).match?(/This file was generated by Bundler/)
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).match?(/This file was generated by Bundler/)
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nochmal/adapters/active_storage.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Nochmal
+  module Adapters
+    # Handles active storage specifics for the Reupload Task
+    class ActiveStorage < Base
+      def validate
+        services_differ = (@to != @from)
+        message = "It does not make sense to migrate from one service to the same one. from and to should differ."
+
+        raise message unless services_differ
+      end
+
+      def to_storage_service(service = @to)
+        storage_service(service)
+      end
+
+      def from_storage_service(service = @from)
+        storage_service(service)
+      end
+
+      def models_with_attachments
+        @models_with_attachments ||= begin
+          Rails.application.eager_load!
+
+          ::ActiveStorage::Attachment
+            .select(:record_type).distinct.pluck(:record_type)
+            .compact.map(&:constantize)
+            .map do |model|
+              ([model] + model.descendants).find { |child_or_self| attachment?(child_or_self) }
+            end
+        end
+      end
+
+      def attachment_types_for(model)
+        @types[model] ||=
+          model
+          .methods
+          .map { |method| method.to_s.match(/^with_attached_(\w+)$/)&.captures&.first }
+          .compact
+      end
+
+      def collection(model, type)
+        ::ActiveStorage::Attachment
+          .where(name: type)
+          .where(record_type: model.base_class.sti_name)
+      end
+
+      def blob(attachment)
+        attachment.blob
+      end
+
+      # actions
+
+      def reupload(attachment, _type)
+        blob = blob(attachment)
+
+        StringIO.open(from_storage_service.download(blob.key)) do |temp|
+          to_storage_service.upload(blob.key, temp)
+        end
+
+        { status: :ok }
+      end
+
+      private
+
+      def storage_service(service = nil)
+        service ||= Rails.configuration.active_storage.service
+
+        @storage_service ||= {}
+        @storage_service[service] ||= ::ActiveStorage::Service.configure(service, configurations)
+      end
+
+      def configurations
+        @configurations ||= begin
+          file = Rails.root.join("config/storage.yml")
+          erb = ERB.new(file.read).result
+          yaml = YAML.safe_load(erb)
+          ::ActiveStorage::Service::Configurator.new(yaml).configurations
+        end
+      end
+
+      def attachment?(model)
+        model.reflect_on_all_associations.any? do |assoc|
+          next if assoc.options[:polymorphic] # the class cannot be checked for polymorphic associactions
+
+          assoc.klass == ::ActiveStorage::Attachment
+        end
+      end
+    end
+  end
+end

data/lib/nochmal/adapters/base.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Nochmal
+  module Adapters
+    # base-class for storage-adapters
+    #
+    # currently, it provides a comon interface and some support for STI
+    class Base
+      def initialize(from: nil, to: nil)
+        @from = from
+        @to = to
+
+        @types = {}
+        @uploaders = {}
+
+        validate
+      end
+
+      def validate
+        true
+      end
+
+      def to_storage_service(service = @from); end
+
+      def from_storage_service(service = @to); end
+
+      def models_with_attachments
+        raise "Return an Array of model-classes in your adapter-subclass"
+      end
+
+      def attachment_types_for(_model)
+        raise "Return an Array of attachment type (e.g. avatar, embeds) this in your adapter-subclass"
+      end
+
+      def collection(_model, _type)
+        raise "Return a Scope or Enumerable of Records with attachments of a type in your adapter-subclass"
+      end
+
+      def empty_collection?(model, type)
+        model.count.zero? || # no records
+          collection(model, type).count.zero? # no uploads of a type
+      end
+
+      def blob(_attachment)
+        raise "Return the data of the attachment in your adapter-subclass"
+      end
+
+      # hooks
+
+      # called before doing any action or even lookup
+      def setup(_reupload_mode); end
+
+      # called after outputing the final notes, before returning from the last method
+      def teardown; end
+
+      # called after all reuploading/listing/counting
+      def general_notes; end
+
+      # called before uploading a type
+      def type_notes(_model, _type); end
+
+      # called after each model (class)
+      def model_completed(_model); end
+
+      # called after handling each type (uploader/attachment-type)
+      def type_completed(_model, _type); end
+
+      # called after reuploading/listing/counting each record/attachment
+      def item_completed(_item, _type); end
+
+      # actions
+
+      def reupload(_attachment, _type)
+        raise <<~ERROR
+          Upload the attachment (of a certain type) NOCHMAL!!! in your adapter subclass
+
+          Please return a Hash with a least a :status-key. If everything is ok, I suggest :ok as value.
+        ERROR
+      end
+
+      def count
+        { status: :ok }
+      end
+
+      def list(attachment)
+        filename = blob(attachment)
+
+        Output.attachment(filename.try(:key) || filename)
+
+        { status: :noop }
+      end
+
+      private
+
+      def maybe_sti_scope(model)
+        if !model.descends_from_active_record? || model.descendants.any?
+          model.where(type: model.sti_name)
+        else
+          model
+        end
+      end
+    end
+  end
+end