heighliner 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2652edf0b183383b89645cee4e2d22210c2099773c124fdfb44073dd9755be47
+  data.tar.gz: ae906d0864fd3f2ceca23cb94c1675ffcf219a4ec4fd3de3082fbaf64a0cd4eb
+SHA512:
+  metadata.gz: 4134df6ece248fc364167114265cef9bbe7b39bb4b7746a0d0cbb23f1e0dc22b816d27093295edcc441fe2f0a5fd1e08ccac77cfe03fb37e44e7035a136f8753
+  data.tar.gz: 14d9595f84c5e5f545f942e6ce702bb0c8d97fc2e6603547a46c750caec41a32ebc7285059711b2e960a821d795da5f8ae36d814dd39fd289da071ef60fa3de6

data/README.md

@@ -0,0 +1,182 @@
+# Heighliner
+
+Heighliner is a tool that allows you to describe your web application using a Steerfile.
+
+This removes the guesswork of setting up a web application for development and gives teams an edge by allowing new developers on a system to hit the ground running, as well as propagate any changes in settings to other developers via source code.
+
+The Steerfile gives you an immense amount of control on how you want your application set up.
+
+# Dependencies
+
+Heighliner depends on Docker
+
+# Installation
+
+## Installation (Docker)
+
+Simply add the following line to your `.bashrc` or `.bash_profile` or '.zshrc'
+
+```
+alias heighliner='docker run --pull=always --rm -ti -v /var/run/docker.sock:/var/run/docker.sock -v $HOME/.heighliner:/root/.heighliner -v `pwd`:`pwd` -e _HEIGHLINER_USER_HOME=$HOME -e _HEIGHLINER_POS=docker -e CONTEXT_DIR="`pwd`" davidsiaw/heighliner'
+```
+
+Or if you use fish
+
+```
+function heighliner
+  docker run --pull=always --rm -ti -v /var/run/docker.sock:/var/run/docker.sock -v $HOME/.heighliner:/root/.heighliner -v (pwd):(pwd) -e _HEIGHLINER_USER_HOME=$HOME -e _HEIGHLINER_POS=docker -e CONTEXT_DIR=(pwd) davidsiaw/heighliner $argv
+end
+```
+
+Confirm it is working by running
+
+```
+heighliner -h
+```
+
+## Installation (Plain)
+
+Execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install specific_install
+$ gem specific_install -l https://github.com/davidsiaw/heighliner
+```
+
+## Building the docker container
+
+You can build the Heighliner image on your machine if you want
+
+Simply clone the repo and run 
+
+```
+cd heighliner
+bundle
+docker build -t davidsiaw/heighliner . 
+```
+
+And then
+
+# Usage
+
+You'll need a Dockerfile and a Steerfile. The Steerfile should be placed in the project root directory, with contents like this:
+
+```ruby
+# Example Steerfile for a Rails app
+
+dockerfile "Dockerfile"
+
+db "mysql:5.6",
+  port: 3306,
+  data_dir: "/var/lib/mysql",
+  params: "-e MYSQL_ROOT_PASSWORD=test123",
+  commands: ""
+
+app_params "-e DATABASE_URL=mysql2://root:test123@<%= db_container_name %>"
+
+expose "9000"
+db_reset_command "bin/rails db:reset"
+```
+
+```dockerfile
+FROM ruby:alpine
+
+COPY . /app
+RUN apk update && apk add build-base
+RUN gem install bundler
+RUN bundle install
+
+EXPOSE "3000"
+
+CMD ["sh", "-c", "rails -b 0.0.0.0 -p 3000"]
+```
+
+Then go to your repo's root folder and go
+
+```sh
+bundle exec heighliner init myapp
+bundle exec heighliner up
+```
+
+Once its done, simply
+
+```sh
+open http://myapp.lvh.me
+```
+
+And enjoy previewing your app!
+
+## More documentation
+
+You can find even more documentation in https://davidsiaw.github.io/heighliner.
+
+If you wish to read a HTML version of this documentation you can go:
+
+```
+cd docs
+bundle install
+bundle exec weaver
+```
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+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).
+
+### Using Heighliner with docker
+
+You can use heighliner without ruby. if you have docker installed use the following aliases in your .bashrc or .zshrc
+
+**Normal way:**
+
+```
+alias heighliner='docker run --rm -ti \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  -v $HOME/.heighliner:/root/.heighliner \
+  -v `pwd`:`pwd` \
+  -e _HEIGHLINER_USER_HOME=$HOME \
+  -e _HEIGHLINER_POS=docker \
+  -e CONTEXT_DIR="`pwd`" \
+  davidsiaw/heighliner'
+```
+
+
+**With certificates stored in 1password:**
+
+If you have your local dev SSL certificates stored in 1password, but you want to use the docker version you can use them this way.
+
+if you put your personal service account token in 1password you can just read them out like this.
+
+```
+alias heighliner='docker run --rm -ti \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  -v $HOME/.heighliner:/root/.heighliner \
+  -v `pwd`:`pwd` \
+  -e _HEIGHLINER_USER_HOME=$HOME \
+  -e _HEIGHLINER_POS=docker \
+  -e CONTEXT_DIR="`pwd`" \
+  -e OP_SERVICE_ACCOUNT_TOKEN=`op read op://Private/local-dev/credential` \
+  davidsiaw/heighliner'
+```
+
+Create the token in 1Password web app: Integrations → Developer Tools → Service Accounts.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/davidsiaw/heighliner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Heighliner project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/davidsiaw/heighliner/blob/master/CODE_OF_CONDUCT.md).

data/exe/heighliner

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optimist'
+require 'fileutils'
+require 'yaml'
+require 'json'
+require 'erb'
+
+require 'heighliner'
+
+sub_command_strings = Heighliner::SUB_COMMANDS.keys.map(&:to_s)
+
+Heighliner::SUB_COMMANDS.each { |k, v| Heighliner::Cli.register(k, v) }
+
+# It was difficult to allow global arguments like -v and -q to be typed both before and after cmds
+# and still support `heighliner -h` for full help messages and `heighliner subcmd -h` for focused messages.
+# Putting the global options in an array, using an Optimist::Parser and basically everything up to
+# the 'end parser hacks' comment are all hacks to marry the above two behaviours.
+
+global_opts = [
+  [:verbose, "Show Heighliner's debug output", { short: '-v' }],
+  [:quiet, 'Suppress all output', { short: '-q' }]
+]
+
+parser = Optimist::Parser.new do
+  version "Heighliner v#{Heighliner::VERSION}"
+
+  banner <<~BANNER
+    #{version}
+
+    Heighliner is a tool to make development a lot easier by defining how an application starts using a Steerfile in the source code's root directory.g
+
+    Prerequisites
+    =============
+
+    Install docker on your system and make sure the current user has all the rights required to spin up docker containers.
+
+    Usage
+    =====
+
+    For typical usage you'll want to do the following three commands.
+
+    \`\`\`
+    heighliner init ENV_NAME
+    heighliner up
+    heighliner attach
+    \`\`\`
+
+    This will boot up your application in docker and bind mount your local source directory so you can start doing development. Happy coding!
+
+    If any of these commands are giving you trouble, please run them with the \`-v\` flag set. They will show you what exactly is happening so you can debug.
+
+    Subcommands
+    ===========
+
+    - #{Heighliner::SUB_COMMANDS.keys.join("\n- ")}
+
+    Type \`SUB_COMMAND -h\` for help with specific subcommands.
+
+    Global Parameters
+    =================
+  BANNER
+
+  global_opts.each { |o| opt(*o) }
+end
+
+commands = sub_command_strings & ARGV
+
+if commands.empty?
+  Optimist.with_standard_exception_handling parser do
+    raise Optimist::HelpNeeded
+  end
+end
+
+cmd = commands.first
+## end parser hacks ##
+
+begin
+  Heighliner::Cli.run_command(:"#{cmd}", global_opts)
+rescue Heighliner::Error => e
+  puts ''
+  puts e.message
+end
+
+puts ''

data/lib/heighliner/after_dotter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Heighliner
+  # Prints properly after a dotter prints
+  class AfterDotter
+    def initialize(dotter:, channel: $stderr)
+      @channel = channel
+      @dotter = dotter
+    end
+
+    def puts(value)
+      if @dotter.dotted
+        @dotter.dotted = false
+        @channel.puts ''
+      end
+      @channel.puts(value)
+    end
+
+    def flush
+      @channel.flush
+    end
+  end
+end