patches 0.1.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b3d2cbeb7527f40447f40af14ba0e1f77f7e044
-  data.tar.gz: 9bef2a16a778e769ef4aa95118e817ad0246283c
+  metadata.gz: 2aa4b0d46b34a6ec109a084e3fa4a98621227e11
+  data.tar.gz: d5addc26e43180c2946c7454fd48f0dfd80a86a8
 SHA512:
-  metadata.gz: 3c7b3accf85699654b44802122b61a115357be010788810578e90693eae5acc8f623fbd997e1c003b33ccf1442d6a000e2286668703398dacce95884e432b002
-  data.tar.gz: 613051dd3fb716f12b1f1d4957e91ccdbb8704ed2a40f6a3a5919e1ce6ed7f564de3245bb8730c2aea6b53330ed2cf24ed4e3a817891b276f9d86c4b70c1c813
+  metadata.gz: 644e49e78ac8b18a0cee626c83d4354092d90c0006df33aaa78001b1db497314ac09a71ab091a29fba4df11c50b1653f9a5bb2a8658b4eec834181660eb05cf6
+  data.tar.gz: e5ba79708cf10f043e2333b7197bb595d35e11f9428a7659dfa28312e78c260ecd8e5382980d26f3287da6e5420303b709e4a53961101fd660f3336d01f0eb75

data/README.md

@@ -12,7 +12,6 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'patches'
 ```
-
 And then execute:
 
     $ bundle
@@ -33,8 +32,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/patches/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
+1. Fork it ( https://github.com/jobready/patches/fork )
+2. Create your feature branch (`git checkout -b feature/my-feature-name`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
 5. Create a new Pull Request

data/docs/usage.md

@@ -1,11 +1,42 @@
 # Usage
 
-Install the migration
+## Initial Setup
 
+Add patches to the project Gemfile
+
+```ruby
+gem 'patches', '~> 0.1'
 ```
+
+Install the database migration
+
+```bash
 bundle exec rake patches:install:migrations
 ```
 
+Migrate database
+
+```bash
+bundle exec rake db:migrate
+```
+
+If you would like to run the patches asynchronously, or would like them to notify your hipchat room when they fail or succeed, you need to set up an initializer to set those options.
+
+```Ruby
+Patches::Config.configure do |config|
+  config.use_sidekiq = true
+
+  config.use_hipchat = true
+  config.hipchat_options = {
+    api_token: HIPCHATAPITOKEN,
+    room: HIPCHATROOMNAME,
+    user: HIPCHATUSER #maximum of 15 characters
+  }
+end
+```
+
+## Creating Patches
+
 Generate a patch
 
 ```
