RubyGems - picolena - Versions diffs - 0.0.99 - Mend

picolena 0.0.99

Files changed (782) hide show

data/spec/picolena_spec.rb ADDED Viewed

@@ -0,0 +1,3 @@
+require 'pathname'
+picolena_bin=Pathname(File.join(File.dirname(__FILE__),'../bin/picolena')).realpath.to_s
+system("ruby #{picolena_bin} --spec-only")

data/tasks/default.rake ADDED Viewed

	@@ -0,0 +1 @@
1	+ Rake::Task[:default].prerequisites.clear

data/tasks/deployment.rake ADDED Viewed

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake ADDED Viewed

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake ADDED Viewed

@@ -0,0 +1,20 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/tasks/website.rake ADDED Viewed

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/website/index.html ADDED Viewed

@@ -0,0 +1,126 @@
+<!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" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      Picolena
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+    <h1>Picolena</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/picolena"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/picolena" class="numbers">0.0.99</a>
+    </div>
+    <h1>&#x2192; &#8216;picolena&#8217;</h1>
+	<h2>What</h2>
+	<p>&#8217;&#8217;Picolena&#8217;&#8217; is a lightweight <a href="http://ferret.davebalmain.com/trac">ferret-powered</a> documents search engine written in <a href="http://www.rubyonrails.org/">Ruby on rails</a> :</p>
+	<pre><code>1. Just let Ferret index any directory you want.
+2. Enter queries on your browser to get corresponding documents in a few milliseconds.</code></pre>
+	<h2>Installing</h2>
+	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">picolena</span></pre></p>
+	<h2>The basics</h2>
+	<p>The &#8216;picolena&#8217; command creates a new documents search engine, indexing directories specified as parameters. A default structure will be created in &#8216;picolena&#8217; directory. Since picolena is Rails-based, you can launch the search-engine web-server just like you would with any Rails application.</p>
+	<pre><code>picolena ~/shared_documents /media/literature
+cd picolena
+ruby script/server</code></pre>
+	<p>This would create the picolena file structure, index every file inside ~/shared_documents and /media/literature, and launch a web-server available at http://localhost:3000</p>
+	<h2>Demonstration of usage</h2>
+	<ul>
+	<li><a href="http://193.197.204.23:4000/documents/test">Basic query</a></li>
+		<li><a href="http://193.197.204.23:4000/documents/filetype:doc">every indexed .doc</a></li>
+		<li><a href="http://193.197.204.23:4000/documents/%2A">Every indexed file</a></li>
+		<li><a href="http://193.197.204.23:4000/documents/LIKE%20Einstien">Fuzzy query</a></li>
+		<li><a href="http://193.197.204.23:4000/documents/LIKE%20Einstein%20NOT%20Einstein">Typo tracker :)</a></li>
+		<li><a href="http://193.197.204.23:4000/documents/málaga">Accented queries thanks to <span class="caps">UTF8</span> encoding</a></li>
+		<li><a href="http://193.197.204.23:4000/documents/pʰəˈɹɪzɪənz">some hardcore <span class="caps">UTF</span>-8 query!</a></li>
+	</ul>
+	<h2>Trac</h2>
+	<p><a href="http://picolena.devjavu.com/">http://picolena.devjavu.com/</a></p>
+	<h2>Forum</h2>
+	<p><a href="http://groups.google.com/group/picolena">http://groups.google.com/group/picolena</a></p>
+	<h2>How to submit patches</h2>
+	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+	<p>The trunk repository is <code>http://svn.devjavu.com/picolena/trunk</code> for anonymous access.</p>
+	<h2>License</h2>
+	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+	<h2>Contact</h2>
+	<p>Comments are welcome. Send an email to <a href="mailto:eric_duminil@rubyforge.org">Eric Duminil</a> email via the <a href="http://groups.google.com/group/picolena">forum</a></p>
+    <p class="coda">
+      <a href="eric_duminil@rubyforge.org">Eric DUMINIL</a>, 8th April 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>,
+      by Daniel Cadenas via <a href="http://depgraph.rubyforge.org/">DepGraph</a>
+    </p>
+</div>
+<!-- insert site tracking codes here, like Google Urchin -->
+</body>
+</html>

data/website/index.txt ADDED Viewed

@@ -0,0 +1,61 @@
+h1. Picolena
+h1. &#x2192; 'picolena'
+h2. What
+''Picolena'' is a lightweight "ferret-powered":http://ferret.davebalmain.com/trac documents search engine written in "Ruby on rails":http://www.rubyonrails.org/ :
+ 1. Just let Ferret index any directory you want.
+ 2. Enter queries on your browser to get corresponding documents in a few milliseconds.
+h2. Installing
+<pre syntax="ruby">sudo gem install picolena</pre>
+h2. The basics
+The 'picolena' command creates a new documents search engine, indexing directories specified as parameters. A default structure will be created in 'picolena' directory. Since picolena is Rails-based, you can launch the search-engine web-server just like you would with any Rails application.
+ picolena ~/shared_documents /media/literature
+ cd picolena
+ ruby script/server
+This would create the picolena file structure, index every file inside ~/shared_documents and /media/literature, and launch a web-server available at http://localhost:3000
+h2. Demonstration of usage
+ * "Basic query":http://193.197.204.23:4000/documents/test
+ * "every indexed .doc":http://193.197.204.23:4000/documents/filetype:doc
+ * "Every indexed file":http://193.197.204.23:4000/documents/%2A
+ * "Fuzzy query":http://193.197.204.23:4000/documents/LIKE%20Einstien
+ * "Typo tracker :)":http://193.197.204.23:4000/documents/LIKE%20Einstein%20NOT%20Einstein
+ * "Accented queries thanks to UTF8 encoding":http://193.197.204.23:4000/documents/málaga
+ * "some hardcore UTF-8 query!":http://193.197.204.23:4000/documents/pʰəˈɹɪzɪənz
+h2. Trac
+"http://picolena.devjavu.com/":http://picolena.devjavu.com/
+h2. Forum
+"http://groups.google.com/group/picolena":http://groups.google.com/group/picolena
+h2. How to submit patches
+Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+The trunk repository is <code>http://svn.devjavu.com/picolena/trunk</code> for anonymous access.
+h2. License
+This code is free to use under the terms of the MIT license.
+h2. Contact
+Comments are welcome. Send an email to "Eric Duminil":mailto:eric_duminil@rubyforge.org email via the "forum":http://groups.google.com/group/picolena

