rley 0.4.06 → 0.4.07

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57136a1796f3625b841a2f1fdb0965b4314b6224
-  data.tar.gz: 80fd87d6ad9f68314278d5b4c15ef85a241647c3
+  metadata.gz: 3ddc536143d5391aac2c513060d9f0afa43656f7
+  data.tar.gz: 69e5069295d886ea1287b17cdb7453506d589552
 SHA512:
-  metadata.gz: 3922fe824b8d721892b71022e64a79f4117ed0135f0b02fdaf76f5edfef083d345192328f3086a80fc0484e7dac14f7ec188a51c942bab2b14c8a196e4c9ffc4
-  data.tar.gz: 836625169012043daeba92c142fda1e80e6f4eaf085437c2d1bc006e57ca8de99d70619fce22f2d6d8f000468e9c93c65b8e073d80f68084619d7c2070e18197
+  metadata.gz: 18f44cd59717551570814e180c735e62badf109c291cb1b41cbaf709bfc2af6cc78864ceb34060b9eb3ca017ab7cfd2e642f1848770b87cced6b1752d27896c0
+  data.tar.gz: 668c3f7737921db9ad35301034be75b91faa584d1ede14fabb253a0dffa6d5a43dc09c94289df714236f0e184a59eb3f10775a2bbd16a6f5a39e8c746969871e

data/.rubocop.yml

@@ -1,13 +1,9 @@
 AllCops:
   Exclude:
-    - 'examples/**/*'
     - 'features/**/*'
     - 'exp/**/*'    
     - 'gems/**/*'
     - 'refs/**/*'
-
-AbcSize:
-  Max: 45
     
 # This is disabled because some demos use UTF-8
 AsciiComments:
@@ -20,7 +16,7 @@ BlockComments:
   Enabled: false
   
 CaseIndentation:
-  IndentWhenRelativeTo: end
+  EnforcedStyle: end
   IndentOneStep: true
 
 # Rubocop enforces the use of is_a? instead of kind_of?
@@ -50,18 +46,34 @@ EmptyLines:
 Encoding:
   Enabled: false
   
+EndOfLine:
+  Enabled: false
+#  SupportedStyles: lf
+  
+  
 IndentationWidth :
   Enabled: false
   
+# Enabled after end of support of Rubies < 2.3
+Layout/IndentHeredoc:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 50
   
 # Avoid methods longer than 50 lines of code
-MethodLength:
+Metrics/MethodLength:
   Max: 50
   CountComments: false 
- 
-# Avoid modules longer than 700 lines of code 
-ModuleLength:
-  Max: 700
+
+# Avoid modules longer than 200 lines of code 
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 200  
+
+Metrics/PerceivedComplexity:
+  Enabled: true
+  Max: 50
  
 NonNilCheck:
   Enabled: false
@@ -69,9 +81,6 @@ NonNilCheck:
 NumericLiterals:
   Enabled: false
   
-PerceivedComplexity:
-  Max: 10
-  
 RaiseArgs:
   Enabled: false
   

data/.travis.yml

@@ -1,17 +1,18 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.9
-  - 2.2.6
-  - 2.3.3
+  - 2.0.0-p648
+  - 2.1.10
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
   - ruby-head
-  - rbx-2.2
-  - jruby-9.1.0.0    
+  - rbx-2.7
+  - jruby-9.1.9.0    
   - jruby-head 
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: rbx-2.2
+    - rvm: rbx-2.7
     - rvm: jruby-head
 
 gemfile:

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 0.4.07 / 2017-05-25
+* [FIX] To avoid Fixnum deprecation error in Ruby 2.4 abd higher, all explicit references to Fixnum has been removed.
+* [FIX] File `.rubocop.yml`: folder `examples` was excluded from Rubocop control. Now it is in code analysis scope.
+* [NEW] File `spec\.rubocop.yml` to tune the code analysis for Rspec files
+* [NEW] File `examples\.rubocop.yml` to tune the code analysis for example files
+* [CHANGE] Code re-styling to please Rubocop 0.49.0: less than 10 offences remain (from above 200 count!)
+* [CHANGE] Added support for Ruby 2.4.x. Files `.travis.yml` and `README.md` updated.
+
+
 ### 0.4.06 / 2017-05-25
 * [FIX] File `formatter\asciitree.rb` fixed inconsistency in comments that caused Yard warnings.
 * [FIX] File `formatter\bracket_notation.rb` fixed inconsistency in comments that caused Yard warnings.

