gm-notepad 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4175bf606855b4c2be432ac4520727705e708f16583cbf9a616d5246e46aa1f2
-  data.tar.gz: 1877cf77a1aef0e1e7697d673d1a021fe907b964ab21c9adbb38c1ecda784428
+  metadata.gz: '0784714674a998ddc3d5fc89ca12a9bbff1837a18472236c66588b147fc62683'
+  data.tar.gz: cd5e95e5b42684c6d005d696e194c35bbe2ee7c130382e5b1b4ab75b12c09673
 SHA512:
-  metadata.gz: d6b1d4a852e32922d6c18529584c9eb06645f440f7286b363b87767cb5094a6ae18dbf82f53c227bc2485d739a14b7b540482e0422ba81785db8e8337a92b763
-  data.tar.gz: 33b44cb7f7888c038152cc738ab861734b73509db733c2c5ee451270ad0936f883246735300a6b02ff9f760c119be38bb8209a0d99ca4b7575c25da5229dcb3b
+  metadata.gz: 34053cf8caa8baf0a30cc5bef686f55e84ae464e296072fc1e3074af259dc05001f433937b7df42627b56076a807ea4bce8f5ba55b1fcde60e00194bcb0f4ed4
+  data.tar.gz: 0d16b0d3f31df32c84ec8f298634d2bf98cdb2806d2cfb0b47e32a33bd9103aacdc199f5594bc964ae6ef610a9298db352747a8f348bdd878826026e0a9aa904

data/README.md

@@ -10,6 +10,10 @@ Next, you'll want to install the `gm-notepad` gem.
 
 `$ gem install gm-notepad`
 
