runbook 0.14.0 → 1.1.0

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/activesupport_5.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.0"
+
+gemspec path: "../"

data/gemfiles/activesupport_6.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 6.0"
+
+gemspec path: "../"

data/lib/runbook.rb

@@ -2,8 +2,10 @@ require "tmpdir"
 require "yaml"
 require "thread"
 
+require "active_support/deprecation"
 require "active_support/inflector"
 require "method_source"
+require "ruby2_keywords"
 require "pastel"
 require "sshkit"
 require "sshkit/sudo"
@@ -12,6 +14,8 @@ require "tty-progressbar"
 require "tty-prompt"
 require "thor/group"
 
+require "runbook/airbrussh_context"
+
 require "runbook/configuration"
 
 require "hacks/ssh_kit"
@@ -30,6 +34,7 @@ require "runbook/node"
 require "runbook/entity"
 require "runbook/entities/book"
 require "runbook/entities/section"
+require "runbook/entities/setup"
 require "runbook/entities/step"
 
 require "runbook/statement"
@@ -74,6 +79,7 @@ require "runbook/extensions/add"
 require "runbook/extensions/description"
 require "runbook/extensions/shared_variables"
 require "runbook/extensions/sections"
+require "runbook/extensions/setup"
 require "runbook/extensions/ssh_config"
 require "runbook/extensions/statements"
 require "runbook/extensions/steps"
@@ -86,24 +92,36 @@ ActiveSupport::Inflector.inflections(:en) do |inflect|
 end
 
 module Runbook
-  def self.book(title, &block)
+  def self.book(title, *tags, labels: {}, &block)
     Configuration.load_config
-    Entities::Book.new(title).tap do |book|
+    Entities::Book.new(title, tags: tags, labels: labels).tap do |book|
       book.dsl.instance_eval(&block)
       register(book)
     end
   end
 
-  def self.section(title, &block)
+  def self.section(title, *tags, labels: {}, &block)
     Configuration.load_config
-    Entities::Section.new(title).tap do |section|
+    Entities::Section.new(title, tags: tags, labels: labels).tap do |section|
       section.dsl.instance_eval(&block)
     end
   end
 
-  def self.step(title=nil, &block)
+  def self.setup(*tags, labels: {}, &block)
     Configuration.load_config
-    Entities::Step.new(title).tap do |step|
+    Entities::Setup.new(tags: tags, labels: labels).tap do |setup|
+      setup.dsl.instance_eval(&block)
+    end
+  end
+
+  def self.step(title=nil, *tags, labels: {}, &block)
+    if title.is_a?(Symbol)
+      tags.unshift(title)
+      title = nil
+    end
+
+    Configuration.load_config
+    Entities::Step.new(title, tags: tags, labels: labels).tap do |step|
       step.dsl.instance_eval(&block) if block
     end
   end
@@ -115,4 +133,8 @@ module Runbook
   def self.books
     @books ||= []
   end
+
+  def self.runtime_methods
+    @runtime_methods ||= []
+  end
 end

data/lib/runbook/airbrussh_context.rb

@@ -0,0 +1,25 @@
+module Runbook
+  class AirbrusshContext
+    attr_reader :history, :current_task_name
+
+    def initialize(config=Airbrussh.configuration)
+      @history = []
+    end
+
+    def register_new_command(command)
+      hist_entry = command.to_s
+      first_execution = history.last != hist_entry
+      history << hist_entry if first_execution
+      first_execution
+    end
+
+    def position(command)
+      history.rindex(command.to_s)
+    end
+
+    def set_current_task_name(task_name)
+      @current_task_name = task_name
+      history.clear
+    end
+  end
+end

data/lib/runbook/cli.rb

@@ -82,17 +82,6 @@ module Runbook
       invoke(Runbook::Initializer)
     end
 
-    desc "install", "Install Runbook in an existing project", hide: true
-    Runbook::Initializer.class_options.values.each do |co|
-      method_option co.name, desc: co.description, required: co.required,
-        default: co.default, aliases: co.aliases, type: co.type,
-        banner: co.banner, hide: co.hide
-    end
-    def install
-      Runbook.deprecator.deprecation_warning(:install, :init)
-      invoke(Runbook::Initializer)
-    end
-
     desc "--version", "Print runbook's version"
     def __print_version
       puts "Runbook v#{Runbook::VERSION}"
@@ -104,8 +93,23 @@ module Runbook
       unless File.exist?(runbook)
         raise Thor::InvocationError, "#{cmd}: cannot access #{runbook}: No such file or directory"
       end
-      load(runbook)
-      Runbook.books.last || eval(File.read(runbook))
+
+      begin
+        load(runbook)
+        Runbook.books.last || eval(File.read(runbook))
+      rescue NameError => e
+        if Runbook.runtime_methods.include?(e.name)
+          message = (
+            "Runtime method `#{e.name}` cannot be referenced at " \
+            "compile time. Wrap statements referencing it in a " \
+            "`ruby_command` block in order to invoke the code at " \
+            "runtime."
+          )
+          raise e, message, e.backtrace
+        end
+
+        raise e
+      end
     end
   end
 end

data/lib/runbook/configuration.rb

@@ -19,6 +19,7 @@ module Runbook
   end
 
   class Configuration
+    attr_accessor :_airbrussh_context
     attr_accessor :ssh_kit
     attr_accessor :enable_sudo_prompt
     attr_reader :use_same_sudo_password
@@ -89,11 +90,16 @@ module Runbook
 
     def initialize
       self.ssh_kit = SSHKit.config
-      ssh_kit.output = Airbrussh::Formatter.new(
+      formatter = Airbrussh::Formatter.new(
         $stdout,
         banner: nil,
         command_output: true,
+        context: AirbrusshContext,
       )
+      ssh_kit.output = formatter
+      self._airbrussh_context = formatter.formatters.find do |fmt|
+        fmt.is_a?(Airbrussh::ConsoleFormatter)
+      end.context
       self.enable_sudo_prompt = true
       self.use_same_sudo_password = true
     end

data/lib/runbook/entities/book.rb

@@ -1,7 +1,7 @@
 module Runbook::Entities
   class Book < Runbook::Entity
-    def initialize(title)
-      super(title)
+    def initialize(title, tags: [], labels: {})
+      super(title, tags: tags, labels: labels)
     end
 
     # Seed data for 'render' tree traversal method

data/lib/runbook/entities/section.rb

@@ -1,7 +1,7 @@
 module Runbook::Entities
   class Section < Runbook::Entity
-    def initialize(title)
-      super(title)
+    def initialize(title, tags: [], labels: {})
+      super(title, tags: tags, labels: labels)
     end
   end
 end

data/lib/runbook/entities/setup.rb

@@ -0,0 +1,7 @@
+module Runbook::Entities
+  class Setup < Runbook::Entity
+    def initialize(tags: [], labels: {})
+      super("Setup", tags: tags, labels: labels)
+    end
+  end
+end

data/lib/runbook/entities/step.rb

@@ -1,7 +1,7 @@
 module Runbook::Entities
   class Step < Runbook::Entity
-    def initialize(title=nil)
-      super(title)
+    def initialize(title=nil, tags: [], labels: {})
+      super(title, tags: tags, labels: labels)
     end
   end
 end

data/lib/runbook/entity.rb

@@ -7,11 +7,12 @@ module Runbook
       child_class.const_set(:DSL, Runbook::DSL.class)
     end
 
-    attr_accessor :parent
-    attr_reader :title, :dsl
+    attr_reader :title, :tags, :labels, :dsl
 
-    def initialize(title, parent: nil)
+    def initialize(title, tags: [], labels: {}, parent: nil)
       @title = title
+      @tags = tags
+      @labels = labels
       @parent = parent
       @dsl = "#{self.class}::DSL".constantize.new(self)
     end
@@ -25,7 +26,7 @@ module Runbook
       @items ||= []
     end
 
-    def method_missing(method, *args, &block)
+    ruby2_keywords def method_missing(method, *args, &block)
       if dsl.respond_to?(method)
         dsl.send(method, *args, &block)
       else
@@ -92,7 +93,8 @@ module Runbook
 
     def _run_metadata(items, item, metadata, index)
       pos_index = items.select do |item|
-        item.is_a?(Entity)
+        item.is_a?(Entity) &&
+          !item.is_a?(Runbook::Entities::Setup)
       end.index(item)
 
       if pos_index

data/lib/runbook/extensions/add.rb

@@ -9,5 +9,6 @@ module Runbook::Extensions
 
   Runbook::Entities::Book::DSL.prepend(Add::DSL)
   Runbook::Entities::Section::DSL.prepend(Add::DSL)
+  Runbook::Entities::Setup::DSL.prepend(Add::DSL)
   Runbook::Entities::Step::DSL.prepend(Add::DSL)
 end

data/lib/runbook/extensions/sections.rb

@@ -1,8 +1,12 @@
 module Runbook::Extensions
   module Sections
     module DSL
-      def section(title, &block)
-        Runbook::Entities::Section.new(title).tap do |section|
+      def section(title, *tags, labels: {}, &block)
+        Runbook::Entities::Section.new(
+          title,
+          tags: tags,
+          labels: labels,
+        ).tap do |section|
           parent.add(section)
           section.dsl.instance_eval(&block)
         end

data/lib/runbook/extensions/setup.rb

@@ -0,0 +1,17 @@
+module Runbook::Extensions
+  module Setup
+    module DSL
+      def setup(*tags, labels: {}, &block)
+        Runbook::Entities::Setup.new(
+          tags: tags,
+          labels: labels,
+        ).tap do |setup|
+          parent.add(setup)
+          setup.dsl.instance_eval(&block) if block
+        end
+      end
+    end
+  end
+
+  Runbook::Entities::Book::DSL.prepend(Setup::DSL)
+end

data/lib/runbook/extensions/ssh_config.rb

@@ -71,6 +71,8 @@ module Runbook::Extensions
   Runbook::Entities::Step::DSL.prepend(SSHConfig::DSL)
   Runbook::Entities::Section.prepend(SSHConfig)
   Runbook::Entities::Section::DSL.prepend(SSHConfig::DSL)
+  Runbook::Entities::Setup.prepend(SSHConfig)
+  Runbook::Entities::Setup::DSL.prepend(SSHConfig::DSL)
   Runbook::Entities::Book.prepend(SSHConfig)
   Runbook::Entities::Book::DSL.prepend(SSHConfig::DSL)
 end

data/lib/runbook/extensions/statements.rb

@@ -1,10 +1,14 @@
 module Runbook::Extensions
   module Statements
     module DSL
-      def method_missing(name, *args, &block)
+      ruby2_keywords def method_missing(name, *args, &block)
         if (klass = Statements::DSL._statement_class(name))
           klass.new(*args, &block).tap do |statement|
             parent.add(statement)
+
+            if statement.respond_to?(:into)
+              Runbook.runtime_methods << statement.into
+            end
           end
         else
           super
@@ -22,5 +26,6 @@ module Runbook::Extensions
     end
   end
 
+  Runbook::Entities::Setup::DSL.prepend(Statements::DSL)
   Runbook::Entities::Step::DSL.prepend(Statements::DSL)
 end

data/lib/runbook/extensions/steps.rb

@@ -1,8 +1,17 @@
 module Runbook::Extensions
   module Steps
     module DSL
-      def step(title=nil, &block)
-        Runbook::Entities::Step.new(title).tap do |step|
+      def step(title=nil, *tags, labels: {}, &block)
+        if title.is_a?(Symbol)
+          tags.unshift(title)
+          title = nil
+        end
+
+        Runbook::Entities::Step.new(
+          title,
+          tags: tags,
+          labels: labels,
+        ).tap do |step|
           parent.add(step)
           step.dsl.instance_eval(&block) if block
         end
@@ -10,5 +19,6 @@ module Runbook::Extensions
     end
   end
 
+  Runbook::Entities::Book::DSL.prepend(Steps::DSL)
   Runbook::Entities::Section::DSL.prepend(Steps::DSL)
 end

data/lib/runbook/generators/project/project.rb

@@ -22,14 +22,23 @@ module Runbook::Generators
       desc: "Target directory for shared runbook code"
     class_option :test, type: :string, enum: ["rspec", "minitest"],
       default: "rspec", desc: %Q{Test-suite, "rspec" or "minitest"}
+    class_option :ci, type: :string, enum: ["github", "travis", "gitlab", "circle"],
+      default: "github", desc: %Q{CI Service, "github", "travis", "gitlab", or "circle"}
 
     def init_gem
       bundle_exists = "which bundle 2>&1 1>/dev/null"
       raise "Please ensure bundle is installed" unless system(bundle_exists)
+      bundler_version = Gem::Version.new(Bundler::VERSION)
 
       inside(parent_options[:root]) do
         test = "--test #{options[:test]}"
-        run("bundle gem #{_name} #{test} --no-coc --no-mit")
+        ci = "--ci #{options[:ci]}"
+        changelog = "--no-changelog" if bundler_version >= Gem::Version.new("2.2.8")
+        continue = (
+          run("bundle gem #{_name} #{test} #{ci} --rubocop #{changelog} --no-coc --no-mit") ||
+          options[:pretend]
+        )
+        exit 1 unless continue
       end
     end
 
@@ -49,6 +58,9 @@ module Runbook::Generators
       remove_file(readme)
 
       gemfile = File.join(*dirs, "Gemfile")
+      if File.exist?(gemfile)
+        @gemfile_file_contents = File.readlines(gemfile)
+      end
       remove_file(gemfile)
 
       base_file = File.join(*dirs, "lib", "#{_name}.rb")
@@ -98,14 +110,25 @@ module Runbook::Generators
       template("templates/Gemfile.tt", target)
 
       # Add development dependencies from gemspec
-      return unless @gemspec_file_contents
-      gems = @gemspec_file_contents.select do |line|
-        line =~ /  spec.add_development_dependency/
-      end.map do |line|
-        line.gsub(/  spec.add_development_dependency/, "gem")
-      end.join
-
-      append_to_file(target, "\n#{gems}", verbose: false)
+      if @gemspec_file_contents
+        gems = @gemspec_file_contents.select do |line|
+          line =~ /  spec.add_development_dependency/
+        end.map do |line|
+          line.gsub(/  spec.add_development_dependency/, "gem")
+        end.join
+
+        append_to_file(target, "\n#{gems}", verbose: false)
+      end
+
+      # Add gemfile gems
+      if @gemfile_file_contents
+        gems = @gemfile_file_contents.select do |line|
+          line =~ /^gem /
+        end.join
+
+        append_to_file(target, "\n#{gems}", verbose: false)
+      end
+
     end
 
     def create_base_file