prissy 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in prissy.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Paul Sadauskas
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+# Prissy
+
+Pretty prints JSON output with even more prettiness, and focus on readability. Also understands things like terminal width, colors, and HTML.
+
+## Why another one?
+
+There's plenty of JSON formatters out there, in tons of languages. While none of them are perfect, this one is special because:
+
+ * Left-align key names. Column-align the values.
+ * When nested objects or arrays are short and simple, keep them in the same line as the key. If they're longer, or contain further nestings, then make them multiline.
+ * Terminal width aware, so that things don't wrap if we can help it.
+ * Colorized terminal output optional.
+ * TODO: (colored) HTML output, so we don't have to roundtrip through yet another syntax library.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'prissy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prissy
+
+## Usage
+
+### From the command line
+
+```
+$ cat example_input.json | prissy
+{
+  "array":         [
+    "one",
+    "two",
+    "three",
+    "four",
+    "five",
+    "six",
+    "seven",
+    "eight",
+    "nine",
+    "ten",
+    "eleven",
+    "twelve"
+  ],
+  "false":         false,
+  "inline_array":  ["one", "two", "three"],
+  "inline_object": {"foo": "bar"},
+  "null":          null,
+  "number":        42.0,
+  "object":        {
+    "baz":  "bax",
+    "foo":  "bar",
+    "more": [1, 2, 3]
+  },
+  "string":        "a text string",
+  "true":          true
+}
+
+$ curl -H "Accept: application/json" https://api.github.com/users/paul | prissy
+{
+  "type":         "User",
+  "avatar_url":
+    "https://secure.gravatar.com/avatar/d587890d0fcf8f45724baa8b1bfe1bf4?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+  "bio":          "",
+  "blog":         "blog.theamazingrando.com",
+  "company":      "GitHub",
+  "created_at":   "2008-02-11T18:44:09Z",
+  "email":        "psadauskas@gmail.com",
+  "followers":    35,
+  "following":    1,
+  "gravatar_id":  "d587890d0fcf8f45724baa8b1bfe1bf4",
+  "hireable":     false,
+  "html_url":     "https://github.com/paul",
+  "id":           184,
+  "location":     "Boulder, CO",
+  "login":        "paul",
+  "name":         "Paul Sadauskas",
+  "public_gists": 322,
+  "public_repos": 82,
+  "url":          "https://api.github.com/users/paul"
+}
+```
+
+### In Ruby
+
+```ruby
+# The easy way
+Prissy(json_or_hash)
+
+# With options
+Prissy.new(width: 120, color: false).prissy(json_or_hash)
+```
+
+## Output:
+
+![prissy output](https://github-images.s3.amazonaws.com/skitch/2._psadauskas%40Pauls-GitHub-MBP__%7E_Code_personal_prissy_%28zsh%29-20120717-163756.png)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/prissy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'terminfo'
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require 'prissy'
+
+
+json = STDIN.read
+
+width = TermInfo.screen_width
+has_color = TermInfo.default_object.tigetnum("colors")
+
+print Prissy.new(:max_width => width, :color => has_color).prissy(json)
+

data/example_input.json

@@ -0,0 +1,13 @@
+
+{
+  "inline_array":     ["one", "two", "three"],
+  "array": [ "one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten", "eleven", "twelve" ],
+  "string": "a text string",
+  "number": 42.0,
+  "true": true,
+  "false": false,
+  "null": null,
+  "inline_object": {"foo": "bar"},
+  "object": {"foo": "bar", "baz": "bax", "more": [1,2,3]}
+}
+

data/lib/prissy.rb

@@ -0,0 +1,48 @@
+require "prissy/version"
+require 'prissy/printer'
+require 'prissy/color_printer'
+
+require 'multi_json'
+
+
+class Prissy
+  attr_reader :options
+
+  def initialize(options = {})
+    defaults = {}
+
+    @options = defaults.merge(options)
+  end
+
+  def prissy(json_or_hash)
+    hash = (json_or_hash.is_a?(String) ? parse(json_or_hash) : json_or_hash)
+
+    printer.print(hash)
+  end
+
+  protected
+
+  def parse(json)
+    MultiJson.decode(json)
+  end
+
+  def printer
+    @printer ||= begin
+      if $0 =~ /prissy$/
+	if options[:color]
+	  ColorPrinter.new(options)
+	else
+	  Printer.new(options)
+	end
+      else
+	Printer.new(options)
+      end
+		 end
+  end
+
+
+end
+
+def Prissy(json_or_hash)
+  Prissy.new.prissy(json_or_hash)
+end

data/lib/prissy/color_printer.rb

@@ -0,0 +1,34 @@
+require 'term/ansicolor'
+
+class Prissy
+  class ColorPrinter < Printer
+    include Term::ANSIColor
+
+    def print_string(string, starting_column)
+      super blue{string}
+    end
+
+    def print_number(number)
+      super yellow{number.to_s}
+    end
+
+    def print_literal(char)
+      super green{char}
+    end
+
+    def print_key(key)
+      super cyan{key}
+    end
+
+    def print_true
+      @txt << green{"true"}
+    end
+    def print_false
+      @txt << green{"false"}
+    end
+    def print_null
+      @txt << green{"null"}
+    end
+  end
+end
+

data/lib/prissy/printer.rb

@@ -0,0 +1,149 @@
+class Prissy
+  class Printer
+    attr_reader :options
+
+    def initialize(options = {})
+      @txt = ""
+      @indent = 0
+      @options = options
+      options[:max_width] ||= 80
+    end
+
+    def print(object)
+      print_object(object)
+      @txt << "\n"
+    end
+
+    protected
+
+    def print_object(object, starting_column = 0)
+      if object.empty?
+	print_literal '{}'
+      elsif object.size == 1
+	pair = object.first
+	print_literal '{'
+	print_pair(pair.first, pair.last)
+	print_literal '}'
+      else
+	max_key_width = object.keys.max_by { |k| k.length }.length
+	print_literal '{'
+	newline!
+	@indent += 1
+	object.keys.sort.each do |key|
+	  value = object[key]
+	  indent!
+	  print_pair(key, value, max_key_width)
+	  print_literal ',' unless key == object.keys.sort.last
+	  newline!
+	end
+	@indent -= 1
+	indent!
+	print_literal '}'
+      end
+    end
+
+    def print_pair(key, value, max_key_width = 0)
+      print_key(key)
+      print_separator
+      spacing = max_key_width > 0 ? (max_key_width - key.length) : 0
+      @txt << " " * spacing
+      print_value(value, @indent * 2 + key.length + 4 + spacing )
+    end
+
+    def print_array(array, starting_column = 0)
+      # Length of all values, plus quotes, commas, spaces and brackets
+      array_length = calculate_array_length(array)
+
+      if !array.any?{|el| el.is_a?(Hash) || el.is_a?(Array)} &&
+	(starting_column + array_length < options[:max_width])
+
+	print_literal '['
+	array.each do |el|
+	  print_value(el)
+	  print_literal ', ' unless el == array.last
+	end
+	print_literal ']'
+      else
+	print_literal '['
+	newline!
+	@indent += 1
+	array.each do |el|
+	  indent!
+	  print_value(el)
+	  print_literal ',' unless el == array.last
+	  newline!
+	end
+	@indent -= 1
+	indent!
+	print_literal ']'
+      end
+
+    end
+
+    def print_key(key)
+      @txt << %{"#{key.to_s}"}
+    end
+
+    def print_value(value, starting_column = 0)
+      case value
+      when Array      then print_array(value, starting_column)
+      when Hash       then print_object(value, starting_column)
+      when Numeric    then print_number(value)
+      when String     then print_string(value, starting_column)
+      when TrueClass  then print_true
+      when FalseClass then print_false
+      when NilClass   then print_null
+      end
+    end
+
+    # Make all these explicit, so its easier to override them in subclasses
+    def print_string(string, starting_column = 0)
+      @txt << %{"#{string}"}
+    end
+
+    def print_number(number)
+      @txt << number.to_s
+    end
+
+    def print_true
+      @txt << "true"
+    end
+
+    def print_false
+      @txt << "false"
+    end
+
+    def print_null
+      @txt << "null"
+    end
+
+    def print_separator
+      @txt << ": "
+    end
+
+    def print_literal(literal)
+      @txt << literal
+    end
+
+    def indent!
+      @txt << "  " * @indent
+    end
+
+    def newline!
+      @txt << "\n"
+    end
+
+    def calculate_array_length(array)
+      array.inject(0) do |sum, item|
+	case item
+	when Numeric, TrueClass, FalseClass, NilClass
+	  sum += item.to_s.length
+	when String
+	  sum += item.length + 2 # "quotes"
+	end
+	sum += 2 # ", "
+      end
+    end
+
+  end
+end

data/lib/prissy/version.rb

@@ -0,0 +1,3 @@
+class Prissy
+  VERSION = "1.0.0"
+end

data/prissy.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/prissy/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Paul Sadauskas"]
+  gem.email         = ["psadauskas@gmail.com"]
+  gem.description   = %q{Even prettier JSON console output}
+  gem.summary       = %q{Nicely format JSON}
+  gem.homepage      = "https://github.com/paul/prissy"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "prissy"
+  gem.require_paths = ["lib"]
+  gem.version       = Prissy::VERSION
+
+  gem.add_development_dependency "rspec", "~> 2.11"
+
+  gem.add_dependency "multi_json", "~> 1.3"
+
+  gem.add_dependency "options",        "~> 2.3.0"
+  gem.add_dependency "term-ansicolor", "~> 1.0.7"
+  gem.add_dependency "ruby-terminfo",  "~> 0.1.1"
+end

data/spec/acceptance/the_easy_way_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Prissy, "the easy way" do
+  let(:json) { <<-JSON }
+     {
+      "Image": {
+          "Width":  800,
+          "Height": 600,
+          "Title":  "View from 15th Floor",
+          "Thumbnail": {
+              "Url":    "http://www.example.com/image/481989943",
+              "Height": 125,
+              "Width":  "100"
+          },
+          "IDs": [116, 943, 234, 38793]
+        }
+   }
+  JSON
+
+  subject { Prissy(json) }
+
+  it { should look_like(<<-JSON.strip) }
+{"Image": {
+  "Height":    600,
+  "IDs":       [116, 943, 234, 38793],
+  "Thumbnail": {
+    "Height": 125,
+    "Url":    "http://www.example.com/image/481989943",
+    "Width":  "100"
+  },
+  "Title":     "View from 15th Floor",
+  "Width":     800
+}}
+JSON
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'prissy'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  #config.order = 'random'
+end
+
+RSpec::Matchers.define(:look_like) do |expected|
+  match do |actual|
+    actual.strip == expected.strip
+  end
+
+  diffable
+end

data/spec/unit/plain_printer_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe Prissy::Printer do
+
+  subject { Prissy::Printer.new.print(object) }
+
+  describe "an empty object" do
+    let(:object) { {} }
+    it { should look_like '{}' }
+  end
+
+  describe "a simple object" do
+    let(:object) { {"foo" => "bar"} }
+    it { should look_like '{"foo": "bar"}' }
+  end
+
+  describe "an object with multiple keys" do
+    let(:object) { {"foo" => "bar", "x" => "y" } }
+    it { should look_like <<-STR.strip }
+{
+  "foo": "bar",
+  "x":   "y"
+}
+STR
+  end
+
+  describe "an object with simple nested objects" do
+    let(:object) { {"foo" => "bar", "other" => {"subkey" => "subvalue"}} }
+    it { should look_like <<-STR.strip }
+{
+  "foo":   "bar",
+  "other": {"subkey": "subvalue"}
+}
+STR
+  end
+
+  describe "an object with multiple nested objects" do
+    let(:object) { {"foo" => "bar", "other" => {"a" => "b", "c" => "d"}} }
+    it { should look_like <<-STR.strip }
+{
+  "foo":   "bar",
+  "other": {
+    "a": "b",
+    "c": "d"
+  }
+}
+STR
+  end
+
+  describe "an object with a short array" do
+    let(:object) { {"stooges" => %w[Moe Larry Curly] } }
+    it { should look_like <<-STR.strip }
+{"stooges": ["Moe", "Larry", "Curly"]}
+STR
+  end
+
+  describe "an object with a long array" do
+    let(:object) { {"dwarves" => %w[ Fili Kili Oin Gloin Thorin Dwalin Balin Bifur Bofur Bombur Dori Nori Ori ]} }
+    it { should look_like <<-STR.strip }
+{"dwarves": [
+  "Fili",
+  "Kili",
+  "Oin",
+  "Gloin",
+  "Thorin",
+  "Dwalin",
+  "Balin",
+  "Bifur",
+  "Bofur",
+  "Bombur",
+  "Dori",
+  "Nori",
+  "Ori"
+]}
+STR
+  end
+
+  describe "basic types" do
+    let(:object) { {
+      "string" => "string",
+      "number" => 42.0,
+      "object" => {"foo" => "bar"},
+      "array"  => [1, 2, 3],
+      "true"   => true,
+      "false"  => false,
+      "null"   => nil
+    } }
+    it { should look_like <<-STR.strip }
+{
+  "array":  [1, 2, 3],
+  "false":  false,
+  "null":   null,
+  "number": 42.0,
+  "object": {"foo": "bar"},
+  "string": "string",
+  "true":   true
+}
+STR
+  end
+
+end
+

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: prissy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Paul Sadauskas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: options
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+- !ruby/object:Gem::Dependency
+  name: ruby-terminfo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: Even prettier JSON console output
+email:
+- psadauskas@gmail.com
+executables:
+- prissy
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/prissy
+- example_input.json
+- lib/prissy.rb
+- lib/prissy/color_printer.rb
+- lib/prissy/printer.rb
+- lib/prissy/version.rb
+- prissy.gemspec
+- spec/acceptance/the_easy_way_spec.rb
+- spec/spec_helper.rb
+- spec/unit/plain_printer_spec.rb
+homepage: https://github.com/paul/prissy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Nicely format JSON
+test_files:
+- spec/acceptance/the_easy_way_spec.rb
+- spec/spec_helper.rb
+- spec/unit/plain_printer_spec.rb