abtion-scripts 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55e361f8696410094af177be969b938b133cfc23e61422888e9dc82579ddf46d
+  data.tar.gz: 62b021ccf44c0a177a8f2c47d37b66687eebfa892c883b79da2dfe44dcd66d87
+SHA512:
+  metadata.gz: 801de11d039b4d8799972a7b2d52ef56165e67bee921b39240bb795d1450a1e7dcc73cf0ff4c7ca0dd00726633b1a3fad214839669321cd53cddd8cd1280df8b
+  data.tar.gz: e003a9a147fdd1dd7cbfb0196c097477422b6a80094fcbae8ace7b1be9409c603586b57a77da84581c80e86b78a75851b48a5f0a55949ac86b826ad88abf0e38

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.pairs

@@ -0,0 +1,11 @@
+pairs:
+  eh: Erik Hanson; erik
+  erik: Erik Hanson
+  hm: Heather Moore; heather
+  heather: Heather Moore
+  db: David Balatero; dbalatero
+  david: David Balatero
+  bj: Bion Johnson; bion
+  bion: Bion Johnson
+email:
+  domain: abtion.io

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "jeweler"
+  gem 'pry'
+  gem 'pry-stack_explorer'
+  gem "rdoc"
+  gem "rspec"
+  gem "shoulda"
+  gem "simplecov"
+end

data/Gemfile.lock

