ki_format 0.0.1

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 ki_format.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ben Brinckerhoff
+
+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,29 @@
+# KiFormat
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ki_format'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ki_format
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,16 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new("spec:coverage") do |t|
+  ENV['COVERAGE'] = "true"
+end

data/bin/ki_format

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'methadone'
+require 'ki_format'
+require 'fileutils'
+
+module KiFormat
+  module CLI
+    include Methadone::Main
+    include Methadone::CLILogging
+
+    main do |arg|
+      input = arg.nil? ? $stdin : File.open(arg, 'r')
+      command = Command.new(input)
+      if options[:pretty]
+        command.print_pretty
+      elsif options[:list]
+        command.print_list
+      elsif options.has_key?(:table)
+        keys = (options[:table] || "").split(",")
+        command.print_table(*keys)
+      elsif options.has_key?(:select)
+        keys = (options[:select] || "").split(",")
+        command.print_selected(*keys)
+      else
+        help_now! "No option given"
+      end
+    end
+
+    version     KiFormat::VERSION
+    description 'Formats JSON'
+
+    arg(:file, :optional)
+    on("--pretty", "Pretty print the JSON")
+    on("--list", "Print each JSON object on one line")
+    on("--table [key1,key2]", "Print JSON as table. Optionally include keys")
+    on("--select [key1,key2]", "Select specific keys")
+    go!
+  end
+
+end

data/ki_format.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ki_format/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ben Brinckerhoff", "Aaron Cronin"]
+  gem.email         = ["ben@freeagent.com", "aaron@freeagent.com"]
+  gem.description   = %q{Formats JSON}
+  gem.summary       = %q{Formats JSON}
+  gem.homepage      = ""
+
+  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          = "ki_format"
+  gem.require_paths = ["lib"]
+  gem.version       = KiFormat::VERSION
+
+  gem.add_dependency('multi_json', '~> 1.3.6')
+  gem.add_dependency('methadone', '~> 1.2.1')
+  gem.add_dependency('map', '~> 4.6.1')
+  gem.add_dependency('terminal-table', '~> 1.4.5')
+
+  gem.add_development_dependency('debugger', '~> 1.2.0')
+  gem.add_development_dependency('rake', '~> 0.9.2')
+  gem.add_development_dependency('rspec', '~> 2.11.0')
+  gem.add_development_dependency('simplecov', '~> 0.6.4')
+end

data/lib/ki_format/command.rb

@@ -0,0 +1,64 @@
+module KiFormat
+
+  class Command
+
+    attr_reader :input, :output, :error
+
+    def initialize(input=$stdin, output=$stdout, error=$stderr)
+      @input = input
+      @output = output
+      @error = error
+    end
+
+    def print_pretty
+      json_in do |data|
+        output.puts MultiJson.dump(data, :pretty => true)
+      end
+    end
+
+    def print_list
+      json_in do |data|
+        data = wrap(data)
+        data.each do |obj|
+          output.puts MultiJson.dump(obj, :pretty => false)
+        end
+      end
+    end
+
+    def print_table(*keys)
+      json_in do |data|
+        data = wrap(data)
+        output.puts(TableMaker.new(data, :only => keys).print)
+      end
+    end
+
+    def print_selected(*keys)
+      json_in do |data|
+        data = wrap(data)
+        output.puts(TableMaker.new(data, :only => keys).print(:plain => true))
+      end
+    end
+
+    private
+
+    def wrap(data)
+      if data.is_a?(Array)
+        data
+      else
+        [data]
+      end
+    end
+
+    def json_in
+      json = input.read
+      begin
+        data = MultiJson.load(json)
+        yield data
+      rescue MultiJson::DecodeError
+        error.puts "Invalid JSON"
+      end
+    end
+
+  end
+
+end

data/lib/ki_format/table_maker.rb

@@ -0,0 +1,61 @@
+require 'set'
+
+module KiFormat
+
+  class TableMaker
+
+    def initialize(data, opts = {})
+      keys = opts.fetch(:only, nil)
+      @data = data
+      @headings = build_headings(keys)
+      @rows = build_rows
+    end
+
+    def print(opts = {})
+      plain = opts.fetch(:plain, false)
+      table = Terminal::Table.new do |t|
+        t.rows = @rows
+        if plain
+          t.style =  {:border_x => "", :border_i => "", :border_y => "", :padding_left => 0, :padding_right => 2}
+        else
+          t.headings = @headings
+        end
+      end
+      str = table.to_s
+      if plain
+        # hack to remove the first (blank) line
+        str.split("\n")[1..-1].join("\n")
+      else
+        str
+      end
+    end
+
+    private
+
+    def build_headings(keys)
+      all_keys = Set.new
+      @data.each do |obj|
+        all_keys.merge(obj.keys)
+      end
+      if keys && !keys.empty?
+        all_keys.intersection(keys) 
+      else
+        all_keys
+      end
+    end
+
+    def build_rows
+      rows = []
+      @data.each do |obj|
+        row = []
+        @headings.each do |key|
+          row << obj[key]
+        end
+        rows << row
+      end
+      rows
+    end
+
+  end
+
+end

data/lib/ki_format/version.rb

@@ -0,0 +1,3 @@
+module KiFormat
+  VERSION = "0.0.1"
+end

data/lib/ki_format.rb

@@ -0,0 +1,11 @@
+require "ki_format/version"
+require 'multi_json'
+require 'map'
+require 'terminal-table'
+
+module KiFormat
+
+  autoload :Command, 'ki_format/command'
+  autoload :TableMaker, 'ki_format/table_maker'
+
+end

data/spec/integration/commands_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+describe Command do
+
+  def with_command(input_string)
+    input = StringIO.new(input_string)
+    error = StringIO.new
+    output = StringIO.new
+    command = Command.new(input, output, error)
+    yield command
+    output.rewind
+    error.rewind
+    [output.read, error.read]
+  end
+
+  it "gives sensible error on bad input" do
+    input = "adfasd"
+    _, err = with_command(input) do |command|
+      command.print_pretty
+    end
+    err.should match /Invalid JSON/
+  end
+
+  it "can pretty print JSON" do
+    input =<<-JSON
+      [ { "foo" : "bar" } ]
+    JSON
+    expected_json_out =<<-EOS
+[
+  {
+    "foo": "bar"
+  }
+]
+EOS
+    out,  _ = with_command(input) do |command|
+      command.print_pretty
+    end
+    out.should == expected_json_out
+  end
+
+  it "pretty prints out single object" do
+    input =<<-JSON
+      { "foo" : "bar" }
+    JSON
+    expected_json_out =<<-EOS
+{
+  "foo": "bar"
+}
+EOS
+    out, err = with_command(input) do |command|
+      command.print_pretty
+    end
+    out.should == expected_json_out
+  end
+
+  it "can print objects in array on different lines" do
+    input =<<-JSON
+      [ { "foo" : "bar" }, { "baz" : "baz" } ]
+    JSON
+    expected_json_out =<<-EOS
+{"foo":"bar"}
+{"baz":"baz"}
+EOS
+    out, err = with_command(input) do |command|
+      command.print_list
+    end
+    out.should == expected_json_out
+  end
+
+  it "prints out single object" do
+    input =<<-JSON
+      { "foo" : "bar" }
+    JSON
+    expected_json_out =<<-EOS
+{"foo":"bar"}
+EOS
+    out, err = with_command(input) do |command|
+      command.print_list
+    end
+    out.should == expected_json_out
+  end
+
+  it "can print ASCII table with all keys" do
+    input =<<-JSON
+      [ { "name" : "bob", "count" : 1 }, { "name" : "jane", "count" : 2 } ]
+    JSON
+    expected_json_out =<<-EOS
++------+-------+
+| name | count |
++------+-------+
+| bob  | 1     |
+| jane | 2     |
++------+-------+
+EOS
+    out, err = with_command(input) do |command|
+      command.print_table
+    end
+    out.should == expected_json_out
+  end
+
+  it "can print ASCII table with select keys" do
+    input =<<-JSON
+      [ { "name" : "bob", "count" : 1 }, { "name" : "jane", "count" : 2 } ]
+    JSON
+    expected_json_out =<<-EOS
++------+
+| name |
++------+
+| bob  |
+| jane |
++------+
+EOS
+    out, err = with_command(input) do |command|
+      command.print_table("name")
+    end
+    out.should == expected_json_out
+  end
+
+  it "can select keys" do
+    input =<<-JSON
+      [ { "name" : "bob", "count" : 1 }, { "name" : "jane", "count" : 2 } ]
+    JSON
+    expected_json_out =<<-EOS
+bob   1  
+jane  2  
+EOS
+    out, err = with_command(input) do |command|
+      command.print_selected
+    end
+    out.should == expected_json_out
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+
+require 'ki_format'
+
+include KiFormat
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+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
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start
+end

data/spec/unit/table_maker_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe TableMaker do
+
+  it "prints table with keys" do
+    data = [{ :name => "Bob", :age => 35 },
+            { :name => "Sam", :age => 40 }
+           ]
+    expected = <<-EOS
++------+-----+
+| name | age |
++------+-----+
+| Bob  | 35  |
+| Sam  | 40  |
++------+-----+
+EOS
+
+    maker = TableMaker.new(data)
+    maker.print.should == expected.chomp
+  end
+
+  it "can select keys" do
+    data = [{ :name => "Bob", :age => 35 },
+            { :name => "Sam", :age => 40 }
+           ]
+    expected = <<-EOS
++------+
+| name |
++------+
+| Bob  |
+| Sam  |
++------+
+EOS
+
+    maker = TableMaker.new(data, :only => [:name])
+    maker.print.should == expected.chomp
+  end
+
+  it "combines all keys for all rows" do
+    data = [
+            { :name => "Bob", :age => 35 },
+            { :name => "Jane", :eyes => "blue" }
+           ]
+    expected = <<-EOS
++------+-----+------+
+| name | age | eyes |
++------+-----+------+
+| Bob  | 35  |      |
+| Jane |     | blue |
++------+-----+------+
+EOS
+    maker = TableMaker.new(data)
+    maker.print.should == expected.chomp
+  end
+
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: ki_format
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ben Brinckerhoff
+- Aaron Cronin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70206829817800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70206829817800
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: &70206829817300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70206829817300
+- !ruby/object:Gem::Dependency
+  name: map
+  requirement: &70206829816840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70206829816840
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: &70206829816380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70206829816380
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: &70206856634200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: *70206856634200
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70206856633740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70206856633740
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70206856633280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: *70206856633280
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70206856632820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70206856632820
+description: Formats JSON
+email:
+- ben@freeagent.com
+- aaron@freeagent.com
+executables:
+- ki_format
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ki_format
+- ki_format.gemspec
+- lib/ki_format.rb
+- lib/ki_format/command.rb
+- lib/ki_format/table_maker.rb
+- lib/ki_format/version.rb
+- spec/integration/commands_spec.rb
+- spec/spec_helper.rb
+- spec/unit/table_maker_spec.rb
+homepage: ''
+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.10
+signing_key: 
+specification_version: 3
+summary: Formats JSON
+test_files:
+- spec/integration/commands_spec.rb
+- spec/spec_helper.rb
+- spec/unit/table_maker_spec.rb