@@ -29,10 +60,14 @@ update the run method and then execute
 bundle exec rake patches:run
 ```
 
-Patches will only ever run once, patches will run in order.
+Patches will only ever run once, patches will run in order of creation date.
 
 To run patches after db:migrate on deployment edit Capfile and add
 
 ```ruby
 require 'patches/capistrano'
 ```
+
+## Multitenant
+
+Patches will detect if `Apartment` gem is installed and if there are any tenants and run the patches for each tenant

data/lib/patches.rb

@@ -24,3 +24,7 @@ require "patches/engine" if defined?(Rails)
 require "patches/patch"
 require "patches/pending"
 require "patches/runner"
+require "patches/tenant_runner"
+require "patches/config"
+require "patches/notifier"
+require "patches/worker" if defined?(Sidekiq)

data/lib/patches/config.rb

@@ -0,0 +1,19 @@
+module Patches
+  class Config
+    class << self
+      class_attribute :use_sidekiq, :sidekiq_queue, :sidekiq_options, :use_hipchat, :hipchat_options
+
+      def sidekiq_queue
+        @sidekiq_queue ||= 'default'
+      end
+
+      def sidekiq_options
+        @sidekiq_options ||= { retry: false, queue: Patches::Config.sidekiq_queue }
+      end
+
+      def configure
+        yield self
+      end
+    end
+  end
+end

data/lib/patches/notifier.rb

@@ -0,0 +1,34 @@
+class Patches::Notifier
+  class << self
+    def notify_success(patches)
+      send_hipchat_message(success_message(patches), color: 'green')
+    end
+
+    def notify_failure(patch_path, error)
+      send_hipchat_message(failure_message(patch_path, error), color: 'red')
+    end
+
+    def success_message(patches)
+      message = "#{patches.count} patches succeeded"
+      append_tenant_message(message)
+    end
+
+    def failure_message(patch_path, error)
+      message = "Error applying patch: #{Pathname.new(patch_path).basename} failed with error: #{error}"
+      append_tenant_message(message)
+    end
+
+    def append_tenant_message(message)
+      message = message + " for tenant: #{Apartment::Tenant.current}" if defined?(Apartment)
+      message
+    end
+
+    private
+
+    def send_hipchat_message(message, options)
+      if defined?(HipChat) && Patches::Config.use_hipchat
+        HipChat::Client.new(Patches::Config.hipchat_options[:api_token])[Patches::Config.hipchat_options[:room]].send(Patches::Config.hipchat_options[:user], message, options)
+      end
+    end
+  end
+end

data/lib/patches/pending.rb

@@ -9,9 +9,10 @@ class Patches::Pending
 
   def each
     return nil unless files
-    Patches.logger.info("Patches found: #{files.join(',')}")
+    new_files = files.reject { |file| already_run?(file) }
+    Patches.logger.info("Patches found: #{new_files.join(',')}")
 
-    files.each do |file|
+    new_files.each do |file|
       unless already_run?(file)
         yield file
       end

data/lib/patches/runner.rb

@@ -8,13 +8,20 @@ class Patches::Runner
   end
 
   def perform
-    pending.each do |file_path|
+    completed_patches = pending.each do |file_path|
       klass = load_class(file_path)
       instance = klass.new
       Patches.logger.info("Running #{klass} from #{file_path}")
-      instance.run
+      begin
+        instance.run
+      rescue => e
+        Patches::Notifier.notify_failure(file_path, format_exception(e))
+        raise e
+      end
       complete!(patch_path(file_path))
     end
+    Patches::Notifier.notify_success(completed_patches)
+    completed_patches
   end
 
   def complete!(patch_path)
@@ -29,6 +36,10 @@ class Patches::Runner
     @pending ||= Patches::Pending.new(path)
   end
 
+  def format_exception(e)
+    "#{e.class.name}: #{e.message} (#{e.backtrace.first})"
+  end
+
   private
   def load_class(path)
     begin

data/lib/patches/version.rb

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

data/lib/patches/worker.rb

@@ -0,0 +1,11 @@
+require 'sidekiq'
+
+class Patches::Worker
+  include Sidekiq::Worker
+
+  sidekiq_options Patches::Config.sidekiq_options
+
+  def perform(runner)
+    runner.constantize.new.perform
+  end
+end

data/lib/tasks/patches.rake

@@ -1,12 +1,16 @@
-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
+      runner = Patches::TenantRunner
+    else
+      runner = Patches::Runner
+    end
+
+    if defined?(Sidekiq) && Patches::Config.use_sidekiq
+      Patches::Worker.perform_async(runner)
     else
-      Patches::Runner.new.perform
+      runner.new.perform
     end
   end
 

data/patches.gemspec

@@ -30,4 +30,7 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "sidekiq", "~> 3.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patches
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 1.0.0
 platform: ruby
 authors:
 - John D'Agostino
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -164,6 +164,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
 description: A simple gem for one of tasks for example database patches
 email:
 - johnd@jobready.com.au
@@ -188,12 +230,15 @@ files:
 - lib/patches/base.rb
 - lib/patches/capistrano.rb
 - lib/patches/capistrano/tasks.rake
+- lib/patches/config.rb
 - lib/patches/engine.rb
+- lib/patches/notifier.rb
 - lib/patches/patch.rb
 - lib/patches/pending.rb
 - lib/patches/runner.rb
 - lib/patches/tenant_runner.rb
 - lib/patches/version.rb
+- lib/patches/worker.rb
 - lib/tasks/patches.rake
 - patches.gemspec
 - script/buildkite.sh
@@ -216,9 +261,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A simple gem for one off tasks
 test_files: []
-has_rdoc: