deep_hash_transformer 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd4691f4f42a7a731098aeb989eb7f333e5d34a2a627ddb3229653ff8e1a3a6f
-  data.tar.gz: 95b96a971d5b65f37411ead70ffd93d92624a145e65125a81d992cc238a87978
+  metadata.gz: 7e757436383ce13e17ee8e2b68e48d419e2f9f3c2e57fcfa76503e723ecde5e0
+  data.tar.gz: 5508770653b53402c6be53f9a3b1c0ea42a899b42760c2844565c3befa4bc54c
 SHA512:
-  metadata.gz: f5f0e923fbed861df614b33a0e3465a8ebb24da4020750414ff911b779e07520507d6cf85c44ffa88bb0009b0fffcea192c3743a9ed7c5aa9562b2f28dc12861
-  data.tar.gz: 99412bba8c0260a5c90cd126726380f0336dfd5570d806b107601ca735edd2295d9fe8f642af9e5ac4b6a401ae8268e26fce8b59210143fabfe89e7274687180
+  metadata.gz: 02c165dda7044c595af36f476fe4234dfca724654e4384d971c183f14dadab6a1f9782f58dd5736f2b82962b7811a41fd51350b2a755ef62cfe684b259dd705d
+  data.tar.gz: 41ed65816b738a755fdfbf9e97c0c6ef408fa022a16230d504b0acb4f744ef10279f98954b3eb1c22eaf7af552a9ef5a40c61b75e68cfe4f723f444ebd7e9987

data/lib/deep_hash_transformer/blank.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class DeepHashTransformer
+  class Blank
+    BLANK_STRING = /\A[[:space:]]*\z/.freeze
+
+    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)

data/lib/deep_hash_transformer/version.rb

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

data/lib/deep_hash_transformer.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require 'deep_hash_transformer/operation'
+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,20 +46,30 @@ class DeepHashTransformer
 
   attr_reader :hash
 
-  def transform_value(value, ops)
-    case value
-    when Array
-      value.map { |e| transform_value(e, ops) }
-    when Hash
-      value.map { |k, v| [transform_key(k, ops), transform_value(v, ops)] }.to_h
-    else
-      value
+  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)
+    collection = case value
+                 when Array
+                   value.map { |e| transform_value(e, ops) }
+                 when Hash
+                   value.map { |k, v| [transform_key(k, ops), transform_value(v, ops)] }.to_h
+                 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/{operation_spec.rb → element_operation_spec.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe DeepHashTransformer::Operation do
+RSpec.describe DeepHashTransformer::ElementOperation do
   examples = [
     :symbol, 'string', 'camelCase', 'dashed-key', 'PascalCase', 'under_scored'
   ]
@@ -22,7 +22,7 @@ RSpec.describe DeepHashTransformer::Operation do
   }
   # rubocop:enable Layout/HashAlignment, Style/SymbolArray, Style/WordArray
 
-  DeepHashTransformer::OPS.each do |method|
+  DeepHashTransformer::ELEMENT_OPS.each do |method|
     describe "##{method}" do
       let(:method) { method }
 

data/spec/deep_hash_transformer_spec.rb

@@ -6,11 +6,11 @@ RSpec.describe DeepHashTransformer do
   let(:example) { { foo: 'bar' } }
 
   describe 'autogenerated methods' do
-    DeepHashTransformer::OPS.each do |method|
+    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)
@@ -71,6 +71,55 @@ RSpec.describe DeepHashTransformer do
         )
       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

data/spec/spec_helper.rb

@@ -2,7 +2,9 @@
 
 require 'bundler/setup'
 require 'deep_hash_transformer'
-require 'deep_hash_transformer/operation'
+require 'deep_hash_transformer/blank'
+require 'deep_hash_transformer/collection_operation'
+require 'deep_hash_transformer/element_operation'
 require 'simplecov'
 
 SimpleCov.start do

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.0
 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-05-16 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
@@ -157,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Transforms deeply nested hash structure