cheatorious 0.0.0 → 0.1.0

data/GEM_VERSION

@@ -1 +1 @@
-v0.0.0+2
+v0.1.0

data/LICENSE

@@ -0,0 +1,8 @@
+Copyright (c) 2011 Luis Cipriani
+
+The MIT License (MIT)
+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

@@ -1,5 +1,106 @@
-# Cheatorious
+# cheatorious
 
-generator of simple, searchable, command line cheatsheets
+_"Being victorious through a means so amazing it cannot possibly be achieved without cheating."_ 
+(Urban Dictionary)
 
-This gem is not ready yet, more info comming soon...
+[![Build Status](https://secure.travis-ci.org/lfcipriani/cheatorious.png)](http://travis-ci.org/lfcipriani/cheatorious)
+
+**cheatorious** is a generator of simple, searchable, shareable, modular command-line cheatsheets.
+
+Cheatsheets are very good to start learning or keep knowledge of some language or tool, but very often you just don't have the proper cheatsheet at hand when you need to remember that cryptic keyboard shortcut. Furthermore, wouldn't be nice to keep or create your own cheatsheets in a neat ruby DSL? Wouldn't be great if you have easy access to them, such as via command-line interface?
+
+## Install ##
+
+    gem install cheatorious
+    
+Cheatorious is compatible with ruby 1.8.x, 1.9.x, rubinius, jruby, ree and more.
+
+## Creating your Cheatsheet ##
+
+Create a file and use the following syntax, shown in the example below:
+
+    cheatsheet_for "Simple VIM" do
+        # put some info about you, if you want to share this later
+        description "A simple VIM cheatsheet for tests"
+        author      "Luis Cipriani", "github.com/lfcipriani"
+        version     "1.0.0"
+
+        # you can configure some keyboard keys variables
+        key :control, "^"
+        key :esc    , "<esc>"
+        key :leader , ","
+        
+        # your prefered keyboard keys separators (default is empty string)
+        key_separator " "
+
+        # this is an cheatsheet entry, the first parameter is what the entry does, the other are the shortcuts or descriptions
+        __ "Enter insertion mode", "i"
+        __ "Exit insertion mode" , _esc
+
+        # you can create sections, that will be searchable
+        section "Basic Movement" do
+            __ "character left, right, line up, line down", "h", "l", "k", "j"
+            __ "word/token left, right"                   , "b", "w"
+        end
+
+        section "Scrolling" do
+            # this is how you use the pre-configured keyboard keys
+            __ "scroll line up, down", (_control "E"), (_control "Y")
+            __ "scroll page up, down", (_control "F"), (_control "B")
+            __ "crazy scroll", (_leader _control "A") # this is just to show you can combine keys \o/
+        end
+
+        section "Files" do
+            __ "Open file", ":e"
+
+            # you can go infinitely deep with sections
+            section "Saving" do
+                __ "Save file", ":w"
+            end
+        end
+    end
+
+## Compiling your cheatsheet ##
+
+In this alpha version, the compilation is transparently done by cheatorious, but in future versions you'll be able to:
+
+* serialize your cheatsheet for exporting
+* export in Base64 to make the search faster
+* export a standalone executable script
+
+## Using cheatorious ##
+
+The CLI usage goes as follows:
+
+    $ cheatorious cheatsheet_file [keyword]
+    
+Where *cheatsheet_file* is the file you created above using the ruby DSL and a optional *keyword* if you want to filter the cheatsheet (case insensitive). If no keyword is passed, it will return whole cheatsheet.
+
+I'm working to let this usage even more simple and fast.
+
+## TODO ##
+
+* search by sections
+* reverse search
+* standalone script generation
+* case sensitive search
+* better ouput layout, colored
+* more features in command line
+* other output writers
+
+## Tips ##
+
+* In Macs, cheatorious is very powerful if used with [DTerm](http://decimus.net/DTerm)
+
+## Contributing ##
+
+You can contribute in the Core, with Writers or Cheatsheets, feel free.
+
+* Fork
+* Implement tests
+* Implement feature
+* Test it
+* Pull request
+
+----
+_Copyright (c) 2011 Luis Cipriani (under MIT license)_

data/bin/cheatorious

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+@cheatsheet_model = nil
+def cheatsheet_for(name, &block)
+  @cheatsheet_model = Cheatorious::CheatSheet.compile(name, &block)
+end
+
+if ARGV.size > 0
+  require File.expand_path(File.dirname(__FILE__) + '/../lib/cheatorious')
+  
+  if File.exist?(ARGV[0])
+    load ARGV[0]
+    result = Cheatorious::Search.execute(@cheatsheet_model, ARGV[1] || "")
+    puts result
+  else
+    puts "File not found: #{ARGV[0]}"
+  end
+else
+  puts "Usage: cheatorious cheatsheet_file [keyword]"
+end

data/bin/vim_example.rb

@@ -0,0 +1,34 @@
+cheatsheet_for "Simple VIM" do
+  
+    description "A simple VIM cheatsheet for tests"
+    author      "Luis Cipriani", "github.com/lfcipriani"
+    version     "1.0.0"
+  
+    key_separator " "
+  
+    key :control, "^"
+    key :esc    , "<esc>"
+    key :leader , ","
+
+    __ "Enter insertion mode", "i"
+    __ "Exit insertion mode" , _esc
+  
+    section "Basic Movement" do
+        __ "character left, right, line up, line down", "h", "l", "k", "j"
+        __ "word/token left, right"                   , "b", "w"
+    end
+  
+    section "Scrolling" do
+        __ "scroll line up, down", (_control "E"), (_control "Y")
+        __ "scroll page up, down", (_control "F"), (_control "B")
+    end
+  
+    section "Files" do
+        __ "Open file", ":e"
+    
+        section "Saving" do
+            __ "Save file", ":w"
+        end
+    end
+  
+end

data/lib/cheatorious/cheatsheet.rb

@@ -2,9 +2,9 @@ module Cheatorious
   class CheatSheet
     
     class << self
-      def compile(name, &block)
+      def compile(name, output = nil, &block)
         c = self.new(name, &block)
-        c.compile!
+        c.compile!(output)
       end
     end
     
@@ -15,29 +15,32 @@ module Cheatorious
       @block      = block
       @keys       = {}
       @cheat_hash = {
+        :info       => { :name => name },
         :cheatsheet => {
-          :root => {}
+          :root    => [],
+          :reverse => {}
         }
       }
       @current_section = @cheat_hash[:cheatsheet][:root]
-      @separator = ""
+      @stack           = []
+      @separator       = ""
     end
     
-    def compile!
+    def compile!(output = nil)
       self.instance_eval(&@block)
-      return @cheat_hash
+      return output ? Utils.serialize(@cheat_hash, output) : @cheat_hash
     end
     
     def description(info) 
-      root["description"] = info
+      root[:info][:description] = info
     end
     
     def version(numbers)
-      root["version"] = numbers.to_s
+      root[:info][:version] = numbers.to_s
     end
     
     def author(*args)
-      root["author"] = args
+      root[:info][:author] = args
     end
     
     def key_separator(separator)
@@ -49,22 +52,33 @@ module Cheatorious
     end
     
     def section(name, &block)
-      @current_section[:sections] = {} unless @current_section.key?(:sections)
-      @current_section[:sections][name] = {} unless @current_section[:sections].key?(name)
       parent_section = @current_section
-      @current_section = @current_section[:sections][name]
       
+      new_section = { name => [] }
+      @current_section = new_section[name]
+      
+      @stack.push(name)
       self.instance_eval(&block)
+      @stack.pop
       
       @current_section = parent_section
+      @current_section << new_section
     end
     
-    def ___(name, *values)
-      @current_section[:entries] = {} unless @current_section.key?(:entries)
-      @current_section[:entries][name] = [] unless @current_section[:entries].key?(name)
+    def __(name, *values) 
+      new_entry = [name]
+      
       values.each do |v|
-        @current_section[:entries][name] << v
+        new_entry << v
+        
+        reverse_entry = {
+          :name    => name,
+          :section => @stack.dup
+        }
+        reverse_index.key?(v) ? reverse_index[v] << reverse_entry : reverse_index[v] = [reverse_entry]
       end
+      
+      @current_section << new_entry
     end
     
     def method_missing(method, *args)
@@ -88,15 +102,9 @@ module Cheatorious
       @cheat_hash[:cheatsheet]
     end
 
+    def reverse_index
+      @cheat_hash[:cheatsheet][:reverse]
+    end
+
   end
 end
-
-# hash = {
-#   "description" => "bla",
-#   "cheatsheet" => {
-#     :root => {
-#             :entries => { "Save File" => [":w"] },
-#             :sections => { "files" => {} }
-#             }
-#   }
-# }

data/lib/cheatorious/search.rb

@@ -0,0 +1,77 @@
+module Cheatorious
+  class Search
+    
+    class << self
+      def execute(cheat_model, query = "", writer = Writer::Text, options = {})
+        s = self.new(cheat_model)
+        s.execute(query, writer, options)
+      end
+    end
+    
+    def initialize(cheat_model)
+      cheat_model  = Utils.deserialize(cheat_model, Utils.serialization_type(cheat_model)) if cheat_model.kind_of?(String)
+      @cheat_model = cheat_model
+    end
+    
+    def execute(query = "", writer = Writer::Text, options = {})
+      options[:print] = query.empty? ? :full : :partial
+      
+      filtered = @cheat_model[:cheatsheet][:root].dup
+      unless print_full?(options)
+        filtered, results_count = depth_search(query, filtered, options)
+      end
+      
+      w = writer.new(@cheat_model[:info])
+      print_full?(options) ? w.header : w.search_header(query, results_count, "")
+      write_contents(filtered, w, options)
+      w.footer if print_full?(options)
+      
+      return w.result
+    end
+    
+  private
+  
+    def depth_search(query, section, options)
+      match_count = 0
+      result = section.select do |item|
+        if item.kind_of?(Array) #entry
+          name = item[0]
+          result = match?(query, name)
+          match_count += 1 if result
+          result
+        elsif item.kind_of?(Hash) #section
+          name = item.keys.first
+          item[name], count = depth_search(query, item[name], options)
+          match_count += count
+          item[name].size > 0
+        else
+          false
+        end
+      end
+      return result, match_count
+    end
+  
+    def write_contents(section, writer, options)
+      section.each do |item|
+        if item.kind_of?(Array) #entry
+          name = item.shift
+          writer.entry(name, *item)
+        elsif item.kind_of?(Hash) #section
+          name = item.keys.first
+          writer.section_start(name)
+          write_contents(item[name], writer, options)
+          writer.section_end
+        end
+      end
+    end
+  
+    def match?(query, name)
+      not name.downcase.index(query.downcase).nil?
+    end
+  
+    def print_full?(options)
+      options[:print] == :full
+    end
+  
+  end
+end

data/lib/cheatorious/utils.rb

@@ -0,0 +1,21 @@
+module Cheatorious
+  class Utils
+    require "base64"
+    
+    def self.serialize(object, to = nil)
+      data = Marshal.dump(object)
+      data = Base64.encode64(data) if to == :base64
+      return data
+    end
+    
+    def self.deserialize(data, from = nil)
+      data   = Base64.decode64(data) if from == :base64
+      object = Marshal.load(data)
+      return object
+    end
+    
+    def self.serialization_type(data)
+      /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=|[A-Za-z0-9+\/]{4})$/ =~ data ? :base64 : :bytes
+    end
+  end
+end

data/lib/cheatorious/writer/text.rb

@@ -0,0 +1,64 @@
+module Cheatorious
+  module Writer    
+    class Text
+      def initialize(cheatsheet_info = {})
+        @info          = cheatsheet_info
+        @section_stack = []
+        @result        = ""
+      end
+      
+      def header
+        line
+        line "-" * 80
+        line "#{@info[:name]} (#{@info[:version]})"
+        line
+        line "Author     : #{@info[:author][0]} (#{@info[:author][1]})"
+        line "Description: #{@info[:description]}"
+        line "-" * 80
+        line
+      end
+      
+      def search_header(query, results_count, query_type)
+        line
+        line "Your search for '#{query}' returned #{results_count} #{results_count > 1 ? "entries" : "entry"}:" if results_count != 0
+        line "Your search for '#{query}' doesn't returned any entry. Try with another keyword." if results_count == 0
+        line
+      end
+      
+      def footer
+        line
+        line "-" * 80
+        line "generated by Cheatorious (https://github.com/lfcipriani/cheatorious)"
+      end
+      
+      def section_start(section)
+        @section_stack.push(section)
+        line indentation("-") + " #{section}"
+      end
+      
+      def section_end
+        @section_stack.pop
+      end
+      
+      def entry(name, *values)
+        e = "#{indentation(" ")} - #{name}: "
+        e << values.join(", ")
+        line e
+      end
+      
+      def result
+        @result
+      end
+      
+    private
+    
+      def line(str = "")
+        @result += str + "\n"
+      end
+      
+      def indentation(char)
+        char * 2 * @section_stack.size
+      end
+    end
+  end
+end

data/lib/cheatorious/writer.rb

@@ -0,0 +1,5 @@
+module Cheatorious
+  module Writer    
+    autoload :Text, "cheatorious/writer/text"
+  end
+end

data/lib/cheatorious.rb

@@ -8,5 +8,8 @@ require "bundler/setup"
 # Gem requirements
 module Cheatorious
   autoload :CheatSheet, "cheatorious/cheatsheet"
+  autoload :Utils     , "cheatorious/utils"
+  autoload :Search    , "cheatorious/search"
+  autoload :Writer    , "cheatorious/writer"
   autoload :VERSION   , 'cheatorious/version'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cheatorious
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-08 00:00:00.000000000Z
+date: 2011-12-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: step-up
-  requirement: &2152980340 !ruby/object:Gem::Requirement
+  requirement: &2152580060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152980340
+  version_requirements: *2152580060
 description: 
 email: lfcipriani@gmail.com
 executables: []
@@ -29,12 +29,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .travis.yml
+- LICENSE
 - README.md
+- bin/cheatorious
+- bin/vim_example.rb
 - cheatorious.gemspec
 - lib/cheatorious.rb
 - lib/cheatorious/.gitkeep
 - lib/cheatorious/cheatsheet.rb
+- lib/cheatorious/search.rb
+- lib/cheatorious/utils.rb
 - lib/cheatorious/version.rb
+- lib/cheatorious/writer.rb
+- lib/cheatorious/writer/text.rb
 - lib/tasks/task_sample.rake
 - GEM_VERSION
 homepage: https://github.com/abril/cheatorious
@@ -51,7 +58,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2831247960477896023
+      hash: 4106099593151906772
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: