prettify_json 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d86347bba51955e7614b451d3170173d7c573e34b96983ee35d985c2f45c2e1e
+  data.tar.gz: c316527c4c6c2a0722732db77856ec18f7adebd62d8ef534c8bf5da2884cbaff
+SHA512:
+  metadata.gz: 79c18a2224eac2b6b2191aff72408f6ddfb3dd0f269f8b80ad74094b5e401848d1b99ab5fc1027f310887390fd4abd07d1328bbec0e1727171cfeed5645f4caa
+  data.tar.gz: 9705c8b350aa01cb71eca5763c20b998734ade52c1cd4712d242b809dc10edf0947b3803f35b692744e8f059deeed3bb97d40cc9239fc0f55a123eadde0b25c8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 talaatmagdyx
+
+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,142 @@
+# PrettifyJson
+
+`prettify_json` is a powerful command-line tool designed to enhance the readability of JSON data. Whether you're working with JSON files, strings, or data streamed from the web, `prettify_json` will format it in a clean, colorful, and human-friendly way.
+
+## Features
+
+- **Readability**: Formats JSON data for easier reading.
+- **Flexibility**: Accepts input from files, strings, or standard input.
+- **Colorful Output**: Adds colors to the JSON keys, strings, numbers, and more for better visual distinction.
+
+## Dependencies
+
+- Ruby (version 2.7.0 or higher)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prettify_json'
+```
+
+And then execute:
+
+```sh
+$ bundle install
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install prettify_json
+```
+
+## Usage
+
+### From a File
+
+Prettify JSON data from a file:
+
+```sh
+$ prettify_json -f path/to/your/file.json
+```
+
+### From a String
+
+Prettify JSON data from a string:
+
+```sh
+$ prettify_json -s '{"key": "value"}'
+```
+
+### From Standard Input
+
+Prettify JSON data from standard input:
+
+```sh
+$ echo '{"key": "value"}' | prettify_json -
+```
+
+### From a Web API
+
+Fetch and prettify JSON data from a web API:
+
+```sh
+$ curl -s https://api.restful-api.dev/objects | prettify_json -
+```
+
+## Examples
+
+### Example 1: Prettifying a JSON File
+
+```sh
+$ prettify_json -f sample.json
+
+{
+  "name": "John Doe",
+  "age": 30,
+  "city": "New York"
+}
+```
+
+### Example 2: Prettifying a JSON String
+
+```sh
+$ prettify_json -s '{"name": "John Doe", "age": 30, "city": "New York"}'
+
+{
+  "name": "John Doe",
+  "age": 30,
+  "city": "New York"
+}
+```
+
+### Example 3: Prettifying JSON from a REST API
+
+```sh
+$ curl -s https://api.restful-api.dev/objects | prettify_json -
+
+[
+  {
+    "id": 1,
+    "name": "Object 1",
+    "data": {
+      "value": "Sample data"
+    }
+  },
+  {
+    "id": 2,
+    "name": "Object 2",
+    "data": {
+      "value": "More sample data"
+    }
+  }
+]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `lib/prettify_json/version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/talaatmagdyx/prettify_json. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/talaatmagdyx/prettify_json/blob/master/CODE_OF_CONDUCT.md).
+
+## Reporting Bugs / Feature Requests
+
+If you encounter any bugs or have suggestions for new features, please [open an issue on GitHub](https://github.com/talaatmagdyx/prettify_json/issues). Your feedback is valuable and helps improve the quality of the gem.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PrettifyJson project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/talaatmagdyx/prettify_json/blob/master/CODE_OF_CONDUCT.md).
+
+---
+
+This README provides a comprehensive guide to using your `prettify_json` gem, with detailed usage examples and instructions for installation, development, and contribution.

data/bin/prettify_json

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+
+require 'prettify_json'
+require 'optparse'
+
+# Display help message for usage instructions
+def display_help
+  puts help_message
+  exit 0
+end
+
+# Help message content
+def help_message
+  <<~HELP
+    Usage:
+      prettify_json [options]
+
+    [Options]
+      -f, --file FILE          Input JSON file
+      -s, --string JSON        Input JSON string
+      -                        Read multiple lines from standard input (no single quotes needed)
+
+    You may specify a file path or a JSON string to be parsed and formatted.
+    IMPORTANT: make sure to surround your JSON string with single quotes to prevent the shell from splitting it by its own.
+  HELP
+end
+
+# Parse command line options and arguments
+def parse_options
+  options = {}
+  opts = option_parser(options)
+  opts.parse!
+  options
+end
+
+# OptionParser configuration
+def option_parser(options)
+  OptionParser.new do |opts|
+    opts.banner = 'Usage: prettify_json [options]'
+    add_file_option(opts, options)
+    add_string_option(opts, options)
+    add_help_option(opts)
+  end
+end
+
+# Add file option to OptionParser
+def add_file_option(opts, options)
+  opts.on('-f', '--file FILE', 'Input JSON file') do |file|
+    options[:file] = file
+  end
+end
+
+# Add string option to OptionParser
+def add_string_option(opts, options)
+  opts.on('-s', '--string JSON', 'Input JSON string') do |json_string|
+    options[:string] = json_string
+  end
+end
+
+# Add help option to OptionParser
+def add_help_option(opts)
+  opts.on('-h', '--help', 'Show this help message') do
+    display_help
+  end
+end
+
+# Read JSON input from the specified source
+def read_input(options)
+  if options[:file]
+    File.read(options[:file])
+  elsif options[:string]
+    options[:string]
+  elsif ARGV.include?('-')
+    $stdin.read
+  else
+    display_help
+  end
+end
+
+# Pretty print JSON input
+def pretty_print_json(input)
+  puts PrettifyJson::JsonPrettifier.new(input).pretty_print
+rescue JSON::ParserError => e
+  puts "Invalid JSON: #{e.message}"
+end
+
+# Main execution logic
+def main
+  options = parse_options
+
+  display_help if options.empty? && ARGV.empty?
+
+  input = read_input(options)
+  pretty_print_json(input)
+end
+
+# Execute main method
+main

data/lib/prettify_json/version.rb

@@ -0,0 +1,3 @@
+module PrettifyJson
+  VERSION = '0.1.0'.freeze
+end

data/lib/prettify_json.rb

@@ -0,0 +1,131 @@
+require 'json'
+require 'optparse'
+require 'rainbow'
+require_relative 'prettify_json/version'
+
+module PrettifyJson
+  class JsonPrettifier
+    attr_reader :json_string
+
+    def initialize(json_string)
+      @json_string = json_string
+    end
+
+    def colorize_json(json_string)
+      regex = /("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(?:\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+-]?\d+)?)/
+
+      json_string.gsub(regex) { |match| colorize_match(match) }
+    end
+
+    def colorize_match(match)
+      case match
+      when /^"/
+        match.include?(':') ? Rainbow(match).yellow : Rainbow(match).green
+      when 'true', 'false'
+        Rainbow(match).blue
+      when 'null'
+        Rainbow(match).magenta
+      else
+        Rainbow(match).red
+      end
+    end
+
+    def pretty_print
+      parsed_json = JSON.parse(json_string)
+      pretty_json = JSON.pretty_generate(parsed_json)
+      colorize_json(pretty_json)
+    rescue JSON::ParserError => e
+      "Invalid JSON: #{e.message}"
+    end
+  end
+
+  class CLI
+    def self.parse_options(argv = ARGV)
+      options = {}
+      opts = option_parser(options)
+      opts.parse!(argv)
+      options
+    end
+
+    def self.option_parser(options)
+      OptionParser.new do |opts|
+        opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options]"
+        add_file_option(opts, options)
+        add_string_option(opts, options)
+        add_help_option(opts)
+      end
+    end
+
+    def self.add_file_option(opts, options)
+      opts.on('-f', '--file FILE', 'Input JSON file') do |file|
+        options[:file] = file
+      end
+    end
+
+    def self.add_string_option(opts, options)
+      opts.on('-s', '--string JSON', 'Input JSON string') do |json_string|
+        options[:string] = json_string
+      end
+    end
+
+    def self.add_help_option(opts)
+      opts.on('-h', '--help', 'Show this help message') do
+        puts opts
+        exit
+      end
+    end
+
+    def self.read_input(options)
+      if options[:file]
+        File.read(options[:file])
+      elsif options[:string]
+        options[:string]
+      elsif ARGV.include?('-')
+        $stdin.read
+      else
+        display_help
+      end
+    end
+
+    def self.pretty_print_json(input)
+      puts PrettifyJson::JsonPrettifier.new(input).pretty_print
+    rescue JSON::ParserError => e
+      puts "Invalid JSON: #{e.message}"
+    end
+
+    def self.display_help
+      puts help_message
+      exit 0
+    end
+
+    def self.help_message
+      <<~HELP
+        Usage:
+          prettify_json [options]
+
+        [Options]
+          -f, --file FILE          Input JSON file
+          -s, --string JSON        Input JSON string
+          -                        Read multiple lines from standard input (no single quotes needed)
+
+        You may specify a file path or a JSON string to be parsed and formatted.
+        IMPORTANT: make sure to surround your JSON string with single quotes to prevent the shell from splitting it by its own.
+      HELP
+    end
+
+    def self.main(argv = ARGV)
+      options = parse_options(argv)
+
+      display_help if options.empty? && argv.empty?
+
+      input = read_input(options)
+      pretty_print_json(input)
+    end
+
+    public_class_method :main
+  end
+end
+
+if __FILE__ == $PROGRAM_NAME
+  PrettifyJson::CLI.main
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: prettify_json
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- talaatmagdyx
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A simple command line tool to pretty-print JSON with colors using Ruby.
+email:
+- talaatmagdy75@gmail.com
+executables:
+- prettify_json
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/prettify_json
+- lib/prettify_json.rb
+- lib/prettify_json/version.rb
+homepage: https://github.com/talaatmagdyx/prettify_json
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/talaatmagdyx/prettify_json
+  source_code_uri: https://github.com/talaatmagdyx/prettify_json/main
+  changelog_uri: https://github.com/talaatmagdyx/prettify_json/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/talaatmagdyx/prettify_json/issues
+  wiki_uri: https://github.com/talaatmagdyx/prettify_json/wiki
+  rubygems_mfa_required: 'true'
+post_install_message: Thanks for installing! prettify_json is A simple command line
+  tool to pretty-print JSON with colors using Ruby.
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.10
+signing_key: 
+specification_version: 4
+summary: A CLI tool to pretty-print JSON with colors.
+test_files: []