srl_ruby 0.4.3 → 0.4.7

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/LICENSE.txt

@@ -5,7 +5,7 @@ the 'srl_test' directory, which is subject to its own license.
 
 The MIT License (MIT)
 
-Copyright (c) 2018 Dimitri Geshef
+Copyright (c) 2018-2019 Dimitri Geshef
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -15,7 +15,7 @@ With **srl_ruby** you can easily design your patterns in SRL and let *srl_ruby*
 - Ruby API for integrating a SRL parser or compiler with your code.
 - 100% pure Ruby with clean design (_not a port from some other language_)
 - Minimal runtime dependency ([Rley](https://rubygems.org/gems/rley) gem). Won't drag a bunch of gems...
-- Compatibility: works with 2.x+ MRI, JRuby
+- Compatibility: works with Ruby 2.3+ MRI, JRuby
 - Portability: tested on both Linux and Windows,...
 
 ## Installation

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task' # Rspec as testing tool
 require 'cucumber/rake/task' # Cucumber as testing tool
@@ -8,6 +10,7 @@ RSpec::Core::RakeTask.new do |spec|
 end
 
 Cucumber::Rake::Task.new do |_|
+  # Comment
 end
 
 # Combine RSpec and Cucumber tests

data/appveyor.yml

@@ -1,27 +1,28 @@
 version: '{build}'
-max_jobs: 3
+max_jobs: 5
 environment:
   matrix:
-  - Ruby_version: 21
-  - Ruby_version: 21-x64
-  - Ruby_version: 22
-  - Ruby_version: 22-x64
-  - Ruby_version: 23
-  - Ruby_version: 23-x64
-  - Ruby_version: 24  
-  - Ruby_version: 24-x64
-  - Ruby_version: 25  
+  - Ruby_version: 26-x64
   - Ruby_version: 25-x64
- 
-# These are failing 
-#  - Ruby_version: 26  
-#  - Ruby_version: 26-x64  
+  - Ruby_version: 24-x64
+  - Ruby_version: 23-x64
+  - Ruby_version: 26
+  - Ruby_version: 25
+  - Ruby_version: 24
+  - Ruby_version: 23
 
 install:
   - set PATH=C:\Ruby%Ruby_version%\bin;%PATH%
+  - gem update --system
+  - gem install bundler
   - bundle install --retry=3 --clean --force
 
 build: off
 
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
 test_script:
   - bundle exec rake

data/bin/srl2ruby

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'erb'
 require 'rubygems'
 require 'pathname'
@@ -7,10 +9,14 @@ require_relative '../lib/srl_ruby'
 require_relative 'srl2ruby_cli_parser'
 
 class Srl2RubyProg
-  DefaultSRLExtension = 'srl'.freeze
-  DefDirname = '/templates'.freeze
-  DefTemplate = 'base.erb'.freeze
+  DefaultSRLExtension = 'srl'
+  DefDirname = '/templates'
+  DefTemplate = 'base.erb'
+
+  # @return [Hash]
   attr_reader(:cli_options)
+
+  # @return [ERB]
   attr_reader(:template)
 
   def initialize(prog_name, args)
@@ -23,11 +29,12 @@ class Srl2RubyProg
   def run!(file_names)
     if cli_options.include?(:pattern)
       srl_source = cli_options[:pattern]
-      process_srl(srl_source)    
+      process_srl(srl_source)
     end
     file_names.each do |srl_file|
       fname = validate_filename(srl_file)
       next unless file_exist?(fname)
+
       puts "Parsing file '#{fname}'"
       srl_source = File.read(fname)
       process_srl(srl_source)
@@ -46,18 +53,16 @@ class Srl2RubyProg
       fname = cli_options[:template]
       exists = File.exist?(fname)
       if exists
-        t_filepath = Dir.getwd + '/' + fname
+        t_filepath = "#{Dir.getwd}/#{fname}"
       else
-        t_filepath = def_template_dir + '/' + fname
+        t_filepath = "#{def_template_dir}/#{fname}"
         exit(1) unless file_exist?(t_filepath)
       end
     else
-      t_filepath = def_template_dir + '/' + DefTemplate
+      t_filepath = "#{def_template_dir}/#{DefTemplate}"
     end
     path = Pathname.new(t_filepath)
-    erb_template = ERB.new(path.read, nil, '<>')
-
-    erb_template
+    ERB.new(path.read, nil, '<>')
   end
 
   def validate_filename(raw_fname)
@@ -76,7 +81,7 @@ class Srl2RubyProg
 
     exists
   end
-  
+
   def process_srl(srl_source)
     result = SrlRuby.parse(srl_source)
     destination = $stdout
@@ -85,7 +90,7 @@ class Srl2RubyProg
       destination = File.open(filepath, 'w')
     end
     puts "Writing to file '#{filepath}'" unless destination == $stdout
-    destination.puts emit_code(template, srl_source, result)  
+    destination.puts emit_code(template, srl_source, result)
   end
 
   def emit_code(template, srl_source, regexp)

data/bin/srl2ruby_cli_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optparse' # Use standard OptionParser class for command-line parsing
 
 # A command-line option parser for the srl2ruby compiler.
@@ -13,7 +15,7 @@ class Srl2RubyCLIParser < OptionParser
 
     heading
     separator 'Options:'
-    add_p_option    
+    add_p_option
     add_o_option
     add_t_option
     separator ''
@@ -35,7 +37,7 @@ class Srl2RubyCLIParser < OptionParser
   end
 
   def description
-    descr = <<-DESCR
+    <<-DESCR
 Description:
   Parses a SRL file and compiles it into a Ruby Regexp literal.
   Simple Regex Language (SRL) website: https://simple-regex.com
@@ -45,8 +47,6 @@ Examples:
   #{program_name} -p 'begin with literally "Hello world!"'
   #{program_name} example.srl -o example_re.rb -t srl_and_ruby.erb
 DESCR
-
-    descr
   end
 
   def heading
@@ -63,14 +63,14 @@ DESCR
       @parsed_options[:output] = pathname
     end
   end
-  
+
   def add_p_option
     explanation = 'One-liner SRL pattern.'
 
     on '-p', '--pattern SRL_PATT', explanation do |pattern_arg|
        @parsed_options[:pattern] = pattern_arg.gsub(/^'|'$/, '')
     end
-  end  
+  end
 
   def add_t_option
     explanation = <<-EXPLANATION

data/features/lib/step_definitions/srl_testing_steps.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 When('I define the following SRL expression:') do |srl_source|
   @regex = SrlRuby::parse(srl_source)
 end

data/features/lib/support/env..rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec'
 require 'cucumber'
 require 'srl_ruby'

data/lib/regex/abstract_method.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: abstract_method.rb
 
 # Mix-in module. Provides the method 'abstract_method' that raises an exception

data/lib/regex/alternation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: alternation.rb
 
 require_relative 'polyadic_expression' # Access the superclass
@@ -17,9 +19,7 @@ module Regex # This module is used as a namespace
     # Purpose: Return the String representation of the concatented expressions.
     def text_repr
       result_children = children.map(&:to_str)
-      result = '(?:' + result_children.join('|') + ')'
-
-      return result
+      "(?:#{result_children.join('|')})"
     end
   end # class
 end # module

data/lib/regex/anchor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: anchor.rb
 
 require_relative 'atomic_expression' # Access the superclass
@@ -24,6 +26,7 @@ module Regex # This module is used as a namespace
     # Constructor
     # @param aKind [String] Lexeme representation of the anchor
     def initialize(aKind)
+      super()
       @kind = valid_kind(aKind)
     end
 

data/lib/regex/atomic_expression.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: atomic_expression.rb
 
 require_relative 'expression' # Access the superclass

data/lib/regex/capturing_group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: capturing_group.rb
 
 require_relative 'monadic_expression' # Access the superclass
@@ -6,6 +8,8 @@ module Regex # This module is used as a namespace
   # An association between a capture variable and an expression
   # the subject text in the same serial arrangement
   class CapturingGroup < MonadicExpression
+    # rubocop: disable Style/OptionalBooleanParameter
+
     # The capture variable id. It is a Fixnum when the capture group gets
     # a sequence number,
     # a String when it is an user-defined name
@@ -40,12 +44,13 @@ module Regex # This module is used as a namespace
       atomic = no_backtrack ? '?>' : ''
       if child.is_a?(Regex::NonCapturingGroup)
         # Minor optimization
-        result = '(' + atomic + prefix + child.child.to_str + ')'
+        suffix = child.child.to_str
       else
-        result = '(' + atomic + prefix + child.to_str + ')'
+        suffix = child.to_str
       end
-      return result
+      "(#{atomic}#{prefix}#{suffix})"
     end
+    # rubocop: enable Style/OptionalBooleanParameter
   end # class
 end # module
 

data/lib/regex/char_class.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: char_class.rb
 
 require_relative 'polyadic_expression' # Access the superclass
@@ -22,13 +24,13 @@ module Regex # This module is used as a namespace
     # Conversion method re-definition.
     # Purpose: Return the String representation of the character class.
     def text_repr
-      result_children = children.inject('') do |sub_result, child|
+      result_children = children.inject(+'') do |sub_result, child|
         if child.kind_of?(Regex::Character) && Metachars.include?(child.codepoint)
           sub_result << '\\' # Escape meta-character...
         end
         sub_result << child.to_str
       end
-      result = '[' + (negated ? '^' : '') + result_children + ']'
+      result = "[#{negated ? '^' : ''}#{result_children}]"
 
       return result
     end

data/lib/regex/char_range.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: char_range.rb
 
 require_relative 'polyadic_expression' # Access the superclass
@@ -32,9 +34,7 @@ module Regex # This module is used as a namespace
     # Conversion method re-definition.
     # Purpose: Return the String representation of the concatented expressions.
     def text_repr
-      result = lower.to_str + '-' + upper.to_str
-
-      return result
+      "#{lower.to_str}-#{upper.to_str}"
     end
 
     private
@@ -43,6 +43,7 @@ module Regex # This module is used as a namespace
     def validated_range(theLowerBound, theUpperBound)
       msg = 'Character range error: lower bound is greater than upper bound.'
       raise StandardError, msg if theLowerBound.codepoint > theUpperBound.codepoint
+
       return [theLowerBound, theUpperBound]
     end
   end # class

data/lib/regex/char_shorthand.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: char_shorthand.rb
 
 require_relative 'atomic_expression' # Access the superclass
@@ -24,6 +26,7 @@ module Regex # This module is used as a namespace
 
     # Constructor
     def initialize(aShortname)
+      super()
       @shortname = valid_shortname(aShortname)
     end
 

data/lib/regex/character.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: character.rb
 
 require_relative 'atomic_expression' # Access the superclass
@@ -25,8 +27,8 @@ module Regex # This module is used as a namespace
       '\7' => 7
     }.freeze
 
-    MetaChars = '\^$.|+?*()[]{}'.freeze
-    MetaCharsInClass = '\^[]-'.freeze # Characters with special meaning in char. class
+    MetaChars = '\^$.|+?*()[]{}'
+    MetaCharsInClass = '\^[]-' # Characters with special meaning in char. class
 
     # The integer value that uniquely identifies the character.
     attr_reader(:codepoint)
@@ -57,6 +59,7 @@ module Regex # This module is used as a namespace
     # RegAn::Character.new('\n')    # Represents a newline
     # RegAn::Character.new('\u03a3')  # Represents a Σ
     def initialize(aValue)
+      super()
       case aValue
         when String
           if aValue.size == 1
@@ -103,6 +106,7 @@ module Regex # This module is used as a namespace
     def self.esc2codepoint(esc_seq)
       msg = "Escape sequence #{esc_seq} does not begin with a backslash (\)."
       raise StandardError, msg unless esc_seq[0] == '\\'
+
       result = (esc_seq.length == 2) ? digram2codepoint(esc_seq) : esc_number2codepoint(esc_seq)
 
       return result
@@ -155,6 +159,7 @@ module Regex # This module is used as a namespace
     # Otherwise the character corresponding to the codepoint is returned.
     def text_repr
       return char if lexeme.nil?
+
       return lexeme.dup
     end
 

data/lib/regex/compound_expression.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: compound_expression.rb
 
 require_relative 'expression' # Access the superclass

data/lib/regex/concatenation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: concatenation.rb
 
 require_relative 'polyadic_expression' # Access the superclass
@@ -17,7 +19,7 @@ module Regex # This module is used as a namespace
     # Conversion method re-definition.
     # Purpose: Return the String representation of the concatented expressions.
     def text_repr
-      outcome = children.inject('') do |result, child|
+      outcome = children.inject(+'') do |result, child|
         result << child.to_str
       end
 

data/lib/regex/expression.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: expression.rb
 
 require_relative 'abstract_method'
@@ -5,7 +7,10 @@ require_relative 'abstract_method'
 module Regex # This module is used as a namespace
   # Abstract class. The generalization of any valid regular (sub)expression.
   class Expression
+    # @return [NilClass, Anchor]
     attr_accessor :begin_anchor
+
+    # @return [NilClass, Anchor]
     attr_accessor :end_anchor
 
     # Constructor
@@ -31,7 +36,7 @@ module Regex # This module is used as a namespace
     # Template method.
     # @return [String] text representation of the expression.
     def to_str
-      result = ''
+      result = +''
       result << prefix
       result << text_repr
       result << suffix