darthjee-core_ext 1.7.4 → 2.0.0

data/spec/support/shared_examples/hash/hash_squasher.rb

@@ -2,22 +2,67 @@
 
 require 'spec_helper'
 
-shared_examples 'a class that has a method to squash a hash' do
-  describe '#squash' do
-    let(:hash) { { a: { b: 1, c: { d: 2 } } } }
+shared_examples 'a method to squash a hash' do |joiner = '.'|
+  let(:hash) { { a: { b: 1, c: { d: 2 } } } }
+
+  context 'with hash values' do
+    let(:key1) { %w[a b].join(joiner) }
+    let(:key2) { %w[a c d].join(joiner) }
 
     it 'flattens the hash' do
-      expect(squashed).to eq('a.b' => 1, 'a.c.d' => 2)
+      expect(squashed).to eq(key1 => 1, key2 => 2)
     end
 
     it { expect { hash.squash }.not_to(change { hash }) }
+  end
 
-    context 'with array value' do
-      let(:hash) { { a: { b: [1, { x: 3, y: { z: 4 } }] } } }
+  context 'with simple array value' do
+    let(:hash) do
+      {
+        'person' => %w[John Wick]
+      }
+    end
+
+    it 'squash also hash' do
+      expect(squashed).to eq(
+        'person[0]' => 'John',
+        'person[1]' => 'Wick'
+      )
+    end
+  end
+
+  context 'with array containing hashes' do
+    let(:hash) { { a: { b: [1, { x: 3, y: { z: 4 } }] } } }
+    let(:key)  { %w[a b].join(joiner) }
+
+    let(:expected) do
+      {
+        "#{key}[0]" => 1,
+        "#{key}[1]#{joiner}x" => 3,
+        "#{key}[1]#{joiner}y#{joiner}z" => 4
+      }
+    end
 
-      it 'flattens the hash' do
-        expect(squashed).to eq('a.b' => [1, { x: 3, y: { z: 4 } }])
-      end
+    it 'flattens the hash' do
+      expect(squashed).to eq(expected)
+    end
+  end
+
+  context 'with array containing arrays' do
+    let(:hash) { { a: { b: [[11, 12], [21, 22]] } } }
+    let(:key)  { %w[a b].join(joiner) }
+
+    let(:expected) do
+      {
+        "#{key}[0][0]" => 11,
+        "#{key}[0][1]" => 12,
+        "#{key}[1][0]" => 21,
+        "#{key}[1][1]" => 22
+      }
+    end
+
+    it 'flattens the hash' do
+      expect(squashed).to eq(expected)
     end
   end
 end

data/spec/support/shared_examples/hash/keys_sorter.rb

@@ -10,6 +10,10 @@ shared_examples 'a class with a keys sort method' do
       it 'sorts keys as symbols' do
         expect(result).to eq(a: 2, b: 1)
       end
+
+      it 'sorts keys' do
+        expect(result.keys).to eq(%i[a b])
+      end
     end
 
     context 'when keys are strings' do
@@ -18,6 +22,10 @@ shared_examples 'a class with a keys sort method' do
       it 'sorts keys as string' do
         expect(result).to eq('a' => 2, 'b' => 1)
       end
+
+      it 'sorts keys' do
+        expect(result.keys).to eq(%w[a b])
+      end
     end
 
     context 'when there is a nested hash' do
@@ -27,6 +35,14 @@ shared_examples 'a class with a keys sort method' do
         it 'sorts keys recursively' do
           expect(result).to eq(a: { c: 4, d: 3 }, b: 1)
         end
+
+        it 'sorts keys' do
+          expect(result.keys).to eq(%i[a b])
+        end
+
+        it 'sorts inner keys' do
+          expect(result[:a].keys).to eq(%i[c d])
+        end
       end
 
       context 'when recursive option is given' do
@@ -35,6 +51,14 @@ shared_examples 'a class with a keys sort method' do
         it 'sorts keys recursively when argumen is passed' do
           expect(result).to eq(a: { c: 4, d: 3 }, b: 1)
         end
+
+        it 'sorts keys' do
+          expect(result.keys).to eq(%i[a b])
+        end
+
+        it 'sorts inner keys' do
+          expect(result[:a].keys).to eq(%i[c d])
+        end
       end
 
       context 'when no recursive option is given' do
@@ -43,24 +67,260 @@ shared_examples 'a class with a keys sort method' do
         it 'does not sorts keys recursively when argumen is passed' do
           expect(result).to eq(a: { d: 3, c: 4 }, b: 1)
         end
+
+        it 'sorts keys' do
+          expect(result.keys).to eq(%i[a b])
+        end
+
+        it 'does not sort inner keys' do
+          expect(result[:a].keys).to eq(%i[d c])
+        end
+
+        it 'does not change inner hash' do
+          expect { result }.not_to change(hash[:a], :keys)
+        end
       end
     end
 
     context 'when it is deep nestled' do
-      let(:hash) { { b: 1, a: { d: 2, c: { e: 3, f: 4 } } } }
+      let(:hash) { { b: 1, a: { d: 2, c: { f: 3, e: 4 } } } }
 
       it 'sort recursevely on many levels' do
-        expected = { a: { c: { f: 4, e: 3 }, d: 2 }, b: 1 }
-        expect(hash.sort_keys(recursive: true)).to eq(expected)
+        expected = { a: { c: { f: 3, e: 4 }, d: 2 }, b: 1 }
+        expect(result).to eq(expected)
+      end
+
+      it 'sorts keys' do
+        expect(result.keys).to eq(%i[a b])
+      end
+
+      it 'sorts inner keys' do
+        expect(result[:a].keys).to eq(%i[c d])
+      end
+
+      it 'sorts deeper inner keys' do
+        expect(result[:a][:c].keys).to eq(%i[e f])
       end
     end
 
     context 'when it has a nestled array' do
-      let(:hash) { { b: 1, a: { d: 2, c: [{ e: 3, f: 4 }] } } }
+      let(:hash) { { b: 1, a: { d: 2, c: [{ f: 3, e: 4 }] } } }
 
       it 'applies to arrays as well' do
-        expected = { a: { c: [{ f: 4, e: 3 }], d: 2 }, b: 1 }
-        expect(hash.sort_keys(recursive: true)).to eq(expected)
+        expected = { a: { c: [{ f: 3, e: 4 }], d: 2 }, b: 1 }
+        expect(result).to eq(expected)
+      end
+
+      it 'sorts keys' do
+        expect(result.keys).to eq(%i[a b])
+      end
+
+      it 'sorts inner keys' do
+        expect(result[:a].keys).to eq(%i[c d])
+      end
+
+      it 'does not sort array deeper inner keys' do
+        expect(result[:a][:c].map(&:keys)).to eq([%i[f e]])
+      end
+
+      it 'does not change array deeper inner hash' do
+        expect { result }.not_to(change { hash[:a][:c].map(&:keys) })
+      end
+    end
+  end
+end
+
+shared_examples 'a class with a keys sort method that changes original' do
+  describe '#sort_keys' do
+    let(:options) { {} }
+
+    context 'when keys are symbols' do
+      let(:hash) { { b: 1, a: 2 } }
+
+      it 'changes original hash' do
+        expect { result }.to change(hash, :keys)
+          .from(%i[b a]).to(%i[a b])
+      end
+    end
+
+    context 'when keys are strings' do
+      let(:hash) { { 'b' => 1, 'a' => 2 } }
+
+      it 'changes original hash' do
+        expect { result }.to change(hash, :keys)
+          .from(%w[b a]).to(%w[a b])
+      end
+    end
+
+    context 'when there is a nested hash' do
+      let(:hash) { { b: 1, a: { d: 3, c: 4 } } }
+
+      context 'when no option is given' do
+        it 'changes original hash' do
+          expect { result }.to change(hash, :keys)
+            .from(%i[b a]).to(%i[a b])
+        end
+
+        it 'changes inner hash' do
+          expect { result }.to change(hash[:a], :keys)
+            .from(%i[d c]).to(%i[c d])
+        end
+      end
+
+      context 'when recursive option is given' do
+        let(:options) { { recursive: true } }
+
+        it 'changes original hash' do
+          expect { result }.to change(hash, :keys)
+            .from(%i[b a]).to(%i[a b])
+        end
+
+        it 'changes inner hash' do
+          expect { result }.to change(hash[:a], :keys)
+            .from(%i[d c]).to(%i[c d])
+        end
+      end
+
+      context 'when no recursive option is given' do
+        let(:options) { { recursive: false } }
+
+        it 'changes original hash' do
+          expect { result }.to change(hash, :keys)
+            .from(%i[b a]).to(%i[a b])
+        end
+
+        it 'does not change inner hash' do
+          expect { result }.not_to change(hash[:a], :keys)
+        end
+      end
+    end
+
+    context 'when it is deep nestled' do
+      let(:hash) { { b: 1, a: { d: 2, c: { f: 3, e: 4 } } } }
+
+      it 'changes original hash' do
+        expect { result }.to change(hash, :keys)
+          .from(%i[b a]).to(%i[a b])
+      end
+
+      it 'changes inner hash' do
+        expect { result }.to change(hash[:a], :keys)
+          .from(%i[d c]).to(%i[c d])
+      end
+
+      it 'changes deeper inner hash' do
+        expect { result }.to change(hash[:a][:c], :keys)
+          .from(%i[f e]).to(%i[e f])
+      end
+    end
+
+    context 'when it has a nestled array' do
+      let(:hash) { { b: 1, a: { d: 2, c: [{ f: 3, e: 4 }] } } }
+
+      it 'changes original hash' do
+        expect { result }.to change(hash, :keys)
+          .from(%i[b a]).to(%i[a b])
+      end
+
+      it 'changes inner hash' do
+        expect { result }.to change(hash[:a], :keys)
+          .from(%i[d c]).to(%i[c d])
+      end
+
+      it 'does not change array deeper inner hash' do
+        expect { result }.not_to(change { hash[:a][:c].map(&:keys) })
+      end
+    end
+  end
+end
+
+shared_examples 'a class with a keys sort method that not change self' do
+  describe '#sort_keys' do
+    let(:options) { {} }
+
+    context 'when keys are symbols' do
+      let(:hash) { { b: 1, a: 2 } }
+
+      it 'changes original hash' do
+        expect { result }.not_to change(hash, :keys)
+      end
+    end
+
+    context 'when keys are strings' do
+      let(:hash) { { 'b' => 1, 'a' => 2 } }
+
+      it 'changes original hash' do
+        expect { result }.not_to change(hash, :keys)
+      end
+    end
+
+    context 'when there is a nested hash' do
+      let(:hash) { { b: 1, a: { d: 3, c: 4 } } }
+
+      context 'when no option is given' do
+        it 'changes original hash' do
+          expect { result }.not_to change(hash, :keys)
+        end
+
+        it 'changes inner hash' do
+          expect { result }.not_to change(hash[:a], :keys)
+        end
+      end
+
+      context 'when recursive option is given' do
+        let(:options) { { recursive: true } }
+
+        it 'changes original hash' do
+          expect { result }.not_to change(hash, :keys)
+        end
+
+        it 'changes inner hash' do
+          expect { result }.not_to change(hash[:a], :keys)
+        end
+      end
+
+      context 'when no recursive option is given' do
+        let(:options) { { recursive: false } }
+
+        it 'changes original hash' do
+          expect { result }.not_to change(hash, :keys)
+        end
+
+        it 'does not change inner hash' do
+          expect { result }.not_to change(hash[:a], :keys)
+        end
+      end
+    end
+
+    context 'when it is deep nestled' do
+      let(:hash) { { b: 1, a: { d: 2, c: { f: 3, e: 4 } } } }
+
+      it 'changes original hash' do
+        expect { result }.not_to change(hash, :keys)
+      end
+
+      it 'changes inner hash' do
+        expect { result }.not_to change(hash[:a], :keys)
+      end
+
+      it 'changes deeper inner hash' do
+        expect { result }.not_to change(hash[:a][:c], :keys)
+      end
+    end
+
+    context 'when it has a nestled array' do
+      let(:hash) { { b: 1, a: { d: 2, c: [{ f: 3, e: 4 }] } } }
+
+      it 'changes original hash' do
+        expect { result }.not_to change(hash, :keys)
+      end
+
+      it 'changes inner hash' do
+        expect { result }.not_to change(hash[:a], :keys)
+      end
+
+      it 'does not change array deeper inner hash' do
+        expect { result }.not_to(change { hash[:a][:c].map(&:keys) })
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: darthjee-core_ext
 version: !ruby/object:Gem::Version
-  version: 1.7.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-01 00:00:00.000000000 Z
+date: 2019-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.x
+        version: 1.17.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.x
+        version: 1.17.3
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.30.0
+- !ruby/object:Gem::Dependency
+  name: rubycritic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -159,10 +173,12 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".gitignore"
+- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ARRAY_README.md
+- CLASS_README.md
 - DATE_README.md
 - Dockerfile
 - ENUMERABLE_README.md
@@ -174,6 +190,7 @@ files:
 - README.md
 - Rakefile
 - SYMBOL_README.md
+- config/rubycritc.rb
 - config/yardstick.rb
 - config/yardstick.yml
 - core_ext.gemspec
@@ -188,12 +205,13 @@ files:
 - lib/darthjee/core_ext/hash.rb
 - lib/darthjee/core_ext/hash/cameliazable.rb
 - lib/darthjee/core_ext/hash/chain_fetcher.rb
