sxmrb 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaec2808aa258c444c32e6fcd3b25905115a2265d2cab3f4cb2e9c0c7b614aea
-  data.tar.gz: 1295875b0cbe75caa8f5cf14ac48faf4ed949f014a85494bd1ffd12d7e0710fa
+  metadata.gz: 747dff11cd326291eea482413ce698ffb329503bb695bee27b44c3138432b338
+  data.tar.gz: d0b285f5e948e1569892e31752490690354ef0756910d055fd9b33155b298c63
 SHA512:
-  metadata.gz: 84ea47112cab58346aee700ca89e6a6fa81ba2383d54956d02ca6db606bfad8e169e36d6ad939aeb1c380180424279ac33bb16bc419881505b2400aad4c6ccbd
-  data.tar.gz: 1d6a11d6678faa7eed03d91ee650da9cd30838a171381d9df3746494855db1568bfeeb38d5c2d38c78502669edd5a2fe827b6bbbe2bce0d85cd9c01302d1b215
+  metadata.gz: ad9cdb4a7caff2b5488f8a73a2c5e8fca4e30bd8eee44de3be117a52844eafb04a78db194aad5fd93d3060a4afbb45a7d2f62bca27ec5e8900fa82d10cf05813
+  data.tar.gz: fe55d8de0f68cae3eab8dfb8a185091cfe0c955f4591f77f25ccde0e9df9d1fe1511b9ee188d11806fe9f11e58ccfed1b2772c3e10e9f7295edcbedd076fd071

data/.rubocop.yml

@@ -10,6 +10,9 @@ Layout/LineLength:
 Lint/AmbiguousBlockAssociation:
   Enabled: false
 
+Style/BlockDelimiters:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: single_quotes

data/Gemfile

@@ -12,3 +12,5 @@ gem 'minitest', '~> 5.0'
 gem 'rubocop', '~> 1.7'
 gem 'rubocop-minitest'
 gem 'rubocop-rake'
+
+gem 'gem-release'

data/README.md

@@ -31,6 +31,14 @@ end
 
 ## Usage
 
+### Prompt for a value:
+
+```ruby
+value = Sxmrb.input(prompt: 'Amount?')
+```
+
+### Build a menu:
+
 ```ruby
 def main_menu
   Sxmrb.echo(<<~'END') | Sxmrb.menu(prompt: 'Ledger')
@@ -42,8 +50,28 @@ def main_menu
 end
 ```
 
+### Wrap a system command:
+
 ```ruby
-value = Sxmrb.input(prompt: 'Amount?')
+def ledger(file: @file, command: nil, rest: nil)
+  Sxmrb.sh String.new('ledger').tap { |cmd|
+    cmd << " -f #{file.inspect}" if file
+    cmd << " #{command}"         if command
+    cmd << " #{rest}"            if rest
+  }
+end
+```
+
+### Build a menu from a system command:
+
+```ruby
+def accounts(query: nil)
+  ledger(command: 'accounts', rest: query)
+end
+
+def input_account
+  (accounts | Sxmrb.menu(prompt: 'Account?')).to_s.chomp
+end
 ```
 
 ## Development

data/lib/sxmrb.rb

@@ -5,36 +5,112 @@ require_relative 'sxmrb/version'
 require 'shell'
 require 'shellwords'
 
+require 'singleton'
+require 'forwardable'
+
 # SXMO user scripts in ruby.
-module Sxmrb
-  class <<self
-    class Error < StandardError; end
+class Sxmrb
+  include Singleton
 
-    def sh(...)
-      (@_sh ||= Shell.new).system(...)
-    rescue StandardError => e
-      raise Error, e
-    end
+  # Normally when using Singleton there is no way to pass arguments
+  # when instantiating.  The renew hack below allows the singleton
+  # instance to be re-instantiated and can pass arguments at that time;
+  # this was added as an experiment to assist with testing.
+  def initialize(shell: ::Shell.new) # :nodoc:
+    @_sh = shell
+  end
 
-    def menu(prompt: nil)
-      sh String.new.tap { |cmd|
-        if ENV['SSH_CLIENT'] || ENV['SSH_TTY']
-          cmd << 'vis-menu -i -l 18'
-        else
-          cmd << 'dmenu -c -i -l 18'
-          sh 'sxmo_keyboard.sh open'
-        end
+  # Run a system shell command.
+  #
+  # @example
+  #   sh('ls -tr').to_s.lines.last
+  def sh(...)
+    @_sh.system(...)
+  rescue ::StandardError => e
+    raise Error, e
+  end
 
-        cmd << " -p #{prompt.inspect}" if prompt
-      }
-    end
+  # Display a menu using dmenu [X11] or vis-menu [ssh].
+  # A newline-separated list of items is read from standard input.
+  # The selected item is printed to standard output.
+  #
+  # @example
+  #   file = (sh('ls') | menu(prompt: 'File?')).to_s.chomp
+  def menu(prompt: nil)
+    sh String.new.tap { |cmd|
+      if ENV['SSH_CLIENT'] || ENV['SSH_TTY']
+        cmd << 'vis-menu -i -l 18'
+      else
+        cmd << 'dmenu -c -i -l 18'
+        sh 'sxmo_keyboard.sh open'
+      end
 
-    def echo(arg = '')
-      sh("echo #{Shellwords.escape arg.chomp}")
-    end
+      cmd << " -p #{prompt.inspect}" if prompt
+    }
+  end
+
+  # Run the awk command.
+  #
+  # @example
+  #   print(sh('ls -l') | awk('{print $1}').to_s)
+  def awk(arg = '')
+    sh("awk -e #{Shellwords.escape arg.chomp}")
+  end
+
+  # Run the cat command.
+  #
+  # @example
+  #   print cat('/etc/passwd').to_s
+  def cat(arg = '')
+    sh("cat #{arg.chomp}")
+  end
 
-    def input(prompt:)
-      (echo | menu(prompt: prompt)).to_s.chomp
+  # Run the column command.
+  #
+  # @example
+  #   print(sh('ls -l') | column('-t').to_s)
+  def column(arg = '')
+    sh("column #{arg.chomp}")
+  end
+
+  # Run the shell echo command.
+  #
+  # @example
+  #   print echo('Hello World').to_s
+  def echo(arg = '')
+    sh("echo #{Shellwords.escape arg.chomp}")
+  end
+
+  # Run the tac command.
+  #
+  # @example
+  #   print tac('/etc/passwd').to_s
+  def tac(arg = '')
+    sh("tac #{arg.chomp}")
+  end
+
+  # Use a blank #menu to prompt for a value.
+  #
+  # @example
+  #   value = input(prompt: 'Amount?').to_i
+  def input(prompt:)
+    (echo | menu(prompt: prompt)).to_s.chomp
+  end
+
+  class <<self
+    # This evil hack experiment is intended to allow swapping out the
+    # Shell instance when testing.
+    def renew_instance(...) # :nodoc:
+      @singleton__mutex__.synchronize {
+        @singleton__instance__ = new(...)
+      }
     end
+
+    # Forward instance methods to the Singleton instance; false here
+    # excludes ancestor methods.
+    extend Forwardable
+    def_delegators :instance, *Sxmrb.instance_methods(false)
   end
+
+  class Error < ::StandardError; end
 end

data/lib/sxmrb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Sxmrb
-  VERSION = '0.1.0'
+class Sxmrb
+  VERSION = '0.1.1'
 end

data/sxmrb.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Ruby library for SXMO user scripts.'
   spec.homepage      = 'https://gitlab.com/fjc/sxmrb'
   spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sxmrb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Frank J. Cameron
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shell
@@ -73,7 +73,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="