cmds 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 327a49d0895e5e91d1d35c9ab352357a4a577f65
-  data.tar.gz: f2f7bd60a0b9bcdfca5a7e50a28ac386f329d33a
+  metadata.gz: 49d2979f3b8330647a63142158c793edabe0016d
+  data.tar.gz: b1e6d69cd6324cea64ae349dae9f6613ec41ef26
 SHA512:
-  metadata.gz: c22d98773434a8c16df0420d599222e00df2f5fcca68e448f889f16671d35db3ab441faa8d6194419c690f435b60e28b1992cc2cbddb0614c79f26fa378e5033
-  data.tar.gz: ca4371971382c85c6438bafac00c40f637a9e7dbeb2e232838ea9ae2e11ffdc7de5f6989ccd76560f2d09cac452d7da5438e291a29b1baa24dc64e93e8abbacb
+  metadata.gz: 0bf4ce786dedf1ff4eb19768bc6985bba4a45e26669745797f023e4b7046467a4fd748519e766e3c5cbc44159ac5ef10917cf4ca2dfbc5cc1f45d206da0b6915
+  data.tar.gz: d2b7eebf773c8c3c6f5f04f26441e8d24823f36ae8549ee6cd8f72222d61775aefc5249a02e3f34e61d8c6fe42a84c6bd0fe7c92b139353e5fc38f5a3230ad97

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/ansible/hosts

@@ -1,6 +1 @@
 localhost ansible_connection=local
-
-alamo.beiarea.com ansible_connection=ssh ansible_ssh_user=root
-
-[production]
-alamo.beiarea.com

data/cmds.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["neil@ztkae.com"]
   spec.summary       = %q{helps read, write and remember commands.}
   # spec.description   = %q{TODO: Write a longer description. Optional.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/nrser/cmds"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pastel"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "redcarpet"
 end

data/lib/cmds/result.rb

@@ -1,24 +1,55 @@
 class Cmds
+  # a {Result} is a simple data structure returned from calling {Cmds#capture} 
+  # on a {Cmds} instance.
+  # 
+  # it contains the exit status code, standard output and standard error,
+  # as well as the actual string command issued (after all substitutions).
+  #
+  # instances also have a few convenience methods.
+  #
+  # @!attribute [r] cmd
+  #   @return [String] the command string that was executed.
+  #
+  # @!attribute [r] status
+  #   @return [Fixnum] the command process' exit status code.
+  #
+  # @!attribute [r] out
+  #   @return [String] the command process' standard output.
+  #
+  # @!attribute [r] err
+  #   @return [String] the command process' standard error.
+  #
   class Result
     attr_reader :cmd, :status, :out, :err
-
+    
+    # @param cmd [String] {#cmd} attribute.
+    # @param status [Fixnum] {#status} attribute.
+    # @param out [String] {#out} attribute.
+    # @param err [String] {#err} attribute.
     def initialize cmd, status, out, err
       @cmd = cmd
       @status = status
       @out = out
       @err = err
     end
-
+    
+    # @return [Boolean] true if {#status} is `0`.
     def ok?
       @status == 0
     end
-
+    
+    # @return [Boolean] true if {#status} is not `0`.
     def error?
       ! ok?
     end
-
-    # raises an error if there was one
-    # returns the Result so that it can be chained
+    
+    # raises an error if the command failed (exited with a {#status} other 
+    # than `0`).
+    #
+    # @return [Result] it's self (so that it can be chained).
+    #
+    # @raise [SystemCallError] if the command failed.
+    #
     def assert
       if error?
         msg = NRSER.squish <<-BLOCK
@@ -31,4 +62,4 @@ class Cmds
       self
     end # raise_error
   end
-end # class Cmds
+end # class Cmds

data/lib/cmds/sugar.rb

@@ -23,6 +23,7 @@ class Cmds
   # =============
 
   # create a new Cmd from template and subs and call it
+  # @return [Result]
   def self.capture template, *subs, &input_block
     new(template, options(subs, input_block)).capture
   end

data/lib/cmds/version.rb

@@ -1,3 +1,3 @@
 class Cmds
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmds
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - nrser
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: redcarpet
+  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:
 - neil@ztkae.com
@@ -103,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -144,7 +173,7 @@ files:
 - test/lines.txt
 - test/questions.rb
 - test/tick.rb
-homepage: ''
+homepage: https://github.com/nrser/cmds
 licenses:
 - MIT
 metadata: {}
@@ -188,3 +217,4 @@ test_files:
 - test/lines.txt
 - test/questions.rb
 - test/tick.rb
+has_rdoc: