dasheets 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjJjMWNkOTYwMzU1N2Q5ZTZiMGYxYzE3NGVhMDk2OWM0NjNjOTAzNA==
+  data.tar.gz: !binary |-
+    NDliZTI5ODcwOGRmNjVlNjc5NjYyNGU3ODcyMTAzMWU2MDIzYTZlNA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OTM2YmFiMGI0MTczOWQzOTMxNWQzOGUxNDI1ZjAwZDdiMDZmMWU2ZDgzZTlk
+    ZWFiNWFmMGNlNzgzZDA1NTk5YjZiZjkwOGJmMTI4ZTA4M2I1OTU4N2YwMzUy
+    NTJhMTdjNzk2NWRmNjg3ZDA5MDU3MDE1NDI3MWRhOTIzNGQ2Y2M=
+  data.tar.gz: !binary |-
+    ZmNlOGY4Y2FjYjFlZGFiNDk5N2E2YWZmOGUxNzkzZDJmNGM5ZmZmZGZjN2Jh
+    ZmYxNjcyYzAxNjdhMGJkYzNlYWU4Njc5MGRmZmQ3OTVlNzQ4NGQwNDYzODRj
+    OGYyZGUyNDFjZTllOGVjZjcyYTM3YTg3ZGUyZDgwNmMwOTRmNjY=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Florian Dütsch
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# 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).
+
+## Installation
+
+    $ gem install dasheets
+
+## Usage
+
+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
+    end
+
+To convert this file to a docset, call
+
+    $ dasheets generate tmux.cheatsheet
+
+
+## Contributing
+
+Yes, please! Open issues and pull requests on the
+[GitHub page](https://github.com/Nix-wie-weg/dasheets).
+
+## Thanks
+
+[svenwin](https://github.com/svenwin) for the awesome name!

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO

@@ -0,0 +1,5 @@
+TODO
+* Better documentation, more examples, ...
+* Render nice HTML
+* Icon
+* minidown

data/bin/dasheets

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

data/dasheets.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dasheets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dasheets'
+  spec.version       = Dasheets::VERSION
+  spec.authors       = ['Florian Dütsch']
+  spec.email         = ['florian.duetsch@nix-wie-weg.de']
+  spec.description   = 'Generate cheatsheets for Dash'
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/Nix-wie-weg/dasheets'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'thor'
+  spec.add_dependency 'haml', '~> 4.0.3'
+  spec.add_dependency 'sqlite3', '~> 1.3.8'
+  spec.add_dependency 'plist', '~> 3.1.0'
+end

data/examples/tmux.cheatsheet

@@ -0,0 +1,38 @@
+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
+

data/lib/dasheets/cli.rb

@@ -0,0 +1,11 @@
+require 'thor'
+
+module Dasheets
+  class CLI < Thor
+    desc 'generate FILE', 'Generates cheatsheet out of a file'
+    def generate(file)
+      context = Dasheets::DSL::Context.new(file)
+      context.generate
+    end
+  end
+end

data/lib/dasheets/creator.rb

@@ -0,0 +1,67 @@
+require 'plist'
+require 'sqlite3'
+require 'fileutils'
+require 'haml'
+require 'ostruct'
+
+class Dasheets::Creator
+  def initialize(cheatsheet)
+    @cheatsheet = cheatsheet
+    @path = "#{@cheatsheet.short_name}.docset/Contents/"
+  end
+
+  def generate
+    FileUtils.rm_rf(@path)
+    FileUtils.mkdir_p(@path)
+    generate_html_file
+    generate_plist_file
+    generate_database
+  end
+
+  private
+
+  def generate_html_file
+    tpl_path = File.expand_path('../templates', __FILE__)
+
+    # HTML
+    template = File.read("#{tpl_path}/template.haml")
+    engine = Haml::Engine.new(template)
+    out = engine.render(@cheatsheet)
+    doc_path = "#{@path}Resources/Documents/"
+    FileUtils.mkdir_p(doc_path)
+    File.open("#{doc_path}index.html", 'w') { |file| file.write(out) }
+
+    # (static) CSS
+    FileUtils.cp("#{tpl_path}/style.css", doc_path)
+  end
+
+  def generate_plist_file
+    plist_data = {
+      'CFBundleIdentifier' => @cheatsheet.short_name,
+      'CFBundleName' => @cheatsheet.title,
+      'DocSetPlatformFamily' => @cheatsheet.short_name,
+      'isDashDocset' => true,
+      'dashIndexFilePath' => 'index.html'
+    }
+    File.open("#{@path}Info.plist", 'w') do |file|
+      file.write(Plist::Emit.dump(plist_data))
+    end
+  end
+
+  def generate_database
+    sqlite_file = "#{@path}Resources/docSet.dsidx"
+    db = SQLite3::Database.new(sqlite_file)
+    db.execute <<-SQL
+      CREATE TABLE searchIndex(id INTEGER PRIMARY KEY, name TEXT,
+                               type TEXT, path TEXT);
+      CREATE UNIQUE INDEX anchor ON searchIndex (name, type, path);
+    SQL
+    @cheatsheet.categories.each do |category|
+      category.entries.each_with_index do |entry, index|
+        sql = 'INSERT INTO searchIndex(name, type, path) VALUES (?, ?, ?)'
+        db.execute(sql, entry.name, 'Guide',
+                   "index.html\##{category.id}-#{index}")
+      end
+    end
+  end
+end

data/lib/dasheets/dsl/category.rb

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

data/lib/dasheets/dsl/cheatsheet.rb

@@ -0,0 +1,21 @@
+class Dasheets::DSL::Cheatsheet
+  attr_reader :categories
+  def initialize(&block)
+    @categories = []
+    instance_eval(&block)
+  end
+
+  def category(&block)
+    @categories << Dasheets::DSL::Category.new(&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
+end
+

data/lib/dasheets/dsl/context.rb

@@ -0,0 +1,13 @@
+class Dasheets::DSL::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)
+  end
+end

data/lib/dasheets/dsl/entry.rb

@@ -0,0 +1,17 @@
+class Dasheets::DSL::Entry
+  def initialize(&block)
+    instance_eval(&block)
+  end
+  def name(name = nil)
+    @name = name if name
+    @name
+  end
+  def command(c = nil)
+    @command = c if c
+    @command
+  end
+  def notes(n = nil)
+    @notes = n if n
+    @notes
+  end
+end

data/lib/dasheets/templates/style.css

@@ -0,0 +1,74 @@
+/* wkhmtmltopdf needs true-type fonts */
+@font-face {
+  font-family: 'Open Sans';
+  font-style: normal;
+  font-weight: 400;
+  src: url(http://themes.googleusercontent.com/static/fonts/opensans/v6/cJZKeOuBrn4kERxqtaUH3aCWcynf_cDxXwCLxiixG1c.ttf) format('truetype');
+}
+@font-face {
+  font-family: 'Droid Sans Mono';
+  font-style: normal;
+  font-weight: 400;
+  src: url(http://themes.googleusercontent.com/static/fonts/droidsansmono/v4/ns-m2xQYezAtqh7ai59hJYW_AySPyikQrZReizgrnuw.ttf) format('truetype');
+}
+
+h1, h2, h3, p, blockquote {
+  margin: 0;
+  padding: 0;
+}
+body {
+  font-family: 'Open Sans', sans-serif;
+  font-size: 10px;
+  line-height: 13px;
+  color: black;
+  background-color: white;
+  margin: 10px 13px;
+}
+table {
+  margin: 10px 0 15px 0;
+  border-collapse: collapse;
+  font-size: 10px;
+}
+td, th {
+  border: 1px solid #ddd;
+  padding: 1px 10px;
+}
+
+a {
+  color: #0069d6;
+}
+p {
+  margin-bottom: 9px;
+}
+h1, h2, h3 {
+  color: #404040;
+  line-height: 36px;
+}
+h1 {
+  margin-bottom: 18px;
+  font-size: 30px;
+}
+h2 {
+  font-size: 24px;
+}
+h3 {
+  font-size: 18px;
+}
+
+code, pre {
+    font-family: 'Droid Sans Mono', monospace;
+}
+code {
+    background-color: #fee9cc;
+    color: black;
+    padding: 1px 3px;
+    font-size: 10px;
+    -webkit-border-radius: 3px;
+    -moz-border-radius: 3px;
+    border-radius: 3px;
+}
+table, pre {
+  page-break-inside: avoid;
+}
+
+

data/lib/dasheets/templates/template.haml

@@ -0,0 +1,22 @@
+!!!
+%html
+  %head
+    %meta{charset: 'utf-8'}
+    %title= title
+    %link{rel: 'stylesheet', href: 'style.css'}
+  %body
+
+    %h1= title
+    - categories.each do |category|
+      %h2= category.id
+      %table
+        %tr
+          %th command
+          %th name
+          %th notes
+        - category.entries.each_with_index do |entry, index|
+          %tr{id: "#{category.id}-#{index}"}
+            %td
+              %code= entry.command
+            %td= entry.name
+            %td= entry.notes

data/lib/dasheets/version.rb

@@ -0,0 +1,3 @@
+module Dasheets
+  VERSION = "0.0.1"
+end

data/lib/dasheets.rb

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

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: dasheets
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Florian Dütsch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  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
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Generate cheatsheets for Dash
+email:
+- florian.duetsch@nix-wie-weg.de
+executables:
+- dasheets
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO
+- bin/dasheets
+- dasheets.gemspec
+- examples/tmux.cheatsheet
+- lib/dasheets.rb
+- lib/dasheets/cli.rb
+- lib/dasheets/creator.rb
+- lib/dasheets/dsl/category.rb
+- lib/dasheets/dsl/cheatsheet.rb
+- lib/dasheets/dsl/context.rb
+- lib/dasheets/dsl/entry.rb
+- lib/dasheets/templates/style.css
+- lib/dasheets/templates/template.haml
+- lib/dasheets/version.rb
+homepage: https://github.com/Nix-wie-weg/dasheets
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.7
+signing_key: 
+specification_version: 4
+summary: Generate cheatsheets for Dash
+test_files: []