pocketwatch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5388ad0287b782cbfcbd2fd09befcca9f0103d8b415cf60e2cc19b0016c64bbf
+  data.tar.gz: 627a66a496dd946cb70975d9861e5c2be3b2a77773a5d9a52a6dd525e264de98
+SHA512:
+  metadata.gz: eb3d6d5b7abb3a4feee7c241ddc261116a0b7d46a6d286f2127f83ace85cc899d38e54d993dee5da5db104d70fedefc37ece19e16d2f87071f10c37c990c4216
+  data.tar.gz: d7bf7e1e7f854a299f03b69320eb1710082e6deb1956218d740ac7459a7e54e5d08e52197c66f2ef9dca98c6e838dffd20afd22ed9bf934a279cdbe1404a8829

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.5.5

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    pocketwatch (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    backport (1.1.2)
+    benchmark (0.1.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    maruku (0.7.3)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    reverse_markdown (1.4.0)
+      nokogiri
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    rufo (0.10.0)
+    solargraph (0.38.2)
+      backport (~> 1.1)
+      benchmark
+      bundler (>= 1.17.2)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      maruku (~> 0.7, >= 0.7.3)
+      nokogiri (~> 1.9, >= 1.9.1)
+      parser (~> 2.3)
+      reverse_markdown (~> 1.0, >= 1.0.5)
+      rubocop (~> 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9)
+    thor (1.0.1)
+    tilt (2.0.10)
+    unicode-display_width (1.6.1)
+    yard (0.9.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pocketwatch!
+  pry-byebug
+  rake (~> 12.0)
+  rufo
+  solargraph
+
+BUNDLED WITH
+   2.1.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Taylor Thurlow
+
+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,19 @@
+# Pocketwatch
+
+`pocketwatch` is a clone of the `watch` utility found on many UNIX-based operating systems. It exists entirely due to the fact that `watch` swallows CTRL-code shortcuts that aren't CTRL-C (interrupt), and as a result, makes it really difficult to use CTRL codes to navigate around terminal panes. A Ruby implementation serves the same purpose but doesn't jack up my terminal navigation.
+
+Yes, that's the only reason this exists.
+
+## Installation
+
+```bash
+gem install pocketwatch
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/pocketwatch

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "pocketwatch"
+
+Pocketwatch.start(ARGV)

data/lib/pocketwatch/version.rb

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

data/lib/pocketwatch/watcher.rb

@@ -0,0 +1,55 @@
+module Pocketwatch
+  class Watcher
+    # @return [String] the command to run on an interval
+    attr_reader :command
+
+    # @return [Hash] the options hash determined by the command-line option
+    #   parser
+    attr_reader :options
+
+    # @param command [String] the command to run on an interval
+    # @param options [Hash] the options hash determined by the command-line
+    #   option parser
+    def initialize(command, options = {})
+      @command = command
+
+      if @command.nil? || @command.empty?
+        warn "No command provided."
+        exit 1
+      end
+      @options = options
+    end
+
+    # Begin the watcher task, executing the provided command in a loop. The
+    # loop will only break when interrupted in the shell.
+    #
+    # @return [void]
+    def run
+      loop do
+        # Double buffer the output by precomputing the results of the system
+        # call. Then, clear the terminal and print the results as quickly as
+        # possible - this should avoid any flickering due to clearing the
+        # terminal.
+        output = `#{@command}`
+
+        clear_screen
+        puts output
+
+        sleep(@options[:interval] || 2)
+      end
+    rescue Errno::EPIPE, SystemExit, Interrupt
+      clear_screen
+      exit 0
+    end
+
+    private
+
+    # Clear the terminal screen by writing a control code to the terminal. This
+    # avoids having to shell out to run something like `clear`.
+    #
+    # @return [void]
+    def clear_screen
+      puts "\e[H\e[2J"
+    end
+  end
+end

data/lib/pocketwatch.rb

@@ -0,0 +1,46 @@
+require "optparse"
+
+require_relative "pocketwatch/watcher"
+
+module Pocketwatch
+  # Parse the ARGV input and run the command watcher.
+  #
+  # @param args [Array<String>] the array of input arguments, typically `ARGV`
+  #
+  # @return [void]
+  def self.start(args)
+    options = parse(args)
+    Watcher.new(args.join(" "), options).run
+  end
+
+  # Parse an argument list for configuration options
+  #
+  # @param args [Array<String>] the array of input arguments, typically `ARGV`
+  #
+  # @return [Hash] the options hash
+  def self.parse(args)
+    options = {}
+
+    parser = OptionParser.new do |opts|
+      opts.banner = "Usage: pocketwatch [options] -- <command>"
+
+      opts.on("-v", "--version", "Print the version number") do
+        puts Pocketwatch::VERSION
+        exit
+      end
+
+      opts.on("-n INTERVAL", Integer, "Interval length in seconds between command execution") do |v|
+        unless v.positive?
+          warn "Must provide a positive integer for the command execution interval."
+          exit
+        end
+
+        options[:interval] = v
+      end
+    end
+
+    parser.parse!(args)
+
+    options
+  end
+end

data/pocketwatch.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative "lib/pocketwatch/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "pocketwatch"
+  spec.version = Pocketwatch::VERSION
+  spec.authors = ["Taylor Thurlow"]
+  spec.email = ["taylorthurlow@me.com"]
+
+  spec.summary = "A clone of UNIX 'watch'."
+  spec.homepage = "https://github.com/taylorthurlow/pocketwatch"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/taylorthurlow/pocketwatch/releases"
+
+  spec.files = `git ls-files`.split
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rufo"
+  spec.add_development_dependency "solargraph"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: pocketwatch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taylor Thurlow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rufo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- taylorthurlow@me.com
+executables:
+- pocketwatch
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/pocketwatch
+- lib/pocketwatch.rb
+- lib/pocketwatch/version.rb
+- lib/pocketwatch/watcher.rb
+- pocketwatch.gemspec
+homepage: https://github.com/taylorthurlow/pocketwatch
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/taylorthurlow/pocketwatch
+  source_code_uri: https://github.com/taylorthurlow/pocketwatch
+  changelog_uri: https://github.com/taylorthurlow/pocketwatch/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: A clone of UNIX 'watch'.
+test_files: []