format_engine 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53a90dc85e96a48d8f1b469ef5749f63102a4230
-  data.tar.gz: 6555ef6261b11cd7feb5fe996b3e5143d593271b
+  metadata.gz: 9763561c83301a57758ba138e2a5e1baceaa9bd2
+  data.tar.gz: a358fc3401bc95e897b7eb3470e3a0583d1699d7
 SHA512:
-  metadata.gz: 9bd665882c88cdb9ed4acb2e6bed688a3b69585630a74425e2fc14e15a098ebb36899dd609d1c5680ffcb89a68c61390ee808dbfb4535837624f4945fa26c636
-  data.tar.gz: a726f4166591fe0683275b35eec562e4d4f9baadbdbe8f14c41e780736add9b38922941e4efedce6ffcc2e853fd3cec9bb5a1b5398d7d0fe32a21e72d88221eb
+  metadata.gz: 87ae5fcb562aa0a10b91dd6f7d599f8b50154e445e4fe56b62833e0d8d0e673cd49cca5295e24d86f0dbdfce542aabad41111e8688b7bc7462b2333c1043c995
+  data.tar.gz: 4894677c3a40eacf60946cf13b4d10e8d71a441283b81f5a2b7529a1d6a9cbe8fd08cd7992e614f67c58dc982a2158a4f53572313a612d5b4db5639b7e670abe

data/README.md

@@ -54,9 +54,9 @@ class Customer
 
   #Demo defn of the strprs method for formatted string input!
   attr_parser :strprs,
