datafix 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2e3e8da571a3bd7df4b2a46867f39f48afa96ea
+  data.tar.gz: 20869acf6db09da707ac2909a012eeb83c0a5d16
+SHA512:
+  metadata.gz: 963e3bbbb5f71310d6103242ac5f73ea4b60bc5e4d05d2eb6230290ed994bb1602de8002fd73a09c08c8ad64bd8c64372e317cc1136a71f7f3cd1e8f2db2d7b1
+  data.tar.gz: 2432646f4fa4b89a1dff3729e21f7624ccf58a2299a4e2f1083378d688bd6c2668189b70b51b63e84f9a57031a788c5a36e6a40b079f235e9eeff40fa5399d85

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.vimlog
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Case Commons, LLC
+
+MIT License
+
+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,54 @@
+# Datafix
+
+Datafix provides a template generator for documenting and testing database hotfixes
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'datafix', :github => 'Casecommons/datafix'
+
+And then execute:
+
+    $ bundle
+    $ rails g datafix:install
+    $ rake db:migrate
+
+## Usage
+
+Generate a timestamped datafix script with some boilerplate for execution.
+
+    rails g datafix MyGroovyName
+
+This will create:
+
+    db/datafixes/YYYYMMDDhhmmss_my_groovy_name.rb
+
+and
+
+    spec/db/datafixes/YYYYMMDDhhmmss_my_groovy_name_spec.rb
+
+To run it, execute:
+
+    rake db:datafix[:up] NAME=my_groovy_name
+
+or
+
+    rake db:datafix[:up] NAME=MyGroovyName
+
+run the down with:
+
+    rake db:datafix:down NAME=my_groovy_name
+
+To run the spec, execute:
+
+    rspec spec/db/datafixes/YYYYMMDDhhmmss_my_groovy_name_spec.rb
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/datafix.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/datafix/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Case Commons, LLC"]
+  gem.email         = ['casecommons-dev@googlegroups.com', 'andrew@johnandrewmarshall.com']
+  gem.description   = %q{Datafix provides a generator for documenting and testing database hotfixes}
+  gem.summary       = %q{Datafix provides a generator for documenting and testing database hotfixes}
+  gem.homepage      = "https://github.com/Casecommons/datafix"
+
+  gem.add_dependency "activerecord"
+  gem.add_dependency "railties"
+  gem.add_dependency "pg"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "database_cleaner"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "pry"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "datafix"
+  gem.require_paths = ["lib"]
+  gem.version       = Datafix::VERSION
+end

data/lib/datafix.rb

@@ -0,0 +1,56 @@
+require "datafixes"
+require "datafix/version"
+require "datafix/railtie" if defined?(Rails)
+
+class Datafix
+  class << self
+    DIRECTIONS = %w[up down]
+
+    def migrate(direction)
+      raise ArgumentError unless DIRECTIONS.include?(direction)
+
+      ActiveRecord::Base.transaction do
+        send(direction.to_sym)
+        log_run(direction)
+      end
+    end
+
+    private
+
+    def log_run(direction)
+      name = self.name.camelize.split('::').tap(&:shift).join('::')
+      puts "migrating #{name} #{direction}"
+
+      execute(<<-SQL)
+      INSERT INTO datafix_log
+      (direction, script, timestamp)
+      VALUES ('#{direction}', '#{name.camelize}', NOW())
+      SQL
+    end
+
+    def connection
+      @connection ||= ActiveRecord::Base.connection
+    end
+
+    def execute(*args)
+      connection.execute(*args)
+    end
+
+    def table_exists?(table_name)
+      ActiveRecord::Base.connection.table_exists? table_name
+    end
+
+    def archive_table(table_name)
+      log "Archive #{table_name} for Rollback" if self.respond_to?(:log)
+      execute "CREATE TABLE archived_#{table_name} ( LIKE #{table_name} INCLUDING DEFAULTS INCLUDING CONSTRAINTS INCLUDING INDEXES )"
+      execute "INSERT INTO archived_#{table_name} SELECT * FROM #{table_name}"
+    end
+
+    def revert_archive_table(table_name)
+      log "Move old #{table_name} back" if self.respond_to?(:log)
+      execute "TRUNCATE TABLE #{table_name}"
+      execute "INSERT INTO #{table_name} SELECT * FROM archived_#{table_name}"
+      execute "DROP TABLE archived_#{table_name}"
+    end
+  end
+end

