kindly 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7008dc866f7e27d37c5a69ce8dad35bd6669b42e
+  data.tar.gz: 0aefa9e87d7db75410d5999cee14b742d44cf30d
+SHA512:
+  metadata.gz: b97fef9801e31b8337007c1ca996f633b0487bf2590464fc038c6a21269c363a5d15c56b4d6cbf43c63802c92a985597f8f55268637434b2b9c6e3a06e810d57
+  data.tar.gz: 6013ce5a2ffd0180dde7d9b0ece187b268077f406ac8ef2a45c5745b34aaee86c041479171d7d62920d79d2162c722b6eaa1326649fa0149e5d5de08d35cd283

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg/

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Greg Scott
+
+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,3 @@
+# kindly
+
+The successor to [please](https://github.com/ResourceDataInc/please).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/bin/kindly

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w{ .. lib })
+
+require 'kindly'
+require 'mercenary'
+
+Mercenary.program(:kindly) do |p|
+  p.version Kindly::VERSION
+  p.description 'Kindly run migrations of any kind.'
+  p.syntax 'kindly <handler> [options]'
+
+  p.option 'source', '--source DIR', 'Host directory of the kindly directory structure.'
+  p.action do |args, options|
+    if args.empty?
+      puts p
+    elsif options['source']
+      Kindly.run(args.first.to_sym, options['source'])
+    else
+      Kindly.run(args.first.to_sym)
+    end
+  end
+end

data/kindly.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kindly/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name          = 'kindly'
+  spec.version       = Kindly::VERSION
+  spec.authors       = ['Greg Scott']
+  spec.email         = ['i@gregoryjscott.com']
+  spec.summary       = %q{Kindly run migrations of any kind.}
+  spec.homepage      = 'https://github.com/gregoryjscott/kindly'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'mercenary', '~> 0.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'mocha', '~> 1.1'
+
+end

data/lib/kindly.rb

@@ -0,0 +1,38 @@
+require 'kindly/migration'
+require 'kindly/runner'
+require 'kindly/handlers'
+require 'kindly/handlers/do_nothing'
+require 'kindly/version'
+
+module Kindly
+
+  def self.run(handler_name, source = '_migrations')
+    @@source = source
+    puts "Kindly run #{handler_name} in #{source} directory."
+
+    handler = Handlers.find(handler_name)
+    runner = Runner.new(handler)
+    migrations = find_migrations(handler.ext)
+
+    puts "No migrations found for #{handler_name} handler." if migrations.empty?
+    migrations.each { |migration| runner.run(migration) }
+  end
+
+  def self.source
+    @@source
+  end
+
+  private
+
+  def self.find_migrations(ext)
+    filenames = Dir[File.join(source, 'pending', "*.#{ext}")]
+    build_migrations(filenames)
+  end
+
+  def self.build_migrations(filenames)
+    migrations = []
+    filenames.each { |filename| migrations << Migration.new(filename) }
+    migrations
+  end
+
+end

data/lib/kindly/handlers.rb

@@ -0,0 +1,29 @@
+require 'kindly'
+
+module Kindly
+  module Handlers
+
+    def self.register(name, handler)
+      @@handlers ||= {}
+      @@handlers[name.to_sym] = handler
+    end
+
+    def self.unregister(name)
+      @@handlers.delete(name.to_sym)
+    end
+
+    def self.find(name)
+      if not_registered(name)
+        raise "No handler registered with name #{name.to_sym}."
+      end
+
+      @@handlers[name.to_sym]
+    end
+
+    private
+
+    def self.not_registered(name)
+      !@@handlers.has_key?(name.to_sym)
+    end
+  end
+end

data/lib/kindly/handlers/do_nothing.rb

@@ -0,0 +1,19 @@
+require 'kindly'
+
+module Kindly
+  module Handlers
+    class DoNothing
+
+      def ext
+        '*'
+      end
+
+      def run(migration)
+        puts "The handler for #{migration.filename} did nothing."
+      end
+
+    end
+
+    register(:do_nothing, DoNothing.new)
+  end
+end

data/lib/kindly/migration.rb

@@ -0,0 +1,37 @@
+require 'kindly'
+require 'fileutils'
+require 'json'
+
+module Kindly
+  class Migration
+
+    attr_reader :filename
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def move(destination)
+      path = File.join(Kindly.source, destination)
+      FileUtils.mkdir(path) unless Dir.exist?(path)
+      FileUtils.mv(@filename, path)
+      @filename = File.join(path, File.basename(@filename))
+    end
+
+    def running!
+      move('running')
+      puts "#{@filename} running."
+    end
+
+    def completed!
+      move('completed')
+      puts "#{@filename} completed."
+    end
+
+    def failed!
+      move('failed')
+      puts "#{@filename} failed."
+    end
+
+  end
+end

data/lib/kindly/runner.rb

@@ -0,0 +1,44 @@
+require 'kindly'
+
+module Kindly
+  class Runner
+
+    def initialize(handler)
+      @handler = handler
+    end
+
+    def run(migration)
+      output = capture_output do
+        begin
+          migration.running!
+          @handler.run(migration)
+          migration.completed!
+        rescue Exception
+          puts $!, $@
+          migration.failed!
+        end
+      end
+
+      write_log_file(migration, output)
+    end
+
+    private
+
+    def capture_output
+      begin
+        old_stdout = $stdout
+        $stdout = StringIO.new('', 'w')
+        yield
+        $stdout.string
+      ensure
+        $stdout = old_stdout
+      end
+    end
+
+    def write_log_file(migration, output)
+      filename = "#{migration.filename}.log"
+      File.open(filename, 'w') { |file| file.write(output) }
+    end
+
+  end
+end

data/lib/kindly/version.rb

@@ -0,0 +1,3 @@
+module Kindly
+  VERSION = '0.0.6'
+end

data/test/fixtures/pending/one.json

@@ -0,0 +1,3 @@
+{
+  "one": 1
+}

data/test/fixtures/pending/two.json

@@ -0,0 +1,3 @@
+{
+  "two": 2
+}

data/test/kindly/handlers_test.rb

@@ -0,0 +1,24 @@
+require 'kindly'
+require 'minitest/autorun'
+
+describe 'Kindly::Handlers' do
+
+  let(:handlers) { Kindly::Handlers }
+  let(:handler) { Kindly::Handlers::DoNothing.new }
+
+  it 'throws if handler is not registered' do
+    assert_raises(RuntimeError) { handlers.find(:missing) }
+  end
+
+  it 'allows handlers to be registered' do
+    handlers.register :different, handler
+    assert handlers.find(:different) == handler
+  end
+
+  it 'allows handlers to be unregistered' do
+    handlers.register :different, handler
+    handlers.unregister :different
+    assert_raises(RuntimeError) { handlers.find(:different) }
+  end
+
+end

data/test/kindly/migration_test.rb

@@ -0,0 +1,108 @@
+require 'kindly'
+require 'minitest/autorun'
+require 'mocha/mini_test'
+
+describe 'Migration' do
+
+  let(:filename) { File.join('test', 'fixtures', 'pending', 'one.json') }
+  let(:migration) { migration = Kindly::Migration.new(filename) }
+
+  before(:each) do
+    Kindly.stubs(:source).returns(File.join('test', 'fixtures'))
+  end
+
+  describe 'logs' do
+
+    before(:each) { migration.stubs(:move) }
+
+    it 'when running' do
+      output = capture_output { migration.running! }
+      assert running?(output)
+    end
+
+    it 'when completed' do
+      output = capture_output { migration.completed! }
+      assert completed?(output)
+    end
+
+    it 'when failed' do
+      output = capture_output { migration.failed! }
+      assert failed?(output)
+    end
+
+    def running?(output)
+      output.include?("#{filename} running")
+    end
+
+    def completed?(output)
+      output.include?("#{filename} completed") && !failed?(output)
+    end
+
+    def failed?(output)
+      output.include?("#{filename} failed") && !completed?(output)
+    end
+
+  end
+
+  describe 'moves files' do
+
+    let(:source) { File.join('test', 'fixtures') }
+    let(:tmp_dir) { File.join(source, 'tmp') }
+
+    before(:each) do
+      FileUtils.mkdir(tmp_dir) unless Dir.exist?(tmp_dir)
+      Dir[File.join(source, 'pending', '*.json')].each do |file|
+        FileUtils.cp(file, tmp_dir)
+      end
+    end
+
+    after(:each) do
+      restore_pending
+      remove(File.join(source, 'running'))
+      remove(File.join(source, 'completed'))
+      remove(File.join(source, 'failed'))
+      remove(tmp_dir)
+    end
+
+    it 'when running' do
+      capture_output { migration.running! }
+      assert File.exist?(File.join(source, 'running', File.basename(filename)))
+    end
+
+    it 'when completed' do
+      capture_output { migration.completed! }
+      assert File.exist?(File.join(source, 'completed', File.basename(filename)))
+    end
+
+    it 'when failed' do
+      capture_output { migration.failed! }
+      assert File.exist?(File.join(source, 'failed', File.basename(filename)))
+    end
+
+    def restore_pending
+      pending_dir = File.join(source, 'pending')
+      FileUtils.rm_r(pending_dir)
+      FileUtils.mkdir(pending_dir)
+      Dir[File.join(tmp_dir, '*.json')].each do |file|
+        FileUtils.cp(file, pending_dir)
+      end
+    end
+
+    def remove(dir)
+      FileUtils.rm_r(dir) if Dir.exist?(dir)
+    end
+
+  end
+
+  def capture_output
+    begin
+      old_stdout = $stdout
+      $stdout = StringIO.new('', 'w')
+      yield
+      $stdout.string
+    ensure
+      $stdout = old_stdout
+    end
+  end
+
+end

data/test/kindly/runner_test.rb

@@ -0,0 +1,44 @@
+require 'kindly'
+require 'minitest/autorun'
+require 'mocha/mini_test'
+require 'fileutils'
+
+describe 'Runner' do
+
+  let(:filename) { File.join('test', 'fixtures', 'pending', 'one.json') }
+  let(:migration) { migration = Kindly::Migration.new(filename) }
+  let(:runner) { Kindly::Runner.new(Kindly::Handlers::DoNothing.new) }
+
+  before(:each) do
+    migration.stubs(:move)
+  end
+
+  after(:each) do
+    logfile = "#{filename}.log"
+    FileUtils.rm(logfile) if File.exist?(logfile)
+  end
+
+  it 'sets migration to running if loads succeeds' do
+    migration.expects(:running!).once
+    runner.run(migration)
+  end
+
+  it 'sets migration to loading even if load fails' do
+    migration.stubs(:load).raises
+    migration.expects(:running!).once
+    runner.run(migration)
+  end
+
+  it 'sets migration to completed if Runner succeeds' do
+    migration.expects(:completed!).once
+    migration.expects(:failed!).never
+    runner.run(migration)
+  end
+
+  it 'writes log file' do
+    runner.run(migration)
+    expected_log_file = "#{migration.filename}.log"
+    assert File.exist?(expected_log_file)
+  end
+
+end

data/test/kindly_test.rb

@@ -0,0 +1,37 @@
+require 'kindly'
+require 'minitest/autorun'
+require 'mocha/mini_test'
+
+describe 'Kindly' do
+
+  it 'runs given handler name' do
+    Kindly.stubs(:source).returns(File.join('test', 'fixtures'))
+    Kindly::Runner.any_instance.expects(:run).twice
+    capture_output { Kindly.run(:do_nothing) }
+  end
+
+  it 'defaults source to _migrations' do
+    Kindly::Runner.any_instance.stubs(:run)
+    capture_output { Kindly.run(:do_nothing) }
+    assert Kindly.source == '_migrations'
+  end
+
+  it 'allows source to be overridden' do
+    Kindly::Runner.any_instance.stubs(:run)
+    fixtures = File.join('test', 'fixtures')
+    capture_output { Kindly.run(:do_nothing, fixtures) }
+    assert Kindly.source == fixtures
+  end
+
+  def capture_output
+    begin
+      old_stdout = $stdout
+      $stdout = StringIO.new('', 'w')
+      yield
+      $stdout.string
+    ensure
+      $stdout = old_stdout
+    end
+  end
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: kindly
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Greg Scott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mercenary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 
+email:
+- i@gregoryjscott.com
+executables:
+- kindly
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/kindly
+- kindly.gemspec
+- lib/kindly.rb
+- lib/kindly/handlers.rb
+- lib/kindly/handlers/do_nothing.rb
+- lib/kindly/migration.rb
+- lib/kindly/runner.rb
+- lib/kindly/version.rb
+- test/fixtures/pending/one.json
+- test/fixtures/pending/two.json
+- test/kindly/handlers_test.rb
+- test/kindly/migration_test.rb
+- test/kindly/runner_test.rb
+- test/kindly_test.rb
+homepage: https://github.com/gregoryjscott/kindly
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Kindly run migrations of any kind.
+test_files:
+- test/fixtures/pending/one.json
+- test/fixtures/pending/two.json
+- test/kindly/handlers_test.rb
+- test/kindly/migration_test.rb
+- test/kindly/runner_test.rb
+- test/kindly_test.rb