@@ -0,0 +1,116 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    addressable (2.4.0)
+    binding_of_caller (0.8.0)
+      debug_inspector (>= 0.0.1)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    debug_inspector (0.0.3)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.5.0)
+    github_api (0.16.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      mime-types (>= 1.16, < 3.0)
+      oauth2 (~> 1.0)
+    hashie (3.6.0)
+    highline (2.0.2)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jeweler (2.3.9)
+      builder
+      bundler
+      git (>= 1.2.5)
+      github_api (~> 0.16.0)
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      psych
+      rake
+      rdoc
+      semver2
+    json (2.2.0)
+    jwt (2.2.1)
+    method_source (0.9.2)
+    mime-types (2.99.3)
+    mini_portile2 (2.4.0)
+    minitest (5.12.0)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    oauth2 (1.4.1)
+      faraday (>= 0.8, < 0.16.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-stack_explorer (0.4.9.3)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    psych (3.1.0)
+    rack (2.0.7)
+    rake (12.3.3)
+    rdoc (6.2.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    semver2 (3.4.2)
+    shoulda (3.6.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (~> 3.0)
+    shoulda-context (1.2.2)
+    shoulda-matchers (3.1.3)
+      activesupport (>= 4.0.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  pry
+  pry-stack_explorer
+  rdoc
+  rspec
+  shoulda
+  simplecov
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Abtion, A/S
+
+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,113 @@
+# abtion-scripts
+
+Handy scripts for developing. Initially built for projects based on [Abtion Rails](https://github.com/abtion/abtion-rails),
+but hopefully useful for other projects as well. 
+
+## Installation
+
+Add to your project's Gemfile:
+
+```ruby
+gem 'abtion-scripts'
+```
+
+
+## Getting help
+
+You can run `abtion help` at any time for a list of commands.
+
+Running `abtion help [command name]` will print specific help for that
+command.
+
+## Commands
+
+`abtion doctor` will run a bunch of checks to make sure all the project dependencies are met
+
+`abtion promote` will promote staging to production and run migrations on production
+
+`abtion update` will pull from git, bundle if necessary, migrate the DB if necessary, remove old logs, and restart Rails
+
+
+## Extending/adding commands to your project
+
+Any files in `.abtion/scripts/**/*.rb` will be automatically required
+by the `abtion` command on a per-project basis. Any overrides/extensions
+can be added in that directory.
+
+## Example of adding a project-specific command
+
+If you have a custom command you'd like to add, just put it in
+`.abtion/scripts/custom_command.rb`
+
+Each command needs to subclass `AbtionScripts::Base` and implement
+a `run` method.
+
+As an example, here's how you might override the `abtion test` command to
+add ESLint as a step:
+
+```ruby
+class CustomTest < AbtionScripts::Test
+  # override the default 'test' command by naming it
+  # the same
+  def self.name
+    "test"
+  end
+
+  def run
+    # Other scripts can be reused by calling .run
+    AbtionScripts::Rspec.run
+
+    # Adding a custom step to run eslint after RSpec runs
+    step "Running eslint" do
+      system! "bin/eslint"
+    end
+  end
+end
+```
+
+## Extending doctor
+
+Create a file called `.abtion/scripts/doctor.rb`, and as an example:
+
+```ruby
+class Doctor < AbtionScripts::Doctor
+  def run_checks
+    # Use built-in default checks, if still desired
+    run_default_checks
+
+    # Add a custom check
+    check_aws_configured
+  end
+
+  private
+
+  def check_aws_configured
+    check(
+      name: "AWS env configured",
+      command: "cat .envrc | grep AWS_ACCESS_KEY_ID",
+      remedy: "cp .envrc .env # and edit"
+    )
+  end
+end
+```
+
+If you want to cherry pick some of the default checks, you'll need
+to call each of their methods manually. For a list of default checks,
+run `abtion doctor list`. Then, create a `.abtion/scripts/doctor.rb` 
+file that looks something like this:
+
+```ruby
+class Doctor < AbtionScripts::Doctor
+  def run_checks
+    # Only run these two defaults
+    check_envrc_file_exists
+    check_phantomjs_installed
+
+    # Add any custom checks here...
+  end
+end
+```
+
+## Copyright
+
+Copyright (c) 2019 Abtion. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "abtion-scripts"
+  gem.homepage = "http://github.com/abtion/abtion-scripts"
+  gem.license = "MIT"
+  gem.summary = %Q{Abtion command-line scripts for easy testing and deployment}
+  gem.description = %Q{Abtion tools for easy building, testing, and deploying}
+  gem.email = "admin@abtion.com"
+  gem.authors = ["Heather Moore"]
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "abtion-scripts #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.1

data/abtion.yml

@@ -0,0 +1,5 @@
+# Sample abtion.yml
+
+heroku_app_names:
+  production: PROJECT-NAME-production
+  staging: PROJECT-NAME-staging

data/bin/abtion

@@ -0,0 +1,26 @@
+#! /usr/bin/env ruby
+
+require_relative '../lib/abtion_scripts'
+
+# Require any overrides or additional hooks for abtion here
+Dir.glob(".abtion/scripts/**/*.rb").each do |file|
+  require File.expand_path(file)
+end
+
+script = ARGV.first
+
+if ARGV.size == 0
+  AbtionScripts::Help.run
+elsif AbtionScripts::Base.script_names.include?(script)
+  AbtionScripts::Base
+    .scripts[script]
+    .run(*ARGV[1 .. -1])
+else
+  puts "Script '#{script}' not recognized"
+  AbtionScripts::Help.run
+
+  similar_commands = Levenstein.closest_match(script, AbtionScripts::Base.script_names)
+  puts
+  puts "Did you mean #{similar_commands.map{|c|"`#{c}`"}.join(' or ')} ?"
+  puts
+end

data/lib/abtion_scripts.rb

@@ -0,0 +1,7 @@
+module AbtionScripts; end
+
+require_relative './abtion_scripts/colorize'
+require_relative './abtion_scripts/base'
+
+search_path = File.dirname(__FILE__) + '/abtion_scripts/**/*.rb'
+Dir.glob(search_path).each { |path| require path }

data/lib/abtion_scripts/base.rb

@@ -0,0 +1,135 @@
+require 'pathname'
+require 'fileutils'
+require 'yaml'
+
+class AbtionScripts::Base
+  include AbtionScripts::Colorize
+  include FileUtils
+
+  attr_reader :argv
+
+  def initialize(*argv)
+    @argv = argv
+  end
+
+  def self.name
+    self
+      .to_s
+      .split('::')
+      .last
+      .gsub(/[A-Z]/, "-\\0")
+      .downcase[1..-1]
+  end
+
+  def self.inherited(klass)
+    AbtionScripts::Base.script_classes << klass
+  end
+
+  def self.script_classes
+    @script_classes ||= []
+  end
+
+  def self.scripts
+    @scripts ||= load_scripts_deferred
+  end
+
+  def self.load_scripts_deferred
+    script_classes.reduce(Hash.new) do |result, klass|
+      result[klass.name] = klass
+      result
+    end
+  end
+
+  def self.script_names
+    scripts.keys
+  end
+
+  def self.help
+    msg = <<-HELP
+Help has not been implemented for "#{name}". Please implement a help method like so:
+
+class #{self} < AbtionScripts::Base
+  def self.help
+    <<-EOF
+    My awesome help message here.
+
+    This will be so useful for people.
+    EOF
+  end
+end
+HELP
+
+    puts msg
+  end
+
+  def self.description
+    ""
+  end
+
+  def self.run(*args)
+    new(*args).run
+  end
+
+  # path to your application root.
+  def app_root
+    Pathname.new(Dir.pwd)
+  end
+
+  def run_script(name, *args)
+    script = AbtionScripts::Base.scripts[name.to_s]
+
+    if script.nil?
+      raise "Could not find script with name #{name.inspect} to run"
+    end
+
+    script.run(*args)
+  end
+
+  def rails?
+    File.exist?("config/application.rb")
+  end
+
+  def bundler?
+    File.exist?("Gemfile")
+  end
+
+  def yarn?
+    File.exist?("yarn.lock")
+  end
+
+  def ci?
+    # Set by Circle automatically:
+    # https://circleci.com/docs/1.0/environment-variables/#basics
+    ENV.has_key?('CI')
+  end
+
+  def system!(*args)
+    puts colorize(:command, args.join(" "))
+    system(*args) || abort(colorize(:error, "\n== Command #{args} failed =="))
+  end
+
+  def step(name)
+    puts colorize(:info, "\n== #{name} ==")
+    yield
+  end
+
+  def app_names
+    YAML.load_file('abtion.yml')['heroku_app_names']
+  end
+
+  def heroku_app_name(remote)
+    app_names[remote.to_s]
+  end
+
+  def heroku(command, remote:)
+    validate_heroku_remote(remote)
+    system! "heroku #{command} -r #{remote}"
+  end
+
+  private
+
+  def validate_heroku_remote(remote)
+    raise "Missing remote" if remote.nil?
+    raise "Unknown remote" unless %w[staging production].include?(remote.to_s)
+  end
+end