cl-console 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Sebastian Cohnen
+
+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,9 @@
+# CouchDB-Lucene Console
+
+    $ gem install cl-console
+    $ irb -rrubygems -rcl_console
+    >> cl = CLConsole.new("database/ddoc/index")
+    => #<CLConsole:0x101df9d08 [...]>
+    >> cl.q "test"
+    => {"total_rows"=>1, "etag"=>"11a69b3141bc67e8", "search_duration"=>0, "q"=>"default:test", "rows"=>[{"id"=>"f3fba9f61520e0ef2a245772a900074c", "score"=>1}], "fetch_duration"=>0, "limit"=>25, "skip"=>0}
+    >> cl.help

data/lib/cl_console.rb

@@ -0,0 +1,86 @@
+require "active_support/core_ext"
+require "json"
+require 'open-uri'
+
+class CLConsole
+  attr_accessor :options
+    
+  def initialize(url, opts={})
+    @cl_url = if url.start_with? "http"
+                url
+              else
+                parts = url.split('/')
+                "http://localhost:5984/#{parts[0]}/_fti/_design/#{parts[1]}/#{parts[2]}"
+              end
+
+    @options = opts
+  end
+  
+  # do the actual query
+  def q(query, opts={})
+    opts = options.merge(opts).merge({:q => query})
+    url = "#{@cl_url}?#{opts.to_param}"
+    puts "query: " << url if opts[:debug]
+    res = JSON.parse(open(url).string)
+    puts ">> q: #{res["q"]} (#{res["search_duration"]}ms / #{res["fetch_duration"]}ms)"
+    res
+  end
+  
+  # do the query, and only give me the rows
+  def qr(query, opts={})
+    q(query,opts)["rows"]
+  end
+
+  # do the query, ensure that cl fetches the documents and return only the documents
+  def qd(query, opts={})
+    qr(query,{:include_docs => true}.merge(opts)).inject([]) do |acc,row|
+      acc << row["doc"]
+    end
+  end
+  
+  # fetch index infos
+  def info
+    puts "query: " << @cl_url if options[:debug]
+    JSON.parse(open("#{@cl_url}").string)
+  end
+  
+  # helper to escape searchterms properly for lucene search queries
+  def escape(str)
+    lucene_chars = %w{+ - & | ! ( ) { } [ ] ^ " ~ * ? : \\}.collect {|e| Regexp.escape(e)}
+    str.gsub!(/(#{lucene_chars.join("|")})/, '\\\\\1')
+  end
+  
+  # display help message
+  def help
+    puts <<-HELP_MSG
+------------------------------------------------------------------------------
+ CL-Console Help
+==============================================================================
+Example usage:
+
+# initialize with "database/designdocument/index" (ddoc without _design)
+cl = CLConsole.new("db/ddoc/index")
+
+# or initialize with a full url
+cl = CLConsole.new("http://localhost:5984/db/_fti/_design/ddoc/index")    
+
+# You can also pass a hash with options to be passed to couchdb-lucene, like
+# limit, sorting, debug, ... see the couchdb-lucene documentation for details.
+
+# query
+
+cl.q "simple"   # issue a simple query and give the raw result from c-l
+cl.qr "simple"  # same query but only the result rows
+cl.qd "simple"  # and this time only return the documents
+
+# do a more sophisticated request and let cl-console escape special chars
+cl.qd "title:(couchdb OR lucene) AND body:(awesome AND \#{cl.escape(':-)')})"
+
+# meta
+
+cl.info         # get index infos
+cl.help         # this info
+------------------------------------------------------------------------------
+    HELP_MSG
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: cl-console
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sebastian Cohnen
+autorequire: lib/cl_console.rb
+bindir: bin
+cert_chain: []
+
+date: 2010-04-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :runtime
+  version_requirements: *id002
+description: This is a little helper to query CouchDB-Lucene indices from an IRB session. It is meant to be used for a very easy inspection, query-testing and exploration of c-l indices.
+email: sebastian.cohnen@gmx.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- lib/cl_console.rb
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: http://github.com/tisba/cl-console
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Little gem meant to be used in IRB sessions for querying CouchDB-Lucene indices.
+test_files: []
+