cheatset 1.4.2 → 1.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81813b0cb0456d0585f35a8c2d122cc990a6549e3ceaa1ce017ef308d61d4899
-  data.tar.gz: 65ca0783c3cb8187e3d04000ef52a61827dd8468000ec77d0b758d769dc782ae
+  metadata.gz: c0003ce02c53148dbf92dd296e86f17088f943eaf06fc0a2e5c465355cd8b346
+  data.tar.gz: d9670d8da75d5b655a5c9e6092729b15088190d0c4013bd10c53cbd7f65a8a39
 SHA512:
-  metadata.gz: ce2f280c10e5f1ab13db3230dddc0b23d1867f3bd0f729b5b88ad2ecaecc23dc312f9c97d61e4a3c4171d12c78905fb1def8dfc17e50a7ea2adf3751074c079b
-  data.tar.gz: 23aa5393bfa5d5823c4c1679af21da7fe2f6950f65f6fa5d870eb520c1ce1ca3003b237c41c94a3eb88ec50e729d614fdeeba38c2db3c7838064908865cd43b8
+  metadata.gz: eccced4fa8f4f199dc27062bf1393320269fe5b97b3a72353b07f96328c0258ee5ac2cd3522fd4c861330371d572eaf11c83321b4ac9aad7efe1c6e490981925
+  data.tar.gz: 60e7d5e8ba188a36b89a02215efba736c62fe540ecff311840a11194d738345f2d42fba62bae9c255f6d762d09414ecd7ff7440a5257343b6dca9c9d784cda1f

data/README.md

@@ -94,7 +94,8 @@ Apart from the attributes listed in the sample cheat sheet above, you can also u
 * `style` (under `cheatsheet`) - define any CSS style you want. See example [here](https://github.com/Kapeli/cheatsheets/blob/f9e40e30b6fde9063b7a0fb5de8fb203851b17df/cheatsheets/CSS_Named_Colors.rb#L7-L12)
 * `html_class` (under `category`) - define a HTML class to be added to a category. This can be used to define custom styling for each category
 * `td_command` (under `entry`) - just like `command`, but multiple ones are added in a separate column (as opposed to a separate row)
-* `td_notes` (under `entry`) - just like `notes`, but multiple ones are added in a separate column (as opposed to a separate row)
+* `td_notes` (under `entry`) - just like `notes` but can be repeated multiple times, each becoming a separate column
+* `html_notes` (under `entry`) - just like `notes`, but doesn't support Markdown
 * `index_name` (under `entry`) - this is not displayed in the cheat sheet at all. You can use it to define a separate index name (i.e what gets added to Dash's search index and is searchable in Dash). In other words, if this entry is not present, the value in `name` is used.
 
 ## Thanks

data/lib/cheatset/creator.rb

@@ -3,7 +3,7 @@ require 'sqlite3'
 require 'fileutils'
 require 'haml'
 require 'ostruct'
-require 'uri'
+require 'cgi'
 require 'pathname'
 
 class Cheatset::Creator
@@ -84,9 +84,9 @@ class Cheatset::Creator
     sql = 'INSERT INTO searchIndex(name, type, path) VALUES (?, ?, ?)'
     db.execute(sql, @cheatsheet.title, 'Category',
                "index.html")
-    
+
     @cheatsheet.categories.each do |category|
-      category_strip = URI.escape(category.id.strip).gsub(/\//, '%252F');
+      category_strip = CGI.escape(category.id.strip).gsub(/\//, '%252F').gsub(/\+/, '%20');
       if @cheatsheet.title != category.id
         db.execute(sql, category.id, 'Category',
                  "index.html\#//dash_ref/Category/#{category_strip}/1")
@@ -96,7 +96,7 @@ class Cheatset::Creator
         if entry.command && entry.command.length > 0
           first_command = entry.command.first
         end
-        href = (entry.name || entry.index_name) ? "index.html\#//dash_ref_#{category_strip}/Entry/#{URI.escape((entry.index_name) ? entry.index_name.strip : entry.tags_stripped_name.strip).gsub(/\//, '%252F')}/0" : (first_command) ? "index.html\#//dash_ref_#{category_strip}/Command/#{URI.escape(first_command).gsub(/\//, '%252F')}/0" : ""
+        href = (entry.name || entry.index_name) ? "index.html\#//dash_ref_#{category_strip}/Entry/#{CGI.escape((entry.index_name) ? entry.index_name.strip : entry.tags_stripped_name.strip).gsub(/\//, '%252F').gsub(/\+/, '%20')}/0" : (first_command) ? "index.html\#//dash_ref_#{category_strip}/Command/#{URI.escape(first_command).gsub(/\//, '%252F').gsub(/\+/, '%20')}/0" : ""
         if entry.command
           entry.command.each do |command|
             if(!command.strip.empty? && !entry.not_in_main_index)
@@ -124,4 +124,4 @@ class Cheatset::Creator
       end
     end
   end
-end
+end

data/lib/cheatset/dsl/entry.rb

@@ -2,7 +2,7 @@ module Cheatset
   module DSL
     class Entry < Base
       define_list_attrs :command, :td_command, :extra_index_name
-      define_attrs :index_name, :not_in_main_index
+      define_attrs :index_name, :not_in_main_index, :html_notes
       define_markdown_attrs :name, :notes
       define_markdown_list_attrs :td_notes
     end

data/lib/cheatset/templates/style.css

@@ -92,6 +92,13 @@ section.notes {
 article {
   margin: 2em 1em; }
 
+@media print {
+    section.category {
+        page-break-inside: avoid;
+        break-inside: avoid;
+    }
+}
+
 section.category {
   border: 2px solid #666;
   border-radius: 6px 6px;

data/lib/cheatset/templates/style.scss

@@ -69,7 +69,7 @@ code, pre {
   font-size:13px;
 }
 
-code {  
+code {
   margin:0;
   border:1px solid #ddd;
   background-color:#f8f8f8;
@@ -119,6 +119,14 @@ section.notes {
 article {
   margin: 2em 1em;
 }
+
+@media print {
+  section.category {
+      page-break-inside: avoid;
+      break-inside: avoid;
+  }
+}
+
 section.category {
   border: 2px solid $dark_gray;
   border-radius: 6px 6px;
@@ -145,7 +153,7 @@ td {
 }
 th {
   border-left:1px solid $lighter_gray;
-}  
+}
 tr {
   border-bottom:1px dotted $lighter_gray;
 }

data/lib/cheatset/templates/template.haml

@@ -53,10 +53,11 @@
                       %td.td_command
                         - if !command.empty?
                           %code= CGI.escapeHTML(command)
-                  - if entry.name || entry.notes
+                  - if entry.name || entry.notes || entry.html_notes
                     %td.description{:colspan => ("2" unless entry.command || entry.td_command || entry.td_notes)}
                       .name~ entry.name
                       .notes~ entry.notes
+                      .notes~ entry.html_notes
                   - if entry.td_notes
                     - entry.td_notes.each do |notes|
                       %td.td_notes

data/lib/cheatset/version.rb

@@ -1,3 +1,3 @@
 module Cheatset
-  VERSION = '1.4.2'
+  VERSION = '1.4.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cheatset
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.6
 platform: ruby
 authors:
 - Bogdan Popescu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -204,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Generate cheat sheets for Dash