runbook 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c6c617aa11aeff1ab914c2f6d4d7b4db2cc5f46e6c70acc67a97eda7ba5b3a6
-  data.tar.gz: 3d68b0e53afbddc94ac0fa7c56eab9a8ac78ad104830c551f79c477314a81c4f
+  metadata.gz: 11c80dcba3596671291c8d9dbd40a33ae5691963b27dffdd7459cb4f4ebd94be
+  data.tar.gz: a8a578797429344e1fa29c84cb395db5c9c725f4b35b00440e26708328fdca26
 SHA512:
-  metadata.gz: cd186e2e3d0bde065b1ed0cccecce8c5943ec6ca626dac0cfa38725f4dd4050f5208df8343e770c602f2ec6cf7b38be9b01fee69ac0f304a16a14fe6c610378a
-  data.tar.gz: 4ce8c856c8cbd26cbffdfc1f7c2fe1b1fad5f6d5cdfc511d3be731d8db43db5ddeff1abf1d1ab2738374ac5eac27dbe33151e99f97abd604f3ddebb10394bf8c
+  metadata.gz: bda3ee51331bcac0c38f338e4ddcf001847328f07093ff1163b8a8b4394e523b116c05b88de449d7072dc90fbe51da3049f00778933a8e8d0b8d3eac39c935c0
+  data.tar.gz: 11420133d97afa081df1105bbf3dc1364b5722aa50e57f49777f761c2df88b152b50b4db80c2da81a8d10328bc85b46de51721a010113d26b965411243a51e68

data/.travis.yml

@@ -3,26 +3,23 @@ language: ruby
 services:
   - docker
 rvm:
-  - 2.2.10
   - 2.3.8
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0
 gemfile:
   - gemfiles/activesupport_5.gemfile
   - gemfiles/activesupport_6.gemfile
 matrix:
   exclude:
-    - rvm: 2.2.3
-      gemfile: gemfiles/activesupport_6.gemfile
-    - rvm: 2.2.10
-      gemfile: gemfiles/activesupport_6.gemfile
     - rvm: 2.3.8
       gemfile: gemfiles/activesupport_6.gemfile
-    - rvm: 2.4.6
+    - rvm: 2.4.10
       gemfile: gemfiles/activesupport_6.gemfile
 
-before_install: gem install bundler -v 1.15.4
+before_install: gem install bundler -v 2.2.16
 
 script:
   - bundle exec rake spec_all

data/CHANGELOG.md

@@ -4,6 +4,23 @@ This log maintains a list of all substantive changes to Runbook. The log include
 
 ## master
 
+## `v1.1.0` (2021-05-21)
+
+### Breaking Changes:
+
+* Removes `runbook install` (should have happened in v1.0.0)
+* Drops support for Ruby 2.2 and bundler < 2.2
+
+### Features:
+
+* Add support for Ruby 3.0.0 (thanks @pblesi!)
+* Add metadata argument that saves TMUX panes: keep_panes (thanks @ClashTheBunny)
+
+### Documentation:
+
+* Update assert parameters description
+* Update example for module class method (thanks @voodoologic!)
+
 ## `v1.0.0` (2020-07-24)
 
 ### Breaking Changes:

data/README.md

@@ -321,16 +321,16 @@ In the above example, the `note` statement must be wrapped in a `ruby_command` s
 
 ##### Assert
 
-Runs the provided `cmd` repeatedly until it returns true. A timeout and maximum number of attempts can be set. You can specify a command to be run if a timeout occurs or the maximum number of attempts is hit. Commands can optionally be specified as `raw`. This tells SSHKit to not perform auto-wrapping of the commands, but execute the exact string on the remote server. See SSHKit's documentation for more details.
+Runs the provided `cmd` repeatedly until it returns true. A timeout and maximum number of attempts can be set. When either the attempt or timeout limit is hit, a command can be specified that will be run. If no command is specified, the process will fail. Commands can optionally be specified as `raw`. This tells SSHKit to not perform auto-wrapping of the commands, but execute the exact string on the remote server. See SSHKit's documentation for more details.
 
 ```ruby
 assert(
   'service nginx status | grep "is running"',
   cmd_ssh_config: {servers: ["host1.prod"], parallelization: {strategy: :parallel}},
   cmd_raw: false,
-  interval: 3, # seconds
-  timeout: 300, # seconds
-  attempts: 3,
+  interval: 3,   # How often, in seconds, to wait between tries
+  timeout: 300,  # Total time, in seconds, to keep trying command, after which it will fail
+  attempts: 3,   # Total number of attempts after which the process will fail
   abort_statement: Runbook::Statements::Command.new(
     "echo 'help' | mail -s 'need help' page-me@page-me.com",
     ssh_config: {servers: [:local], parallelization: {strategy: :parallel}},
@@ -443,6 +443,7 @@ Metadata at execution time is structured as follows:
   noop: false, # A boolean indicating if you are running in noop mode. ruby_command blocks are never evaluated in noop mode
   auto: false, # A boolean indicating if you are running in auto mode
   paranoid: true, # A boolean indicating if you are running in paranoid mode (prompting before each step)
+  keep_panes: false, # A boolean indicating whether panes should be kept open after completion
   start_at: 0, # A string representing the step where nodes should start being processed
   toolbox: Runbook::Toolbox.new, # A collection of methods to invoke side-effects such as printing and collecting input
   layout_panes: {}, # A map of pane names to pane ids. `layout_panes` is used by the `tmux_command` to identify which tmux pane to send the command to
@@ -1208,7 +1209,7 @@ When defining and referencing your own functions in a runbook, functions should
 
 ```ruby
 module Adder
-  def add(x, y)
+  def self.add(x, y)
     x + y
   end
 end

data/dockerfiles/Dockerfile-runbook

@@ -1,4 +1,4 @@
-FROM ruby:2.5
+FROM ruby:3.0
 RUN apt-get update -qq && apt-get install -y build-essential tmux
 
 RUN mkdir /runbook

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"

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}"

data/lib/runbook/entity.rb

@@ -26,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

data/lib/runbook/extensions/statements.rb

@@ -1,7 +1,7 @@
 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)

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

@@ -22,15 +22,20 @@ 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]}"
+        ci = "--ci #{options[:ci]}"
+        changelog = "--no-changelog" if bundler_version >= Gem::Version.new("2.2.8")
         continue = (
-          run("bundle gem #{_name} #{test} --no-coc --no-mit") ||
+          run("bundle gem #{_name} #{test} #{ci} --rubocop #{changelog} --no-coc --no-mit") ||
           options[:pretend]
         )
         exit 1 unless continue
@@ -53,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")
@@ -102,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

data/lib/runbook/run.rb

@@ -258,7 +258,7 @@ module Runbook
         :after,
         Runbook::Entities::Book,
       ) do |object, metadata|
-        next if metadata[:noop] || metadata[:layout_panes].none?
+        next if metadata[:noop] || metadata[:layout_panes].none? || metadata[:keep_panes]
         if metadata[:auto]
           metadata[:toolbox].output("Killing all opened tmux panes...")
           kill_all_panes(metadata[:layout_panes])

data/lib/runbook/runner.rb

@@ -11,6 +11,7 @@ module Runbook
       noop: false,
       auto: false,
       paranoid: true,
+      keep_panes: false,
       start_at: "0"
     )
       run = "Runbook::Runs::#{run.to_s.camelize}".constantize
@@ -21,6 +22,7 @@ module Runbook
         paranoid: Util::Glue.new(paranoid),
         start_at: Util::Glue.new(start_at || "0"),
         toolbox: Util::Glue.new(toolbox),
+        keep_panes: keep_panes,
         book_title: book.title,
       }).
       merge(Runbook::Entities::Book.initial_run_metadata).

data/lib/runbook/version.rb

@@ -1,3 +1,3 @@
 module Runbook
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/runbook.gemspec

@@ -32,7 +32,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "activesupport", ">= 5.0.1.x", "< 7.0"
-  spec.add_runtime_dependency "method_source", "~> 0.9"
+  spec.add_runtime_dependency "method_source", "~> 1.0"
+  spec.add_runtime_dependency "ruby2_keywords", "~> 0.0.4"
   spec.add_runtime_dependency "sshkit", "1.21.0"
   spec.add_runtime_dependency "sshkit-sudo", "~> 0.1"
   spec.add_runtime_dependency "airbrussh", "~> 1.4"
@@ -42,10 +43,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "appraisal", "~> 2.2"
   spec.add_development_dependency "aruba", "~> 0.14"
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "bundler", "~> 2.2"
   spec.add_development_dependency "bcrypt_pbkdf", ">= 1.0", "< 2.0"
   spec.add_development_dependency "ed25519", ">= 1.2", "< 2.0"
-  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency "pry", "~> 0.13"
   spec.add_development_dependency "pry-byebug", "~> 3.6"
   spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runbook
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - pblesi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-24 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -36,14 +36,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: sshkit
   requirement: !ruby/object:Gem::Requirement
@@ -162,14 +176,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
   requirement: !ruby/object:Gem::Requirement
@@ -216,14 +230,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -398,7 +412,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Write beautiful, executable runbooks for conducting system operations.