format_engine 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6e8a31da2b7b4563578c47c0356f8079f83de97
-  data.tar.gz: 50f0f2c2acb64b9174e4a1ba9a32c3b690688d3b
+  metadata.gz: 09f96049d5a1aec1f68f2c4f999c5c0138c0bd83
+  data.tar.gz: 26d8f175cb85f9307c2d0f93bebedc7dfe682bd6
 SHA512:
-  metadata.gz: 121d8da85416bf95fc3de8f563648036de5e658be5253c5224b0e7a7963be6905ab90c3d57b1842f03d2742cc7c1dbe93da6c96de42141dc484e12b1f6d5f87b
-  data.tar.gz: 7679f577c475743cd6bdd0958b29898f39f6d508da6b16ab88e18ff6e47e61807f61ca742f57ab44b3675b2917e56736342b02f5bd0837eb06d4eae87f116c9a
+  metadata.gz: d9f42b5c1a1e0ba22a89b3fb9531e9b4ed874d3f618b0b8cdbe47d393e4a8a978860a07efcf7cdb805bb32199bb2b4e597464aae413252da2795c7691c04dfca
+  data.tar.gz: c0d18a3b94da1251e12e1d66166f42359adb08553005e5bd0bad7c6d722f64946758a1706e9bc309ea9bb8f1a7802b8b0efe1520ab63770c1b9776710dd544f2

data/README.md

@@ -86,17 +86,19 @@ puts cust.strfmt('%f %l is %a years old.')
 ```
 ## Format Specification
 
-Format String Specification Syntax (BNF):
-
-* spec ::= (text | item | set)+
-* item ::= "%" flag* sign? (parm ("." parm)? )? command
-* set  ::= "%" flag* parm? "[" chrs "]"
-* flag ::= "~" | "@" | "#" | "&" | "^" | "&" | "*" | "=" | "?" | "_"
-| "<" | ">" | "\\" | "/" | "." | "," | "|" | "!"
-* sign ::= sign = ("+" | "-")
-* parm ::= ("0" .. "9")+
-* chrs ::= (not_any("]") | "\\" "]")+
-* command ::= ("a" .. "z" | "A" .. "Z")
+Format String Specification Syntax (Regex):
+
+    REGEX = %r{(?<lead>  (^|(?<=[^\\]))%){0}
+               (?<flags> [~@#$^&*\=?_<>|!]*){0}
+               (?<parms> [-+]?(\d+(\.\d+)?)?){0}
+               (?<var> \g<lead>\g<flags>\g<parms>[a-zA-Z]){0}
+               (?<set> \g<lead>\g<flags>\d*\[([^\]\\]|\\.)+\]){0}
+               (?<per> \g<lead>%){0}
+               \g<var> | \g<set> | \g<per>
+              }x
+
+Where _var_ describes a format specification, _set_ describes a regex
+set (or unset) specification, and _per_ describes a %% literal.
 
 ###Samples:
 
@@ -115,9 +117,15 @@ creates the following format specification array:
  Variable("%S", ["-5", "2"]),
  Literal("!")]
 ```
-Where literals are processed as themselves. If that literal ends with a space,
-that space will match zero or more spaces. Variables are executed by looking
-up the format string in the library and executing the corresponding block.
+Where literals are processed as themselves, except:
+* If that literal ends with a space, that space will parse zero or more spaces.
+When formatting, the trailing space is just another space.
+* A %% will be treated as a single % sign.
+* A backslash character will take the character that follows as a literal
+character. Thus \\% is equivalent to %%.
+
+Variables are executed by looking up the format string (without the width or
+precision fields) in the library and executing the corresponding block.
 
 **Note:** If a format string does not correspond to an entry in the library,
 an exception occurs.

data/lib/format_engine/engine.rb

@@ -59,7 +59,7 @@ module FormatEngine
     #* spec_str - The format specification string.
     #* block - A code block performed for each format specification.
     def due_process(spec_info, spec_str)
-      format_spec = FormatSpec.get_spec(spec_str).validate(self)
+      format_spec = FormatSpec.get_spec(spec_str)
 
       spec_info.instance_exec(&self[:before])
 

data/lib/format_engine/format_spec/literal.rb

@@ -8,8 +8,8 @@ module FormatEngine
 
     # Set up a literal format specification.
     def initialize(literal)
-      @literal  = literal
-      @head     = literal.rstrip
+      @literal  = literal.gsub(/\\./) {|seq| seq[-1]}
+      @head     = @literal.rstrip
       @has_tail = @head != @literal
     end
 
@@ -18,11 +18,6 @@ module FormatEngine
       0
     end
 
-    # Is this literal supported by the engine? YES!
-    def validate(_engine)
-      self
-    end
-
     # Format onto the output string
     def do_format(spec_info)
       spec_info.dst << @literal

data/lib/format_engine/format_spec/set.rb

@@ -33,12 +33,6 @@ module FormatEngine
       @regex = Regexp.new("#{set}#{qualifier}")
     end
 
-    #Is this variable supported by the engine?
-    def validate(engine)
-      fail "Unsupported tag = #{format.inspect}" unless engine[format]
-      self
-    end
-
     #Format onto the output string
     def do_format(spec_info)
       fail "The tag %{@raw} may not be used in formatting."
@@ -46,7 +40,11 @@ module FormatEngine
 
     #Parse from the input string
     def do_parse(spec_info)
-      spec_info.instance_exec(&spec_info.engine[self.format])
+      unless (block = spec_info.engine[format])
+        fail "Unsupported tag = #{format.inspect}"
+      end
+
+      spec_info.instance_exec(&block)
     end
 
     #Inspect for debugging.

data/lib/format_engine/format_spec/variable.rb

@@ -31,12 +31,6 @@ module FormatEngine
       end
     end
 
-    #Is this variable supported by the engine?
-    def validate(engine)
-      fail "Unsupported tag = #{format.inspect}" unless engine[format]
-      self
-    end
-
     #Has a width been specified?
     def has_width?
       parms
@@ -69,12 +63,12 @@ module FormatEngine
 
     #Format onto the output string
     def do_format(spec_info)
-      spec_info.instance_exec(&spec_info.engine[self.format])
+      spec_info.instance_exec(&get_block(spec_info.engine))
     end
 
     #Parse from the input string
     def do_parse(spec_info)
-      spec_info.instance_exec(&spec_info.engine[self.format])
+      spec_info.instance_exec(&get_block(spec_info.engine))
     end
 
     #Inspect for debugging.
@@ -82,6 +76,14 @@ module FormatEngine
       "Variable(#{format.inspect}, #{parms.inspect})"
     end
 
+    private
+
+    #Get the execution block from the engine.
+    def get_block(engine)
+      block = engine[format]
+      fail "Unsupported tag = #{format.inspect}" unless block
+      block
+    end
   end
 
 end

data/lib/format_engine/format_spec.rb

@@ -9,11 +9,12 @@ module FormatEngine
   #The format string parser.
   class FormatSpec
     #The regex used to parse variable specifications.
-    REGEX = %r{(?<flags> [~@#$^&*\=?_<>\\\/\.,\|!]*){0}
+    REGEX = %r{(?<lead>  (^|(?<=[^\\]))%){0}
+               (?<flags> [~@#$^&*\=?_<>|!]*){0}
                (?<parms> [-+]?(\d+(\.\d+)?)?){0}
-               (?<var> %\g<flags>\g<parms>[a-zA-Z]){0}
-               (?<set> %\g<flags>\d*\[([^\]\\]|\\.)+\]){0}
-               (?<per> %%){0}
+               (?<var> \g<lead>\g<flags>\g<parms>[a-zA-Z]){0}
+               (?<set> \g<lead>\g<flags>\d*\[([^\]\\]|\\.)+\]){0}
+               (?<per> \g<lead>%){0}
                \g<var> | \g<set> | \g<per>
               }x
 

data/lib/format_engine/version.rb

@@ -1,5 +1,5 @@
 
 module FormatEngine
   # The version of the format_engine gem.
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

data/tests/format_spec_tests.rb

@@ -16,6 +16,14 @@ class FormatSpecTester < Minitest::Test
     assert_equal("ABCDEFG!", test.specs[0].literal)
   end
 
+  def test_that_backslash_quotes
+    test = FormatEngine::FormatSpec.get_spec "ABC\\%DEFG!"
+    assert_equal(Array, test.specs.class)
+    assert_equal(1, test.specs.length)
+    assert_equal(FormatEngine::FormatLiteral, test.specs[0].class)
+    assert_equal("ABC%DEFG!", test.specs[0].literal)
+  end
+
   def test_that_it_scans_simple_variable_formats
     test = FormatEngine::FormatSpec.get_spec "%A"
     assert_equal(Array, test.specs.class)
@@ -80,7 +88,7 @@ class FormatSpecTester < Minitest::Test
   end
 
   def test_that_it_scans_option_variable_formats
-    "~@#&^&*-+=?_<>\\/.,|".each_char do |char|
+    "~@#&^&*-+=?_<>|".each_char do |char|
       test = FormatEngine::FormatSpec.get_spec "%#{char}A"
       assert_equal(Array, test.specs.class)
       assert_equal(1, test.specs.length)
@@ -182,16 +190,6 @@ class FormatSpecTester < Minitest::Test
     assert_equal(")", test.specs[6].literal)
   end
 
-  def test_that_it_validates
-    engine = { "%A" => true, "%B" => true }
-
-    test = FormatEngine::FormatSpec.get_spec "%A and %B"
-    assert_equal(test, test.validate(engine))
-
-    test = FormatEngine::FormatSpec.get_spec "%A and %C"
-    assert_raises(RuntimeError) { test.validate(engine) }
-  end
-
   def test_that_it_caches
     t1 = FormatEngine::FormatSpec.get_spec "%123.456A"
     t2 = FormatEngine::FormatSpec.get_spec "%123.456A"

data/tests/formatter_engine_tests.rb

@@ -62,13 +62,4 @@ class FormatterTester < Minitest::Test
     assert_raises(RuntimeError) { engine.do_format(obj, spec) }
   end
 
-  def test_that_it_validates_before_before
-    engine, obj, spec = make_all("Name = %f %j")
-    test = 1
-    engine[:before] = lambda { test = 2 }
-
-    assert_raises(RuntimeError) { engine.do_format(obj, spec) }
-    assert_equal(1, test)
-  end
-
 end

data/tests/literal_spec_tests.rb

@@ -8,11 +8,6 @@ class LiteralSpecTester < Minitest::Test
   #Track mini-test progress.
   MinitestVisible.track self, __FILE__
 
-  def test_that_it_validates_always
-    test = FormatEngine::FormatLiteral.new("Test 1 2 3")
-    assert_equal(test, test.validate(nil))
-  end
-
   def test_that_it_formats
     spec_info = FormatEngine::SpecInfo.new(nil, "", nil)
     test = FormatEngine::FormatLiteral.new("Test 1 2 3")

data/tests/variable_spec_tests.rb

@@ -8,16 +8,6 @@ class VariableSpecTester < Minitest::Test
   #Track mini-test progress.
   MinitestVisible.track self, __FILE__
 
-  def test_that_it_validates
-    engine = { "%A" => true }
-
-    test = FormatEngine::FormatVariable.new("%A")
-    assert_equal(test, test.validate(engine))
-
-    test = FormatEngine::FormatVariable.new("%B")
-    assert_raises(RuntimeError) { test.validate(engine) }
-  end
-
   def test_the_parms
     test = FormatEngine::FormatVariable.new("%B")
     refute(test.has_width?)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: format_engine
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-06 00:00:00.000000000 Z
+date: 2016-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,3 +145,4 @@ signing_key:
 specification_version: 4
 summary: An engine for string formatting and parsing.
 test_files: []
+has_rdoc: