parity 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZWQ5MDcxMzdkOTY3ZDE1OGQzZmJiYzlmMjJlN2U4NTQ4NzBiNWM1Ng==
-  data.tar.gz: !binary |-
-    NWI3ZjUyZmNlOTY3Yzc1NjQzNDMwMTc4NzcxMzE4ZGYzMDg1NmIyNA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YmZhM2U4ZDc0ZDQwM2MzOTlkNTFjZWRjZmJlN2FlOWQ4YmE5NzIyODFjYjBh
-    MTJhYzEwNTJmMWI2YmJiMWNkYmZhOGY1OGFkYzNmYTQ5NGY1ZTZkODIwMjVh
-    YjAyMTdhODgyMmRkM2E4ODU0MDMyYjAwMjEyOTRlNmNkODhkOWQ=
-  data.tar.gz: !binary |-
-    MTlmMjYyNDg3NzEwY2FjODE1ZTA3MTE3OTdlZTIxZDU5OThmODUxZjUyMDhh
-    OWIwZjVkM2M4NmRjMmVlNDMwNGIyODljMzE0MTI4MmRhYTM0YTA5MjBiOGM1
-    Y2JlMDg0NmNhZjEzODAxM2NkNTlmNmI4Y2Q4NTM3ZjA1ZDRjMDQ=
+SHA1:
+  metadata.gz: 0698fa82d8c213ab44c52cb3fce810562de1f473
+  data.tar.gz: 46a3715c5db2394ae33ad4b6f2de32db42c36206
+SHA512:
+  metadata.gz: 3f8d844f83bd34cc98c3d04cb85815fab30b8d0490d7c345b7f92c3a981a66d231ce5d845a9420f965a89d95d5a9ec0eb232191f19ce7f81b6976afee11b86c9
+  data.tar.gz: b9d1f976654e6bb6716a07ea03be643f680c9d0b5ff39df916d7a9aeaaf6e4137e332dc8aa1f2f705ac261247492ccbc2b20940baefb8b9e216293b04e24df2d

data/README.md

@@ -0,0 +1,102 @@
+Parity
+======
+
+Shell commands for development, staging, and production parity for Heroku apps.
+
+Install
+-------
+
+    gem install parity
+
+This installs three shell commands:
+
+    development
+    staging
+    production
+
+Your development machine will also need these command-line programs:
+
+    curl
+    heroku
+    pg_restore
+
+On a Mac, `curl` is installed by default and the other programs can be installed
+with Homebrew:
+
+    brew install heroku-toolbelt
+    brew install postgres --no-python
+
+Usage
+-----
+
+Backup a database:
+
+    production backup
+    staging backup
+
+Restore a production or staging database backup into development:
+
+    development restore production
+    development restore staging
+
+Restore a production database backup into staging:
+
+    staging restore production
+
+Open a console:
+
+    production console
+    staging console
+
+Open [log2viz][1]:
+
+    production log2viz
+    staging log2viz
+
+Migrate a database and restart the dynos:
+
+    production migrate
+    staging migrate
+
+Tail a log:
+
+    production tail
+    staging tail
+
+The scripts also pass through, so you can do anything with them that you can do
+with `heroku ______ --remote staging` or `heroku ______ --remote production`:
+
+    watch production ps
+    staging open
+
+Convention
+----------
+
+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
+  `['development']['database']`.
+* The Heroku apps are named like `app-staging` and `app-production`
+  where `app` is equal to `basename $PWD`.
+
+Configuration
+-------------
+
+Override some of the conventions:
+
+```ruby
+Parity.configure do |config|
+  config.database_config_path = 'different/path.yml'
+  config.heroku_app_basename = 'different-base-name'
+end
+```
+
+Credits
+-------
+
+Parity is maintained by Dan Croak. It is free software and may be redistributed
+under the terms specified in the LICENSE file.
+
+[1]: https://blog.heroku.com/archives/2013/3/19/log2viz

data/bin/development

@@ -2,4 +2,8 @@
 
 require File.join(File.dirname(__FILE__), '..', 'lib', 'parity')
 
-Parity::Development.new(ARGV).run
+if ARGV.empty?
+  puts Parity::Usage.new
+else
+  Parity::Development.new(ARGV).run
+end

data/bin/production

@@ -2,4 +2,8 @@
 
 require File.join(File.dirname(__FILE__), '..', 'lib', 'parity')
 
-Parity::Production.new(ARGV).run
+if ARGV.empty?
+  puts Parity::Usage.new
+else
+  Parity::Production.new(ARGV).run
+end

data/bin/staging

@@ -2,4 +2,8 @@
 
 require File.join(File.dirname(__FILE__), '..', 'lib', 'parity')
 
-Parity::Staging.new(ARGV).run
+if ARGV.empty?
+  puts Parity::Usage.new
+else
+  Parity::Staging.new(ARGV).run
+end

data/lib/parity.rb

@@ -1,3 +1,7 @@
+require 'parity/configuration'
 require 'parity/development'
 require 'parity/staging'
 require 'parity/production'
+require 'parity/usage'
+
+Parity.configure

data/lib/parity/backup.rb

@@ -2,7 +2,7 @@ require 'yaml'
 
 module Parity
   class Backup
-    def initialize(from, to)
+    def initialize(from: from, to: to)
       @from = from
       @to = to
     end
@@ -20,16 +20,23 @@ module Parity
     attr_reader :from, :to
 
     def restore_to_development
-      system %{
-        curl -s `#{db_backup_url}` | \
-        pg_restore --verbose --clean --no-acl --no-owner -d #{development_db}
-      }
+      Kernel.system "#{curl} | #{pg_restore}"
+    end
+
+    def curl
+      "curl -s `#{db_backup_url}`"
+    end
+
+    def pg_restore
+      "pg_restore --verbose --clean --no-acl --no-owner -d #{development_db}"
     end
 
     def restore_to_pass_through
-      system %{
-        heroku pgbackups:restore DATABASE `#{db_backup_url}` --remote #{to}
-      }
+      Kernel.system "heroku pgbackups:restore #{backup_from} --remote #{to}"
+    end
+
+    def backup_from
+      "DATABASE `#{db_backup_url}`"
     end
 
     def db_backup_url
@@ -37,7 +44,8 @@ module Parity
     end
 
     def development_db
-      YAML.load(IO.read('config/database.yml'))['development']['database']
+      yaml_file = IO.read(Parity.config.database_config_path)
+      YAML.load(yaml_file)['development']['database']
     end
   end
 end

data/lib/parity/configuration.rb

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

data/lib/parity/development.rb

@@ -4,14 +4,13 @@ require 'parity/environment'
 module Parity
   class Development < Environment
     def initialize(subcommands)
-      @environment = 'development'
-      super(subcommands)
+      super 'development', subcommands
     end
 
     private
 
     def restore
-      Backup.new(arguments.first, 'development').restore
+      Backup.new(from: arguments.first, to: 'development').restore
     end
   end
 end

data/lib/parity/environment.rb

@@ -1,51 +1,52 @@
 module Parity
   class Environment
-    def initialize(subcommands)
-      @subcommand = subcommands[0]
-      @arguments = subcommands[1..-1]
+    def initialize(environment, subcommands)
+      self.environment = environment
+      self.subcommand = subcommands[0]
+      self.arguments = subcommands[1..-1]
     end
 
     def run
       if self.class.private_method_defined?(subcommand)
         send(subcommand)
       else
-        system "heroku #{pass_through} --remote #{environment}"
+        Kernel.system "heroku #{pass_through} --remote #{environment}"
       end
     end
 
     private
 
-    attr_reader :environment, :subcommand, :arguments
+    attr_accessor :environment, :subcommand, :arguments
 
     def backup
-      system "heroku pgbackups:capture --expire --remote #{environment}"
+      Kernel.system "heroku pgbackups:capture --expire --remote #{environment}"
     end
 
     def console
-      system "heroku run console --remote #{environment}"
+      Kernel.system "heroku run console --remote #{environment}"
     end
 
     def log2viz
-      system "open https://log2viz.herokuapp.com/app/#{heroku_app_name}"
+      Kernel.system "open https://log2viz.herokuapp.com/app/#{heroku_app_name}"
     end
 
     def migrate
-      system %{
+      Kernel.system %{
         heroku run rake db:migrate --remote #{environment} &&
         heroku restart --remote #{environment}
       }
     end
 
     def tail
-      system "heroku logs --tail --remote #{environment}"
+      Kernel.system "heroku logs --tail --remote #{environment}"
     end
 
     def heroku_app_name
-      [app_name, environment].join('-')
+      [basename, environment].join('-')
     end
 
-    def app_name
-      Dir.pwd.split('/').last
+    def basename
+      Parity.config.heroku_app_basename || Dir.pwd.split('/').last
     end
 
     def pass_through

data/lib/parity/production.rb

@@ -3,8 +3,7 @@ require 'parity/environment'
 module Parity
   class Production < Environment
     def initialize(subcommands)
-      @environment = 'production'
-      super(subcommands)
+      super 'production', subcommands
     end
   end
 end

data/lib/parity/staging.rb

@@ -4,14 +4,13 @@ require 'parity/environment'
 module Parity
   class Staging < Environment
     def initialize(subcommands)
-      @environment = 'staging'
-      super(subcommands)
+      super 'staging', subcommands
     end
 
     private
 
     def restore
-      Backup.new(arguments.last, 'staging').restore
+      Backup.new(from: arguments.last, to: 'staging').restore
     end
   end
 end

data/lib/parity/usage.rb

@@ -0,0 +1,13 @@
+module Parity
+  class Usage
+    def to_s
+      File.read(readme).match(/Usage\n-----\n([^\/.]*)Convention/)[1]
+    end
+
+    private
+
+    def readme
+      File.join(File.dirname(__FILE__), '..', '..', 'README.md')
+    end
+  end
+end

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: parity
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dan Croak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-08-03 00:00:00.000000000 Z
 dependencies: []
-description: ! "    Devevelopment/staging/production parity is intended to decrease
-  the time\n    between a developer writing code and having it deployed, make it possible\n
-  \   for the same people who wrote the code to deploy it and watch its behavior\n
-  \   in production, and reduce the number of tools necessary to manage.\n"
+description: |2
+      Devevelopment/staging/production parity is intended to decrease the time
+      between a developer writing code and having it deployed, make it possible
+      for the same people who wrote the code to deploy it and watch its behavior
+      in production, and reduce the number of tools necessary to manage.
 email:
 - dan@thoughtbot.com
 executables:
@@ -23,12 +24,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/parity.rb
 - lib/parity/backup.rb
+- lib/parity/configuration.rb
 - lib/parity/development.rb
 - lib/parity/environment.rb
 - lib/parity/production.rb
 - lib/parity/staging.rb
+- lib/parity/usage.rb
 - bin/development
 - bin/staging
 - bin/production
@@ -42,19 +46,18 @@ 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.0.0
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Shell commands for development, staging, and production parity.
 test_files: []
-has_rdoc: