handcuffs 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da7fdd5f453f4907761e1969eed5e343a73a61b3
-  data.tar.gz: 66b088789f400b5054dff8bde1339b91ccb4a95e
+  metadata.gz: fad65d31075a71be8ae84c5d27c6f92c7b0cef64
+  data.tar.gz: 3090970bf6d57882a3cd7573729c4a84a9e44ed4
 SHA512:
-  metadata.gz: 6aa274089abdc0153be5211e309c18209ba4e5ab17937019c142b3c6b750dec71560ffae0ad9ff68535bc91c661fcf1cc336e12a983134053edf7621deed148f
-  data.tar.gz: d02b547321c03c3047e8335977e4ca3e4f792e2d4e3058a149bc72ec1c9f9c8f3d0cd584061496a140189b05634bbf0cafcdb13a586b038076b505bf5879aa02
+  metadata.gz: ba80cc8d9c509ef9e4b43f72bc745e2969f318e748927dc1927021f399c0d31963f9ebf2135a065d2836adb9385a8866d5bcbe832913f997e5068972ca90b289
+  data.tar.gz: 632e11dfd992d24f71b8464e9a1f6a60b181351c88ea474ad18e8744a4516ecf7e268bdf2e7eb6f7407fc4e7824ff32d023c3053ffddab46105a4d82f6eff64b

data/README.md

@@ -11,7 +11,7 @@ To configure, first create a handcuff initializer and define a configuration
 # config/initializers/handcuffs.rb
 
 Handcuffs.configure do |config|
-  config.phases = [:pre_deploy, :post_deploy]
+  config.phases = [:pre_restart, :post_restart]
 end
 ```
 
@@ -22,7 +22,7 @@ Then call `phase` from inside your migrations
 
 class AddOnSaleColumn < ActiveRecord::Migration
 
-  phase :pre_deploy
+  phase :pre_restart
 
   def up
     add_column :products, :on_sale, :boolean
@@ -40,7 +40,7 @@ end
 
 class AddOnSaleIndex < ActiveRecord::Migration
 
-  phase :post_deploy
+  phase :post_restart
 
   def up
     add_index :products, :on_sale, algorithm: :concurrently
@@ -55,11 +55,11 @@ end
 
 You can then run your migrations in phases using
 ```bash
-rake handcuffs:migrate[pre_deploy]
+rake handcuffs:migrate[pre_restart]
 ```
 or
 ```bash
-rake handcuffs:migrate[post_deploy]
+rake handcuffs:migrate[post_restart]
 ```
 
 You can run all migrations using
@@ -77,8 +77,8 @@ error, you can define a default phase for migrations that don't define one.
 # config/initializers/handcuffs.rb
 
 Handcuffs.configure do |config|
-  config.phases = [:pre_deploy, :post_deploy]
-  config.default_phase = :pre_deploy
+  config.phases = [:pre_restart, :post_restart]
+  config.default_phase = :pre_restart
 end
 ```
 

data/lib/handcuffs/errors.rb

@@ -5,7 +5,7 @@
     def initialize(task)
       msg = <<-MESSAGE
         rake #{task} requires a phase argument.
-        For example: #{task}[pre_deploy]
+        For example: #{task}[pre_restart]
       MESSAGE
       super(msg)
     end
@@ -31,6 +31,16 @@
     end
   end
 
+  class HandcuffsPhaseUndeclaredError < HandcuffsError
+    def initialize(found_phases, allowed_phases)
+      msg = <<-MESSAGE
+        found declarations for #{found_phases.to_sentence}
+        but only #{allowed_phases.to_sentence} are allowed
+      MESSAGE
+      super msg
+    end
+  end
+
   class HandcuffsPhaseOutOfOrderError < HandcuffsError
     def initialize(not_run_phase, attempted_phase)
       msg = <<-MESSAGE

data/lib/handcuffs/phase_filter.rb

@@ -10,6 +10,7 @@ class Handcuffs::PhaseFilter
   def filter(migration_proxies)
     migration_hashes = proxies_with_migrations(migration_proxies)
     check_for_undefined_phases!(migration_hashes)
+    check_for_undeclared_phases!(migration_hashes)
     by_phase = migration_hashes.lazy.group_by { |mh| phase(mh[:migration]) }
     defined_phases = Handcuffs.config.phases
     if(attempted_phase == :all)
@@ -49,9 +50,9 @@ class Handcuffs::PhaseFilter
 
   def check_order_down!(by_phase, defined_phases)
     #There's no way to do this without some super hackery. If we run rake
-    #handcuffs::rollback[:post_deploy] and the top of the list (in desc order)
-    #in a pre_deploy, we don't know if that was run before or after the
-    #last post_deploy because we can't count on the versions to give us the
+    #handcuffs::rollback[:post_restart] and the top of the list (in desc order)
+    #in a pre_restart, we don't know if that was run before or after the
+    #last post_restart because we can't count on the versions to give us the
     #execution order. Without storing the execution order in another table,
     #there's no way to implement this
   end
@@ -74,6 +75,17 @@ class Handcuffs::PhaseFilter
     end
   end
 
+  def check_for_undeclared_phases!(migration_hashes)
+    unknown_phases = migration_hashes
+      .lazy
+      .map { |mh| mh[:migration].handcuffs_phase }
+      .reject(&:nil?)
+      .select { |phase| !phase.in?(Handcuffs.config.phases) }.to_a
+    if (unknown_phases.any?)
+      raise HandcuffsPhaseUndeclaredError.new(unknown_phases, Handcuffs.config.phases)
+    end
+  end
+
   def phase(migration)
     migration.handcuffs_phase || Handcuffs.config.default_phase
   end

data/lib/handcuffs/version.rb

@@ -1,3 +1,3 @@
 module Handcuffs
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,89 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: handcuffs
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Brad Urani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-01 00:00:00.000000000 Z
+date: 2016-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pg
   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'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   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: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: '5.0'
 description: Allows you to define a phase on Active Record migrations and provides
@@ -95,7 +95,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
+- .ruby-version
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -126,17 +127,17 @@ 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.1
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for running Active Record migrations in phases