gm-notepad 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 183a799326643a98e2ee4936d5788549453746e1f74fcd5439b85ffbcfbb24f8
-  data.tar.gz: 1e55a32eaab16d88b6ae07ecfa155b01fb2c261943d80cf95175200b3c239553
+  metadata.gz: 23c9253d91c1ef03c4db29751924f0fbb45e13497aaa9f4625a629a8b5d66ca0
+  data.tar.gz: 7f9d487042f838d415012a43e5cbb840c820bf256fd322cba313f8610fee3d5c
 SHA512:
-  metadata.gz: 0ca9a59b30268a02d7e94718276f597f6c120f4f5cfa120e0f6159a2ee340eb7e69491326d1f04c148994b040f704b876acfd53f02d463b66ff407e0990b34de
-  data.tar.gz: 6207a2cd3628d05ebf53e97e232c25c3ee1cb5bfd36a909ed6177ff4c79089957ab32c3829badbb11863a5a72bc814de0ddf93c562d335e104775a4ce2de95d0
+  metadata.gz: 013b9c64ade3b19008f1bfda2686df131db92051e0c376de64f9c441ad09368d3b64712a87ab2c82dea69f5e3fd66d0710ef5b59c4190a435c2df2f89f1ce73e
+  data.tar.gz: e9ae058f45ba1979e75fef183ba0c62c8f184ec6638d76a7d2ae4c28bbae1f286de5c8730118bbc4169dd708f793b386acdc98929790aba8f45c5ae86a1111ad

data/README.md

@@ -64,11 +64,15 @@ 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)
+    -d, --delimiter=DELIM            Default column delimiter for tables (Default: "|")
+
+Output options:
     -t, --timestamp                  Append a timestamp to the note (Default: false)
 
 Color options:
     -i, --skip-interactive-color     Disable color rendering for interactive buffer (Default: false)
-    -o, --with-output-color          Enable color rendering for output buffer (Default: false)
+    -o, --with-output-color          Enable color rendering for output buffer (Default: true)
 
     -h, --help                       You're looking at it!
 ```
@@ -81,15 +85,20 @@ Which writes the following to the `interactive` buffer (eg. `$stderr`)::
 
 ```console
 # Configuration Parameters:
-#   config[:report_config] = true
+#   config[:column_delimiter] = "|"
 #   config[:filesystem_directory] = "."
+#   config[:include_original_command_as_comment] = true
+#   config[:index_entry_prefix] = "index"
 #   config[:interactive_buffer] = #<IO:<STDERR>>
-#   config[:interactive_color] = true
-#   config[:output_color] = false
+#   config[:interactive_color] = :faint
 #   config[:list_tables] = false
 #   config[:output_buffer] = #<IO:<STDOUT>>
+#   config[:output_color] = false
 #   config[:paths] = ["."]
+#   config[:report_config] = true
+#   config[:skip_readlines] = false
 #   config[:table_extension] = ".txt"
+#   config[:time_to_live] = 20
 #   config[:with_timestamp] = false
 ```
 
@@ -116,10 +125,10 @@ Below are the table names when you run the `gm-notepad -l` against the
 repository (note when you run this command you'll get a preamble of the config):
 
 ```console
-=>	character
-=>	first-name
-=>	last-name
-=>	name
+character
+first-name
+last-name
+name
 ```
 
 Now let's load `gm-notepad` for interaction. In the terminal, type:
@@ -131,16 +140,20 @@ You now have an interactive shell for `gm-notepad`. Type `?` and hit
 `gm-notepad` will write the following to `interactive` buffer (eg. `$stderr`):
 
 ```console
-=>	Prefixes:
-=>		? - Help (this command)
-=>		+ - Query table names and contents
-=>		<table_name: - Write the results to the given table
-=>
-=>	Tokens:
-=>		! - Skip expansion
-=>		/search/ - Grep for the given 'search' within the prefix
-=>		[index] - Target a specific 'index'
-=>		{table_name} - expand_line the given 'table_name'
+Prefixes:
+	?  - Help (this command)
+	+  - Query table names and contents
+	<table_name: - Write the results to the given table
+	`  - Shell out command and write to interactive buffer
+	`> - Shell out command and write to interactive AND output buffer
+Tokens:
+	! - Skip expansion
+	/search/ - Grep for the given 'search' within the prefix
+	[index] - Target a specific 'index'
+	[][column] - Pick a random index
+	{table_name} - expand_line the given 'table_name'
+	{table_name[d6]} - roll a d6 and lookup that row on the given 'table_name'
+	{table_name[d6][name]} - pick a random row (between 1 and 6) and select the 'name' column from the given table_name
 ```
 
 Now, let's take look at a table. Again in an active `gm-notepad` session type
@@ -149,11 +162,11 @@ the following: `+first-name`
 `gm-notepad` will write the following to `interactive` buffer (eg. `$stderr`):
 
 ```console
-=>	[1]	Frodo
-=>	[2]	Merry
-=>	[3]	Pippin
-=>	[4]	Sam
-=>	[5-6]	{first-name}Wise
+[1]	Frodo
+[2]	Merry
+[3]	Pippin
+[4]	Sam
+[5-6]	{first-name}Wise
 ```
 
 These are the five table entries in the `first-name` table.
@@ -199,6 +212,26 @@ columns. _I am still working on retrieving by column names as well as rendering
 =>	[jehat]	Jehat	19	14D6
 ```
 
+You can write a new table, without exiting `gm-notepad`, by doing the following:
+
+```console
+<junk:1|2\n3|4
+```
+
+This will write to the `junk.txt` file the following:
+
+```console
+1|2
+3|4
+```
+
+You can then immediately access the `junk` table, by typing the following: `+junk`
+
+```console
+[1]	2
+[3]	4
+```
+
 ## Testing Locally
 
 * Clone the repository

data/exe/gm-notepad

@@ -39,7 +39,7 @@ OptionParser.new do |options|
     config[:table_extension] = table_extension
   end
 
-  options.on("-lTTL", "--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("-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|
     config[:time_to_live] = time_to_live
   end
 

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

@@ -13,15 +13,20 @@ module Gm
         def after_initialize!
           [
             "Prefixes:",
-            "\t? - Help (this command)",
-            "\t+ - Query table names and contents",
+            "\t?  - Help (this command)",
+            "\t+  - Query table names and contents",
             "\t<table_name: - Write the results to the given table",
+            "\t`  - Shell out command and write to interactive buffer",
+            "\t`> - Shell out command and write to interactive AND output buffer",
             "",
             "Tokens:",
             "\t! - Skip expansion",
             "\t/search/ - Grep for the given 'search' within the prefix",
             "\t[index] - Target a specific 'index'",
-            "\t{table_name} - expand_line the given 'table_name'"
+            "\t[][column] - Pick a random index",
+            "\t{table_name} - expand_line the given 'table_name'",
+            "\t{table_name[d6]} - roll a d6 and lookup that row on the given 'table_name'",
+            "\t{table_name[d6][name]} - pick a random row (between 1 and 6) and select the 'name' column from the given table_name"
           ].each do |text|
             input.for_rendering(text: text, to_interactive: true, to_output: false, expand_line: false)
           end

data/lib/gm/notepad/line_renderer.rb

@@ -52,7 +52,7 @@ module Gm
 
       def render_interactive(lines)
         each_expanded_line(lines: lines) do |line|
-          interactive_buffer.puts("=>\t#{line}")
+          interactive_buffer.puts(line)
         end
       end
 

data/lib/gm/notepad/version.rb

@@ -1,5 +1,5 @@
 module Gm
   module Notepad
-    VERSION = "0.0.14"
+    VERSION = "0.0.15"
   end
 end

metadata

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