hash_flatten 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73bc14c6b41e2943e5c7a9e244db24681324a060
-  data.tar.gz: 7c89f6bc9f49d95098fa37ef0bf88e15fb54a600
+  metadata.gz: 83fff9dffa4f78c3437e291b31519ff7035a2665
+  data.tar.gz: 01c61a4e9a3c2877c9593064bb55ecf616bbc415
 SHA512:
-  metadata.gz: 1a7e487f9d2467a51c247c88f040b4099f613f55ce1df312329bb2b02a81665c283d3a3bbfc3ef2693fc0f29c3ac145518086fa5febd70d1aea5b458548cc3cb
-  data.tar.gz: 3c750e9ecdb551ad7e5c0a4f2981446722be93960b9b937c817bbb38cea970811babbbb875d745cd915ee3538ce8aa9dd64cdc9c1ed9b547f2f98319afca8abb
+  metadata.gz: e607f013258e812f6106a008d0fe5075ac66dd862b35dd3bbfb1151b8c2a930cfcba3dec2970cc2a6c48e4200fa30504667ce7399c61dce0d65c87dd2964d9ea
+  data.tar.gz: 64b47cfbcef60c76936051c5ae8afb2eb15778fb7f9317851e2a57ab26dab44603235f94fea6edd7b0a0c7229bcefe02b7952bba3854990aab5993342f495a72

data/.travis.yml

@@ -1,5 +1,4 @@
-sudo: false
 language: ruby
 rvm:
   - 2.3.1
-before_install: gem install bundler -v 1.15.4
+  - 2.5

data/Gemfile

@@ -1,6 +1,4 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hash_flatten.gemspec
 gemspec

data/README.md

@@ -1,32 +1,24 @@
-# HashFlatten
+# HashFlatten [![Build Status](https://travis-ci.org/Masa331/hash_flatten.svg?branch=master)](https://travis-ci.org/Masa331/hash_flatten)
 
-Two methods i sometimes miss on Hash.
+Flatten nested Hash to one level depth with keys joined with a dot and vice versa.
 
-## `#destructure`
+Content:
+1. [About](#about)
+2. [How to](#how-to)
+    1. [Installation](#installation)
+    2. [Usage](#usage)
+    3. [squish_levels](#squish_levels)
+    4. [stretch_to_levels](#stretch_to_levels)
+    5. [Notes](#notes)
+3. [License](#license)
 
-hash = { a: 'a',
-         b: { a: 'b' },
-         c: { b: { a: 'c' } } }
-
-hash.destructure =>
-
-  { 'a' => 'a',
-    'b.a' => 'b',
-    'c.b.a' => 'c' }
-
-## `#structure`
-
-hash = { 'a' => 'a',
-         'b.a' => 'b',
-         'c.b.a' => 'c' }
+## About
 
-hash.structure =>
+This gem includes Refinement which adds `#squish_levels` and `#stretch_to_levels` to Hash. With them you can transform this hash: `{ a: { b: 'b', c: 'c' } }` to this: `{ 'a.b' => 'b', 'a.c' => 'c' }` and vice versa. I use these to transform Rails locales to somehow readable csv for external translators or showing XML structure(transformed to a hash) in a table.
 
-{ 'a' => 'a',
-  'b' => { 'a' => 'b' },
-  'c' => { 'b' => { 'a' => 'c' } } }
+## How to
 
-## Installation
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -42,17 +34,52 @@ Or install it yourself as:
 
     $ gem install hash_flatten
 
-## Usage
+### Usage
 
-Use as refinement:
+Use as a Refinement:
 ```
 class MyClass
   using HashFlatten
 end
 ```
-now you can call `#destructure` od `#structure` on hashes in `MyClass`.
+now you can call `#squish_levels` and `#stretch_to_levels` on hashes in `MyClass`(lexically).
+
+Here is an excellent blog post on Refinements if you didn't use them before: http://interblah.net/why-is-nobody-using-refinements
+
+### `#squish_levels`
+
+```ruby
+hash = { a: 'a',
+         b: { a: 'b' },
+         c: { b: { a: 'c' } } }
+
+hash.squish_levels =>
+
+  { 'a' => 'a',
+    'b.a' => 'b',
+    'c.b.a' => 'c' }
+```
+
+### `#stretch_to_levels`
+
+```ruby
+hash = { 'a' => 'a',
+         'b.a' => 'b',
+         'c.b.a' => 'c' }
+
+hash.stretch_to_levels =>
+
+{ 'a' => 'a',
+  'b' => { 'a' => 'b' },
+  'c' => { 'b' => { 'a' => 'c' } } }
+```
+
+### Notes
+
+Some things to know:
 
-Here is an excellent blog post on refinements if you didn't use them before: http://interblah.net/why-is-nobody-using-refinements
+* whenever you call `#squish_levels` or `#stretch_to_levels` returned hash has keys transformed to strings
+* squishes or stretches only sub Hashes, other hash-like structure aren't touched(`#to_h` isn't called on values..)
 
 ## License
 

data/hash_flatten.gemspec

@@ -4,19 +4,18 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'hash_flatten'
-  spec.version       = '0.3.0'
+  spec.version       = '1.0.0'
   spec.authors       = ['Premysl Donat']
   spec.email         = ['pdonat@seznam.cz']
 
-  spec.summary       = 'Two method i miss in std lib'
-  spec.description   = spec.summary
+  spec.summary       = 'Flatten nested Hash to one level depth with keys joined with a dot.'
+  spec.description   = 'A refinement which includes a method for flattening nested Hash to one level depth with keys joined with a dot. Also includes a method for reverse operation.'
   spec.homepage      = 'https://github.com/Masa331/hash_flatten'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler'

data/lib/hash_flatten.rb

@@ -1,48 +1,29 @@
 module HashFlatten
   refine Hash do
-    def destructure
-      flattened = each_with_object({}) do |(k, v), n|
-        if v.is_a? Hash
-          v.each do |k2, v2|
-            n["#{k}.#{k2}"] = v2
-          end
+    def squish_levels
+      each_with_object({}) do |(key, value), squished|
+        if value.is_a? Hash
+          value.squish_levels.each { |sub_key, sub_value| squished.store("#{key}.#{sub_key}", sub_value) }
         else
-          n[k.to_s] = v
+          squished.store(key.to_s, value)
         end
       end
-
-      if flattened.any? { |_, v| v.is_a? Hash }
-        flattened.destructure
-      else
-        flattened
-      end
     end
 
-    def structure
-      new_hash = decompose_keys
+    def stretch_to_levels
+      each_with_object({}) do |(key, value), stretched|
+        key_parts = key.to_s.split('.')
 
-      new_hash.each do |k, v|
-        if v.is_a? Hash
-          new_value = v.structure
+        if key_parts.size > 1
+          level_key = key_parts.shift
+          tail = key_parts.join('.')
 
-          new_hash[k] = new_value
-        end
-      end
-    end
-
-    def decompose_keys
-      each_with_object({}) do |(k, v), new_hash|
-        key_parts = k.split('.')
-        top_level_key = key_parts.shift
-        tail = key_parts.join('.')
+          existing_content = stretched.fetch(level_key, {})
+          new_content = existing_content.merge({ tail => value }).stretch_to_levels
 
-        if tail.empty?
-          new_hash[top_level_key] = v
+          stretched.store(level_key, new_content)
         else
-          existing_value = new_hash.fetch(top_level_key, {})
-          new_value = existing_value.merge({ tail => v })
-
-          new_hash[top_level_key] = new_value
+          stretched.store(key.to_s, value)
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_flatten
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Premysl Donat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-08 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Two method i miss in std lib
+description: A refinement which includes a method for flattening nested Hash to one
+  level depth with keys joined with a dot. Also includes a method for reverse operation.
 email:
 - pdonat@seznam.cz
 executables: []
@@ -107,5 +108,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Two method i miss in std lib
+summary: Flatten nested Hash to one level depth with keys joined with a dot.
 test_files: []