dasheets 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 62b108dde9128cfabd4d010435fde4a59112ed8a
-  data.tar.gz: c15937f60fe7ff9d2292969895ef551059b6c0f9
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Njk2ODJjYWYyMzdjOTdiOGFiYzJjMzMzNjYyZmMxODY2OTVlNmVmZQ==
+  data.tar.gz: !binary |-
+    Y2M4MDIxNGRjOWFlNzQwYjQwYjQ0NDc1MzM1YmUzMGU3MmM0NzliMg==
 SHA512:
-  metadata.gz: be969821c53733a94677b70dc1584afaad22448ecbc803d14d5147c1d865f08a44825e166cfe54bf6deff56f975365019baf2eaee7b00e0c153ef06a48dbd472
-  data.tar.gz: 20d90d53c701d30dfcd18f28198ed55c41f2b41b52b38fecb65de9f906ee36d1ea348a444cecf495ca4bd67ab9bbd7c473d125ee36164f65ea22c324e2af71a0
+  metadata.gz: !binary |-
+    MTg5YzdlYjhhNDhkM2M2ZmM5MzVlM2Q2ZGI5ZTQ0MmY2NTZmNGFlN2UwYTc4
+    ZTY2OTAwZTZkZDc0NTYxNDI0NTBjOTIxZmNhMzM1NTBiNzAwNGU5NjlhMjEx
+    NDk0OWVkZjMyMmRjMjUzODA2ZmYyMTNjYjg3YzdiYzRiMzY1OWM=
+  data.tar.gz: !binary |-
+    YTQ1MzdjYTVhNGY2OGIxODUwZjkzMDQxY2RmNmU4MTFiYzNkY2JiZWExMDY0
+    YmUzYWI4MDRmODA2ZGQ4NDk1ZTM5OTg5ZmIyMzIwNDU3MjgxY2EyZjQ4YzVm
+    NWU3YTM0ZjdlZTE2MTg2YzA1YjdhYTNmNmMwNWU3MjM4MDM1YWY=

data/README.md

@@ -1,5 +1,7 @@
 # Dasheets
 
+[![Gem Version](https://badge.fury.io/rb/dasheets.png)](http://badge.fury.io/rb/dasheets)
+
 Generate your own cheatsheets as docsets for [Dash](http://kapeli.com/dash)!
 Use this simple command line tool and write your cheatsheets in an easy
 language (Ruby DSL).
@@ -12,43 +14,58 @@ language (Ruby DSL).
 
 Write a file (here `tmux.cheatsheet`) containing your cheatsheet-data, e. g.:
 
-    cheatsheet do
-      title 'TMUX-Cheatsheet'
-      short_name 'tmux'
-
-      category do
-        id 'windows'
-        entry do
-          name 'create window'
-          command 'PREFIX-c'
-        end
-        entry do
-          name 'rename window'
-          command 'PREFIX-,'
-        end
-        entry do
-          name 'go to next window'
-          command 'PREFIX-n'
-        end
-      end
-
-      category do
-        id 'panes'
-        entry do
-          name 'split horizontally'
-          command 'PREFIX-|'
-          notes 'custom mapping'
-        end
-        entry do
-          name 'split horizontally'
-          command 'PREFIX-%'
-        end
-        entry do
-          name 'split vertically'
-          command 'PREFIX-"'
-        end
-      end
+```
+cheatsheet do
+  title 'tmux cheatsheet'
+  short_name 'tmux' # Used for the filename of the docset
+  introduction 'My *awesome* cheatsheet for tmux'
+
+  # A cheatsheet must consist of categories
+  category do
+    id 'windows'  # must be unique and is used as title of the category
+
+    entry do
+      command 'PREFIX-c'
+      name 'create window'            # A short name
+      notes 'theses are some notes'   # longer explanation
+    end
+    entry do
+      name 'rename window'
+      command 'PREFIX-,'
+    end
+    entry do
+      name 'go to next window'
+      command 'PREFIX-n'
+    end
+  end
+
+  category do
+    id 'panes'
+    entry do
+      name 'split horizontally'
+      command 'PREFIX-|'
+      notes 'custom mapping'
+    end
+    entry do
+      name 'split horizontally'
+      command 'PREFIX-%'
+    end
+    entry do
+      name 'split vertically'
+      command 'PREFIX-"'
     end
+  end
+
+  notes 'Some notes at the end of the cheatsheet'
+end
+```
+The following values may contain markdown formatted text:
+
+* The `introduction` and the `notes` of the cheatsheet
+* The `name` and the `notes` of the entries
+
+For more complete examples look at some of
+[my actual cheatsheets](https://github.com/der-flo/my_dasheets).
 
 To convert this file to a docset, call
 

data/TODO

@@ -1,5 +1,2 @@
-TODO
-* Better documentation, more examples, ...
-* Even nicer HTML ;-)
-* Icon
-* http://badge.fury.io/for/rb/dasheets
+Prio 2
+* Table of Contents Support - http://kapeli.com/docsets

data/bin/dasheets

@@ -4,4 +4,3 @@ $LOAD_PATH << File.expand_path('../../lib', __FILE__)
 require 'dasheets'
 require 'dasheets/cli'
 Dasheets::CLI.start
-

data/lib/dasheets.rb

@@ -1,11 +1,7 @@
 require 'dasheets/version'
 require 'minidown'
 
-module Dasheets
-  module DSL
-  end
-end
-
-%w(creator dsl/cheatsheet dsl/category dsl/context dsl/entry).each do |file|
+%w(creator dsl/base dsl/cheatsheet dsl/category dsl/context
+   dsl/entry).each do |file|
   require "dasheets/#{file}"
 end

data/lib/dasheets/creator.rb

@@ -7,12 +7,14 @@ require 'ostruct'
 class Dasheets::Creator
   def initialize(cheatsheet)
     @cheatsheet = cheatsheet
-    @path = "#{@cheatsheet.short_name}.docset/Contents/"
+    @docset_path = "#{@cheatsheet.short_name}.docset"
+    @path = "#{@docset_path}/Contents/"
   end
 
   def generate
     FileUtils.rm_rf(@path)
     FileUtils.mkdir_p(@path)
+    copy_icon
     generate_html_file
     generate_plist_file
     generate_database
@@ -20,9 +22,15 @@ class Dasheets::Creator
 
   private
 
-  def generate_html_file
-    tpl_path = File.expand_path('../templates', __FILE__)
+  def tpl_path
+    File.expand_path('../templates', __FILE__)
+  end
 
+  def copy_icon
+    FileUtils.cp("#{tpl_path}/icon.png", @docset_path)
+  end
+
+  def generate_html_file
     # HTML
     template = File.read("#{tpl_path}/template.haml")
     engine = Haml::Engine.new(template)

data/lib/dasheets/dsl/base.rb

@@ -0,0 +1,34 @@
+module Dasheets
+  module DSL
+    class Base
+      def initialize(&block)
+        instance_eval(&block)
+      end
+      private
+
+      def parse_markdown(str)
+        Minidown.parse(i).to_html
+      end
+
+      def self.define_attrs(*names)
+        names.each do |name|
+          define_method(name) do |val = nil|
+            instance_variable_set("@#{name}", val) if val
+            instance_variable_get("@#{name}")
+          end
+        end
+      end
+      def self.define_markdown_attrs(*names)
+        names.each do |name|
+          define_method(name) do |val = nil|
+            if val
+              val = Minidown.parse(val).to_html
+              instance_variable_set("@#{name}", val)
+            end
+            instance_variable_get("@#{name}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dasheets/dsl/category.rb

@@ -1,15 +1,16 @@
-class Dasheets::DSL::Category
-  attr_reader :entries
-  def initialize(&block)
-    @entries = []
-    instance_eval(&block)
-  end
+module Dasheets
+  module DSL
+    class Category < Base
+      attr_reader :entries
+      define_attrs :id
 
-  def id(id = nil)
-    @id = id if id
-    @id
-  end
-  def entry(&block)
-    @entries << Dasheets::DSL::Entry.new(&block)
+      def initialize(&block)
+        @entries = []
+        super(&block)
+      end
+      def entry(&block)
+        @entries << Dasheets::DSL::Entry.new(&block)
+      end
+    end
   end
 end

data/lib/dasheets/dsl/cheatsheet.rb

@@ -1,28 +1,18 @@
-class Dasheets::DSL::Cheatsheet
-  attr_reader :categories
-  def initialize(&block)
-    @categories = []
-    instance_eval(&block)
-  end
+module Dasheets
+  module DSL
+    class Cheatsheet < Base
+      attr_reader :categories
+      define_attrs :title, :short_name
+      define_markdown_attrs :introduction, :notes
 
-  def category(&block)
-    @categories << Dasheets::DSL::Category.new(&block)
-  end
+      def initialize(&block)
+        @categories = []
+        super(&block)
+      end
 
-  def title(t = nil)
-    @title = t if t
-    @title
-  end
-  def short_name(s = nil)
-    @short_name = s if s
-    @short_name
-  end
-  def introduction(i = nil)
-    @introduction = Minidown.parse(i).to_html if i
-    @introduction
-  end
-  def notes(n = nil)
-    @notes = Minidown.parse(n).to_html if n
-    @notes
+      def category(&block)
+        @categories << Dasheets::DSL::Category.new(&block)
+      end
+    end
   end
 end

data/lib/dasheets/dsl/context.rb

@@ -1,13 +1,17 @@
-class Dasheets::DSL::Context
-  def initialize(filename)
-    instance_eval(File.read(filename))
-  end
-  def generate
-    Dasheets::Creator.new(@data).generate
-  end
-  private
+module Dasheets
+  module DSL
+    class Context
+      def initialize(filename)
+        instance_eval(File.read(filename))
+      end
+      def generate
+        Dasheets::Creator.new(@data).generate
+      end
+      private
 
-  def cheatsheet(&block)
-    @data = Dasheets::DSL::Cheatsheet.new(&block)
+      def cheatsheet(&block)
+        @data = Dasheets::DSL::Cheatsheet.new(&block)
+      end
+    end
   end
 end

data/lib/dasheets/dsl/entry.rb

@@ -1,25 +1,8 @@
-require 'minidown'
-
-# TODO: Refactor Minidown usage?
-
-class Dasheets::DSL::Entry
-  def initialize(&block)
-    instance_eval(&block)
-  end
-  def name(name = nil)
-    if name
-      @name = Minidown.parse(name).to_html
-    end
-    @name
-  end
-  def command(c = nil)
-    @command = c if c
-    @command
-  end
-  def notes(n = nil)
-    if n
-      @notes = Minidown.parse(n).to_html
+module Dasheets
+  module DSL
+    class Entry < Base
+      define_attrs :command
+      define_markdown_attrs :name, :notes
     end
-    @notes
   end
 end

data/lib/dasheets/templates/style.css

@@ -1,93 +1,79 @@
-/*
-#050405
-#041F38
-#1C4E70
-#40738F
-#E8F0F8
-*/
-
 h1, h2, h3, p, blockquote {
   margin: 0;
-  padding: 0;
-}
+  padding: 0; }
+
 body {
   font-family: 'Open Sans', sans-serif;
   font-size: 14px;
-  line-height: 1.5em;
-  color: #050405;
-  background-color: #E8F0F8;
-  margin: 0;
-}
+  color: black;
+  background-color: white;
+  margin: 0; }
+
+code, pre {
+  font-family: 'Droid Sans Mono', monospace; }
 
 header {
-  color: #E8F0F8;
-  background-color: #041F38;
-  padding: 1em;
-}
-article {
-  margin: 1em;
-}
+  color: #efefef;
+  background-color: #666666;
+  padding: 2em 1em 1em 4em; }
+
+h1 {
+  font-family: Lobster, sans-serif;
+  font-size: 60px; }
+
 footer {
   margin: 1em;
-  background-color: #1C4E70;
-  color: #E8F0F8;
-  padding: .5em;
-  border-radius: .5em;
-  text-align: center;
-}
-footer a {
-  color: #E8F0F8;
-}
+  background-color: #666666;
+  color: #efefef;
+  border-radius: 10px;
+  text-align: center; }
+  footer a {
+    color: #efefef; }
+
+article {
+  margin: 1em; }
+
+section {
+  border: 2px solid #666666;
+  border-radius: 10px;
+  background-color: #666666;
+  margin: .5em 0;
+  overflow: hidden; }
+
+h2 {
+  color: white;
+  font-size: 1.5em;
+  text-align: center; }
 
 table {
+  background-color: white;
   border-collapse: collapse;
-  border: 2px solid #40738F;
-  border-radius: 10px;
-  margin-bottom: .1em;
-  width: 100%;
-}
+  width: 100%; }
+
+td {
+  padding: 2px; }
 
