tomo 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92b79ae23f462d987b150fe0537a743f087e150b6947780baa77ea4046e7d9b9
-  data.tar.gz: 77f301ef039cc4b8e8ed65f4009f0f1e0f3b0edaba7420f7b9994797b78bd53f
+  metadata.gz: f9fc9bfe01816992c55105b084e6c9ed40c9f7aa9070e833feebfe4084a66194
+  data.tar.gz: be42304890a78153df0cd9589f4c7e01afbbfe1f8fa077ab2d3c879893eab2fc
 SHA512:
-  metadata.gz: 312cc7f96ebe0fa19c369fe1bb3ad3c8ea654abfbc8f6d35ec8253f03f8694f4300d6b113d9c17a20ab0473d649b1c0404611f746ffbf563a0c15b8eb35b29e4
-  data.tar.gz: 737e7aa7cbffe6a048164a6798fc63847ec32478ea81fe63b78fe62b95970f602c6c888b5087a7c03ffe281807182284e1d46ce8e25eff189bc48591a7c598b4
+  metadata.gz: 3e34a45b62184a909bfb6d6825110aa56924249acb263f5469e7c470b0393255e73b8a7e40b8aec88a09af8d722edfa4a5fc2d8db49e488039f9f1df541cfa09
+  data.tar.gz: cfb514fc60e188e17d81acf2c465608a9b8fce474918a0513f021a1ec02d8817fc997bcb2379bd0a916fabe7baed526737cb0b028d73fa468a7facc67eca7dac

data/README.md

