cheatorious 0.1.1 → 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+#v0.2.0 (Dec/29 2011 09:59 -0200 by Luis Cipriani)
+
+    Changes:
+
+      - Changed Writer#header and constructor method signature
+      - Command line interface parser now is done by Thor
+
+    Features:
+
+      - Added the following commands to the command line interface
+        - list
+        - import
+        - view
+        - search
+        - writers
+        - alias
+      - All the settings and compiled cheatsheets are saved to .cheatorious home folder
+      - Provided reverse, section, sensitive search filters
+      - Added simple_vim sample by default to every installation
+
+#v0.1.1 (2011-12-12)
+
+    Bugfixes:
+
+      - Configured executables in the gemspec file
+
+# v0.1.0 (2011-12-12)
+
+    Features:
+
+      - basic gem structure and initial implementation of DSL
+      - dsl now support keyboard key settings
+      - maintaining a reverse index for other types of searches
+      - Ruby DSL to create your cheatsheets
+      - Command-line interface
+        - input the cheatsheet file
+        - full listing
+        - search by keyword
+      - Compilation
+        - marshal serialization
+        - base64 serialization
+        - serialized types verification
+      - Writers (output formating)
+        - simple text ouptut
+
+----
+_this cheatsheet is generated by [step-up](https://github.com/kawamanza/step-up)_

data/GEM_VERSION

@@ -1 +1 @@
-v0.1.1
+v0.2.0+1

data/README.md

@@ -25,7 +25,7 @@ Create a file and use the following syntax, shown in the example below:
         author      "Luis Cipriani", "github.com/lfcipriani"
         version     "1.0.0"
 
-        # you can configure some keyboard keys variables
+        # you can configure some keyboard keys variables, you can change it later to fit your personal preferences
         key :control, "^"
         key :esc    , "<esc>"
         key :leader , ","
@@ -53,48 +53,84 @@ Create a file and use the following syntax, shown in the example below:
         section "Files" do
             __ "Open file", ":e"
 
-            # you can go infinitely deep with sections
+            # you can go infinitely deep with sections (seriously)
             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]
+    $ cheatorious                           # get help
+    $ cheatorious help [TASK]               # get help for a specific task
+    $ cheatorious import FILE               # import a cheatsheet description FILE (example above)
+    $ cheatorious list                      # lists the available cheatsheets
+    $ cheatorious view CHEATSHEET [OPTIONS] # view a CHEATSHEET
     
-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.
+To search on your cheatsheets:
+    
+    $ cheatorious help search
+    Usage:
+      cheatorious search CHEATSHEET [KEYWORD] [OPTIONS]
 
-I'm working to let this usage even more simple and fast.
+    Options:
+      -s, [--section]        # matches KEYWORD only on section names, returning all entries and sections inside it.
+      -r, [--reverse]        # reverse means to search only the values of a cheatsheet (and not entries, as usual). For example, search by shortcuts.
+      -S, [--sensitive]      # case sensitive search (insensitive is default).
+      -w, [--writer=WRITER]  # writer to use for the output. If not set, uses the default.
 
-## TODO ##
+    search for KEYWORD in CHEATSHEET entries only.
+    The CHEATSHEET variable could be a name (for imported cheatsheets) or a file that describes a cheatsheet.
+    Omit KEYWORD to view the full cheatsheet.
+
+If you are tired to type everything above to do a simple search, use the alias command:
+
+    $ bin/cheatorious help alias
+    Usage:
+      cheatorious alias NAME CHEATSHEET
+
+    return a shell alias command with NAME for easy access to searching a CHEATSHEET.
+    The CHEATSHEET variable must be an imported cheatsheet.
+    Example: cheatorious alias svim simple_vim >> ~/.bashrc
+             next time just use: svim KEYWORD [OPTIONS]
+
+The command will just show the command, it's up to you to decide where to put it.
 
-* search by sections
-* reverse search
-* standalone script generation
-* case sensitive search
-* better ouput layout, colored
-* more features in command line
-* other output writers
+## Writers ##
 
-## Tips ##
+Cheatorious has a default Text writer to give a fairly nice output for your cheatsheet. Since we can have multiple writers avaiable, you can list and set a default writer through the command *writers*:
+
+    $ bin/cheatorious help writers
+    Usage:
+      cheatorious writers [OPTIONS]
+
+    Options:
+      -d, [--default=DEFAULT]  # set a default writer for next searches.
+
+    lists the available writers or set a default
+
+I'll work to provide more options of output as soon as possible (markdown, colored, HTML, etc), but you can also contribute writing your own writers and sending a pull request to this project. Check the examples folder to see a Writer sample, you just need to implement that interface.
+
+## Tips to improve the experience! ##
 
 * In Macs, cheatorious is very powerful if used with [DTerm](http://decimus.net/DTerm)
+* Create aliases to save typings in the cheatsheets you use more
+* Sync your cheatsheets with Dropbox by creating a symlink for the `~/.cheatorious` folder
+
+## TODO ##
+
+* standalone script generation (works indenpendently of cheatorious being installed or not)
+* more writers, better ouput layout, colored
+* more cheatsheets
 
 ## Contributing ##
 
-You can contribute in the Core, with Writers or Cheatsheets, feel free.
+If you have cheatsheets, share with us at [cheatorious cheatsheet repository](https://github.com/lfcipriani/cheatorious-cheatsheets).
+
+You can also contribute in the Core or Writers, feel free to:
 
 * Fork
 * Implement tests

data/bin/cheatorious

@@ -1,19 +1,4 @@
 #!/usr/bin/env ruby
-@cheatsheet_model = nil
-def cheatsheet_for(name, &block)
-  @cheatsheet_model = Cheatorious::CheatSheet.compile(name, &block)
-end
+require File.expand_path(File.dirname(__FILE__) + '/../lib/cheatorious')
 
-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
+Cheatorious::CLI.start

data/examples/writer_sample.rb

@@ -0,0 +1,70 @@
+module Cheatorious
+  module Writer    
+    # This is an example of a Writer
+    #
+    # To implement your own Writer, just create a class inside 
+    # Cheatorious::Writer module and implement the interface 
+    # represented by the public methods below.
+    class WriterSample
+      def initialize
+        @section_stack = []
+        @result        = ""
+      end
+      
+      def header(name, author = "", version = "", description = "")
+        line
+        line "-" * 80
+        line "#{name} (#{version})"
+        line
+        line "Author     : #{author[0]} (#{author[1]})"
+        line "Description: #{description}"
+        line "-" * 80
+        line
+      end
+      
+      def search_header(query, results_count, options)
+        search_type = options.keys.join(", ")
+        search_type += " " if search_type.size > 0
+        line
+        line "Your #{search_type}search for '#{query}' returned #{results_count} #{results_count > 1 ? "results" : "result"}:" if results_count != 0
+        line "Your #{search_type}search for '#{query}' doesn't returned any result. 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.rb

@@ -5,8 +5,18 @@ $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__))
 require "rubygems"
 require "bundler/setup"
 
+# Adding Dir.home method if it's not available
+unless Dir.respond_to?(:home)
+  class Dir
+    def self.home
+      File.expand_path(File.join("~"))
+    end
+  end
+end
+
 # Gem requirements
 module Cheatorious
+  autoload :CLI       , "cheatorious/cli"
   autoload :CheatSheet, "cheatorious/cheatsheet"
   autoload :Utils     , "cheatorious/utils"
   autoload :Search    , "cheatorious/search"

data/lib/cheatorious/cheatsheet.rb

@@ -17,8 +17,7 @@ module Cheatorious
       @cheat_hash = {
         :info       => { :name => name },
         :cheatsheet => {
-          :root    => [],
-          :reverse => {}
+          :root    => []
         }
       }
       @current_section = @cheat_hash[:cheatsheet][:root]
