format_engine 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4ae6ded21313ff4d99c029eb6e278e5f5de82e8
-  data.tar.gz: 6c3db7919e7a21366f7ca7d835a86b37e1404719
+  metadata.gz: de6ff33cc2d740c1ac1721bc6f2a40bf745208b0
+  data.tar.gz: 9ef57766216651bd454e32ff5cecb8d0c187c39e
 SHA512:
-  metadata.gz: f7cfb0b7d0bd449b0996d281bb59989fa5578a752007cd7b1d9add50e765bc3658054456898dec3ded0d83cfe50aae84f33ce91934bab3fe787d43e6de769995
-  data.tar.gz: bca710cf89db0b058a24b35a735902b1f33ca7db0e3f001ee4c7f2b105ee9c51c0e7fabf430d888806f5f02c0e33083a7fed23a0b09374ee5f6937a063b31f5d
+  metadata.gz: 915a1c8a1bcda84ae78e197f990a67519511be97174b36574028af18fded89589bf3425cb666c23e85508057fa876c521038c390d2c164a10e8926caa9f3f972
+  data.tar.gz: 8d80d8e21223443b3806633d7b2ccbf1fbd714a2488c1dd3a67a8096a988eaba26cd04f9b38e0bca0cb42261394bd1927b98213802335d5e30d9ea496e3bf5a0

data/README.md

@@ -52,17 +52,17 @@ class Customer
 
   #Demo defn of the strfmt method for formatted string output!
   attr_formatter :strfmt,
-  {"%a"  => lambda {cat "%#{fmt.width_str}d" % src.age },
-   "%f"  => lambda {cat "%#{fmt.width_str}s" % src.first_name },
-   "%l"  => lambda {cat "%#{fmt.width_str}s" % src.last_name  }
+  {"%a" => lambda {cat "%#{fmt.width_str}d" % src.age },
+   "%f" => lambda {cat "%#{fmt.width_str}s" % src.first_name },
+   "%l" => lambda {cat "%#{fmt.width_str}s" % src.last_name  }
   }
 
   #Demo defn of the strprs method for formatted string input!
   attr_parser :strprs,
-  {"%a"    => lambda { tmp[:age] = found.to_i if parse(/(\d)+/ ) },
-   "%f"    => lambda { tmp[:fn] = found if parse(/(\w)+/ ) },
-   "%l"    => lambda { tmp[:ln] = found if parse(/(\w)+/ ) },
-   :after  => lambda { set dst.new(tmp[:fn], tmp[:ln], tmp[:age]) }
+  {"%a"   => lambda { tmp[:age] = found.to_i if parse(/(\d)+/ ) },
+   "%f"   => lambda { tmp[:fn] = found if parse(/(\w)+/ ) },
+   "%l"   => lambda { tmp[:ln] = found if parse(/(\w)+/ ) },
+   :after => lambda { set dst.new(tmp[:fn], tmp[:ln], tmp[:age]) }
   }
 
   #Create an instance of the demo customer.
@@ -75,7 +75,7 @@ end
 
 cust = Customer.strprs('Jane, Smith 22', "%f, %l %a")
 
-# snd still in another part of Gotham City...
+# and in another part of Gotham City...
 
 puts cust.strfmt('%f %l is %a years old.')
 
@@ -88,34 +88,58 @@ puts cust.strfmt('%f %l is %a years old.')
 
 Format String Specification Syntax (Regex):
 
+The parsing of format specification strings is based on the following regular
+expression. This expression is applied repeatedly until all the specifications
+have been extracted from the input string.
+
     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}
+               (?<flags> [~@#$^&*=?_<>|!]*){0}
+
+               (?<var> \g<lead>\g<flags>[-+]?(\d+(\.\d+)?)?[a-zA-Z]){0}
+               (?<set> \g<lead>\g<flags>(\d+(,\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.
+### Var
+A format specification of the classical form:
+
+    %[flags][+/-][width[.precision]]letter
+
+### Set
+A reguluar expression set (or un-set) of the form:
+
+  %[flags][[min_width,]max_width]"["[^]set_chars"]"
 
-###Samples:
+### Per
+A %% which evaluates to a literal character %.
+
+### Literal
+Text in between the various format specifications is treated as literal text.
+
+###Format Internals:
 
 The format specification:
 ```ruby
-"Elapsed = %*02H:%M:%-5.2S!"
+"Elapsed = %*02H:%M:%-5.2S %d%% %@1[!?]"
 ```
 creates the following format specification array:
 
 ```ruby
-[Literal("Elapsed = "),
- Variable("%*H", ["02"]),
- Literal(":"),
- Variable("%M", nil).
- Literal(":"),
- Variable("%S", ["-5", "2"]),
- Literal("!")]
+#<FormatEngine::FormatSpec:0x1b4e288
+ @specs=
+  [Literal("Elapsed = "),
+   Variable("%*H", ["02"]),
+   Literal(":"),
+   Variable("%M", nil),
+   Literal(":"),
+   Variable("%S", ["-5", "2"]),
+   Literal(" "),
+   Variable("%d", nil),
+   Literal("%"),
+   Literal(" "),
+   Set("%@[!?]", "%@[", /[!?]{1,1}/)]>
 ```
 Where literals are processed as themselves, except:
 * If that literal ends with a space, that space will parse zero or more spaces.
@@ -125,7 +149,14 @@ When formatting, the trailing space is just another space.
 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.
+precision fields) in the library and executing the corresponding block. The
+format string can be seen in the above sample as the first string in the
+Variable
+
+Sets work by looking into the input string with their regular expression. Sets
+are only ever used when parsing, never for formatting. Sets are executed by
+first looking up their long name, listed first, and then if the long name is not
+found, their short name, listed second is tried.
 
 **Note:** If a format string does not correspond to an entry in the library,
 an exception occurs.
@@ -160,6 +191,7 @@ Methods
 * set - Set the return value of the parsing operation to the value that follows.
 * parse - Look for the string or regex parm that follows. Return the data found or nil.
 * parse! - Like parse but raises an exception (with optional msg) if not found.
+* grab - Grab some text based on the width of the format.
 * found? - Did the last parse succeed?
 * found - The text found by the last parse (or parse!) operation.
 
@@ -174,17 +206,6 @@ fmt attribute, has itself, the following attributes:
 * prec_str - The actual precision text or an empty string.
 * parm_str - The actual parameter (width and precision) text or an empty string.
 
-## Philosophy
-
-When designing this gem, a concerted effort has been applied to keeping it as
-simple as possible. To this end, many subtle programming techniques have been
-avoided in favor of simpler, more obvious approaches. This is based on the
-observation that I don't trust code that I don't understand and I avoid code
-that I don't trust.
-
-Feedback on the convenience/clarity balance as well as any other topics are
-most welcomed.
-
 ## Contributing
 
 #### Plan A
@@ -200,7 +221,7 @@ most welcomed.
 Go to the GitHub repository and raise an issue calling attention to some
 aspect that could use some TLC or a suggestion or idea. Apply labels to
 the issue that match the point you are trying to make. Then follow your
-issue and keep up-to-date as it is worked on. Or not as pleases you.
-All input are greatly appreciated.
+issue and keep up-to-date as it is worked on. All input are greatly
+appreciated.
 
 

data/lib/format_engine/engine.rb

@@ -9,6 +9,7 @@ module FormatEngine
     #Set up base data structures.
     def initialize(library)
       @library = library
+      @spec_pool = {}
 
       #Set up defaults for pre and post amble blocks.
       nop = lambda { }
@@ -59,7 +60,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)
+      format_spec = get_spec(spec_str)
 
       spec_info.instance_exec(&self[:before])
 
@@ -72,5 +73,10 @@ module FormatEngine
       spec_info.dst
     end
 
+    #Get a format specification with caching.
+    def get_spec(spec_str)
+      @spec_pool[spec_str] ||= FormatSpec.new(spec_str).validate(self)
+    end
+
   end
 end

data/lib/format_engine/format_spec/literal.rb

@@ -18,6 +18,11 @@ module FormatEngine
       0
     end
 
+    #Is this format item supported by the engine's library?
+    def validate(_engine)
+      true
+    end
+
     # Format onto the output string
     def do_format(spec_info)
       spec_info.dst << @literal

data/lib/format_engine/format_spec/set.rb

@@ -3,8 +3,11 @@ module FormatEngine
   #A format engine set specification.
   class FormatSet
 
-    #The fixed part of this set specification.
-    attr_reader :format
+    #The full name of the set.
+    attr_reader :long_name
+
+    #The short form name of the set.
+    attr_reader :short_name
 
     #The regular expression part of this set specification.
     attr_reader :regex
@@ -18,14 +21,16 @@ module FormatEngine
     def initialize(format)
       @raw = format
 
-      if format =~ /(\d+)(?=\[)/
-        qualifier = "{1,#{$MATCH}}"
-        @format   = $PREMATCH + "["
-        set       = $POSTMATCH
+      if (match_data = /(\d+,)?(\d+)(?=\[)/.match(format))
+        qualifier   = "{#{match_data[1] || "1,"}#{match_data[2]}}"
+        @short_name = match_data.pre_match + "["
+        @long_name  = match_data.pre_match + match_data.post_match
+        set         = match_data.post_match
       elsif format =~ /\[/
-        qualifier = "+"
-        @format   = $PREMATCH + $MATCH
-        set       = $MATCH + $POSTMATCH
+        qualifier   = "+"
+        @short_name = $PREMATCH + $MATCH
+        @long_name  = format
+        set         = $MATCH + $POSTMATCH
       else
         fail "Invalid set string #{format}"
       end
@@ -33,6 +38,13 @@ module FormatEngine
       @regex = Regexp.new("#{set}#{qualifier}")
     end
 
+    #Is this format item supported by the engine's library?
+    def validate(engine)
+      @block = engine[@long_name] || engine[@short_name]
+      fail "Unsupported tag = #{@raw.inspect}" unless @block
+      true
+    end
+
     #Format onto the output string
     def do_format(spec_info)
       fail "The tag %{@raw} may not be used in formatting."
@@ -40,16 +52,12 @@ module FormatEngine
 
     #Parse from the input string
     def do_parse(spec_info)
-      unless (block = spec_info.engine[format])
-        fail "Unsupported tag = #{format.inspect}"
-      end
-
-      spec_info.instance_exec(&block)
+      spec_info.instance_exec(&@block)
     end
 
     #Inspect for debugging.
     def inspect
-      "Set(#{format.inspect}, #{regex.inspect})"
+      "Set(#{@long_name.inspect}, #{@short_name.inspect}, #{regex.inspect})"
     end
 
   end

data/lib/format_engine/format_spec/variable.rb

@@ -61,14 +61,21 @@ module FormatEngine
       has_prec? ? parms[1] : ""
     end
 
+    #Is this format item supported by the engine's library?
+    def validate(engine)
+      @block = engine[format]
+      fail "Unsupported tag = #{format.inspect}" unless @block
+      true
+    end
+
     #Format onto the output string
     def do_format(spec_info)
-      spec_info.instance_exec(&get_block(spec_info.engine))
+      spec_info.instance_exec(&@block)
     end
 
     #Parse from the input string
     def do_parse(spec_info)
-      spec_info.instance_exec(&get_block(spec_info.engine))
+      spec_info.instance_exec(&@block)
     end
 
     #Inspect for debugging.
@@ -76,14 +83,6 @@ 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

@@ -10,35 +10,28 @@ module FormatEngine
   class FormatSpec
     #The regex used to parse variable specifications.
     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}
+               (?<flags> [~@#$^&*=?_<>|!]*){0}
+               (?<var> \g<lead>\g<flags>[-+]?(\d+(\.\d+)?)?[a-zA-Z]){0}
+               (?<set> \g<lead>\g<flags>(\d+(,\d+)?)?\[([^\]\\]|\\.)+\]){0}
                (?<per> \g<lead>%){0}
                \g<var> | \g<set> | \g<per>
               }x
 
-    #Don't use new, use get_spec instead.
-    private_class_method :new
-
-    #Either get a format specification from the pool or create one.
-    def self.get_spec(fmt_string)
-      @spec_pool ||= {}
-      @spec_pool[fmt_string] ||= new(fmt_string)
-    end
-
     #The array of specifications that were extracted.
     attr_reader :specs
 
     #Set up an instance of a format specification.
-    #<br>Note
-    #This is a private method (rdoc gets it wrong). To create new instances of
-    #\FormatSpec do not use \FormatSpec.new, but use \FormatSpec.get_spec instead.
     def initialize(fmt_string)
       @specs = []
       scan_spec(fmt_string)
     end
 
+    # Validate the specs of this format against the engine.
+    def validate(engine)
+      specs.each {|item| item.validate(engine)}
+      self
+    end
+
     #Scan the format string extracting literals and variables.
     def scan_spec(fmt_string)
       until fmt_string.empty?

data/lib/format_engine/spec_info.rb

@@ -52,7 +52,7 @@ module FormatEngine
         head, tail = src, ""
       end
 
-      #Do the parse on the input string.
+      #Do the parse on the input string or regex.
       @prematch, @match, @postmatch = head.partition(target)
 
       #Analyze the results.

data/lib/format_engine/version.rb

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

data/sire.rb

@@ -29,6 +29,10 @@ class SIRE
   #Set up the interactive session.
   def initialize
     @_done = false
+    @_edit = MiniReadline::Readline.new(history: true,
+                                        auto_complete: true,
+                                        auto_source: MiniReadline::QuotedFileFolderSource,
+                                        eoi_detect: true)
 
     puts "Welcome to a Simple Interactive Ruby Environment\n"
     puts "FormatEngine version = #{FormatEngine::VERSION}"
@@ -69,12 +73,12 @@ class SIRE
   def run_sire
     until @_done
       @_break = false
-      exec_line(MiniReadline.readline('SIRE>', true))
+      exec_line(@_edit.readline(prompt: 'SIRE>'))
     end
 
     puts "\n\n"
 
-  rescue Interrupt => e
+  rescue MiniReadlineEOI, Interrupt => e
     puts "\nInterrupted! Program Terminating."
   end
 

data/tests/format_spec_tests.rb

@@ -9,7 +9,7 @@ class FormatSpecTester < Minitest::Test
   include MinitestVisible
 
   def test_that_it_scans_literal_formats
-    test = FormatEngine::FormatSpec.get_spec "ABCDEFG!"
+    test = FormatEngine::FormatSpec.new "ABCDEFG!"
     assert_equal(Array, test.specs.class)
     assert_equal(1, test.specs.length)
     assert_equal(FormatEngine::FormatLiteral, test.specs[0].class)
@@ -17,7 +17,7 @@ class FormatSpecTester < Minitest::Test
   end
 
   def test_that_backslash_quotes
-    test = FormatEngine::FormatSpec.get_spec "ABC\\%DEFG!"
+    test = FormatEngine::FormatSpec.new "ABC\\%DEFG!"
     assert_equal(Array, test.specs.class)
     assert_equal(1, test.specs.length)
     assert_equal(FormatEngine::FormatLiteral, test.specs[0].class)
@@ -25,7 +25,7 @@ class FormatSpecTester < Minitest::Test
   end
 
   def test_that_it_scans_simple_variable_formats
-    test = FormatEngine::FormatSpec.get_spec "%A"
+    test = FormatEngine::FormatSpec.new "%A"
     assert_equal(Array, test.specs.class)
     assert_equal(1, test.specs.length)
     assert_equal(FormatEngine::FormatVariable, test.specs[0].class)
@@ -34,44 +34,48 @@ class FormatSpecTester < Minitest::Test
   end
 
   def test_that_it_scans_set_formats
-    test = FormatEngine::FormatSpec.get_spec "%[A]"
+    test = FormatEngine::FormatSpec.new "%[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("%[", test.specs[0].short_name)
+    assert_equal("%[A]", test.specs[0].long_name)
     assert_equal(/[A]+/, test.specs[0].regex)
 
-    test = FormatEngine::FormatSpec.get_spec "%*[A]"
+    test = FormatEngine::FormatSpec.new "%*[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("%*[", test.specs[0].short_name)
+    assert_equal("%*[A]", test.specs[0].long_name)
     assert_equal(/[A]+/, test.specs[0].regex)
 
-    test = FormatEngine::FormatSpec.get_spec "%7[A]"
+    test = FormatEngine::FormatSpec.new "%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("%[", test.specs[0].short_name)
+    assert_equal("%[A]", test.specs[0].long_name)
     assert_equal(/[A]{1,7}/, test.specs[0].regex)
 
-    test = FormatEngine::FormatSpec.get_spec "%*7[A]"
+    test = FormatEngine::FormatSpec.new "%*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("%*[", test.specs[0].short_name)
+    assert_equal("%*[A]", test.specs[0].long_name)
     assert_equal(/[A]{1,7}/, test.specs[0].regex)
   end
 
   def test_a_mixed_set
-    test = FormatEngine::FormatSpec.get_spec "%f %l %[age] %a"
+    test = FormatEngine::FormatSpec.new "%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"
+    test = FormatEngine::FormatSpec.new "%A\t%B"
     assert_equal(Array, test.specs.class)
     assert_equal(3, test.specs.length)
 
@@ -89,7 +93,7 @@ class FormatSpecTester < Minitest::Test
 
   def test_that_it_scans_option_variable_formats
     "~@#&^&*-+=?_<>|".each_char do |char|
-      test = FormatEngine::FormatSpec.get_spec "%#{char}A"
+      test = FormatEngine::FormatSpec.new "%#{char}A"
       assert_equal(Array, test.specs.class)
       assert_equal(1, test.specs.length)
       assert_equal(FormatEngine::FormatVariable, test.specs[0].class)
@@ -103,7 +107,7 @@ class FormatSpecTester < Minitest::Test
   end
 
   def test_that_it_scans_single_variable_formats
-    test = FormatEngine::FormatSpec.get_spec "%123A"
+    test = FormatEngine::FormatSpec.new "%123A"
     assert_equal(Array, test.specs.class)
     assert_equal(1, test.specs.length)
     assert_equal(FormatEngine::FormatVariable, test.specs[0].class)
@@ -120,7 +124,7 @@ class FormatSpecTester < Minitest::Test
   end
 
   def test_that_it_scans_double_variable_formats
-    test = FormatEngine::FormatSpec.get_spec "%123.456A"
+    test = FormatEngine::FormatSpec.new "%123.456A"
     assert_equal(Array, test.specs.class)
     assert_equal(1, test.specs.length)
     assert_equal(FormatEngine::FormatVariable, test.specs[0].class)
@@ -138,7 +142,7 @@ class FormatSpecTester < Minitest::Test
   end
 
   def test_negative_variable_formats
-    test = FormatEngine::FormatSpec.get_spec "%-123.456A"
+    test = FormatEngine::FormatSpec.new "%-123.456A"
     assert_equal(Array, test.specs.class)
     assert_equal(1, test.specs.length)
     assert_equal(FormatEngine::FormatVariable, test.specs[0].class)
@@ -156,7 +160,7 @@ class FormatSpecTester < Minitest::Test
   end
 
   def test_multipart_formats
-    test = FormatEngine::FormatSpec.get_spec "T(%+02A:%3B:%4.1C)"
+    test = FormatEngine::FormatSpec.new "T(%+02A:%3B:%4.1C)"
 
     assert_equal(Array, test.specs.class)
     assert_equal(7, test.specs.length)
@@ -190,16 +194,4 @@ class FormatSpecTester < Minitest::Test
     assert_equal(")", test.specs[6].literal)
   end
 
-  def test_that_it_caches
-    t1 = FormatEngine::FormatSpec.get_spec "%123.456A"
-    t2 = FormatEngine::FormatSpec.get_spec "%123.456A"
-    assert(t1.object_id == t2.object_id)
-
-    t3 = FormatEngine::FormatSpec.get_spec "%123.457A"
-    assert(t1.object_id != t3.object_id)
-
-    t4 = FormatEngine::FormatSpec.get_spec "%123.457A"
-    assert(t4.object_id == t3.object_id)
-  end
-
 end

data/tests/set_spec_tests.rb

@@ -0,0 +1,25 @@
+require_relative '../lib/format_engine'
+gem              'minitest'
+require          'minitest/autorun'
+require          'minitest_visible'
+
+class SetSpecTester < Minitest::Test
+
+  #Track mini-test progress.
+  include MinitestVisible
+
+  def test_the_parms
+    test = FormatEngine::FormatSet.new("%[ABC]")
+    assert_equal(0, test.width)
+    assert_equal(/[ABC]+/, test.regex)
+
+    test = FormatEngine::FormatSet.new("%10[ABC]")
+    assert_equal(0, test.width)
+    assert_equal(/[ABC]{1,10}/, test.regex)
+
+    test = FormatEngine::FormatSet.new("%5,10[ABC]")
+    assert_equal(0, test.width)
+    assert_equal(/[ABC]{5,10}/, test.regex)
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: format_engine
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,6 +119,7 @@ files:
 - tests/literal_spec_tests.rb
 - tests/parser_engine_tests.rb
 - tests/scan_tests.rb
+- tests/set_spec_tests.rb
 - tests/variable_spec_tests.rb
 homepage: http://teuthida-technologies.com/
 licenses: