kapost-bootstrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e5522302446bcfaf58d7002c434604292e18b70
+  data.tar.gz: 318f1caef8803908f9514eed27233388eee37e03
+SHA512:
+  metadata.gz: c7a11d08ba699dd4d37f61a0f988803ff8ea895df9bcc9313901cc15353ce870610fa493c61a56b509d7593cbcc938b2ffdfd362ce3fb7c515de060a4aa45627
+  data.tar.gz: 3a1e4d724f84650cf8c680e6484c960bad44b4760aad89c53f34628b210a3a9b3c92f019111bcf794e4515db0b2e071c8bbf8c6b70ed2dcc53d1a1fb3207d0b0

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kapost-bootstrapper.gemspec
+gemspec
+
+group :development, :test do
+  gem "guard"
+  gem "guard-rspec"
+end

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -0,0 +1,121 @@
+# Kapost::Bootstrapper
+
+Used by Kapost apps to get themselves bootstrapped. To enhance developer happiness, every app should have a single command to get it set up (`./bin/setup`) and one command to run the whole thing (`./bin/run`). This gem attempts to help with the first script by encapsulating a useful set of helper functions that makes detecting and installing dependencies simpler.
+
+## Installation
+
+Add a file to your project called `bin/setup` with these contents:
+
+```bash
+#!/usr/bin/env bash
+
+set -euvxo pipefail
+
+gem which kapost-bootstrapper || gem install kapost-bootstrapper
+
+./bin/bootstrap
+```
+
+Then, use the gem's helper functions in your file called `./bin/bootstrap`. See usage for examples.
+
+## Usage
+
+Example `./bin/bootstrap`:
+
+```ruby
+#!/usr/bin/env/ruby
+
+require "pathname"
+
+require "kapost/bootstrapper"
+
+$LOAD_PATH << File.join(__dir__, "..", "lib")
+app_root = Pathname.new File.expand_path("../../",  __FILE__)
+
+Kapost::Bootstrapper.new do
+  puts "== Checking application dependencies =="
+
+  # only run these commands on this platform. See also `#ubuntu`.
+  osx do
+
+    # `check` looks for the command specified by name, and prints the help if
+    # it isn't present.
+    check "brew", "Homebrew isn't installed. How did you even get this far?"
+  end
+
+  # The optional `version` attempts to do a substring match on `{cmd} --version`.
+  # Also note the use of HEREDOC for the help string.
+  required_ruby_version = File.read(app_root.join(".ruby-version")).strip
+  check "ruby", <<~HELP, version: required_ruby_version
+    Wrong Ruby version, please install #{required_ruby_version}, and make
+    sure it is the current Ruby.  The DevOps team recommends
+    [chruby](https://github.com/postmodern/chruby#readme) and
+    [ruby-install](https://github.com/postmodern/ruby-install#readme). Both
+    are available in Homebrew.
+  HELP
+
+  # When `#check` is given a block, it is executed rather than the built-in check.
+  # If the block returns true-ish, it is assumed to have worked, and the bootstrap
+  # process continues. When false-ish, the help is printed and boostrap is halted.
+  check "elasticsearch" do
+    # The `#installed?` helper does the same as the default `#check`, and merely checks
+    # if the command is available.
+    if installed?("elasticsearch")
+      true
+    else
+      # Use `#sh` to execute shell commands.
+      osx    { sh "brew install elasticsearch" }
+      ubuntu { sh "apt-get install elasticsearch" }
+    end
+  end
+
+  check "postgresql" do
+    if installed?("psql")
+      true
+    else
+      osx    { sh "brew install postgresql" }
+      ubuntu { sh "apt-get install postgresql" }
+    end
+  end
+
+  # `#check_bundler` checks if Bundler is installed, and installs it if not.
+  # `#bundle` does exactly what you'd think.
+  check_bundler && bundle
+
+  # Test if an environment variable is present
+  check "env", <<~HELP do
+    You need to load the environment variables located in `.env` into your
+    local shell environment.  The DevOps team recommends
+    [direnv](http://direnv.net/) (available in homebrew).
+  HELP
+    !ENV["PORT"].nil?
+  end
+
+  # Check different variables, with different instructions.
+  check "AWS tokens", <<~HELP do
+    You need to set "AWS_REGION", "AWS_ACCESS_KEY_ID" and
+    "AWS_SECRET_ACCESS_KEY" in your local shell environment. Contact the
+    #devops channel if you don't already have some. The DevOps team recommends
+    setting them in a `.env.local` file, and using [direnv](http://direnv.net/)
+    (available in homebrew) to load them.
+  HELP
+    !ENV["AWS_ACCESS_KEY_ID"].nil?
+  end
+
+  # At this point, all dependencies are assumed to be installed, and the app should be
+  # bootable. Do some further checks and setup, like verifying DB connections and
+  # migrating, etc...
+  sh "rake setup"
+end
+```
+
+## 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/kapost/kapost-bootstrapper.
+

data/Rakefile

@@ -0,0 +1,6 @@
+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 "kapost/bootstrapper"
+
+# 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 -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kapost-bootstrapper.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kapost/bootstrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kapost-bootstrapper"
+  spec.version       = Kapost::Bootstrapper::VERSION
+  spec.authors       = ["Paul Sadauskas"]
+  spec.email         = ["paul@sadauskas.com"]
+
+  spec.summary       = %q{A small helper utility for your app to declare and setup its system dependencies}
+  spec.homepage      = "https://github.com/kapost/kapost-bootstrapper"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/kapost/bootstrapper/version.rb

@@ -0,0 +1,5 @@
+module Kapost
+  class Bootstrapper
+    VERSION = "0.1.0"
+  end
+end

data/lib/kapost/bootstrapper.rb

@@ -0,0 +1,103 @@
+require "open3"
+
+module Kapost
+  # Application dependency installer for this Rails application.
+  class Bootstrapper
+    def initialize(cli: Open3, printer: $stdout, platform: RUBY_PLATFORM, shell: Kernel, &block)
+      @cli      = cli
+      @printer  = printer
+      @platform = platform
+      @shell    = shell
+
+      run(&block) if block_given?
+    end
+
+    def osx(&block)
+      instance_eval(&block) if os == :macosx
+    end
+
+    def check(command, help = nil, version: nil, &block)
+      success = say(label(command, version)) do
+        if block_given?
+          yield
+        else
+          installed?(command) and (!version or right_version?(command, version))
+        end
+      end
+
+      unless success
+        say(help) if help
+        shell.exit 1
+      end
+    end
+
+    def check_bundler
+      check "bundler" do
+        sh "gem install bundler --conservative", verbose: false
+      end
+    end
+
+    def bundle
+      check "gems" do
+        sh "bundle check || bundle install", verbose: false
+      end
+    end
+
+    def installed?(command)
+      _, status = cli.capture2e "type #{command}"
+      status.success?
+    end
+
+    def right_version?(command, expected_version)
+      version, status = cli.capture2e "#{command} --version"
+      status.success? && version.include?(expected_version)
+    end
+
+    def say(message)
+      if block_given?
+        # If we're given a block print a label with a success indicator
+        printer.print message.to_s
+        result = yield
+        result ? say("✓") : say("╳")
+        result
+      else
+        # Otherwise, just print the message
+        printer.puts message.to_s
+      end
+    end
+
+    def sh(*cmd)
+      options = (Hash === cmd.last) ? cmd.pop : {}
+      say(cmd.join(" ")) if options[:verbose]
+      result = system(*cmd)
+      status = $?
+      fail "Command `#{cmd.join(' ')}` failed with status #{status.exitstatus}" unless result
+      result
+    end
+
+    def run(&code)
+      instance_eval(&code)
+    end
+
+    private
+
+    attr_reader :cli, :printer, :platform, :shell
+
+    def label(text, version = nil)
+      "#{[text, version].compact.join(' ')}:".ljust(15)
+    end
+
+    def os
+      @os ||= case platform
+                when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+                  :windows
+                when /darwin|mac os/
+                  :macosx
+                when /linux/
+                  :linux
+                else
+                  fail "unknown os: #{RUBY_PLATFORM.inspect}"
+              end
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: kapost-bootstrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Sadauskas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-07 00:00:00.000000000 Z
+dependencies:
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- paul@sadauskas.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kapost-bootstrapper.gemspec
+- lib/kapost/bootstrapper.rb
+- lib/kapost/bootstrapper/version.rb
+homepage: https://github.com/kapost/kapost-bootstrapper
+licenses: []
+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: A small helper utility for your app to declare and setup its system dependencies
+test_files: []