-  {"%f"    => lambda { hsh[:fn] = found if parse(/(\w)+/ ) },
-   "%l"    => lambda { hsh[:ln] = found if parse(/(\w)+/ ) },
-   :after  => lambda { set dst.new(hsh[:fn], hsh[:ln]) } }
+  {"%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]) } }
 
   #Create an instance of the demo customer.
   def initialize(first_name, last_name)
@@ -81,19 +81,22 @@ agent = Customer.strprs(in_str, "%f, %l")
 
 Format String Specification Syntax (BNF):
 
-* spec = { text | item }+
-* item = "%" {flag}* {parm {"." parm}?}? {command}
-* flag = { "~" | "@" | "#" | "&" | "^"  |
+* spec = ( text | item )+
+* item = "%" flag* (parm ("." parm)?)? command
+* flag = ( "~" | "@" | "#" | "&" | "^"  |
   "&" | "*" | "-" | "+" | "="  |
   "?" | "_" | "<" | ">" | "\\" |
-  "/" | "." | "," | "|" | "!"  }
-* parm = { "0" .. "9" }+
-* command = { "a" .. "z" | "A" .. "Z" }
+  "/" | "." | "," | "|" | "!"  )
+* parm = ("0" .. "9")+
+* command = ("a" .. "z" | "A" .. "Z")
 
 
-###Sample:
+###Samples:
 
-The format specification "Elapsed = %*02H:%M:%5.2S!"
+The format specification:
+```ruby
+"Elapsed = %*02H:%M:%5.2S!"
+```
 creates the following format specification array:
 
 ```ruby
@@ -123,11 +126,11 @@ Attributes:
 * dst - A string that receives the formatted output (RO).
 * fmt - The format specification currently being processed (RW).
 * engine - The formatting engine. Mostly for access to the library (RO).
-* hsh - A utility hash so that the formatting process can retain state (RO).
+* tmp - A utility hash so that the formatting process can retain state (RO).
 
 Methods
 * cat - Append the string that follows to the formatted output. This is
-  equivalent to dst << "string"
+  equivalent to the code dst << "string"
 
 ###When Parsing:
 Attributes:
@@ -135,7 +138,7 @@ Attributes:
 * dst - The class of the object being created (RO).
 * fmt - The parse specification currently being processed (RW).
 * engine - The parsing engine. Mostly for access to the library (RO).
-* hsh - A utility hash so that the parsing process can retain state RO.
+* tmp - A utility hash so that the parsing process can retain state (RO).
 
 Methods
 * set - Set the return value of the parsing operation to the value that follows.
@@ -162,8 +165,20 @@ most welcomed.
 
 ## Contributing
 
+#### Plan A
+
 1. Fork it ( https://github.com/[my-github-username]/format_engine/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+#### Plan B
+
+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.
+
+

data/lib/format_engine/format_spec.rb

@@ -2,15 +2,16 @@ require_relative 'format_spec/literal'
 require_relative 'format_spec/variable'
 
 # Format String Specification Syntax (BNF):
-#  spec = { text | item }+
-#  item = "%" {flag}* {parm {"." parm}?}? {command}
-#  flag = { "~" | "@" | "#" | "&" | "^"  |
+#  spec = (text | item)+
+#  item = "%" flag* (parm ("." parm)? )? command
+#  flag = ( "~" | "@" | "#" | "&" | "^"  |
 #           "&" | "*" | "-" | "+" | "="  |
 #           "?" | "_" | "<" | ">" | "\\" |
-#           "/" | "." | "," | "|" | "!"  }
-#  parm = { "0" .. "9" }+
-#  command = { "a" .. "z" | "A" .. "Z" }
-#  Sample: x = FormatSpec.get_spec "Elapsed = %*03.1H:%M:%S!"
+#           "/" | "." | "," | "|" | "!"  )
+#  parm = ("0" .. "9" )+
+#  command = ("a" .. "z" | "A" .. "Z")
+#
+#  Sample: x = FormatSpec.get_spec "Elapsed = %*3.1H:%02M!"
 
 module FormatEngine
 

data/lib/format_engine/spec_info.rb

@@ -11,7 +11,7 @@ module FormatEngine
   #* dst - A string that receives the formatted output.
   #* fmt - The format specification currently being processed.
   #* engine - The formatting engine. Mostly for access to the library.
-  #* hsh - A utility hash so that the formatting process can retain state.
+  #* tmp - A utility hash so that the formatting process can retain state.
   #<br>Methods
   #* cat - Append the string that follows to the formatted output.
   #<br>
@@ -20,7 +20,7 @@ module FormatEngine
   #* dst - The class of the object being created.
   #* fmt - The parse specification currently being processed.
   #* engine - The parsing engine. Mostly for access to the library.
-  #* hsh - A utility hash so that the parsing process can retain state.
+  #* tmp - A utility hash so that the parsing process can retain state.
   #<br>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.
@@ -30,14 +30,14 @@ module FormatEngine
   class SpecInfo
 
     # General readers
-    attr_reader :src, :dst, :engine, :hsh
+    attr_reader :src, :dst, :engine, :tmp
 
     #General accessors
     attr_accessor :fmt
 
     # Set up the spec info.
-    def initialize(src, dst, fmt, engine, hsh = {})
-      @src, @dst, @fmt, @engine, @hsh = src, dst, fmt, engine, hsh
+    def initialize(src, dst, fmt, engine, tmp = {})
+      @src, @dst, @fmt, @engine, @tmp = src, dst, fmt, engine, tmp
     end
 
     # Concatenate onto the formatted output string.

data/lib/format_engine/version.rb

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

data/mocks/demo/demo_parse.rb

@@ -7,8 +7,8 @@ class Customer
   #The specification of the parser method of the demo \Customer class.
 
   attr_parser :strprs,
-  {"%f"    => lambda { hsh[:fn] = found if parse(/(\w)+/ ) },
-   "%l"    => lambda { hsh[:ln] = found if parse(/(\w)+/ ) },
-   :after  => lambda { set dst.new(hsh[:fn], hsh[:ln]) } }
+  {"%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]) } }
 
 end

data/tests/parser_engine_tests.rb

@@ -13,18 +13,18 @@ class ParserTester < Minitest::Test
 
   def make_parser
     FormatEngine::Engine.new(
-      "%f"    => lambda { hsh[:fn] = found if parse(/(\w)+/ ) },
-      "%F"    => lambda { hsh[:fn] = found.upcase if parse(/(\w)+/) },
-      "%-F"   => lambda { hsh[:fn] = found.capitalize if parse(/(\w)+/) },
-      "%l"    => lambda { hsh[:ln] = found if parse(/(\w)+/ ) },
-      "%L"    => lambda { hsh[:ln] = found.upcase if parse(/(\w)+/) },
-      "%-L"   => lambda { hsh[:ln] = found.capitalize if parse(/(\w)+/) },
+      "%f"    => lambda { tmp[:fn] = found if parse(/(\w)+/ ) },
+      "%F"    => lambda { tmp[:fn] = found.upcase if parse(/(\w)+/) },
+      "%-F"   => lambda { tmp[:fn] = found.capitalize if parse(/(\w)+/) },
+      "%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)+/) },
       "%s"    => lambda { parse(/\s+/) },
       "%,s"   => lambda { parse(/[,\s]\s*/) },
       "%t"    => lambda { parse("\t") },
       "%!t"   => lambda { parse!("\t") },
 
-      :after  => lambda { set TestPerson.new(hsh[:fn], hsh[:ln]) })
+      :after  => lambda { set TestPerson.new(tmp[:fn], tmp[:ln]) })
   end
 
   def test_that_it_can_parse

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: format_engine
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler