trent 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bd76ca7ec62253cf51678cf861497c9b7e994d2e
-  data.tar.gz: 494bf1d60e7bed0be13746a83102359fe5e1aa0d
+SHA256:
+  metadata.gz: ae2e50c64156a238d44cea8d8dd2f75d065a67181c83c4c8393b977185a780dc
+  data.tar.gz: 030376142fdf94609f35462eeaf57c6aeae1c3613c2cacaaa3a0b32090a54fea
 SHA512:
-  metadata.gz: aedc27c0447919ba248ed0b883a2dc5d7f327422be206894dfdba9de9abdece1799e4096bd174cf1482bcb253725d5a4de06ffc26bdf9f2e763a4f89f48870c7
-  data.tar.gz: 618011c76aee3f36ae61019f7614de36145db8f1ce836d7bf1f30e1f4bf9dce772bbcf0577e5d3349f58969e56a0f0b4f09b63bee88514c89bf3f782c42f1f79
+  metadata.gz: a04dada57e421b6c9b832dbed4c8f096448dcc89a61afb0da3f0086f2f865816b90e4d6b1f4be9be1d506a47fcf629a64a6bdd1c194407440476c1e145e7b622
+  data.tar.gz: f106b7156d6a8188e58ee7b802b411fc7a297e9dcf52dabcc562234d6710d5e3d91b95e6be45d702051ea2e3ee2e1d559d4d9eb7a6d25b5e95a1054e53c94285

data/CHANGELOG.md

@@ -7,3 +7,13 @@ First release!
 - Ability to run remote ssh commands on Travis CI builds. 
 - Ability to send a comment on the GitHub pull request for the Travis CI build. 
 - Trent only works with Travis-CI at this time. 
+
+### [0.2.0] 2018-08-08
+
+Add `path` function to Trent to perform string replacing in your commands for you. 
+
+### Added
+- Add `path` function to Trent to perform string replacing in your commands for you. 
+
+### Changed
+- Each time you run `sh()` or `ssh()` commands, your command will perform a string replace with all commands you add to `path()`. 

data/README.md

