iteraptor 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7333782eaae52f82638bd82f741a1ac2cdec49af
-  data.tar.gz: 1fc1b09cee6edfd7f350d049a4a9d13905d649fc
+  metadata.gz: 0e8cc46b604659e350fd66dd26157c0a0810373c
+  data.tar.gz: 10105442b0e2c0a807e55ff1decf52fbef0d5772
 SHA512:
-  metadata.gz: 2b37702ea08e4b0a9a63ad35670c50411c223f1db8425d63cebaee6dc09d9a631e11a0ec08b138fee87ceff1cbfefd981829fd5e770db7a439db6954237ab44b
-  data.tar.gz: fb4662a8024047f6269fd4fbc921fad75b289ce32f54061bebbd4409341b05933db16e32fba6dfe5f1079ab0c60dc675f5119d5dfc38304f89e35185e764f82c
+  metadata.gz: ff5aade1285567f7bf58d422316db68b3e42627c828c13ad54d6c1f533d7542b3c15ca666b8a0b33ff175e6f83363c17ad591c4b7351f031808019938c8e348f
+  data.tar.gz: bd271aae4e66a0528f0efb9eba9b5e2bd0cc87082ffee878e5a134fc5bf57358f498cb968c9fce0d81dca90a0cc384f877d0252c97b0c191825cdebde7024502

data/.codeclimate.yml

@@ -2,6 +2,9 @@
 engines:
   duplication:
     enabled: true
+    checks:
+      Similar code:
+        enabled: false
     config:
       languages:
       - ruby

data/.travis.yml

@@ -1,7 +1,10 @@
 language: ruby
 rvm:
   - 2.1.8
-  - 2.2.0
+  - 2.2.3
+  - 2.3.2
+  - 2.4.1
+  - 2.5.0
 before_install: gem install bundler -v 1.11.2
 addons:
   code_climate:

data/Gemfile

@@ -2,4 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in iteraptor.gemspec
 gemspec
-gem 'codeclimate-test-reporter', group: :test, require: nil
+gem 'simplecov', require: false, group: :test
+# gem 'codeclimate-test-reporter', group: :test, require: nil

data/README.md

@@ -10,27 +10,10 @@ This small mixin allows the deep iteration / mapping of `Enumerable`s instances.
 Adopted to be used with hashes/arrays. It **is not** intended to be used with
 large objects.
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'iteraptor'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install iteraptor
-
 ## Usage
 
 ```ruby
 require 'iteraptor'
-require 'iteraptor/greedy' # to patch Array and Hash
 ```
 
 `Iteraptor` is intended to be used for iteration of complex nested structures.
@@ -42,6 +25,22 @@ Nested `Enumerable`s are called with a compound key, represented as a “breadcr
 which is a path to current key, joined with `Iteraptor::DELIMITER` constant. The
 latter is just a dot in current release.
 
+## Features
+
+* `cada` (_sp._ `each`) iterates through all the levels of the nested `Enumerable`,
+yielding `parent, element` tuple; parent is returned as a delimiter-joined string
+* `mapa` (_sp._ `map`) iterates all the elements, yielding `parent, (key, value)`;
+the mapper should return either `[key, value]` array or `nil` to remove this
+element;
+  * _NB_ this method always maps to `Hash`, to map to `Array` use `plana_mapa`
+  * _NB_ this method will raise if the returned value is neither `[key, value]` tuple nor `nil`
+* `plana_mapa` iterates yielding `key, value`, maps to the yielded value,
+whatever it is; `nil`s are not treated in some special way
+* `aplanar` (_sp._ `flatten`) the analogue of `Array#flatten`, but flattens
+the deep enumerable into `Hash` instance
+* `segar` (_sp._ `yield`), alias `escoger` (_sp._ `select`) allows to filter
+and collect elelements.
+
 ### Iteration
 
 `Iteraptor#cada` iterates all the `Enumerable` elements, recursively. As it meets
@@ -97,7 +96,9 @@ iterated as `Enumerable`s.
 In the example below we yield all keys, that matches the regexp given as parameter.
 
 ```ruby
-▶ hash.segar(/[abc]/) { |parent, elem| puts "Parent: #{parent.inspect}, Element: #{elem.inspect}" }
+▶ hash.segar(/[abc]/) do |parent, elem|
+▷   puts "Parent: #{parent.inspect}, Element: #{elem.inspect}"
+▷ end
 # Parent: "a", Element: true
 # Parent: "b", Element: {:c=>"", :d=>42}
 # Parent: "b.c", Element: ""
@@ -115,6 +116,35 @@ In the example below we yield all keys, that matches the regexp given as paramet
 #⇒ {:a=>true, :b=>{:c=>"N/A", :d=>42}, :e=>"N/A"}
 ```
 
+#### Flatten the deeply nested hash:
+
+```ruby
+▶ hash = {a: true, b: {c: '', d: 42}, e: ''}
+#⇒ {:a=>true, :b=>{:c=>"", :d=>42}, :e=>""}
+▶ hash.aplanar(delimiter: '_', symbolize_keys: true)
+#⇒ {:a=>true, :b_c=>"", :b_d=>42, :e=>""}
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'iteraptor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iteraptor
+
+## Changelog
+
+#### 0.4.0 `aplanar` and `plana_mapa`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/iteraptor.rb

@@ -7,7 +7,7 @@ module Iteraptor
     raise "This module might be included into Enumerables only" unless base.ancestors.include? Enumerable
   end
 
-  %i(cada mapa).each do |m|
+  %i[cada mapa].each do |m|
     define_method m do |root = nil, parent = nil, &λ|
       return enum_for(m, root, parent) unless λ
       send_to = [Hash, Array, Enumerable].detect(&method(:is_a?))
@@ -15,6 +15,7 @@ module Iteraptor
     end
   end
 
+  # rubocop:disable Style/MultilineIfModifier
   # rubocop:disable Metrics/CyclomaticComplexity
   # rubocop:disable Metrics/MethodLength
   def segar filter
@@ -33,8 +34,31 @@ module Iteraptor
       end
     end
   end
+
+  def aplanar delimiter: DELIMITER, symbolize_keys: false
+    cada.with_object({}) do |(parent, element), acc|
+      key = parent.tr(DELIMITER, delimiter)
+      key = key.to_sym if symbolize_keys
+      acc[key] = element unless element.is_a?(Enumerable)
+      yield key, element if block_given?
+    end
+  end
+
+  def plana_mapa delimiter: DELIMITER, symbolize_keys: false
+    return enum_for(
+      :plana_mapa, delimiter: delimiter, symbolize_keys: symbolize_keys
+    ) unless block_given?
+
+    cada.with_object([]) do |(parent, element), acc|
+      key = parent.tr(DELIMITER, delimiter)
+      key = key.to_sym if symbolize_keys
+      acc << yield(key, element) unless element.is_a?(Enumerable)
+    end
+  end
+
   # rubocop:enable Metrics/MethodLength
   # rubocop:enable Metrics/CyclomaticComplexity
+  # rubocop:enable Style/MultilineIfModifier
 
   private
 
@@ -70,7 +94,7 @@ module Iteraptor
 
   ##############################################################################
   ### mapa
-  def mapa_in_array root = nil, parent = nil
+  def mapa_in_array root = nil, parent = nil, with_index: false
     λ = Proc.new
 
     map.with_index do |e, idx|
@@ -79,7 +103,7 @@ module Iteraptor
       case e
       when Iteraptor then e.mapa(root, p, &λ)
       when Enumerable then e.map(&λ.curry[p])
-      else yield p, e
+      else yield p, (with_index ? [idx.to_s, e] : e)
       end
     end
   end

data/lib/iteraptor/version.rb

@@ -1,3 +1,3 @@
 module Iteraptor
-  VERSION = '0.3.5'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iteraptor
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Aleksei Matiushkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-22 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler