lino 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20eb6e2b8594c3261c3800bb7cca393d9fa55ed3
-  data.tar.gz: 1c6c9be281476348c146a8b8aa3cda314da0406c
+  metadata.gz: f9f6cf4b79d9262b01413a60d6f0fa83bce2f831
+  data.tar.gz: 9f88a2482f3cb2d6bee52b173d7a59cbc2af4b76
 SHA512:
-  metadata.gz: 46a0add9fb8eda70f19ef8469278dc51ca75dfccc3ef991dee60e46ca2aff83120489ea23b1c9777ccdf3261b1e373a8fc7d7733f05411263473c40a951bfb6b
-  data.tar.gz: beed732e75c3804d18d2b693ba3641c49e76a4f449b3bbd7f208058e56fc54e958656e8cf8d271211b05a0c63a5ded9f906dd3f58f3d57fc2901982158b0e6c1
+  metadata.gz: df1cb5b66c36b08d91d0a4ef851b7c3eb527cba980347a0855b64d132f5f451a0c98b24f8bd03edb49fac4142f76a541976bb3c055115bf6bb799d8fe09059d8
+  data.tar.gz: b6557f3d7038e507165a5c34af7924c00ef72ad9d71693fb5d61f34b5ff66a29edc7bbcba7ec0ea257efc3d304887c8eca840c429ffa73c5ad0cb7a03c2a672f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lino (0.1.0)
+    lino (1.0.0)
       hamster (~> 3.0)
       open4 (~> 1.3)
 
@@ -10,6 +10,7 @@ GEM
   specs:
     concurrent-ruby (1.0.2)
     diff-lcs (1.3)
+    gem-release (0.7.4)
     hamster (3.0.0)
       concurrent-ruby (~> 1.0)
     open4 (1.3.4)
@@ -33,6 +34,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.14)
+  gem-release (~> 0.7)
   lino!
   rake (~> 10.0)
   rspec (~> 3.0)

data/README.md

@@ -20,7 +20,141 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Lino allows commands to be built and executed:
+
+```ruby
+require 'lino'
+  
+command_line = Lino::CommandLineBuilder.for_command('ruby')
+    .with_flag('-v')
+    .with_option('-e', 'puts "Hello"')
+    .build
+    
+puts command_line.to_s 
+# => ruby -v -e puts "Hello"
+  
+command_line.execute 
+# ruby 2.3.1p112 (2016-04-26 revision 54768) [x86_64-darwin15]
+# Hello
+```
+
+### `Lino::CommandLineBuilder`
+
+The `CommandLineBuilder` allows a number of different styles of commands to be built:
+
+```ruby
+# commands with flags
+Lino::CommandLineBuilder.for_command('ls')
+    .with_flag('-l')
+    .with_flag('-a')
+    .build
+    .to_s
+    
+# => ls -l -a
+  
+# commands with options
+Lino::CommandLineBuilder.for_command('gpg')
+    .with_option('--recipient', 'tobyclemson@gmail.com')
+    .with_option('--sign', './doc.txt')
+    .build
+    .to_s 
+    
+# => gpg --recipient tobyclemson@gmail.com --sign ./doc.txt
+  
+# commands with arguments
+Lino::CommandLineBuilder.for_command('diff')
+    .with_argument('./file1.txt')
+    .with_argument('./file2.txt')
+    .build
+    .to_s 
+    
+# => diff ./file1.txt ./file2.txt
+  
+# commands with custom option separator
+Lino::CommandLineBuilder.for_command('java')
+    .with_option_separator(':')
+    .with_option('-splash', './images/splash.jpg')
+    .with_argument('./application.jar')
+    .build
+    .to_s 
+    
+# => java -splash:./images/splash.jpg ./application.jar
+  
+# commands using a subcommand style
+Lino::CommandLineBuilder.for_command('git')
+    .with_flag('--no-pager')
+    .with_subcommand('log') do |sub|
+      sub.with_option('--since', '2016-01-01')
+    end
+    .build
+    .to_s
+    
+# => git --no-pager log --since 2016-01-01
+  
+# commands with multiple levels of subcommand
+Lino::CommandLineBuilder.for_command('gcloud')
+    .with_subcommand('sql')
+    .with_subcommand('instances')
+    .with_subcommand('set-root-password')
+    .with_subcommand('some-database') do |sub|
+      sub.with_option('--password', 'super-secure')
+    end
+    .build
+    .to_s
+    
+# => gcloud sql instances set-root-password some-database --password super-secure
+  
+# commands controlled by environment variables
+Lino::CommandLineBuilder.for_command('node')
+    .with_environment_variable('PORT', '3030')
+    .with_environment_variable('LOG_LEVEL', 'debug')
+    .with_argument('./server.js')
+    .build
+    .to_s
+    
+# => PORT=3030 LOG_LEVEL=debug node ./server.js
+```
+
+### `Lino::CommandLine`
+
+A `CommandLine` can be executed using the `#execute` method:
+
+```ruby
+command_line = Lino::CommandLineBuilder.for_command('ls')
+    .with_flag('-l')
+    .with_flag('-a')
+    .with_argument('/')
+    .build
+    
+command_line.execute
+  
+# => <contents of / directory> 
+```
+
+By default, the standard input stream is empty and the process writes to the standard output and error streams.
+
+To populate standard input:
+
+```ruby
+command_line.execute(stdin: 'something to be passed to standard input')
+```
+
+The `stdin` option supports any object that responds to `each`, `read` or `to_s`.
+
+To provide custom streams for standard output or standard error:
+
+```ruby
+require 'stringio'
+  
+stdout = StringIO.new
+stderr = StringIO.new
+  
+command_line.execute(stdout: stdout, stderr: stderr)
+  
+puts "[output: #{stdout.string}, error: #{stderr.string}]"
+```
+
+The `stdout` and `stderr` options support any object that responds to `<<`.
 
 ## Development
 

data/lib/lino/version.rb

@@ -1,3 +1,3 @@
 module Lino
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/lino.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'gem-release', '~> 0.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lino
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Toby Clemson
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: Command line builders and executors.
 email:
 - tobyclemson@gmail.com