ruby_yacht 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 724d4833d4fccb763b4173463fd4d39a6c72b5af
-  data.tar.gz: 385d64ac428190fe57096eeb5382f03fd3de4099
+  metadata.gz: a361c6c7a0ed8037cf5030012a0817839bf6b2ff
+  data.tar.gz: e2fecb59ced73e241e268cd601dcfdd80e16aa2b
 SHA512:
-  metadata.gz: 3acb66557ac774872c8548f5afc9bb3e9a0e5fa5b189e5c2846e19eed7e3afbe1f7ee3b7345140ace4ae838d5b2315f538a53745219896f7ee94a06b1c9f35d1
-  data.tar.gz: fad7d2289310ee0c3ffed0f02250d1c86060bdf0f64ea3c1190c343eaa05a965595e2b15aa3fdd54807f458303244807235d1aceae57031f449cc7578ff519f9
+  metadata.gz: ecd0d6522211c695a253bb86a45de1fc8a8a9f4f13cce0e19b4f9c7b9e3b96506d2792b4d12972571813a19360f4a7b0f304cb2e2d285d3abd60171cb2a9eb21
+  data.tar.gz: 4880e951c8696e057546ca1801c2e44f26850db49af1a8c611c8d04c08ed9e8b8f102d1c25219aea7b129530731ca8f13676f1384847022d965d5b9bcae34c16

data/.gitignore

@@ -1,6 +1,8 @@
 tmp
