indented-list 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b0048ef91a5c25c0f8cfb7f98a434f2315a71a3
+  data.tar.gz: 7914d6c64b58c1dbe7c167586b6480649facc52c
+SHA512:
+  metadata.gz: a5c541dfd88b371a0e954e4f8f3a7911ab0cc2cd5946e4d55e861d449c01d2e44e73a66b2fb03ed695112d1fa883357364b7a8b3ac8dfd4471a7f274e4dd27d6
+  data.tar.gz: 929d141bbd25b1aca52a221df9de9e876e144426e0126215af50f3d5e082d86cf09b80284cf196569bf51545af4544c09b7f2f4e877cebb9bdd86b41e3cb5e94

data/lib/indented-list/indented-list-parser.rb

@@ -0,0 +1,52 @@
+class IndentedListParser
+  attr_reader :list, :raw
+
+  #
+  # Parses a whitespace indented nested list and returns its content as an object of nested Hashes and Arrays. 
+  #
+  def initialize( list )
+    case list
+      when String
+        source = list && File.exist?( list ) ? File.readlines( list ) : list.lines
+      when Array 
+        source = list
+      else
+        abort "List can be given as a file name, String or Array. The class of the currently used list '#{list}' is: #{list.class}."
+    end
+    raw = source.map(&:chomp).select { |line|  line if !line.match(/^\s*$/) }
+    @list = step raw
+  end
+ 
+  private
+
+  def get_indentation_map( arr )
+    arr.map { |line| line[/^ */].size }
+  end
+
+  def slice_before_smallest_indent( arr )
+    indentation_map = get_indentation_map( arr ).uniq.sort
+    smallest_indent = indentation_map[0]
+    arr.slice_before { |line| line[/^ */].size == smallest_indent  }.to_a
+  end
+
+  def turn_nested_arr_into_hash( nested_arr )
+    nested_arr.inject({}) { |hash, arr| hash = hash.merge( arr[0].strip => arr[1..-1] ) }
+  end
+
+  def step( arr )
+    if arr.is_a?( Array ) && !arr.empty? && arr[0].is_a?( String )     
+      if get_indentation_map( arr ).uniq.sort.count > 1 
+        arr = slice_before_smallest_indent arr
+        arr = turn_nested_arr_into_hash arr
+        arr = arr.inject({}) do |hash, (key, value)|
+          hash = hash.merge( key => step( value ) )
+        end
+      else
+        arr = arr.map(&:strip)
+      end
+    else
+      arr
+    end
+  end
+    
+end

data/lib/indented-list.rb

@@ -0,0 +1,88 @@
+require 'indented-list/indented-list-parser'
+require 'pp'
+ 
+  #
+  # Parses whitespace indented nested list.
+  # The parsing result is an object of Hashes of Array, hence the list can easily be converted to JSON or YAML.
+  #
+  #
+  # == Getting started 
+  #      require 'indented-list'
+  #      list = IndentedList.new( 'list.txt' )  # load list from a text file
+  #      list = IndentedList.new( my-list )     # list can be passed as Array or String
+  #
+  #
+  # == Usage
+  #
+  # Full text search 
+  # Returns full branch of the root Hash in which match has occured.
+  #       pp list.find( /my-regex/ )  
+  #
+  #
+  # == Extensibility
+  #
+  # This gem suggests the hook method 'get' which can be implemented as needed for any specific list. 
+  # Any other list-specific method can be easily implemented. 
+  #   class MyList < IndentedList
+  #     def get( *params )
+  #       get_tags_with_indicators
+  #     end
+  #
+  #     def get_tags_with_indicators
+  #       # ...
+  #     end
+  #   end
+  #
+  #
+  # == CLI Usage
+  #
+  # For use with IRB suppress return output:
+  #       irb(main):001:0> irb --simple-prompt --noecho
+  #
+  # You can also suppress return output in irb on a by-line basis:
+  #       irb(main):001:0> marc = MARC21Format.new;0    # => 0
+  #
+  # Commands can then be used as described above.
+  #
+  # ---
+  #
+  # Copyright (c) 2017 Maike Kittelmann
+  #
+  # Indented-List is freely distributable under the terms of MIT license.
+  # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+  #
+  # Disclaimer: The software comes without any warranty.
+  
+  
+class IndentedList
+  attr_reader :list
+
+  def initialize( list )
+    parser = IndentedListParser.new( list )
+    @list = parser.list
+  end
+  
+  def each( &block )
+    list.each( &block )
+  end
+  
+  def method_missing( method, *args, &block )
+    list.respond_to?( method, *args, &block ) ? list.send( method, *args, &block ) : super
+  end  
+  
+  #
+  # Full text search. Takes a regular expression as an argument. 
+  # Returns full branch of the root Hash in which match has occured.
+  #  
+  def find( regex )
+    list.select { |k,v| { k => v } if ( k.match( regex ) || v.to_s.match( regex ) ) } 
+  end
+  
+  #
+  # Hook
+  #
+  def get( *params )
+    puts 'Implement specific searches for your list. See documentation for how to do this.'
+  end
+  
+end