+## Datasets
+
+* `[gm-notepad-swn-free](//github.com/jeremyf/gm-notepad-swn-free)` a subset of tables available in [Stars without Number: Revised Edition](https://www.drivethrurpg.com/product/226996/Stars-Without-Number-Revised-Edition?affiliate_id=318171)
+
 ## Background
 
 On a commute home from work, while listening to [Judd Karlman's "Daydreaming about Dragons" podcast](https://anchor.fm/daydreaming-about-dragons/)
@@ -64,7 +68,7 @@ Options:
     -p, --path=PATH                  Path(s) for {table_name}.<config.table_extension> files (Default: ["."])
     -f, --filesystem_directory=DIR   Path to dump tables (Default: ".")
     -x, --table_extension=EXT        Extension to use for selecting tables (Default: ".txt")
-        --time_to_live=TTL           Per line of input, how many times to allow text expansion (Default: 20)
+        --time_to_live=TTL           Per line of input, how many times to allow text expansion (Default: 100)
     -d, --delimiter=DELIM            Default column delimiter for tables (Default: "|")
 
 Output options:
@@ -98,7 +102,7 @@ Which writes the following to the `interactive` buffer (eg. `$stderr`)::
 #   config[:report_config] = true
 #   config[:skip_readlines] = false
 #   config[:table_extension] = ".txt"
-#   config[:time_to_live] = 20
+#   config[:time_to_live] = 100
 #   config[:with_timestamp] = false
 ```
 
@@ -270,10 +274,11 @@ You can then immediately access the `junk` table, by typing the following: `+jun
 - [X] Gracefully handle cell lookup when named cell for entry is not found
 - [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
+- [X] Hit 100% spec coverage
 - [X] 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.
 - [X] Remove "defer" printing concept
 - [X] Add ability to shell out; I would love to leverage the [swnt](https://github.com/nboughton/swnt) command line tool
+- [ ] Refine row/column grep behavior, as it is pre-dates the idea of a table having columns
 
 ### 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 = 98
+      EXPECTED_COVERAGE_GOAL = 100
       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/exe/gm-notepad

@@ -39,12 +39,12 @@ OptionParser.new do |options|
     config[:table_extension] = table_extension
   end
 
-  options.on("-tTTL", "--time_to_live=TTL", Integer, "Per line of input, how many times to allow text expansion (Default: #{defaults.time_to_live.inspect})") do |time_to_live|
+  options.on("-vTTL", "--time_to_live=TTL", Integer, "Per line of input, how many times to allow text expansion (Default: #{defaults.time_to_live.inspect})") do |time_to_live|
     config[:time_to_live] = time_to_live
   end
 
   options.on("-dDELIM", "--delimiter=DELIM", String, "Default column delimiter for tables (Default: #{defaults.column_delimiter.inspect})") do |column_delimiter|
-    map = { "t" => "\t" }
+    map = { "t" => "\t", '\t' => "\t" }
     config[:column_delimiter] = map.fetch(column_delimiter) { column_delimiter }
   end
 
@@ -57,11 +57,15 @@ OptionParser.new do |options|
   options.separator("")
   options.separator("Color options:")
 
-  options.on("-i", "--skip-interactive-color", "Disable color rendering for interactive buffer (Default: #{(!defaults.interactive_color).inspect})") do |interactive_color|
-    config[:interactive_color] = !interactive_color
+  options.on("-iCOLOR", "--interactive-color=COLOR", "Disable color rendering for interactive buffer (Default: #{(defaults.interactive_color).inspect})") do |interactive_color|
+    if ["false", "f" ,"no", "n"].include?(interactive_color.downcase)
+      config[:interactive_color] = false
+    else
+      config[:interactive_color] = interactive_color
+    end
   end
 
-  options.on("-o", "--with-output-color", "Enable color rendering for output buffer (Default: #{(!defaults.output_color).inspect})") do |output_color|
+  options.on("-oCOLOR", "--with-output-color=COLOR", "Enable color rendering for output buffer (Default: #{(defaults.output_color).inspect})") do |output_color|
     config[:output_color] = output_color
   end
 

data/lib/gm/notepad/app.rb

@@ -15,6 +15,9 @@ module Gm
 
       def initialize(*args, input_processor: nil, renderer: nil)
         super
+        # Note: I could note use Dry::Initializer.option with Container as I ended
+        # up with multiple table registry objects created. Which is why I'm using the
+        # keyword's with nil, so I can set two elements after the table_registry is "resolved"
         @renderer = renderer || LineRenderer.new(table_registry: table_registry)
         @input_processor = input_processor || InputProcessor.new(table_registry: table_registry)
         open!

data/lib/gm/notepad/config.rb

@@ -17,7 +17,7 @@ module Gm
       setting :report_config, false, reader: true
       setting :skip_readlines, false, reader: true
       setting :table_extension, '.txt', reader: true
-      setting :time_to_live, 20, reader: true
+      setting :time_to_live, 100, reader: true
       setting :with_timestamp, false, reader: true
 
       def self.index_entry_prefix_regexp

data/lib/gm/notepad/input_handlers/write_to_table_handler.rb

@@ -4,37 +4,24 @@ module Gm
   module Notepad
     module InputHandlers
       class WriteToTableHandler < DefaultHandler
-        HANDLED_PREFIX = "<".freeze
+        WITH_WRITE_TARGET_REGEXP = %r{\A\<(?<table_name>[^:]+):(?<line>.*)}
         def self.handles?(input:)
-          return true if input.match(/^\</)
+          return true if input.match(WITH_WRITE_TARGET_REGEXP)
         end
 
-        NON_EXPANDING_CHARATER = '!'.freeze
-        WITH_INDEX_REGEXP = %r{(?<declaration>\[(?<index>[^\]]+)\])}
-        WITH_GREP_REGEXP = %r{(?<declaration>\/(?<grep>[^\/]+)/)}
-        WITH_WRITE_TARGET_REGEXP = %r{\A#{HANDLED_PREFIX}(?<table_name>[^:]+):(?<line>.*)}
         def after_initialize!
-          if match = input.match(WITH_WRITE_TARGET_REGEXP)
-            input.text_to_evaluate = match[:line].strip
-            table_name = match[:table_name]
-            if index_match = WITH_INDEX_REGEXP.match(table_name)
-              table_name = table_name.sub(index_match[:declaration], '')
-              index = index_match[:index]
-            elsif grep_match = WITH_GREP_REGEXP.match(table_name)
-              table_name = table_name.sub(grep_match[:declaration], '')
-              grep = grep_match[:grep]
-            end
-            table_name = table_name.downcase
-          else
-            raise "I don't know what to do"
-          end
-          if input.match(/^\!/)
-            expand_line = false
-            input.sub!(/^\!/, '')
-          else
-            expand_line = true
-          end
-          input.for_rendering(table_name: table_name, text: input.text_to_evaluate, to_interactive: true  , to_output: false, to_filesystem: true, expand_line: expand_line)
+          match = input.match(WITH_WRITE_TARGET_REGEXP)
+          input.text_to_evaluate = match[:line].strip
+          table_name = match[:table_name]
+          table_name = table_name.downcase
+          input.for_rendering(
+            table_name: table_name,
+            text: input.text_to_evaluate,
+            to_interactive: true,
+            to_output: false,
+            to_filesystem: true,
+            expand_line: true
+          )
         end
       end
     end

data/lib/gm/notepad/parameters/table_lookup.rb

@@ -35,32 +35,25 @@ module Gm
           end
         end
 
+        CELL_AND_INDEX_DECLARED_REGEXP = %r{(?<declaration>\[(?<index>[^\[\]]*)\]\[(?<cell>[^\[\]]*)\])}
+
         WITH_GREP_REGEXP = %r{(?<declaration>\/(?<found>[^\/]+)/)}
         WITH_INDEX_REGEXP = %r{(?<declaration>\[(?<found>[^\]]+)\])}
-        CELL_WITHOUT_INDEX_REGEXP = %r{(?<declaration>\[\]\[(?<found>[^\]]+)\])}
-        EMPTY_INDEX_EMPTY_CELL_REGEXP = %r{(?<declaration>\[\]\[\])}
         WITH_EMPTY_INDEX_REGEX = %r{(?<declaration>\[\])}
         WITH_EMPTY_GREP_REGEX = %r{(?<declaration>\/\/)}
 
+        # TODO: Revisit this method to see if I can remove some pre-amble
         def extract_parameters!
           text = @text
-          if match = EMPTY_INDEX_EMPTY_CELL_REGEXP.match(text)
-            text = text.sub(match[:declaration], '')
-          elsif match = CELL_WITHOUT_INDEX_REGEXP.match(text)
+          if match = CELL_AND_INDEX_DECLARED_REGEXP.match(text)
+            self.index = match[:index] if match[:index].present?
+            self.cell = match[:cell] if match[:cell].present?
             text = text.sub(match[:declaration], '')
-            self.cell = match[:found]
           elsif match = WITH_EMPTY_INDEX_REGEX.match(text)
             text = text.sub(match[:declaration], '')
           elsif match = WITH_INDEX_REGEXP.match(text)
             text = text.sub(match[:declaration], '')
             self.index = match[:found]
-            # Moving on to the cell
-            if match = WITH_EMPTY_INDEX_REGEX.match(text)
-              text = text.sub(match[:declaration], '')
-            elsif match = WITH_INDEX_REGEXP.match(text)
-              text = text.sub(match[:declaration], '')
-              self.cell = match[:found]
-            end
           elsif match = WITH_EMPTY_GREP_REGEX.match(text)
             text = text.sub(match[:declaration], '')
           elsif match = WITH_GREP_REGEXP.match(text)

data/lib/gm/notepad/table.rb

@@ -8,7 +8,7 @@ module Gm
   module Notepad
     class Table
       extend Dry::Initializer
-      option :table_name, proc(&:to_s)
+      option :table_name, -> (value) { value.to_s.downcase.strip }
       option :filename, optional: true
       option :lines, type: method(:Array)
       option :index_entry_prefix_regexp, default: -> { Container.resolve(:config).index_entry_prefix_regexp }
@@ -93,13 +93,6 @@ module Gm
         @table.values[random_index]
       end
 
-      attr_accessor :filename
-      attr_reader :table_name
-
-      def table_name=(input)
-        @table_name = input.downcase
-      end
-
       def random_index
         rand(@table.size)
       end

data/lib/gm/notepad/table_column_set.rb

@@ -12,7 +12,9 @@ module Gm
         end
 
         def column_index_for(cell:)
-          cell.to_i
+          # In the file, we have cell 0 is the index. This is hidden from the cell lookup, so I
+          # want to internally treat the given cell as one less.
+          cell.to_i - 1
         end
       end
 

data/lib/gm/notepad/table_entry.rb

@@ -36,7 +36,13 @@ module Gm
 
         def lookup(cell:)
           index = table.column_index_for(cell: cell)
-          cells[index] || cells[0]
+          if index.nil?
+            # In the file, we have cell 0 is the index. This is hidden from the cell lookup, so I
+            # want to internally treat the given cell as one less.
+            cells[cell.to_i - 1]
+          else
+            cells[index] || cells[0]
+          end
         end
 
         NUMBER_RANGE_REGEXP = %r{(?<left>\d+) *- *(?<right>\d+)}

data/lib/gm/notepad/version.rb

@@ -1,5 +1,5 @@
 module Gm
   module Notepad
-    VERSION = "0.0.17"
+    VERSION = "0.0.18"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gm-notepad
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Jeremy Friesen