+log/*.txt
 *.gem
 doc/coverage
 doc/code
 doc/yard
-.yardoc
+.yardoc
+.byebug_history

data/.rdoc_options

@@ -4,14 +4,20 @@ static_path: []
 rdoc_include:
 - "."
 charset: UTF-8
-exclude: 
-- "spec"
+exclude:
 - ".gem"
 - ".gemspec"
 - "nohup.out"
 - "Gemfile"
 - "doc/coverage"
 - "doc/yard"
+- "doc/code"
+- "lib/ruby_yacht/images"
+- "lib/ruby_yacht/plugins/mysql/scripts"
+- "lib/ruby_yacht/plugins/rails/scripts"
+- "log" 
+- "spec"
+- "tmp"
 hyperlink_all: false
 line_numbers: false
 locale: 

data/.rspec

@@ -1 +1,2 @@
 --color
+-t ~integration

data/.travis.yml

@@ -1,4 +1,20 @@
+sudo: required
+services:
+  - docker
+
 language: ruby
 rvm:
   - 2.2
-script: bundle exec rspec spec
+
+before_install:
+  - sudo apt-get -o Dpkg::Options::="--force-confnew" install -y docker-engine
+  - docker version
+  - echo -e $SSH_ID_RSA > ~/.ssh/id_rsa
+  - chmod 600 ~/.ssh/id_rsa
+script:
+  - bash spec/docker/run.bash -O /dev/null
+
+notifications:
+  email:
+    recipients:
+      - mail@johnbrownlee.com

data/Gemfile.lock

@@ -1,16 +1,22 @@
 PATH
   remote: .
   specs:
-    ruby_yacht (0.4.3)
+    ruby_yacht (0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.2.0)
+    byebug (9.0.0)
     codeclimate-test-reporter (0.5.0)
       simplecov (>= 0.7.1, < 1.0.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
     json (1.8.3)
+    parser (2.3.1.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
@@ -24,21 +30,31 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
+    rubocop (0.40.0)
+      parser (>= 2.3.1.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.0)
     simplecov (0.11.2)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     timecop (0.8.1)
+    unicode-display_width (1.0.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug
   codeclimate-test-reporter
   rspec
+  rubocop
   ruby_yacht!
   timecop
 
 BUNDLED WITH
-   1.11.2
+   1.12.2

data/README.md

@@ -27,11 +27,19 @@ Enter this in the file:
         
 Your `run.rb` file will have two parts: A configuration block and the `Runner`
 command. The configuration block defines your projects and your apps. You can
-read [the configuration documentation](/gems/ruby_yacht/file/doc/configuration.md)
+read [the configuration documentation](http://www.rubydoc.info/gems/ruby_yacht/file/doc/configuration.md)
 for more information on the configuration options.
 
 The runner command invokes a RubyYacht script based on the command information.
 
+You can also use the `ruby_yacht` command to generate a new project:
+
+        ruby_yacht new test test-config
+
+This will generate a `run.rb` file in `test-config/run.rb`, with sample config
+for a project called `test`. You can then fill it in with the details of your
+applications, as explained in the configuration documentation.
+
 # RubyYacht Scripts
 
 RubyYacht provides several scripts to build and manage your application
@@ -70,7 +78,7 @@ it will build the following images:
 
 <table>
   <tr>
-    <td>apollo-app-dependencies</td>
+    <td>apollo-rails-app-dependencies</td>
     <td>
       An image with mars and saturn checked out, and all of their dependencies
       installed
@@ -98,7 +106,15 @@ it will build the following images:
     </td>
   </tr>
   <tr>
-    <td>jupiter-app-dependencies</td>
+    <td>apollo-web</td>
+    <td>
+      An image with nginx installed, and set up to proxy the app containers for
+      apollo-mars and apollo-saturn. Each app will get a subdomain of the
+      project's main domain, with the subdomain named after the app.
+    </td>
+  </tr>
+  <tr>
+    <td>jupiter-rails-app-dependencies</td>
     <td>
       An image with venus and saturn checked out, and all of their dependencies
       installed
@@ -119,12 +135,10 @@ it will build the following images:
     </td>
   </tr>
   <tr>
-    <td>apollo-web</td>
+    <td>jupiter-web</td>
     <td>
       An image with nginx installed, and set up to proxy the app containers for
-      apollo-mars, apollo-saturn, jupiter-venus, and jupiter-saturn. Each app
-      will get a subdomain of the project's main domain, with the subdomain named
-      after the app.
+      jupiter-venus and jupiter-saturn.
     </td>
   </tr>
 </table>
@@ -198,9 +212,13 @@ any additional commands you pass it will be forwarded to the container and run.
 
 For instance, you can run `ruby run.rb shell mars` to open a bash shell in the
 mars app container, or `ruby run.rb shell mars rails c` to open a
-rails console, or `ruby run.rb shell mars tail -f log/development.log` to start
+rails console, or `ruby run.rb shell mars "tail -f log/development.log"` to start
 reading all the content printed to the development log file.
 
+If the command you want to run has any flags in it, like the `-f` above, you
+must enclose the command in quotes to prevent RubyYacht from trying to consume
+that as a flag of its own.
+
 ### checkout
 
 This checks out a new branch inside an app container, and restarts the app
@@ -212,7 +230,7 @@ the latest changes from the repository.
 
 # Plugins and Customization
 
-RubyYacht has a [plugin API](/gems/ruby_yacht/file/doc/plugins.md) for
+RubyYacht has a [plugin API](http://www.rubydoc.info/gems/ruby_yacht/file/doc/plugins.md) for
 customizing the behavior of your scripts. You can use plugins for defining new
 app types or database types, or for adding hooks for the built-in types. This
 plugin API is so powerful that all of the rails-specific and mysql-specific code
@@ -221,5 +239,5 @@ in RubyYacht is provided through plugins.
 # Additional Information
 
 If you're interested in contributing to the project, you can find more
-information in [the contributing documentation](/gems/ruby_yacht/file/doc/contributing.md).
+information in [the contributing documentation](http://www.rubydoc.info/gems/ruby_yacht/file/doc/contributing.md).
 You can also reach out to me on Twitter [@brownleej](https://twitter.com/brownleej)

data/bin/ruby_yacht

@@ -0,0 +1,5 @@
+#! /usr/bin/ruby
+
+require 'ruby_yacht'
+RubyYacht::Runner.load_default_commands(false)
+RubyYacht::Runner.run

data/doc/TODO.md

@@ -3,23 +3,4 @@ for open tickets.
 
 # General
 
-* Do more testing with remote databases and non-development environments
-* Consider whether using the same web server for multiple projects is the best
-  approach
-* Look into issues with running shell command that has its own command-line
-  flags.
-* Create shorthands for loading config from external files.
-
-# Plugins
-
-* Better support for rails apps with no database
-* Configurable ports for database servers
-* Support for SQLite databases
-
-# More customization
-
-* Defining custom commands
-* Allowing customization points at different levels, like adding hooks to
-  individual apps
-* Customizing how we check out the repositories, so that people can use https
-  instead of SSH.
+* Test on Windows

data/doc/configuration.md

@@ -39,15 +39,6 @@ You can provide the following fields.
     <td><code>system_prefix :foo</code></td>
     <td>None; this is required.</td>
   </tr>
-  <tr>
-    <td>domain</td>
-    <td>
-      The main domain for this project. Different apps will be added as
-      subdomains of this main domain.
-    </td>
-    <td><code>domain 'test.com'</code></td>
-    <td>None; this is required.</td>
-  </tr>
   <tr>
     <td>repository</td>
     <td>
@@ -87,8 +78,8 @@ You can provide the following fields.
   </tr>
 </table>
 
-Inside a project block, you also define databases, DNS servers, and apps, as
-described below.
+Inside a project block, you also define databases, DNS servers, web servers,
+and apps, as described below.
 
 ### Plugin-Specific Fields
 
@@ -126,6 +117,15 @@ will also have the following fields:
     <td><code>rails_secret_key_base 'abc123'</code></td>
     <td>None; this is required</td>
   </tr>
+  <tr>
+    <td>rails_excluded_gem_groups</td>
+    <td>
+      The gem groups from the Gemfile that should not be installed on the
+      server.
+    </td>
+    <td><code>rails_excluded_gem_groups %w(development test)</code></td>
+    <td>An empty array</td>
+  </tr>
 </table>
 
 For more information about working with the default plugins, see
@@ -133,12 +133,13 @@ For more information about working with the default plugins, see
 
 # Adding Apps
 
-Inside the project DSL, you can call `app :mars, :rails` to add a Rails app
+Inside the project DSL, you can call `app :rails, :mars` to add a Rails app
 called `mars`. You can also call `rails_app :mars` to do the same thing. Both
 forms take a block, which allows you to call methods from `RubyYacht::App::DSL`.
 
 If you are using a different app type, you can supply that type instead of
-`rails`, but the app type must be defined through a [plugin](/gems/ruby_yacht/file/doc/plugins.md).
+`rails`, but the app type must be defined through a
+[plugin](http://www.rubydoc.info/gems/ruby_yacht/file/doc/plugins.md).
 
 You can call the `app` method multiple times to add multiple databases.
 
@@ -156,11 +157,20 @@ You can provide the following fields in the app DSL:
   <tr>
     <td>repository_name</td>
     <td>
-      The name of the code repository holding this app. This is relative to the
-      project's repository.
+      <p>
+        The name of the code repository holding this app. This is relative to
+        the project's repository.
+      </p>
+      <p>
+        If this is nil, then the scripts will create a new app instead of trying
+        to check out an existing one. When combined with the `check_out_locally`
+        flag on the project, this can be a good way to bootstrap new apps.
+      </p>
     </td>
     <td><code>repository_name 'brownleej/mars'</code></td>
-    <td>None; this is required</td>
+    <td>
+      nil
+    </td>
   </tr>
   <tr>
     <td>database_name</td>
@@ -188,15 +198,16 @@ You can provide the following fields in the app DSL:
 
 # Adding Databases
 
-Inside the project DSL, you can call `database :apollo, :mysql` to add a MySQL
+Inside the project DSL, you can call `database :mysql, :apollo` to add a MySQL
 database called `apollo`. You can also call `mysql_database :apollo` to do the
 same thing. Both forms take a block, which allows you to call methods from
 `RubyYacht::Database::DSL`.
 
 You can call the `database` method multiple times to add multiple databases.
 
-If you are using a different app type, you can supply that type instead of
-`mysql`, but the app type must be defined through a [plugin](/gems/ruby_yacht/file/doc/plugins.md).
+If you are using a different database type, you can supply that type instead of
+`mysql`, but the database type must be defined through a
+[plugin](http://www.rubydoc.info/gems/ruby_yacht/file/doc/plugins.md).
 
 ### Database Fields
 
@@ -235,6 +246,17 @@ If you are using a different app type, you can supply that type instead of
     <td><code>password 'testpass'</code></td>
     <td>None; this is required.</td>
   </tr>
+  <tr>
+    <td>port</td>
+    <td>
+      The port that the database server listens on.
+    </td>
+    <td><code>port 3377</code></td>
+    <td>
+      In general, this does not have a default value. For MySQL databases,
+      though, this will be set to 3306 by default.
+    </td>
+  </tr>
   <tr>
     <td>container_label</td>
     <td>
@@ -248,6 +270,59 @@ If you are using a different app type, you can supply that type instead of
   </tr>
 </table>
 
+# Adding Web Servers
+
+The app containers will not publish their ports to the host machine or the
+outside world, so you need to define web servers that serve as a proxy for them.
+Inside the project DSL, you can call `web_server :nginx` to add an Nginx
+web server. You can also call `nginx_web_server` to do the
+same thing. Both forms take a block, which allows you to call methods from
+`RubyYacht::WebServer::DSL`.
+
+By default, the web server will be called `web`, and its image name and
+container name will have the format `apollo-web`, where `apollo` is the system
+prefix for the project. If you want to use a different name, you can pass this
+as an argument to `web_server` or `nginx_web_server`.
+
+You can call the `web_server` method multiple times to add multiple servers.
+The scripts will try to start all of the web servers for your projects at once,
+which will cause conflicts if they are trying to listen on the same port. This
+is also a potential problem if you have multiple projects in the same
+configuration file, since each project will need its own web server.
+
+If you are using a different web server type, you can supply that type instead
+of `nginx`, but the server type must be defined through a
+[plugin](http://www.rubydoc.info/gems/ruby_yacht/file/doc/plugins.md).
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Description</th>
+    <th>Example</th>
+    <td>Default</td>
+  </tr>
+  <tr>
+    <td>domain</td>
+    <td>
+      The main domain for this server. Different apps will be added as
+      subdomains of this main domain.
+    </td>
+    <td><code>domain 'test.com'</code></td>
+    <td>None; this is required.</td>
+  </tr>
+  <tr>
+    <td>port</td>
+    <td>
+      The port that this server listens on. This is the port on the
+      *host machine* that the requests will come into. Inside the container, the
+      server will always listen on port 80, and it will be mapped to this port=
+      on the host.
+    </td>
+    <td><code>port 8080</code></td>
+    <td>80</td>
+  </tr>
+</table>
+
 # DNS Server Config
 
 If your network has custom DNS servers, you can call `dns_server` inside of a
@@ -289,13 +364,21 @@ You should only call the `dns_server` once for a given project.
 
 # Default Plugins
 
-By default, RubyYacht comes with two plugins, defined under the
+By default, RubyYacht comes with three plugins, defined under the
 `RubyYacht::Plugins` namespace:
 
 * Rails, for defining app servers for Rails apps
 * MySQL, for defining MySQL database servers
+* Nginx, for defining Nginx web servers.
 
 If you want to unload the default plugins, you can call
 `RubyYacht.configuration.clear` before defining the rest of your configuration.
 You can then load individual plugins by calling, for instance,
-`RubyYacht::Plugins::MySQL.load`.
+`RubyYacht::Plugins::MySQL.load`.
+
+# Miscellaneous Configuration
+
+The `disable_docker_machine` flag on `RubyYacht.configuration` forces the scripts
+to act as though docker-machine is not installed. This can be helpful if you are
+running a Docker for Mac or Docker for Windows beta alongside a docker-machine-based
+installation.

data/doc/configuration_sample.rb

@@ -6,13 +6,6 @@ RubyYacht.configure do
     # 'apollo-'
     system_prefix :apollo
     
-    # The web server will place the apps under 'apollo.docker.local'
-    #
-    # apollo.docker.local will point to a landing page with links to the apps,
-    # and individual apps will be available at mars.apollo.docker.local and
-    # saturn.apollo.docker.local
-    domain "apollo.docker.local"
-    
     # The repositories for the apps in this project will all be available at the
     # domain github.com.
     #
@@ -53,13 +46,21 @@ RubyYacht.configure do
     # This indicates that apollo.docker.local should serve requests to the mars
     # app.
     primary_app :mars
+
+    nginx_web_server do
+      # The web server will place the apps under 'apollo.docker.local'
+      #
+      # apollo.docker.local will point to a landing page with links to the apps,
+      # and individual apps will be available at mars.apollo.docker.local and
+      # saturn.apollo.docker.local
+      domain "apollo.docker.local"
+    end
   end
 
   # This is a second project that runs a different set of apps, with different
   # domains and a separate database.
   project :jupiter do
     system_prefix :jupiter
-    domain "jupiter.docker.local"
     repository "github.com"
     rails_secret_key_base 'abc'
     
@@ -88,6 +89,16 @@ RubyYacht.configure do
 
     # Because this project has no primary app, jupiter.docker.local will serve
     # an ad-hoc landing page with links to the individual apps.
+
+
+
+    nginx_web_server do
+      domain "jupiter.docker.local"
+
+      # This project's web server will listen on port 8080, instead of the
+      # default port 80.
+      port 8080
+    end
   end
 end
 

data/doc/contributing.md

@@ -4,9 +4,32 @@ release, and that will likely shape decisions about what gets accepted into the
 core and what should remain in individual's projects. You can start by opening
 a pull request with a fix, or an issue with a suggestion for a new feature.
 
+### Tests
+
 All pull requests must contain test coverage. The nature of this project
-requires caution when developing and running tests. The tests contain extensive
-stubs to prevent them from interacting with a real docker environment, and you
-should use the same techniques in your own tests. I would also recommend that
-you run the tests within their own docker container. You can find tools for
-building such a container in `spec/docker`.
+requires caution when developing and running tests. The unit tests contain
+extensive stubs to prevent them from interacting with a real docker environment,
+and you should use the same techniques in your own unit tests. The integration
+tests, on the other hand, directly interact with docker so that we can test the
+behavior of real containers. The images and containers for our tests will all be
+prefixed with `apollo`, so you must not have any images or containers in your
+environment that start with that prefix. They will be overwritten and removed in
+the course of running the integration tests. The integration tests also update
+the contents of the hosts file on the system. Though the tests are designed not
+to persist any modifications, it is *strongly* recommended that you run the
+tests inside a docker container.
+
+If you want to run your tests in a docker container, you can run
+`bash spec/docker/run.bash`, followed by the flags you want to pass to RSpec.
+By default, it will skip integration tests, but you can tell it to only run the
+integration tests by passing `-t integration` to rspec. This will build an image
+called `ruby-yacht-tests` and run rspec in a container based off of that image.
+That container will have its own docker environment, and it will start with a
+fresh set of containers every time you run it. This causes the tests to be very
+slow, which can be frustrating if you are running a few tests repeatedly as you
+make changes to the code. To speed this up, you can run the script with the
+PRESERVE_IMAGES flag, `PRESERVE_IMAGES=1 bash spec/docker/run.bash`. This will
+change the ruby-yacht-tests container to be daemonized and stay open
+indefinitely, and then run rspec in a separate process on the container. Once
+the specs are done, they will leave the built images on that container, and the
+specs will run faster the next time you run them.