lexical_analyzer 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 273933b2287cdeb8b2b222f6e7300be549035466
-  data.tar.gz: 07a210f72d942e13e5e6f399a3d51738eac9eb15
+  metadata.gz: 9dd35696f4d5750cc7ea28dbd6da1fea8ac798bb
+  data.tar.gz: 62643fad63d6447ff424591674a15b86e9e380ad
 SHA512:
-  metadata.gz: a0cbcf9971f958e2da32f3b86504a857c9e0dd326e6167be41b256c8dc0356eafd38c7fdf0b45f7a598ac88ab3b8aa943eceebb7c22a7f2e3440d8d48ddea3a8
-  data.tar.gz: 7df681c1106a6009443228ade75c3b26935b82695b89baeb8d64db62e8f81cbdeb5045dbcb4a8d5de6b84738d103b863a2a27cc464aa84673cf8c88feaa80416
+  metadata.gz: 1d712d947aba827f92e780b4dc8a2d0b2cc8d65eb58cc31857b1c6521f9402e02b95c0059259de969bad5896c1946d3080b7cdd5da950fdb76c8ba8b20e4d167
+  data.tar.gz: efee0aedb08edeaed16acced97b2531c95ffced80ef42b2806bb6caf2e40ae90e5a584ac6ff72ff9cc4bf7d46cf3528656cb9fc837747f6c868ee4b2cb9af013

data/README.md

@@ -1,10 +1,21 @@
 # LexicalAnalyzer
 
-The lexical analyzer is a component of the Ruby Compiler Toolkit Project that
-scans an input text against an array of rules and generating the lexical
-tokens that it detects. It is normally used in conjunction with a parse queue
-object which handles queuing of tokens and back tracking of the compile process
-when needed.
+The lexical analyzer is a component of the Ruby Compiler Toolkit Project (rctp)
+that scans an input text against an array of rules and generating the lexical
+tokens that it detects. This process is shown below:
+
+![The Lexical Process](./images/lexical_process.png)
+
+In general, each time the lexical_analyzer receives the "get" message, it tries
+to extract another token from the source text. As such, the lexical analyzer
+gem component is the first stage of the compilation process for a compiler
+built using the rctp. With its array of lexical rules it provides the language
+tokens needed to operate the compiler's parser.
+
+The lexical analyzer is normally used in conjunction with a parse queue object
+which handles queuing of tokens and back tracking of the compile process when
+needed. In the rcpt this is done by the gem
+[parse_queue](https://github.com/PeterCamilleri/parse_queue).
 
 ## Installation
 
@@ -76,10 +87,14 @@ Notes:
 
 * The regular expression must begin with a \A clause to ensure correct
 operation of the analyzer.
+* An exception to the above is the use of the expression /.+/ at the end of the
+rule list as a sort of lexical "else" catch-all clause.
 * The order of rules is important. For example, if there are two rules
 looking for "==" and "=" respectively, if the "=" is ahead of the "==" rule
 in the array the "==" rule will never trigger and the analysis will be
 incorrect.
+* The method LexicalRule#symbol is a read accessor for the symbol property of
+the lexical rule.
 
 #### Tokens
 

data/lexical_analyzer.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>=2.3.0'
 
   spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency 'minitest_visible', "~> 0.1"
   spec.add_development_dependency 'reek', "~> 5.0.2"

data/lib/lexical_analyzer/version.rb

@@ -1,3 +1,3 @@
 class LexicalAnalyzer
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lexical_analyzer
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - PeterCamilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-12 00:00:00.000000000 Z
+date: 2020-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +92,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- images/lexical_process.png
 - lexical_analyzer.gemspec
 - lib/lexical_analyzer.rb
 - lib/lexical_analyzer/lexical_rule.rb