so-pretty 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebcbc2fa619e3b9d8456f1173803b48896bb0244
-  data.tar.gz: 9156649bc47e57c81af01f411813c1f14b6e16b0
+  metadata.gz: 100ba0b3c6d2d72a42f55e3d7aa5e06b6f61dce9
+  data.tar.gz: 6ad553a0192ab14995e306cff44a9ce7bf80be58
 SHA512:
-  metadata.gz: 213252e82e13d776c79c19b2c4c2a4c2a451adce5aaaf9eeac2a0547b5f161443464a3b3fa3a142cdc684c3ac3dcae21e364af56eca5043d8e6d9b6003800e2d
-  data.tar.gz: a17ad9329dd6218fb7ec7bfa5e6c23f1d834e73368bbbfc39a5a173fe2809f3decd04c09a70f745b27e560f2f95a39e66750945e67edf9c4f2997b8a53d54471
+  metadata.gz: 4883640bcf017232553c3036dc0645dc254329fffd4a464b790bc25a5140128e2f06345c0e5feb7c4211a74a6ae76e4106f4a0d515637d7683968e24fb86912e
+  data.tar.gz: 679699610a7bf11bdf3854758afb52cfece142ddf1176f709c1dc22c4fb26e77cd630d23a13ef14fbc46a0a551aa5560d8767989e09c861f8856e26792c9a9ed

data/README.md

@@ -13,3 +13,22 @@ Usage: sp [options]
   * csv
   * toml
   * some specs would be nice
+
+## Examples
+
+    $ echo '{"foo":"bar"}' | sp -f ruby
+    > {
+    >     "foo" => "bar"
+    > }
+
+    $ echo '{"foo":"bar"}' | sp -f json
+    > {
+    >   "foo": "bar"
+    > }
+
+    $ echo '{"foo":"bar"}' | sp -f yaml
+    > ---
+    > foo: bar
+
+    $ echo '{"foo":"bar"}' | sp -f minjson
+    > {"foo":"bar"}

data/lib/so-pretty.rb

@@ -5,6 +5,7 @@ require 'json'
 require 'zlib'
 require 'yaml'
 require 'optparse'
+require 'so-pretty/version'
 
 begin
   require 'awesome_print'
@@ -105,18 +106,29 @@ module SoPretty
 
       parser = OptionParser.new do |opts|
         opts.banner = "Usage: sp [options]"
+        opts.separator ""
+        opts.separator "Options:"
 
-        opts.on( "-i", "--input [instream]", "Input stream, one of: '-', 'STDIN', or a file name" ) do |instream|
+        opts.on( "-i", "--input [instream]", "Input stream, one of: '-', 'STDIN', or a file name. default: '-'" ) do |instream|
           options[:instream] = instream
         end
 
-        opts.on( "-o", "--output [outstream]", "Output stream, one of: '-', 'STDOUT', 'STDERR' or a file name" ) do |outstream|
+        opts.on( "-o", "--output [outstream]", "Output stream, one of: '-', 'STDOUT', 'STDERR' or a file name. default: '-'" ) do |outstream|
           options[:outstream] = outstream
         end
 
         opts.on( "-f", "--format [format]", "Output format, one of: 'yaml', 'json', 'ruby', 'minjson'") do |format|
           options[:format] = format.to_sym
         end
+
+        opts.on("-V", "--version", "Show version") do
+          puts VERSION
+          exit
+        end
+
+        opts.separator ""
+        opts.separator "Examples:"
+        opts.separator EXAMPLES
       end
 
       parser.parse( argv )
@@ -150,4 +162,23 @@ module SoPretty
       return File.open( maybe_stream, mode )
     end
   end
+
+  EXAMPLES=<<EOD
+    $ echo '{"foo":"bar"}' | sp -f ruby
+    > {
+    >     "foo" => "bar"
+    > }
+
+    $ echo '{"foo":"bar"}' | sp -f json
+    > {
+    >   "foo": "bar"
+    > }
+
+    $ echo '{"foo":"bar"}' | sp -f yaml
+    > ---
+    > foo: bar
+
+    $ echo '{"foo":"bar"}' | sp -f minjson
+    > {"foo":"bar"}
+EOD
 end

data/lib/so-pretty/version.rb

@@ -1,3 +1,3 @@
 module SoPretty
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: so-pretty
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brett Nakashima