parity 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6234f6e4b0de3c9522d680873f0656eadc2eb9e1
-  data.tar.gz: 8eb26ea4a4baaa7d1725c77ba189f4e37b6dcc68
+  metadata.gz: e4e155834acdf736ab29c1ec93f809a224aad99f
+  data.tar.gz: 2456550fe32dfd2a44f4103ca52120cb2a0b0fb7
 SHA512:
-  metadata.gz: 51fc15b1ecd873d961a3faae32c56cb7c164f6118ff87b40eb1a708432fabf679687bc43daa54247b6e830a5479d8343e9e0fbaeb0399ce6aebd899d1993d0bf
-  data.tar.gz: 26c3c4270ac85ba8d70fc82b62250aafebe61ebce301c673a9b1c97854f91644c027e3132923469234e6814538b3494226ef9fac1adc160b6819d36b06f1bed4
+  metadata.gz: 5390a193b5833b01e5b30f5dd96a1d505667807a21e6fe8bbeab22c7967d7f1ca7cffaa5d07a2a66bf6105df2374987a5fa6f82f839ac31d4f00ba337c2c24d9
+  data.tar.gz: acd28f15ba2039c1d96a36c5083de72b4ef0c9d67724f9c87eed7a0a6c32fc6be569efc2c5b1ac5901aad115809fbbfd2107fdeba21a844351c0e72ef3958c1c

data/README.md

@@ -3,27 +3,10 @@ Parity
 
 Shell commands for development, staging, and production parity for Heroku apps.
 
-Prerequisites
--------------
-
-Your development machine will need these command-line programs:
-
-    git
-    curl
-    heroku
-    pg_restore
-
-On a Mac,
-`curl` and `git` are installed by default
-and the other programs can be installed with Homebrew:
-
-    brew install heroku-toolbelt
-    brew install postgres
-
 Install
 -------
 
-OSX:
+On OS X, this installs everything you need:
 
     brew tap thoughtbot/formulae
     brew install parity
@@ -33,18 +16,17 @@ On other systems you can:
 1. Download the package for your system from the [releases page][releases]
 1. Extract the tarball and place it so that `/bin` is in your `PATH`
 
-Alternatively, you can do the following on all systems
-(requires a Ruby installation):
-
-    gem install parity
+[releases]: https://github.com/thoughtbot/parity/releases
 
-All these methods install the following three shell commands:
+Parity requires these command-line programs:
 
-    development
-    staging
-    production
+    git
+    heroku
+    pg_restore
 
-[releases]: https://github.com/thoughtbot/parity/releases
+On OS X, these programs are installed
+as Homebrew package dependencies of
+the `parity` Homebrew package.
 
 Usage
 -----
@@ -63,6 +45,10 @@ Restore a production database backup into staging:
 
     staging restore production
 
+Push your local development database backup up to staging:
+
+    development restore staging
+
 Deploy from master, and migrate and restart the dynos if necessary:
 
     production deploy
@@ -73,11 +59,6 @@ Open a console:
     production console
     staging console
 
-Open [log2viz][1]:
-
-    production log2viz
-    staging log2viz
-
 Migrate a database and restart the dynos:
 
     production migrate
@@ -99,7 +80,6 @@ with `heroku ______ --remote staging` or `heroku ______ --remote production`:
     watch production ps
     staging open
 
-[1]: https://blog.heroku.com/archives/2013/3/19/log2viz
 [2]: http://redis.io/commands
 
 Convention
@@ -109,7 +89,7 @@ Parity expects:
 
 * A `staging` remote pointing to the staging Heroku app.
 * A `production` remote pointing to the production Heroku app.
-* There is a `config/database.yml` file that can be parsed as Yaml for
+* There is a `config/database.yml` file that can be parsed as YAML for
   `['development']['database']`.
 * The Heroku apps are named like `app-staging` and `app-production`
   where `app` is equal to `basename $PWD`.
@@ -117,21 +97,18 @@ Parity expects:
 Customization
 -------------
 
-Override some of the conventions:
-
-```ruby
-Parity.configure do |config|
-  config.database_config_path = "different/path.yml"
-  config.heroku_app_basename = "different-base-name"
-  config.redis_url_env_variable = "DIFFERENT_REDIS_URL"
-end
-```
-
 If you have Heroku environments beyond staging and production (such as a feature
 environment for each developer), you can add a [binstub] to the `bin` folder of
 your application. Custom environments share behavior with staging: they can be
 backed up and can restore from production.
 
+Using feature environments requires including Parity as a gem in your
+application's Gemfile.
+
+```ruby
+gem "parity"
+```
+
 [binstub]: https://github.com/sstephenson/rbenv/wiki/Understanding-binstubs
 
 Here's an example binstub for a 'feature-geoff' environment, hosted at
@@ -140,24 +117,24 @@ myapp-feature-geoff.herokuapp.com.
 ```ruby
 #!/usr/bin/env ruby
 
-require 'parity'
+require "parity"
 
 if ARGV.empty?
   puts Parity::Usage.new
 else
-  Parity::Environment.new('feature-geoff', ARGV).run
+  Parity::Environment.new("feature-geoff", ARGV).run
 end
 ```
 
 Contributing
 ------------
 
-Please see CONTRIBUTING.md for details.
+Please see [`CONTRIBUTING.md`](CONTRIBUTING.md) for details.
 
 Releasing
 ---------
 
-See guidelines in RELEASING.md for details
+See guidelines in [`RELEASING.md`](RELEASING.md) for details
 
 License
 -------

data/bin/development

@@ -5,5 +5,5 @@ require File.join(File.dirname(__FILE__), '..', 'lib', 'parity')
 if ARGV.empty?
   puts Parity::Usage.new
 else
-  Parity::Environment.new('development', ARGV).run
+  exit Parity::Environment.new('development', ARGV).run
 end

data/bin/production

@@ -5,5 +5,5 @@ require File.join(File.dirname(__FILE__), '..', 'lib', 'parity')
 if ARGV.empty?
   puts Parity::Usage.new
 else
-  Parity::Environment.new('production', ARGV).run
+  exit Parity::Environment.new('production', ARGV).run
 end

data/bin/staging

@@ -5,5 +5,5 @@ require File.join(File.dirname(__FILE__), '..', 'lib', 'parity')
 if ARGV.empty?
   puts Parity::Usage.new
 else
-  Parity::Environment.new('staging', ARGV).run
+  exit Parity::Environment.new('staging', ARGV).run
 end

data/lib/parity.rb

@@ -1,10 +1,7 @@
 $LOAD_PATH << File.expand_path("..", __FILE__)
 
 require "parity/version"
-require "parity/configuration"
 require "parity/environment"
 require "parity/usage"
 require "open3"
 require "uri"
-
-Parity.configure

data/lib/parity/backup.rb

@@ -8,10 +8,12 @@ module Parity
     end
 
     def restore
-      if to == 'development'
+      if to == "development"
         restore_to_development
+      elsif from == "development"
+        restore_from_development
       else
-        restore_to_pass_through
+        restore_to_remote_environment
       end
     end
 
@@ -21,35 +23,41 @@ module Parity
 
     private
 
-    def restore_to_development
-      Kernel.system "#{curl} | #{pg_restore}"
+    def restore_from_development
+      Kernel.system(
+        "heroku pg:push #{development_db} DATABASE_URL --remote #{to} "\
+          "#{additional_args}",
+      )
     end
 
-    def curl
-      "curl -s `#{db_backup_url}`"
+    def restore_to_development
+      Kernel.system(
+        "heroku pg:pull DATABASE_URL #{development_db} --remote #{from} "\
+          "#{additional_args}",
+      )
     end
 
     def pg_restore
       "pg_restore --verbose --clean --no-acl --no-owner -d #{development_db}"
     end
 
-    def restore_to_pass_through
+    def restore_to_remote_environment
       Kernel.system(
         "heroku pg:backups restore #{backup_from} --remote #{to} "\
-          "#{additional_args}"
+          "#{additional_args}",
       )
     end
 
     def backup_from
-      "`#{db_backup_url}` DATABASE"
+      "`#{remote_db_backup_url}` DATABASE"
     end
 
-    def db_backup_url
+    def remote_db_backup_url
       "heroku pg:backups public-url --remote #{from}"
     end
 
     def development_db
-      yaml_file = IO.read(Parity.config.database_config_path)
+      yaml_file = IO.read("config/database.yml")
       YAML.load(yaml_file)['development']['database']
     end
   end

data/lib/parity/environment.rb

@@ -20,6 +20,8 @@ module Parity
 
     private
 
+    PROTECTED_ENVIRONMENTS = %w(development production)
+
     attr_accessor :environment, :subcommand, :arguments
 
     def open
@@ -27,49 +29,67 @@ module Parity
     end
 
     def run_via_cli
-      Kernel.system "heroku", subcommand, *arguments, "--remote", environment
+      Kernel.system("heroku", subcommand, *arguments, "--remote", environment)
     end
 
     def backup
-      Kernel.system "heroku pg:backups capture --remote #{environment}"
+      Kernel.system("heroku pg:backups capture --remote #{environment}")
     end
 
     def deploy
-      skip_migration = skip_migration?
-
-      Kernel.system "git push #{environment} master"
-
-      unless skip_migration
+      if deploy_to_heroku && run_migration?
         migrate
       end
     end
 
+    def deploy_to_heroku
+      if production?
+        Kernel.system("git push production master")
+      else
+        Kernel.system(
+          "git push #{environment} HEAD:master --force",
+        )
+      end
+    end
+
     def restore
-      if environment == "production"
+      if production?
         $stdout.puts "Parity does not support restoring backups into your "\
           "production environment."
       else
         Backup.new(
           from: arguments.first,
           to: environment,
-          additional_args: arguments.drop(1).join(" ")
+          additional_args: additional_restore_arguments,
         ).restore
       end
     end
 
-    def console
-      Kernel.system "heroku run rails console --remote #{environment}"
+    def production?
+      environment == "production"
+    end
+
+    def additional_restore_arguments
+      (arguments.drop(1) + [restore_confirmation_argument]).
+        compact.
+        join(" ")
     end
 
-    def log2viz
-      Kernel.system "open https://log2viz.herokuapp.com/app/#{heroku_app_name}"
+    def restore_confirmation_argument
+      unless PROTECTED_ENVIRONMENTS.include?(environment)
+        "--confirm #{heroku_app_name}"
+      end
+    end
+
+    def console
+      Kernel.system("heroku run rails console --remote #{environment}")
     end
 
     def migrate
-      Kernel.system %{
+      Kernel.system(%{
         heroku run rake db:migrate --remote #{environment} &&
         heroku restart --remote #{environment}
-      }
+      })
     end
 
     def tail
@@ -94,7 +114,7 @@ module Parity
 
     def raw_redis_url
       @redis_to_go_url ||= Open3.capture3(
-        "heroku config:get #{Parity.config.redis_url_env_variable} "\
+        "heroku config:get REDIS_URL "\
         "--remote #{environment}"
       )[0].strip
     end
@@ -104,14 +124,14 @@ module Parity
     end
 
     def basename
-      Parity.config.heroku_app_basename || Dir.pwd.split('/').last
+      Dir.pwd.split("/").last
     end
 
-    def skip_migration?
-      Kernel.system %{
+    def run_migration?
+      !Kernel.system(%{
         git fetch #{environment} &&
         git diff --quiet #{environment}/master..master -- db/migrate
-      }
+      })
     end
   end
 end

data/lib/parity/version.rb

@@ -1,3 +1,3 @@
 module Parity
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parity
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Dan Croak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies: []
 description: |2
       Development/staging/production parity makes it easier for
@@ -28,7 +28,6 @@ files:
 - bin/staging
 - lib/parity.rb
 - lib/parity/backup.rb
-- lib/parity/configuration.rb
 - lib/parity/environment.rb
 - lib/parity/usage.rb
 - lib/parity/version.rb
@@ -52,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Shell commands for development, staging, and production parity.

data/lib/parity/configuration.rb

@@ -1,25 +0,0 @@
-module Parity
-  class Configuration
-    attr_accessor \
-      :database_config_path,
-      :heroku_app_basename,
-      :redis_url_env_variable
-
-    def initialize
-      @database_config_path = "config/database.yml"
-      @redis_url_env_variable = "REDIS_URL"
-    end
-  end
-
-  class << self
-    attr_accessor :config
-  end
-
-  def self.configure
-    self.config ||= Configuration.new
-
-    if block_given?
-      yield config
-    end
-  end
-end