gm-notepad 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4666e0ae345ed21a19074c884d3d5052287d70f79d61c005598c0176b5305a4c
-  data.tar.gz: fbe40603b8d2c7ac16176e04c8dd4c314728891a07cf291fc84522071faca9ef
+  metadata.gz: ce5817b9b619d272b6b534d4da74e9474fb15a5cbfc1dd21ac1094ec2aed844d
+  data.tar.gz: a82515600b627a7b0227305cb7430a548d53d0bdf006b633390da5da80c9af8a
 SHA512:
-  metadata.gz: 29cc37dc451ebb46573cf70c39353d6c73f65962c2956f18ddbd0abedaaa3f9a921c3ce828c10c22f2afda7268fe51099a3255fae938ca0171bfa8ab0ccfde6f
-  data.tar.gz: d1d5a709afe55264d2bd694463837b14afaaec529c84f238ca6c6374b706c3dbaea41971d70badd6229a506aed7cdab2dcf4c660c798d22d6d91dae583be594e
+  metadata.gz: 5c0eb020328774f1e4395f4609fef3da8bd15957f1a97acba14d2d492eee854322d7288ad55ee486ee39774464134f34a3ce9e4150900aa966913a78a4665d00
+  data.tar.gz: 54da4151c52a779dd42324efe1520e066db65c696e108ccf2780c5f756f9b97f84bb66a3538d43b229d2f8973c818c45e1e390defe69600c45d867470e8db293

data/README.md

@@ -2,14 +2,6 @@
 
 A command-line tool to help with your GM-ing.
 
-## Todo
-
-- [ ] Colorize puts to `interactive` buffer
-- [ ] Normalize `WriteToTableHandler` to use a renderer
-- [ ] Normalize `WriteToTableHandler` to deliver on `grep` and `index` behavior
-- [ ] Gracefully handle requesting an entry from a table with an index that does not exist (e.g. with test data try `+name[23]`)
-- [ ] Gracefully handle `+name[]`, where "name" is a registered table
-
 ## To install
 
 `$ gem install gm-notepad`
@@ -44,10 +36,9 @@ Examples:
 Specific options:
         --timestamp                  Append a timestamp to the note (Default: false)
     -c, --config_reporting           Dump the configuration data (Default: false)
-    -d, --defer_output               Defer output until system close (Default: true)
+    -d, --defer_output               Defer output until system close (Default: false)
     -p, --path=PATH                  Path for {table_name}.<config.table_extension> files (Default: ["."])
-    -tTABLE_EXTENSION,               Path for {table_name}.<config.table_extension> files (Default: ".txt")
-        --table_extension
+    -t, --table_extension=EXT        Path for {table_name}.<config.table_extension> files (Default: ".txt")
     -l, --list_tables                List tables loaded (Default: nil)
     -h, --help                       You're looking at it!
 ```
@@ -60,8 +51,8 @@ Which writes the following to the `interactive` buffer (eg. `$stderr`)::
 
 ```console
 =>	# Configuration Parameters:
-=>	#   config[:config_reporting] = true
-=>	#   config[:defer_output] = true
+=>	#   config[:config_reporting] = false
+=>	#   config[:defer_output] = false
 =>	#   config[:interactive_buffer] = #<IO:<STDERR>>
 =>	#   config[:output_buffer] = #<IO:<STDOUT>>
 =>	#   config[:paths] = ["."]
@@ -116,3 +107,57 @@ You now have an interactive shell for `gm-notepad`. Type `?` and hit
 =>		[index] - Target a specific 'index'
 =>		{table_name} - expand_line the given 'table_name'
 ```
+
+Now, let's take look at a table. Again in an active `gm-notepad` session type
+the following: `+first-name`
+
+`gm-notepad` will write the following to `interactive` buffer (eg. `$stderr`):
+
+```console
+=>	Frodo
+=>	Merry
+=>	Pippin
+=>	Sam
+=>	{first-name}Wise
+```
+
+These are the five table entries in the `first-name` table. Notice the fifth
+entry: `{first-name}Wise`. The `{first-name}` references a table named
+"first-name" (the same on you are looking at). Now type the following in your `gm-notepad`
+session: `Hello {first-name}`
+
+`gm-notepad` will read the line and recursively expand the `{first-name}` and
+write the result to the `interactive` buffer and `output` buffer.
+
+In the session you might have something like the below:
+
+```console
+=>	Hello SamWise
+Hello SamWise
+```
+The line with starting with `=>` is the `interactive` buffer. The other line
+is written to the `output` buffer.
+
+To wrap up our first session, let's try one more thing. In your `gm-notepad`
+session type the following: `{first-name} owes [2d6]gp to {first-name}`:
+
+```console
+Frodo owes 3gp to SamWise
+```
+
+And there you go.
+
+## Todo
+
+- [ ] Colorize puts to `interactive` buffer
+- [ ] Normalize `WriteToTableHandler` to use a renderer
+- [ ] Normalize `WriteToTableHandler` to deliver on `grep` and `index` behavior
+- [ ] Gracefully handle requesting an entry from a table with an index that does not exist (e.g. with test data try `+name[23]`)
+- [ ] Gracefully handle `+name[]`, where "name" is a registered table
+- [ ] Add time to live for line expansion (to prevent infinite loops)
+- [ ] Enable "up" and "down" to scroll through history
+- [ ] Add config that expands dice results while including the requested roll
+- [ ] Determine feasibility of adding dice to the `{}` expansion syntax (instead of the `[]` syntax)
+- [ ] Add index name when rendering table entries
+- [ ] Add force write results to `output`
+- [ ] Add concept of history

data/exe/gm-notepad

@@ -4,7 +4,7 @@ require 'gm/notepad'
 require 'optparse'
 config = {
   config_reporting: false,
-  defer_output: true,
+  defer_output: false,
   interactive_buffer: $stderr,
   output_buffer: $stdout,
   paths: ['.'],
@@ -43,7 +43,7 @@ OptionParser.new do |options|
     config[:paths] << path
   end
 
-  options.on("-tTABLE_EXTENSION", "--table_extension=TABLE_EXTENSION", String, "Path for {table_name}.<config.table_extension> files (Default: #{config[:table_extension].inspect})") do |table_extension|
+  options.on("-tEXT", "--table_extension=EXT", String, "Path for {table_name}.<config.table_extension> files (Default: #{config[:table_extension].inspect})") do |table_extension|
     config[:table_extension] = table_extension
   end
 

data/lib/gm/notepad/line_evaluator.rb

@@ -13,7 +13,7 @@ module Gm
         end
         while match = line.match(DICE_REGEXP)
           if parsed_dice = Dice.parse(match[:dice])
-            evaluated_dice = "#{parsed_dice.evaluate} (#{match[:dice]})"
+            evaluated_dice = "#{parsed_dice.evaluate}"
           else
             evaluated_dice = "(#{match[:dice]})"
           end

data/lib/gm/notepad/version.rb

@@ -1,5 +1,5 @@
 module Gm
   module Notepad
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

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