shell-lite 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c914ac1049a2318b40d79ed5185095c30ffcfb0
+  data.tar.gz: c73473f778d47775bf793bdeaed87bfa66c1cd94
+SHA512:
+  metadata.gz: 1d0b8d2d7b4e674f8f526d93a996f2762ac0c75495ca14a047280ecbb23fda6c1feb6f2d2279be57e41c79b47e88395214f57f5968a73a84d229a07a3d4bc1da
+  data.tar.gz: 924816787421c3f8681b78d826b7b71c5286e6b155752b85873a561dceeb3ebd39fc2b058b392522e31ffbc855e5b31d35729e9e4b806a8436145664eb9f7f64

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+### 0.0.1 / 2020-10-19
+
+* Everything is new. First release.
+

data/Manifest.txt

@@ -0,0 +1,9 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/shell-lite.rb
+lib/shell-lite/shell.rb
+lib/shell-lite/version.rb
+test/helper.rb
+test/test_shell.rb

data/README.md

@@ -0,0 +1,23 @@
+# shell-lite
+
+shell-lite gem  -  shell command line helper / wrapper 'n' more for your computer
+
+* home  :: [github.com/rubycoco/git](https://github.com/rubycoco/git)
+* bugs  :: [github.com/rubycoco/git/issues](https://github.com/rubycoco/git/issues)
+* gem   :: [rubygems.org/gems/shell-lite](https://rubygems.org/gems/shell-lite)
+* rdoc  :: [rubydoc.info/gems/shell-lite](http://rubydoc.info/gems/shell-lite)
+
+
+
+## Usage
+
+To be done
+
+
+
+
+## License
+
+The `shell-lite` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+

data/Rakefile

@@ -0,0 +1,28 @@
+require 'hoe'
+require './lib/shell-lite/version.rb'
+
+Hoe.spec 'shell-lite' do
+
+  self.version = ShellLite::VERSION
+
+  self.summary = "shell-lite gem  -  shell command line helper / wrapper 'n' more for your computer"
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/rubycoco/git' }
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'ruby-talk@ruby-lang.org'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = []
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+   required_ruby_version: '>= 2.2.2'
+  }
+
+end

data/lib/shell-lite.rb

@@ -0,0 +1,84 @@
+require 'pp'
+require 'time'
+require 'date'    ## e.g. Date.today etc.
+require 'yaml'
+require 'json'
+require 'uri'
+require 'net/http'
+require "net/https"
+require 'open3'
+require 'fileutils'    ## e.g. FileUtils.mkdir_p etc.
+
+##########################
+# more defaults ("prolog/prelude") always pre-loaded
+require 'optparse'
+require 'rbconfig'
+
+#####################
+# our own code
+require 'shell-lite/version'   # note: let version always go first
+require 'shell-lite/shell'
+
+
+
+
+## add some system info from/via rbconfig - why? why not?
+module Computer
+
+OS = case RbConfig::CONFIG['host_os'].downcase
+when /linux/
+  "linux"
+when /darwin/
+  "darwin"
+when /freebsd/
+  "freebsd"
+when /netbsd/
+  "netbsd"
+when /openbsd/
+  "openbsd"
+when /dragonfly/
+  "dragonflybsd"
+when /sunos|solaris/
+  "solaris"
+when /mingw|mswin/
+  "windows"
+else
+  RbConfig::CONFIG['host_os'].downcase
+end
+
+CPU = RbConfig::CONFIG['host_cpu']   ## todo/check: always use downcase - why? why not?
+
+ARCH = case CPU.downcase
+when /amd64|x86_64|x64/
+  "x86_64"
+when /i?86|x86|i86pc/
+  "i386"
+when /ppc64|powerpc64/
+  "powerpc64"
+when /ppc|powerpc/
+  "powerpc"
+when /sparcv9|sparc64/
+  "sparcv9"
+when /arm64|aarch64/  # MacOS calls it "arm64", other operating systems "aarch64"
+  "aarch64"
+when /^arm/
+  "arm"
+else
+  RbConfig::CONFIG['host_cpu']   ## todo/check: always use downcase - why? why not?
+end
+
+def self.os()   OS;   end
+def self.cpu()  CPU;  end
+def self.arch() ARCH; end
+
+
+end  # module Computer
+
+
+######################
+# add convenience shortcuts - why? why not?
+Compu = Computer
+
+
+# say hello
+puts ShellLite.banner

data/lib/shell-lite/shell.rb

@@ -0,0 +1,57 @@
+module Computer
+
+
+## raised / thrown by Shell.run if exit status non-zero
+##   todo/check: (re)use an already existing error - why? why not?
+class ShellError < StandardError
+end
+
+
+###
+#  use nested class for "base" for running commands - why? why not?
+class Shell
+
+  ## use call for the "to-the-metal" command execution
+  def self.call( cmd )
+    stdout, stderr, status = Open3.capture3( cmd )
+    [stdout, stderr, status]
+  end
+
+
+  ## use run for "porcelain / high-level" command execution
+  def self.run( cmd )
+    ## add pwd (print working directory to output?) - why? why not?
+    print "---> (shell run) >#{cmd}<..."
+    stdout, stderr, status = Open3.capture3( cmd )
+
+    ## todo: add colors (red, green) - why? why not?
+    if status.success?
+      print " OK"   ## todo/check: use OK (0) - why? why not?
+      print "\n"
+    else
+      print " FAIL (#{status.exitstatus})"
+      print "\n"
+    end
+
+    unless stdout.empty?
+      puts stdout
+    end
+
+    unless stderr.empty?
+      ## todo/check: or use >2: or &2: or such
+      ##  stderr output not always an error (that is, exit status might be 0)
+      STDERR.puts "2>"
+      STDERR.puts stderr
+    end
+
+    if status.success?
+      stdout   # return stdout string
+    else
+      STDERR.puts "!! ERROR: Shell.run >#{cmd}< failed with exit status #{status.exitstatus}:"
+      STDERR.puts stderr
+
+      raise ShellError, "Shell.run >#{cmd}< failed with exit status #{status.exitstatus}<: #{stderr}"
+    end
+  end
+end  # class Shell
+end  # module Computer

data/lib/shell-lite/version.rb

@@ -0,0 +1,21 @@
+module ShellLite
+
+  MAJOR = 0    ## todo: namespace inside version or something - why? why not??
+  MINOR = 0
+  PATCH = 1
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "shell-lite/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
+  end
+
+end # module ShellLite
+

data/test/helper.rb

@@ -0,0 +1,9 @@
+## minitest setup
+require 'minitest/autorun'
+
+
+## our own code
+require 'shell-lite'
+
+
+

data/test/test_shell.rb

@@ -0,0 +1,33 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_shell.rb
+
+require 'helper'
+
+class TestShell < MiniTest::Test
+
+  Shell = Computer::Shell
+
+  def test_run
+    Shell.run( 'git config user.name' )
+    Shell.run( 'git config --show-origin user.name' )
+    # Shell.run( 'git config xxxx' )
+    # Shell.run( 'xxxx' )
+  end
+
+  def test_call
+    stdout1, stderr1, status1 = Shell.call( 'git config user.name' )
+    stdout2, stderr2, status2 = Shell.call( 'git config --show-origin user.name' )
+    # stdout3, stderr3, status3 = Shell.call( 'xxxx' )
+
+    pp stdout1
+    pp stderr1
+    pp status1
+    puts "---"
+    pp stdout2
+    pp stderr2
+    pp status2
+  end
+
+end # class TestShell
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: shell-lite
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.22'
+description: shell-lite gem  -  shell command line helper / wrapper 'n' more for your
+  computer
+email: ruby-talk@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/shell-lite.rb
+- lib/shell-lite/shell.rb
+- lib/shell-lite/version.rb
+- test/helper.rb
+- test/test_shell.rb
+homepage: https://github.com/rubycoco/git
+licenses:
+- Public Domain
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: shell-lite gem  -  shell command line helper / wrapper 'n' more for your
+  computer
+test_files: []