piotrb_cli_utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3cb0debcbe966ad1de8f288ddefc096d7dfcd68fb89f84b7ace3a4b3f3b63a1
+  data.tar.gz: b2edfdfaa4a185947a8d6ec85217c4a6d298e1b82064d32ce05a36d41a19c4af
+SHA512:
+  metadata.gz: 9d26d350387060a6306ba609ab15f2c9f2509e1e847b5663e8d9700382161f1ec0aa8a3b7f565f19bab1a97d9564155044fd5df56d8a38ab24c840baeaffa5c0
+  data.tar.gz: 6d576945365c77c9bc91ab252917f3571aea7f03bd35175e0b3f25bd4755b5d03d5b47ca8c2b9383968fc03dcc6e2099be0a8f6a6bead836d38b45725eda6331

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in piotrb_cli_utils.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Piotr Banasik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# PiotrbCliUtils
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/piotrb_cli_utils`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'piotrb_cli_utils'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install piotrb_cli_utils
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/piotrb_cli_utils.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "piotrb_cli_utils"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/piotrb_cli_utils.rb

@@ -0,0 +1,15 @@
+require 'shellwords'
+require 'open3'
+
+require 'tty-reader'
+require 'cri'
+require 'paint'
+
+require_relative 'piotrb_cli_utils/version'
+require_relative 'piotrb_cli_utils/cmd_loop'
+require_relative 'piotrb_cli_utils/cri_command_support'
+require_relative 'piotrb_cli_utils/shell_helpers'
+require_relative 'piotrb_cli_utils/util'
+
+module PiotrbCliUtils
+end

data/lib/piotrb_cli_utils/cmd_loop.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PiotrbCliUtils
+  module CmdLoop
+    def run_cmd_loop(prompt = '=> ')
+      reader = TTY::Reader.new(interrupt: :noop)
+      reader.on(:keyctrl_c, :keyescape) do
+        return :abort
+      end
+
+      reader.on(:keyctrl_d) do
+        return :eof
+      end
+
+      catch(:stop) do
+        loop do
+          line = reader.read_line(prompt)
+          line.strip!
+          yield(line)
+        end
+      end || :stopped
+    end
+  end
+end

data/lib/piotrb_cli_utils/cri_command_support.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module PiotrbCliUtils
+  module CriCommandSupport
+    def define_cmd(name, summary: nil, help: false, &block)
+      cmd_name = name
+      Cri::Command.define do
+        name cmd_name
+        summary summary
+        option nil, :help, 'show help for this command'
+        run do |opts, args, cmd|
+          if opts[:help]
+            puts cmd.help
+          else
+            if block
+              block.call(opts, args, cmd)
+            elsif help
+              puts cmd.help
+            else
+              warn "no action defined for cmd: #{cmd.name}"
+            end
+          end
+        end
+      end
+    end
+
+    def exit_cmd
+      define_cmd('exit') do |_opts, _args, _cmd|
+        throw :stop, :exit
+      end
+    end
+  end
+end

data/lib/piotrb_cli_utils/shell_helpers.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module PiotrbCliUtils
+  module ShellHelpers
+    def join_cmd(args)
+      if args.is_a? Array
+        Shellwords.join(args)
+      else
+        args
+      end
+    end
+
+    def run_shell(command, return_status: false, echo_command: true, quiet: false, indent: 0)
+      command = join_cmd(command)
+      puts "#{' ' * indent}$> #{command}" if echo_command
+      command += ' 1>/dev/null 2>/dev/null' if quiet
+      system command.to_s
+      code = $CHILD_STATUS.exitstatus
+      raise("failed with code: #{code}") if !return_status && code > 0
+
+      code
+    end
+
+    def run_with_each_line(command)
+      command = join_cmd(command)
+      Open3.popen2e(command) do |_stdin, stdout_and_stderr, wait_thr|
+        pid = wait_thr.pid # pid of the started process.
+        until stdout_and_stderr.eof?
+          raw_line = stdout_and_stderr.gets
+          yield(raw_line)
+        end
+        wait_thr.value # Process::Status object returned.
+      end
+    end
+
+    def capture_shell(command, error: true, echo_command: true, indent: 0, raise_on_error: false, detailed_result: false)
+      command = join_cmd(command)
+      puts "#{' ' * indent}<< #{command}" if echo_command
+      command += ' 2>/dev/null' unless error
+      value = `#{command}`
+      code = $CHILD_STATUS.exitstatus
+      if raise_on_error && code > 0
+        raise("capture_shell: #{command.inspect} failed with code: #{code}")
+      end
+
+      if detailed_result
+        OpenStruct.new({
+                         status: code,
+                         output: value
+                       })
+      else
+        value
+      end
+    end
+  end
+end

data/lib/piotrb_cli_utils/util.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module PiotrbCliUtils
+  module Util
+    def fail_with(*messages, code: 1)
+      messages.each do |message|
+        warn(Paint[message, :red])
+      end
+      exit code
+    end
+
+    def log(message, depth: 0, newline: true)
+      message = Array(message)
+      message.each do |m|
+        indent = '  ' * depth
+        print indent + m
+        print "\n" if newline
+      end
+    end
+  end
+end

data/lib/piotrb_cli_utils/version.rb

@@ -0,0 +1,3 @@
+module PiotrbCliUtils
+  VERSION = "0.1.0"
+end

data/piotrb_cli_utils.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/piotrb_cli_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "piotrb_cli_utils"
+  spec.version       = PiotrbCliUtils::VERSION
+  spec.authors       = ["Piotr Banasik"]
+  spec.email         = ["piotr.banasik@gmail.com"]
+
+  spec.summary       = %q{CLI Utils for my command line scripts}
+  # spec.description   = %q{}
+  spec.homepage      = "https://github.com/piotr/cli_utils"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/piotr/cli_utils"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "tty-reader"
+  spec.add_dependency "cri"
+  spec.add_dependency "paint"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: piotrb_cli_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Banasik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- piotr.banasik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/piotrb_cli_utils.rb
+- lib/piotrb_cli_utils/cmd_loop.rb
+- lib/piotrb_cli_utils/cri_command_support.rb
+- lib/piotrb_cli_utils/shell_helpers.rb
+- lib/piotrb_cli_utils/util.rb
+- lib/piotrb_cli_utils/version.rb
+- piotrb_cli_utils.gemspec
+homepage: https://github.com/piotr/cli_utils
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/piotr/cli_utils
+  source_code_uri: https://github.com/piotr/cli_utils
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: CLI Utils for my command line scripts
+test_files: []