cheatset 1.4.1 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6e82e43c4402b68c129a13be55550581f4633e6a41e2abc969c84437e6936ed
-  data.tar.gz: 9f073f4fce052749b72935977bac5f6f91f36734466a5fc9908b808132fcc587
+  metadata.gz: 8a7cff5cf1487c0fef78f6013283e7b167cc1a64ec9938defbc317a21adf059f
+  data.tar.gz: 0bb0916201eb1d27677fb9cb8f5146a1887a54cebd9e9d88b70a8faf69e1bbb5
 SHA512:
-  metadata.gz: 54c3999aae21439650008792948b94a975ca002ff743703e6a8f15fa36ed42f874ba6332e319a1bcbc118de99f90f5ad0659ed2520f28a100eda3c4cdbf25d4a
-  data.tar.gz: 79ca59e3666d0c1d6ae22bdfdca10ab556c94a92120f3b4846fa20bb2cc15051af77f563123e7635054278247d3f42e9f0e9ace0e4e81693072d09c3205dfccc
+  metadata.gz: 26a07fdcd1ba96f17d9c25e46208321ef5239bb709d5c54ecbe271634e14113e40f84f8e3f47c354c8c9469f94bf2fba1bc9f2fd888d0b9c9e142e6932c14259
+  data.tar.gz: 24a70af2864c96f6bf7c02cfc6af0eac0681425c921cd7898077e145df376a28ec65365e959f12ab52f1e2366a625bed59f8c6dc3e5be0a073e21490301fb600

data/README.md

@@ -13,7 +13,7 @@ language (Ruby DSL).
 Note: this requires the Xcode Command Line Tools to be installed. Install them using this:
 
     $ xcode-select --install
-    
+
 ## Contributions
 
 If you make a useful cheat sheet, please [contribute it](https://github.com/Kapeli/cheatsheets#readme) to Dash.
@@ -28,7 +28,7 @@ cheatsheet do
   docset_file_name 'Sample'    # Used for the filename of the docset
   keyword 'sample'             # Used as the initial search keyword (listed in Preferences > Docsets)
   # resources 'resources_dir'  # An optional resources folder which can contain images or anything else
-  
+
   introduction 'My *awesome* cheat sheet'  # Optional, can contain Markdown or HTML
 
   # A cheat sheet must consist of categories
@@ -78,6 +78,15 @@ Syntax highlighting is supported (see Ruby code in the sample). For a list of su
 For more complete examples look at some of
 [the actual cheat sheets](https://github.com/Kapeli/cheatsheets/tree/master/cheatsheets).
 
+If you do not use Ruby or lack a working Ruby toolchain and still want to generate cheatsheets.
+
+You can use the `cheatset` Docker image.
+
+    $ docker pull jonasbn/cheatset:lastest
+    $ docker run --rm  -it --volume $PWD:/tmp --name cheatset jonasbn/cheatset:latest generate samble.rb
+
+For more details on the Docker image please visit the repositories on [DockerHub](https://hub.docker.com/repository/docker/jonasbn/cheatset) or [GitHub](https://github.com/jonasbn/docker-cheatset)
+
 ## Advanced Usage
 
 Apart from the attributes listed in the sample cheat sheet above, you can also use these:
@@ -85,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/bin/cheatset

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+require 'cheatset'
+require 'cheatset/cli'
+Cheatset::CLI.start

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');
       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')}/0" : (first_command) ? "index.html\#//dash_ref_#{category_strip}/Command/#{URI.escape(first_command).gsub(/\//, '%252F')}/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.1'
+  VERSION = '1.4.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cheatset
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.5
 platform: ruby
 authors:
 - Bogdan Popescu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2022-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,7 +152,8 @@ dependencies:
         version: '0'
 description: Generate cheat sheets for Dash
 email: 
-executables: []
+executables:
+- cheatset
 extensions: []
 extra_rdoc_files: []
 files:
@@ -161,6 +162,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/cheatset
 - cheatset.gemspec
 - lib/cheatset.rb
 - lib/cheatset/cli.rb
@@ -202,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