simple_data_migrations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a4275c5b1c6f081913056bd954e294c64db0affb8b3d673c0e8e54794dd35e5
+  data.tar.gz: 37b99f86b67e80b8c176a1b401a8a7fbeaf6a266b55cc4661544c070006ca65e
+SHA512:
+  metadata.gz: 5731d1a108dcd09d60ca1d9749fe3a449cb08bf6711c5bb3b9662e539135dbf4db8f11e14f5f9705e6d3b0bb81940248699e8818981edf44eac4a55bd9d88b73
+  data.tar.gz: da8566add2d9d89fc44cf52b62913ef318902a8dba6fec2373ac128b193d358dedc1d7e826d28726131ec822ac582ea272b2fa4de926c908f029f0e1e7795461

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-01-06
+
+- Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simple_data_migrations.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Wojciech Wnętrzak
+
+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,38 @@
+# Simple Data Migrations
+
+Inspired by [data-migrate](https://github.com/ilyakatz/data-migrate) but simplified.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "simple_data_migrations"
+```
+
+## Usage
+
+Install by creating db migration file:
+
+`bin/rails generate simple_data_migrations:install` and then run `bin/rails db:migrate`
+
+Generate sample data migration file by `bin/rails generate simple_data_migrations:template`
+
+Status can be displayed by `bin/rails data:migrate:status`
+And executed by `bin/rails data:migrate`
+
+## Development
+
+TODO: add configuration
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/tiramizoo/simple_data_migrations.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "simple_data_migrations"
+
+# 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/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/generators/simple_data_migrations/install_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module SimpleDataMigrations
+  class InstallGenerator < Rails::Generators::Base
+    include ActiveRecord::Generators::Migration
+
+    source_paths << File.expand_path("../templates", __FILE__)
+
+    def create_migration_file
+      migration_template "install.rb.erb", "db/migrate/create_simple_data_migrations_table.rb"
+    end
+
+    private
+
+    def migration_version
+      "[#{ActiveRecord::VERSION::STRING.to_f}]"
+    end
+  end
+end

data/lib/generators/simple_data_migrations/template_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../../simple_data_migrations/utils"
+
+module SimpleDataMigrations
+  class TemplateGenerator < Rails::Generators::NamedBase
+    def create_template_file
+      version = Time.now.utc.strftime("%Y%m%d%H%M%S") # Rails db migration like
+      path = SimpleDataMigrations::Utils.root.join("#{version}_#{file_name}.rb")
+
+      create_file path do
+<<-TEMPLATE
+ApplicationRecord.transaction do
+  # Your code
+
+  SimpleDataMigrations::Entry.create!(version: #{version})
+end
+TEMPLATE
+      end
+    end
+  end
+end

data/lib/generators/simple_data_migrations/templates/install.rb.erb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class CreateSimpleDataMigrationsTable < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :data_migrations, primary_key: "version", id: :string
+  end
+end

data/lib/simple_data_migrations/entry.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "active_record/base"
+
+module SimpleDataMigrations
+  class Entry < ActiveRecord::Base
+    self.table_name = "data_migrations"
+  end
+end

data/lib/simple_data_migrations/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SimpleDataMigrations
+  class Railtie < ::Rails::Railtie
+
+    rake_tasks do
+      load File.expand_path("../tasks/data.rake", __dir__)
+    end
+
+    generators do
+      require File.expand_path("../generators/simple_data_migrations/template_generator", __dir__)
+      require File.expand_path("../generators/simple_data_migrations/install_generator", __dir__)
+    end
+  end
+end

data/lib/simple_data_migrations/utils.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SimpleDataMigrations
+  module Utils
+    def self.script_files
+      Dir.children(root).sort
+    end
+
+    def self.ran_versions
+      Entry.pluck(:version)
+    end
+
+    def self.root
+      Rails.root.join("db/data")
+    end
+
+    def self.version(filename)
+      filename.split("_", 2).first
+    end
+
+    def self.humanize_filename(filename)
+      return "********** NO FILE **********" unless filename
+
+      filename.delete_prefix(version(filename)).delete_suffix(".rb").humanize
+    end
+  end
+end

data/lib/simple_data_migrations/version.rb

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

data/lib/simple_data_migrations.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "benchmark"
+require "thor/shell/basic"
+
+require_relative "simple_data_migrations/version"
+require_relative "simple_data_migrations/entry"
+require_relative "simple_data_migrations/utils"
+require_relative "simple_data_migrations/railtie" if defined?(Rails::Railtie)
+
+module SimpleDataMigrations
+  def self.status
+    ran_versions = Utils.ran_versions
+    files = Utils.script_files
+    all_versions = (ran_versions | files).map { |filename| Utils.version(filename) }
+
+    result = all_versions.sort.map do |version|
+      filename = files.find { |file| file.start_with?(version) }
+
+      [ran_versions.include?(version) ? "up" : "down", version, Utils.humanize_filename(filename)]
+    end
+
+    result.prepend(["Status", "Version", "Name"])
+    Thor::Shell::Basic.new.print_table(result)
+  end
+
+  def self.run
+    ran_versions = Utils.ran_versions
+    non_run_scripts = Utils.script_files.select do |filename|
+      !ran_versions.include?(Utils.version(filename))
+    end
+
+    if ENV["VERSION"]
+      non_run_scripts.select! { |filename| Utils.version(filename) == ENV["VERSION"] }
+    end
+
+    non_run_scripts.each do |filename|
+      Thor::Shell::Basic.new.say("Running data migration: #{filename}")
+      time = Benchmark.measure do
+        load Utils.root.join(filename)
+      end
+      measure = "%.4fs" % time.real
+      Thor::Shell::Basic.new.say("Finished in #{measure}")
+    end
+  end
+
+  def self.bootstrap
+    attributes = Utils.script_files.map { |filename| {version: Utils.version(filename)} }
+    Entry.insert_all!(attributes)
+  end
+end

data/lib/tasks/data.rake

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+namespace :data do
+  desc "Run data migration scripts. Provide VERSION env to run specific one"
+  task migrate: :environment do
+    require "simple_data_migrations"
+
+    SimpleDataMigrations.run
+  end
+
+  namespace :migrate do
+    desc "Display status of data migration scripts"
+    task status: :environment do
+      require "simple_data_migrations"
+
+      SimpleDataMigrations.status
+    end
+  end
+end

data/simple_data_migrations.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/simple_data_migrations/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "simple_data_migrations"
+  spec.version = SimpleDataMigrations::VERSION
+  spec.authors = ["Wojciech Wnętrzak"]
+  spec.email = ["w.wnetrzak@gmail.com"]
+
+  spec.summary = "Data migrations"
+  spec.description = "Data migrations (mainly for Rails)"
+  spec.homepage = "https://github.com/tiramizoo/simple_data_migrations"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/tiramizoo/simple_data_migrations"
+  spec.metadata["changelog_uri"] = "https://github.com/tiramizoo/simple_data_migrations/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 do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 6.0"
+  spec.add_dependency "thor", ">= 1.0"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: simple_data_migrations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wojciech Wnętrzak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Data migrations (mainly for Rails)
+email:
+- w.wnetrzak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/simple_data_migrations/install_generator.rb
+- lib/generators/simple_data_migrations/template_generator.rb
+- lib/generators/simple_data_migrations/templates/install.rb.erb
+- lib/simple_data_migrations.rb
+- lib/simple_data_migrations/entry.rb
+- lib/simple_data_migrations/railtie.rb
+- lib/simple_data_migrations/utils.rb
+- lib/simple_data_migrations/version.rb
+- lib/tasks/data.rake
+- simple_data_migrations.gemspec
+homepage: https://github.com/tiramizoo/simple_data_migrations
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tiramizoo/simple_data_migrations
+  source_code_uri: https://github.com/tiramizoo/simple_data_migrations
+  changelog_uri: https://github.com/tiramizoo/simple_data_migrations/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.4
+signing_key: 
+specification_version: 4
+summary: Data migrations
+test_files: []