format_engine 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d7dfb82f1660f588d8c962202bc052410d0103a
-  data.tar.gz: afc3a10a88f09024a9d37493bf77308be189473b
+  metadata.gz: dbd9eddd61c278dea142573e9edc3ff65aa622f9
+  data.tar.gz: 5d4637bb827e30c3230cb44b9f4e02d8640af24e
 SHA512:
-  metadata.gz: 5f0d437c4b5d083b40287823fe705cb3a09871b68b8ed8805eb09e64f5d28dbb80779fb5f471f261d1ff9e84d0ba4fcd01c8f0ee78fd32b7bc0fcaa4201a585d
-  data.tar.gz: 110691ceb8a920df1b626febe8f803402e2b8ad48fe7934bf5cd06a6f0d84e8f04bcacd404c2c885a1fa9da7ccfc4fbf432585ce5089345bf5bac18e432f60a1
+  metadata.gz: ec88dfaf16365f492b9ab47f15885a476218e7e610a74726b9199d077a5ae061579304d5f6d7aceb8612d39abb8757c3003731d8f223d04fc07aa188158fbe0d
+  data.tar.gz: 8c4926a9a3abba6ac9fc2b36155e08a8f987714201da795891106aab22ade47887b4ed2aa9a731d21158591649272513e742e26739de4b0a22af27bd74dd4d82

data/README.md

@@ -88,12 +88,15 @@ puts cust.strfmt('%f %l is %a years old.')
 
 Format String Specification Syntax (BNF):
 
-* spec = ( text | item )+
-* item = "%" flag* ("+" | "-")?(parm ("." parm)?)? command
-* flag = "~"|"@"|"#"|"&"|"^"|"&"|"*"|"="|"?"|"_"|"<"|">"|"\\"|"/"|"."|","|"|"|"!"
-* parm = ("0" .. "9")+
-* command = ("a" .. "z" | "A" .. "Z")
-
+* 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")
 
 ###Samples:
 

data/lib/format_engine.rb

@@ -2,10 +2,10 @@
 
 require 'English'
 
-require 'format_engine/format_spec'
-require 'format_engine/engine'
-require 'format_engine/spec_info'
-require 'format_engine/attr_formatter'
-require 'format_engine/attr_parser'
+require_relative 'format_engine/format_spec'
+require_relative 'format_engine/engine'
+require_relative 'format_engine/spec_info'
+require_relative 'format_engine/attr_formatter'
+require_relative 'format_engine/attr_parser'
 
-require 'format_engine/version'
+require_relative 'format_engine/version'

data/lib/format_engine/engine.rb

@@ -3,24 +3,27 @@ module FormatEngine
   # The engine class of the format engine.
   class Engine
 
+    #The parse library
+    attr_reader :library
+
     #Set up base data structures.
     def initialize(library)
-      @lib = library
+      @library = library
 
       #Set up defaults for pre and post amble blocks.
       nop = lambda { }
-      @lib[:before] ||= nop
-      @lib[:after]  ||= nop
+      @library[:before] ||= nop
+      @library[:after]  ||= nop
     end
 
     # Get an entry from the library
     def [](index)
-      @lib[index]
+      @library[index]
     end
 
     # Set an entry in the library
     def []=(index, value)
-      @lib[index] = value
+      @library[index] = value
     end
 
     #Do the actual work of building the formatted output.

data/lib/format_engine/format_spec.rb

@@ -1,14 +1,20 @@
+#Analysis of format/parse specification strings.
+
 require_relative 'format_spec/literal'
 require_relative 'format_spec/variable'
+require_relative 'format_spec/set'
 
 # Format String Specification Syntax (BNF):
-#  spec = (text | item)+
-#  item = "%" flag* (parm ("." parm)? )? command
+#  spec = (text | item | set)+
+#  item = "%" flag* sign? (parm ("." parm)? )? command
+#  set  = "%" flag* parm? "[" chrs "]"
 #  flag = ( "~" | "@" | "#" | "&" | "^"  |
 #           "&" | "*" | "-" | "+" | "="  |
 #           "?" | "_" | "<" | ">" | "\\" |
 #           "/" | "." | "," | "|" | "!"  )
+#  sign = ("+" | "-")
 #  parm = ("0" .. "9" )+
+#  chrs = (not_any("]") | "\\" "]")+
 #  command = ("a" .. "z" | "A" .. "Z")
 #
 #  Sample: x = FormatSpec.get_spec "Elapsed = %*3.1H:%02M!"
@@ -18,10 +24,12 @@ module FormatEngine
   #The format string parser.
   class FormatSpec
     #The regex used to parse variable specifications.
-    VAR_REGEX = %r{(?<flags> [~@#$^&*\=?_<>\\\/\.,\|!]*){0}
-                   (?<parms> [-+]?(\d+(\.\d+)?)?){0}
-                   (%\g<flags>\g<parms>[a-zA-Z])
-                  }x
+    REGEX = %r{(?<flags> [~@#$^&*\=?_<>\\\/\.,\|!]*){0}
+               (?<parms> [-+]?(\d+(\.\d+)?)?){0}
+               (?<var> %\g<flags>\g<parms>[a-zA-Z]){0}
+               (?<set> %\g<flags>\d*\[([^\]]|\\\])+\]){0}
+               \g<var> | \g<set>
+              }x
 
     #Don't use new, use get_spec instead.
     private_class_method :new
@@ -47,10 +55,17 @@ module FormatEngine
     #Scan the format string extracting literals and variables.
     def scan_spec(fmt_string)
       until fmt_string.empty?
-        if fmt_string =~ VAR_REGEX
-          @specs << FormatLiteral.new($PREMATCH) unless $PREMATCH.empty?
-          @specs << FormatVariable.new($MATCH)
-          fmt_string  =  $POSTMATCH
+        if (match_data = REGEX.match(fmt_string))
+          mid = match_data.to_s
+          pre = match_data.pre_match
+
+          @specs << FormatLiteral.new(pre) unless pre.empty?
+          @specs << case
+                    when match_data[:var] then FormatVariable.new(mid)
+                    when match_data[:set] then FormatSet.new(mid)
+                    else fail "Impossible case in scan_spec."
+                    end
+          fmt_string = match_data.post_match
         else
           @specs << FormatLiteral.new(fmt_string)
           fmt_string = ""

data/lib/format_engine/format_spec/set.rb

@@ -0,0 +1,55 @@
+module FormatEngine
+
+  #A format engine set specification.
+  class FormatSet
+
+    #The fixed part of this set specification.
+    attr_reader :format
+
+    #The regular expression part of this set specification.
+    attr_reader :regex
+
+    #Setup a variable format specification.
+    def initialize(format)
+      @raw = format
+
+      if format =~ /(\d+)(?=\[)/
+        qualifier = "{1,#{$MATCH}}"
+        @format   = $PREMATCH + "["
+        set       = $POSTMATCH
+      elsif format =~ /\[/
+        qualifier = "+"
+        @format   = $PREMATCH + $MATCH
+        set       = $MATCH + $POSTMATCH
+      else
+        fail "Invalid set string #{format}"
+      end
+
+      @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."
+    end
+
+    #Parse from the input string
+    def do_parse(spec_info)
+      spec_info.fmt = self
+      spec_info.instance_exec(&spec_info.engine[self.format])
+    end
+
+    #Inspect for debugging.
+    def inspect
+      "Set(#{format.inspect}, #{regex.inspect})"
+    end
+
+  end
+
+end

data/lib/format_engine/format_spec/variable.rb

@@ -67,6 +67,12 @@ module FormatEngine
       has_prec? ? parms[1] : ""
     end
 
+    #Build up a regular expression for parsing.
+    def regex(base)
+      qualifier = has_width? ? "{1,#{width}}": "+"
+      Regexp.new("#{base}#{qualifier}")
+    end
+
     #Format onto the output string
     def do_format(spec_info)
       spec_info.fmt = self

data/lib/format_engine/version.rb

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

data/sire.rb

@@ -0,0 +1,85 @@
+# coding: utf-8
+# A Simple Interactive Ruby Environment
+
+require_relative 'lib/format_engine'
+
+$no_alias_read_line_module = true
+require 'mini_readline'
+require 'pp'
+
+class Object
+  #Generate the class lineage of the object.
+  def classes
+    begin
+      result = ""
+      klass  = self.instance_of?(Class) ? self : self.class
+
+      begin
+        result << klass.to_s
+        klass = klass.superclass
+        result << " < " if klass
+      end while klass
+
+      result
+    end
+  end
+end
+
+class SIRE
+  #Set up the interactive session.
+  def initialize
+    @_done = false
+
+    puts "Welcome to a Simple Interactive Ruby Environment\n"
+    puts "FormatEngine version = #{FormatEngine::VERSION}"
+    puts "Use command 'q' to quit.\n\n"
+  end
+
+  #Quit the interactive session.
+  def q
+    @_done = true
+    puts
+    "Bye bye for now!"
+  end
+
+  def fs
+    FormatEngine::FormatSpec
+  end
+
+  #Execute a single line.
+  def exec_line(line)
+    result = eval line
+    pp result unless line.length == 0
+
+  rescue Interrupt => e
+    @_break = true
+    puts "\nExecution Interrupted!"
+    puts "\n#{e.class} detected: #{e}\n"
+    puts e.backtrace
+    puts "\n"
+
+  rescue Exception => e
+    @_break = true
+    puts "\n#{e.class} detected: #{e}\n"
+    puts e.backtrace
+    puts
+  end
+
+  #Run the interactive session.
+  def run_sire
+    until @_done
+      @_break = false
+      exec_line(MiniReadline.readline('SIRE>', true))
+    end
+
+    puts "\n\n"
+
+  rescue Interrupt => e
+    puts "\nInterrupted! Program Terminating."
+  end
+
+end
+
+if __FILE__ == $0
+  SIRE.new.run_sire
+end

data/tests/format_spec_tests.rb

@@ -25,6 +25,43 @@ class FormatSpecTester < Minitest::Test
     assert_equal(nil, test.specs[0].parms)
   end
 
+  def test_that_it_scans_set_formats
+    test = FormatEngine::FormatSpec.get_spec "%[A]"
+    assert_equal(Array, test.specs.class)
+    assert_equal(1, test.specs.length)
+    assert_equal(FormatEngine::FormatSet, test.specs[0].class)
+    assert_equal("%[", test.specs[0].format)
+    assert_equal(/[A]+/, test.specs[0].regex)
+
+    test = FormatEngine::FormatSpec.get_spec "%*[A]"
+    assert_equal(Array, test.specs.class)
+    assert_equal(1, test.specs.length)
+    assert_equal(FormatEngine::FormatSet, test.specs[0].class)
+    assert_equal("%*[", test.specs[0].format)
+    assert_equal(/[A]+/, test.specs[0].regex)
+
+    test = FormatEngine::FormatSpec.get_spec "%7[A]"
+    assert_equal(Array, test.specs.class)
+    assert_equal(1, test.specs.length)
+    assert_equal(FormatEngine::FormatSet, test.specs[0].class)
+    assert_equal("%[", test.specs[0].format)
+    assert_equal(/[A]{1,7}/, test.specs[0].regex)
+
+    test = FormatEngine::FormatSpec.get_spec "%*7[A]"
+    assert_equal(Array, test.specs.class)
+    assert_equal(1, test.specs.length)
+    assert_equal(FormatEngine::FormatSet, test.specs[0].class)
+    assert_equal("%*[", test.specs[0].format)
+    assert_equal(/[A]{1,7}/, test.specs[0].regex)
+  end
+
+  def test_a_mixed_set
+    test = FormatEngine::FormatSpec.get_spec "%f %l %[age] %a"
+    assert_equal(Array, test.specs.class)
+    assert_equal(7, test.specs.length)
+
+  end
+
   def test_that_it_scans_tab_seperators
     test = FormatEngine::FormatSpec.get_spec "%A\t%B"
     assert_equal(Array, test.specs.class)

data/tests/formatter_engine_tests.rb

@@ -32,6 +32,10 @@ class FormatterTester < Minitest::Test
     [make_formatter, make_person, make_spec(str)]
   end
 
+  def test_crazy
+    assert_equal("0.4.0", FormatEngine::VERSION)
+  end
+
   def test_that_it_can_format_normally
     engine, obj, spec = make_all("Name = %f %l %a")
     assert_equal("Name = Squidly Jones 21", engine.do_format(obj, spec))

data/tests/parser_engine_tests.rb

@@ -20,6 +20,7 @@ class ParserTester < Minitest::Test
       "%l"    => lambda { tmp[:ln] = found if parse(/(\w)+/ ) },
       "%L"    => lambda { tmp[:ln] = found.upcase if parse(/(\w)+/) },
       "%-L"   => lambda { tmp[:ln] = found.capitalize if parse(/(\w)+/) },
+      "%["    => lambda { parse! fmt.regex },
       "%t"    => lambda { parse("\t") },
       "%!t"   => lambda { parse!("\t") },
 
@@ -92,6 +93,18 @@ class ParserTester < Minitest::Test
     assert_equal(TestPerson, result.class)
     assert_equal("Squidly", result.first_name)
     assert_equal("Jones", result.last_name)
+    assert_equal(55, result.age)
+  end
+
+  def test_that_it_can_parse_sets
+    engine = make_parser
+    spec =  "%f %l %[age] %a"
+    result = engine.do_parse("Squidly Jones age 55", TestPerson, spec)
+
+    assert_equal(TestPerson, result.class)
+    assert_equal("Squidly", result.first_name)
+    assert_equal("Jones", result.last_name)
+    assert_equal(55, result.age)
   end
 
   def test_that_it_can_detect_errors

data/tests/scan_tests.rb

@@ -0,0 +1,95 @@
+require_relative '../lib/format_engine'
+gem              'minitest'
+require          'minitest/autorun'
+require          'minitest_visible'
+
+
+# Test the internals of the parser engine. This is not the normal interface.
+class ScanTester < Minitest::Test
+
+  #Track mini-test progress.
+  MinitestVisible.track self, __FILE__
+
+  def make_parser
+    FormatEngine::Engine.new(
+      "%d"    => lambda do
+        dst << found.to_i if parse(fmt.regex("\\d"))
+      end,
+
+      "%*d"   => lambda do
+        parse(fmt.regex("\\d"))
+      end,
+
+      "%["    => lambda do
+        dst << found if parse(fmt.regex)
+      end,
+
+      "%*["   => lambda do
+        parse(fmt.regex)
+      end)
+  end
+
+  def test_that_it_can_scan
+    engine = make_parser
+    spec = "%d %2d %4d"
+    result = engine.do_parse("12 34 56", [], spec)
+
+    assert_equal(Array, result.class)
+    assert_equal([12, 34, 56] , result)
+  end
+
+  def test_missing_data
+    engine = make_parser
+    spec = "%d %2d %4d %d"
+    result = engine.do_parse("12 34 56", [], spec)
+
+    assert_equal(Array, result.class)
+    assert_equal([12, 34, 56] , result)
+  end
+
+  def test_excess_data
+    engine = make_parser
+    spec = "%d %2d %4d"
+    result = engine.do_parse("12 34 56 78", [], spec)
+
+    assert_equal(Array, result.class)
+    assert_equal([12, 34, 56] , result)
+  end
+
+  def test_skipped_data
+    engine = make_parser
+    spec = "%d %2d %*d %d"
+    result = engine.do_parse("12 34 56 78", [], spec)
+
+    assert_equal(Array, result.class)
+    assert_equal([12, 34, 78] , result)
+  end
+
+  def test_packed_data
+    engine = make_parser
+    spec = "%2d %2d %2d"
+    result = engine.do_parse("123456", [], spec)
+
+    assert_equal(Array, result.class)
+    assert_equal([12, 34, 56] , result)
+  end
+
+  def test_some_sets
+    engine = make_parser
+    spec = "%5[truefals] %5[truefals] %5[truefals]"
+    result = engine.do_parse("true false true", [], spec)
+
+    assert_equal(Array, result.class)
+    assert_equal(["true", "false", "true"] , result)
+  end
+
+  def test_some_sets_with_skips
+    engine = make_parser
+    spec = "%5[truefals] %*5[truefals] %5[truefals]"
+    result = engine.do_parse("true false true", [], spec)
+
+    assert_equal(Array, result.class)
+    assert_equal(["true", "true"] , result)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: format_engine
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Peter Camilleri
@@ -101,6 +101,7 @@ files:
 - lib/format_engine/engine.rb
 - lib/format_engine/format_spec.rb
 - lib/format_engine/format_spec/literal.rb
+- lib/format_engine/format_spec/set.rb
 - lib/format_engine/format_spec/variable.rb
 - lib/format_engine/spec_info.rb
 - lib/format_engine/version.rb
@@ -110,12 +111,14 @@ files:
 - mocks/demo/demo_parse.rb
 - mocks/test_person_mock.rb
 - reek.txt
+- sire.rb
 - tests/engine_base_tests.rb
 - tests/format_engine_tests.rb
 - tests/format_spec_tests.rb
 - tests/formatter_engine_tests.rb
 - tests/literal_spec_tests.rb
 - tests/parser_engine_tests.rb
+- tests/scan_tests.rb
 - tests/variable_spec_tests.rb
 homepage: http://teuthida-technologies.com/
 licenses: