iparser 1.1.6 → 1.1.7

data/lib/iparser/state.rb

@@ -0,0 +1,76 @@
+module Iparser
+  #  Used for describe single state
+  #  of parser machine.
+  class State
+
+    attr_reader :statename
+    attr_accessor :branches, :entry, :leave, :ientry, :ileave, :ignore
+  
+    # call-seq:
+    #  State.new( String )
+    def initialize ( sname )
+      unless sname.instance_of? String
+        raise TypeError, 'Incorrectly types for <Parser-State> constructor.'
+      end
+
+      @statename = sname
+      @init    = nil  # method called after entry (state constructor).
+      @fini    = nil  # method called after leave (state destructor).
+      @handler = nil  # state machine for handler current state.
+      @ignore  = { :all => [], :handler => [] }
+      @ientry  = 0    # use to save compred index of this state.
+      @ileave  = 0    # use to save compred index of this state.
+      @entry   = []   # template chars for entry state.
+      @leave   = []   # template chars for leave state.
+      @branches = []  # indexes of any states to branch.
+    end
+
+    # call-seq:
+    #   init( method(:some_init_method) )
+    #
+    # Set initializer method for current state.
+    def init ( method )
+      raise TypeError, error_message(method, __method__) unless method.instance_of? Method
+      @init = method
+    end
+
+    # call-seq:
+    #   fini( method(:some_fini_method) )
+    #
+    # Set finalizer method for current state.
+    def fini ( method )
+      raise TypeError, error_message(method, __method__) unless method.instance_of? Method
+      @fini = method
+    end
+
+    def run_init( *args ) # :nodoc:
+      return @init.call( *args ) if @init != nil
+      return nil
+    end
+
+    def run_fini( *args ) # :nodoc:
+      return @fini.call( *args ) if @fini != nil
+      return nil
+    end
+
+    # call-seq:
+    #   handler( method(:some_handler_method) )
+    #
+    # Set handler method for current state.
+    def handler ( method )
+      raise TypeError,  error_message(method, __method__) unless method.instance_of? Method
+      @handler = method
+    end
+
+    def run_handler( *args ) # :nodoc:
+      return @handler.call( *args ) if @handler != nil
+      return nil
+    end
+    
+  private
+    def error_message(object, method)
+      "#{object.class}: Incorrectly types for <#{method}> method of <Parser-State>."
+    end
+  end # class State
+
+end

data/lib/iparser/version.rb

@@ -1,3 +1,3 @@
 module Iparser
-  VERSION = "1.1.6"
+  VERSION = "1.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iparser
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.1.7
 platform: ruby
 authors:
 - gera-gas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2015-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,16 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
-- iparser.gemspec
 - lib/iparser.rb
+- lib/iparser/machine.rb
+- lib/iparser/state.rb
 - lib/iparser/version.rb
 homepage: https://github.com/gera-gas/iparser
 licenses:

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 anton
-
-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

@@ -1,313 +0,0 @@
-# Iparser
-
-Universal parser machine to generate your specific parsers (Parser engine).
-Used for simple and fast create your specific parsers.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'Iparser'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install iparser
-
-## Usage
-
-For example usage, present here very simple parser for automatically generate documentation from source code.
-Create file 'parser_example.rb' and copy the contents from the file *source № 1*.
-
-*source № 1*:
-```ruby
-require 'iparser'
-
-# Create parser-machine object.
-parser = Iparser::Machine.new
-# Create startup state for this parser-machine.
-ps_idle = Iparser::State.new('idle')
-# Create single line comment state for this parser-machine.
-ps_cline = Iparser::State.new('comment-line')
-# Create multiline comment state for this parser-machine.
-ps_cblock = Iparser::State.new('comment-block')
-
-# Add all states to parser-machine.
-parser.addstate ps_idle
-parser.addstate ps_cline
-parser.addstate ps_cblock
-
-# Add branch indexes to 'comment-line' and 'comment-block' state.
-# From 'idle' we can branch to 'comment-line' or 'comment-block' states.
-ps_idle.branches << parser.state_index( ps_cline )
-ps_idle.branches << parser.state_index( ps_cblock )
-
-# Describe 'comment-line' state.
-# Set template for entry this state (String or Regexp).
-ps_cline.entry << '/'
-ps_cline.entry << '/'
-ps_cline.entry << '/'
-# Set template for leave this state (String or Regexp).
-ps_cline.leave << /[\n\r]/
-
-# Describe 'comment-block' state.
-# Set template for entry this state (String or Regexp).
-ps_cblock.entry << '/'
-ps_cblock.entry << '*'
-ps_cblock.entry << '*'
-# Set template for leave this state (String or Regexp).
-ps_cblock.leave << '*'
-ps_cblock.leave << '/'
-# Set template for ignore this state (String format only).
-ps_cblock.ignore << '*'
-
-# Call parser startup method.
-parser.prestart
-# Call interactive mode for check state-machine.
-parser.interactive_parser
-```
-
-Run this script `ruby parser_example.rb` and typing `'///'` for branch to 'comment-line' state.
-Then type `'\n'` or `'\r'` for leave this state.
-Press `enter` (input empty string) to leave interactive mode.
-Check each state.
-
-**NOTE**: Type `'\\'` for input `'\'`.
-
-Each state has the following templates:
-* `entry`  - used for set condition (template) to entry state.
-* `leave`  - used for set condition (template) to leave state (return to previous state).
-* `ignore` - used for set symbols to ignoring.
- 
-After successfully check, you can add handler to each state.
-Each state has the following handlers:
-* `init` - is state contructor (called when entry to state).
-* `fini` - is state destructor (called when leave state).
-* `handler` - is state handler (called every time, is still in state).
-
-Each handler can return the following values: __nil__ - nothing is done (method `.parse` return `true`)
-and __any__ values for break parsing (method `.parse` return `false`). For break parsing process you
-should check return value of `.parse` method. For example:
-```ruby
-parser = Iparser::Machine.new
-'123asd'.each_char do |c|
-  exit if !parser.parse(c)
-end
-```
-Also each state have a `branches` field. Use the `branches` to add the index state,
-which is a possible jump.
-
-We create the following handlers:
-
-* Method `doc_init` is state destructor.
-* Method `doc_handler` is state handler and call in `comment-line` or `comment-block` for each input char.
-* Method `doc_fini` is state destructor.
-
-For `comment-block` state set ignore char - `*`, and handler don't called to this chars.
-The result is a file with the following content of 'parser_example.rb':
-
-Constructors and destructors handlers will be getting array chars with own templates.
-For example `doc_init` getting follow array chars: `['/', '/', '/']`
-
-*source № 2*:
-```ruby
-require 'iparser'
-
-# Simple check startup arguments.
-if( ARGV.size != 1 || !File.exist?(ARGV[0]) )
-  puts
-  puts "ERROR: unable to open file #{ARGV[0]}"
-  puts
-  exit
-end
-
-# Create output file.
-$fout = File.new( 'index.html', 'w' )
-
-# Create initializer method for parser-states.
-def doc_init ( str )
-  $fout.print "<p>"; return nil
-end
-# Create handler method for parser-states.
-def doc_handler ( c )
-  $fout.print c; return nil
-end
-# Create finalizer method for parser-states.
-def doc_fini ( str )
-  $fout.puts "</p>"; return nil
-end
-
-# Create parser-machine object.
-parser = Iparser::Machine.new
-# Create startup state for this parser-machine.
-ps_idle = Iparser::State.new('idle')
-# Create single line comment state for this parser-machine.
-ps_cline = Iparser::State.new('comment-line')
-# Create multiline comment state for this parser-machine.
-ps_cblock = Iparser::State.new('comment-block')
-
-# Add all states to parser-machine.
-parser.addstate ps_idle
-parser.addstate ps_cline
-parser.addstate ps_cblock
-
-# Add branch indexes to 'comment-line' and 'comment-block' state.
-# From 'idle' we can branch to 'comment-line' or 'comment-block' states.
-ps_idle.branches << parser.state_index( ps_cline )
-ps_idle.branches << parser.state_index( ps_cblock )
-
-# Describe 'comment-line' state.
-# Set template for entry this state (String or Regexp).
-ps_cline.entry << '/'
-ps_cline.entry << '/'
-ps_cline.entry << '/'
-# Set template for leave this state (String or Regexp).
-ps_cline.leave << /[\n\r]/
-# Add handler to 'commaent-line' state.
-ps_cline.init( method(:doc_init) )
-ps_cline.handler( method(:doc_handler) )
-ps_cline.fini( method(:doc_fini) )
-
-# Describe 'comment-block' state.
-# Set template for entry this state (String or Regexp).
-ps_cblock.entry << '/'
-ps_cblock.entry << '*'
-ps_cblock.entry << '*'
-# Set template for leave this state (String or Regexp).
-ps_cblock.leave << '*'
-ps_cblock.leave << '/'
-# Set template for ignore this state (String format only).
-ps_cblock.ignore << '*'
-# Add handler to 'commaent-block' state.
-ps_cblock.init( method(:doc_init) )
-ps_cblock.handler( method(:doc_handler) )
-ps_cblock.fini( method(:doc_fini) )
-
-# Call parser startup method.
-parser.prestart
-
-$fout.puts "<html>"
-$fout.puts "<body>"
-
-File.open( ARGV[0], 'r' ).each do |line|
-  line.each_char do |c|
-    parser.parse(c)
-  end
-end
-
-$fout.puts "</body>"
-$fout.puts "</html>"
-$fout.close
-```
-
-Now developing of the simple parser has been finished. You can create test file, for example 'test.c':
-
-*source № 3*:
-```
-#include <stdlib.h>
-
-///Test function - 1.
-void test1 ( void )
-{
-}
-/**
- * Test function - 2.
- */
-void test2 ( void )
-{
-}
-```
-
-and execute folow command in command line as:
-
-    $ ruby parser_example.rb test.c
-
-After work, we should see a file named 'index.html'.
-
-###### Своих не бросаем!
-------------------------
-
-Для примера использования данного gem, напишем простой парсер файла исходного кода
-для автоматической генерации документации, отдаленно напоминающего doxygen.
-Создадим ruby скрипт c именем 'parser_example.rb' и наполним его содержимым из *source № 1*.
-
-Далее запустим скрипт на выполнение:
-
-    $ ruby parser_example.rb
-
-Теперь в интерактивном режиме проверим корректность описанных нами состояний: `comment-line` и `comment-block`.
-Для чего введем строку символов `///` и увидим что наш парсер вывел `branch to <comment-line>`, это говорит
-о том, что парсер перешол в состояние для обработки однострочных комментариев, т.е. в состояние `comment-line`.
-Теперь введем `\n` или `\r` и увидим что парсер покинул состояние `comment-line` и вернулся в состояние `idle`.
-Аналогично проведем проверку для всех оставшихся состояний. Для выхода из интерактивного режима просто введите
-`Enter`, т.е. пустую строку.
-
-**NOTE**: для ввода символа `'\'` необходимо набрать `'\\'`.
-
-Если все переходы работают как мы и ожидали, то можно перейти к написанию обработчиков наших состояний.
-
-* Метод `doc_init` будет вызываться при входе в состояние, т.е. является конструктором состояния.
-* Метод `doc_handler` будет вызываться каждый раз, до тех пор пока парсер находится в состоянии `comment-line` или `comment-block`.
-* Метод `doc_fini` будет вызываться при выходе из состояния, т.е. является деструктором состояния.
-
-Обработчики состояния должены возвращать следующие значения: __nil__ - говорит парсер-машине о том,
-что процесс разбора продолжается и метод `.parse` вернет `true` и любое отличное от __nil__ значение
-будет разценено парсером как ошибка обработки и метод `.parse` вернет `false`. Для того, чтобы
-прервать процесс процесс парсинга, следует анализировать возвращаемое значение метода `,parse`,
-например так:
-```ruby
-parser = Iparser::Machine.new
-'123asd'.each_char do |c|
-  exit if !parser.parse(c)
-end
-```
-Также, каждое состояние имеет поле `branches`, для добавление индекса состояний на которые
-возможен переход из текущего состояния.
-
-Дополнительно для состояния `comment-block` мы указали символы, которые надо игнорировать,
-а именно `'*'` и `doc_handler` не будет вызываться при наличия данного символа во входном потоке.
-По окончанию мы получим файл с содержимым из *source № 2*.
-
-И наконец создадим тестовый файл с именем 'test.c' и наполним его содержимым из *source № 3*.
-Наш простой парсер готов. Теперь запустим его набрав следующую команду:
-
-    $ ruby parser_example.rb test.c
-
-По окончанию работы мы должны увидеть файл с именем 'index.html'.
-
-## Patch
-
-Details information for each patch.
-
-##### 1.1.6
-* Fixed bug in analyse `leave` template (incorrectly handling, if `entry` and `leave` is begin with identical symbol).
-* Now `ignore` template enabled for all handlers (init, fini, handler).
-
-##### 1.1.5
-* Add method `.current_state` for return name (String) of current state in parser-machine.
-
-##### 1.1.4
-* Add method `.state_index` for return index of parser-state.
-* Add analyse result of any handler (init, fini, handler).
-* Now `entry` and `leave` templates you can set a string or regular expression.
-
-## 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
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-