kaiser 0.0.0 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fca5130b0e2499829e856a1c50d3456620ae5d30
-  data.tar.gz: 454dcd8b92a260abc2071dadcb82446ff3515d04
+SHA256:
+  metadata.gz: 9f8047763773bfe748430378babb51a03b464f203653f65b18c914c9dcc0fc5d
+  data.tar.gz: f5f4f0965aa9cd5f8b54e5812e8f5810cd96db4140bc5efcfb4483b04394cf81
 SHA512:
-  metadata.gz: 6a8015dbe99d1184d4c75aa4599e1334288c40622bb7ad3e973244e387c9c52480cc9a97d80f1398f276fc49145a94b2352b0c8026a0488dd53dec5424f43f03
-  data.tar.gz: bafeacb6d191595108857bbc33b519e3af18e359e7dfc3df52c2c942a952892ef6cbaa8fd8a5c5261c5486b6d23bf8681c6a6e8d2e8e31c91dba911613d4c87d
+  metadata.gz: 2c8500f56e296379d71bbde647cc5c55fdb44079d4ebf149ce2791c1b0aff279c590192baa02953d2b8c87c1a335796b84d410786a032aa0ba23ef059398477c
+  data.tar.gz: 1c301bf576a3b1eab3a6fa785b37a9e58afa0c35c2bc9ede6c10bc6bea8a38c87f89fee1817d8dd6938ca32d2d4d667feff7638eeb1f7316b6a203c69be7713c

data/README.md

@@ -0,0 +1,129 @@
+# Kaiser
+
+Welcome to Kaiser! Kaiser will mind-control all your monsters and make them even more effective.
+
+Kaiser lets you define how an application starts, so trying out a web application simply reduces to a `kaiser up`
+
+## Installation (Traditional)
+
+1. Download and setup [Docker](https://www.docker.com/get-started)
+
+2. Add this line to your application's Gemfile:
+
+```ruby
+gem 'kaiser', git: "https://github.com/degica/kaiser"
+```
+
+3. Execute:
+
+    ```$ bundle```
+
+    Or install it yourself as:
+
+        $ gem install specific_install
+        $ gem specific_install -l https://github.com/degica/kaiser
+
+## Installation (Docker)
+
+You can install Kaiser as a docker image on your machine too!
+
+Simply clone the repo and run 
+
+```
+cd kaiser
+docker build -t degica/kaiser . 
+```
+
+And then add the following line to your `.bashrc` or `.bash_profile`
+
+```
+alias kaiser='docker run --rm -ti -v /var/run/docker.sock:/var/run/docker.sock -v $HOME/.kaiser:/root/.kaiser -v `pwd`:`pwd` -e CONTEXT_DIR="`pwd`" degica/kaiser'
+```
+
+Or if you use fish
+
+```
+function kaiser
+  docker run --rm -ti -v /var/run/docker.sock:/var/run/docker.sock -v $HOME/.kaiser:/root/.kaiser -v (pwd):(pwd) -e CONTEXT_DIR=(pwd) degica/kaiser $argv
+end
+```
+
+## Usage
+
+You'll need a Dockerfile and a Kaiserfile. The Kaiserfile should be placed in the project root directory, with contents like this:
+
+```ruby
+# Example Kaiserfile for a Rails app
+
+dockerfile "Dockerfile.kaiser"
+
+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 kaiser init myapp
+bundle exec kaiser 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://tech.degica.com/kaiser.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/degica/kaiser. 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 Kaiser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/degica/kaiser/blob/master/CODE_OF_CONDUCT.md).

data/exe/kaiser

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optimist'
+require 'fileutils'
+require 'yaml'
+require 'json'
+require 'pty'
+require 'erb'
+
+require 'kaiser'
+
+sub_command_strings = Kaiser::SUB_COMMANDS.keys.map(&:to_s)
+
+Kaiser::SUB_COMMANDS.each { |k, v| Kaiser::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 `kaiser -h` for full help messages and `kaiser 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 Kaiser's debug output", { short: '-v' }],
+  [:quiet, 'Suppress all output', { short: '-q' }]
+]
+
+parser = Optimist::Parser.new do
+  version "Kaiser v#{Kaiser::VERSION}"
+
+  banner <<~BANNER
+    #{version}
+
+    Kaiser is a tool to make development a lot easier by defining how an application starts using a \`Kaiserfile\` in the source code's root directory.
+
+    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.
+
+    \`\`\`
+    kaiser init ENV_NAME
+    kaiser up
+    kaiser 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
+    ===========
+
+    - #{Kaiser::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
+  Kaiser::Cli.run_command(:"#{cmd}", global_opts)
+rescue Kaiser::Error => e
+  puts ''
+  puts e.message
+end
+
+puts ''

data/lib/kaiser/after_dotter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Kaiser
+  # 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