rogerleite-gedit-snippets-tool 0.2.2

data/README.textile

@@ -0,0 +1,47 @@
+h2. DESCRIPTION AND MOTIVATION:
+
+Tool to generate cheat sheet of "gedit's snippets":http://live.gnome.org/Gedit/Plugins/Snippets .
+
+Gedit's snippets are personal files that you can change any time, and now, you can have your "custom" cheat sheet any time too.
+
+h2. INSTALLATION:
+
+@sudo gem install rogerleite-gedit-snippets-tool -s http://gems.github.com@
+
+h2. USAGE
+
+To generate a cheat sheet with all your snippets: <br>
+@gedit-snippets-tool -cs > ~/mycheatsheet.xhtml@
+
+To generate a cheat sheet with all your snippets that starts with "ruby": <br>
+@gedit-snippets-tool -cs ruby* > ~/mycheatsheet.xhtml@
+
+After that, you can access you new brand cheat sheet at your home folder.
+
+**IMPORTANT:** gedit-snippets-tool reads your "{home-folder}/.gnome2/gedit/snippets/" folder. I noticed that default use of snippet plugin uses "/usr/share/gedit-2/plugins/snippets/" folder. So please, with you want to generate your cheat sheets, copy the contents from "/usr/share/gedit-2/plugins/snippets/" to "{home-folder}/.gnome2/gedit/snippets/". Thanks!
+
+h2. LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rubygems/specification'
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+GEM = "gedit-snippets-tool"
+GEM_VERSION = "0.2.2"
+SUMMARY = "Tool to generate cheat sheet of gedit's snippets"
+AUTHOR = "Roger Leite"
+EMAIL = "roger.barreto@gmail.com"
+HOMEPAGE = "http://1up4dev.org"
+
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.summary = SUMMARY
+  s.require_paths = ['bin', 'lib']
+  s.files = FileList['bin/*', 'lib/**/*.rb', 'template/**/*.eruby', '[A-Z]*'].to_a
+  s.executables = ["gedit-snippets-tool"]
+
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+
+  s.rubyforge_project = GEM # GitHub bug, gem isn't being build when this miss
+
+  s.add_dependency(%q<erubis>, [">= 2.6.4"])
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "Create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+

data/bin/gedit-snippets-tool

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'gedit_snippets_tool'
+
+args = ARGV.dup
+ARGV.clear
+
+commands = GeditSnippetsTool::Commands.new
+commands.execute args
+

data/lib/gedit_snippets_tool.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.dirname(__FILE__) + "/snippet")
+require 'erubis'
+
+module GeditSnippetsTool
+
+    VERSION = '0.2.2'
+
+    class Commands
+
+        def execute(args)
+            command = args.shift.strip rescue '--help'
+
+            if %w(-h --help).include? command
+                show_help
+            elsif %w(-v --version).include? command
+                puts "#{File.basename($0)} #{VERSION}"
+            elsif %w(-cs --cheat-sheet).include? command
+                generate_cheat_sheet args[0]
+            else
+                puts "Unknow command '#{command}'"
+                puts ""
+                show_help
+            end
+        end
+
+        def show_help
+            puts "Usage: #{File.basename($0)} [OPTION]"
+            puts "Tool to generate cheat sheet of gedit's snippets"
+            puts ""
+            puts "Valid options:"
+            puts "-cs, --cheat-sheet\tcreate cheat sheet of yours gedit's snippets"
+            puts "-h, --help\tshow this help"
+            puts "-v, --version\tshow #{File.basename($0)}'s version"
+            puts ""
+        end
+
+        def generate_cheat_sheet(snippet_name=nil)
+
+            hash_of_snippets = Snippet.all(snippet_name)
+
+            input = File.read(File.expand_path(File.dirname(__FILE__) + "/../template/template.eruby"))
+            eruby = Erubis::EscapedEruby.new(input)      # create Eruby object
+
+            ## create context object
+            ## (key means var name, which may be string or symbol.)
+            context = {
+              :hash_of_snippets  => hash_of_snippets
+            }
+
+            puts eruby.evaluate(context)         # get result
+        end
+
+    end
+
+end
+

data/lib/snippet.rb

@@ -0,0 +1,51 @@
+require 'rexml/document'
+
+class Snippet
+
+  attr_accessor :tag, :description, :text, :accelerator
+
+  def self.all(snippet_name=nil)
+    snippet_name = '*' if snippet_name.nil?
+    path_to_xmls = ENV['HOME'] + "/.gnome2/gedit/snippets/#{snippet_name}.xml"
+
+    snippets = {}
+    Dir.glob(path_to_xmls).each do |file|
+      doc = REXML::Document.new( File.new(file) )
+      file_name = File.basename(file, '.xml')
+      snippets[file_name] = load_by_xml(doc)
+    end
+
+    snippets
+  end
+
+  def self.load_by_xml xml_snippet
+    snippets = []
+    xml_snippet.root.each_element('//snippet') do |snippet_element|
+        snippets << parse(snippet_element)
+    end
+    snippets
+  end
+
+  private
+
+  def self.parse(snippet_element)
+    new_snippet = Snippet.new
+    #puts snippet_element  #help to debug :(
+    new_snippet.tag = snippet_element.elements['tag'].text unless snippet_element.elements['tag'].nil?
+    new_snippet.description = snippet_element.elements['description'].text unless snippet_element.elements['description'].nil?
+
+    text_element = snippet_element.elements['text']
+    if not text_element.nil?
+        new_snippet.text = text_element.cdatas.first
+    end
+
+    accelerator_element = snippet_element.elements['accelerator']
+    if not accelerator_element.nil?
+        new_snippet.accelerator = accelerator_element.cdatas.first
+    end
+
+    new_snippet
+  end
+
+end
+

data/template/template.eruby

@@ -0,0 +1,55 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>Cheat Sheet Gedit Snippets</title>
+  <style>
+    span {
+      border-bottom: 1px solid;
+      text-align: center;
+      font-size: 3em;
+    }
+
+    table {
+      width: 768px;
+    }
+
+    tr.even {
+    }
+
+    tr.odd {
+      background: lightgray;
+    }
+
+    td {
+      border-bottom: 1px solid;
+    }
+  </style>
+</head>
+<body>
+
+<br/>
+
+<% @hash_of_snippets.each_pair do |snippet_name, snippets| %>
+  <span><%= snippet_name %></span>
+  <table>
+    <% snippets.each_with_index do |snippet, index| %>
+      <tr class="<%= index % 2 == 0 ? 'even' : 'odd' %>">
+        <td>
+          <%= snippet.description %> (<b><%= snippet.tag %></b>) <br/>
+          <blockquote>
+          <%= snippet.text %>
+          </blockquote>
+          <% if not snippet.accelerator.nil? %>
+            <br/> accelerator: <%= snippet.accelerator %>
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+  </table>
+  <br/>
+<% end %>
+
+</body>
+</html>
+

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: rogerleite-gedit-snippets-tool
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- Roger Leite
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-30 00:00:00 -07:00
+default_executable: gedit-snippets-tool
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: erubis
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.6.4
+    version: 
+description: 
+email: roger.barreto@gmail.com
+executables: 
+- gedit-snippets-tool
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/gedit-snippets-tool
+- lib/gedit_snippets_tool.rb
+- lib/snippet.rb
+- template/template.eruby
+- Rakefile
+- README.textile
+has_rdoc: false
+homepage: http://1up4dev.org
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- bin
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: gedit-snippets-tool
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Tool to generate cheat sheet of gedit's snippets
+test_files: []
+