prettify 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZWU5MGJiYzcxOGM1NTE3MTIyNWU0NTU4Mzk5MDlkNzc4YmNmMGQ4MQ==
+  data.tar.gz: !binary |-
+    ZWYwNDcxMGRkNTcwNTBlMTJiMmMzNmVlZTY0NzVhZjYxNGI4MWMyZQ==
+SHA512:
+  metadata.gz: !binary |-
+    Mzk4YWRlZGNjNDFiN2ZjYTIxNjU1NTFiNzVmMGI1MjcwNDE1ZTc5ZmIwYjAy
+    ODhmYmI1ZDkzOTc3MmRhOTM5N2M3MGEzMzczOTExNDM2MzJkNGRlYzY1MDcy
+    NTY4ZWUzYmY4ZDFkOGMwZTZiYjFjZDVhMDFiYTgzODkyYmQ2NWQ=
+  data.tar.gz: !binary |-
+    MTg1MTgzYzdkOTlmOGM3NzI1ODIwN2M3NTI5YTkyNDQ3ZGU5ZDI4ODJjZjli
+    OTI5MGQ1MmM3NzQxZjAxNDk2ZDkyOWQxOWNmYzYwYzhhZjM5MjY1YTU3ODE3
+    ZWU0NWNmY2FiNDZjZGZkNGUxZDBjYzliNmI0NjU5NmViMTc4M2E=

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nayyara Samuel
+
+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,57 @@
+<img src='https://github.com/nayyara-samuel/prettify/blob/master/img/prettify_icon.png?raw=true' height='100'>
+
+This gem is inspired by the [JSON Editor Online](http://www.jsoneditoronline.org/) tool. It contains a CLI for pretty formatting JSON files on your file system. It will let you bulk format files as well. It also has a `Prettify::Prettifier` module which you can use in your code to generated pretty JSON output. It uses the Ruby JSON gem's `pretty_generate` method with a minor modification to improve formatting.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'prettify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prettify
+
+## Usage
+
+To use in our code:
+
+     class MyClass
+         include Prettify::Prettifier
+         def pretty
+            # Use a JSON string
+            some_json = '{"one": 1}'
+            puts prettify(some_json)
+
+            # Or use a hash
+            some_json = {"one"=> 1}
+            puts prettify(some_json)
+         end
+      end
+
+To use the CLI use type the command `prettify`.
+
+    Usage:
+      prettify json -l, --location=LOCATION
+
+    Options:
+       -l, --location=LOCATION  # The desired file/directory containing the JSON files
+       -o, [--output=OUTPUT]    # The desired output file/directory to write to
+
+    Formats JSON files on the file system
+
+##Example Formatting:
+
+<img src='https://raw.github.com/nayyara-samuel/prettify/master/img/formatted_json.png' height='350'>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/prettify

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'prettify'
+#
+# The CLI for this project based on Thor
+# Author: Nayyara Samuel (nayyara.samuel@opower.com)
+#
+Prettify::Command.start
+

data/json/test_1.json

@@ -0,0 +1 @@
+{"firstName":"John","lastName":"Smith","age":25,"address":{"streetAddress":"21 2nd Street","city":"New York","state":"NY","postalCode":10021},"phoneNumbers":[{"type":"home","number":"212 555-1234"},{"type":"fax","number":"646 555-4567"}],"children":[],"hasCar":true}

data/json/test_2.json

@@ -0,0 +1 @@
+[{"attribute":"something"}, {"attribute":"something else"}]

data/lib/prettify.rb

@@ -0,0 +1,61 @@
+require 'prettify/version'
+require 'thor'
+require 'json'
+require 'colorize'
+
+#
+# This file contains the prettifier module and the CLI support code for this gem
+# Author: Nayyara Samuel (nayyara.samuel@opower.com)
+#
+module Prettify
+
+  module Prettifier
+    def prettify(json)
+      json_map = json.class == String ? JSON.parse(json) : json
+      JSON.pretty_generate(json_map).gsub(/\[\n+\s*\]/, '[]')
+    end
+  end
+
+  class Command < Thor
+    include Prettifier
+
+    desc 'json', 'Formats JSON files on the file system'
+    option :location, aliases: '-l', required: true, desc: 'The desired file/directory containing the JSON files'
+    option :output, aliases: '-o', required: false, desc: 'The desired output file/directory to write to'
+
+    def json
+      _options = options.dup
+      _options['output'] = _options['location'] if !_options['output']
+
+      puts "\nRunning with options:"
+      _options.each do |k, v|
+        puts "\t#{k}: #{v}".yellow
+      end
+      puts ''
+
+      prettify_block = Proc.new do |read_file, write_file|
+        puts "Processing file: #{File.basename(read_file)}".cyan
+        content = File.read(read_file)
+        content = prettify(content)
+        f = File.open(write_file, 'w')
+        f.write(content)
+        f.close
+      end
+
+      location = _options['location']
+      output = _options['output']
+      if File.directory?(location)
+        raise 'Output location must be a directory' unless File.directory?(output)
+        Dir.glob(File.join(location, '*.json')) do |file|
+          prettify_block.call(file, File.join(output, File.basename(file)))
+        end
+      else
+        output = File.directory?(output) ? File.join(output, location) : output
+        prettify_block.call(location, output)
+      end
+
+      puts ''
+    end
+  end
+
+end

data/lib/prettify/version.rb

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

data/prettify.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prettify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'prettify'
+  spec.version       = Prettify::VERSION
+  spec.authors       = ['Nayyara Samuel']
+  spec.email         = ['nayyara.samuel@opower.com']
+  spec.description   = %q{A gem that prettifies JSON files on your file system}
+  spec.summary       = %q{Make your JSON files formatted using this gem's cli}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'thor'
+  spec.add_dependency 'json'
+  spec.add_dependency 'colorize'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: prettify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nayyara Samuel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem that prettifies JSON files on your file system
+email:
+- nayyara.samuel@opower.com
+executables:
+- prettify
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/prettify
+- img/formatted_json.png
+- img/prettify_icon.png
+- json/test_1.json
+- json/test_2.json
+- lib/prettify.rb
+- lib/prettify/version.rb
+- prettify.gemspec
+homepage: ''
+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.1.3
+signing_key: 
+specification_version: 4
+summary: Make your JSON files formatted using this gem's cli
+test_files: []