patches 0.1.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b3d2cbeb7527f40447f40af14ba0e1f77f7e044
+  data.tar.gz: 9bef2a16a778e769ef4aa95118e817ad0246283c
+SHA512:
+  metadata.gz: 3c7b3accf85699654b44802122b61a115357be010788810578e90693eae5acc8f623fbd997e1c003b33ccf1442d6a000e2286668703398dacce95884e432b002
+  data.tar.gz: 613051dd3fb716f12b1f1d4957e91ccdbb8704ed2a40f6a3a5919e1ce6ed7f564de3245bb8730c2aea6b53330ed2cf24ed4e3a817891b276f9d86c4b70c1c813

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "rails", "~> 4.1"

data/README.md

@@ -0,0 +1,40 @@
+# Patches
+[![Build status](https://badge.buildkite.com/4f3df3f3458bcc933dc44cab6c136af5c3bbdd9f761f1a99ff.svg)](https://buildkite.com/jobready/patches)
+[![Code Climate](https://codeclimate.com/repos/557f93b76956807f81000001/badges/39d142050017ffeb2564/gpa.svg)](https://codeclimate.com/repos/557f93b76956807f81000001/feed)
+[![Test Coverage](https://codeclimate.com/repos/557f93b76956807f81000001/badges/39d142050017ffeb2564/coverage.svg)](https://codeclimate.com/repos/557f93b76956807f81000001/coverage)
+
+A simple gem for one off tasks
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'patches'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install patches
+
+## Usage
+
+see `docs/usage.md`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/patches/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "patches"
+
+# 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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/db/migrate/201506011700_create_patch.rb

@@ -0,0 +1,10 @@
+class CreatePatch < ActiveRecord::Migration
+  def change
+    create_table :patches_patches do |t|
+      t.string :path, null: false
+      t.timestamps
+    end
+
+    add_index :patches_patches, :path, unique: true
+  end
+end

data/docs/usage.md

@@ -0,0 +1,38 @@
+# Usage
+
+Install the migration
+
+```
+bundle exec rake patches:install:migrations
+```
+
+Generate a patch
+
+```
+bundle exec rails g patches:patch PreferenceUpdate
+```
+
+Which will result in a file like below
+
+```ruby
+class PreferenceUpdate < Patches::Base
+  def run
+    # Code goes here
+  end
+end
+```
+
+update the run method and then execute
+
+
+```bash
+bundle exec rake patches:run
+```
+
+Patches will only ever run once, patches will run in order.
+
+To run patches after db:migrate on deployment edit Capfile and add
+
+```ruby
+require 'patches/capistrano'
+```

data/lib/generators/patches.rb

@@ -0,0 +1,22 @@
+module Patches
+  module Generators
+    class PatchGenerator < Rails::Generators::NamedBase
+      desc 'Adds an empty patch'
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_patch
+        template "patch.erb", "app/db/#{file_name}.rb"
+      end
+
+      private
+
+      def class_name
+        name.camelize
+      end
+
+      def file_name
+        name.underscore
+      end
+    end
+  end
+end

data/lib/generators/patches/patch_generator.rb

@@ -0,0 +1,23 @@
+module Patches
+  module Generators
+    class PatchGenerator < Rails::Generators::NamedBase
+      desc 'Adds an empty patch'
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_patch
+        template "patch.rb.erb", "db/patches/#{file_name}.rb"
+      end
+
+      private
+
+      def class_name
+        name.camelize
+      end
+
+      def file_name
+        "#{Time.now.strftime('%Y%m%d%H%M')}_#{name.underscore}"
+      end
+    end
+  end
+end
+

data/lib/generators/patches/templates/patch.rb.erb

@@ -0,0 +1,5 @@
+class <%= class_name %> < Patches::Base
+  def run
+    # Code goes here
+  end
+end

data/lib/patches.rb

@@ -0,0 +1,26 @@
+require "patches/version"
+
+module Patches
+  def self.default_path
+    Rails.root.join('db/patches/') if defined?(:Rails)
+  end
+
+  def self.class_name(path)
+    match = path.match(/\d+_(.+?)\.rb/)
+    match[1].camelcase if match
+  end
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+  def self.logger=(log)
+    @logger = log
+  end
+end
+
+require "patches/base"
+require "patches/engine" if defined?(Rails)
+require "patches/patch"
+require "patches/pending"
+require "patches/runner"

data/lib/patches/base.rb

@@ -0,0 +1,20 @@
+class Patches::Base
+
+  # TODO: Use this :/
+  def self.tenant(name)
+    @tenant = name
+  end
+
+  def run
+    logger.warn("Run method not implemented for #{self.class.name}")
+  end
+
+  private
+  def execute(sql)
+    ActiveRecord::Base.connection.execute(sql)
+  end
+
+  def logger
+    Patches.logger
+  end
+end

data/lib/patches/capistrano.rb

@@ -0,0 +1 @@
+load File.expand_path("capistrano/tasks.rake", File.dirname(__FILE__))

data/lib/patches/capistrano/tasks.rake

@@ -0,0 +1,13 @@
+namespace :deploy do
+  desc 'Runs rake patches:run'
+  task :patches do
+     on primary fetch(:migration_role) do
+        within release_path do
+           with rails_env: fetch(:rails_env) do
+              execute :rake, "patches:run"
+           end
+        end
+     end
+  end
+  after 'deploy:migrate', 'deploy:patches'
+end

data/lib/patches/engine.rb

@@ -0,0 +1,7 @@
+require 'rails/engine'
+
+module Patches
+  class Engine < Rails::Engine
+    isolate_namespace Patches
+  end
+end

data/lib/patches/patch.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+
+class Patches::Patch < ActiveRecord::Base
+  validates :path, presence: true
+
+  def self.path_lookup
+    Hash[pluck(:path, :created_at)]
+  end
+end

data/lib/patches/pending.rb

@@ -0,0 +1,34 @@
+class Patches::Pending
+  include Enumerable
+
+  attr_accessor :path
+
+  def initialize(path=nil)
+    @path = path || Patches.default_path
+  end
+
+  def each
+    return nil unless files
+    Patches.logger.info("Patches found: #{files.join(',')}")
+
+    files.each do |file|
+      unless already_run?(file)
+        yield file
+      end
+    end
+  end
+
+  private
+
+  def files
+    @files ||= Dir[File.join(path, "*.rb")].to_a.sort
+  end
+
+  def already_run?(path)
+    patches[File.basename(path)]
+  end
+
+  def patches
+    @patches ||= Patches::Patch.path_lookup
+  end
+end

data/lib/patches/runner.rb

@@ -0,0 +1,42 @@
+class Patches::Runner
+  attr_accessor :path
+
+  class UnknownPatch < StandardError; end
+
+  def initialize(path = nil)
+    @path = path || Patches.default_path
+  end
+
+  def perform
+    pending.each do |file_path|
+      klass = load_class(file_path)
+      instance = klass.new
+      Patches.logger.info("Running #{klass} from #{file_path}")
+      instance.run
+      complete!(patch_path(file_path))
+    end
+  end
+
+  def complete!(patch_path)
+    Patches::Patch.create!(path: patch_path)
+  end
+
+  def patch_path(patch_path)
+    File.basename(patch_path)
+  end
+
+  def pending
+    @pending ||= Patches::Pending.new(path)
+  end
+
+  private
+  def load_class(path)
+    begin
+      name = Patches.class_name(path)
+      load path
+      name.constantize
+    rescue StandardError, LoadError
+      raise UnknownPatch, "#{path} should define #{name}"
+    end
+  end
+end

data/lib/patches/tenant_runner.rb

@@ -0,0 +1,26 @@
+class Patches::TenantRunner
+  attr_accessor :path
+
+  def initialize(path: nil, tenants: nil)
+    @path = path
+    @tenants = tenants
+  end
+
+  def perform
+    Patches.logger.info("Patches tenant runner for: #{tenants.join(',')}")
+
+    tenants.each do |tenant|
+      Apartment::Tenant.switch(tenant)
+      runner = build
+      runner.perform
+    end
+  end
+
+  def build
+    Patches::Runner.new(path)
+  end
+
+  def tenants
+    @tenants ||= (Apartment.tenant_names || [])
+  end
+end

data/lib/patches/version.rb

@@ -0,0 +1,3 @@
+module Patches
+  VERSION = "0.1.8"
+end

data/lib/tasks/patches.rake

@@ -0,0 +1,22 @@
+require 'patches/tenant_runner'
+
+namespace :patches do
+  desc "Run Patches"
+  task :run => [:environment] do
+    if defined?(Apartment) && tenants.present?
+      Patches::TenantRunner.new(tenants: tenants).perform
+    else
+      Patches::Runner.new.perform
+    end
+  end
+
+  def tenants
+    ENV['DB'] ? ENV['DB'].split(',').map { |s| s.strip } : Apartment.tenant_names || []
+  end
+
+  task :pending => [:environment] do
+    Patches::Pending.each do |patch|
+      puts patch
+    end
+  end
+end

data/patches.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'patches/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "patches"
+  spec.version       = Patches::VERSION
+  spec.authors       = ["John D'Agostino"]
+  spec.email         = ["johnd@jobready.com.au"]
+
+  spec.summary       = %q{A simple gem for one off tasks}
+  spec.description   = %q{A simple gem for one of tasks for example database patches}
+  spec.homepage      = "http://github.com/jobready/patches"
+
+  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_dependency "railties", ">= 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3.5"
+  spec.add_development_dependency "rspec-rails", "~> 3.2.0"
+  spec.add_development_dependency "capybara", "~> 2.3.0"
+  spec.add_development_dependency "generator_spec", "~> 0.9.0"
+  spec.add_development_dependency "simplecov", "~> 0.10"
+  spec.add_development_dependency "factory_girl", "~> 4.5.0"
+  spec.add_development_dependency "timecop", "~> 0.7.0"
+  spec.add_development_dependency "database_cleaner", "~> 1.3.0"
+end

data/script/buildkite.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+set -e
+
+echo '--- setting ruby version'
+rbenv local 2.1.5
+
+echo '--- setting up env'
+REVISION=https://github.com/$BUILDBOX_PROJECT_SLUG/commit/$BUILDBOX_COMMIT
+
+echo '--- bundling'
+bundle install -j $(nproc) --without production --quiet
+
+echo '--- running specs'
+if bundle exec rspec; then
+  echo "[Successful] $BUILDBOX_PROJECT_SLUG - Build - $BUILDBOX_BUILD_URL - Commit - $REVISION" | hipchat_room_message -t $HIPCHAT_TOKEN -r $HIPCHAT_ROOM -f "Buildbox" -c "green"
+else
+  echo "[Failed] Build $BUILDBOX_PROJECT_SLUG - Build - $BUILDBOX_BUILD_URL - Commit - $REVISION" | hipchat_room_message -t $HIPCHAT_TOKEN -r $HIPCHAT_ROOM -f "Buildbox" -c "red"
+  exit 1;
+fi

metadata

@@ -0,0 +1,224 @@
+--- !ruby/object:Gem::Specification
+name: patches
+version: !ruby/object:Gem::Version
+  version: 0.1.8
+platform: ruby
+authors:
+- John D'Agostino
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: A simple gem for one of tasks for example database patches
+email:
+- johnd@jobready.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- db/migrate/201506011700_create_patch.rb
+- docs/usage.md
+- lib/generators/patches.rb
+- lib/generators/patches/patch_generator.rb
+- lib/generators/patches/templates/patch.rb.erb
+- lib/patches.rb
+- lib/patches/base.rb
+- lib/patches/capistrano.rb
+- lib/patches/capistrano/tasks.rake
+- lib/patches/engine.rb
+- lib/patches/patch.rb
+- lib/patches/pending.rb
+- lib/patches/runner.rb
+- lib/patches/tenant_runner.rb
+- lib/patches/version.rb
+- lib/tasks/patches.rake
+- patches.gemspec
+- script/buildkite.sh
+homepage: http://github.com/jobready/patches
+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: A simple gem for one off tasks
+test_files: []
+has_rdoc: