heroku_rails_deploy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9735e2adea62cb3eb911e797afeaf47803517e44
+  data.tar.gz: db9355ebc07bf1013ef783aa782a4decd366cdd7
+SHA512:
+  metadata.gz: 240b8f705fc58112e1616a92147befa4469d545828aa14989eb84ce0bbae892b61a1c53778dc4fb3f9e47bf5b6fd26fdd6d5d6fb584728e3ade96af1b29a4a6b
+  data.tar.gz: abb3a2c9cc963ad7be67bea6c9bd924721fd4c41752dade7b2107590fcd778f67502498514560dbac3a304d6f190345c74e127fd9f101ad9f08ba9146482f159

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.overcommit.yml

@@ -0,0 +1,13 @@
+PreCommit:
+  RuboCop:
+    enabled: true
+    required: false
+    on_warn: fail
+
+  HardTabs:
+    enabled: true
+    required: false
+
+CommitMsg:
+  TrailingPeriod:
+    enabled: false

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  salsify_rubocop: conf/rubocop.yml

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# heroku_rails_deploy
+
+## v0.1.0
+- Initial version

data/Gemfile

@@ -0,0 +1,6 @@
+
+source 'https://gems.salsify.com'
+
+
+# Specify your gem's dependencies in heroku_rails_deploy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Salsify, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# HerokuRailsDeploy
+
+This gem provides a simple Heroku deploy script for Rails applications. Deploys
+following the following steps:
+
+1. Push code to Heroku
+2. If there are pending migrations, run them and restart the Heroku dynos
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'heroku_rails_deploy'
+end
+```
+
+Then execute:
+
+    $ bundle
+
+Then run the generator to create the deploy script and configuration file:
+
+    $ rails generate heroku_rails_deploy
+    
+Finally follow the instructions in `config/heroku.yml` to configure the 
+environments/Heroku applications for your project e.g.
+
+```yml
+production: my-app-prod
+staging: my-app-staging
+```
+
+## Usage
+
+From your application's root directory run the `bin/deploy` script with the `--help`
+argument to print usage:
+
+```
+$ bin/deploy --help
+Usage: deploy [options]
+    -e, --environment ENVIRONMENT    The environment to deploy to. Must be in production, staging (default production)
+    -r, --revision REVISION          The git revision to push. (default HEAD)
+    -h, --help                       Show this message
+```
+
+A typical deploy command will look something like:
+```
+$ bin/deploy --environment production
+```
+
+Note you can omit the environment to deploy to your default environment.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/salsify/heroku_rails_deploy.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'heroku_rails_deploy'
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -v
+
+bundle update
+
+overcommit --install

data/circle.yml

@@ -0,0 +1,15 @@
+machine:
+  ruby:
+    version:
+      2.3.1
+
+database:
+  override:
+    - echo 'nothing to setup'
+
+test:
+  override:
+    - bundle exec rubocop
+    - bundle exec rspec --format RspecJunitFormatter --out $CIRCLE_TEST_REPORTS/rspec/junit.xml --format progress spec
+  post:
+    - cp -R log $CIRCLE_ARTIFACTS

data/heroku_rails_deploy.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heroku_rails_deploy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'heroku_rails_deploy'
+  spec.version       = HerokuRailsDeploy::VERSION
+  spec.authors       = ['Salsify, Inc']
+  spec.email         = ['engineering@salsify.com']
+
+  spec.summary       = 'Simple deployment of Rails app to Heroku'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/salsify/heroku_rails_deploy'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rails'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'salsify_rubocop', '~> 0.42.0'
+  spec.add_development_dependency 'overcommit'
+
+  spec.add_development_dependency 'rspec_junit_formatter', '0.2.2'
+end

data/lib/generators/heroku_rails_deploy/heroku_rails_deploy_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators/base'
+
+class HerokuRailsDeployGenerator < Rails::Generators::Base
+  source_paths << File.join(File.dirname(__FILE__), 'templates')
+
+  def create_config_file
+    template('heroku.yml', 'config/heroku.yml')
+  end
+
+  def create_executable_file
+    template('deploy', 'bin/deploy')
+    chmod('bin/deploy', 0755)
+  end
+end

data/lib/generators/heroku_rails_deploy/templates/deploy

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require_relative '../config/boot'
+require 'heroku_rails_deploy'
+
+root_dir = File.absolute_path("#{__dir__}/..")
+HerokuRailsDeploy.deploy(root_dir, ARGV)

data/lib/generators/heroku_rails_deploy/templates/heroku.yml

@@ -0,0 +1,11 @@
+# A map from environment name to Heroku application name.
+# Entries should be of the form:
+#
+# <environment>: <heroku app name>
+#
+# The first environment mentioned will be the default
+# used for deploys that don't specify an environment.
+#
+# TODO: Update for your desired environments/Heroku applications
+# staging: my-service-staging
+# production: my-service-production

data/lib/heroku_rails_deploy.rb

@@ -0,0 +1,9 @@
+require 'heroku_rails_deploy/version'
+require 'heroku_rails_deploy/deployer'
+
+module HerokuRailsDeploy
+  def self.deploy(root_dir, args)
+    config_file = File.join(root_dir, 'config', 'heroku.yml')
+    Deployer.new(config_file, args).run
+  end
+end

data/lib/heroku_rails_deploy/deployer.rb

@@ -0,0 +1,103 @@
+require 'optparse'
+require 'yaml'
+
+module HerokuRailsDeploy
+  class Deployer
+    attr_reader :config_file, :args
+
+    class Options < Struct.new(:environment, :revision)
+      def self.create_default(app_registry)
+        new(app_registry.keys.first, 'HEAD')
+      end
+    end
+
+    def initialize(config_file, args)
+      @config_file = config_file
+      @args = args
+    end
+
+    def run
+      raise "Missing config file #{config_file}" unless File.file?(config_file)
+      app_registry = YAML.load(File.read(config_file))
+
+      options = Options.create_default(app_registry)
+      OptionParser.new do |parser|
+        parser.on_tail('-h', '--help', 'Show this message') do
+          puts parser
+          # rubocop:disable Lint/NonLocalExitFromIterator
+          return
+          # rubocop:enable Lint/NonLocalExitFromIterator
+        end
+
+        parser.on('-e', '--environment ENVIRONMENT',
+                  "The environment to deploy to. Must be in #{app_registry.keys.join(', ')} (default #{app_registry.keys.first})") do |environment|
+          options.environment = environment
+        end
+
+        parser.on('-r', '--revision REVISION',
+                  'The git revision to push. (default HEAD)') do |revision|
+          options.revision = revision
+        end
+      end.parse!(args)
+
+      app_name = app_registry.fetch(options.environment) do
+        raise OptionParser::InvalidArgument.new("Invalid environment '#{options.environment}'. " \
+          "Must be in #{app_registry.keys.join(', ')}")
+      end
+
+      puts "Pushing code to Heroku app #{app_name} for environment #{options.environment}"
+      push_code(app_name, options.revision)
+
+      puts 'Checking for pending migrations'
+      if pending_migrations?(app_name)
+        puts 'Running migrations'
+        run_migrations(app_name)
+        puts 'Restarting dynos'
+        restart_dynos(app_name)
+      else
+        puts 'No migrations required'
+      end
+    end
+
+    def push_code(app_name, revision)
+      run_command!("git push --force git@heroku.com:#{app_name}.git #{revision}:master")
+    end
+
+    def run_migrations(app_name)
+      run_heroku_command!(app_name, 'run rake db:migrate')
+    end
+
+    def restart_dynos(app_name)
+      run_heroku_command!(app_name, 'ps:restart')
+    end
+
+    def pending_migrations?(app_name)
+      !run_heroku_command(app_name, 'run rake db:abort_if_pending_migrations')
+    end
+
+    def run_heroku_command!(app_name, command)
+      success = run_heroku_command(app_name, command)
+      raise "Heroku command '#{command}' failed" unless success
+    end
+
+    def run_heroku_command(app_name, command)
+      cli_command = "heroku #{command} --app #{app_name}"
+      if command.start_with?('run ')
+        # If we're running a shell command, return the underlying
+        # shell command exit code
+        cli_command << ' --exit-code'
+      end
+      run_command(cli_command)
+    end
+
+    def run_command!(command)
+      success = run_command(command)
+      raise "Command '#{command}' failed" unless success
+    end
+
+    def run_command(command)
+      puts command
+      Bundler.with_clean_env { system(command) }
+    end
+  end
+end

data/lib/heroku_rails_deploy/version.rb

@@ -0,0 +1,3 @@
+module HerokuRailsDeploy
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: heroku_rails_deploy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Salsify, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: salsify_rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.42.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.42.0
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  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: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+description: Simple deployment of Rails app to Heroku
+email:
+- engineering@salsify.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- heroku_rails_deploy.gemspec
+- lib/generators/heroku_rails_deploy/heroku_rails_deploy_generator.rb
+- lib/generators/heroku_rails_deploy/templates/deploy
+- lib/generators/heroku_rails_deploy/templates/heroku.yml
+- lib/heroku_rails_deploy.rb
+- lib/heroku_rails_deploy/deployer.rb
+- lib/heroku_rails_deploy/version.rb
+homepage: https://github.com/salsify/heroku_rails_deploy
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple deployment of Rails app to Heroku
+test_files: []