json_pretty_generate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64bd62d114a4fa52979974f1321141d6fa75baecae332267d777fb0c5b5e5e4a
+  data.tar.gz: de25100652bc8884377f824c2ccd73f0b09746ec1407f0bfae73ff5400155e79
+SHA512:
+  metadata.gz: a6d5cf4cd28d36c0f38ff8238a507bfa1da7304113fabb7da3eb1e73fdea075ebddac88ea4487b9b26bc8760eb18c0931289ba802e6e16f476ccc2c1f0c075b8
+  data.tar.gz: bd6044e841d2a638f2f2160d4de8e3034a54a9129bae18290d12842d46fbe9b13e5f7d97a3ce2e790629add67b93ee3259b440d684dd71091ce2bea9ff37b689

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Metrics:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'rake'
+
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rubocop'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    json_pretty_generate (0.1.0)
+      activesupport (~> 4.2.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.11.3)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.16.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json_pretty_generate!
+  pry
+  rake
+  rspec
+  rubocop
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Nick Palaniuk
+
+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,83 @@
+# JSON Pretty Generate
+
+Small utility method for pretty generating JSON
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_pretty_generate'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install json_pretty_generate
+
+## Usage
+
+There is a single `::call` method.
+
+### Argument is a Hash
+
+When the argument is a Hash JSON will be returned with line breaks
+```ruby
+obj = { a: 1 }
+JSONPrettyGenerate.(obj)
+# => "{\n  \"a\": 1\n}"
+```
+
+### Argument is a String
+
+When the argument is JSON it returns JSON with line breaks
+```ruby
+obj = "{\"a\":1}"
+JSONPrettyGenerate.(obj)
+# => "{\n  \"a\": 1\n}"
+```
+
+When the argument is a string that is not JSON it returns the argument
+```ruby
+obj = "a=1"
+JSONPrettyGenerate.(obj)
+# => "a=1"
+```
+
+### Argument is not a String or a Hash
+
+When the argument type is not a String or Hash it will return nil
+```ruby
+obj = 1
+JSONPrettyGenerate.(obj)
+# => nil
+```
+
+### Filtering with a block
+
+You can use a block to filter the obj to a subset of the data. Strings
+or symbols can be passed to the block argument.
+```ruby
+obj = { data: { body: { a: 1 } } }
+JSONPrettyGenerate.(obj) { |o| o[:data][:body] }
+# => "{\n  \"a\": 1\n}"
+```
+
+## Development
+
+To run the specs
+
+```bash
+  $  bundle exec rake
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nikkypx/json_pretty_generate.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop:auto_correct]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'json_pretty_generate'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json_pretty_generate.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'lib/json_pretty_generate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'json_pretty_generate'
+  spec.version       = JSONPrettyGenerate::VERSION
+  spec.authors       = ['Nicholas Palaniuk']
+  spec.email         = ['npalaniuk+github@gmail.com']
+  spec.summary       = 'Util for pretty printing JSON'
+  spec.description   = 'Util for pretty printing JSON'
+  spec.homepage      = 'https://github.com/nikkypx/json_pretty_generate'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.license       = 'MIT'
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  spec.require_paths = ['lib']
+  spec.add_dependency 'activesupport', '~> 4.2.10'
+end

data/lib/json_pretty_generate.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'json_pretty_generate/version'
+require 'active_support/core_ext/hash'
+require 'json'
+
+module JSONPrettyGenerate
+  def self.call(obj)
+    return unless [Hash, String].include?(obj.class)
+
+    if obj.is_a? String
+      begin
+        obj = JSON.parse(obj)
+      rescue JSON::ParserError
+        return obj
+      end
+    end
+
+    obj = yield(obj.with_indifferent_access) if block_given?
+
+    JSON.pretty_generate(obj)
+  end
+end

data/lib/json_pretty_generate/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JSONPrettyGenerate
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: json_pretty_generate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas Palaniuk
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.10
+description: Util for pretty printing JSON
+email:
+- npalaniuk+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_pretty_generate.gemspec
+- lib/json_pretty_generate.rb
+- lib/json_pretty_generate/version.rb
+homepage: https://github.com/nikkypx/json_pretty_generate
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nikkypx/json_pretty_generate
+  source_code_uri: https://github.com/nikkypx/json_pretty_generate
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Util for pretty printing JSON
+test_files: []