sxmrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aaec2808aa258c444c32e6fcd3b25905115a2265d2cab3f4cb2e9c0c7b614aea
+  data.tar.gz: 1295875b0cbe75caa8f5cf14ac48faf4ed949f014a85494bd1ffd12d7e0710fa
+SHA512:
+  metadata.gz: 84ea47112cab58346aee700ca89e6a6fa81ba2383d54956d02ca6db606bfad8e169e36d6ad939aeb1c380180424279ac33bb16bc419881505b2400aad4c6ccbd
+  data.tar.gz: 1d6a11d6678faa7eed03d91ee650da9cd30838a171381d9df3746494855db1568bfeeb38d5c2d38c78502669edd5a2fe827b6bbbe2bce0d85cd9c01302d1b215

data/.gitignore

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

data/.gitlab-ci.yml

@@ -0,0 +1,9 @@
+image: ruby:2.7.3
+
+before_script:
+  - gem install bundler -v 2.2.17
+  - bundle install
+
+example_job:
+  script:
+    - bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-05-16
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sxmrb.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'minitest', '~> 5.0'
+
+gem 'rubocop', '~> 1.7'
+gem 'rubocop-minitest'
+gem 'rubocop-rake'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Frank J. Cameron
+
+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,71 @@
+# Sxmrb
+
+Ruby library for SXMO[1] user scripts.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sxmrb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sxmrb
+
+Or use an inline bundle:
+
+```ruby
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'sxmrb'
+end
+```
+
+## Usage
+
+```ruby
+def main_menu
+  Sxmrb.echo(<<~'END') | Sxmrb.menu(prompt: 'Ledger')
+    Add Transaction
+    Balance
+    Budget
+    Quit
+    END
+end
+```
+
+```ruby
+value = Sxmrb.input(prompt: 'Amount?')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install
+dependencies. Then, run `rake test` to run the tests. 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 the created tag, and
+push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at
+https://gitlab.com/fjc/sxmrb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+[1]: https://sr.ht/~mil/Sxmo/

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'sxmrb'
+
+# 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/sxmrb.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'sxmrb/version'
+
+require 'shell'
+require 'shellwords'
+
+# SXMO user scripts in ruby.
+module Sxmrb
+  class <<self
+    class Error < StandardError; end
+
+    def sh(...)
+      (@_sh ||= Shell.new).system(...)
+    rescue StandardError => e
+      raise Error, e
+    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
+
+        cmd << " -p #{prompt.inspect}" if prompt
+      }
+    end
+
+    def echo(arg = '')
+      sh("echo #{Shellwords.escape arg.chomp}")
+    end
+
+    def input(prompt:)
+      (echo | menu(prompt: prompt)).to_s.chomp
+    end
+  end
+end

data/lib/sxmrb/version.rb

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

data/sxmrb.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/sxmrb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sxmrb'
+  spec.version       = Sxmrb::VERSION
+  spec.authors       = ['Frank J. Cameron']
+  spec.email         = ['fjc@fastmail.net']
+
+  spec.summary       = 'Ruby library for SXMO user scripts.'
+  spec.homepage      = 'https://gitlab.com/fjc/sxmrb'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/-/blob/master/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency 'example-gem', '~> 1.0'
+
+  spec.add_dependency 'shell'
+  spec.add_dependency 'shellwords'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: sxmrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frank J. Cameron
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shell
+  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: shellwords
+  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:
+- fjc@fastmail.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sxmrb.rb
+- lib/sxmrb/version.rb
+- sxmrb.gemspec
+homepage: https://gitlab.com/fjc/sxmrb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/fjc/sxmrb
+  source_code_uri: https://gitlab.com/fjc/sxmrb
+  changelog_uri: https://gitlab.com/fjc/sxmrb/-/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Ruby library for SXMO user scripts.
+test_files: []