snipcheat 0.0.1

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in snipcheat.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tadas Tamosauskas
+
+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,27 @@
+# Snipcheat
+
+Snipcheat takes a directory with sublime snippets and generates you a cheatsheet file.
+
+## Installation
+
+    $ gem install snipcheat
+
+## Usage
+
+    $ snipcheat generate -d Packages/Rails -o ~/rails_cheatsheet.html
+
+## Contributing
+
+Contributions are very welcome. Please consider the list of things that could improve the gem:
+
+* Better/more CSS styles for output
+* Live search
+* Ability to generate a website with nested lists of cheatsheets
+
+### How to contribute
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/bin/snipcheat

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/snipcheat.rb'
+
+Snipcheat::Task.start

data/lib/snipcheat/output.rb

@@ -0,0 +1,30 @@
+require 'haml'
+
+module Snipcheat
+  class Output
+    def initialize(snippets, out_file)
+      @snippets = snippets
+      @out_file = out_file
+    end
+
+    def write
+      f = File.open(@out_file, 'w') do |f|
+        f.write(to_s)
+      end
+    end
+
+    def to_s
+      engine = Haml::Engine.new(template_string)
+      out = engine.render(Object.new, snippets: @snippets)
+    end
+
+  private
+
+    def template_string
+      f = File.open(File.join(File.dirname(__FILE__), '..', 'templates', 'simple.html.haml'))
+      f.read
+    ensure
+      f.close
+    end
+  end
+end

data/lib/snipcheat/snippet.rb

@@ -0,0 +1,31 @@
+require 'crack/xml'
+module Snipcheat
+  class Snippet
+    attr_reader :scope, :content, :description, :tab_trigger
+    def initialize(path)
+      @path = path
+      load
+    end
+
+    def load
+      mash.each do |key, value|
+        underscorized = key.to_s
+          .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+          .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+          .tr("-", "_")
+          .downcase
+        instance_variable_set("@#{underscorized}", value.to_s)
+      end
+    end
+
+  private
+    def mash
+      @_mash ||= begin
+        f = File.open(@path)
+        Crack::XML.parse(f.read)['snippet']
+      ensure
+        f.close
+      end
+    end
+  end
+end

data/lib/snipcheat/snippet_dir.rb

@@ -0,0 +1,23 @@
+require 'snipcheat/snippet'
+
+module Snipcheat
+  class SnippetDir
+    def initialize(path)
+      @path = path
+    end
+
+    def empty?
+      filenames.empty?
+    end
+
+    def snippets
+      @_snippets ||= filenames.map{ |fn| Snippet.new(File.join(@path, fn)) }
+    end
+
+    def filenames
+      @_filenames ||= Dir.new(@path).select{ |x|
+        x.end_with? '.sublime-snippet'
+      }.compact
+    end
+  end
+end

data/lib/snipcheat/task.rb

@@ -0,0 +1,34 @@
+require 'snipcheat/snippet_dir'
+require 'snipcheat/output'
+
+module Snipcheat
+  class Task < Thor
+    include Thor::Actions
+
+    class_option  :verbose, type: :boolean, aliases: '-v'
+    method_option :dir, type: :string, aliases: '-d', desc: "Input directory containing .sublime-snippet files", required: true
+    method_option :out, type: :string, aliases: '-o', desc: "Output file. eg ~/ruby-cheatsheet.html. Defaults to cheatsheet.html"
+    desc "generate", "Generate a cheat sheet file given --dir and -out"
+    def generate
+      vsay "Looking for snippets in #{options[:dir]}"
+      snippet_dir = SnippetDir.new(options[:dir])
+      if snippet_dir.empty?
+        say "No snippets found in #{options[:dir]}"
+        return
+      else
+        vsay "Found: #{snippet_dir.filenames.join(', ')}"
+        out = options[:out] || 'cheatsheet.html'
+        vsay "Writing to #{out}..."
+        Output.new(snippet_dir.snippets, out).write
+      end
+    end
+
+  private
+
+    def vsay(message)
+      if options[:verbose]
+        say message
+      end
+    end
+  end
+end

data/lib/snipcheat/version.rb

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

data/lib/snipcheat.rb

@@ -0,0 +1,5 @@
+require 'thor'
+require 'snipcheat/task'
+
+module Snipcheat
+end

data/lib/templates/simple.html.haml

@@ -0,0 +1,16 @@
+!!!
+%head
+%body
+  %table
+    %tr
+      %th Description
+      %th Tab trigger
+      %th Scope
+      %th Content
+    - snippets.each do |snippet|
+      %tr
+        %td= snippet.description
+        %td= snippet.tab_trigger
+        %td= snippet.scope
+        %td= snippet.content
+

data/snipcheat.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snipcheat/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "snipcheat"
+  gem.version       = Snipcheat::VERSION
+  gem.authors       = ["Tadas Tamosauskas"]
+  gem.email         = ["tadas@pdfcv.com"]
+  gem.description   = %q{Generate a cheatsheet HTML given a directory with Sublime Text snippets}
+  gem.summary       = %q{Sublime Text 2 snippet cheat-sheet generator}
+  gem.homepage      = "https://github.com/tadast/snipcheat"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'crack'
+  gem.add_dependency 'thor'
+  gem.add_dependency 'haml'
+
+  gem.add_development_dependency 'rspec'
+end

data/spec/fixtures/sample.sublime-snippet

@@ -0,0 +1,6 @@
+<snippet>
+  <content><![CDATA[${TM_RAILS_TEMPLATE_START_RUBY_EXPR}stylesheet_link_tag {1::all}${2:, media: ${3:"all"}}${TM_RAILS_TEMPLATE_END_RUBY_EXPR}]]></content>
+  <tabTrigger>slt</tabTrigger>
+  <scope>text.html.ruby</scope>
+  <description>stylesheet_link_tag</description>
+</snippet>

data/spec/output_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+module Snipcheat
+  describe Output do
+    describe "#to_s" do
+      it "has all the snippet attributes" do
+        snippets = [double(content: 'xyz', tab_trigger: 'ttr', description: 'magic', scope: 'all.files')]
+        out = Output.new(snippets, :path).to_s
+
+        out.should match 'xyz'
+        out.should match 'ttr'
+        out.should match 'magic'
+        out.should match 'all.files'
+      end
+    end
+  end
+end

data/spec/snippet_dir_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+module Snipcheat
+  describe SnippetDir do
+    let(:fixtures_dir){ SnippetDir.new(File.join(File.dirname(__FILE__), "fixtures")) }
+
+    describe "#empty?" do
+      it "is false for the fixtures dir" do
+        fixtures_dir.should_not be_empty
+      end
+
+      it "is true for the spec folder" do
+        dir = SnippetDir.new(File.join(File.dirname(__FILE__), "..", ".."))
+        dir.should be_empty
+      end
+    end
+
+    describe "#snippets" do
+      it "is an array of Snippets" do
+        fixtures_dir.snippets.first.should be_a Snippet
+      end
+    end
+
+    describe "#filenames" do
+      it "finds sample snippet" do
+        fixtures_dir.filenames.should include('sample.sublime-snippet')
+      end
+
+      it "does not include no snippet" do
+        fixtures_dir.filenames.should_not include('no.snippet')
+      end
+    end
+  end
+end

data/spec/snippet_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module Snipcheat
+  describe Snippet do
+    it "reads all properties from an xml file" do
+      snippet_path = File.join(File.dirname(__FILE__), "fixtures", "sample.sublime-snippet")
+      snippet = Snippet.new(snippet_path)
+
+      snippet.content.should be_a   String
+      snippet.tab_trigger.should eq 'slt'
+      snippet.scope.should eq       'text.html.ruby'
+      snippet.description.should eq 'stylesheet_link_tag'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'snipcheat'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: snipcheat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tadas Tamosauskas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate a cheatsheet HTML given a directory with Sublime Text snippets
+email:
+- tadas@pdfcv.com
+executables:
+- snipcheat
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/snipcheat
+- lib/snipcheat.rb
+- lib/snipcheat/output.rb
+- lib/snipcheat/snippet.rb
+- lib/snipcheat/snippet_dir.rb
+- lib/snipcheat/task.rb
+- lib/snipcheat/version.rb
+- lib/templates/simple.html.haml
+- snipcheat.gemspec
+- spec/fixtures/no.snippet
+- spec/fixtures/sample.sublime-snippet
+- spec/output_spec.rb
+- spec/snippet_dir_spec.rb
+- spec/snippet_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tadast/snipcheat
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Sublime Text 2 snippet cheat-sheet generator
+test_files:
+- spec/fixtures/no.snippet
+- spec/fixtures/sample.sublime-snippet
+- spec/output_spec.rb
+- spec/snippet_dir_spec.rb
+- spec/snippet_spec.rb
+- spec/spec_helper.rb