deep_hash_transformer 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7f171270350f94fdce54754d2cd72e7832b50d96fd92255e7c0ccf2b4a4460b
-  data.tar.gz: bfbe82ac975f7a38f21a26ffd969fb226592ec67e4d54c6009213ad56883e146
+  metadata.gz: 7e757436383ce13e17ee8e2b68e48d419e2f9f3c2e57fcfa76503e723ecde5e0
+  data.tar.gz: 5508770653b53402c6be53f9a3b1c0ea42a899b42760c2844565c3befa4bc54c
 SHA512:
-  metadata.gz: 3c2b9b9c03df98e7407c1ff2e365b2b49a5e200380b1a3747be28d3bcdb8832be8c59c5b94db2753b93809549d7841da2bf1e0a9d6bb425c1c9f545802bea830
-  data.tar.gz: cab7709f4bf6dbb2a3c9d692c0d3bb4af83b4ce318a020624ad7151c7e1d71f40dde2dec2df51326d79e0f9ae7f2a97c72ba11c65c38467e3e617d26bb572d1f
+  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/element_operation.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+class DeepHashTransformer
+  module ElementOperation
+    class << self
+      def camel_case(val)
+        pascal_case(val)
+          .sub(/^[A-Z]/, &:downcase)
+      end
+
+      def dasherize(val)
+        stringify(val)
+          .tr('_', '-')
+      end
+
+      def identity(val)
+        val
+      end
+
+      def pascal_case(val)
+        stringify(val)
+          .split(/(?=[A-Z])|[-_]/)
+          .map(&:capitalize)
+          .join
+      end
+
+      def stringify(val)
+        val.to_s
+      end
+
+      def symbolize(val)
+        val.to_sym
+      end
+
+      def underscore(val)
+        stringify(val)
+          .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('-', '_')
+          .downcase
+      end
+    end
+  end
+end

data/lib/deep_hash_transformer/version.rb

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

data/lib/deep_hash_transformer.rb

@@ -1,25 +1,44 @@
 # frozen_string_literal: true
 
+require 'deep_hash_transformer/collection_operation'
+require 'deep_hash_transformer/element_operation'
 require 'deep_hash_transformer/version'
 
 class DeepHashTransformer
-  OPS = {
-    dasherize: ->(val) { val.to_s.tr('_', '-') },
-    identity: ->(val) { val },
-    stringify: ->(val) { val.to_s },
-    symbolize: ->(val) { val.to_sym },
-    underscore: ->(val) { val.to_s.tr('-', '_') }
-  }.freeze
+  ELEMENT_OPS = %i[
+    camel_case
+    dasherize
+    identity
+    pascal_case
+    snake_case
+    stringify
+    symbolize
+    underscore
+  ].freeze
+
+  COLLECTION_OPS = %i[
+    compact
+    compact_blank
+  ].freeze
+
+  OPS = ELEMENT_OPS + COLLECTION_OPS
 
   def initialize(hash)
     @hash = hash
   end
 
   def tr(*ops)
+    unknown_transformations = ops.map(&:to_s) - OPS.map(&:to_s)
+    if unknown_transformations.any?
+      raise(
+        ArgumentError, "unknown transformation(s): #{unknown_transformations.join(',')}"
+      )
+    end
+
     transform_value(hash, ops)
   end
 
-  OPS.each_key do |operation|
+  OPS.each do |operation|
     define_method(operation) { tr(operation) }
   end
 
@@ -27,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| OPS.fetch(op).call(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

@@ -1,87 +1,128 @@
 # frozen_string_literal: true
 
 RSpec.describe DeepHashTransformer do
-  subject do
-    described_class.new(
-      Integer => 123,
-      :foobar => { bar: 'bar' },
-      'aa_zz' => [{ 'bar' => :bar, 'a-z' => 'a-z' }]
-    )
-  end
+  subject(:operation) { described_class.new(example) }
+
+  let(:example) { { foo: 'bar' } }
 
-  describe '#tr with `:underscore, :symbolize`' do
-    subject { super().tr(:underscore, :symbolize) }
+  describe 'autogenerated methods' do
+    DeepHashTransformer::ELEMENT_OPS.each do |method|
+      describe ".#{method}" do
+        it "delegates to `Operation.#{method}`" do
+          expect(
+            DeepHashTransformer::ElementOperation
+          ).to receive(method).with(:foo).once # rubocop:disable RSpec/MessageSpies
 
-    it do
-      expect(subject).to eq( # rubocop:disable RSpec/NamedSubject
-        Integer => 123,
-        :foobar => { bar: 'bar' },
-        :aa_zz => [{ bar: :bar, a_z: 'a-z' }]
-      )
+          operation.public_send(method)
+        end
+      end
     end
   end
 
-  describe '#dasherize' do
-    subject { super().dasherize }
+  describe '#tr' do
+    context 'with `:snake_case, :symbolize`' do
+      subject { super().tr(:snake_case, :symbolize) }
 
-    it do
-      expect(subject).to eq( # rubocop:disable RSpec/NamedSubject
-        Integer => 123,
-        'foobar' => { 'bar' => 'bar' },
-        'aa-zz' => [{ 'bar' => :bar, 'a-z' => 'a-z' }]
-      )
+      let(:example) { { 'FooBar' => 'baz' } }
+
+      it { is_expected.to eq(foo_bar: 'baz') }
     end
-  end
 
-  describe '#identity' do
-    subject { super().identity }
+    context 'with an unknown transformation' do
+      subject(:unknown_ops) { operation.tr(:unknown) }
 
-    it do
-      expect(subject).to eq( # rubocop:disable RSpec/NamedSubject
-        Integer => 123,
-        :foobar => { bar: 'bar' },
-        'aa_zz' => [{ 'bar' => :bar, 'a-z' => 'a-z' }]
-      )
+      it 'raise an exception' do
+        expect { unknown_ops }.to raise_error(ArgumentError, /unknown/)
+      end
     end
-  end
 
-  describe '#stringify' do
-    subject { super().stringify }
+    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' => [
+            {
+              'camelCased' => 'camelCased',
+              'dashed-key' => 'dashed-key',
+              'PascalCased' => 'PascalCased',
+              'under_scored' => 'under_scored'
+            }
+          ]
+        }
+      end
 
-    it do
-      expect(subject).to eq( # rubocop:disable RSpec/NamedSubject
-        Integer => 123,
-        'foobar' => { 'bar' => 'bar' },
-        'aa_zz' => [{ 'bar' => :bar, 'a-z' => 'a-z' }]
-      )
+      it do # rubocop:disable RSpec/ExampleLength
+        is_expected.to eq( # rubocop:disable RSpec/ImplicitSubject
+          Integer => 123,
+          :symbol => { fooBar: 'bar' },
+          :string => { fooBar: 123 },
+          :nestedArray => [
+            {
+              camelCased: 'camelCased',
+              dashedKey: 'dashed-key',
+              pascalCased: 'PascalCased',
+              underScored: 'under_scored'
+            }
+          ]
+        )
+      end
     end
-  end
 
-  describe '#symbolize' do
-    subject { super().symbolize }
+    context 'with nil values' do
+      subject { super().tr(:compact, :stringify) }
 
-    it do
-      expect(subject).to eq( # rubocop:disable RSpec/NamedSubject
-        Integer => 123,
-        :foobar => { bar: 'bar' },
-        :aa_zz => [{ bar: :bar, 'a-z': 'a-z' }]
-      )
+      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
-  end
 
-  describe '#underscore' do
-    subject { super().underscore }
+    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 do
-      expect(subject).to eq( # rubocop:disable RSpec/NamedSubject
-        Integer => 123,
-        'foobar' => { 'bar' => 'bar' },
-        'aa_zz' => [{ 'bar' => :bar, 'a_z' => 'a-z' }]
-      )
+      it { is_expected.to eq({}) }
     end
   end
 
   it 'has a version number' do
-    expect(DeepHashTransformer::VERSION).not_to be nil
+    expect(DeepHashTransformer::VERSION).not_to be_nil
   end
 end

data/spec/spec_helper.rb

@@ -1,10 +1,26 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'coveralls'
 require 'deep_hash_transformer'
+require 'deep_hash_transformer/blank'
+require 'deep_hash_transformer/collection_operation'
+require 'deep_hash_transformer/element_operation'
+require 'simplecov'
 
-Coveralls.wear!
+SimpleCov.start do
+  if ENV['CI']
+    require 'simplecov-lcov'
+
+    SimpleCov::Formatter::LcovFormatter.config do |c|
+      c.report_with_single_file = true
+      c.single_report_path = 'coverage/lcov.info'
+    end
+
+    formatter SimpleCov::Formatter::LcovFormatter
+  end
+
+  add_filter %w[version.rb initializer.rb]
+end
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure

metadata

@@ -1,100 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: deep_hash_transformer
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Martin Spickermann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  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: 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-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'
-description: "    DeepHashTransformer helps to transform deeply nested hash structures\n"
+date: 2023-05-16 00:00:00.000000000 Z
+dependencies: []
+description: "    DeepHashTransformer helps to transform keys in deeply nested hash
+  structures\n"
 email:
 - spickermann@gmail.com
 executables: []
@@ -103,13 +20,20 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - lib/deep_hash_transformer.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/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
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -125,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Transforms deeply nested hash structure