cheatset 1.4.0 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0963874193dcbdf97faaea916dc29529861c7bfb
-  data.tar.gz: 7c3481e0821db0a00c13c67f8c83636bb999db12
+SHA256:
+  metadata.gz: 7cdad91d3249670d887fc8d31610c34332eec34e4b3cc7b238caf17ad6a8c71a
+  data.tar.gz: f950f00db4a6205d1be2eceaac6cda4e70620bc69ac4d7ba5e6d0de4b4b78a20
 SHA512:
-  metadata.gz: 899d97cc1734b4a08a906e66e91caee81bad26eeb5e279d9097ba064fb1edc5e57f88ea5756e4322f73934025e17e321970fa8e2616ae4990e5850f64a1bc316
-  data.tar.gz: 836b7f0bc93683e1e875447047ab5813c1663a4d35e59087398191c8f8753108b04f9d1b31f8271e3d905c2f98dd3500fc3584bb46e426542f1ec73227163612
+  metadata.gz: 4685f391d19394979b8fe9bd321b02f524e935d654c6898940a0771ee56876407bce6d89aac7de2ca87feac477a47fafa04cda7b3e7f925a8c10405917d96996
+  data.tar.gz: c4f2979652d942646e2abc52a4431479e8dbe8489aa5d238979db25ef7301908ac6103db53e6388cece733cd2e47c9f09b83db2aaab178a8dfb0a774dbe83b9a

data/README.md

@@ -8,15 +8,15 @@ language (Ruby DSL).
 
 ## Installation
 
-    $ sudo gem install cheatset --no-ri --no-rdoc
+    $ sudo gem install cheatset
 
 Note: this requires the Xcode Command Line Tools to be installed. Install them using this:
 
     $ xcode-select --install
-    
+
 ## Contributions
 
-If you make an useful cheat sheet, please [contribute it](https://github.com/Kapeli/cheatsheets#readme) to Dash.
+If you make a useful cheat sheet, please [contribute it](https://github.com/Kapeli/cheatsheets#readme) to Dash.
 
 ## Usage
 
@@ -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:

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

@@ -44,14 +44,14 @@ h1, h2, h3, p, blockquote {
   src: local("Open Sans Extrabold Italic"), local("OpenSans-ExtraboldItalic"), url(cheatset_resources/Open_Sans_Extrabold_Italic.woff) format("woff"); }
 body {
   font-family: 'Open Sans', sans-serif;
-  font-size: 14px;
+  font-size: 16px;
   color: #000;
   background-color: #fff;
   margin: 0; }
 
 code, pre {
   font-family: Menlo, Consolas, "Liberation Mono", Courier, monospace;
-  font-size: 13px; }
+  font-size: 15px; }
 
 code {
   margin: 0;

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.0'
+  VERSION = '1.4.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cheatset
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.4
 platform: ruby
 authors:
 - Bogdan Popescu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-18 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -204,8 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Generate cheat sheets for Dash