srl_ruby 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f476a011aec905f943e525e2fb73770d6fe253b0
-  data.tar.gz: 3a93a4502442762e7101bb46f58be95ac60a7730
+  metadata.gz: 1997032b58ee5f449eaed39a3fca67d24e86f253
+  data.tar.gz: 89ec3ebb1fab1f5f766096efe8e13faf51f4857d
 SHA512:
-  metadata.gz: 064d58d3a68227f7f0e636b3228194262bf08b79b07d807edd9c99042fa9e22a39735c4798a9bd918adb24216095849e7e69f5500447e4b2c1fe519823cac5d8
-  data.tar.gz: 63e7d716017d8fc95dfbac33fc1b36e0d4b39bcf0803b192f30b7d772747f5c811619afabcec0dbcb8091788e62d378b982de5e20978bea717f054301b3c4f57
+  metadata.gz: f2a3e60c41dc5ad53ebe26283b091fed46f2d75c38137f2fbbde5859f58a3f777c85cad4163efa4c0538288db469aa8e6623a7cbd0e5911e563a01661774e932
+  data.tar.gz: f5002562a72aac9b6e1a4f9ec2bba1f8e251435f578b3f9aad7b25a1acb1097553ae49e10ecdb2a87d2ab0eb4e3f026f5efca63331f991ee19b673591c8528e0

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.4.1] - 2018-05-25
+
+### Added
+- Command-line option -p, --pattern SRL_PATT, that allows users to enter directly short one-liner SRL patterns.
+  Thanks to `KarimGeiger` for suggesting me this enhancement.
+- Directory `examples` with SRL examples from `README` and more...
+
+### Changed
+- File `README.md` updated with new text of command-line help.
+
 ## [0.4.0] - 2018-05-13
 Version bump: SrlRuby has a command-line compiler `srl2ruby`
 

data/README.md

@@ -50,9 +50,11 @@ Description:
 
 Examples:
   srl2ruby example.srl
+  srl2ruby -p 'begin with literally "Hello world!"'
   srl2ruby example.srl -o example_re.rb -t srl_and_ruby.erb
 
 Options:
+    -p, --pattern SRL_PATT           One-liner SRL pattern.
     -o, --output-file PATH           Output to a file with specified name.
     -t, --template-file TEMPLATE     Use given ERB template for the Ruby code generation. srl2ruby looks for
 the template file in current dir first then in its gem's /templates dir.
@@ -140,7 +142,7 @@ Parsing file 'email_validation.srl'
 ```
 
 The resulting regexp isn't for the fainted hearts: who's ready to maintain it? In addition, the above pattern covers only the most frequent cases.  
-If you were asked to cover more exotic case, and knowing that it means an expression at least twice as complex, which version are you willing to update the SRL or the Regexp one?
+If you were asked to cover more exotic cases, and knowing that it means an expression at least twice as complex, which version are you willing to update the SRL or the Regexp one?
 
 #### Good to know: customizable output
 In fact, if one wants to update or maintain a pattern, it would be practical to have the SRL expression and its equivalent Regexp next to each other in our Ruby source code.  
@@ -212,12 +214,12 @@ If one compiles the above SRL expression with `srl2ruby` as explained earlier in
 When I want to test regular expressions, one of my favorite tool is the
 [Rubular website](http://rubular.com/). Tom Lovitt created a great Regexp editor and tester specifically for the Ruby community.
 
-By the way, perhaps, some lynx-eyed readers spotted a small "mistake" on the third line of the SRL snippet: it doesn't end with a comma.  
+By the way, perhaps some lynx-eyed readers spotted a small "mistake" on the third line of the SRL snippet: it doesn't end with a comma.  
 My apologies... For style consistency this line should be written as:  
 ```
 digit twice,
 ```
-In reality, SRL happily ignores comma. Well..., most of the time. There is one exception: for the `any of` construct commas are used to separate alternatives (see example in [Iteration 3](#iteration-3)
+In reality, SRL happily ignores comma. Well..., most of the time. There is one exception: for the `any of` construct commas are used to separate alternatives (see example in [Iteration 3](#iteration-3)).
 
 ### Iteration 2
 Tests won't take a long time to show that the previous pattern is much too 'lenient' and will accept grossly incorrect entries such as 45:67 PM.  
@@ -295,7 +297,7 @@ must end,
 case insensitive
 ```
 
-Here is the Regexp counterpart:
+Here is the Regexp counterpart generated by `srl2ruby`:
 ```ruby
 /(?i-mx:^(?:(?:0?\d)|(?:1[01])):(?:0?|[1-5])\d\s?[AP]M$)/
 ```
@@ -329,7 +331,7 @@ case insensitive
 /(?i-mx:^(?<hour>(?:(?:0?\d)|(?:1[01]))):(?<min>(?:0?|[1-5])\d)\s?[AP]M$)/
 ```
 
-That's becoming insane...
+That Regexp is becoming insane...
 
 
 #### Does this last Regexp really work?

data/bin/srl2ruby

@@ -21,19 +21,16 @@ class Srl2RubyProg
   end
 
   def run!(file_names)
+    if cli_options.include?(:pattern)
+      srl_source = cli_options[:pattern]
+      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)
-      result = SrlRuby.parse(srl_source)
-      destination = $stdout
-      if cli_options.include?(:output)
-        filepath = cli_options[:output]
-        destination = File.open(filepath, 'w')
-      end
-      puts "Writing to file '#{filepath}'" unless destination == $stdout
-      destination.puts emit_code(template, srl_source, result)
+      process_srl(srl_source)
     end
   end
 
@@ -79,6 +76,17 @@ class Srl2RubyProg
 
     exists
   end
+  
+  def process_srl(srl_source)
+    result = SrlRuby.parse(srl_source)
+    destination = $stdout
+    if cli_options.include?(:output)
+      filepath = cli_options[:output]
+      destination = File.open(filepath, 'w')
+    end
+    puts "Writing to file '#{filepath}'" unless destination == $stdout
+    destination.puts emit_code(template, srl_source, result)  
+  end
 
   def emit_code(template, srl_source, regexp)
     template.result(binding)

data/bin/srl2ruby_cli_parser.rb

@@ -13,6 +13,7 @@ class Srl2RubyCLIParser < OptionParser
 
     heading
     separator 'Options:'
+    add_p_option    
     add_o_option
     add_t_option
     separator ''
@@ -41,6 +42,7 @@ Description:
 
 Examples:
   #{program_name} example.srl
+  #{program_name} -p 'begin with literally "Hello world!"'
   #{program_name} example.srl -o example_re.rb -t srl_and_ruby.erb
 DESCR
 
@@ -61,6 +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  
 
   def add_t_option
     explanation = <<-EXPLANATION

data/features/uuid_validation.feature

@@ -0,0 +1,24 @@
+Feature: Defining a UUID validation pattern
+	As a shy Rubyist,
+  I want to use SRL to specify password pattern
+	So that I can use its regex representation in my code
+
+
+Scenario: defining a UUID validation expression
+  # The pattern is based on the 8-4-4-4-12 syntax
+  When I define the following SRL expression:
+  """
+  begin with (any of(digit, letter from a to f)) exactly 8 times,
+  literally "-",
+  (
+    (any of(digit, letter from a to f)) exactly 4 times,
+    literally "-"
+  ) exactly 3 times,
+  (any of(digit, letter from a to f)) exactly 12 times
+  """
+  Then I expect matching for:
+  | 123e4567-e89b-12d3-a456-426655440000 |
+  | 00112233-4455-6677-8899-aabbccddeeff |
+
+  And I expect no match for:
+  | 123e4567e89b12d3a456426655440000 |

data/lib/srl_ruby/version.rb

@@ -1,3 +1,3 @@
 module SrlRuby
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.4.1'.freeze
 end

data/srl_ruby.gemspec

@@ -46,8 +46,8 @@ Gem::Specification.new do |spec|
   spec.email         = ['famished.tiger@yahoo.com']
 
   spec.description   = <<-DESCR
-  A compiler that transforms highly readable Simple Regex Language patterns
-  into regular expressions.
+  A compiler and library that transforms highly readable Simple Regex Language 
+  patterns into regular expressions.
 DESCR
   spec.summary = <<-SUMMARY
   A parser for the [Simple Regex Language](https://simple-regex.com/).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: srl_ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-13 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rley
@@ -80,9 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: |2
-    A compiler that transforms highly readable Simple Regex Language patterns
-    into regular expressions.
+description: "  A compiler and library that transforms highly readable Simple Regex
+  Language \n  patterns into regular expressions.\n"
 email:
 - famished.tiger@yahoo.com
 executables:
@@ -120,6 +119,7 @@ files:
 - features/lib/support/env..rb
 - features/password_validation.feature
 - features/url_capturing.feature
+- features/uuid_validation.feature
 - lib/regex/abstract_method.rb
 - lib/regex/alternation.rb
 - lib/regex/anchor.rb