fop_lang 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62ded9f974ca670a6eca5d4b293f98195af25ab476e9b3571e7def5299499fa9
-  data.tar.gz: b53b6e276ee31f122571a096dd534ed5c1407d27384fab78d216886322751fcb
+  metadata.gz: 711af4fad2907616e057049dcb84bce16ffdb381b3601a387dc7260cc16057d3
+  data.tar.gz: 40da554ca0cb21f275748593921bdc616dcf8cdfe5d4fa31494f588f2c25d66c
 SHA512:
-  metadata.gz: 45509b09122e4f76f1f8219d8c0f094bc5ac77231dec25f6e0e9818932b68186d74c71dd74db80638dcfc9bae210892b563e660004cfd32c25f439c761c3edc2
-  data.tar.gz: 49c6153cf728e909e60bc8fa1f1214dcdd8f9532703c8bc3455999aac1aa421c629370e1c7669bc9a846b5886fa2f10b7f5b698426cae2830e73ca9623a32a4a
+  metadata.gz: 0253a6446b88b6de112f00a95c81f1d5f710a859998e5b3d8df21d64caecc8e013ab1edec2b68047558f8053ce135b60082078f85db1f7aa16a93b86aa487093
+  data.tar.gz: c7f0cb0387df52a3ea121e3e91a35e0444afe8862aabe054ec433d889955ee9221129fd0c07f7e36d6c71e6b9ab33f30cd16264447dfda24d29babb671112140

data/README.md

@@ -1,44 +1,75 @@
 # fop_lang
 
-Fop is a tiny expression language implemented in Ruby for text filtering and modification.
+Fop (Filter and OPperations language) is an experimental, tiny expression language in the vein of awk and sed. This is a Ruby implementation. It is useful for simultaneously matching and transforming text input.
 
-## Examples
+## Release Number Example
+
+This example takes in GitHub branch names, decides if they're release branches, and if so, increments the version number.
 
 ```ruby
-  f = Fop("release-{N}.{N+1}.{N=0}")
+  f = Fop('release-{N}.{N+1}.{N=0}')
 
-  puts f.apply("release-5.99.1")
-  =>           "release-5.100.0"
+  puts f.apply('release-5.99.1')
+  =>           'release-5.100.0'
 
-  puts f.apply("release-5")
+  puts f.apply('release-5')
   => nil
   # doesn't match the pattern
 ```
 
+## Anatomy of a Fop expression
+
+`Text Literal {Operation}`
+
+The above expression contains the only two parts of Fop (except for the wildcard and escape characters).
+
+**Text Literals**
+
+A text literal works how it sounds: the input must match it exactly. The only exception is the `*` (wildcard) character, which matches 0 or more of anything. Wildcards can be used anywhere except inside `{...}` (operations).
+
+If `\` (escape) is used before the special characters `*`, `{` or `}`, then that character is treated like a text literal. It's recommended to use single-quoted Ruby strings with Fop expressions that so you don't need to double-escape.
+
+**Operations**
+
+Operations are the interesting part of Fop, and are specified between `{` and `}`. An Operation can consist of one to three parts:
+
+1. Matching character class (required): Defines what characters the operation will match and operate on.
+  * `N` is the numeric class and will match one or more digits.
+  * `A` is the alpha class and will match one or more letters (lower or upper case).
+  * `W` is the word class and matches alphanumeric chars and underscores.
+  * `*` is the wildcard class and greedily matches everything after it.
+3. Operator (optional): What to do to the matching characters.
+  * `=` Replace the matching character(s) with the given argument. If no argument is given, drop the matching chars.
+  * `+` Perform addition on the matching number and the argument (`N` only).
+  * `-` Subtract the argument from the matching number (`N` only).
+5. Operator argument (required for some operators): meaning varies by operator.
+
+## More Examples
+
 ```ruby
-  f = Fop("release-{N=5}.{N+1}.{N=0}")
+  f = Fop('release-{N=5}.{N+1}.{N=0}')
 
-  puts f.apply("release-4.99.1")
-  =>           "release-5.100.0"
+  puts f.apply('release-4.99.1')
+  =>           'release-5.100.0'
 ```
 
 ```ruby
-  f = Fop("release-*{N=5}.{N+100}.{N=0}")
+  f = Fop('release-*{N=5}.{N+100}.{N=0}')
 
-  puts f.apply("release-foo-4.100.1")
-  =>           "release-foo-5.200.0"
+  puts f.apply('release-foo-4.100.1')
+  =>           'release-foo-5.200.0'
 ```
 
 ```ruby
-  f = Fop("release-{N=5}.{N+1}.{N=0}{*=}")
+  f = Fop('release-{N=5}.{N+1}.{N=0}{*=}')
 
-  puts f.apply("release-4.100.1.foo.bar")
-  =>           "release-5.101.0"
+  puts f.apply('release-4.100.1.foo.bar')
+  =>           'release-5.101.0'
 ```
 
 ```ruby
-  f = Fop("{W=version}-{N=5}.{N+1}.{N=0}")
+  f = Fop('{W=version}-{N=5}.{N+1}.{N=0}')
 
-  puts f.apply("release-4.100.1")
-  =>           "version-5.101.0"
+  puts f.apply('release-4.100.1')
+  =>           'version-5.101.0'
 ```

data/lib/fop/nodes.rb

@@ -15,6 +15,7 @@ module Fop
     Match = Struct.new(:wildcard, :tokens) do
       NUM = "N".freeze
       WORD = "W".freeze
+      ALPHA = "A".freeze
       WILD = "*".freeze
       BLANK = "".freeze
 
@@ -37,7 +38,8 @@ module Fop
         @regex =
           case @match
           when NUM then Regexp.new((wildcard ? ".*?" : "^") + "[0-9]+")
-          when WORD then Regexp.new((wildcard ? ".*?" : "^") + "[a-zA-Z]+")
+          when WORD then Regexp.new((wildcard ? ".*?" : "^") + "\\w+")
+          when ALPHA then Regexp.new((wildcard ? ".*?" : "^") + "[a-zA-Z]+")
           when WILD then /.*/
           else raise ParserError, "Unknown match type '#{@match}'"
           end

data/lib/fop/version.rb

@@ -1,3 +1,3 @@
 module Fop
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fop_lang
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jordan Hollinger