json_truncate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc0246cf913cdef7f3bfd498765aa29d6dc5712fbcb259fd46cc44f93724d273
+  data.tar.gz: db42da9845727e231270614a8666d1860df573446e17586effff62fbfb2d68be
+SHA512:
+  metadata.gz: 57db2f96a4abc66ae1283ec571c3320c3df50a8a78077145b3e89b8e777d4ed68b7a4f25222011ce9d5eecacf7eb44be1bbd7e5a6debae468ab4ed9d6306e0bd
+  data.tar.gz: 9b4bac28065b56d104622bde4b4481b5674afbbbb9a860ea9a839c2ff77902f517d48806ccca8f481f3d8a9ce133ba1022727b8e636f7b5d2615e4f4c2fa4793

data/.gitignore

@@ -0,0 +1,2 @@
+.vscode
+*.gem

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+gemspec
+
+group :test do
+    gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    json_truncate (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    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)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  json_truncate!
+  rspec
+
+BUNDLED WITH
+   2.2.21

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Sean West <sean@digitalshift.ca>
+
+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,52 @@
+# `json_truncate`
+
+Simplify JSON object structures for logging purposes. Limit the number of array elements, depth of the tree or length of strings.
+
+```ruby
+gem 'json_truncate'
+```
+
+```ruby
+require 'json_truncate'
+
+person = {
+    name: 'John Doe',
+    address: {
+        street: '123 ABC St.',
+        city: 'Truncatia',
+    },
+    image: '123456789012345678901234567890',
+    emails: [ 'jdoe@example.com', 'johnd@example.com', 'john.doe@example.com' ]
+}
+
+JsonTruncate.truncate(person,
+    max_depth: 2,
+    max_string_length: 20,
+    max_array_length: 2,
+)
+
+# {
+#     name: 'John Doe',
+#     address: {
+#         street: '123 ABC St.',
+#         city: 'Truncatia',
+#         latlong: [],
+#     },
+#     image: '12345678901234567890...',
+#     emails: [ 'jdoe@example.com', 'johnd@example.com', '...' ]
+# }
+```
+
+# Options
+
+- `max_depth`: restrict the depth of the tree by pruning arrays and hashes.
+- `max_string_length`: restrict the length of strings.
+- `max_array_length`: restrict the number of items an array can contain.
+
+All options are optional and can be used together.
+
+# Motivation
+
+There have been occassions where I just want the basics of a JSON structure and
+not all the detail. I couldn't find an existing gem to do this so I threw this one
+together.

data/json_truncate.gemspec

@@ -0,0 +1,15 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'json_truncate/version'
+
+Gem::Specification.new do |s|
+    s.name        = 'json_truncate'
+    s.license     = 'MIT'
+    s.version     = JsonTruncate::VERSION
+    s.platform    = Gem::Platform::RUBY
+    s.authors     = ['Sean West']
+    s.email       = 'sean@digitalshift.ca'
+    s.homepage    = 'http://github.com/seanzo/json_truncate'
+    s.summary     = %q{Simplify a JSON object for logging purposes.}
+    s.description = %q{Truncate any JSON values to a certain length. Truncate to a maximum depth. Truncate to a maximum number of array elements.}
+    s.files       = `git ls-files`.split("\n")
+end

data/lib/json_truncate.rb

@@ -0,0 +1,2 @@
+require 'json_truncate/truncate'
+require 'json_truncate/version'

data/lib/json_truncate/truncate.rb

@@ -0,0 +1,35 @@
+module JsonTruncate
+    def self.truncate(object, opts = {})
+        process(object.dup, opts)
+    end
+
+    def self.process(object, opts, depth = 0)
+        depth += 1
+
+        if opts[:max_array_length] && object.is_a?(Array) && object.length > opts[:max_array_length]
+            object.slice!(opts[:max_array_length]..-1)
+            object.push('...')
+        end
+
+        if opts[:max_string_length] && object.is_a?(String) && object.length > opts[:max_string_length]
+            object.slice!(opts[:max_string_length]..-1)
+            object << '...'
+        end
+
+        if opts[:max_depth] && depth > opts[:max_depth] && [ Array, Hash ].include?(object.class)
+            object.delete_if { |_| true }
+        end
+
+        if object.is_a?(Hash)
+            object.each do |k,v|
+                process(v, opts, depth)
+            end
+        elsif object.is_a?(Array)
+            object.each do |v|
+                process(v, opts, depth)
+            end
+        end
+
+        object
+    end
+end

data/lib/json_truncate/version.rb

@@ -0,0 +1,3 @@
+module JsonTruncate
+    VERSION = '0.0.1'
+end

data/spec/json_truncate/truncate_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe JsonTruncate do
+    it "should remove nested objects" do
+        o = { foo: 'bar', bar: { baz: 'foo' }}
+
+        expect(JsonTruncate.truncate(
+            o,
+            max_depth: 1
+        )).to eql({ foo: 'bar', bar: {}})
+    end
+
+    it "should remove array items" do
+        o = { foo: [ 'foo', 'bar', 'baz' ], bar: { baz: [ 'foo', 'bar' ]}}
+
+        expect(JsonTruncate.truncate(
+            o,
+            max_array_length: 1
+        )).to eql({ foo: [ 'foo', '...' ], bar: { baz: [ 'foo', '...' ]}})
+    end
+
+    it "should truncate strings" do
+        o = { foo: '1234567890', bar: { baz: '1234567890', bat: [ '1234567890' ]}}
+
+        expect(JsonTruncate.truncate(
+            o,
+            max_string_length: 5
+        )).to eql({ foo: '12345...', bar: { baz: '12345...', 'bat': [ '12345...' ]}})
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+require 'json_truncate'

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: json_truncate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sean West
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-25 00:00:00.000000000 Z
+dependencies: []
+description: Truncate any JSON values to a certain length. Truncate to a maximum depth.
+  Truncate to a maximum number of array elements.
+email: sean@digitalshift.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- json_truncate.gemspec
+- lib/json_truncate.rb
+- lib/json_truncate/truncate.rb
+- lib/json_truncate/version.rb
+- spec/json_truncate/truncate_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/seanzo/json_truncate
+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.7.6.2
+signing_key: 
+specification_version: 4
+summary: Simplify a JSON object for logging purposes.
+test_files: []