@@ -19,6 +19,7 @@ Tomo is a friendly command-line tool for deploying Rails apps. It is a new alter
 
 - [Quick start](#quick-start)
 - [Usage](#usage)
+- [Tutorials](#tutorials)
 - [Reference documentation](#reference-documentation)
 - [FAQ](#faq)
 - [Support](#support)
@@ -94,7 +95,7 @@ Tomo gives you easy-to-use commands for three common use cases:
 2. `tomo deploy` performs a deployment
 3. `tomo run` lets you invoke one-off tasks
 
-#### Setup
+### Setup
 
 `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.
@@ -106,7 +107,7 @@ Out of the box, tomo will:
 - Create all necessary deployment directories
 - Create the Rails database, load the schema, and insert seed data
 
-#### Deploy
+### Deploy
 
 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:
 
@@ -117,7 +118,7 @@ Whereas `tomo setup` is typically run once, you can use `tomo deploy` every time
 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))
 
-#### Run
+### Run
 
 Tomo can also `run` individual remote tasks on demand. You can use the `tasks` command to see the list of tasks tomo knows about.
 
@@ -127,7 +128,7 @@ One of the built-in Rails tasks is `rails:console`, which brings up a fully-inte
 
 ![$ tomo run rails:console](./readme_images/tomo-run-rails-console.png)
 
-#### Extending tomo
+### 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:
 
@@ -155,6 +156,12 @@ And run it!
 
 Read the [Writing Custom Tasks](https://tomo-deploy.com/tutorials/writing-custom-tasks/) tutorial for an in-depth guide to extending tomo.
 
+## Tutorials
+
+- [Deploying Rails From Scratch](https://tomo-deploy.com/tutorials/deploying-rails-from-scratch/)
+- [Writing Custom Tasks](https://tomo-deploy.com/tutorials/writing-custom-tasks/)
+- [Publishing a Plugin](https://tomo-deploy.com/tutorials/publishing-a-plugin/) [TODO]
+
 ## Reference documentation
 
 - [Configuration](https://tomo-deploy.com/configuration/)
@@ -173,10 +180,6 @@ Read the [Writing Custom Tasks](https://tomo-deploy.com/tutorials/writing-custom
   - [puma](https://tomo-deploy.com/plugins/puma/)
   - [rails](https://tomo-deploy.com/plugins/rails/)
   - [rbenv](https://tomo-deploy.com/plugins/rbenv/)
-- Tutorials
-  - [Deploying Rails From Scratch](https://tomo-deploy.com/tutorials/deploying-rails-from-scratch/)
-  - [Writing Custom Tasks](https://tomo-deploy.com/tutorials/writing-custom-tasks/)
-  - [Publishing a Plugin](https://tomo-deploy.com/tutorials/publishing-a-plugin/) [TODO]
 - API
   - [Host](https://tomo-deploy.com/api/Host/)
   - [Logger](https://tomo-deploy.com/api/Logger/)

data/lib/tomo.rb

@@ -17,6 +17,7 @@ module Tomo
   autoload :Script, "tomo/script"
   autoload :ShellBuilder, "tomo/shell_builder"
   autoload :SSH, "tomo/ssh"
+  autoload :TaskAPI, "tomo/task_api"
   autoload :TaskLibrary, "tomo/task_library"
   autoload :VERSION, "tomo/version"
 

data/lib/tomo/configuration.rb

@@ -20,7 +20,7 @@ module Tomo
       config_rb = IO.read(path)
 
       new.tap do |config|
-        config.working_dir = File.dirname(path)
+        config.path = File.expand_path(path)
         DSL::ConfigFile.new(config).instance_eval(config_rb, path.to_s, 1)
       end
     rescue StandardError, SyntaxError => e
@@ -28,7 +28,7 @@ module Tomo
     end
 
     attr_accessor :environments, :deploy_tasks, :setup_tasks, :hosts, :plugins,
-                  :settings, :task_filter, :working_dir
+                  :settings, :task_filter, :path
 
     def initialize
       @environments = {}
@@ -59,7 +59,7 @@ module Tomo
         setup_tasks: setup_tasks,
         plugins_registry: plugins_registry,
         hosts: add_log_prefixes(hosts),
-        settings: settings,
+        settings: { tomo_config_file_path: path }.merge(settings),
         task_filter: task_filter
       )
     end
@@ -95,7 +95,7 @@ module Tomo
 
       (["core"] + plugins.uniq).each do |plug|
         if %w[. /].include?(plug[0])
-          plug = File.expand_path(plug, working_dir) unless working_dir.nil?
+          plug = File.expand_path(plug, File.dirname(path)) unless path.nil?
           plugins_registry.load_plugin_from_path(plug)
         else
           plugins_registry.load_plugin_by_name(plug)

data/lib/tomo/plugin/core.rb

@@ -9,20 +9,21 @@ module Tomo::Plugin
     tasks Tomo::Plugin::Core::Tasks
 
     defaults Tomo::SSH::Options::DEFAULTS.merge(
-      application:       "default",
-      concurrency:       10,
-      current_path:      "%<deploy_to>/current",
-      deploy_to:         "/var/www/%<application>",
-      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:          [] # determined at runtime
+      application:           "default",
+      concurrency:           10,
+      current_path:          "%<deploy_to>/current",
+      deploy_to:             "/var/www/%<application>",
+      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",
+      tomo_config_file_path: nil, # determined at runtime
+      run_args:              [] # determined at runtime
     )
   end
 end

data/lib/tomo/plugin/core/helpers.rb

@@ -12,7 +12,9 @@ module Tomo::Plugin::Core
       result.success?
     end
 
-    def write(text:, to:, append: false, **run_opts)
+    def write(text: nil, template: nil, to:, append: false, **run_opts)
+      assert_text_or_template_required!(text, template)
+      text = merge_template(template) unless template.nil?
       message = "Writing #{text.bytesize} bytes to #{to}"
       run(
         "echo -n #{text.shellescape} #{append ? '>>' : '>'} #{to.shellescape}",
@@ -61,5 +63,11 @@ module Tomo::Plugin::Core
     def flag?(flag, path, **run_opts)
       run?("[ #{flag} #{path.to_s.shellescape} ]", **run_opts)
     end
+
+    def assert_text_or_template_required!(text, template)
+      return if text.nil? ^ template.nil?
+
+      raise ArgumentError, "specify text: or template:"
+    end
   end
 end

data/lib/tomo/remote.rb

@@ -2,6 +2,8 @@ require "forwardable"
 
 module Tomo
   class Remote
+    include TaskAPI
+
     extend Forwardable
     def_delegators :ssh, :close, :host
     def_delegators :shell_builder, :chdir, :env, :prepend, :umask
@@ -33,21 +35,8 @@ module Tomo
 
     private
 
-    def_delegators :context, :paths, :settings
     attr_reader :context, :ssh, :shell_builder
 
-    def dry_run?
-      Tomo.dry_run?
-    end
-
-    def logger
-      Tomo.logger
-    end
-
-    def raw(str)
-      ShellBuilder.raw(str)
-    end
-
     def remote
       self
     end

data/lib/tomo/runtime.rb

@@ -16,6 +16,7 @@ module Tomo
     autoload :SettingsRequiredError, "tomo/runtime/settings_required_error"
     autoload :TaskAbortedError, "tomo/runtime/task_aborted_error"
     autoload :TaskRunner, "tomo/runtime/task_runner"
+    autoload :TemplateNotFoundError, "tomo/runtime/template_not_found_error"
     autoload :UnknownTaskError, "tomo/runtime/unknown_task_error"
 
     def self.local_user

data/lib/tomo/runtime/template_not_found_error.rb

@@ -0,0 +1,11 @@
+module Tomo
+  class Runtime
+    class TemplateNotFoundError < Error
+      attr_accessor :path
+
+      def to_console
+        "Template not found: #{yellow(path)}"
+      end
+    end
+  end
+end

data/lib/tomo/task_api.rb

@@ -0,0 +1,59 @@
+require "erb"
+
+module Tomo
+  module TaskAPI
+    extend Forwardable
+
+    private
+
+    def_delegators :context, :paths, :settings
+
+    def die(reason)
+      Runtime::TaskAbortedError.raise_with(
+        reason,
+        task: context.current_task,
+        host: remote.host
+      )
+    end
+
+    def dry_run?
+      Tomo.dry_run?
+    end
+
+    def logger
+      Tomo.logger
+    end
+
+    def merge_template(path)
+      working_path = paths.tomo_config_file&.dirname
+      if working_path && path.start_with?(".")
+        path = File.expand_path(path, working_path)
+      end
+
+      unless File.file?(path)
+        Runtime::TemplateNotFoundError.raise_with(path: path)
+      end
+      template = IO.read(path)
+      ERB.new(template).result(binding)
+    end
+
+    def raw(string)
+      ShellBuilder.raw(string)
+    end
+
+    def remote
+      context.current_remote
+    end
+
+    def require_setting(*names)
+      missing = names.flatten.select { |sett| settings[sett].nil? }
+      return if missing.empty?
+
+      Runtime::SettingsRequiredError.raise_with(
+        settings: missing,
+        task: context.current_task
+      )
+    end
+    alias require_settings require_setting
+  end
+end

data/lib/tomo/task_library.rb

@@ -2,7 +2,7 @@ require "forwardable"
 
 module Tomo
   class TaskLibrary
-    extend Forwardable
+    include TaskAPI
 
     def initialize(context)
       @context = context
@@ -10,42 +10,6 @@ module Tomo
 
     private
 
-    def_delegators :context, :paths, :settings
     attr_reader :context
-
-    def die(reason)
-      Runtime::TaskAbortedError.raise_with(
-        reason,
-        task: context.current_task,
-        host: remote.host
-      )
-    end
-
-    def dry_run?
-      Tomo.dry_run?
-    end
-
-    def logger
-      Tomo.logger
-    end
-
-    def raw(string)
-      ShellBuilder.raw(string)
-    end
-
-    def remote
-      context.current_remote
-    end
-
-    def require_setting(*names)
-      missing = names.flatten.select { |sett| settings[sett].nil? }
-      return if missing.empty?
-
-      Runtime::SettingsRequiredError.raise_with(
-        settings: missing,
-        task: context.current_task
-      )
-    end
-    alias require_settings require_setting
   end
 end

data/lib/tomo/version.rb

@@ -1,3 +1,3 @@
 module Tomo
-  VERSION = "0.7.0".freeze
+  VERSION = "0.8.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tomo
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-10 00:00:00.000000000 Z
+date: 2019-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -245,6 +245,7 @@ files:
 - lib/tomo/runtime/settings_required_error.rb
 - lib/tomo/runtime/task_aborted_error.rb
 - lib/tomo/runtime/task_runner.rb
+- lib/tomo/runtime/template_not_found_error.rb
 - lib/tomo/runtime/unknown_task_error.rb
 - lib/tomo/script.rb
 - lib/tomo/shell_builder.rb
@@ -260,6 +261,7 @@ files:
 - lib/tomo/ssh/script_error.rb
 - lib/tomo/ssh/unknown_error.rb
 - lib/tomo/ssh/unsupported_version_error.rb
+- lib/tomo/task_api.rb
 - lib/tomo/task_library.rb
 - lib/tomo/templates/config.rb.erb
 - lib/tomo/testing.rb