data/website/index_devjavu ADDED Viewed

@@ -0,0 +1,116 @@
+= Welcome to Picolena! =
+== Description ==
+''Picolena'' is a lightweight [http://ferret.davebalmain.com/trac ferret-powered] documents search engine written in [http://www.rubyonrails.org/ Ruby on rails]:
+ 1. Just let Ferret index any directory you want.
+ 2. Enter queries on your browser to get corresponding documents in a few milliseconds.
+== Examples ==
+ * [http://193.197.204.23:4000/documents/test Basic query]
+ * [http://193.197.204.23:4000/documents/filetype:doc every indexed .doc]
+ * [http://193.197.204.23:4000/documents/* every indexed file]
+ * [http://193.197.204.23:4000/documents/LIKE%20Einstien Fuzzy query]
+ * [http://193.197.204.23:4000/documents/LIKE%20Einstein%20NOT%20Einstein Typo tracker :)]
+ * [http://193.197.204.23:4000/documents/málaga Accented queries thanks to UTF8 encoding]
+ * [http://193.197.204.23:4000/documents/pʰəˈɹɪzɪənz some hardcore UTF-8 query!]
+== Advantages ==
+''Picolena'' has many advantages:
+ * it can index .pdf, .doc, .docx, .odt, .xls, .ods, .ppt, .pptx, .odp, .rtf, .html and plain text files will '''full text search''', and offers a very easy way to [http://picolena.devjavu.com/browser/trunk/lib/filters add new filters] to index other filetype.
+ * it is '''free''' as in ''free beer'' and as in ''free speech''
+ * thanks to [http://ferret.davebalmain.com/trac Ferret], it is '''very fast'''
+ * it keeps your data '''private'''. By default, only the computer on which it is installed can get access to the search engine. Other IP addresses can then be added to a white list.
+ * it does not phone home. This claim is somewhat easier to verify on '''your server''', with just a few lines of codes added, than on a ''Don't be evil'' [http://www.google.co.uk/enterprise/ black-box server].
+ * it can be used to index any ftp, smb, ssh, webdav or local directory.
+ * its user interface is available in [http://picolena.devjavu.com/browser/trunk/lang/ui English, German, Spanish and French.]
+== License ==
+''Picolena'', ''Ferret'' and ''Ruby on Rails'' are all released under the [http://www.opensource.org/licenses/mit-license.php MIT license].
+== Authors ==
+''Picolena'' has been created by Eric Duminil, following the idea of [http://www.methods.co.nz/ff/ Ferret Finder utility] by Stuart Rackham.
+It would be totally useless without:
+ * Ferret, by Dave Balmain
+ * Ruby on Rails, by David Heinemeier Hansson
+ * the open source community that supports those projects.
+= Installation process =
+''Picolena'' has been tested on [http://www.ubuntu.com Ubuntu] 7.04 and 7.10, for both Desktop and Server editions.
+To install ''Picolena'', you first need [http://www.rubyonrails.org/ Ruby on rails] and  [http://www.rubygems.org/ RubyGems]
+== Getting picolena gem ==
+Launch
+{{{
+gem install picolena
+}}}
+with admin privileges.
+== Installing picolena ==
+Once the gem is installed, you can launch:
+{{{
+picolena
+}}}
+followed by a list of directories you would like to be indexed.
+For example:
+{{{
+picolena ~/shared_documents /media/literature
+}}}
+This would create picolena file structure, index every file inside ~/shared_documents and /media/literature, and launch specs to be sure everything is in order.
+Depending on the amount of indexed data, it can take anywhere between a few seconds and some hours.
+For example, 15000 documents (out of which 50% get their content extracted as to plain text) have been indexed in 30 minutes on an Ubuntu server VM running on an old Windows server.
+If every spec pass, you can be sure every file has been indexed properly.
+== Launching Picolena ==
+{{{
+cd picolena
+ruby script/server
+}}}
+Time to open your browser and [http://localhost:3000 enjoy]!
+== Optional configuration ==
+=== Allowing access to other computers ===
+You can allow access to other computers by adding IP addresses to ''config/white_list_ip.yml'':
+{{{
+# Only localhost is allowed by default, any request coming from another IP will get rejected.
+# You can either add an IP address to the list:
+#       - 192.168.0.37
+# or an IP address range:
+#       - 192.168.0.
+# that will match any IP address whose first octets are 192.168.0
+# If you want to allow everybody, just write:
+#       Allow:
+#         - all
+Allow:
+  - 127.0.0.1
+  - 0.0.0.0
+}}}
+=== Modifying alias path of indexed directories ===
+=== Changing interface language ===
+=== Updating index periodically ===