tomo 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecf2cc8af9f664f1144c1b0c17975ecb87ec5f1345e7ffa0b4c919f46287780f
-  data.tar.gz: c805af8340d195a83a636735de9ea14fb630e335582513397ad2694318029725
+  metadata.gz: 64db4196df1505dcfb7b3be9098bf1fdcd6583dda180ac2108a01c4b8ee399da
+  data.tar.gz: 2409539abd04df955234e48d26a463a4a5491a2626d482e9b519016f479d3064
 SHA512:
-  metadata.gz: bb100deafcaef09ed875c7d6100a133638884ca35298163b3621242ca33c178c27fbe6061ee9387f20ba50b5b089ddb0522b9b5184f6d8375b9835dc9d99c399
-  data.tar.gz: e8a67228094bbea79d492d4ab7666de8d1e4cffb902ae6c3c77acc6b6b8bc4d904ecbc1e90a046abc64b7bd81fc0a15be70f355925943bbc59d5cf028e94b2d1
+  metadata.gz: 9c4ac76cbece92d504f2e229eb68779c679e9c1389554bcb1a39ef76bf88e15e9543b9b4b711990a6faaf0cdbba6b2a022606bc701fe32342f2e98c2100cbd9e
+  data.tar.gz: dd03847eb940857c45fe7a02b662b07280fe669de17cd778cb8ad542bafc3b81306fff543d37ce2e613ba3ab813356a8bd8f6af47726919d0106c84cb154bf7b

data/README.md

@@ -4,9 +4,8 @@
 [![Travis](https://img.shields.io/travis/mattbrictson/tomo.svg?label=travis)](https://travis-ci.org/mattbrictson/tomo)
 [![Circle](https://circleci.com/gh/mattbrictson/tomo.svg?style=shield)](https://circleci.com/gh/mattbrictson/tomo)
 [![Code Climate](https://codeclimate.com/github/mattbrictson/tomo/badges/gpa.svg)](https://codeclimate.com/github/mattbrictson/tomo)
-[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/mattbrictson)
 
-Tomo is a friendly command-line tool for deploying Rails apps. It is a new alternative to Capistrano, Mina, and Shipit that optimizes for simplicity and developer happiness.
+Tomo is a friendly command-line tool for deploying Rails apps. It is a new alternative to Capistrano, Mina, and Shipit that aims for simplicity and developer happiness.
 
 💻 Rich command-line interface with built-in bash completions<br/>
 ☁️ Multi-environment and role-based multi-host support<br/>
@@ -16,17 +15,16 @@ Tomo is a friendly command-line tool for deploying Rails apps. It is a new alter
 📚 Quality documentation<br/>
 🔬 Minimal dependencies<br/>
 
-This project wouldn't be possible without the generosity of the open source Ruby community. Please support open source projects and your fellow developers by helping answer questions, contributing pull requests to improve code and documentation, or just [drop a note](https://saythanks.io/to/mattbrictson) to say thanks! ❤️
-
 ---
 
 - [Quick start](#quick-start)
+- [Usage](#usage)
 - [Reference documentation](#reference-documentation)
 - [FAQ](#faq)
 - [Support](#support)
 - [License](#license)
 - [Code of conduct](#code-of-conduct)
-- [Contribution guide](#contribution-guide) [TODO]
+- [Contribution guide](#contribution-guide)
 
 ## Quick start
 
@@ -36,19 +34,19 @@ Tomo is distributed as a ruby gem. To install:
 $ gem install tomo
 ```
 
-#### Getting help
-
-An easy way to kick the tires is to view the `--help`.
+For instructions on setting up bash completions, run:
 
-![$ tomo --help](./readme_images/tomo-help.png)
+```
+$ tomo completion-script
+```
 
 #### Configuring a project
 
-Let’s init a project to see how tomo is configured.
+Tomo is configured via a `.tomo/config.rb` file in your project. To get started, you can use `tomo init` to generate a configuration that works for a basic Rails app.
 
 ![$ tomo init](./readme_images/tomo-init.png)
 
-The `.tomo/config.rb` file defines all the settings and tasks needed to setup and deploy a typical Rails project. An abbreviated version looks like this:
+An abbreviated version looks like this:
 
 ```ruby
 # .tomo/config.rb
@@ -86,41 +84,50 @@ deploy do
 end
 ```
 
-Eventually you'll want to edit the config file to specify the appropriate user and host, perhaps define some custom tasks, and tweak the settings to make them suitable for your Rails app. You can also take advantage of more advanced features like multiple hosts and environment-based config.
-
-#### Host setup
+Check out the [configuration docs](https://tomo-deploy.com/configuration/) for a complete reference.
 
-With tomo, an initial deployment is separated into two distinct steps. The `setup` command prepares the host for its first deploy. Let’s take a look at the documentation with `--help`:
+## Usage
 
-![$ tomo setup --help](./readme_images/tomo-setup-help.png)
+Tomo gives you easy-to-use commands for three common use cases:
 
-We can simulate the setup operation with the `--dry-run` option. Let's try it:
+1. `tomo setup` prepares a remote host for its first deploy
+2. `tomo deploy` performs a deployment
+3. `tomo run` lets you invoke one-off tasks
 
-![$ tomo setup --dry-run](./readme_images/tomo-setup-dry-run.png)
+#### Setup
 
-As you can see, the setup command in this project clones the git repository, installs ruby, node, bundler, and initializes the database. One the host is set up, it is ready for its first deploy.
+`tomo setup` prepares the remote host for its first deploy by sequentially running the
+[setup](https://tomo-deploy.com/configuration#setupblock) list of tasks specified in `.tomo/config.rb`. These tasks typically create directories, initialize data stores, install prerequisite tools, and perform other one-time actions that are necessary before a deploy can take place.
 
-#### Performing a deploy
+Out of the box, tomo will:
 
-Typically you only need to run `setup` once. From then on deploying a project is a matter of running the `deploy` command.
+- Configure necessary environment variables, like `RAILS_ENV` and `SECRET_KEY_BASE`
+- Install Ruby, Bundler, Node, Yarn, and dependencies
+- Create all necessary deployment directories
+- Create the Rails database, load the schema, and insert seed data
 
-![$ tomo deploy --help](./readme_images/tomo-deploy-help.png)
+#### Deploy
 
-Like `setup`, this can be simulated with `--dry-run`, like this:
+Whereas `tomo setup` is typically run once, you can use `tomo deploy` every time you want to deploy a new version of your app. The deploy command will sequentially run the [deploy](https://tomo-deploy.com/configuration#deployblock) list of tasks specified in `.tomo/config.rb`. You can customize this list to meet the needs of your app. By default, tomo runs these tasks:
 
-![$ tomo deploy --dry-run](./readme_images/tomo-deploy-dry-run.png)
+1. Create a release (using the [git:create_release](https://tomo-deploy.com/plugins/git#gitcreate_release) task)
+2. Build the project (e.g. [bundler:install](https://tomo-deploy.com/plugins/bundler#bundlerinstall), [rails:assets_precompile](../plugins/rails.md#railsassets_precompile))
+3. Migrate data to the meet the requirements of the new release (e.g. [rails:db_migrate](https://tomo-deploy.com/plugins/rails#railsdb_migrate))
+4. Make the new release the "current" one ([core:symlink_current](https://tomo-deploy.com/plugins/core#coresymlink_current))
+5. Restart the app to use the new current release (e.g. [puma:restart](https://tomo-deploy.com/plugins/puma#pumarestart))
+6. Perform any cleanup (e.g. [bundler:clean](https://tomo-deploy.com/plugins/bundler#bundlerclean))
 
-#### Running a single task
+#### Run
 
-Tomo can also `run` individual remote tasks. Use the `tasks` command to see the list of tasks tomo knows about.
+Tomo can also `run` individual remote tasks on demand. You can use the `tasks` command to see the list of tasks tomo knows about.
 
 ![$ tomo tasks](./readme_images/tomo-tasks.png)
 
-One of the built-in Rails tasks is `rails:console`, which brings up a fully-interactive Rails console over SSH. We can simulate this with `--dry-run` as well.
+One of the built-in Rails tasks is `rails:console`, which brings up a fully-interactive Rails console over SSH.
 
-![$ tomo run rails:console --dry-run](./readme_images/tomo-run-rails-console-dry-run.png)
+![$ tomo run rails:console](./readme_images/tomo-run-rails-console.png)
 
-#### Writing tasks
+#### Extending tomo
 
 Tomo has many plugins built-in, but you can easily add your own to extend tomo with custom tasks. By convention, custom plugins are stored in `.tomo/plugins/`. These plugins can define tasks as plain ruby methods. For example:
 
@@ -144,13 +151,9 @@ plugin "./plugins/my-plugin.rb"
 
 And run it!
 
-![$ tomo run my-plugin:hello --dry-run](./readme_images/tomo-run-hello-dry-run.png)
+![$ tomo run my-plugin:hello](./readme_images/tomo-run-hello.png)
 
-#### Next steps
-
-And just like that, you are now already familiar with the basics of tomo and how to extend it! Tomo is even more friendly and powerful with the help of bash completions. If you use bash, run `tomo completion-script` for instructions on setting them up.
-
-To prepare your existing project for a real deploy, check out the sections of the reference documentation on [configuration](https://tomo-deploy.com/configuration/), [writing custom tasks](https://tomo-deploy.com/tutorials/writing-custom-tasks/), the [setup command](https://tomo-deploy.com/commands/setup/), and the [deploy command](https://tomo-deploy.com/commands/deploy/). There is also a tutorial that walks through [deploying a new Rails app from scratch](https://tomo-deploy.com/tutorials/deploying-rails-from-scratch/) [TODO]. If you have questions, check out the [FAQ](#faq) and [support](#support) notes below. Enjoy using tomo!
+Read the [Writing Custom Tasks](https://tomo-deploy.com/tutorials/writing-custom-tasks/) tutorial for an in-depth guide to extending tomo.
 
 ## Reference documentation
 
@@ -198,15 +201,7 @@ set ssh_strict_host_key_checking: true # or false
 
 ## Support
 
-Thanks for your interest in Tomo! I use Tomo myself to deploy my own Rails projects and intend to keep this repository working and up to date for the foreseeable future. However Tomo is only a hobby, and as the sole maintainer, my ability to provide support and review pull request is limited and a bit sporadic. My priorities right now are:
-
-1. Improve test coverage
-2. Keep the project free of any serious bugs
-3. Stay up to date with the latest versions of Ruby and gem dependencies
-
-If you'd like to help by submitting a pull request, that would be much appreciated! Check out the contribution guide to get started.
-
-Otherwise if you want to report a bug, or have ideas, feedback or questions about Tomo, [let me know via GitHub issues](https://github.com/mattbrictson/tomo/issues/new) and I will do my best to provide a helpful answer. Happy hacking! —Matt
+This project is a labor of love and I can only spend a few hours a week maintaining it, at most. If you'd like to help by submitting a pull request, or if you've discovered a bug that needs my attention, please let me know. Check out [CONTRIBUTING.md](https://github.com/mattbrictson/tomo/blob/master/CONTRIBUTING.md) to get started. Happy hacking! —Matt
 
 ## License
 
@@ -218,4 +213,4 @@ Everyone interacting in the Tomo project’s codebases, issue trackers, chat roo
 
 ## Contribution guide
 
-[TODO]
+Interested in filing a bug report, feature request, or opening a PR? Excellent! Please read the short [CONTRIBUTING.md](https://github.com/mattbrictson/tomo/blob/master/CONTRIBUTING.md) guidelines before you dive in.

data/lib/tomo/commands/init.rb

@@ -62,7 +62,7 @@ module Tomo
 
       def git_origin_url
         return unless File.file?(".git/config")
-        return unless `git remote -v` =~ /^origin/
+        return unless `git remote -v`.match?(/^origin/)
 
         url = `git remote get-url origin`.chomp
         url.empty? ? nil : url

data/lib/tomo/plugin/core.rb

@@ -16,12 +16,13 @@ module Tomo::Plugin
       keep_releases:     10,
       linked_dirs:       [],
       linked_files:      [],
+      local_user:        nil, # determined at runtime
       release_json_path: "%<release_path>/.tomo_release.json",
       releases_path:     "%<deploy_to>/releases",
       revision_log_path: "%<deploy_to>/revisions.log",
       shared_path:       "%<deploy_to>/shared",
       tmp_path:          "/tmp/tomo",
-      run_args:          []
+      run_args:          [] # determined at runtime
     )
   end
 end

data/lib/tomo/plugin/git/tasks.rb

@@ -68,7 +68,7 @@ module Tomo::Plugin::Git
       remote.release[:revision] = sha
       remote.release[:revision_date] = date
       remote.release[:deploy_date] = Time.now.to_s
-      remote.release[:deploy_user] = ENV["USER"] || ENV["USERNAME"]
+      remote.release[:deploy_user] = settings.fetch(:local_user)
     end
     # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/AbcSize

data/lib/tomo/runtime.rb

@@ -18,6 +18,12 @@ module Tomo
     autoload :TaskRunner, "tomo/runtime/task_runner"
     autoload :UnknownTaskError, "tomo/runtime/unknown_task_error"
 
+    def self.local_user
+      ENV["USER"] || ENV["USERNAME"] || `whoami`.chomp
+    rescue StandardError
+      nil
+    end
+
     attr_reader :tasks
 
     def initialize(deploy_tasks:, setup_tasks:, hosts:, task_filter:,
@@ -65,6 +71,7 @@ module Tomo
 
     def new_task_runner(release_type, args)
       run_settings = { release_path: release_path_for(release_type) }
+                     .merge(local_user: Runtime.local_user)
                      .merge(settings)
                      .merge(run_args: args)
 

data/lib/tomo/version.rb

@@ -1,3 +1,3 @@
 module Tomo
-  VERSION = "0.4.0".freeze
+  VERSION = "0.4.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tomo
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Matt Brictson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-28 00:00:00.000000000 Z
+date: 2019-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,28 +114,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 0.74.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 0.74.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.4.1
 description: 
 email:
 - opensource@mattbrictson.com