data/lib/datafix/railtie.rb

@@ -0,0 +1,7 @@
+class Datafix
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/db/datafix.rake"
+    end
+  end
+end

data/lib/datafix/version.rb

@@ -0,0 +1,3 @@
+class Datafix
+  VERSION = '0.0.2'.freeze
+end

data/lib/datafixes.rb

@@ -0,0 +1,2 @@
+module Datafixes
+end

data/lib/generators/datafix/USAGE.md

@@ -0,0 +1,22 @@
+## Description
+    This generator will create a timestamped script with some boilerplate for execution.
+
+## Example
+
+    rails generate datafix MyGroovyName
+
+This will create:
+
+    db/datafixes/YYYYMMDDhhmmss_my_groovy_name.rb
+
+To run it, execute:
+
+    rake db:datafix NAME=my_groovy_name
+
+or
+
+    rake db:datafix NAME=MyGroovyName
+
+run the down with:
+
+    rake db:datafix:down NAME=my_groovy_name

data/lib/generators/datafix/datafix_generator.rb

@@ -0,0 +1,20 @@
+class DatafixGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  PATH = 'db/datafixes'
+
+  def generate
+    raise "Datafix with name '#{file_name}' already exists" if Dir.glob("#{PATH}/*_#{file_name}.rb").any?
+
+    template "datafix_template.rb.erb", "#{PATH}/#{timestamp}_#{file_name}.rb"
+
+    if Rails.application.config.generators.rails[:test_framework] == :rspec
+      template "datafix_spec_template.rb.erb", "spec/#{PATH}/#{timestamp}_#{file_name}_spec.rb"
+    else
+      puts "Datafix test was not generated. Datafix requires rspec."
+    end
+  end
+
+  def timestamp
+    @timestamp ||= Time.now.strftime("%Y%m%d%H%M%S")
+  end
+end

data/lib/generators/datafix/install/USAGE.md

@@ -0,0 +1,14 @@
+## Description
+    This generates a migration to create the datafix\_log table necessary for the datafix tasks and specs
+
+## Example
+
+    rails generate datafix:install
+
+This will create:
+
+    db/migrate/YYYYMMDDhhmmss_create_datafix_log.rb
+
+To run it, execute:
+
+    rake db:migrate

data/lib/generators/datafix/install/install_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/active_record'
+
+class Datafix
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      extend ActiveRecord::Generators::Migration
+
+      # Implement the required interface for Rails::Generators::Migration.
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def generate
+        migration_dir = "db/migrate"
+        migration_name = "create_datafix_log"
+        if ActiveRecord::Generators::Base.migration_exists?(migration_dir, migration_name)
+          raise "Another migration is already named #{migration_name}: #{migration_dir}"
+        else
+          migration_number = ActiveRecord::Generators::Base.next_migration_number(migration_dir)
+          copy_file "migration.rb", "#{migration_dir}/#{migration_number}_#{migration_name}.rb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/datafix/install/templates/migration.rb

@@ -0,0 +1,14 @@
+class CreateDatafixLog < ActiveRecord::Migration
+  def self.up
+    create_table :datafix_log do |t|
+      t.string :direction
+      t.string :script
+      t.timestamp :timestamp
+    end
+  end
+
+  def self.down
+    drop_table :datafix_log
+  end
+end
+

data/lib/generators/datafix/templates/datafix_spec_template.rb.erb

@@ -0,0 +1,12 @@
+require "spec_helper"
+require Rails.root.join("db", "datafixes", "<%= "#{timestamp}_#{file_name}" %>")
+
+describe Datafixes::<%= file_name.camelize %> do
+  describe ".up" do
+    pending "Needs tests"
+  end
+
+  describe ".down" do
+    pending "Needs tests"
+  end
+end

data/lib/generators/datafix/templates/datafix_template.rb.erb

@@ -0,0 +1,7 @@
+class Datafixes::<%= file_name.camelize %> < Datafix
+  def self.up
+  end
+
+  def self.down
+  end
+end

data/lib/tasks/db/datafix.rake

@@ -0,0 +1,41 @@
+namespace :db do
+  namespace :datafix do
+
+    desc "Run the 'up' on the passed datafix"
+    task :up => :environment do
+      name = ENV['NAME']
+      raise 'NAME required' if name.blank?
+
+      require path_from_name(name)
+      klass_from_name(name).migrate('up')
+    end
+
+    desc "Run the 'down' operation on the passed datafix"
+    task :down => :environment do
+      name = ENV['NAME']
+      raise 'NAME required' if name.blank?
+
+      require path_from_name(name)
+      klass_from_name(name).migrate('down')
+    end
+
+    private
+
+    def klass_from_name(name)
+      name = name.split(File::SEPARATOR).last.gsub(/^\d+_/, '').gsub(/.rb$/, '').camelize
+      "Datafixes::#{name}".constantize
+    end
+
+    def path_from_name(name)
+      unless name =~ %r(^db/datafixes/)
+        name = name.underscore
+        name = Dir.glob("db/datafixes/*_#{name}.rb").first
+      end
+      Rails.root.join(name)
+    end
+
+  end
+
+  desc "Run the 'up' on the passed datafix"
+  task :datafix => 'datafix:up'
+end

data/spec/lib/datafix_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+class Datafixes::FixKittens < Datafix
+  def self.up
+    table_name = Kitten.table_name
+    archive_table(table_name)
+    execute %Q{ UPDATE #{table_name} SET fixed = 't'; }
+  end
+
+  def self.down
+    table_name = Kitten.table_name
+    revert_archive_table(table_name)
+  end
+end
+
+describe Datafix do
+
+  let(:kitten_names) { %w[nyan hobbes stimpy tigger garfield] }
+  let(:table_name) { Kitten.table_name }
+  let(:archived_table_name) { "archived_#{table_name}" }
+
+  before do
+    kitten_names.each do |name|
+      Kitten.create!(name: name)
+    end
+    Kitten.where(fixed: true).should be_empty
+  end
+
+  context "after running fix kittens up" do
+    before do
+      Datafixes::FixKittens.migrate('up')
+    end
+
+    it "fixes all kittens should" do
+      Kitten.where(fixed: false).should be_empty
+    end
+
+    it "creates a kittens archive table" do
+      Kitten.connection.table_exists?(archived_table_name).should be_true
+      Kitten.connection.select_value("SELECT COUNT(*) FROM #{archived_table_name}").to_i.should == kitten_names.size
+    end
+
+    it "updates the datafix log" do
+      datafix_log = DatafixLog.last
+      datafix_log.direction.should == 'up'
+      datafix_log.script.should == 'FixKittens'
+    end
+
+    context "after running fix kittens down" do
+      before do
+        Datafixes::FixKittens.migrate('down')
+      end
+
+      it "unfixes the kittens" do
+        Kitten.where(fixed: true).should be_empty
+      end
+
+      it "removes the kittens archive table" do
+        Kitten.connection.table_exists?("archived_kittens").should be_false
+      end
+
+      it "updates the datafix log" do
+        datafix_log = DatafixLog.last
+        datafix_log.direction.should == 'down'
+        datafix_log.script.should == 'FixKittens'
+      end
+    end
+  end
+end

data/spec/lib/tasks/datafix_rspec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+require "rake"
+require "rails/generators"
+require "generators/datafix/datafix_generator"
+
+describe "datafix rake tasks" do
+  let(:fix_name) { "fix_kittens" }
+
+  before(:all) do
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    Rake.application.rake_require "tasks/db/datafix"
+    Rake::Task.define_task(:environment)
+
+    @old_path = Dir.pwd
+    Dir.chdir(Rails.root)
+    Rails::Generators.invoke("datafix", [fix_name])
+  end
+
+  after(:all) do
+    Dir.chdir(@old_path)
+    @old_path = nil
+  end
+
+  describe "up" do
+    it "runs the migration" do
+      require Dir.glob(Rails.root.join("db/datafixes/*_#{fix_name}.rb")).first
+      Datafixes::FixKittens.should_receive(:up)
+      ENV['NAME'] = fix_name
+      @rake["db:datafix:up"].invoke
+    end
+  end
+
+  describe "down" do
+    it "runs the migration" do
+      require Dir.glob(Rails.root.join("db/datafixes/*_#{fix_name}.rb")).first
+      Datafixes::FixKittens.should_receive(:down)
+      ENV['NAME'] = fix_name
+      @rake["db:datafix:down"].invoke
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,75 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'active_record'
+require 'database_cleaner'
+require 'pry'
+
+require 'pg'
+require 'datafix'
+
+PG_SPEC = {
+  :adapter  => 'postgresql',
+  :host     => 'localhost',
+  :database => 'datafix_test',
+  :username => ENV['USER'],
+  :encoding => 'utf8'
+}
+
+ActiveRecord::Base.establish_connection(PG_SPEC.merge('database' => 'postgres', 'schema_search_path' => 'public'))
+# drops and create need to be performed with a connection to the 'postgres' (system) database
+# drop the old database (if it exists)
+ActiveRecord::Base.connection.drop_database PG_SPEC[:database] rescue nil
+# create new
+ActiveRecord::Base.connection.create_database(PG_SPEC[:database])
+ActiveRecord::Base.establish_connection(PG_SPEC)
+
+ActiveRecord::Migration.create_table :datafix_log do |t|
+  t.string :direction
+  t.string :script
+  t.timestamp :timestamp
+end
+
+class DatafixLog < ActiveRecord::Base
+  self.table_name = "datafix_log"
+end
+
+ActiveRecord::Migration.create_table :kittens do |t|
+  t.string :name
+  t.boolean :fixed, default: false
+  t.timestamps
+end
+
+class Kitten < ActiveRecord::Base; end
+
+require "action_controller/railtie"
+class TestRailsApp < Rails::Application
+  config.secret_token = "random_secret_token"
+end
+
+Rails.application.config.root = File.expand_path("../tmp_rails_app",__FILE__)
+
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+
+  config.before(:suite) do
+    FileUtils.rm_rf(Rails.root)
+    Dir.mkdir(Rails.root)
+    TestRailsApp.initialize!
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+  config.after(:suite) do
+    FileUtils.rm_rf(Rails.root)
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: datafix
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Case Commons, LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: railties
+  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: pg
+  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: rspec
+  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: database_cleaner
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Datafix provides a generator for documenting and testing database hotfixes
+email:
+- casecommons-dev@googlegroups.com
+- andrew@johnandrewmarshall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- datafix.gemspec
+- lib/datafix.rb
+- lib/datafix/railtie.rb
+- lib/datafix/version.rb
+- lib/datafixes.rb
+- lib/generators/datafix/USAGE.md
+- lib/generators/datafix/datafix_generator.rb
+- lib/generators/datafix/install/USAGE.md
+- lib/generators/datafix/install/install_generator.rb
+- lib/generators/datafix/install/templates/migration.rb
+- lib/generators/datafix/templates/datafix_spec_template.rb.erb
+- lib/generators/datafix/templates/datafix_template.rb.erb
+- lib/tasks/db/datafix.rake
+- spec/lib/datafix_spec.rb
+- spec/lib/tasks/datafix_rspec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Casecommons/datafix
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Datafix provides a generator for documenting and testing database hotfixes
+test_files:
+- spec/lib/datafix_spec.rb
+- spec/lib/tasks/datafix_rspec.rb
+- spec/spec_helper.rb
+has_rdoc: