so-pretty 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ebcbc2fa619e3b9d8456f1173803b48896bb0244
+  data.tar.gz: 9156649bc47e57c81af01f411813c1f14b6e16b0
+SHA512:
+  metadata.gz: 213252e82e13d776c79c19b2c4c2a4c2a451adce5aaaf9eeac2a0547b5f161443464a3b3fa3a142cdc684c3ac3dcae21e364af56eca5043d8e6d9b6003800e2d
+  data.tar.gz: a17ad9329dd6218fb7ec7bfa5e6c23f1d834e73368bbbfc39a5a173fe2809f3decd04c09a70f745b27e560f2f95a39e66750945e67edf9c4f2997b8a53d54471

data/README.md

@@ -0,0 +1,15 @@
+## Usage
+
+```
+Usage: sp [options]
+    -i, --input [instream]           Input stream, one of: '-', 'STDIN', or a file name
+    -o, --output [outstream]         Output stream, one of: '-', 'STDOUT', 'STDERR' or a file name
+    -f, --format [format]            Output format, one of: 'yaml', 'json', 'ruby', 'minjson'
+```
+
+## TODO
+
+- add formats
+  * csv
+  * toml
+  * some specs would be nice

data/bin/so-pretty

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'so-pretty'
+
+prettifier = SoPretty::Base.from_cli( ARGV )
+prettifier.prettify

data/bin/sp

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'so-pretty'
+
+prettifier = SoPretty::Base.from_cli( ARGV )
+prettifier.prettify

data/lib/so-pretty.rb

@@ -0,0 +1,153 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'json'
+require 'zlib'
+require 'yaml'
+require 'optparse'
+
+begin
+  require 'awesome_print'
+rescue LoadError => e
+  STDERR.puts "awesome_print is not installed.  Install it to get better printing from the :ruby format.  `gem install awesome_print`"
+end
+
+module SoPretty
+  class Base
+    def initialize( options = {} )
+      @instream  = to_stream( :input,  options[:instream] )
+      @outstream = to_stream( :output, options[:outstream] )
+      @outformat = options[:format]
+    end
+
+    def prettify
+      if @outformat == :yaml
+        @outstream.puts YAML::dump( parsed )
+        return
+      end
+
+      if @outformat == :ruby
+        if defined?( AwesomePrint )
+          @outstream.puts parsed.ai( plain: true, index: false )
+        else
+          @outstream.puts parsed.inspect
+        end
+
+        return
+      end
+
+      if @outformat == :minjson
+        @outstream.puts JSON.dump( parsed )
+        return
+      end
+
+      @outstream.puts JSON.pretty_generate( parsed )
+    ensure
+      close_streams
+    end
+
+    def parsed
+      return @parsed if @parsed
+
+      begin
+        data = JSON.load( string )
+        return @parsed = data
+      rescue JSON::ParserError => e
+      end
+
+      begin
+        data = YAML::load( string )
+        return @parsed = data
+      rescue Psych::SyntaxError => e
+      end
+
+      begin
+        data = Kernel.eval( string )
+        return @parsed = data
+      rescue StandardError => e
+      end
+
+      raise ArgumentError, "Input was unparsable as JSON or YAML."
+    end
+
+    def string
+      return @string if @string
+
+      str = @instream.read
+
+      zstream = Zlib::Inflate.new
+      begin
+        buf = zstream.inflate(str)
+        zstream.finish
+        zstream.close
+
+        return @string = buf
+      rescue Exception => e
+      end
+
+      return @string = str
+    end
+
+    def close_streams
+      @instream.flush
+      @instream.close
+
+      @outstream.flush
+      @outstream.close
+    end
+
+    def self.from_cli( argv )
+      options = {
+        :instream  => "-",
+        :outstream => "-",
+        :format    => :yaml,
+      }
+
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: sp [options]"
+
+        opts.on( "-i", "--input [instream]", "Input stream, one of: '-', 'STDIN', or a file name" ) do |instream|
+          options[:instream] = instream
+        end
+
+        opts.on( "-o", "--output [outstream]", "Output stream, one of: '-', 'STDOUT', 'STDERR' or a file name" ) 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
+      end
+
+      parser.parse( argv )
+
+      return self.new( options )
+    end
+
+    private
+    def to_stream( input_output, maybe_stream )
+      case maybe_stream.downcase
+      when "stdin"
+        raise ArgumentError, "Output stream cannot be STDIN"
+        return STDIN
+      when "stdout"
+        raise ArgumentError, "Input stream cannot be STDOUT"
+        return STDOUT
+      when "stderr"
+        raise ArgumentError, "Input stream cannot be STDERR"
+        return STDERR
+      end
+
+      if maybe_stream == "-"
+        if input_output == :input
+          return STDIN
+        end
+
+        return STDOUT
+      end
+
+      mode = input_output == :input ? "r" : "w"
+      return File.open( maybe_stream, mode )
+    end
+  end
+end

data/lib/so-pretty/version.rb

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

data/so-pretty.gemspec

@@ -0,0 +1,52 @@
+lib_path  = "./lib"
+spec_path = "./spec"
+bin_path  = "./bin"
+
+libs  = Dir.glob("#{lib_path}/**/*.rb")
+libs += Dir.glob("#{lib_path}/**/*.erb")
+
+specs = Dir.glob("#{spec_path}/**/*.rb")
+bins  = Dir.glob("#{bin_path}/so-pretty")
+bins += Dir.glob("#{bin_path}/sp")
+
+flist = libs + specs + bins
+flist << "so-pretty.gemspec"
+flist << "README.md"
+
+require_relative './lib/so-pretty/version'
+
+summary = <<-EOD
+A gem to pretty print anything.  Currently supports input formats:
+
+- ruby (.inspect formatted)
+- yaml
+- json
+
+And will auto-detect input type, though you can force detection.
+
+Outputs yaml by default, but can output ruby, yaml, or json.  Input streams
+or files may be compressed with zlib/deflate, however, gzip is not currently
+supported.
+EOD
+
+Gem::Specification.new do |gem|
+  gem.name          = "so-pretty"
+  gem.version       = SoPretty::VERSION
+  gem.authors       = ["Brett Nakashima"]
+  gem.email         = ["brettnak@gmail.com"]
+  gem.summary       = "SoPretty print anything"
+  gem.description   = summary
+
+  # TODO: Rename this repo to match the gem name
+  gem.homepage      = "http://gitlab.com/brettnak/pretty"
+
+  gem.files         = flist
+  gem.executables   = bins.map{ |f| File.basename(f) }
+  gem.test_files    = specs
+  gem.require_paths = ["lib/"]
+
+  gem.add_development_dependency 'rspec', '~> 3.1'
+  gem.add_development_dependency 'awesome_print'
+
+  gem.license = "MIT"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: so-pretty
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brett Nakashima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: |
+  A gem to pretty print anything.  Currently supports input formats:
+
+  - ruby (.inspect formatted)
+  - yaml
+  - json
+
+  And will auto-detect input type, though you can force detection.
+
+  Outputs yaml by default, but can output ruby, yaml, or json.  Input streams
+  or files may be compressed with zlib/deflate, however, gzip is not currently
+  supported.
+email:
+- brettnak@gmail.com
+executables:
+- so-pretty
+- sp
+extensions: []
+extra_rdoc_files: []
+files:
+- "./bin/so-pretty"
+- "./bin/sp"
+- "./lib/so-pretty.rb"
+- "./lib/so-pretty/version.rb"
+- README.md
+- bin/so-pretty
+- bin/sp
+- so-pretty.gemspec
+homepage: http://gitlab.com/brettnak/pretty
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: SoPretty print anything
+test_files: []