data/README.md

@@ -55,8 +55,9 @@ Rley supports the following Ruby implementations:
 - MRI 2.0  
 - MRI 2.1  
 - MRI 2.2  
-- MRI 2.3  
-- JRuby 9.0+  
+- MRI 2.3
+- MRI 2.4  
+- JRuby 9.1+  
 
 ---
 
@@ -88,7 +89,7 @@ directory
 The subset of English grammar is based on an example from the NLTK book.
 
 ```ruby  
-    require 'rley'  # Load Rley library
+    require 'rley' # Load Rley library
 
     # Instantiate a builder object that will build the grammar for us
     builder = Rley::Syntax::GrammarBuilder.new do
@@ -134,7 +135,7 @@ The subset of English grammar is based on an example from the NLTK book.
       'on' => 'Preposition',
       'by' => 'Preposition',
       'with' => 'Preposition'
-    }
+    }.freeze
 ```  
 
 
@@ -142,12 +143,10 @@ The subset of English grammar is based on an example from the NLTK book.
 ```ruby
     # A tokenizer reads the input string and converts it into a sequence of tokens
     # Highly simplified tokenizer implementation.
-    def tokenizer(aText, aGrammar)
-      tokens = aText.scan(/\S+/).map do |word|
+    def tokenizer(aTextToParse, aGrammar)
+      tokens = aTextToParse.scan(/\S+/).map do |word|
         term_name = Lexicon[word]
-        if term_name.nil?
-          raise StandardError, "Word '#{word}' not found in lexicon"
-        end
+        raise StandardError, "Word '#{word}' not found in lexicon" if term_name.nil?
         terminal = aGrammar.name2symbol[term_name]
         Rley::Tokens::Token.new(word, terminal)
       end
@@ -441,7 +440,7 @@ The extensive resource list not to miss: [Awesome NLP with Ruby](https://github.
 actively curated by Andrei Beliankou (aka arbox).
 
 ##  Thanks to:
-* Professor Keshav Pingali, one of the creators of the Grammar Flow Graph parsing approach for his encouraging e-mail exchanges.
+* Professor Keshav Pingali, one of the creators of the Grammar Flow Graph parsing approach for his encouraging e-mail exchange.
 
 ## Grammar Flow Graph
 Since the Grammar Flow Graph parsing approach is quite new, it has not yet taken a place in

data/examples/NLP/mini_en_demo.rb

@@ -1,4 +1,4 @@
-require 'rley'  # Load Rley library
+require 'rley' # Load Rley library
 
 ########################################
 # Step 1. Define a grammar for a micro English-like language
@@ -10,7 +10,8 @@ require 'rley'  # Load Rley library
 
 # Instantiate a builder object that will build the grammar for us
 builder = Rley::Syntax::GrammarBuilder.new do
-  # Next 2 lines we define the terminal symbols (=word categories in the lexicon)
+  # Next 2 lines we define the terminal symbols 
+  # (= word categories in the lexicon)
   add_terminals('Noun', 'Proper-Noun', 'Verb') 
   add_terminals('Determiner', 'Preposition')
 
@@ -51,7 +52,7 @@ Lexicon = {
   'on' => 'Preposition',
   'by' => 'Preposition',
   'with' => 'Preposition'
-}
+}.freeze
 
 ########################################
 # Step 3. Creating a tokenizer
@@ -60,9 +61,7 @@ Lexicon = {
 def tokenizer(aTextToParse, aGrammar)
   tokens = aTextToParse.scan(/\S+/).map do |word|
     term_name = Lexicon[word]
-    if term_name.nil?
-      raise StandardError, "Word '#{word}' not found in lexicon"
-    end
+    raise StandardError, "Word '#{word}' not found in lexicon" if term_name.nil?
     terminal = aGrammar.name2symbol[term_name]
     Rley::Tokens::Token.new(word, terminal)
   end
@@ -102,7 +101,8 @@ visitor = Rley::ParseTreeVisitor.new(ptree)
 # Let's create a formatter that will render the parse tree with characters
 renderer = Rley::Formatter::Asciitree.new($stdout)
 
-# Let's create a formatter that will render the parse tree in labelled bracket notation
+# Let's create a formatter that will render the parse tree in labelled 
+# bracket notation
 # renderer = Rley::Formatter::BracketNotation.new($stdout)
 
 # Subscribe the formatter to the visitor's event and launch the visit

data/examples/data_formats/JSON/cli_options.rb

@@ -2,10 +2,9 @@ require 'optparse'
 
 # A Hash specialization that collects the command-line options
 class CLIOptions < Hash
-#labelled square notation (LBN).
-#Use online tools (e.g. http://yohasebe.com/rsyntaxtree/) to visualize
-#parse trees from LBN output.
-
+  # labelled square notation (LBN).
+  # Use online tools (e.g. http://yohasebe.com/rsyntaxtree/) to visualize
+  # parse trees from LBN output.
   def initialize(progName, progVersion, args)
     super()
     
@@ -42,7 +41,7 @@ Select the output format (default: ascii_tree). Available formats:
               Use online tools (e.g. http://yohasebe.com/rsyntaxtree/) 
               to visualize parse trees from LBN output.
 END_TEXT
-      formats = %i(ascii_tree labelled)
+      formats = %i[ascii_tree labelled]
       opts.on('-f', '--format FORMAT', formats, format_help) do |frm|
         self[:format] = frm
       end
@@ -62,4 +61,4 @@ END_TEXT
       end
     end
   end
-end # class
+end # class

data/examples/data_formats/JSON/{JSON_demo.rb → json_demo.rb}

@@ -1,7 +1,7 @@
 require_relative 'cli_options'
-require_relative 'JSON_parser'
+require_relative 'json_parser'
 
-prog_name = 'JSON_demo'
+prog_name = 'json_demo'
 prog_version = '0.1.0'
 
 cli_options = CLIOptions.new(prog_name, prog_version, ARGV)

data/examples/data_formats/JSON/{JSON_grammar.rb → json_grammar.rb}

@@ -1,5 +1,5 @@
 # Grammar for JSON data representation
-require 'rley'  # Load the gem
+require 'rley' # Load the gem
 
 
 ########################################
@@ -21,17 +21,17 @@ builder = Rley::Syntax::GrammarBuilder.new do
   rule 'value' => 'array'
   rule 'value' => 'number'
   rule 'value' => 'string'  
-  rule 'object' => %w(begin-object member-list end-object)
-  rule 'object' => %w(begin-object end-object)
+  rule 'object' => %w[begin-object member-list end-object]
+  rule 'object' => %w[begin-object end-object]
   # Next rule is an example of a left recursive rule
-  rule 'member-list' => %w(member-list value-separator member)
+  rule 'member-list' => %w[member-list value-separator member]
   rule 'member-list' => 'member'
-  rule 'member' => %w(string name-separator value)
-  rule 'array' => %w(begin-array array-items end-array)
-  rule 'array' => %w(begin-array end-array)
-  rule 'array-items' => %w(array-items value-separator value)
-  rule 'array-items' => %w(value)
+  rule 'member' => %w[string name-separator value]
+  rule 'array' => %w[begin-array array-items end-array]
+  rule 'array' => %w[begin-array end-array]
+  rule 'array-items' => %w[array-items value-separator value]
+  rule 'array-items' => %w[value]
 end
 
 # And now build the JSON grammar...
-GrammarJSON = builder.grammar
+GrammarJSON = builder.grammar

data/examples/data_formats/JSON/{JSON_lexer.rb → json_lexer.rb}

@@ -1,6 +1,6 @@
 # File: JSON_lexer.rb
 # Lexer for the JSON data format
-require 'rley'  # Load the gem
+require 'rley' # Load the gem
 require 'strscan'
 
 # Lexer for JSON.
@@ -17,20 +17,19 @@ class JSONLexer
     ']' => 'end-array',
     ',' => 'value-separator',
     ':' => 'name-separator'
-  }
+  }.freeze
 
-  class ScanError < StandardError ; end
+  class ScanError < StandardError; end
 
-public
   def initialize(source, aGrammar)
     @scanner = StringScanner.new(source)
     @name2symbol = aGrammar.name2symbol
-    @lineno =  1
+    @lineno = 1
   end
 
   def tokens()
     tok_sequence = []
-    until @scanner.eos? do
+    until @scanner.eos?
       token = _next_token
       tok_sequence << token unless token.nil?
     end
@@ -38,13 +37,14 @@ public
     return tok_sequence
   end
 
-private
+  private
+
   def _next_token()
     token = nil
     skip_whitespaces
     curr_ch = scanner.getch # curr_ch is at start of token or eof reached...
 
-    begin
+    loop do
       break if curr_ch.nil?
 
       case curr_ch
@@ -53,7 +53,7 @@ private
           token_type = name2symbol[type_name]
           token = Rley::Tokens::Token.new(curr_ch, token_type)
 
-        when /[ftn]/  # First letter of keywords
+        when /[ftn]/ # First letter of keywords
           @scanner.pos = scanner.pos - 1 # Simulate putback
           keyw = scanner.scan(/false|true|null/)
           if keyw.nil?
@@ -65,10 +65,11 @@ private
           end
 
         # LITERALS
-        when '"'  # Start string delimiter found
+        when '"' # Start string delimiter found
           value = scanner.scan(/([^"\\]|\\.)*/)
-          end_delimiter = scanner.getch()
-          raise ScanError.new('No closing quotes (") found') if end_delimiter.nil?
+          end_delimiter = scanner.getch
+          err_msg = 'No closing quotes (") found'
+          raise ScanError.new(err_msg) if end_delimiter.nil?
           token_type = name2symbol['string']
           token = Rley::Tokens::Token.new(value, token_type)
 
@@ -83,15 +84,13 @@ private
           sequel = scanner.scan(/.{1,20}/)
           erroneous += sequel unless sequel.nil?
           raise ScanError.new("Unknown token #{erroneous}")
-      end #case
-
-
-    end while (token.nil? && curr_ch = scanner.getch())
+      end # case
+      break unless token.nil? && (curr_ch = scanner.getch)
+    end
 
     return token
   end
 
-
   def skip_whitespaces()
     matched = scanner.scan(/[ \t\f\n\r]+/)
     return if matched.nil?
@@ -101,12 +100,8 @@ private
     newline_detected(newline_count)
   end
 
-
   def newline_detected(count)
     @lineno += count
-    @line_start = scanner.pos()
+    @line_start = scanner.pos
   end
-
 end # class
-
-

data/examples/data_formats/JSON/{JSON_parser.rb → json_parser.rb}

@@ -1,6 +1,6 @@
 # Purpose: to demonstrate how to build and render a parse tree for JSON
 # language
-require 'rley'  # Load the Rley gem
+require 'rley' # Load the Rley gem
 require_relative 'json_lexer'
 
 # Steps to render a parse tree (of a valid parsed input):
@@ -13,7 +13,7 @@ require_relative 'json_lexer'
 
 ########################################
 # Step 1. Load a grammar for JSON
-require_relative 'JSON_grammar'
+require_relative 'json_grammar'
 
 # A JSON parser derived from our general Earley parser.
 class JSONParser < Rley::Parser::GFGEarleyParser

data/examples/general/calc/calc_demo.rb

@@ -36,4 +36,4 @@ visitor = Rley::ParseTreeVisitor.new(ptree)
 # Now output formatted parse tree
 renderer = Rley::Formatter::Asciitree.new($stdout)
 renderer.render(visitor)
-# End of file
+# End of file

data/examples/general/calc/calc_grammar.rb

@@ -1,5 +1,5 @@
 # Grammar for simple arithmetical expressions
-require 'rley'  # Load the gem
+require 'rley' # Load the gem
 
 ########################################
 # Define a grammar for basic arithmetical expressions
@@ -8,13 +8,13 @@ builder = Rley::Syntax::GrammarBuilder.new do
   add_terminals('LPAREN', 'RPAREN') # For '(', ')' delimiters
   add_terminals('PLUS', 'MINUS') # For '+', '-' operators or sign
   add_terminals('STAR', 'DIVIDE') # For '*', '/' operators
-  rule 'expression' => %w(sign simple_expression)
+  rule 'expression' => %w[sign simple_expression]
   rule 'simple_expression' => 'term'
-  rule 'simple_expression' => %w(simple_expression add_operator term)
+  rule 'simple_expression' => %w[simple_expression add_operator term]
   rule 'term' => 'factor'
-  rule 'term' => %w(term mul_operator factor)
+  rule 'term' => %w[term mul_operator factor]
   rule 'factor' => 'NUMBER'
-  rule 'factor' => %w(LPAREN expression RPAREN)
+  rule 'factor' => %w[LPAREN expression RPAREN]
   rule 'sign' => 'PLUS'
   rule 'sign' => 'MINUS'
   rule 'sign' => []