@@ -1,4 +1,8 @@
-# Trent 
+[![Gem](https://img.shields.io/gem/v/formatador.svg)](https://rubygems.org/gems/trent)
+[![Travis (.com)](https://travis-ci.com/levibostian/Trent.svg?branch=development)](https://travis-ci.com/levibostian/Trent)
+[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/levibostian/trent)
+
+# Trent
 
 Run and debug bash commands on Travis-CI much easier.
 
@@ -34,6 +38,10 @@ This makes it difficult to debug when things go wrong. Knowing what commands wer
 
 ```
 $> bundle add trent
+
+or...
+
+$> gem install trent 
 ```
 
 * Create a new Ruby file for the scripts you want to run and create an instance of `Trent`. 
@@ -79,6 +87,9 @@ Let's break this down.
 ```ruby
 # Allow a command to fail and not fail the Travis build. 
 ci.sh("false", :fail_non_success => false) 
+
+# Perform a string replace on your commands where "docker-compose" will be replaced with "/opt/bin/docker-compose"
+ci.path("docker-compose", "/opt/bin/docker-compose")
 ```
 
 # Run remote SSH shell commmands
@@ -137,6 +148,10 @@ ci.config_github('wfoweifwoeifjweoijwefowefweoif')
 ci.github.comment("Tests pass!") # Send comment to pull request for the Travis build. The pull request information is automatically retrieved from the Travis virtual machine the build is running on. 
 ```
 
+# Docs
+
+Trent documentation is hosted [here](https://www.rubydoc.info/gems/trent/0.1.0). 
+
 # Advanced Trent configuration 
 
 ```ruby
@@ -160,8 +175,8 @@ Trent is open for pull requests. Check out the [list of issues](https://github.c
 ### Building Trent 
 
 ```
-$> gem build trent.gemspec
-$> gem install --dev ./trent-X.X.X.gem
+$> bundle install --path vendor/bundle
+$> bundle exec rake init 
 ```
 
 This will install all dependencies including for development. You are ready to write some code. 
@@ -169,14 +184,13 @@ This will install all dependencies including for development. You are ready to w
 While working on Trent, make sure to lint it:
 
 ```
-$> rubocop  --auto-correct 
+$> bundle exec rake lint 
 ```
 
 To test out Trent on your machine:
 
 ```
-$> gem build trent.gemspec
-$> gem install ./trent-X.X.X.gem
+$> bundle exec rake build
 ```
 
 Then, you can use it on your own machine using `require 'trent'` in your ruby scripts. 

data/bin/gem-release.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative '../lib/trent'
+
+ci = Trent.new
+ci.config_github(ENV['DANGER_GITHUB_API_TOKEN'])
+
+ci.sh('printf "%s\\n%s " "---" ":rubygems_api_key:" > ~/.gem/credentials')
+ci.sh('printf $RUBYGEMS_KEY >> ~/.gem/credentials')
+ci.sh('chmod 0600 ~/.gem/credentials')
+
+ci.sh('bundle exec rake publish')
+
+ci.github.comment("Success! Don't forget to create a git tag and git release.")

data/lib/command/command.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Conventient methods when working with commands
+class Command
+  # Takes a hash (paths) and replaces each occurance of the keys with the value within the "command" string.
+  # This is used when you have a "docker-compose ... up -d" command and you want to replace all occurances of "docker-compose" with "/opt/bin/docker-compose".
+  def self.path_replace(command, paths)
+    # I am doing command.split() instead of a simple `gsub()` because I need to replace *whole words* not substrings.
+    edited_command = []
+    command.split(' ').each do |command_phrase|
+      if paths.key? command_phrase
+        edited_command.push(paths[command_phrase])
+      else
+        edited_command.push(command_phrase)
+      end
+    end
+
+    edited_command.join(' ')
+  end
+end

data/lib/command/sh/sh.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'open3'
 
 # Run bash commands locally on machine.

data/lib/command/ssh/ssh.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/ssh'
 
 # Run SSH commands remotely on a server.

data/lib/github/github.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'json'
 require_relative '../log'
@@ -21,6 +23,8 @@ class GitHub
     end
   end
 
+  private
+
   def comment_on_pull_request(message)
     puts "Commenting on GitHub pull request: #{ENV['TRAVIS_REPO_SLUG']}/#{ENV['TRAVIS_PULL_REQUEST']}"
     uri = URI("https://api.github.com/repos/#{ENV['TRAVIS_REPO_SLUG']}/issues/#{ENV['TRAVIS_PULL_REQUEST']}/comments")

data/lib/log.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'colorize'
 
 # Convenient class to log to console in certain ways

data/lib/trent.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'command/ssh/ssh'
 require 'github/github'
 require 'command/sh/sh'
 require 'colorize'
 require_relative './log'
+require 'command/command'
 
 # Communicate with all of the Trent library with this class.
 class Trent
@@ -11,6 +14,8 @@ class Trent
 
     @color = color
     @sh = Sh.new
+
+    @paths = {}
   end
 
   # Configure how to run remote SSH commmands on server.
@@ -23,8 +28,18 @@ class Trent
     @github = GitHub.new(api_key)
   end
 
+  # While working with bash commands, some commands are not added to the path. That's annoying.
+  # Convenient method to assign a command to a path for replacing.
+  # Example:
+  # ci.path("docker-compose", "/opt/bin/docker-compose")
+  # Now, when you use ci.sh("docker-compose -f ... up -d"), it will run "/opt/bin/docker-compose -f ... up -d" instead.
+  def path(command, path)
+    @paths[command] = path
+  end
+
   ## Run ssh command
   def ssh(command, fail_non_success = true)
+    command = Command.path_replace(command, @paths)
     Log.fatal('You did not configure SSH yet.') unless @ssh
 
     puts command.colorize(@color)
@@ -37,6 +52,7 @@ class Trent
 
   # Run local bash command
   def sh(command, fail_non_success = true)
+    command = Command.path_replace(command, @paths)
     puts command.colorize(@color)
 
     result = @sh.run(command)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trent
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Levi Bostian
@@ -52,6 +52,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.58.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.1
 description: "I have been using Travis-CI for a few years to build, test, and deploy
   my apps. Bash is great, but using a higher level language for interacting with Travis
   and the build machine would be very beneficial. \n\n  Trent is a convenient ruby
@@ -65,6 +79,8 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- bin/gem-release.rb
+- lib/command/command.rb
 - lib/command/sh/sh.rb
 - lib/command/ssh/ssh.rb
 - lib/github/github.rb
@@ -90,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Run and debug bash commands on Travis-CI much easier.