gm-notepad 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da3bbc8cbf352187a313f8815110edef14d41c7c37e4f2dd1f3bb49e43200bcf
-  data.tar.gz: 12ffebdda56b6d2e3a4c43da401c884b8c1a659767ea618081792346530ca15c
+  metadata.gz: de7a4c2dc05bae568e9f8c5d98644495563447a55cc9ff6af4b53199ffe64311
+  data.tar.gz: d1a469f3379acc8213ae64050457473186411359af8ce707b7f8ac267d6749d2
 SHA512:
-  metadata.gz: fa277d748161cb37f2b1105d02d17cc551769f171953746bfd8aed13cd009c48fbb155a96c08a980f1c34ab66e6c6afa07cf42b804eac77cf5a5a79016533f4e
-  data.tar.gz: a0539f38a29bcce258255da060388f29cbeab6cd59505fbcb2af2f757f8094637d8b821f63e339f8002169ffe720b9346d5b10c5fd6a03ead9ad6ba759308116
+  metadata.gz: da07a6915adf85b592a7d0b6b0280573da0b9f802b4c148684eef38896f72570b5c5ac2855ab938691dc0ab49aa8d49cfee34abcd590249d9e0fd08bef3fb209
+  data.tar.gz: 70b13268f20d7b2cfca3c18288f9f853a5bf2a506132aa8558ce7ab4b931a0d98af8a487b2d8b261514dd812fd30d98170d2c82a101d9e2fcb7e1b8253fe07ec

data/README.md

@@ -189,14 +189,12 @@ Frodo owes 3gp to SamWise
 ```
 
 Let's take a look at the `+character` table. Your table indices need not be
-numbers. And you can mix numbers and text. _If you expand the table via
-`{table}` each text index counts as 1 entry. For the below table, each
-entry has a 1 in 3 chance of being randomly chosen.
+numbers. And you can mix numbers and text. This example introduces the idea of
+columns. _I am still working on retrieving by column names as well as rendering column names_.
 
 ```console
-=>	[name]	Grell
-=>	[ac]	15
-=>	[hd]	12D12
+=>	[grell]	Grell	15	12D12
+=>	[jehat]	Jehat	19	14D6
 ```
 
 ## Testing Locally
@@ -228,7 +226,7 @@ entry has a 1 in 3 chance of being randomly chosen.
 - [X] Add index name when rendering table entries
 - [ ] Gracefully handle loading a malformed data file (maybe?)
 - [X] Add concept of history
-- [ ] When expanding tables account for line expansion (via \n and \t)
+- [X] When expanding tables account for line expansion (via \n and \t)
 - [ ] Separate the InputHandler into pre-amble (e.g. allow overrides to where we are writing, determine what command we are writing)
 - [X] Create a configuration object that captures the initial input (reduce passing around parameters and persisting copies of the config)
 - [ ] Add concept of "journal entry"; its not a table (perhaps) but something that you could capture notes.
@@ -237,6 +235,7 @@ entry has a 1 in 3 chance of being randomly chosen.
 - [X] Support `\{\{table}-name}` You should be able to do `\{\{culture}-name}` and first evaluate to `{arabic-name}` and then get a value from the `arabic-name` table
 - [X] Ensure index names are lower-case
 - [ ] Hit 100% spec coverage
+- [ ] Create a "To Render Object"; When you parse the input, you push relevant lines to that "To Render Object". When you look at a table, you want to know what the column names are.
 
 ### Stretch TODO
 

data/Rakefile

@@ -17,7 +17,7 @@ namespace :commitment do
     lastrun_filename = File.expand_path('../coverage/.last_run.json', __FILE__)
     if File.exist?(lastrun_filename)
       coverage_percentage = JSON.parse(File.read(lastrun_filename)).fetch('result').fetch('covered_percent').to_i
-      EXPECTED_COVERAGE_GOAL = 97
+      EXPECTED_COVERAGE_GOAL = 98
       if coverage_percentage < EXPECTED_COVERAGE_GOAL
         abort("ERROR: Code Coverage Goal Not Met:\n\t#{coverage_percentage}%\tExpected\n\t#{EXPECTED_COVERAGE_GOAL}%\tActual")
       else

data/lib/gm/notepad/configuration.rb

@@ -7,6 +7,7 @@ module Gm
         report_config: false,
         defer_output: false,
         filesystem_directory: '.',
+        index_entry_prefix: "index",
         interactive_buffer: $stderr,
         interactive_color: true,
         output_color: false,

data/lib/gm/notepad/line_renderer.rb

@@ -39,7 +39,7 @@ module Gm
       end
 
       def render_output(lines, defer_output:, as_of:)
-        Array(lines).each do |line|
+        each_expanded_line(lines: lines) do |line|
           if config[:with_timestamp]
             line = "#{as_of}\t#{line}"
           end
@@ -52,10 +52,20 @@ module Gm
       end
 
       def render_interactive(lines)
-        Array(lines).each do |line|
+        each_expanded_line(lines: lines) do |line|
           interactive_buffer.puts("=>\t#{line}")
         end
       end
+
+      # Gracefully expand the \t and \n for the output buffer
+      def each_expanded_line(lines:)
+        Array(lines).each do |unexpanded_line|
+          unexpanded_line.to_s.split('\\n').each do |line|
+            line = line.gsub('\\t', "\t")
+            yield(line)
+          end
+        end
+      end
     end
 
     # To provide a means for colorizing the output

data/lib/gm/notepad/table.rb

@@ -1,10 +1,14 @@
 require "gm/notepad/exceptions"
+require "gm/notepad/configuration"
 require "gm/notepad/table_entry"
+require "gm/notepad/table_column_set"
 
 module Gm
   module Notepad
     class Table
-      Configuration.init!(target: self, additional_params: [:table_name, :filename, :lines]) do
+      Configuration.init!(target: self, from_config: [:column_delimiter, :index_entry_prefix], additional_params: [:table_name, :filename, :lines]) do
+        @index_entry_prefix_regexp = %r{^#{Regexp.escape(index_entry_prefix)} *#{Regexp.escape(column_delimiter)}}i.freeze
+        set_null_table_column_set!
         process(lines: lines)
       end
 
@@ -24,6 +28,10 @@ module Gm
         @table.values.uniq
       end
 
+      def column_names
+        @table_column_set.names
+      end
+
       def grep(expression)
         returning_value = []
         @table.each_value do |entry|
@@ -68,18 +76,39 @@ module Gm
         rand(@table.size)
       end
 
+      STARTS_WITH_COMMENT_REGEXP = %r{\A#}
       def process(lines:)
         @table = {}
         lines.each do |line|
-          next if line[0] == '#'
-          entry = TableEntry.new(line: line, config: config)
-          entry.lookup_range.each do |i|
-            key = i.to_s
-            raise DuplicateKeyError.new(key: table_name, object: self) if @table.key?(key)
-            @table[key] = entry
+          line = line.strip
+          # Handle Comment
+          case line
+          when STARTS_WITH_COMMENT_REGEXP
+            next
+          when @index_entry_prefix_regexp
+            register_index_declaration!(line: line)
+          else
+            make_entry!(line: line)
           end
         end
       end
+
+      def set_null_table_column_set!
+        @table_column_set = TableColumnSet::Null.new
+      end
+
+      def register_index_declaration!(line:)
+        @table_column_set = TableColumnSet.new(table: self, line: line, config: config)
+      end
+
+      def make_entry!(line:)
+        entry = TableEntry.new(table: self, line: line, config: config)
+        entry.lookup_range.each do |i|
+          key = i.to_s
+          raise DuplicateKeyError.new(key: table_name, object: self) if @table.key?(key)
+          @table[key] = entry
+        end
+      end
     end
   end
 end

data/lib/gm/notepad/table_column_set.rb

@@ -0,0 +1,33 @@
+require "gm/notepad/exceptions"
+require "gm/notepad/configuration"
+
+module Gm
+  module Notepad
+    class TableColumnSet
+      # Because we may not have an index row, from which we create a TableColumnSet.
+      # So this class provides the necessary external interface.
+      class Null
+        def names
+          []
+        end
+      end
+
+      Configuration.init!(target: self, additional_params: [:table, :line], from_config: [:column_delimiter]) do
+        @columns = []
+        @index =
+        process_line!
+      end
+
+      def names
+        @columns.map(&:to_s)
+      end
+
+      private
+      def process_line!
+        columns = line.split(column_delimiter)
+        @index = columns.shift
+        @columns = columns.map {|c| c.strip.downcase }
+      end
+    end
+  end
+end

data/lib/gm/notepad/table_entry.rb

@@ -3,7 +3,7 @@ module Gm
   module Notepad
     TABLE_ENTRY_RANGE_MARKER = "-".freeze
     class TableEntry
-      Configuration.init!(target: self, from_config: [:column_delimiter], additional_params: [:line]) do
+      Configuration.init!(target: self, from_config: [:column_delimiter], additional_params: [:line, :table]) do
         row = line.split(column_delimiter)
         self.index = row.shift
         self.cells = row

data/lib/gm/notepad/version.rb

@@ -1,5 +1,5 @@
 module Gm
   module Notepad
-    VERSION = "0.0.8"
+    VERSION = "0.0.9"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gm-notepad
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Jeremy Friesen
@@ -163,6 +163,7 @@ files:
 - lib/gm/notepad/parameters/table_lookup.rb
 - lib/gm/notepad/readline.rb
 - lib/gm/notepad/table.rb
+- lib/gm/notepad/table_column_set.rb
 - lib/gm/notepad/table_entry.rb
 - lib/gm/notepad/table_registry.rb
 - lib/gm/notepad/version.rb