@@ -70,12 +69,6 @@ module Cheatorious
       
       values.each do |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
@@ -101,10 +94,6 @@ module Cheatorious
     def sheet
       @cheat_hash[:cheatsheet]
     end
-
-    def reverse_index
-      @cheat_hash[:cheatsheet][:reverse]
-    end
-
+    
   end
 end

data/lib/cheatorious/cli.rb

@@ -0,0 +1,130 @@
+require 'thor'
+
+module Cheatorious
+  module DslExecutor
+    def self.cheatsheet_for(name, &block)
+      Cheatorious::CheatSheet.compile(name, @output, &block)
+    end
+  end
+  
+  class CLI < Thor
+    include Thor::Actions
+    
+    desc "list", "lists the available cheatsheets. See 'import' command."
+    def list
+      ensure_workspace_exist
+      puts (cheatsheet_list.empty? ? "You don't have imported cheatsheets. See 'import' command." : "You have #{cheatsheet_list.size} cheatsheet(s):")
+      puts cheatsheet_list.join("\n")
+    end
+    
+    desc "import FILE", "import a cheatsheet description FILE.\nCheck https://github.com/lfcipriani/cheatorious to learn how to create your own cheatsheets."
+    def import(file)
+      ensure_workspace_exist
+      name = File.basename(file, ".rb")
+      return if cheatsheet_list.include?(name) && 
+                !yes?("Do you want to override the existent #{name} cheatsheet? (y/n)")
+      if File.exist?(file)
+        source = File.read(file)
+        bytes = DslExecutor.module_eval("@output = :bytes\n"+source)
+        File.open(File.join(workspace_path, "compiled", name), 'w') {|f| f.write(bytes) }
+        File.open(File.join(workspace_path, "originals", name + ".rb"), 'w') {|f| f.write(source) }
+        puts "Cheatsheet imported successfuly! Try 'cheatorious view #{name}'\nThe original cheatsheet file was copied to #{File.join(workspace_path, "originals", name + ".rb")}"
+      else
+        puts "The specified file doesn't exist: #{file}"
+      end
+    end
+    
+    desc "view CHEATSHEET [OPTIONS]", "view a CHEATSHEET.\nThe CHEATSHEET variable could be a name (for imported cheatsheets) or a file that describes a cheatsheet."
+    method_option :writer, :aliases => "-w", :type => :string, :desc => "writer to use for the output. If not set, uses the default."
+    def view(cheatsheet)
+      invoke :search
+    end
+    
+    desc "search CHEATSHEET [KEYWORD] [OPTIONS]", "search for KEYWORD in CHEATSHEET entries only.\nThe CHEATSHEET variable could be a name (for imported cheatsheets) or a file that describes a cheatsheet.\nOmit KEYWORD to view the full cheatsheet."
+    method_option :section, :aliases => "-s", :type => :boolean, :desc => "matches KEYWORD only on section names, returning all entries and sections inside it."
+    method_option :reverse, :aliases => "-r", :type => :boolean, :desc => "reverse means to search only the values of a cheatsheet (and not entries, as usual). For example, search by shortcuts."
+    method_option :sensitive, :aliases => "-S", :type => :boolean, :desc => "case sensitive search (insensitive is default)."
+    method_option :writer, :aliases => "-w", :type => :string, :desc => "writer to use for the output. If not set, uses the default."
+    def search(cheatsheet, keyword = "")
+      ensure_workspace_exist
+      writer = options["writer"] ? writer_for(options["writer"]) : default_writer
+      model = nil
+      if cheatsheet_list.include?(cheatsheet)
+        model = File.read(File.join(workspace_path, "compiled", cheatsheet))
+      elsif File.exist?(cheatsheet)
+        model = DslExecutor.module_eval("@output = nil\n" + File.read(cheatsheet))
+      end
+      if model
+        puts Cheatorious::Search.execute(model, keyword, writer, options.dup)
+      else
+        puts "Invalid cheatsheet name or file name: #{cheatsheet}"
+      end
+    end
+
+    desc "writers [OPTIONS]", "lists the available writers or set a default"
+    method_option :default, :aliases => "-d", :type => :string, :desc => "set a default writer for next searches."
+    def writers
+      ensure_workspace_exist
+      if options["default"]
+        if Cheatorious::Writer.constants.map {|c| c.to_s}.include?(options["default"])
+          config = YAML.load(File.open(File.join(workspace_path, "config")))
+          config["default_writer"] = options["default"]
+          File.open(File.join(workspace_path, "config"), "w") {|f| f.write(config.to_yaml) }
+          puts "The default writer now is #{options["default"]}"
+        else
+          puts "Invalid writer name, use 'cheatorious writers' to choose one from the available."
+        end
+      else
+        puts "The following writers are available:\n"
+        dw = default_writer.to_s
+        puts Cheatorious::Writer.constants.map {|w| (dw.end_with?(w.to_s) ? w.to_s + " (default)" : w.to_s) }.join("\n")
+        puts "\nUse -d option to set a default writer."
+      end
+    end
+    
+    desc "alias NAME CHEATSHEET", "return a shell alias command with NAME for easy access to searching a CHEATSHEET.\nThe CHEATSHEET variable must be an imported cheatsheet.\nExample: cheatorious alias svim simple_vim >> ~/.bashrc\n         next time just use: svim KEYWORD [OPTIONS]"
+    def alias(name, cheatsheet)
+      ensure_workspace_exist
+      if cheatsheet_list.include?(cheatsheet)
+        puts "alias #{name}='cheatorious search #{cheatsheet}'"
+      else
+        puts "Invalid cheatsheet name: #{cheatsheet}"
+      end
+    end
+    
+  private
+
+    def cheatsheet_list
+      Dir[File.join(workspace_path, "compiled", "*")].map {|c| File.basename(c)}
+    end
+
+    def writer_for(constant)
+      Cheatorious::Writer.const_get(constant)
+    end
+
+    def default_writer
+      writer_for(YAML.load(File.open(File.join(workspace_path, "config")))["default_writer"])
+    end
+    
+    def ensure_workspace_exist
+      unless File.directory?(workspace_path)
+        Dir.mkdir(workspace_path)
+      end
+      unless File.exist?(File.join(workspace_path, "config"))
+        create_file File.join(workspace_path, "config"), "default_writer: Text\n", :verbose => false
+      end
+      unless File.directory?(File.join(workspace_path, "compiled"))
+        Dir.mkdir(File.join(workspace_path, "compiled"))
+        FileUtils.cp(File.expand_path(File.join(__FILE__, "..", "..", "..", "examples", "simple_vim")), File.join(workspace_path, "compiled"))
+      end
+      unless File.directory?(File.join(workspace_path, "originals"))
+        Dir.mkdir(File.join(workspace_path, "originals"))
+        FileUtils.cp(File.expand_path(File.join(__FILE__, "..", "..", "..", "examples", "simple_vim.rb")), File.join(workspace_path, "originals"))
+      end
+    end
+    
+    def workspace_path
+      @workspace ||= File.join(Dir.home, ".cheatorious")
+    end
+  end
+end

