nested_array 2.0.4 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 615dfa5d6f5e62fb074c1582e8f7b89d825d39e5240a0fca57fe6d87d59e893e
-  data.tar.gz: 108c8eeae031fa0c6340455534132df7238f98c027dc12c3ce811eb20134a210
+  metadata.gz: 9e82939abe3e113f9ce8e54713fd52221362f5e68f5e510ec00153e5504c7198
+  data.tar.gz: 7a854bb61bbb605396b154246b71f2c4e482c1356b37f1f6cb9c2bc4bda6e7f4
 SHA512:
-  metadata.gz: a211a97ca7211c64aafe1eace4649ec6c35fdff531897a68696da3ac42f5cd2f022d755e1b535d46313de9c444e7840ca0d78ca87770be9ac1a46f51ccdaf785
-  data.tar.gz: 66ec5538a88d030de339df95637be069a2fc78c7c2b0ba46b72c4462cfbe465da9f58e1b3327a2f8f63d8eff419d3569a2fc6fb8fcc2d4f4d8868e227ae37fc0
+  metadata.gz: 1dc59a5a4ae0393bc3f3ab1156273e5490b2ac9a3495595d9ff23a0d9d3dfd79f215f7762f7a361ab0c0827f4a7bbcd606b105dec23c2b22ec3d92e3faf7f2ac
+  data.tar.gz: a0a0b98e8f8a3c440a8d8c56f1744352b0f94fbc626cb2380fe0b382fbbae2f52cd84ea05812fa2f03b1bda0402e9f7b6c9fc4139c58030c28307c21b55bb855

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 *.gem
+.byebug_history

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nested_array (2.0.3)
+    nested_array (2.2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -49,4 +49,4 @@ DEPENDENCIES
   rspec (~> 3.9)
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/README-ru.md

@@ -1,6 +1,8 @@
 # NestedArray
 
-Предназначен для преобразования в древовидную структуру плоских данных описанных по паттерну «Список смежности» (Adjacency List), то есть в нодах указа предок `parent_id`. Например:
+Предназначен для преобразования в древовидную структуру плоских данных описанных
+по паттерну «Список смежности» (Adjacency List), то есть в нодах указа предок
+`parent_id`. Например:
 
 ```ruby
 [
@@ -18,99 +20,217 @@
 ```
 
 
+
+
 ## Установка
 
 Добавте строку в _Gemfile_ вашего приложения:
 
 ```ruby
-gem 'nested_array', '~> 2.0.0'
+# Версия не расширяет базовый класс Array методами гема. Для использования необходимо преобразовать данные к новому типу, см ниже.
+
+# Работа с древовидными массивами.
+gem 'nested_array', '~> 1.0.0'
+
+# Версия с автоматическим расширением базового класса Array методами гема.
+
+# Работа с древовидными массивами.
+gem "nested_array", "~> 2.0.0"
 ```
 
-И затем выполните `bundle`.
+И затем выполните `bundle install`.
 
 Или установите его как `gem install nested_array`
 
 
+
+
 ## Использование
 
-```html
-  <ul>
-    <%= Catalogs.all.to_a.to_nested.nested_to_html do |node| %>
-      <% link_to "#{node['name']}", catalog_view_path(node['slug']) %>
-    <% end %>
-  </ul>
+<a name="methods"></a>
+__Список методов__
+
+* [to_nested](#to_nested) — преобразует плоскую структуру во вложенную;
+* [each_nested](#each_nested) — перебирает вложенную стуктуру;
+* [each_nested!](#each_nested) — перебирает вложенную стуктуру, предоставляя доступ к исходным данным;
+* [nested_to_html](#nested_to_html) — преобразует вложенную структуру в html вёрстку (многоуровневый список `<ul><li>…`);
+* [nested_to_options](#nested_to_options) — преобразует вложенную структуру в массив для формирования опций html-тега `<select>` с псевдографикой;
+* [concat_nested](#concat_nested) — скеивание вложенных структур, ноды склеиваются если путь к ним одинаков.
+
+
+
+
+<a name="to_nested"></a>
+### to_nested [↑](#methods "К методам")
+
+Преобразует плоскую структуру во вложенную.
+
+```ruby
+a = [{'id' => 1, 'parent_id' => nil}]
+a = NestedArray::Array.new a
+b = a.to_nested
 ```
 
-__Опции `to_nested`__
+__Опции__
 
-`Catalogs.all.to_a.to_nested(options)`
+У каждой ноды вложенной структуры есть базовые свойства, такие как
+идентификатор, идентификатор предка и другие. Для доступа к этим данным
+используются ключи, которые можно настроить как в примере ниже. По умолчанию
+используются следующие __строковые__ (_чувствительны к string/symbol_) ключи:
+
+```ruby
+b = a.to_nested({
+  id: 'id',               # указывает какое свойство ноды является идентификатором;
+  parent_id: 'parent_id', # -//- предком;
+  children: 'children',   # -//- массивом потомков;
+  level: 'level'          # -//- дополнительным свойством с уровнем вложенности;
+  root_id: nil            # определяет что является корнем для построения дерева,
+                          # например, для построения ветви корнем корнем
+                          # является идентификатор одной из нод.
+})
+```
 
-Для указания базовых имён полей ноды (чувствительны к string/symbol):
+Дополнительные опции преобразования:
 
+```ruby
+b = a.to_nested({
+  hashed: false,    # потомки могут храниться не в массиве а в хэше;
+  add_level: false, # добавляет в ноду информацию о уровене вложенности ноды;
+})
 ```
-id: 'id',
-parent_id: 'parent_id',
-children: 'children',
-level: 'level',
+
+
+
+
+<a name="each_nested"></a>
+### each_nested [↑](#methods "К методам")
+
+Перебирает вложенную стуктуру.
+
+```ruby
+nested.each_nested do |node, parents, level, is_last_children|
+  puts node             # > {'id' => ...}
+  puts parents          # > [{'id' => ...}]
+  puts level            # > 0
+  puts is_last_children # > false
+end
 ```
 
-Дополнительные параметры преобразования:
 
+
+
+<a name="nested_to_html"></a>
+### nested_to_html [↑](#methods "К методам")
+
+Формирует _html_-код для вывода вложенных структур с использованием вложенных друг в друга списков `<ul>`.
+
+__Пример__
+
+```ruby
+[
+  {'id' => 1, 'parent_id' => nil, 'name' => 'first'},
+  {'id' => 2, 'parent_id' =>   1, 'name' => 'second'},
+  {'id' => 3, 'parent_id' =>   1, 'name' => 'third'}
+].to_nested.nested_to_html do |node|
+  node['name']
+end
 ```
-hashed: false,
-add_level: false,
-root_id: nil,
+
+Вернёт
+
+```html
+	<li>first
+		<ul>
+			<li>second</li>
+			<li>third</li>
+		</ul>
+	</li>
 ```
 
-__Опции `nested_to_html`__
+__Расширенный пример__
 
+```ruby
+.nested_to_html li: '<li class="my">', _ul: '<i></i></ul>' do |node, parents, level|
+  block_options = {}
+  block_options[:li] = '<li class="my current">' if node['id'] == 2
+  [
+  	"id: #{node['id']}, #{node['name']}, parent name: #{parents[level]&.[]('name')}",
+  	block_options
+  ]
+end
 ```
+
+__Опции__
+
+Все опции могут быть аргументами метода, и только некоторые опции влияют на результат через блок — на лету (последняя строка блока).
+
+```ruby
 tabulated: true,
 inline: false,
 tab: "\t",
-ul:  '<ul>',
+ul:  '<ul>', # может задаваться блоком
 _ul: '</ul>',
-li:  '<li>',
+li:  '<li>', # может задаваться блоком
 _li: '</li>',
 ```
 
-### "Скеивание" вложенных структур `concat_nested`
 
-Ноды склеиваются если путь к ним одинаков;
-Путь определяется из сложения Текстов (конфигурируемо через :path_key);
 
-__Опции `nested_to_html`__
 
-```
-path_separator: '-=path_separator=-',
-path_key: 'text',
-```
+<a name="nested_to_options"></a>
+### nested_to_options [↑](#methods "К методам")
 
-### Формирования опций для html-тега &lt;select&gt; `nested_to_options`
+Формирования опций для html-тега &lt;select&gt;
 
 Возвращает массив с псевдографикой, позволяющей вывести древовидную структуру.
 
-```
+```ruby
+
 [['option_text1', 'option_value1'],['option_text2', 'option_value2'],…]
 ```
 
-__Опции `nested_to_options`__
+__Опции__
 
-```
+```ruby
 option_value: 'id', # Что брать в качестве значений при формировании опций селекта.
 option_text: 'name',
 ```
 
-## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
+<a name="concat_nested"></a>
+### concat_nested [↑](#methods "К методам")
+
+Скеивание вложенных структур.
+
+* Ноды склеиваются если путь к ним одинаков;
+* Путь определяется из сложения Текстов (конфигурируемо через :path_key);
+
+__Опции__
+
+```ruby
+path_separator: '-=path_separator=-',
+path_key: 'text',
+```
+
+
+
+
+## Разработка
+
+…
+
+
+
+
+## Содействие
+
+…
+
+
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Zlatov/nested_array.
 
-## License
+## Лицензия
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+В соответствии с условиями [лицензии MIT](https://opensource.org/licenses/MIT).

data/README.md

@@ -23,6 +23,7 @@ It is intended for transformation into a tree structure of flat data described b
 Add this line to your application's Gemfile:
 
 ```ruby
+gem 'nested_array', '~> 1.0.0'
 gem 'nested_array', '~> 2.0.0'
 ```
 

data/lib/nested_array/nested.rb

@@ -38,6 +38,9 @@ module NestedArray::Nested
     }
   end
 
+  # 
+  # Перебирает вложенную стуктуру.
+  # 
   def each_nested options={}
     options = NESTED_OPTIONS.merge options
     level = 0
@@ -249,15 +252,16 @@ module NestedArray::Nested
       i[level]+= 1
       if node != nil
 
+        node_html, node_options = yield(node.clone, parents.clone, level)
         html+= options[:tab] * (level * 2 + 1) if options[:tabulated]
-        html+= options[:li]
-        html+= yield(node.clone, parents.clone, level)
+        html+= node_options&.[](:li) || options[:li]
+        html+= node_html.to_s
 
         if !node[options[:children]].nil? && node[options[:children]].length > 0
           level+= 1
           html+= "\n" if !options[:inline]
           html+= options[:tab] * (level * 2) if options[:tabulated]
-          html+= options[:ul]
+          html+= node_options&.[](:ul) || options[:ul]
           html+= "\n" if !options[:inline]
           parents[level] = node.clone
           cache[level] = node[options[:children]]
@@ -298,7 +302,7 @@ module NestedArray::Nested
       node_level = (1..level).map{|l| last[l] == true ? ' ' : '┃'}.join
       node_last = is_last ? '┗' : '┣'
       node_children = node[options[:children]].present? && node[options[:children]].length > 0 ? '┳' : '━'
-      option_text = "#{node_level}#{node_last}#{node_children}╸#{node_text}"
+      option_text = "#{node_level}#{node_last}#{node_children}╸".html_safe + "#{node_text}"
       option_value = node[options[:option_value]]
       ret.push [option_text, option_value]
     end

data/lib/nested_array/version.rb

@@ -1,3 +1,3 @@
 module NestedArray
-  VERSION = "2.0.4"
+  VERSION = "2.2.1"
 end

data/test.old/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'activesupport'
+gem 'awesome_print'
+gem 'nested_array', path: '../'

data/test.old/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: ..
+  specs:
+    nested_array (1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    awesome_print (1.8.0)
+    concurrent-ruby (1.1.6)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  awesome_print
+  nested_array!
+
+BUNDLED WITH
+   2.0.1

data/test.old/bash/run/bundle.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -eu
+
+cd "$(dirname "${0}")"
+
+cd ../..
+
+bundle install

data/test.old/bash/run/test.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -eu
+
+cd "$(dirname "${0}")"
+
+cd ../..
+
+bundle exec ruby test.rb

data/test.old/test.rb

@@ -0,0 +1,42 @@
+require 'active_support/all'
+require 'awesome_print'
+require 'nested_array'
+
+puts 'Начато тестирование.'.blue
+puts "Версия руби: #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
+
+def to_nested_1
+  puts "Тестирование #{__method__}".blue
+  a = [
+    {'id' => 1, 'parent_id' => nil, 'name' => 'first'},
+    {'id' => 2, 'parent_id' => 1, 'name' => 'second'},
+    {'id' => 3, 'parent_id' => 1, 'name' => 'third'}
+  ]
+  a = NestedArray::Array.new a
+  b = a.to_nested
+  return false if b != [
+    {'id' => 1, 'parent_id' => nil, 'name' => 'first', 'children' => [
+      {'id' => 2, 'parent_id' => 1, 'name' => 'second'},
+      {'id' => 3, 'parent_id' => 1, 'name' => 'third'}
+    ]},
+  ]
+  b = a.to_nested add_level: true
+  return false if b != [
+    {'id' => 1, 'parent_id' => nil, 'name' => 'first', 'level' => 0, 'children' => [
+      {'id' => 2, 'parent_id' => 1, 'name' => 'second', 'level' => 1},
+      {'id' => 3, 'parent_id' => 1, 'name' => 'third', 'level' => 1}
+    ]},
+  ]
+  return true
+end
+
+
+
+
+begin
+  raise if !to_nested_1
+rescue => e
+  puts 'Тестирование не пройдено.'.red
+  exit 1
+end
+puts 'Тестирование пройдено.'.green

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nested_array
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.2.1
 platform: ruby
 authors:
 - zlatov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-19 00:00:00.000000000 Z
+date: 2023-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,7 +87,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -109,11 +108,15 @@ files:
 - bin/rspec
 - bin/setup
 - dev/nested_options.rb
-- lib/.byebug_history
 - lib/nested_array.rb
 - lib/nested_array/nested.rb
 - lib/nested_array/version.rb
 - nested_array.gemspec
+- test.old/Gemfile
+- test.old/Gemfile.lock
+- test.old/bash/run/bundle.sh
+- test.old/bash/run/test.sh
+- test.old/test.rb
 homepage: https://github.com/Zlatov/nested_array
 licenses:
 - MIT
@@ -136,8 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: Convert a flat array into a nested one in 1 pass and another…

data/.byebug_history

@@ -1,18 +0,0 @@
-c
-fixture.first.deep_symbolize_keys
-fixture.first
-fixture.deep_symbolize_keys
-fixture
-fixture = JSON.parse File.read(fixture_path)
-File.exist?(fixture_path)
-fixture_path = Pathname.new(Dir.pwd).join("spec", "fixtures", "json", "#{name}.json")
-name
-Dir.pwd
-b = a.join $0
-a = Pathname.new Dir.pwd
-$0
-Dir.pwd
-Pathname
-Dir.entries(File.dirname(__FILE__)).reject{|e| e == '.' || e == '..'}.select{|e| File.directory? e}
-File.dirname(__FILE__)
-__FILE__

data/lib/.byebug_history

@@ -1,10 +0,0 @@
-continue
-NestedArrayModule.class
-NestedArrayModule
-NestedArrayMod
-NestedArray.class
-NestedArray
-self.parent
-self.class
-continue
-NestedArray.class