-td, th {
-  padding: .1em .1em 2em .1em;
-}
 td.command {
-  min-width: 25%;
-}
+  width: 15%;
+  white-space: nowrap;
+  vertical-align: top;
+  padding: .3em 0 0 .3em; }
+  td.command code {
+    padding: .1em .6em;
+    box-shadow: 0 1px 0px rgba(0, 0, 0, 0.2), 0 0 0 2px white inset;
+    border-radius: 3px;
+    border: 1px solid #ccc;
+    background-color: #efefef;
+    color: #333; }
 
-a {
-  color: #0069d6;
-}
-p {
-  margin-bottom: 9px;
-}
-h1, h2, h3 {
-  line-height: 36px;
-  margin: 1em 0 .5em 0;
-}
-h1 {
-  font-family: Lobster, sans-serif;
-  font-size: 48px;
-}
-h2 {
-  font-size: 24px;
-}
-h3 {
-  font-size: 1.2em;
-}
+td.description .name {
+  font-size: 1.2em; }
 
-code, pre {
-  font-family: 'Droid Sans Mono', monospace;
-}
-code {
-  background-color: #40738F;
-  color: #E8F0F8;
-  padding: .1em .3em;
-  border-radius: .5em;
-  font-size: 1.5em;
-}
+tr:nth-child(even) {
+  background: #efefef; }
 
-th {
-  color: #E8F0F8;
-  background-color: #40738F;
-}
+a {
+  color: #666666; }
 
+p + p {
+  margin-top: .5em; }

data/lib/dasheets/templates/style.scss

@@ -0,0 +1,102 @@
+$white: #fff;
+$light_gray: #efefef;
+$dark_gray: #666;
+$black: #000;
+////////////////////////////////////////////////////////////////////////////////
+h1, h2, h3, p, blockquote {
+  margin: 0;
+  padding: 0;
+}
+body {
+  font-family: 'Open Sans', sans-serif;
+  font-size: 14px;
+  color: $black;
+  background-color: $white;
+  margin: 0;
+}
+code, pre {
+  font-family: 'Droid Sans Mono', monospace;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+header {
+  color: $light_gray;
+  background-color: $dark_gray;
+  padding: 2em 1em 1em 4em;
+}
+h1 {
+  font-family: Lobster, sans-serif;
+  font-size: 60px;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+footer {
+  margin: 1em;
+  background-color: $dark_gray;
+  color: $light_gray;
+  border-radius: 10px;
+  text-align: center;
+  a {
+    color: $light_gray;
+  }
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
+article {
+  margin: 1em;
+}
+
+section {
+  border: 2px solid $dark_gray;
+  border-radius: 10px;
+  background-color: $dark_gray;
+  margin: .5em 0;
+  overflow: hidden;
+}
+h2 {
+  color: $white;
+  font-size: 1.5em;
+  text-align: center;
+}
+table {
+  background-color: $white;
+  border-collapse: collapse;
+  width: 100%;
+}
+td {
+  padding: 2px;
+}
+td.command {
+  width: 15%;
+  white-space: nowrap;
+  vertical-align: top;
+  padding: .3em 0 0 .3em;
+  code {
+    // Nice key styling:
+    // https://developers.google.com/chrome-developer-tools/docs/shortcuts
+    padding: .1em .6em;
+    box-shadow: 0 1px 0px rgba(0, 0, 0, 0.2), 0 0 0 2px #fff inset;
+    border-radius: 3px;
+    border: 1px solid #ccc;
+    background-color: $light_gray;
+    color: #333;
+  }
+}
+
+td.description {
+  .name {
+    font-size: 1.2em;
+  }
+}
+tr:nth-child(even) {
+  background: $light_gray;
+}
+
+a {
+  color: $dark_gray;
+}
+p + p {
+  margin-top: .5em;
+}
+

data/lib/dasheets/templates/template.haml

@@ -14,17 +14,16 @@
       %p= introduction
 
       - categories.each do |category|
-        %table
-          %tr
-            %th{colspan: 2}
-              %h2= category.id
-          - category.entries.each_with_index do |entry, index|
-            %tr{id: "#{category.id}-#{index}"}
-              %td.command
-                %code= entry.command
-              %td
-                %h3= entry.name
-                %div= entry.notes
+        %section
+          %h2= category.id
+          %table
+            - category.entries.each_with_index do |entry, index|
+              %tr{id: "#{category.id}-#{index}"}
+                %td.command
+                  %code= entry.command
+                %td.description
+                  .name= entry.name
+                  .notes= entry.notes
       - if notes
         %h2 Notes
         = notes

data/lib/dasheets/version.rb

@@ -1,3 +1,3 @@
 module Dasheets
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dasheets
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Florian Dütsch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2013-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,28 +28,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -124,15 +124,17 @@ files:
 - TODO
 - bin/dasheets
 - dasheets.gemspec
-- examples/tmux.cheatsheet
 - lib/dasheets.rb
 - lib/dasheets/cli.rb
 - lib/dasheets/creator.rb
+- lib/dasheets/dsl/base.rb
 - lib/dasheets/dsl/category.rb
 - lib/dasheets/dsl/cheatsheet.rb
 - lib/dasheets/dsl/context.rb
 - lib/dasheets/dsl/entry.rb
+- lib/dasheets/templates/icon.png
 - lib/dasheets/templates/style.css
+- lib/dasheets/templates/style.scss
 - lib/dasheets/templates/template.haml
 - lib/dasheets/version.rb
 homepage: https://github.com/Nix-wie-weg/dasheets
@@ -145,18 +147,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Generate cheatsheets for Dash
 test_files: []
+has_rdoc: 

data/examples/tmux.cheatsheet

@@ -1,38 +0,0 @@
-cheatsheet do
-  title 'TMUX-Cheatsheet'
-  short_name 'tmux'
-
-  category do
-    id 'windows'
-    entry do
-      name 'create window'
-      command 'PREFIX-c'
-    end
-    entry do
-      name 'rename window'
-      command 'PREFIX-,'
-    end
-    entry do
-      name 'go to next window'
-      command 'PREFIX-n'
-    end
-  end
-
-  category do
-    id 'panes'
-    entry do
-      name 'split horizontally'
-      command 'PREFIX-|'
-      notes 'custom mapping'
-    end
-    entry do
-      name 'split horizontally'
-      command 'PREFIX-%'
-    end
-    entry do
-      name 'split vertically'
-      command 'PREFIX-"'
-    end
-  end
-end
-