+- lib/darthjee/core_ext/hash/changeable.rb
 - lib/darthjee/core_ext/hash/deep_hash_constructor.rb
+- lib/darthjee/core_ext/hash/deep_hash_constructor/setter.rb
 - lib/darthjee/core_ext/hash/key_changeable.rb
 - lib/darthjee/core_ext/hash/key_changer.rb
 - lib/darthjee/core_ext/hash/keys_sorter.rb
 - lib/darthjee/core_ext/hash/squasher.rb
-- lib/darthjee/core_ext/hash/to_hash_mapper.rb
 - lib/darthjee/core_ext/hash/transformable.rb
 - lib/darthjee/core_ext/hash/transposeable.rb
 - lib/darthjee/core_ext/hash/value_changer.rb
@@ -204,6 +222,16 @@ files:
 - lib/darthjee/core_ext/time.rb
 - lib/darthjee/core_ext/version.rb
 - mech.jpg
+- scripts/check_readme.sh
+- scripts/rubycritic.sh
+- spec/integration/readme/array_spec.rb
+- spec/integration/readme/class_spec.rb
+- spec/integration/readme/date_spec.rb
+- spec/integration/readme/enumerable_spec.rb
+- spec/integration/readme/hash_spec.rb
+- spec/integration/readme/math_spec.rb
+- spec/integration/readme/object_spec.rb
+- spec/integration/readme/symbol_spec.rb
 - spec/integration/yard/darthjee/core_ext/array/hash_builder_spec.rb
 - spec/integration/yard/darthjee/core_ext/array_spec.rb
 - spec/integration/yard/darthjee/core_ext/class/default_value_spec.rb
@@ -211,18 +239,29 @@ files:
 - spec/integration/yard/darthjee/core_ext/enumerable_spec.rb
 - spec/integration/yard/darthjee/core_ext/hash/cameliazable_spec.rb
 - spec/integration/yard/darthjee/core_ext/hash/chain_fetcher_spec.rb
+- spec/integration/yard/darthjee/core_ext/hash/changeable_spec.rb
+- spec/integration/yard/darthjee/core_ext/hash/deep_hash_constructor/setter_spec.rb
+- spec/integration/yard/darthjee/core_ext/hash/deep_hash_constructor_spec.rb
 - spec/integration/yard/darthjee/core_ext/hash/key_changeable_spec.rb
+- spec/integration/yard/darthjee/core_ext/hash/key_changer_spec.rb
+- spec/integration/yard/darthjee/core_ext/hash/keys_sorter_spec.rb
+- spec/integration/yard/darthjee/core_ext/hash/squasher_spec.rb
 - spec/integration/yard/darthjee/core_ext/hash/transformable_spec.rb
+- spec/integration/yard/darthjee/core_ext/hash/transposeable_spec.rb
 - spec/integration/yard/darthjee/core_ext/hash/value_changer_spec.rb
 - spec/integration/yard/darthjee/core_ext/hash_spec.rb
+- spec/integration/yard/darthjee/core_ext/math_spec.rb
+- spec/integration/yard/darthjee/core_ext/numeric_spec.rb
+- spec/integration/yard/darthjee/core_ext/object_spec.rb
+- spec/integration/yard/darthjee/core_ext/symbol_spec.rb
 - spec/lib/array_spec.rb
 - spec/lib/class_spec.rb
 - spec/lib/darthjee/core_ext/hash/chain_fetcher_spec.rb
+- spec/lib/darthjee/core_ext/hash/deep_hash_constructor/setter_spec.rb
 - spec/lib/darthjee/core_ext/hash/deep_hash_constructor_spec.rb
 - spec/lib/darthjee/core_ext/hash/key_changer_spec.rb
 - spec/lib/darthjee/core_ext/hash/keys_sorter_spec.rb
 - spec/lib/darthjee/core_ext/hash/squasher_spec.rb
-- spec/lib/darthjee/core_ext/hash/to_hash_mapper_spec.rb
 - spec/lib/darthjee/core_ext/hash/value_changer_spec.rb
 - spec/lib/date_spec.rb
 - spec/lib/enumerable_spec.rb
@@ -233,6 +272,7 @@ files:
 - spec/lib/symbol_spec.rb
 - spec/lib/time_spec.rb
 - spec/spec_helper.rb
+- spec/support/models/client.rb
 - spec/support/models/default_reader_model.rb
 - spec/support/models/default_value_model.rb
 - spec/support/models/dummy_iterator.rb
@@ -245,6 +285,7 @@ files:
 - spec/support/shared_examples/expected.rb
 - spec/support/shared_examples/hash/chain_fetch.rb
 - spec/support/shared_examples/hash/chain_hash_keys_changer.rb
+- spec/support/shared_examples/hash/deep_hash.rb
 - spec/support/shared_examples/hash/hash_keys_changer.rb
 - spec/support/shared_examples/hash/hash_squasher.rb
 - spec/support/shared_examples/hash/hash_transpose.rb
@@ -266,7 +307,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -279,6 +320,14 @@ signing_key:
 specification_version: 4
 summary: Core Extensions
 test_files:
+- spec/integration/readme/array_spec.rb
+- spec/integration/readme/class_spec.rb
+- spec/integration/readme/date_spec.rb
+- spec/integration/readme/enumerable_spec.rb
+- spec/integration/readme/hash_spec.rb
+- spec/integration/readme/math_spec.rb
+- spec/integration/readme/object_spec.rb
+- spec/integration/readme/symbol_spec.rb
 - spec/integration/yard/darthjee/core_ext/array/hash_builder_spec.rb
 - spec/integration/yard/darthjee/core_ext/array_spec.rb
 - spec/integration/yard/darthjee/core_ext/class/default_value_spec.rb
@@ -286,18 +335,29 @@ test_files:
 - spec/integration/yard/darthjee/core_ext/enumerable_spec.rb
 - spec/integration/yard/darthjee/core_ext/hash/cameliazable_spec.rb
 - spec/integration/yard/darthjee/core_ext/hash/chain_fetcher_spec.rb
+- spec/integration/yard/darthjee/core_ext/hash/changeable_spec.rb
+- spec/integration/yard/darthjee/core_ext/hash/deep_hash_constructor/setter_spec.rb
+- spec/integration/yard/darthjee/core_ext/hash/deep_hash_constructor_spec.rb
 - spec/integration/yard/darthjee/core_ext/hash/key_changeable_spec.rb
+- spec/integration/yard/darthjee/core_ext/hash/key_changer_spec.rb
+- spec/integration/yard/darthjee/core_ext/hash/keys_sorter_spec.rb
+- spec/integration/yard/darthjee/core_ext/hash/squasher_spec.rb
 - spec/integration/yard/darthjee/core_ext/hash/transformable_spec.rb
+- spec/integration/yard/darthjee/core_ext/hash/transposeable_spec.rb
 - spec/integration/yard/darthjee/core_ext/hash/value_changer_spec.rb
 - spec/integration/yard/darthjee/core_ext/hash_spec.rb
+- spec/integration/yard/darthjee/core_ext/math_spec.rb
+- spec/integration/yard/darthjee/core_ext/numeric_spec.rb
+- spec/integration/yard/darthjee/core_ext/object_spec.rb
+- spec/integration/yard/darthjee/core_ext/symbol_spec.rb
 - spec/lib/array_spec.rb
 - spec/lib/class_spec.rb
 - spec/lib/darthjee/core_ext/hash/chain_fetcher_spec.rb
+- spec/lib/darthjee/core_ext/hash/deep_hash_constructor/setter_spec.rb
 - spec/lib/darthjee/core_ext/hash/deep_hash_constructor_spec.rb
 - spec/lib/darthjee/core_ext/hash/key_changer_spec.rb
 - spec/lib/darthjee/core_ext/hash/keys_sorter_spec.rb
 - spec/lib/darthjee/core_ext/hash/squasher_spec.rb
-- spec/lib/darthjee/core_ext/hash/to_hash_mapper_spec.rb
 - spec/lib/darthjee/core_ext/hash/value_changer_spec.rb
 - spec/lib/date_spec.rb
 - spec/lib/enumerable_spec.rb
@@ -308,6 +368,7 @@ test_files:
 - spec/lib/symbol_spec.rb
 - spec/lib/time_spec.rb
 - spec/spec_helper.rb
+- spec/support/models/client.rb
 - spec/support/models/default_reader_model.rb
 - spec/support/models/default_value_model.rb
 - spec/support/models/dummy_iterator.rb
@@ -320,6 +381,7 @@ test_files:
 - spec/support/shared_examples/expected.rb
 - spec/support/shared_examples/hash/chain_fetch.rb
 - spec/support/shared_examples/hash/chain_hash_keys_changer.rb
+- spec/support/shared_examples/hash/deep_hash.rb
 - spec/support/shared_examples/hash/hash_keys_changer.rb
 - spec/support/shared_examples/hash/hash_squasher.rb
 - spec/support/shared_examples/hash/hash_transpose.rb