flattenator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7dbb3d8989a54d268ebf7b3a0a5bde6b93a8c13dca8a43bc5b710dc506690f2
-  data.tar.gz: dd57d11d80449c646741ac4c11beb80ce289d967b845ee692595ac191e2eb361
+  metadata.gz: 3b92cd0d6ef19e1f44533d54ad8a681903cba243a137ba11c5cb860c9abcf2f1
+  data.tar.gz: 81dc044b46d5b9509e2221e4bcd8ed8ab1eff15a2a187bbbf951590dda048801
 SHA512:
-  metadata.gz: 065f92ab7f72cf509742a2e6760169b93a7d06133f7cda6a47e1aa3d3079e581f721e8abaf013384cbfede9d89f41838e4f075dfc926989da7b306edb1d39bbe
-  data.tar.gz: 4d25b5c9f671780d63cde1f5cd3fcd68118cd3dc71bfa6ff07fee55e0c2ff08a8df0b10b0528c387065452901a51f40c7fffa63146e42a11220a23655c61b302
+  metadata.gz: 7192f5c026ee85154cb5c7ac7254a9519f91a79395f6ac65d8a26f1b11401e4afebe61431db5f513eae8a5722c389930068bd15142fe3091e025d08b7e52eb62
+  data.tar.gz: f062533cc3e3e351418116aedeb63003eceee5cbef1cb4e4e9f116135a3acc93c032009ee5a4146344c321d448dd5e8e1a71410d4aef88d5f2ea0d0ee1fbe86e

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# v0.1.1
+
+* Fix that `Flattenator::Hash` wasn't available by default when adding the gem to your project.
+
 # v0.1.0
 
-Initial commit
+* Initial commit

data/README.markdown

@@ -14,10 +14,10 @@ Converts a deeply nested hash with a flattened hash, prefixing the keys for chil
 }
 # end with this
 {
-  foo: "bar",
-  baz_apple: 2,
-  baz_banana: 5,
-  baz_carrot: 0,
+  "foo" => "bar",
+  "baz_apple" => 2,
+  "baz_banana" => 5,
+  "baz_carrot" => 0,
 }
 ```
 
@@ -40,7 +40,61 @@ Or install it yourself as:
 ## Usage
 
 ```
-Flattenator.new(hash).flattened
+Flattenator::Hash.new(hash).flattened
+```
+
+By default, a JSON-encoded version of the object being flattened will be included in the flattened hash, but this can be turned off.
+
+```ruby
+original = {
+  foo: "bar",
+  options: {
+    jiggle_handle: true,
+    tighten_valve: false,
+  },
+}
+
+Flattenator::Hash.new(original).flattened
+{
+  "foo" => "bar",
+  "options" => "{\"jiggle_handle\":true,\"tighten_valve\":false}"
+  "options_jiggle_handle" => true,
+  "options_tighten_valve" => false,
+}
+
+Flattenator::Hash.new(original, include_unflattened: false).flattened
+{
+  "foo" => "bar",
+  "options_jiggle_handle" => true,
+  "options_tighten_valve" => false,
+}
+```
+
+Additionally, arrays are flattened into the form `{key}_{index}`, like so:
+
+```ruby
+original = {
+  fruits: [
+    "apple",
+    "banana",
+    "citrus",
+  ],
+  vegetables: [
+    "daikon",
+    "eggplant",
+  ],
+}
+
+Flattenator::Hash.new(original).flattened
+{
+  "fruits" => "[\"apple\",\"banana\",\"citrus\"]",
+  "fruits_0" => "apple",
+  "fruits_1" => "banana",
+  "fruits_2" => "citrus",
+  "vegetables" => "[\"daikon\",\"eggplant\"]",
+  "vegetables_0" => "daikon",
+  "vegetables_1" => "eggplant",
+}
 ```
 
 ## Development

data/lib/flattenator.rb

@@ -1,6 +1,6 @@
+require "flattenator/hash"
 require "flattenator/version"
 
 module Flattenator
-  class Error < StandardError; end
-  # Your code goes here...
+  Error = Class.new(StandardError)
 end

data/lib/flattenator/hash.rb

@@ -0,0 +1,43 @@
+require "json"
+
+class Flattenator::Hash
+  attr_reader *%i(
+    flattened
+    source
+  )
+
+  def initialize(source, include_unflattened: true)
+    raise ArgumentError.new("Source object does not respond to each_pair") unless source.respond_to?(:each_pair)
+
+    @source = source
+    @flattened = {}
+    @include_unflattened = !!include_unflattened
+
+    source.each_pair do |key, value|
+      flatten(key: key, value: value, destination: @flattened)
+    end
+  end
+
+  def include_unflattened?
+    @include_unflattened
+  end
+
+  private def flatten(key:, value:, destination:, prefix: nil)
+    fullkey = [prefix, key].compact.join("_").tr("-", "_")
+
+    case value
+    when Hash
+      destination[fullkey] = JSON.dump(value) if include_unflattened?
+      value.each do |k, v|
+        flatten(key: k, value: v, destination: destination, prefix: fullkey)
+      end
+    when Array
+      destination[fullkey] = JSON.dump(value) if include_unflattened?
+      value.each_with_index do |item, i|
+        destination["#{fullkey}_#{i}"] = item
+      end
+    else
+      destination[fullkey] = value
+    end
+  end
+end

data/lib/flattenator/version.rb

@@ -1,3 +1,3 @@
 module Flattenator
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flattenator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Patrick Byrne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-25 00:00:00.000000000 Z
+date: 2020-02-26 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -19,7 +19,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".semaphore/semaphore.yml"
-- ".travis.yml"
 - CHANGELOG.markdown
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -30,6 +29,7 @@ files:
 - bin/setup
 - flattenator.gemspec
 - lib/flattenator.rb
+- lib/flattenator/hash.rb
 - lib/flattenator/version.rb
 homepage: https://github.com/pbyrne/flattenator
 licenses:

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.5
-before_install: gem install bundler -v 2.1.4