jquery-cheat 0.1.2 → 0.2.0

data/History.txt

@@ -6,4 +6,9 @@
 == 0.1.1 2007-06-01
 
 * 1 minor bugfix
-  * Fixed a bug in pathname
+  * Fixed a bug in pathname
+  
+== 0.1.2 2007-06-01
+
+* 1 minor bugfix
+  * removed dependency on Marshal

data/Manifest.txt

@@ -5,7 +5,9 @@ README.txt
 Rakefile
 bin/jcheat
 lib/index.xml
+lib/jquery-cheat.rb
 lib/jquery-cheat/version.rb
+lib/merger.rb
 scripts/txt2html
 setup.rb
 test/test_helper.rb

data/README.txt

@@ -1,3 +1,61 @@
 README for jquery-cheat
 =======================
 
+jQuery Cheat provides a command-line interface to the jQuery API.
+
+== Usage
+
+jcheat COMMAND [COMMAND_PREFS] [--name NAME [--precise]] 
+  [--module MODULE [--recursive]] [--like STRING] 
+  [--params PARAM1[,PARAM2...]] [--no-examples]
+
+ (describe|desc) METHOD_NAME [PARAM1, ...]
+      > the full description of each method matching METHOD_NAME.
+      > If you also pass optional PARAMs, the list of matching
+      > methods will be filtered to include only methods with those
+      > parameters.
+      >
+      > --no-examples(-e) suppresses examples from the output
+      > 
+      > Example: "jcheat desc $ html" will return the description
+      > of the $ method with an "html" parameter.
+        
+ * list MODULE_NAME
+      > A list of all methods directly under a specific module. Passing
+      > an optional "-r" will return a list of all methods at any level
+      > under the module.
+      >
+      > Example: "jcheat list DOM/Traversing"
+ 
+ * (apopros|ap|like) STRING
+      > A list of all methods whose description contains all of the
+      > words in STRING.
+      >
+      > Example: "jcheat like clear fields"
+      
+ * named STRING
+      > A list of all methods named exactly STRING.
+      >
+      > Example: "jcheat named $"
+      
+ * (namelike|nl) STRING
+      > A list of all methods whose names contain STRING.
+      >
+      > Example: "jcheat nl clear"
+      
+ FILTERS
+ -------
+ 
+ [--name(-n) NAME [--substrings(-s)]] filters methods by their name.
+   Adding the --precise flag will allow a substring match.
+   
+ [--module(-m) MODULE [--recursive(-r)]] filters methods by the
+   module they are in. Adding the --recursive flag will check
+   submodules (ex: -m DOM -r will search for methods in DOM,
+   DOM/Traversal, etc.)
+   
+ [--like(-l) STRING] filters methods by words in their description.
+ 
+ [--params(-o) PARAM1[,PARAM2...]] filters methods by those that
+   contain all of the parameters passed in. Parameters should be
+   passed as a comma-separated list.

data/bin/jcheat

@@ -1,91 +1,37 @@
 #!/usr/bin/env ruby
 
+require 'getoptlong'
 require 'rubygems'
 require 'hpricot'
 gem 'jquery-cheat'
+require 'jquery-cheat'
 
-PATH = File.join(Gem.cache.search("jquery-cheat").sort_by{|x| x.version.version}.last.full_gem_path, 'lib','index.xml')
+opts = GetoptLong.new(
+  [ '--recursive', '-r', GetoptLong::NO_ARGUMENT ],
+  [ '--module', '-m', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--name', '-n', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--substring', '-s', GetoptLong::NO_ARGUMENT ],
+  [ '--like', '-l', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--params', '-o', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--no-examples', '-e', GetoptLong::NO_ARGUMENT ],
+  [ '--help', '-h', GetoptLong::NO_ARGUMENT ]
+)
 
-class JQueryMethod
-  
-  attr_accessor :short, :long, :cat, :params, :options, :examples, :name, :attributes, :param_order, :type
-  
-  def initialize elem
-    @name        = elem.attributes["name"]
-    @short       = elem.attributes["short"]
-    @long        = elem.search("> desc").inner_text
-    @cat         = elem.attributes["cat"]
-    @params      = elem.search("params").inject({}) {|s,p| s.merge(p.attributes["name"] => [p.search("desc").inner_text, p.attributes["type"]]) }
-    @param_order = elem.search("params").map {|p| p.attributes["name"]}
-    @options     = elem.search("options").inject({}) {|s,p| s.merge(p.attributes["name"] => [p.search("desc").inner_text, p.attributes["type"]]) }
-    @type        = elem.attributes["type"]
-    @examples    = elem.search("examples").map do |example|
-      {:desc     => example.search("desc").inner_text,
-       :before   => example.search("before").inner_text,
-       :code     => example.search("code").inner_text,
-       :result   => example.search("result").inner_text
-      }
-    
-    end
-    @attributes = elem.attributes
-  end
-  
-  def signature
-    "#{name}#{"(#{ param_order.join(", ") })" if !attributes["property"] } in #{cat}"
-  end
-  
-end
-
-class JQueryMethods < Array
-  
-  @@parsed = Hpricot::XML(File.read(PATH))
-  
-  def initialize els
-    push(*els.to_jquery_methods)
-  end
-  
-  def self.with_name_and_params name, *params
-    new(@@parsed.search("method[@name='#{name}']").reject{|m| params.any? {|p| m.search("params[@name=#{p}]").length == 0 } })
-  end
-  
-  def self.in_module mod, recursive
-    new(@@parsed.search("[@cat#{ '*' if recursive.to_s =~ /^\-?r/i }='#{mod}']")).named_list
-  end
-  
-  def self.description_matches list
-    new(@@parsed.search("method").select {|m| list.all? {|t| m.search("> desc").inner_text =~ /#{t}/i} }).named_list
-  end
-  
-  def self.named name, precise = false
-    new(@@parsed.search("method[@name#{ precise ? "=" : "*=" }'#{name}']")).named_list
-  end
-  
-  def named_list
-    list = inject([]) {|s,m| s.push(m.signature) }
-    list.empty? ? ["No items found"] : list
-  end
-  
-end
+line = "-" * 80
 
-class Array
-  
-  def to_jquery_methods
-    map {|m| JQueryMethod.new(m)}
-  end
-  
-end
+opts_hash = {}
 
-class String
-  
-  def word_wrap cols, padding = 0
-    gsub(/\n\n/, "\r").gsub(/\n/, ' ').gsub(/\r/, "\n\n#{' ' * 14}").gsub(/(.{1,#{cols}}|\S{#{cols + 1},})(?: +|$\n?)/, "\\1\n#{ ' ' * padding}")
+opts.each do |opt, arg| 
+  case opt
+    when '--params'
+      opts_hash[:params] = arg.split(",")
+    else
+      opts_hash[opt.gsub("--", "").to_sym] = (arg || true)
   end
 end
 
-line = "-" * 80
-
 if ARGV[0] == "describe" || ARGV[0] == "desc"
-  methods = JQueryMethods.with_name_and_params(ARGV[1], *ARGV[2..-1])
+  methods = JQuery::Methods.new(:name => ARGV[1], :params => ARGV[2..-1])
 
   for method in methods
     puts line
@@ -94,37 +40,47 @@ if ARGV[0] == "describe" || ARGV[0] == "desc"
           "Description:  #{method.short.word_wrap(62, 14)}\n" +                                                                                    
           "Details:      #{method.long.word_wrap(62, 14)}\n" +
           "Returns:      #{method.type}\n"
-    puts "#{line}\n|#{" " * 35 }EXAMPLES#{" " * 35}|\n#{line}\n"
-    for example in method.examples
-      puts "---------------\n| Description |\n---------------\n#{example[:desc].word_wrap(80)}\n" if example[:desc] != ""
-      puts "----------\n| Before |\n----------\n#{example[:before]}\n\n" if example[:before] != ""
-      puts "--------\n| Code |\n--------\n#{example[:code]}\n\n" if example[:code] != ""
-      puts "----------\n| Result |\n----------\n#{example[:result]}\n\n" if example[:result] != ""
-      puts "\n"
+
+    if !opts_hash[:"no-examples"]
+      puts "#{line}\n|#{" " * 35 }EXAMPLES#{" " * 35}|\n#{line}\n"
+    
+      for example in method.examples
+        puts "---------------\n| Description |\n---------------\n#{example[:desc].word_wrap(80)}\n" if example[:desc] != ""
+        puts "----------\n| Before |\n----------\n#{example[:before]}\n\n" if example[:before] != ""
+        puts "--------\n| Code |\n--------\n#{example[:code]}\n\n" if example[:code] != ""
+        puts "----------\n| Result |\n----------\n#{example[:result]}\n\n" if example[:result] != ""
+        puts "\n"
+      end
     end
   end
 elsif ARGV[0] == "list"
-  puts JQueryMethods.in_module(ARGV[1], ARGV[2]).join("\n")
+  hash = {:module => ARGV[1]}
 elsif ARGV[0] =~ /^(apopros|ap|like)$/
-  puts JQueryMethods.description_matches(ARGV[1..-1]).join("\n")
+  hash = {:like => ARGV[1..-1]}
 elsif ARGV[0] == "named"
-  puts JQueryMethods.named(ARGV[1], true).join("\n")
+  hash = {:name => ARGV[1]}
 elsif ARGV[0] =~ /^(namelike|nl)$/
-  puts JQueryMethods.named(ARGV[1], false).join("\n")  
-else
+  hash = {:name => ARGV[1], :substring => true}
+elsif ARGV[0] == "tree"
+  JQuery.print_tree(JQuery.convert(JQuery::Parser.category_list))
+elsif opts_hash[:help]
   puts %q{
-    jcheat takes any of the following parameters:
+    jcheat COMMAND [COMMAND_PREFS] [--name NAME [--precise]] 
+      [--module MODULE [--recursive]] [--like STRING] 
+      [--params PARAM1[,PARAM2...]] [--no-examples]
     
      (describe|desc) METHOD_NAME [PARAM1, ...]
           > the full description of each method matching METHOD_NAME.
           > If you also pass optional PARAMs, the list of matching
           > methods will be filtered to include only methods with those
           > parameters.
+          >
+          > --no-examples(-e) suppresses examples from the output
           > 
           > Example: "jcheat desc $ html" will return the description
           > of the $ method with an "html" parameter.
             
-     * list MODULE_NAME [-r]
+     * list MODULE_NAME
           > A list of all methods directly under a specific module. Passing
           > an optional "-r" will return a list of all methods at any level
           > under the module.
@@ -146,6 +102,28 @@ else
           > A list of all methods whose names contain STRING.
           >
           > Example: "jcheat nl clear"
+          
+     FILTERS
+     -------
+     
+     [--name(-n) NAME [--substrings(-s)]] filters methods by their name.
+       Adding the --precise flag will allow a substring match.
+       
+     [--module(-m) MODULE [--recursive(-r)]] filters methods by the
+       module they are in. Adding the --recursive flag will check
+       submodules (ex: -m DOM -r will search for methods in DOM,
+       DOM/Traversal, etc.)
+       
+     [--like(-l) STRING] filters methods by words in their description.
+     
+     [--params(-o) PARAM1[,PARAM2...]] filters methods by those that
+       contain all of the parameters passed in. Parameters should be
+       passed as a comma-separated list.
      
   }
+  
+else
+  hash = {}
 end
+
+puts JQuery::Methods.new(opts_hash.merge(hash)).named_list.sort.join("\n") if hash

data/lib/jquery-cheat.rb

@@ -0,0 +1,113 @@
+require 'getoptlong'
+require 'rubygems'
+require 'hpricot'
+gem 'jquery-cheat'
+require 'merger'
+
+PATH = File.join(Gem.cache.search("jquery-cheat").sort_by{|x| x.version.version}.last.full_gem_path, 'lib','index.xml')
+
+class JQuery::Method
+  
+  attr_accessor :short, :long, :cat, :params, :options, :examples, :name, :attributes, :param_order, :type
+  
+  def initialize elem
+    @name        = elem.attributes["name"]
+    @short       = elem.attributes["short"]
+    @long        = elem.search("> desc").inner_text
+    @cat         = elem.attributes["cat"]
+    @params      = elem.search("params").inject({}) {|s,p| s.merge(p.attributes["name"] => [p.search("desc").inner_text, p.attributes["type"]]) }
+    @param_order = elem.search("params").map {|p| p.attributes["name"]}
+    @options     = elem.search("options").inject({}) {|s,p| s.merge(p.attributes["name"] => [p.search("desc").inner_text, p.attributes["type"]]) }
+    @type        = elem.attributes["type"]
+    @examples    = elem.search("examples").map do |example|
+      {:desc     => example.search("desc").inner_text,
+       :before   => example.search("before").inner_text,
+       :code     => example.search("code").inner_text,
+       :result   => example.search("result").inner_text
+      }
+    
+    end
+    @attributes = elem.attributes
+  end
+  
+  def signature
+    "#{name}#{"(#{ param_order.join(", ") })" if !attributes["property"] } in #{cat}"
+  end
+  
+end
+
+class JQuery::Parser
+
+  @@parsed = Hpricot::XML(File.read(PATH))
+  
+  # The options hash supports the following options
+  # <tt>name</tt>::       search for methods matching the name passed
+  # <tt>substring</tt>::  to be used with :name. If :substring is true, all functions containing the substring passed in :name
+  #                       will be returned (defaults to false).
+  # <tt>module</tt>::     search for methods in :module
+  # <tt>recursive</tt>::  to be used with :module. If :recursive is true, all functions in :module, or its child modules will
+  #                       be returned (defaults to false)
+  # <tt>like</tt>::       search for methods whose descriptions include any strings included in the Array :like
+  # <tt>params</tt>::     search for methods whose parameters include all of the strings include in the Array :params
+  def self.get_methods_by_hash options = {}
+    filters = "method"
+    filters += "[@name#{ '*' if options[:substring] }='#{options[:name]}']" if options[:name]
+    filters += "[@cat#{ '*' if options[:recursive] }='#{options[:module]}']" if options[:module]
+    methods = @@parsed.search(filters)
+    methods.reject! {|m| options[:like].any? {|t| m.search("> desc").inner_text !~ /#{t}/i} } if options[:like]
+    methods.reject! {|m| options[:params].any? {|p| m.search("params[@name=#{p}]").length == 0 } } if options[:params]
+    methods
+  end
+  
+  def self.category_list
+    @@parsed.search("[@cat]").map {|x| x.get_attribute("cat")}.uniq
+  end
+  
+end
+
+class JQuery::Methods < Array
+  
+  def initialize els
+    if(els.is_a?(Hash))
+      push(*JQuery::Parser.get_methods_by_hash(els).to_jquery_methods)
+    else
+      push(*els.to_jquery_methods)
+    end      
+  end
+  
+  def self.get_methods options = {}
+    JQuery::Parser.get_methods_by_hash(options)
+  end
+
+  def self.with_name_and_params name, *params
+    new(@@parsed.search("method[@name='#{name}']").reject{|m| params.any? {|p| m.search("params[@name=#{p}]").length == 0 } })
+  end
+  
+  def named_list
+    list = inject([]) {|s,m| s.push(m.signature) }
+    list.empty? ? ["No items found"] : list
+  end
+  
+end
+
+class Array
+  
+  def to_jquery_methods
+    map {|m| JQuery::Method.new(m)}
+  end
+  
+end
+
+class String
+  
+  def word_wrap cols, padding = 0
+    gsub(/\n\n/, "\r").gsub(/\n/, ' ').gsub(/\r/, "\n\n#{' ' * 14}").gsub(/(.{1,#{cols}}|\S{#{cols + 1},})(?: +|$\n?)/, "\\1\n#{ ' ' * padding}")
+  end
+  
+end
+
+class GetoptLong
+  
+  attr_accessor :argument_flags
+  
+end

data/lib/jquery-cheat/version.rb

@@ -1,8 +1,8 @@
 module JQueryCheat #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 1
-    TINY  = 2
+    MINOR = 2
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/merger.rb

@@ -0,0 +1,27 @@
+module JQuery
+
+  def self.convert(a)
+    h = {}
+    a.each do |s|
+      parse_into(h, s)
+    end
+    h
+  end
+
+  def self.parse_into(frob, s)
+    s.split("/").each { |s1| frob = (frob[s1] ||= {}) }
+  end
+  
+  def self.print_tree(hsh, c = 0)
+    hsh.each do |k,v|
+      puts k
+      if c > 0
+        print "|#{'-' * c}"
+      end
+      if v != {}
+        self.print_tree(v, c + 1)
+      end
+    end
+  end
+  
+end

data/test/test_jquery-cheat.rb

@@ -1,11 +1,92 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
+require 'flexmock/test_unit'
+
+StubMethod  = JQueryMethod.dup
+StubMethods = JQueryMethods.dup
+
+class StubMethod
+  def initialize options = {}
+    @name = options[:name] || "function"
+    @param_order = options[:param_order] || ["param1", "param2"]
+    @cat = options[:cat] || "MyModule"
+    @attributes = options[:attributes] || {}
+  end
+end
+
+class StubMethods < Array
+  def initialize *args
+    if args[0]
+      args[0].each {|hsh| self.push(StubMethod.new(hsh)) }
+    else
+      push(StubMethod.new)
+      push(StubMethod.new(:name => "function2", :param_order => ["param_b1"], :cat => "MyModule", :attributes => {:property => true}))
+    end
+  end
+end
 
 class TestJQueryCheat < Test::Unit::TestCase
 
+  @@parsed = Hpricot::XML(File.read(File.join(Gem.cache.search("jquery-cheat").sort_by{|x| x.version.version}.last.full_gem_path, 'lib','index.xml')))
+
   def setup
   end
   
-  def test_truth
-    assert true
+  def test_named
+    assert_hash_equals_filter({:name => '$'}, "method[@name='$']")
+    assert_hash_equals_filter({:name => '$', :precise => true}, "method[@name='$']")
   end
+  
+  def test_named_imprecise
+    assert_hash_equals_filter({:name => '$', :precise => false}, "method[@name*='$']")
+  end
+  
+  def test_module
+    assert_hash_equals_filter({:module => "Core"}, "method[@cat='Core']")
+    assert_hash_equals_filter({:module => "Core", :recursive => false}, "method[@cat='Core']")
+  end
+  
+  def test_module_recursive
+    assert_hash_equals_filter({:module => "DOM", :recursive => true}, "method[@cat*='DOM']")
+  end
+
+  def test_like
+    expected_parse = @@parsed.search("method[@cat*='Plugins']").reject {|m| m.search("> desc").inner_text !~ /clear/i }
+    assert_equal JQueryParser.get_methods_by_hash(:module => "Plugins", :recursive => true, :like => ["clear"]).inner_html, expected_parse.inner_html
+  end
+
+  def test_like_multiple
+    expected_parse = @@parsed.search("method[@cat*='Plugins']").reject {|m| m.search("> desc").inner_text !~ /clear/i || m.search("> desc").inner_text !~ /field/i }
+    assert_equal JQueryParser.get_methods_by_hash(:module => "Plugins", :recursive => true, :like => ["clear", "field"]).inner_html, expected_parse.inner_html
+  end
+  
+  def test_params
+    expected_parse = @@parsed.search("method[@cat*='Core']").reject {|m| m.search("params[@name=html]").length == 0 }
+    assert_equal JQueryParser.get_methods_by_hash(:module => "Core", :recursive => true, :params => ["html"]).inner_html, expected_parse.inner_html
+  end
+  
+  def test_params_multiple
+    expected_parse = @@parsed.search("method[@cat*='Core']").reject {|m| m.search("params[@name=expr]").length == 0 || m.search("params[@name=context]").length == 0}
+    assert_equal JQueryParser.get_methods_by_hash(:module => "Core", :recursive => true, :params => ["expr", "context"]).inner_html, expected_parse.inner_html
+  end
+
+  def test_signature
+    assert_equal StubMethod.new({}).signature, "function(param1, param2) in MyModule"
+  end
+  
+  def test_named_list
+    assert_equal StubMethods.new.named_list, ["function(param1, param2) in MyModule", "function2(param_b1) in MyModule"]
+  end
+  
+  def test_empty_named_list
+    assert_equal StubMethods.new([]).named_list, ["No items found"]
+  end
+  
+  def test_new_methods_by_hash
+    assert_equal JQueryMethods.new(:name => '$').length, JQueryParser.get_methods_by_hash(:name => '$').length
+  end
+  
+  def assert_hash_equals_filter hash, filter
+    assert_equal JQueryParser.get_methods_by_hash(hash).inner_html, @@parsed.search(filter).inner_html
+  end
+  
 end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>jquery cheat</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/jquery-cheat"; return false'>
       Get Version
-      <a href="http://rubyforge.org/projects/jquery-cheat" class="numbers">0.1.1</a>
+      <a href="http://rubyforge.org/projects/jquery-cheat" class="numbers">0.2.0</a>
     </div>
     <h1>&#x2192; &#8216;jquery-cheat&#8217;</h1>
 
@@ -52,61 +52,95 @@
 	<h2>Demonstration of usage</h2>
 
 
-	<p>jcheat takes any of the following parameters:</p>
+	<h3>Main commands</h3>
 
 
+<pre>jcheat COMMAND [COMMAND_PREFS] [--name NAME [--precise]] 
+  [--module MODULE [--recursive]] [--like STRING] 
+  [--params PARAM1[,PARAM2...]] [--no-examples]</pre>
+
 	<ul>
-	<li>(describe|desc) <span class="caps">METHOD</span>_NAME [PARAM1, ...]
+	<li><pre>(describe|desc) METHOD_NAME [PARAM1, ...]</pre>
 	<ul>
-	<li>the full description of each method matching <span class="caps">METHOD</span>_NAME.</li>
-		<li>If you also pass optional PARAMs, the list of matching
+	<li>the full description of each method matching <span class="caps">METHOD</span>_NAME.
+   If you also pass optional PARAMs, the list of matching
    methods will be filtered to include only methods with those
    parameters.</li>
-		<li>Example: &#8220;jcheat desc $ html&#8221; will return the description
+		<li><code>--no-examples(-e)</code> suppresses examples from the output</li>
+		<li>Example: <code>jcheat desc $ html</code> will return the description
    of the $ method with an &#8220;html&#8221; parameter.</li>
 	</ul></li>
 	</ul>
 
 
 	<ul>
-	<li>list <span class="caps">MODULE</span>_NAME [-r]
+	<li><pre>list MODULE_NAME</pre>
 	<ul>
 	<li>A list of all methods directly under a specific module. Passing
-   an optional &#8220;-r&#8221; will return a list of all methods at any level
+   an optional <code>-r</code> will return a list of all methods at any level
    under the module.</li>
-		<li>Example: &#8220;jcheat list <span class="caps">DOM</span>/Traversing&#8221;</li>
+		<li>Example: <code>jcheat list DOM/Traversing</code></li>
 	</ul></li>
 	</ul>
 
 
 	<ul>
-	<li>(apopros|ap|like) <span class="caps">STRING</span>
+	<li><pre>(apopros|ap|like) STRING</pre>
 	<ul>
 	<li>A list of all methods whose description contains all of the
    words in <span class="caps">STRING</span>.</li>
-		<li>Example: &#8220;jcheat like clear fields&#8221;</li>
+		<li>Example: <code>jcheat like clear fields</code></li>
 	</ul></li>
 	</ul>
 
 
 	<ul>
-	<li>named <span class="caps">STRING</span>
+	<li><pre>named STRING</pre>
 	<ul>
 	<li>A list of all methods named exactly <span class="caps">STRING</span>.</li>
-		<li>Example: &#8220;jcheat named $&#8221;</li>
+		<li>Example: <code>jcheat named $</code></li>
 	</ul></li>
 	</ul>
 
 
 	<ul>
-	<li>(namelike|nl) <span class="caps">STRING</span>
+	<li><pre>(namelike|nl) STRING</pre>
 	<ul>
 	<li>A list of all methods whose names contain <span class="caps">STRING</span>.</li>
-		<li>Example: &#8220;jcheat nl clear&#8221;</li>
+		<li>Example: <code>jcheat nl clear</code></li>
 	</ul></li>
 	</ul>
 
 
+	<h3>Filters</h3>
+
+
+	<ul>
+	<li><code>[--name(-n) NAME [--substrings(-s)]]</code> filters methods by their name.
+  Adding the&#8212;precise flag will allow a substring match.</li>
+	</ul>
+
+
+	<ul>
+	<li><code>[--module(-m) MODULE [--recursive(-r)]]</code> filters methods by the
+  module they are in. Adding the&#8212;recursive flag will check
+  submodules (ex: -m <span class="caps">DOM</span> -r will search for methods in <span class="caps">DOM</span>,
+  <span class="caps">DOM</span>/Traversal, etc.)</li>
+	</ul>
+
+
+	<ul>
+	<li><code>[--like(-l) STRING]</code> filters methods by words in their description.</li>
+	</ul>
+
+
+	<ul>
+	<li><code>[--params(-o) PARAM1[,PARAM2...]]</code> filters methods by those that
+  contain all of the parameters passed in. Parameters should be
+  passed as a comma-separated list.</li>
+	</ul>
+
+
 	<h2>License</h2>
 
 

data/website/index.txt

@@ -12,34 +12,55 @@ h2. Installing
 
 h2. Demonstration of usage
 
-jcheat takes any of the following parameters:
+h3. Main commands
 
-* (describe|desc) METHOD_NAME [PARAM1, ...]
+<pre>jcheat COMMAND [COMMAND_PREFS] [--name NAME [--precise]] 
+  [--module MODULE [--recursive]] [--like STRING] 
+  [--params PARAM1[,PARAM2...]] [--no-examples]</pre>
+
+* <pre>(describe|desc) METHOD_NAME [PARAM1, ...]</pre>
 ** the full description of each method matching METHOD_NAME.
-** If you also pass optional PARAMs, the list of matching
+   If you also pass optional PARAMs, the list of matching
    methods will be filtered to include only methods with those
    parameters.
-** Example: "jcheat desc $ html" will return the description
+** <code>--no-examples(-e)</code> suppresses examples from the output
+** Example: <code>jcheat desc $ html</code> will return the description
    of the $ method with an "html" parameter.
         
-* list MODULE_NAME [-r]
+* <pre>list MODULE_NAME</pre>
 ** A list of all methods directly under a specific module. Passing
-   an optional "-r" will return a list of all methods at any level
+   an optional <code>-r</code> will return a list of all methods at any level
    under the module.
-** Example: "jcheat list DOM/Traversing"
+** Example: <code>jcheat list DOM/Traversing</code>
  
-* (apopros|ap|like) STRING
+* <pre>(apopros|ap|like) STRING</pre>
 ** A list of all methods whose description contains all of the
    words in STRING.
-** Example: "jcheat like clear fields"
+** Example: <code>jcheat like clear fields</code>
       
-* named STRING
+* <pre>named STRING</pre>
 ** A list of all methods named exactly STRING.
-** Example: "jcheat named $"
+** Example: <code>jcheat named $</code>
       
-* (namelike|nl) STRING
+* <pre>(namelike|nl) STRING</pre>
 ** A list of all methods whose names contain STRING.
-** Example: "jcheat nl clear"
+** Example: <code>jcheat nl clear</code>
+      
+h3. Filters
+ 
+* <code>[--name(-n) NAME [--substrings(-s)]]</code> filters methods by their name.
+  Adding the --precise flag will allow a substring match.
+   
+* <code>[--module(-m) MODULE [--recursive(-r)]]</code> filters methods by the
+  module they are in. Adding the --recursive flag will check
+  submodules (ex: -m DOM -r will search for methods in DOM,
+  DOM/Traversal, etc.)
+   
+* <code>[--like(-l) STRING]</code> filters methods by words in their description.
+ 
+* <code>[--params(-o) PARAM1[,PARAM2...]]</code> filters methods by those that
+  contain all of the parameters passed in. Parameters should be
+  passed as a comma-separated list.
 
 h2. License
 

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: jquery-cheat
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 date: 2007-06-01 00:00:00 -07:00
 summary: jQuery command-line API reference
 require_paths: 
@@ -36,7 +36,9 @@ files:
 - Rakefile
 - bin/jcheat
 - lib/index.xml
+- lib/jquery-cheat.rb
 - lib/jquery-cheat/version.rb
+- lib/merger.rb
 - scripts/txt2html
 - setup.rb
 - test/test_helper.rb