data/lib/cheatorious/search.rb

@@ -14,17 +14,20 @@ module Cheatorious
     end
     
     def execute(query = "", writer = Writer::Text, options = {})
-      options[:print] = query.empty? ? :full : :partial
+      info = @cheat_model[:info]
+      options.delete("reverse") if options["section"] && options["reverse"]
       
+      # Filtering
       filtered = @cheat_model[:cheatsheet][:root].dup
-      unless print_full?(options)
+      unless print_full?(query)
         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, "")
+      # Writing
+      w = writer.new
+      print_full?(query) ? w.header(info[:name], info[:author], info[:version], info[:description]) : w.search_header(query, results_count, options)
       write_contents(filtered, w, options)
-      w.footer if print_full?(options)
+      w.footer if print_full?(query)
       
       return w.result
     end
@@ -33,21 +36,43 @@ module Cheatorious
   
     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
+          unless options["section"]
+            name = item[0]
+            matched = false
+            if options["reverse"]
+              item[1..-1].each do |value|
+                matched = match?(query, value, options["sensitive"])
+                break if matched
+              end
+            else
+              matched = match?(query, name, options["sensitive"])
+            end
+            match_count += 1 if matched
+            matched
+          else
+            false
+          end
+          
         elsif item.kind_of?(Hash) #section
           name = item.keys.first
-          item[name], count = depth_search(query, item[name], options)
+          if options["section"] && match?(query, name, options["sensitive"])
+            count = 1
+          else
+            item[name], count = depth_search(query, item[name], options)
+          end
           match_count += count
           item[name].size > 0
+          
         else
           false
         end
+        
       end
+      
       return result, match_count
     end
   
@@ -65,12 +90,12 @@ module Cheatorious
       end
     end
   
-    def match?(query, name)
-      not name.downcase.index(query.downcase).nil?
+    def match?(query, name, sensitive)
+      !(Regexp.new(Regexp.escape(query), (sensitive ? 0 : Regexp::IGNORECASE)) =~ name).nil?
     end
   
-    def print_full?(options)
-      options[:print] == :full
+    def print_full?(query)
+      query.empty?
     end
   
   end

data/lib/cheatorious/writer/text.rb

@@ -1,27 +1,28 @@
 module Cheatorious
   module Writer    
     class Text
-      def initialize(cheatsheet_info = {})
-        @info          = cheatsheet_info
+      def initialize
         @section_stack = []
         @result        = ""
       end
       
-      def header
+      def header(name, author = "", version = "", description = "")
         line
         line "-" * 80
-        line "#{@info[:name]} (#{@info[:version]})"
+        line "#{name} (#{version})"
         line
-        line "Author     : #{@info[:author][0]} (#{@info[:author][1]})"
-        line "Description: #{@info[:description]}"
+        line "Author     : #{author[0]} (#{author[1]})"
+        line "Description: #{description}"
         line "-" * 80
         line
       end
       
-      def search_header(query, results_count, query_type)
+      def search_header(query, results_count, options)
+        search_type = options.keys.join(", ")
+        search_type += " " if search_type.size > 0
         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 "Your #{search_type}search for '#{query}' returned #{results_count} #{results_count > 1 ? "results" : "result"}:" if results_count != 0
+        line "Your #{search_type}search for '#{query}' doesn't returned any result. Try with another keyword." if results_count == 0
         line
       end
       

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cheatorious
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-12 00:00:00.000000000Z
+date: 2011-12-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: step-up
-  requirement: &2152241560 !ruby/object:Gem::Requirement
+  requirement: &2152693740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152241560
+  version_requirements: *2152693740
 description: 
 email: lfcipriani@gmail.com
 executables:
@@ -30,20 +30,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .travis.yml
+- CHANGELOG.md
 - LICENSE
 - README.md
 - bin/cheatorious
-- bin/vim_example.rb
 - cheatorious.gemspec
+- examples/simple_vim
+- examples/simple_vim.rb
+- examples/writer_sample.rb
 - lib/cheatorious.rb
 - lib/cheatorious/.gitkeep
 - lib/cheatorious/cheatsheet.rb
+- lib/cheatorious/cli.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
 licenses: []
@@ -59,7 +62,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4020292091748225162
+      hash: 3692149591727871031
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/tasks/task_sample.rake

@@ -1,7 +0,0 @@
-# encoding: UTF-8
-namespace :gem_name do
-  desc 'task description'
-  task :utils => :environment do
-    # this task loads up the gem environment
-  end
-end