placemat 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d08bb0f9605debf93f94c713dc827a14a032090b
-  data.tar.gz: 1a6eb3948cfa08beced3fc84bc33e039f285e119
+  metadata.gz: 6483b9cdbfb763bed4c460297b97a0d25f9f01de
+  data.tar.gz: db2bcb206cffe2d61ceeef98394af1ca1a4469f6
 SHA512:
-  metadata.gz: 669fadacd8f90bd329830455208d46dfc0fa4e31f4c3910f276e35712e8b87cd534c3e2089a33eaffbd32db94e937f5dc0da2e3bfb1595bbae1c61ee4e92925b
-  data.tar.gz: 49a36aba7d7fe29d569444c95de256e26ed4f2517f6da39852631bf127a644298eff9fe5a2f5df043e5d0a86f95e585ba7fab8ed5f308fd29b1d5269f4e03e40
+  metadata.gz: bc6f35fe942c1be825c9183f06dfd0f7028a87874e52977f0467925a15771edf95e604905173c4d740f2ca537cf599e11310c59623d5f5e55bdb74280c1fc794
+  data.tar.gz: 0b7a58ad8d2e7abe18804913bab817c30b93b207d2a579d1536f3d7d969e3066920e2e42e27d64864d7ab20e33b87464067cd2e9312bb73f1bc1583f2c099f96

data/README.md

@@ -4,7 +4,7 @@
 
 Placemat is a robust (maybe?) pre-processing language exclusively for HTML tables.
 
-As of V 0.1.0, Placemat can handle parsing of basic tables without attribute formatting on cells.
+As of V 0.2.0, Placemat can handle parsing of basic tables as well as colspan and row span. Additionally classes and ids can be added to cell level tags. For future/planned updates see tickets marked with the "0 - TODO" tag.
 
 ## Installation
 
@@ -12,6 +12,8 @@ You can install this gem:
 
     $ gem install placemat
 
+If you have issues run the above code with "sudo"
+
 ## Usage
 
 ### Running Placemat
@@ -96,6 +98,44 @@ A|B|C
 
 ```
 
+**c[int] and r[int]**  
+The c and r arguments are used to specify colspan and rowspan respectively. For these, each is followed by an integer that indicates the value. If no intereger is given the value defaults to one (1).
+
+```
+|Name   ::c2
+ID  |First |Last
+-----
+001 |Scrooge|McDuck
+002 |Huey   |Duck ::r3
+003 |Dewey  |     ::X
+004 |Louie  |     ::X
+
+```
+
+**Classes and Ids**  
+An argument may also be given in the block for a cell to give it
+class attributes or an id. This is presented similar to a css selector.
+So a cell like
+```
+Hello ::.blue.underline#name_columns
+```
+would translate to  
+```
+<td class="blue underline " id="name_columns">Hello</td>
+```
+A more robust table may look like:
+
+```
+|Name   ::c2&.blue.underline#name_columns
+ID  |First |Last
+-----
+001 |Scrooge|McDuck
+002 |Huey   |Duck ::r3&#singleId
+003 |Dewey  |     ::X
+004 |Louie  |     ::X
+```
+
+
 #### Samples
 The /samples directory of this repo contains robust examples of creating tables with Placemat, including a table of the fully proposed formatting options for 1.0.0
 

data/lib/placemat.rb

@@ -32,6 +32,19 @@ class FileHandler
 
 end
 
+##
+# Extends the String open class to allow quick retrieval of the first character
+#
+# @see http://stackoverflow.com/questions/2730854/ruby-how-to-get-the-first-character-of-a-string
+class String #:nodoc:
+  def first #:nodoc:
+    self[0,1]
+  end
+  def trim_first #:nodoc:
+    self[1,self.length]
+  end
+end
+
 
 
 require "placemat/PlmatToHTML_Converter"

data/lib/placemat/OptionParser.rb

@@ -6,7 +6,7 @@ OptionParser.new do |opts|
     plmat_parser.compile(plmat)
   end
   opts.on('--version', 'Display the version') do
-    puts "0.1.0"
+    puts "0.2.0"
     exit
   end
   opts.on('-h', '--help', 'Display this help') do

data/lib/placemat/PlmatToHTML_Converter.rb

@@ -83,7 +83,7 @@ class PlmatToHTML_Converter
   def strip_full_line_comments(raw_table_data) #:doc:
     raw_table_data = raw_table_data.split(/\n/)
     raw_table_data.each_with_index do |row, i|
-      if row[0,1] == ";"
+      if row.first == ";"
         raw_table_data.delete_at(i)
       else
         raw_table_data[i] = trim_same_line_comments(row)
@@ -186,11 +186,59 @@ class PlmatToHTML_Converter
 
   ##
   # Builds tag attributes for a cell based on passed arguments
+  # If a value to value key code is present, it builds based on
+  #   values in the local attr_keys hash, if not if checks for
+  #   more complex intructions and passes to the appropriate method
   #
   # Arguments:
   #   args (Array) - all arguments passed from the .plmat argument block
+  #
+  # Returns:
+  #   (String) - string of formatted html attributes
   def build_cell_attrs(args) #:doc:
-    ""
+    attrs = " "
+    attr_keys = Hash["r"=>"rowspan", "c"=>"colspan"]
+
+    args.each do |arg|
+      if attr_keys.has_key?(arg.first)
+        attrs += attr_keys[arg.first] + '="' + arg[1,arg.length] + '" '
+      else
+        attrs += parse_selectors(arg)
+      end
+    end
+    attrs
+  end
+
+  ##
+  # Parses a css-like selector string of class(es) and optionally
+  #   an id (or ids? but don't do that) into their appropriate attribute strings
+  #
+  # Arguments:
+  #   sel_str (String) - selector string
+  def parse_selectors(sel_str) #:doc:
+    classes = Array.new
+    ids     = Array.new
+    attr_str= ""
+
+    sel_str = sel_str.gsub(/[\.\#]/, "." => "-.", "#" => "-#")
+    sel_str = sel_str[1,sel_str.length].split("-")
+
+    sel_str.each do |str|
+      if str.first == "."
+        classes.push(str.trim_first)
+      else
+        ids.push(str.trim_first)
+      end
+    end
+
+    if classes.length > 0
+      attr_str += 'class="' + classes.join(" ") + '" '
+    end
+    if ids.length > 0
+      attr_str += 'id="' + ids.join(" ") + '" '
+    end
+
+    attr_str
   end
 
   ##

data/lib/placemat/version.rb

@@ -1,3 +1,3 @@
 module Placemat #:nodoc:
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/samples/test.html

@@ -1,31 +1,41 @@
 <table>
-	<tr> <th>First Name</th><th>Last Name</th><th>Email</th> </tr>
+	<tr> <th >First Name</th><th >Last Name</th><th >Email</th> </tr>
 
-	<tr> <td>Scrooge</td><td>McDuck</td><td>number1dime@example.net</td> </tr>
-	<tr> <td>Launchpad</td><td>McQuack</td><td>lpad@example.org</td> </tr>
+	<tr> <td >Scrooge</td><td >McDuck</td><td >number1dime@example.net</td> </tr>
+	<tr> <td >Launchpad</td><td >McQuack</td><td >lpad@example.org</td> </tr>
 </table>
 
 <table>
-	<tr> <th>First Name</th><th>Last Name</th><th>Email</th> </tr>
+	<tr> <th >First Name</th><th >Last Name</th><th >Email</th> </tr>
 
-	<tr> <td>Scrooge</td><td>McDuck</td><td>number1dime@example.net</td> </tr>
-	<tr> <td>Launchpad</td><td>McQuack</td><td>lpad@example.org</td> </tr>
+	<tr> <td >Scrooge</td><td >McDuck</td><td >number1dime@example.net</td> </tr>
+	<tr> <td >Launchpad</td><td >McQuack</td><td >lpad@example.org</td> </tr>
 </table>
 
 <table>
-	<tr> <th>A</th><th>B</th><th>C</th> </tr>
+	<tr> <th >A</th><th >B</th><th >C</th> </tr>
 
-	<tr> <td>1</td><td>2</td><td>3</td> </tr>
+	<tr> <td >1</td><td >2</td><td >3</td> </tr>
 </table>
 
 <table>
-	<tr> <th>Customer ID</th><th>First Name</th><th>Last Name</th><th>email                          ; all rows above a line of pure hyphens (-) are treated as th</th> </tr>
-
-	<tr> <td>0001</td><td>William Anderson </td><td>thewilliamanderson@gmail.com</td> </tr>
-	<tr> <td>0002   </td><td>John</td><td>Doe</td><td>johndoe@example.com</td> </tr>
-	<tr> <td>Scrooge</td><td>McDuck</td><td>scrooge@moneybin.net</td> </tr>
-	<tr> <td>0003</td><td>William  </td><td>Anderson</td><td>thewilliamanderson@gmail.com</td> </tr>
-	<tr> <td>Multiple commands can be given after each with or without spaces lines starting with a tab are concatenated to the previous line with a space between them </td> </tr>
-	<tr> <td>0004</td><td>Donald</td><td>Duck</td><td>donald.duck@gonavy.gov </td> </tr>
+	<tr> <th ></th><th colspan="2" class="blue underline" id="name_columns" >Name   </th> </tr>
+	<tr> <th >ID</th><th >First</th><th >Last</th> </tr>
+
+	<tr> <td >001</td><td >Scrooge</td><td >McDuck</td> </tr>
+	<tr> <td >002</td><td >Huey</td><td rowspan="3" id="singleId" >Duck </td> </tr>
+	<tr> <td >003</td><td >Dewey</td> </tr>
+	<tr> <td >004</td><td >Louie</td> </tr>
+</table>
+
+<table>
+
+	<tr> <th >Customer ID</th><th >First Name</th><th >Last Name</th><th >email                          ; all rows above a line of pure hyphens (-) are treated as th</th> </tr>
+
+	<tr> <td >0001</td><td colspan="2" >Duckworth                   </td><td >butler@moneybin.net</td> </tr>
+	<tr> <td rowspan="2" >0002   </td><td >Scrooge</td><td >McDuck</td><td >scrooge@example.com</td> </tr>
+	<tr> <td >Scrooge</td><td >McDuck</td><td >scrooge@moneybin.net</td> </tr>
+	<tr> <td colspan="4" class="legal" rowspan="1" >Multiple commands can be given after each with or without spaces lines starting with a tab are concatenated to the previous line with a space between them </td> </tr>
+	<tr> <td >0004</td><td >Donald</td><td >Duck</td><td class="blue" >donald.duck@gonavy.gov </td> </tr>
 </table>
 

data/samples/test.plmat

@@ -22,17 +22,26 @@ A|B|C
 -----
 1|this cell wont show ::X|2|3
 
+; sample of colspan
+|Name   ::c2&.blue.underline#name_columns
+ID  |First |Last
+-----
+001 |Scrooge|McDuck
+002 |Huey   |Duck ::r3&#singleId
+003 |Dewey  |     ::X
+004 |Louie  |     ::X
+
+
 ; a hyper-complex table, this uses the full proposed Placemat 1.0.0 spec
 Customer ID|First Name          |Last Name  |email                          ; all rows above a line of pure hyphens (-) are treated as th
 --------------------------------------------------------------------------
-0001       |William Anderson ::c2           |thewilliamanderson@gmail.com   ; ::arguments passes arguments to the cell, c[int] indicates colspan
-0002   ::r2|John                |Doe        |johndoe@example.com            ; the r[int] argument indicates row span
+0001       |Duckworth                   ::c2|butler@moneybin.net            ; ::arguments passes arguments to the cell, c[int] indicates colspan
+0002   ::r2|Scrooge             |McDuck     |scrooge@example.com            ; the r[int] argument indicates row span
 -       ::X|Scrooge             |McDuck     |scrooge@moneybin.net           ; the "X" argument means that the cell should not be rendered (aka, its a placeholder)
-0003       |William  ::.class#id|Anderson   |thewilliamanderson@gmail.com   ; haml syntax style for class and id appends
 Multiple commands can be given after each with or without spaces
   lines starting with a tab are concatenated to the previous line with
   a space between them
-  ::c4&.legal &r2                                                           ; Multiple arguments can be passed with the &, and spaces are removed from the argument block
+  ::c4&.legal&r1                                                           ; Multiple arguments can be passed with the &, and spaces are removed from the argument block
 ; Any line that starts with a semi-colon should be ignored                  ; trailing white space should also be removed
 0004
   | Donald

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: placemat
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - William Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler