deep_hash_transformer 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd4691f4f42a7a731098aeb989eb7f333e5d34a2a627ddb3229653ff8e1a3a6f
-  data.tar.gz: 95b96a971d5b65f37411ead70ffd93d92624a145e65125a81d992cc238a87978
+  metadata.gz: cd3cd6700a7e51238c1c16feb30a81fb8debe53c5225401f33442ef29d771c92
+  data.tar.gz: 93aeb34e4a4e0bdbefa97d6d946d21fc8ab87457bd8361d992aa66399100849e
 SHA512:
-  metadata.gz: f5f0e923fbed861df614b33a0e3465a8ebb24da4020750414ff911b779e07520507d6cf85c44ffa88bb0009b0fffcea192c3743a9ed7c5aa9562b2f28dc12861
-  data.tar.gz: 99412bba8c0260a5c90cd126726380f0336dfd5570d806b107601ca735edd2295d9fe8f642af9e5ac4b6a401ae8268e26fce8b59210143fabfe89e7274687180
+  metadata.gz: 515fe31abc501135498b1450e9f90820c7612161e643198f9276006095abc5eff05e5c54cb924c37ae4e801e078a9cf9f26ccb17900341b2b7f093e86f9d4c03
+  data.tar.gz: 4cb38f5bcfcf1265f77244e61c8d4b13f0d833a52b6ef4e334cbe43bbe157eeee4a3c467f5d08f45b2e738cfee936395cee3a073e79e2c9453a7ba8aef7ab001

data/lib/deep_hash_transformer/blank.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class DeepHashTransformer
+  class Blank
+    BLANK_STRING = /\A[[:space:]]*\z/
+
+    def self.call(value)
+      new(value).blank?
+    end
+
+    def initialize(value)
+      @value = value
+    end
+
+    def blank?
+      return true unless value
+      return value.blank? if value.respond_to?(:blank?)
+      return BLANK_STRING.match?(value) if value.is_a?(String)
+      return value.empty? if value.respond_to?(:empty?)
+
+      false
+    end
+
+    private
+
+    attr_reader :value
+  end
+end

data/lib/deep_hash_transformer/collection_operation.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "blank"
+
+class DeepHashTransformer
+  module CollectionOperation
+    class << self
+      def compact(val)
+        case val
+        when Array, Hash
+          val.compact
+        else
+          val
+        end
+      end
+
+      def compact_blank(val)
+        case val
+        when Array
+          val.reject { |elem| Blank.call(elem) }
+        when Hash
+          val.reject { |_, v| Blank.call(v) }
+        else
+          val
+        end
+      end
+    end
+  end
+end

