nested_string_parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0fd6dba43658f034613dd768a23e82fee6303aa
+  data.tar.gz: f3a0577e9190dedf881b3ea4808be5c982185baa
+SHA512:
+  metadata.gz: adf100b54e17ca969da8360aa70cbc0072ddd934a5315c17f2dfffeb8481cd5b6f4bcf9d178c47c41f3ab35e660c3d986e0a57ee8c3f193b1ffe85c4dea64899
+  data.tar.gz: 46954bed6b8b365c8c10a6b462ae345ac0b89e293e60f8675efc75015072aeb658039f1136245037da1587e7233a3fc94afed96e4c4d7f67f524965a3b741d0a

data/.gitignore

@@ -0,0 +1,30 @@
+*.a
+*.bundle
+*.gem
+*.o
+*.rbc
+*.so
+.#*
+.bundle
+.config
+.yardoc
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+mkmf.log
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nested_string_parser.gemspec
+gemspec

data/README.md

@@ -0,0 +1,37 @@
+# NestedStringParser
+
+`NestedStringParser` takes a multi-line string, containing indented lines, and returns a `Node` object for each line, such that:
+
+* `node.parent` returns the node for the most recent less-indented previous line
+* `node.children` returns the nodes for all following more-indented lines, either up to end-of-string, or up to the next equally-indented or less-indented line
+* `node.value` returns the stripped text of the line
+* `node.indent` returns the length of the blank string for this line in the source string
+
+See specs for some examples.
+
+`NestedStringParser` is not terribly fussy about indentation ; any string that is indented more than a previous string will be assigned the previous string as parent. Use `format` to normalise indentation if your input is sloppy. Specs provide an example of sloppy indentation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nested_string_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nested_string_parser
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/nested_string_parser/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/nested_string_parser.rb

@@ -0,0 +1,20 @@
+require "nested_string_parser/version"
+
+module NestedStringParser
+  class Node
+    attr_accessor :nesting, :value, :parent, :children
+
+    def initialize     s=nil ; @nesting, @value, @children = (s ? s.gsub(/^( *)[^ ].*/, '\1').length : -1), (s && s.strip), [] ; end
+    def add_child?     child ; (child.nesting > self.nesting) ? add_child(child) : parent.add_child?(child)                    ; end
+    def add_child      child ; @children << child ; child.parent = self ; child                                                ; end
+    def nb?              str ; str && str.strip != ""                                                                          ; end
+    def accept str=nil, *ss ; nb?(str) ? add_child?(Node.new(str)).accept(*ss) : (ss.size > 0 ? self.accept(*ss) : self)       ; end
+    def root                 ; parent ? parent.root : self                                                                     ; end
+    def format        indent ; "#{indent}#{value}\n#{children.map { |c| c.format "#{indent}  " }.join}"                        ; end
+  end
+
+  def self.parse str ; NestedStringParser::Node.new.accept(*str.split(/\n/)).root ; end
+  module StringExtension ; def parse_nested_string ; NestedStringParser.parse self ; end ; end
+
+  def self.patch ; ::String.send :include, StringExtension ; end
+end

data/lib/nested_string_parser/version.rb

@@ -0,0 +1,3 @@
+module NestedStringParser
+  VERSION = "0.0.1"
+end

data/mit-license.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Conan Dalton conan@conandalton.net
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/nested_string_parser.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nested_string_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nested_string_parser"
+  spec.version       = NestedStringParser::VERSION
+  spec.authors       = ["Conan Dalton"]
+  spec.email         = ["conan@conandalton.net"]
+  spec.summary       = %q{Parse multi-line string with indentation, return a structure where nesting is based on line indentation}
+  spec.description   = %q{Parse multi-line string with indentation, return a structure where nesting is based on line indentation}
+  spec.homepage      = "http://github.com/conanite/nested_string_parser"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.1'
+end

data/spec/parse_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+require "nested_string_parser"
+
+RSpec::describe NestedStringParser do
+  before(:all) { NestedStringParser.patch }
+  it "parses nothing at all" do
+    node = "".parse_nested_string
+    expect(node.value   ).to eq nil
+    expect(node.nesting ).to eq(-1)
+    expect(node.children).to eq []
+  end
+
+  it "parses a single line" do
+    node = "foo bar hello world".parse_nested_string
+    expect(node.value        ).to eq nil
+    expect(node.nesting      ).to eq(-1)
+    expect(node.children.size).to eq 1
+
+    child = node.children.first
+    expect(child.value   ).to eq "foo bar hello world"
+    expect(child.nesting ).to eq 0
+    expect(child.children).to eq []
+  end
+
+  it "parses two root lines" do
+    node = "foo bar\nhello world".parse_nested_string
+    expect(node.value        ).to eq nil
+    expect(node.nesting      ).to eq(-1)
+    expect(node.children.size).to eq 2
+
+    child = node.children[0]
+    expect(child.value   ).to eq "foo bar"
+    expect(child.nesting ).to eq 0
+    expect(child.children).to eq []
+
+    child = node.children[1]
+    expect(child.value   ).to eq "hello world"
+    expect(child.nesting ).to eq 0
+    expect(child.children).to eq []
+  end
+
+  CANONICAL_QUARKS = <<STRING
+quarks
+  G1
+    up
+    down
+  G2
+    strange
+    charmed
+  G3
+    top
+    bottom
+leptons
+  G1
+    electron
+    electron neutrino
+  G2
+    muon
+    muon neutrino
+  G3
+    tau
+    tau neutrino
+STRING
+
+  it "parses a whole hierarchy" do
+    node = CANONICAL_QUARKS.parse_nested_string
+    expect(node.value                ).to eq nil
+    expect(node.nesting              ).to eq(-1)
+    expect(node.children.map(&:value)).to eq %w{ quarks leptons }
+
+    quarks = node.children[0]
+    expect(quarks.nesting                ).to eq 0
+    expect(quarks.children.map(&:value)  ).to eq %w{ G1 G2 G3 }
+    expect(quarks.children.map(&:nesting)).to eq [2,2,2]
+    expect(quarks.children.map { |q| q.children.map(&:nesting) }).to eq [[4,4], [4,4], [4,4]]
+    expect(quarks.children.map { |q| q.children.map(&:value)   }).to eq [%w{up down}, %w{strange charmed}, %w{top bottom}]
+
+    leptons = node.children[1]
+    expect(leptons.nesting                ).to eq 0
+    expect(leptons.children.map(&:value)  ).to eq %w{ G1 G2 G3 }
+    expect(leptons.children.map(&:nesting)).to eq [2,2,2]
+    expect(leptons.children.map { |q| q.children.map(&:nesting) }).to eq [[4,4], [4,4], [4,4]]
+    expect(leptons.children.map { |q| q.children.map(&:value)   }).to eq [%w{electron electron\ neutrino}, %w{muon muon\ neutrino}, %w{tau tau\ neutrino}]
+
+    expect(node.children.map { |c| c.format "" }.join.strip).to eq CANONICAL_QUARKS.strip
+  end
+
+  it "parses a sloppy indentation and ignores blank lines" do
+    string = <<STRING
+quarks
+  G1
+    up
+    down
+
+  G2
+     strange
+   charmed
+  G3
+                        top
+    bottom
+leptons
+  G1
+                   electron
+
+                   electron neutrino
+ G2
+                muon
+    muon neutrino
+ G3
+  tau
+
+  tau neutrino
+
+
+STRING
+    node = string.parse_nested_string
+    expect(node.value                ).to eq nil
+    expect(node.nesting              ).to eq(-1)
+    expect(node.children.map(&:value)).to eq %w{ quarks leptons }
+
+    quarks = node.children[0]
+    expect(quarks.children.map(&:value)  ).to eq %w{ G1 G2 G3 }
+    expect(quarks.children.map { |q| q.children.map(&:value)   }).to eq [%w{up down}, %w{strange charmed}, %w{top bottom}]
+
+    leptons = node.children[1]
+    expect(leptons.children.map(&:value)  ).to eq %w{ G1 G2 G3 }
+    expect(leptons.children.map { |q| q.children.map(&:value)   }).to eq [%w{electron electron\ neutrino}, %w{muon muon\ neutrino}, %w{tau tau\ neutrino}]
+
+    # #format, however, ignores original indentation
+    expect(node.children.map { |c| c.format "" }.join.strip).to eq CANONICAL_QUARKS.strip
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: nested_string_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Conan Dalton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Parse multi-line string with indentation, return a structure where nesting
+  is based on line indentation
+email:
+- conan@conandalton.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- lib/nested_string_parser.rb
+- lib/nested_string_parser/version.rb
+- mit-license.txt
+- nested_string_parser.gemspec
+- spec/parse_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/conanite/nested_string_parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Parse multi-line string with indentation, return a structure where nesting
+  is based on line indentation
+test_files:
+- spec/parse_spec.rb
+- spec/spec_helper.rb