nomadize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee738d9952a99b01a995138cb42d3f02a33a552e
+  data.tar.gz: a2d88cf37009b8826e651f4e7823e94305c45661
+SHA512:
+  metadata.gz: 10b5374b4a415af7adb87ad3268ef6fa103a86c17b989311e957085df2b843d722ee92314b3b89cbf515118f9c2d4eb879fe0085acf234812eb1fe5c0f639298
+  data.tar.gz: 1c9f547803f18082f8ee1d8a94f153b4c9f07886551524bc50d3c467951a9a4250cd010beb256853f783e3d119a7ce98477bc9984864da67119a1c03b74c0e54

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+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,70 @@
+# Nomadize
+
+Some simple tools for managing migrations with postgres (without requiring an entire ORM).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nomadize'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nomadize
+
+
+## Usage
+
+Nomadize expects a database configuration file in `config/database.yml`. This file should look something like:
+
+```
+migrations_path: db/migrations
+development:
+  :dbname: lol_dev
+test:
+  :dbname: lol_test
+production:
+  :dbname: lol_production
+```
+
+`migrations_path` defines where Nomadize should find and create your migration files.
+
+The test/development/production keys set environment dependent options (through `RACK_ENV`) for the postgres connection object. These key/value pairs are handed directly to the `PG.connect` method, documentation for what options can be passed can be found [here](http://deveiate.org/code/pg/PG/Connection.html#method-c-new).
+
+After a config file is in place  add `require 'nomadize/tasks'` to your rake file, and enjoy helpful new rake tasks such as:
+
+* `rake db:create` - creates a database and a schema_migrations table
+* `rake db:drop`   - dumps your poor poor database
+* `rake db:new_migration[migration_name]` - creates a timestamped migration file in db/migrations/ just fill in the details.
+* `rake db:migrate` - runs migrations found in db/migrations that have not been run yet
+* `rake db:status` - see which migrations have or have not been run
+* `rake db:rollback[count]` - rollback migrations (default count: 1)
+
+
+## Development
+
+todo:
+
+- [x] an actual config setup / object
+- [x] sql cleaning (getting rid of the interpolation)
+- [x] to display migration status
+- [x] migration rollbacks
+- [ ] transactions / error handling
+- [ ] maybe some kind of logging idk
+- [x] possibly wrap pg
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/piisalie/nomadize. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+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/lib/nomadize/config.rb

@@ -0,0 +1,33 @@
+require 'yaml'
+require 'pg'
+require 'nomadize/pg_wrapper'
+
+module Nomadize
+  class Config
+
+    def self.env
+      ENV.fetch('RACK_ENV', 'development')
+    end
+
+    def self.db_connection_info
+      config_file.fetch(env)
+    end
+
+    def self.database_name
+      db_connection_info.fetch(:dbname)
+    end
+
+    def self.migrations_path
+      config_file.fetch("migrations_path")
+    end
+
+    def self.config_file(path = 'config/database.yml')
+      @file ||= File.open(path) { |f| YAML.load(f) }
+    end
+
+    def self.db
+      PGWrapper.new(PG.connect(db_connection_info))
+    end
+
+  end
+end

data/lib/nomadize/file_generator.rb

@@ -0,0 +1,31 @@
+require 'fileutils'
+require 'yaml'
+
+module Nomadize
+  class FileGenerator
+    attr_reader :path, :name, :timestamp
+    private     :path, :name, :timestamp
+
+    def initialize(path:, name:, timestamp: DateTime.now.new_offset(0).strftime("%Y%m%d%H%M%S"))
+      @path      = path
+      @name      = name
+      @timestamp = timestamp
+    end
+
+    def save
+      FileUtils.mkdir_p path unless File.exists?(path)
+      File.open(File.join(path, timestamped_name), "w") { |f| f.write(template_content) }
+    end
+
+    private
+
+    def timestamped_name
+      "#{timestamp}_#{name}.yml"
+    end
+
+    def template_content
+      YAML.dump( {up: "", down: "" })
+    end
+
+  end
+end

data/lib/nomadize/migration.rb

@@ -0,0 +1,23 @@
+module Nomadize
+  class Migration
+    attr_reader :up, :down, :filename
+    private     :up, :down
+
+    def initialize(up:, down:, filename:)
+      @up       = up
+      @down     = down
+      @filename = filename
+    end
+
+    def run(db)
+      db.exec(up)
+      db.insert_migration_filename(filename)
+    end
+
+    def rollback(db)
+      db.exec(down)
+      db.remove_migration_filename(filename)
+    end
+
+  end
+end

data/lib/nomadize/migration_loader.rb

@@ -0,0 +1,26 @@
+require 'yaml'
+
+module Nomadize
+  class MigrationLoader
+    attr_reader :path
+    private     :path
+
+    def initialize(path:)
+      @path = path
+    end
+
+    def migrations
+      filenames.map do |filename|
+        File.open(filename, "r") { |f|
+          YAML.load(f).merge(filename: File.basename(filename, ".yml"))
+        }
+      end
+    end
+
+    private
+
+    def filenames
+      Dir[File.join(path, '*.yml')]
+    end
+  end
+end

data/lib/nomadize/migrator.rb

@@ -0,0 +1,42 @@
+module Nomadize
+  class Migrator
+    attr_reader :migrations, :db
+    private     :migrations, :db
+
+    def initialize(db:, migrations:)
+      @migrations = migrations
+      @db         = db
+    end
+
+    def run
+      pending.map { |migration| migration.run(db) }
+    end
+
+    def rollback(count)
+      done[-count..-1].reverse.map { |migration| migration.rollback(db) }
+    end
+
+    def pending
+      sorted_by_timestamp.select do |migration|
+        !recorded_migrations.include?(migration.filename)
+      end
+    end
+
+    private
+
+    def done
+      sorted_by_timestamp.select do |migration|
+        recorded_migrations.include?(migration.filename)
+      end
+    end
+
+    def sorted_by_timestamp
+      migrations.sort_by { |migration| migration.filename }
+    end
+
+    def recorded_migrations
+      db.retrieve_all_migration_filenames
+    end
+
+  end
+end

data/lib/nomadize/pg_wrapper.rb

@@ -0,0 +1,31 @@
+require 'forwardable'
+
+module Nomadize
+  class PGWrapper
+    extend Forwardable
+    attr_reader :pg
+
+    def initialize(pg)
+      @pg = pg
+    end
+
+    def_delegators :pg, :exec
+
+    def create_schema_migrations_table
+      exec("CREATE TABLE schema_migrations (filename TEXT NOT NULL);")
+    end
+
+    def retrieve_all_migration_filenames
+      exec("SELECT filename FROM schema_migrations;").to_a.flat_map(&:values)
+    end
+
+    def insert_migration_filename(filename)
+      exec("INSERT INTO schema_migrations (filename) VALUES ($1);", [ filename ])
+    end
+
+    def remove_migration_filename(filename)
+      exec("DELETE FROM schema_migrations WHERE filename = $1;", [ filename ])
+    end
+
+  end
+end

data/lib/nomadize/status_display.rb

@@ -0,0 +1,63 @@
+module Nomadize
+  class StatusDisplay
+
+    attr_reader :files, :records
+    private     :files, :records
+
+    def initialize(files:, records:)
+      @files   = files
+      @records = records
+    end
+
+    def titlebar
+      "filename".ljust(lsize) + " | " + "status".rjust(rsize)
+    end
+
+    def divider
+      "-" * titlebar.size
+    end
+
+    def migrations
+      sorted_migrations.map do |migration|
+        migration[:filename].ljust(lsize) + " | " + migration[:status].to_s.rjust(rsize)
+      end.to_enum
+    end
+
+    private
+
+    def files_with_status
+      files.map { |file|
+        file.merge(status: calculate_status(file))
+      }
+    end
+
+    def calculate_status(file)
+      if records.include?(file[:filename])
+        'up'
+      else
+        'down'
+      end
+    end
+
+    def sorted_migrations
+      migrations = files_with_status + migrations_without_files
+      migrations.sort_by { |file| file[:filename] }
+    end
+
+    def migrations_without_files
+      filenames = files.map { |file| file[:filename] }
+      records.select { |record| !filenames.include?(record) }.map { |record|
+        { filename: record, status: 'missing' }
+      }
+    end
+
+    def rsize
+      7
+    end
+
+    def lsize
+      @lsize ||= sorted_migrations.map { |file| file[:filename] }.map(&:size).max
+    end
+
+  end
+end

data/lib/nomadize/tasks.rb

@@ -0,0 +1,36 @@
+require 'nomadize'
+
+namespace :db do
+
+  desc 'Create database using name in {appdir}/config/database.yml'
+  task :create do
+    Nomadize.create_database
+  end
+
+  desc 'drop database using name in {appdir}/config/database.yml'
+  task :drop do
+    Nomadize.drop_database
+  end
+
+  desc 'Generate a migration template file in {appdir}/db/migrations/'
+  task :new_migration, [:migration_name] do |_, args|
+    Nomadize.generate_template_migration_file(args.migration_name)
+  end
+
+  desc 'Run migrations'
+  task :migrate do
+    Nomadize.run_migrations
+  end
+
+  desc 'view the status of known migrations'
+  task :status do
+    Nomadize.status
+  end
+
+  desc 'rollback migrations (default count: 1)'
+  task :rollback, :steps do |_, args|
+    count = args.steps || 1
+    Nomadize.rollback(count)
+  end
+
+end

data/lib/nomadize/version.rb

@@ -0,0 +1,3 @@
+module Nomadize
+  VERSION = "0.1.0"
+end

data/lib/nomadize.rb

@@ -0,0 +1,60 @@
+require 'nomadize/version'
+require 'nomadize/migration_loader'
+require 'nomadize/migration'
+require 'nomadize/migrator'
+require 'nomadize/config'
+require 'nomadize/status_display'
+require 'nomadize/file_generator'
+
+module Nomadize
+
+  def self.run_migrations
+    db              = Config.db
+    migration_files = MigrationLoader.new(path: Config.migrations_path).migrations
+    migrations      = migration_files.map { |migration| Migration.new(migration) }
+    migrator        = Migrator.new(db: db, migrations: migrations)
+
+    migrator.run
+    db
+  end
+
+  def self.create_database
+    system("createdb --echo #{Config.database_name}")
+    db = Config.db
+    db.create_schema_migrations_table
+    db
+  end
+
+  def self.status
+    files   = MigrationLoader.new(path: Config.migrations_path).migrations
+    db      = Config.db
+    records = db.retrieve_all_migration_filenames
+
+    display = StatusDisplay.new(files: files, records: records)
+
+    puts display.titlebar
+    puts display.divider
+    display.migrations.each do |row|
+      puts row
+    end
+  end
+
+  def self.rollback(count = 1)
+    db              = Config.db
+    migration_files = MigrationLoader.new(path: Config.migrations_path).migrations
+    migrations      = migration_files.map { |migration| Migration.new(migration) }
+    migrator        = Migrator.new(db: db, migrations: migrations)
+
+    migrator.rollback(count)
+    db
+  end
+
+  def self.drop_database
+    system("dropdb --echo #{Config.database_name}")
+  end
+
+  def self.generate_template_migration_file(name)
+    Nomadize::FileGenerator.new(path: Config.migrations_path, name: name).save
+  end
+
+end

data/nomadize.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nomadize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nomadize"
+  spec.version       = Nomadize::VERSION
+  spec.authors       = ["Paul Dawson"]
+  spec.email         = ["paul@into.computer"]
+
+  spec.summary       = %q{A simple database migration utility}
+  spec.homepage      = "https://github.com/piisalie/nomadize"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+
+  spec.add_dependency "pg", "~> 0.18.1"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: nomadize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Dawson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+description: 
+email:
+- paul@into.computer
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nomadize.rb
+- lib/nomadize/config.rb
+- lib/nomadize/file_generator.rb
+- lib/nomadize/migration.rb
+- lib/nomadize/migration_loader.rb
+- lib/nomadize/migrator.rb
+- lib/nomadize/pg_wrapper.rb
+- lib/nomadize/status_display.rb
+- lib/nomadize/tasks.rb
+- lib/nomadize/version.rb
+- nomadize.gemspec
+homepage: https://github.com/piisalie/nomadize
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A simple database migration utility
+test_files: []