indentation-parser 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.project
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Samuel Müller
+
+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/README.md

@@ -0,0 +1,63 @@
+[![Build Status](https://secure.travis-ci.org/ssmm/indentation-parser.png)](http://travis-ci.org/ssmm/indentation-parser)
+
+# Indentation-Parser
+
+A parser for indented files.
+
+## How
+
+Assume you have this structure:
+
+	this
+	  is
+	    an
+	      example : First example
+	    the
+	      second
+	        one : Second example
+	  serves
+	    as
+	      another
+	        example : Third example
+
+You want to create an output which you can use like this:
+
+```ruby
+puts output.this.is.an.example
+# => "First example"
+
+puts output.this.is.the.second.one
+# => "Second example"
+
+puts output.this.serves.as.another.example
+# => "Third example"
+```
+
+You write a parser like so:
+
+```ruby
+parser = IndentationParser.new do |p|
+  p.default do |parent, indentation, source|
+    node = OpenStruct.new
+    parent.send("#{source}=", node)
+    node
+  end
+  
+  p.on /([^ ]+) : (.+)/ do |parent, indentation, source, captures|
+    node = captures[2]
+    parent.send("#{captures[1]}=", node)
+    node
+  end
+end
+```
+
+Then you read your special syntax from a file, parse it and celebrate:
+
+```ruby
+source = IO.read("path/to/file")
+output = parser.read(source, OpenStruct.new).value
+
+puts output.this.is.an.example
+puts output.this.is.the.second.one
+puts output.this.serves.as.another.example
+```

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/indentation-parser.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/indentation-parser/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Samuel Müller"]
+  gem.email         = ["mueller.samu@gmail.com"]
+  gem.description   = %q{indentation-parser}
+  gem.summary       = %q{indentation-parser}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "indentation-parser"
+  gem.require_paths = ["lib"]
+  gem.version       = Indentation::Parser::VERSION
+  
+  gem.add_development_dependency "rspec", "~> 2.11"
+end

data/lib/indentation-parser.rb

@@ -0,0 +1,60 @@
+require "indentation-parser/version"
+require "indentation-parser/node"
+require "indentation-parser/hooks"
+require "indentation-parser/handlers"
+
+class IndentationParser
+
+  def initialize    
+    @node_handlers = {}
+    @leaf_handlers = {}
+    @child_of_handlers = {}
+    yield self if block_given?
+  end
+  
+  def parse_line line
+    idx = line.index(/[^ ]/)
+    return idx / 2, line[idx..line.length]
+  end
+
+  def read text, root_value
+    
+    root = IndentationParser::RootNode.new
+
+    root.set_value root_value
+
+    node_stack = [root]
+    
+    text.each_line do |line|
+      line.chomp!
+      next if line.length == 0 || line =~ /^\s*$/
+      indentation, source = parse_line line
+      new_node = IndentationParser::Node.new source, indentation
+      
+      lastone = node_stack.last
+      
+      if new_node.indentation() - 1 == lastone.indentation #the current node is indented to the previous node
+        lastone.add new_node
+        handle_node lastone unless lastone.is_a? RootNode
+        node_stack.push new_node
+      elsif new_node.indentation == lastone.indentation #the current node is on the same level as the previous node
+        leaf = node_stack.pop
+        handle_leaf leaf
+        node_stack.last.add new_node
+        node_stack.push new_node
+      elsif new_node.indentation() - 1 > lastone.indentation #too large indentation -> raise an error
+        raise "ou neei"
+      else #indentation is less than previous node. Pop everything from stack until parent is found
+        leaf = node_stack.pop
+        handle_leaf leaf
+        (lastone.indentation - new_node.indentation).times do 
+          node_stack.pop          
+        end
+        node_stack.last.add new_node
+        node_stack.push new_node
+      end
+    end
+    handle_leaf node_stack.last
+    root
+  end
+end

data/lib/indentation-parser/handlers.rb

@@ -0,0 +1,54 @@
+class IndentationParser
+
+  def execute_regex_handler node, regex, block
+    captures = regex.match node.source
+    if captures
+      node_value = block.call(node.parent.value, node.indentation, node.source, captures)
+      node.set_value node_value
+      return true
+    end
+    false
+  end
+  
+  def execute_child_of_handler node
+    handler = @child_of_handlers[node.parent.value.class]
+    if handler
+      node_value = handler.call node.parent.value, node.indentation, node.source
+      node.set_value node_value
+      return true
+    end
+    false
+  end
+
+  def try_to_handle handlers, node
+    handled = false
+    handlers.each do |key, value|
+      result = execute_regex_handler node, key, value
+      handled = true if result      
+    end
+    handled
+  end
+
+  def handle_node node
+    handled = execute_child_of_handler node
+    
+    return handled if handled
+    
+    handled = try_to_handle @node_handlers, node
+    if not handled and @default
+      node_value = @default.call node.parent.value, node.indentation, node.source if @default
+      node.set_value node_value
+    end
+  end
+  
+  def handle_leaf node
+    handled = try_to_handle @leaf_handlers, node
+    if not handled and @on_leaf
+      node_value = @on_leaf.call node.parent.value, node.indentation, node.source
+      node.set_value node_value
+    else
+      handle_node node
+    end
+  end
+  
+end

data/lib/indentation-parser/hooks.rb

@@ -0,0 +1,23 @@
+class IndentationParser
+  def on regex, &block    
+    @node_handlers[regex] = block
+  end
+
+  def default &block
+    @default = block
+  end
+
+  alias :else :default
+
+  def on_leaf regex, &block
+    @leaf_handlers[regex] = block
+  end
+
+  def on_leaf &block
+    @on_leaf = block
+  end  
+  
+  def as_a_child_of parent_node_type, &block
+    @child_of_handlers[parent_node_type] = block
+  end
+end

data/lib/indentation-parser/node.rb

@@ -0,0 +1,37 @@
+class IndentationParser
+  class Node
+    def initialize source, indentation
+      @source = source
+      @indentation = indentation
+      @subnodes = []
+    end
+    def add node
+      node.set_parent self
+      @subnodes << node
+    end  
+    def parent
+      @parent
+    end
+    def set_parent parent
+      @parent = parent
+    end
+    def indentation
+      @indentation
+    end
+    def source
+      @source
+    end
+    def value
+      @value
+    end
+    def set_value value
+      @value = value
+    end
+  end
+  
+  class RootNode < Node
+    def initialize
+      super "root", -1
+    end
+  end
+end

data/lib/indentation-parser/version.rb

@@ -0,0 +1,5 @@
+module Indentation
+  module Parser
+    VERSION = "0.0.1"
+  end
+end

data/spec/material/an.example

@@ -0,0 +1,11 @@
+this
+  is
+    an
+      example : First example
+    the
+      second
+        one : Second example
+  serves
+    as
+      another
+        example : Third example

data/spec/material/test.mylang

@@ -0,0 +1,13 @@
+this
+  structure
+  is
+    crazy
+      and
+  weird
+and
+  does
+    not
+      make
+    any
+  sense
+    

data/spec/material/the.universe

@@ -0,0 +1,21 @@
+planet = Earth
+  continent = Europe
+    country = Switzerland
+      population = 8
+      currency = CHF
+      specialities:
+        chocolate
+        cheese
+    country = England
+      population = 40
+      currency = GBP
+      specialities:
+        fish'n'chips
+        drum'n'bass
+  continent = America
+    country = USA
+      population = 100
+      currency = USD
+      specialities:
+        hamburgers
+        baseball

data/spec/readme_example_spec.rb

@@ -0,0 +1,29 @@
+require 'indentation-parser'
+require 'ostruct'
+
+describe IndentationParser do
+  it "does what is written in the readme" do
+    parser = IndentationParser.new do |p|
+      p.default do |parent, indentation, source|
+        node = OpenStruct.new
+        parent.send("#{source}=", node)
+        node
+      end
+      
+      p.on /([^ ]+) : (.+)/ do |parent, indentation, source, captures|
+        node = captures[2]
+        parent.send("#{captures[1]}=", node)
+        node
+      end
+    end
+
+    source = IO.read("spec/material/an.example")
+    
+    output = parser.read(source, OpenStruct.new).value
+
+    output.this.is.an.example.should eq "First example"
+    output.this.is.the.second.one.should eq "Second example"
+    output.this.serves.as.another.example.should eq "Third example"
+
+  end
+end

data/spec/simple_spec.rb

@@ -0,0 +1,46 @@
+require 'indentation-parser'
+
+describe IndentationParser do
+  it "parses indented files" do
+    parser = IndentationParser.new do |p|
+      p.default do |parent, indentation, source|
+        node = {}
+        parent[source.to_sym] = node
+        node
+      end
+      
+      p.on_leaf do |parent, indentation, source|
+        node = {}
+        parent[source.to_sym] = node
+        node
+      end
+    end
+    
+    source = IO.read("spec/material/test.mylang")
+    
+    result = parser.read(source, {}).value
+    
+    expected_hash = {
+      :this => {
+        :structure => {},
+        :is => {
+          :crazy => {
+            :and => {}
+          }
+        },
+        :weird => {}
+      },
+      :and => {
+        :does => {
+          :not => {
+            :make => {}
+          },
+          :any => {}
+        },
+        :sense => {}
+      }
+    }
+    
+    result.should eq expected_hash
+  end  
+end

data/spec/universe_spec.rb

@@ -0,0 +1,68 @@
+require 'indentation-parser'
+
+Universe = Struct.new(:planets)
+Planet = Struct.new(:name, :continents)
+Continent = Struct.new(:name, :countries)
+Country = Struct.new(:name, :population, :currency, :specialities)
+
+describe IndentationParser do
+  
+  it "parses a .universe file" do
+    parser = IndentationParser.new do |p|
+      
+      p.on /planet = ([a-zA-Z]+)/ do |parent, indentation, source, captures|
+        planet = Planet.new captures[1]
+        planet.continents = []
+        parent.planets << planet
+        planet
+      end
+      
+      p.on /continent = ([a-zA-Z]+)/ do |parent, indentation, source, captures|
+        continent = Continent.new captures[1]
+        continent.countries = []
+        parent.continents << continent
+        continent
+      end
+      
+      p.on /country = ([a-zA-Z]+)/ do |parent, indentation, source, captures|
+        country = Country.new captures[1]
+        parent.countries << country
+        country
+      end
+      
+      p.on /population = ([0-9]+)/ do |parent, indentation, source, captures|
+        parent.population = captures[1].to_i
+      end
+      
+      p.on /currency = ([a-zA-Z]+)/ do |parent, indentation, source, captures|
+        parent.currency = captures[1]
+      end
+      
+      p.on /specialities/ do |parent, indentation, source, captures|
+        parent.specialities = []
+      end      
+      
+      p.as_a_child_of Array do |parent, indentation, source|
+        parent << source  
+      end
+      
+    end
+    
+    source = IO.read("spec/material/the.universe")
+    universe = Universe.new
+    universe.planets = []
+    result = parser.read(source, universe).value
+    
+    countries = result.planets.first.continents.first.countries
+    
+    switzerland = countries.shift
+    switzerland.name.should eq "Switzerland"
+    switzerland.population.should eq 8
+    switzerland.specialities.should eq ["chocolate", "cheese"]
+    
+    england = countries.shift
+    england.name.should eq "England"
+    england.population.should eq 40
+    england.specialities.should eq ["fish'n'chips", "drum'n'bass"]
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: indentation-parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Samuel Müller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: indentation-parser
+email:
+- mueller.samu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- indentation-parser.gemspec
+- lib/indentation-parser.rb
+- lib/indentation-parser/handlers.rb
+- lib/indentation-parser/hooks.rb
+- lib/indentation-parser/node.rb
+- lib/indentation-parser/version.rb
+- spec/material/an.example
+- spec/material/test.mylang
+- spec/material/the.universe
+- spec/readme_example_spec.rb
+- spec/simple_spec.rb
+- spec/universe_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: indentation-parser
+test_files:
+- spec/material/an.example
+- spec/material/test.mylang
+- spec/material/the.universe
+- spec/readme_example_spec.rb
+- spec/simple_spec.rb
+- spec/universe_spec.rb