pretty_json 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08dddbd2036c9a8980cd73f21b3267af004415bc
+  data.tar.gz: 90f57dce86cfd1b0ca71378da97653d662ea8028
+SHA512:
+  metadata.gz: a8212c730426faadd1df51b34714df26d13fe06cf2837b3ddbce81b778e20627fc62a77ba98e23303f48781e99cc3c4f6a756ba53b0688d5a16bb1e674ab9aea
+  data.tar.gz: 753ba6a778d42b54a0a6c1c89db2a6373fe1fff9b71ac291d82a54de7f392cf5755d2d7ffd19e87944514ea94b8f8835bbe11b98bcc4f7153cec2491d1ed8a6f

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.3
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2
+script: bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yves Komenda
+
+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,69 @@
+# PrettyJson
+
+<a href="https://codeclimate.com/github/Dervol03/pretty_json"><img src="https://codeclimate.com/github/Dervol03/pretty_json/badges/gpa.svg" /></a>  <a href="https://travis-ci.org/Dervol03/pretty_json"><img src="https://travis-ci.org/Dervol03/pretty_json.svg?branch=master" /></a>
+
+This gem provides a simple interface to get pretty formatted JSON. It either can be used in a project or via the command line. When included in code, it provides the possibility to return the formatted JSON as string or to directly store it in a file. The latter option is not provided in the command line tool as you can refer to your favourite shell's file redirection for that purpose.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pretty_json'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pretty_json
+
+## Usage
+
+### In your own code
+
+Simply require it wherever you which to use it:
+```ruby
+require 'pretty_json'
+```
+
+Afterwards, you have the `PrettyJSON` class at your disposal. You may pass a ruby Hash, String or a file name to the constructor.
+
+```ruby
+json = PrettyJSON.new('{"key": "value", "array":[1,2,3]}')
+json.to_s                           #=> pretty formatted JSON
+json.to_file('/tmp/example.json')   #=> writes pretty JSON to /tmp.example.json
+```
+
+### On the command line
+
+If you only need quick formatting for some JSON, there are three possibilities to do so using the command line tool:
+ 1. save your JSON in a file and pass the file name to the command line tool
+    ```shell
+    pretty_json example.json
+    ```
+ 2. pass the JSON as a single line to the command line tool:
+    ```shell
+    pretty_json '{"key": "value", "array":[1,2,3]}'
+    ```
+    Beware the single quotes around the JSON string. If they are omitted, the shell interpreter will split the string as it thinks correct, which will result in invalid JSON in most cases
+ 3. you may pass multiline via STDIN using the `-` option
+    ```shell
+    pretty_json - > /tmp/example.json
+    {"key": "value",
+     "array":[1,2,3]}
+    ```
+    Here, the single quotes may be omitted. The example also shows how to write the result into a file (`/tmp/example.json`)instead of being printed to STDOUT.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Dervol03/pretty_json.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/bin/pretty_json

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'pretty_json'
+
+def help
+  puts 'Usage:'
+  puts '  pretty_json [file_path|json_string]'
+  puts
+  puts '[Options]'
+  puts '  -               read multiple lines from standard in (no single quotes needed).'
+  puts
+  puts 'You may specify a file path or a JSON string to be parsed and formatted.'
+  puts 'IMPORTANT: make sure to surround your JSON with single quotes to prevent the shell from splitting it by its own.'
+  exit 0
+end
+
+
+if %w(-h --help).include?(ARGV[0]) || ARGV.empty?
+  help
+end
+
+input = if ARGV.length == 1
+          if ARGV[0] == '-'
+            STDIN.read
+          else
+            ARGV[0]
+          end
+        else
+          ARGV.join
+        end
+
+Dir.chdir(Dir.pwd) do
+  puts
+  puts
+  puts PrettyJSON.new(input).to_s
+  puts
+end

data/lib/pretty_json/version.rb

@@ -0,0 +1,3 @@
+class PrettyJSON
+  VERSION = '1.0.0'
+end

data/lib/pretty_json.rb

@@ -0,0 +1,43 @@
+require 'json'
+
+require 'pretty_json/version'
+
+# Represents a pretty JSON string.
+class PrettyJSON
+
+  # @param [String] input either a file path or a JSON string.
+  def initialize(input)
+    json_hash = send("#{input.class.name.downcase}_to_hash", input)
+    @json = JSON.pretty_unparse(json_hash)
+  end
+
+
+  # @return [String] pretty formatted JSON.
+  def to_s
+    @json
+  end
+
+  # Writes pretty formatted JSON to the specified file and returns the same
+  # content as a string.
+  #
+  # @param [String] out_file to be written.
+  # @return [String] pretty formatted JSON.
+  def to_file(out_file)
+    File.write(out_file, @json)
+    @json
+  end
+
+
+  private
+
+  def hash_to_hash(hash)
+    hash
+  end
+
+
+  def string_to_hash(string)
+    json = File.exist?(string) ? File.read(string) : string
+    JSON.parse(json)
+  end
+
+end

data/pretty_json.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pretty_json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pretty_json'
+  spec.version       = PrettyJSON::VERSION
+  spec.authors       = ['Yves Komenda']
+  spec.email         = ['b_d_v@web.de']
+
+  spec.summary       = %q{Simple command line tool to get some pretty JSON.}
+  spec.homepage      = 'https://github.com/Dervol03/pretty_json'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry',  '~> 0.10'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: pretty_json
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yves Komenda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: 
+email:
+- b_d_v@web.de
+executables:
+- pretty_json
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/pretty_json
+- lib/pretty_json.rb
+- lib/pretty_json/version.rb
+- pretty_json.gemspec
+homepage: https://github.com/Dervol03/pretty_json
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple command line tool to get some pretty JSON.
+test_files: []