rails-data-migrations 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d872d014e8e922e77c643a401cb07a55c07a628
+  data.tar.gz: b53d95b58987918de1e0ea4c1e170ab77f144b31
+SHA512:
+  metadata.gz: 79f12c676d358a522870252b83f169681d060b01cc91acb397540a8c53e098ee5c4a36eb4ced215c690da16e5f4e1da08c1c26e85879bddaab83944c7bcce07a
+  data.tar.gz: 6a2c2a431f8e0def8f8f4e0408acf5d14f89ddf2f7710c4a5b73c14a8a0ca01779f802d9a72bfe24cab2c28b93a00c5f13a9f91b2ed712e1e4694bb26b99f2e0

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+spec/db/
+gemfiles/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Appraisals

@@ -0,0 +1,15 @@
+appraise 'rails-4.0' do
+  gem 'rails', '~> 4.0'
+end
+
+appraise 'rails-4.1' do
+  gem 'rails', '~> 4.1'
+end
+
+appraise 'rails-4.2' do
+  gem 'rails', '~> 4.2'
+end
+
+appraise 'rails-5.0' do
+  gem 'rails', '~> 5.0'
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-data-migrations.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Offgrid Electric
+
+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,69 @@
+# Rails Data Migrations
+
+## Why?
+
+Have you ever run into a problem when alongside with DB schema migrations (managed by `rake db:migrate` in Rails)
+you have to often change your DB content, as well? If you read this, you probably tried to use schema migrations do change your data after schema changes, but this is not a recommended way and sometimes data changes could take a long time, so they will block your app at the deploy time.
+Another approach is to use [rake tasks](https://robots.thoughtbot.com/data-migrations-in-rails) to run your changes after `db:migrate` or even independently. But this could also become a mess after some time if you have multiple developers in your project, and you need to change your data often.
+
+This is our solution we came up with in our company - run data migration tasks in a `db:migrate`-like manner
+ 
+## Usage
+ 
+To create a data migration you need to run:
+```
+rails generate data_migration migration_name
+```
+
+and this will create a `migration_name.rb` file in `db/data_migrations` folder with a following content:
+```ruby
+class MigrationName < DataMigration
+  def up
+    # put your code here
+  end
+end
+```
+ 
+so all we need to do is to put some ruby code inside the `up` method.
+ 
+Finally, at the release time, you need to run 
+```
+rake data:migrate
+```
+ 
+This will run all pending data migrations and store migration history in `data_migrations` table. You're all set.
+
+## Rails Support
+
+Rails 4.0 and higher
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-data-migrations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-data-migrations
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Run tests (`appraisal install && appraisal rake`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/active_record/data_migration.rb

@@ -0,0 +1,11 @@
+require 'rails/version'
+
+module ActiveRecord
+  class DataMigration < (Rails::VERSION::MAJOR >= 5 ? Migration[5.0] : Migration)
+    # base class (extend with any useful helpers)
+
+    def down
+      raise IrreversibleMigration
+    end
+  end
+end

data/lib/generators/data_migration_generator.rb

@@ -0,0 +1,12 @@
+require 'rails/generators'
+
+class DataMigrationGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_migration_file
+    migration_file_name = "#{RailsDataMigrations::Migrator.migrations_path}/#{Time.now.utc.strftime('%Y%m%d%H%M%S')}_#{file_name}.rb"
+    copy_file 'data_migration_generator.rb', migration_file_name do |content|
+      content.sub(/ClassName/, file_name.camelize)
+    end
+  end
+end

data/lib/generators/templates/data_migration_generator.rb

@@ -0,0 +1,5 @@
+class ClassName < ActiveRecord::DataMigration
+  def up
+    # put your code here
+  end
+end

data/lib/rails-data-migrations.rb

@@ -0,0 +1,6 @@
+require 'active_record'
+require 'active_record/data_migration'
+require 'rails_data_migrations/version'
+require 'rails_data_migrations/log_entry'
+require 'rails_data_migrations/migrator'
+require 'rails_data_migrations/railtie'

data/lib/rails_data_migrations/log_entry.rb

@@ -0,0 +1,13 @@
+module RailsDataMigrations
+  class LogEntry < ::ActiveRecord::SchemaMigration
+    class << self
+      def table_name
+        ActiveRecord::Base.table_name_prefix + 'data_migrations' + ActiveRecord::Base.table_name_suffix
+      end
+
+      def index_name
+        "#{table_name_prefix}unique_data_migrations#{table_name_suffix}"
+      end
+    end
+  end
+end

data/lib/rails_data_migrations/migrator.rb

@@ -0,0 +1,32 @@
+module RailsDataMigrations
+  class Migrator < ::ActiveRecord::Migrator
+
+    def record_version_state_after_migrating(version)
+      if down?
+        migrated.delete(version)
+        LogEntry.where(version: version.to_s).delete_all
+      else
+        migrated << version
+        LogEntry.create!(version: version.to_s)
+      end
+    end
+
+    class << self
+      def get_all_versions(connection = ActiveRecord::Base.connection)
+        if connection.data_source_exists?(schema_migrations_table_name)
+          LogEntry.all.map { |x| x.version.to_i }.sort
+        else
+          []
+        end
+      end
+
+      def schema_migrations_table_name
+        LogEntry.table_name
+      end
+
+      def migrations_path
+        'db/data_migrations'
+      end
+    end
+  end
+end

data/lib/rails_data_migrations/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module RailsDataMigrations
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), '..', 'tasks/data_migrations.rake')
+    end
+  end
+end

data/lib/rails_data_migrations/version.rb

@@ -0,0 +1,3 @@
+module RailsDataMigrations
+  VERSION = '1.0.0'
+end

data/lib/tasks/data_migrations.rake

@@ -0,0 +1,51 @@
+require 'rake'
+
+namespace :data do
+  def migrations_path
+    RailsDataMigrations::Migrator.migrations_path
+  end
+
+  def apply_single_migration(direction, version)
+    raise 'VERSION is required' unless version
+    RailsDataMigrations::Migrator.run(direction, migrations_path, version.to_i)
+  end
+
+  task init_migration: :environment do
+    RailsDataMigrations::LogEntry.create_table
+  end
+
+  desc 'Apply pending data migrations'
+  task migrate: :init_migration do
+    filter = RailsDataMigrations::Migrator.current_version
+    versions = RailsDataMigrations::Migrator.migrations(migrations_path)
+                 .select { |migration| migration.version > filter }
+                 .map(&:version)
+    versions.sort.each do |version|
+      apply_single_migration(:up, version)
+    end
+  end
+
+  namespace :migrate do
+    desc 'Apply single data migration using VERSION'
+    task up: :init_migration do
+      apply_single_migration(:up, ENV['VERSION'])
+    end
+
+    desc 'Revert single data migration using VERSION'
+    task down: :init_migration do
+      apply_single_migration(:down, ENV['VERSION'])
+    end
+
+    desc 'Skip single data migration using VERSION'
+    task skip: :init_migration do
+      version = ENV['VERSION'].to_i
+      raise 'VERSION is required' unless version > 0
+      if RailsDataMigrations::LogEntry.where(version: version).any?
+        puts "data migration #{version} was already applied."
+      else
+        RailsDataMigrations::LogEntry.create!(version: version)
+        puts "data migration #{version} was skipped."
+      end
+    end
+  end
+end

data/rails-data-migrations.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_data_migrations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails-data-migrations'
+  spec.version       = RailsDataMigrations::VERSION
+  spec.authors       = ['Sergey Glukhov']
+  spec.email         = ['sergey.glukhov@gmail.com']
+
+  spec.summary       = %q{Run your data migration tasks in a db:migrate-like manner}
+  spec.homepage      = 'https://github.com/OffgridElectric/rails-data-migrations'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rails', '>= 4.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '3.5.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'appraisal', '~> 2.1'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: rails-data-migrations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sergey Glukhov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: 
+email:
+- sergey.glukhov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_record/data_migration.rb
+- lib/generators/data_migration_generator.rb
+- lib/generators/templates/data_migration_generator.rb
+- lib/rails-data-migrations.rb
+- lib/rails_data_migrations/log_entry.rb
+- lib/rails_data_migrations/migrator.rb
+- lib/rails_data_migrations/railtie.rb
+- lib/rails_data_migrations/version.rb
+- lib/tasks/data_migrations.rake
+- rails-data-migrations.gemspec
+homepage: https://github.com/OffgridElectric/rails-data-migrations
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: Run your data migration tasks in a db:migrate-like manner
+test_files: []