data/lib/deep_hash_transformer/{operation.rb → element_operation.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class DeepHashTransformer
-  module Operation
+  module ElementOperation
     class << self
       def camel_case(val)
         pascal_case(val)
@@ -10,7 +10,7 @@ class DeepHashTransformer
 
       def dasherize(val)
         stringify(val)
-          .tr('_', '-')
+          .tr("_", "-")
       end
 
       def identity(val)
@@ -34,14 +34,14 @@ class DeepHashTransformer
 
       def underscore(val)
         stringify(val)
-          .tr('-', '_')
+          .tr("-", "_")
       end
 
       def snake_case(val)
         stringify(val)
           .gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
           .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-          .tr('-', '_')
+          .tr("-", "_")
           .downcase
       end
     end

data/lib/deep_hash_transformer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class DeepHashTransformer
-  VERSION = '2.1.0'
+  VERSION = "2.2.1"
 end

data/lib/deep_hash_transformer.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require 'deep_hash_transformer/operation'
-require 'deep_hash_transformer/version'
+require "deep_hash_transformer/collection_operation"
+require "deep_hash_transformer/element_operation"
+require "deep_hash_transformer/version"
 
 class DeepHashTransformer
-  OPS = %i[
+  ELEMENT_OPS = %i[
     camel_case
     dasherize
     identity
@@ -15,15 +16,22 @@ class DeepHashTransformer
     underscore
   ].freeze
 
+  COLLECTION_OPS = %i[
+    compact
+    compact_blank
+  ].freeze
+
+  OPS = ELEMENT_OPS + COLLECTION_OPS
+
   def initialize(hash)
     @hash = hash
   end
 
   def tr(*ops)
-    unknown_transformtions = ops.map(&:to_s) - OPS.map(&:to_s)
-    if unknown_transformtions.any?
+    unknown_transformations = ops.map(&:to_s) - OPS.map(&:to_s)
+    if unknown_transformations.any?
       raise(
-        ArgumentError, "unknown transformation(s): #{unknown_transformtions.join(',')}"
+        ArgumentError, "unknown transformation(s): #{unknown_transformations.join(",")}"
       )
     end
 
@@ -38,8 +46,14 @@ class DeepHashTransformer
 
   attr_reader :hash
 
+  def transform_collection(collection, ops)
+    ops.inject(collection) do |c, op|
+      COLLECTION_OPS.include?(op) ? CollectionOperation.public_send(op, c) : c
+    end
+  end
+
   def transform_value(value, ops)
-    case value
+    collection = case value
     when Array
       value.map { |e| transform_value(e, ops) }
     when Hash
@@ -47,11 +61,15 @@ class DeepHashTransformer
     else
       value
     end
+
+    transform_collection(collection, ops)
   end
 
   def transform_key(key, ops)
     return key unless [String, Symbol].include?(key.class)
 
-    ops.inject(key) { |k, op| Operation.public_send(op, k) }
+    ops.inject(key) do |k, op|
+      ELEMENT_OPS.include?(op) ? ElementOperation.public_send(op, k) : k
+    end
   end
 end

data/spec/deep_hash_transformer/blank_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+RSpec.describe DeepHashTransformer::Blank do
+  describe ".call" do
+    subject { described_class.call(value) }
+
+    presents = [true, 1, 0, "any", [nil], {A: nil}]
+    blanks = [nil, false, "", " ", [], {}]
+
+    presents.each do |value|
+      context "with #{value.inspect}" do
+        let(:value) { value }
+
+        it { is_expected.to be false }
+      end
+    end
+
+    blanks.each do |value|
+      context "with #{value.inspect}" do
+        let(:value) { value }
+
+        it { is_expected.to be true }
+      end
+    end
+  end
+end

data/spec/deep_hash_transformer/collection_operation_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+RSpec.describe DeepHashTransformer::CollectionOperation do
+  examples = [
+    {a: "b"}, {a: nil}, {a: " "}, [:foo], ["", nil]
+  ]
+
+  subject do
+    examples.map { |value| described_class.public_send(method, value) }
+  end
+
+  describe ".compact" do
+    let(:method) { :compact }
+
+    expected_output = [
+      {a: "b"}, {}, {a: " "}, [:foo], [""]
+    ]
+
+    it { is_expected.to eq(expected_output) }
+  end
+
+  describe ".compact_blank" do
+    let(:method) { :compact_blank }
+
+    expected_output = [
+      {a: "b"}, {}, {}, [:foo], []
+    ]
+
+    it { is_expected.to eq(expected_output) }
+  end
+end

data/spec/deep_hash_transformer/element_operation_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+RSpec.describe DeepHashTransformer::ElementOperation do
+  examples = [
+    :symbol, "string", "camelCase", "dashed-key", "PascalCase", "under_scored"
+  ]
+
+  subject do
+    examples.map { |value| described_class.public_send(method, value) }
+  end
+
+  # rubocop:disable Layout/HashAlignment, Style/SymbolArray, Style/WordArray
+  expected_output = {
+    camel_case:  ["symbol", "string", "camelCase", "dashedKey", "pascalCase", "underScored"],
+    dasherize:   ["symbol", "string", "camelCase", "dashed-key", "PascalCase", "under-scored"],
+    identity:    [:symbol, "string", "camelCase", "dashed-key", "PascalCase", "under_scored"],
+    pascal_case: ["Symbol", "String", "CamelCase", "DashedKey", "PascalCase", "UnderScored"],
+    snake_case:  ["symbol", "string", "camel_case", "dashed_key", "pascal_case", "under_scored"],
+    stringify:   ["symbol", "string", "camelCase", "dashed-key", "PascalCase", "under_scored"],
+    symbolize:   [:symbol, :string, :camelCase, :"dashed-key", :PascalCase, :under_scored],
+    underscore:  ["symbol", "string", "camelCase", "dashed_key", "PascalCase", "under_scored"]
+  }
+  # rubocop:enable Layout/HashAlignment, Style/SymbolArray, Style/WordArray
+
+  DeepHashTransformer::ELEMENT_OPS.each do |method|
+    describe "##{method}" do
+      let(:method) { method }
+
+      it { is_expected.to eq(expected_output[method]) }
+    end
+  end
+end

data/spec/deep_hash_transformer_spec.rb

@@ -3,14 +3,14 @@
 RSpec.describe DeepHashTransformer do
   subject(:operation) { described_class.new(example) }
 
-  let(:example) { { foo: 'bar' } }
+  let(:example) { {foo: "bar"} }
 
-  describe 'autogenerated methods' do
-    DeepHashTransformer::OPS.each do |method|
+  describe "autogenerated methods" do
+    DeepHashTransformer::ELEMENT_OPS.each do |method|
       describe ".#{method}" do
         it "delegates to `Operation.#{method}`" do
           expect(
-            DeepHashTransformer::Operation
+            DeepHashTransformer::ElementOperation
           ).to receive(method).with(:foo).once # rubocop:disable RSpec/MessageSpies
 
           operation.public_send(method)
@@ -19,37 +19,37 @@ RSpec.describe DeepHashTransformer do
     end
   end
 
-  describe '#tr' do
-    context 'with `:snake_case, :symbolize`' do
+  describe "#tr" do
+    context "with `:snake_case, :symbolize`" do
       subject { super().tr(:snake_case, :symbolize) }
 
-      let(:example) { { 'FooBar' => 'baz' } }
+      let(:example) { {"FooBar" => "baz"} }
 
-      it { is_expected.to eq(foo_bar: 'baz') }
+      it { is_expected.to eq(foo_bar: "baz") }
     end
 
-    context 'with an unknown transformation' do
+    context "with an unknown transformation" do
       subject(:unknown_ops) { operation.tr(:unknown) }
 
-      it 'raise an exception' do
+      it "raise an exception" do
         expect { unknown_ops }.to raise_error(ArgumentError, /unknown/)
       end
     end
 
-    context 'with a complex, nested example' do
+    context "with a complex, nested example" do
       subject { super().tr(:camel_case, :symbolize) }
 
       let(:example) do
         {
           Integer => 123,
-          :symbol => { foo_bar: 'bar' },
-          'string' => { 'foo_bar' => 123 },
-          'nested-array' => [
+          :symbol => {foo_bar: "bar"},
+          "string" => {"foo_bar" => 123},
+          "nested-array" => [
             {
-              'camelCased' => 'camelCased',
-              'dashed-key' => 'dashed-key',
-              'PascalCased' => 'PascalCased',
-              'under_scored' => 'under_scored'
+              "camelCased" => "camelCased",
+              "dashed-key" => "dashed-key",
+              "PascalCased" => "PascalCased",
+              "under_scored" => "under_scored"
             }
           ]
         }
@@ -58,22 +58,71 @@ RSpec.describe DeepHashTransformer do
       it do # rubocop:disable RSpec/ExampleLength
         is_expected.to eq( # rubocop:disable RSpec/ImplicitSubject
           Integer => 123,
-          :symbol => { fooBar: 'bar' },
-          :string => { fooBar: 123 },
+          :symbol => {fooBar: "bar"},
+          :string => {fooBar: 123},
           :nestedArray => [
             {
-              camelCased: 'camelCased',
-              dashedKey: 'dashed-key',
-              pascalCased: 'PascalCased',
-              underScored: 'under_scored'
+              camelCased: "camelCased",
+              dashedKey: "dashed-key",
+              pascalCased: "PascalCased",
+              underScored: "under_scored"
             }
           ]
         )
       end
     end
+
+    context "with nil values" do
+      subject { super().tr(:compact, :stringify) }
+
+      let(:example) do
+        {a: {b: ["", nil, :value], c: "", d: nil, e: true, f: false, g: 123, h: [""]}}
+      end
+
+      it do # rubocop:disable RSpec/ExampleLength
+        is_expected.to eq( # rubocop:disable RSpec/ImplicitSubject
+          "a" => {
+            "b" => ["", :value],
+            "c" => "",
+            "e" => true,
+            "f" => false,
+            "g" => 123,
+            "h" => [""]
+          }
+        )
+      end
+    end
+
+    context "with blank values" do
+      subject { super().tr(:compact_blank, :stringify) }
+
+      let(:example) do
+        {a: {b: ["", nil, :value], c: "", d: nil, e: true, f: false, g: 123, h: [""]}}
+      end
+
+      it do # rubocop:disable RSpec/ExampleLength
+        is_expected.to eq( # rubocop:disable RSpec/ImplicitSubject
+          "a" => {
+            "b" => [:value],
+            "e" => true,
+            "g" => 123
+          }
+        )
+      end
+    end
+
+    context "with deeply nested blank values" do
+      subject { super().tr(:compact_blank) }
+
+      let(:example) do
+        {a: {b: [nil, {c: nil}]}}
+      end
+
+      it { is_expected.to eq({}) }
+    end
   end
 
-  it 'has a version number' do
+  it "has a version number" do
     expect(DeepHashTransformer::VERSION).not_to be_nil
   end
 end

data/spec/spec_helper.rb

@@ -1,20 +1,26 @@
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'deep_hash_transformer'
-require 'deep_hash_transformer/operation'
-require 'simplecov'
+require "bundler/setup"
+require "deep_hash_transformer"
+require "deep_hash_transformer/blank"
+require "deep_hash_transformer/collection_operation"
+require "deep_hash_transformer/element_operation"
+
+require "simplecov"
 
 SimpleCov.start do
-  if ENV['CI']
-    require 'simplecov-lcov'
+  if ENV["CI"]
+    require "simplecov_json_formatter"
+    require "simplecov-lcov"
 
     SimpleCov::Formatter::LcovFormatter.config do |c|
       c.report_with_single_file = true
-      c.single_report_path = 'coverage/lcov.info'
+      c.single_report_path = "coverage/lcov.info"
     end
 
-    formatter SimpleCov::Formatter::LcovFormatter
+    formatter SimpleCov::Formatter::MultiFormatter.new [
+      SimpleCov::Formatter::JSONFormatter, SimpleCov::Formatter::LcovFormatter
+    ]
   end
 
   add_filter %w[version.rb initializer.rb]
@@ -22,7 +28,7 @@ end
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = '.rspec_status'
+  config.example_status_persistence_file_path = ".rspec_status"
 
   config.expect_with :rspec do |c|
     c.syntax = :expect

metadata

@@ -1,127 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: deep_hash_transformer
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Martin Spickermann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-05 00:00:00.000000000 Z
-dependencies:
-- !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: rspec
-  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: rubocop
-  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: rubocop-performance
-  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: rubocop-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: rubocop-rspec
-  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: simplecov
-  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: simplecov-lcov
-  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'
+date: 2023-12-25 00:00:00.000000000 Z
+dependencies: []
 description: "    DeepHashTransformer helps to transform keys in deeply nested hash
   structures\n"
 email:
@@ -132,9 +20,13 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - lib/deep_hash_transformer.rb
-- lib/deep_hash_transformer/operation.rb
+- lib/deep_hash_transformer/blank.rb
+- lib/deep_hash_transformer/collection_operation.rb
+- lib/deep_hash_transformer/element_operation.rb
 - lib/deep_hash_transformer/version.rb
-- spec/deep_hash_transformer/operation_spec.rb
+- spec/deep_hash_transformer/blank_spec.rb
+- spec/deep_hash_transformer/collection_operation_spec.rb
+- spec/deep_hash_transformer/element_operation_spec.rb
 - spec/deep_hash_transformer_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/spickermann/deep_hash_transformer
@@ -150,14 +42,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Transforms deeply nested hash structure

data/spec/deep_hash_transformer/operation_spec.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe DeepHashTransformer::Operation do
-  examples = [
-    :symbol, 'string', 'camelCase', 'dashed-key', 'PascalCase', 'under_scored'
-  ]
-
-  subject do
-    examples.map { |value| described_class.public_send(method, value) }
-  end
-
-  # rubocop:disable Layout/HashAlignment, Style/SymbolArray, Style/WordArray
-  expected_output = {
-    camel_case:  ['symbol', 'string', 'camelCase',  'dashedKey',   'pascalCase',  'underScored'],
-    dasherize:   ['symbol', 'string', 'camelCase',  'dashed-key',  'PascalCase',  'under-scored'],
-    identity:    [:symbol,  'string', 'camelCase',  'dashed-key',  'PascalCase',  'under_scored'],
-    pascal_case: ['Symbol', 'String', 'CamelCase',  'DashedKey',   'PascalCase',  'UnderScored'],
-    snake_case:  ['symbol', 'string', 'camel_case', 'dashed_key',  'pascal_case', 'under_scored'],
-    stringify:   ['symbol', 'string', 'camelCase',  'dashed-key',  'PascalCase',  'under_scored'],
-    symbolize:   [:symbol,  :string,  :camelCase,   :'dashed-key', :PascalCase,   :under_scored],
-    underscore:  ['symbol', 'string', 'camelCase',  'dashed_key',  'PascalCase',  'under_scored']
-  }
-  # rubocop:enable Layout/HashAlignment, Style/SymbolArray, Style/WordArray
-
-  DeepHashTransformer::OPS.each do |method|
-    describe "##{method}" do
-      let(:method) { method }
-
-      it { is_expected.to eq(expected_output[method]) }
-    end
-  end
-end