picky-generators 2.0.0.pre1 → 2.0.0.pre2

data/prototypes/client/sinatra/Gemfile

@@ -2,7 +2,7 @@ source :gemcutter
 
 # Gems required by the Picky client.
 #
-gem 'picky-client', '2.0.0.pre1'
+gem 'picky-client', '2.0.0.pre2'
 gem 'i18n'
 gem 'activesupport', :require => 'active_support/core_ext'
 gem 'sinatra'

data/prototypes/client/sinatra/app.rb

@@ -2,21 +2,22 @@ require 'rubygems'
 require 'bundler'
 Bundler.require
 
-# Load the "model".
+# Sinatra settings.
 #
-require File.expand_path 'book', File.dirname(__FILE__)
+set :static, true
+set :public, File.dirname(__FILE__)
+set :views,  File.expand_path('views', File.dirname(__FILE__))
+set :haml,   :format => :html5
 
-set :haml, { :format => :html5 }
+# Load the simplified "model".
+#
+require File.expand_path 'book', File.dirname(__FILE__)
 
 # Sets up a search instance to the server.
 #
 BookSearch = Picky::Client.new :host => 'localhost', :port => 8080, :path => '/books'
 
-set :static, true
-set :public, File.dirname(__FILE__)
-set :views,  File.expand_path('views', File.dirname(__FILE__))
-
-# Root, the search interface.
+# Root, the search page.
 #
 get '/' do
   @query = params[:q]
@@ -24,12 +25,8 @@ get '/' do
   haml :'/search'
 end
 
-# Configure. The configuration info page.
+# Renders the results into the json.
 #
-get '/configure' do
-  haml :'/configure'
-end
-
 # You get the ids from the picky server and then
 # populate the result with rendered models.
 #
@@ -37,21 +34,21 @@ get '/search/full' do
   results = BookSearch.search params[:query], :ids => params[:ids], :offset => params[:offset]
   results.extend Picky::Convenience
   results.populate_with Book do |book|
-    book.to_s
+    book.render
   end
 
   #
-  # Or use:
+  # Or, to populate with the model instances, use:
   #   results.populate_with Book
   #
-  # Then:
+  # Then to render:
   #   rendered_entries = results.entries.map do |book| (render each book here) end
   #
 
   ActiveSupport::JSON.encode results
 end
 
-# Normally, you'd actually go directly to the search server without taking the detour.
+# Updates the search count while the user is typing.
 #
 # We don't parse/reencode the returned json string using search_unparsed.
 #
@@ -59,6 +56,12 @@ get '/search/live' do
   BookSearch.search_unparsed params[:query], :ids => params[:ids], :offset => params[:offset]
 end
 
+# Configure. The configuration info page.
+#
+get '/configure' do
+  haml :'/configure'
+end
+
 helpers do
 
   def js path

data/prototypes/client/sinatra/book.rb

@@ -35,7 +35,7 @@ class Book
   #
   # Note: This is just an example. Please do not render in the model.
   #
-  def to_s
+  def render
     "<li class='book'><p>\"#{@title}\", by #{@author}</p><p>#{@year}, #{@publisher}</p><p>#{@subjects}</p></li>"
   end
 

data/prototypes/client/sinatra/javascripts/picky.min.js

@@ -6,8 +6,8 @@ this.text=o;var q=function(h){n.text(h);h>0&&h<=5&&n.fadeTo("fast",0.5).fadeTo("
 d.focus()}else{k.remove();p.render(h);$("body").animate({scrollTop:$("#picky div.results div.header:last").position().top-12},500)}};this.liveResultsCallback=function(h){v(w(h));q(h.total)};this.allocationChosen=function(h){h=h.data.query;d.val(h);c.allocationChosen(h)};this.addinationClicked=function(h){c.addinationClicked(o(),h)};(function(){d.keyup(function(h){if(o()==""){f();c.searchTextCleared()}else{c.searchTextEntered(o(),h);a()}});n.click(function(){o()==""||c.searchButtonClicked(o())});m.click(function(){o()==
 ""||c.searchButtonClicked(o())});e.click(function(){f("");c.clearButtonClicked();d.focus()})})();d.focus()};var PickyBackend=function(c){var i=function(g,d,e,m){var n=m||{};n=$.extend({query:g,offset:e},m);$.getJSON(c,n,function(s){d&&d(new PickyData(s))})};this.search=function(g,d,e,m,n){i(g,function(s){d&&d(n,s)},e,m)}},LiveBackend=function(c){var i=new PickyBackend(c);this.search=function(g,d,e,m,n){n=n||{};latestRequestTimestamp=new Date;n.live=latestRequestTimestamp;m=$.extend({ids:0},m);i.search(g,function(s,u){if(!s.live||s.live==latestRequestTimestamp)d&&d(u)},e,m,n)}},FullBackend=function(c){var i=
 new PickyBackend(c);this.search=function(g,d,e,m,n){n=n||{};latestRequestTimestamp=new Date;n.full=latestRequestTimestamp;m=$.extend({ids:20},m);i.search(g,function(s,u){if(!s.full||s.full==latestRequestTimestamp)d&&d(u)},e,m,n)}};var PickyController=function(c){var i=new PickyView(this,c),g=c.backends,d=c.before||function(){},e=c.success||function(){},m=c.after||function(){},n=function(a){return(a=a&&a.match(/q=([^&]+)/))&&unescape(a[1]||"")};this.extractQuery=n;var s=function(){var a=window.History&&window.History.getState();return n(a&&a.url)};this.lastQuery=s;var u=function(a,b){a=e(a,b)||a;i.liveResultsCallback(a);m(a,b)},j,k=function(){var a=i.text();d({});var b=g.live;b&&b.search(a,u,0,void 0);clearInterval(j)};j=setInterval(k,
-180);clearInterval(j);var r=function(a,b){a=e(a,b)||a;i.fullResultsCallback(a);m(a,b)},p=function(a,b,f){f=f||{};b=b||0;clearInterval(j);if(a!=s()){var o="?q="+a;window.History&&window.History.getState()&&window.History.pushState&&window.History.pushState(null,null,o)}f=d(f,a,b)||f;(o=g.full)&&o.search(a,r,b,f)};this.insert=function(a,b){i.insert(a);b&&p(a)};this.clearButtonClicked=function(){clearInterval(j)};this.searchTextCleared=function(){clearInterval(j)};this.searchTextEntered=function(a,b){if($.inArray(b.keyCode,
-[0,8,13,32,46,48,49,50,51,52,53,54,55,56,57,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90])>-1)if(b.keyCode==13)p(a);else{clearInterval(j);j=setInterval(k,180)}};this.searchButtonClicked=function(a){p(a)};this.allocationChosen=function(a){p(a)};this.addinationClicked=function(a,b){p(a,b.data.offset)}};var Localization={},PickyClient=function(c){Localization.qualifiers=c.qualifiers||{};Localization.explanations=c.explanations||{};Localization.choices=c.choices||{};Localization.explanation_delimiters={de:"und",fr:"et",it:"e",en:"and",ch:"und"};var i=c.backends;if(i){i.live||alert("Both a full and live backend must be provided.");i.full||alert("Both a full and live backend must be provided.")}else c.backends={live:c.live&&new LiveBackend(c.live)||alert("A live backend path must be provided."),full:c.full&&
+180);clearInterval(j);var r=function(a,b){a=e(a,b)||a;i.fullResultsCallback(a);m(a,b)},p=function(a,b,f){f=f||{};b=b||0;clearInterval(j);if(a!=s()){var o="?q="+escape(a).replace(/\*/g,"%2A");window.History&&window.History.getState()&&window.History.pushState&&window.History.pushState(null,null,o)}f=d(f,a,b)||f;(o=g.full)&&o.search(a,r,b,f)};this.insert=function(a,b){i.insert(a);b&&p(a)};this.clearButtonClicked=function(){clearInterval(j)};this.searchTextCleared=function(){clearInterval(j)};this.searchTextEntered=
+function(a,b){if($.inArray(b.keyCode,[0,8,13,32,46,48,49,50,51,52,53,54,55,56,57,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90])>-1)if(b.keyCode==13)p(a);else{clearInterval(j);j=setInterval(k,180)}};this.searchButtonClicked=function(a){p(a)};this.allocationChosen=function(a){p(a)};this.addinationClicked=function(a,b){p(a,b.data.offset)}};var Localization={},PickyClient=function(c){Localization.qualifiers=c.qualifiers||{};Localization.explanations=c.explanations||{};Localization.choices=c.choices||{};Localization.explanation_delimiters={de:"und",fr:"et",it:"e",en:"and",ch:"und"};var i=c.backends;if(i){i.live||alert("Both a full and live backend must be provided.");i.full||alert("Both a full and live backend must be provided.")}else c.backends={live:c.live&&new LiveBackend(c.live)||alert("A live backend path must be provided."),full:c.full&&
 new FullBackend(c.full)||alert("A live backend path must be provided.")};var g=c.controller&&new c.controller(c)||new PickyController(c);var d=this.insert=function(e,m){g.insert(e,m||true)};this.insertFromURL=function(e){if(e&&e!="")d(e);else(e=g.lastQuery())&&d(e)};window.History&&window.History.Adapter.bind(window,"statechange",function(){var e=window.History.getState();(e=g.extractQuery(e.url))&&d(e)})};var PickyAddination=function(c,i){this.remove=function(){i.find(".addination").remove()};this.render=function(g){var d=g.total,e;e=g.offset+20+0;var m=e+20;g=g.total;if(g<m)m=g;e={offset:e,start:e+1,end:m};if(e.offset<d){d=$("<div class='addination'>"+t("results.addination.more")+"</div>");d.bind("click",{offset:e.offset},c.addinationClicked);return d}else return""}};var PickyResultsRenderer=function(c,i){var g=i.wrapResults||'<ol class="results"></ol>',d=["street_number","zipcode"],e=function(j){var k=j[j.length-1];j=j.slice(0,j.length-1);if(j==[])j=[j];if(!d.include(k[0]))if(k[1].match(/[^\*~]$/))k[1]+="*";j.push(k);return j},m=function(j){for(var k=Localization.explanations&&Localization.explanations[PickyI18n.locale]||{},r=[],p,a=0,b=j.length;a<b;a++){p=j[a];var f=p[0];f=k[f]||f;r.push([f,p[1]])}return r},n=function(j,k){return[j.replace(/([\w\s\u00c4\u00e4\u00d6\u00f6\u00dc\u00fc\u00e9\u00e8\u00e0]+)/,
 "<strong>$1</strong>"),k].join(" ")},s=function(j,k){var r=Localization.explanation_delimiters[PickyI18n.locale],p=m(e(k)),a="",b=[];p=$.map(p,function(f){var o=f[0];f=f[1];if(a==""||o==a){b.push(f);a=o}else{var q=n(a,b.join(" "));b=[];b.push(f);a=o;return q}});p.push(n(a,b.join(" ")));p=p.join(" "+r+" ");return'<span class="explanation">'+j+" "+p+"</span>"},u=function(j,k){var r='<div class="header">';r+=s(k.type,k.combination);if(j.offset>0)r+='<div class="tothetop"><a href="#" onclick="javascript:$(\'body\').animate({scrollTop: 0}, 500);">&uarr;</a></div>';
 return r};this.render=function(j){var k=$("#picky div.results");j.allocations.each(function(r,p){k.append(u(j,p)).append(p.entries.join("")).append(c.render(j));k.children("li").wrapAll(g)})}};function AllocationRenderer(c,i){function g(a){var b={},f={},o=[],q;q=0;for(l=a.length;q<l;q++){var w=a[q][0];if(w in b){b[w]=b[w]+" "+a[q][1];o.push(q)}else{b[w]=a[q][1];f[q]=w}}for(q in f)a[q][1]=b[f[q]];for(q=o.length-1;q>=0;q--)a.remove(o[q]);return a}function d(a){return $.map(a,function(b,f){return"%"+(f+1)+"$s"}).join(" ")}function e(a){if(a.length==0)return"";var b=a=g(a);b.sort(function(x,y){return x[0]<y[0]?-1:1});for(var f=[],o=0,q=b.length;o<q;o++)f.push(b[o][0]);var w=f.length==1,v=r[f]||

data/prototypes/client/sinatra/stylesheets/application.css

@@ -7,7 +7,7 @@ body {
     text-align: left; }
 
 img {
-  margin: -2px 0px 0px; }
+  margin: 0px 0px -210px; }
 
 p span.explanation {
   color: #999999; }

data/prototypes/client/sinatra/views/search.haml

@@ -61,7 +61,8 @@
             //
             full: '/search/full',
 
-            // A live query just updates the count.
+            // A live query just updates the count and does not need
+            // to render (could go straight to the search server).
             //
             live: '/search/live',
 

data/prototypes/server/shared_unicorn/Gemfile

@@ -2,7 +2,7 @@ source :gemcutter
 
 # Gems required by Picky.
 #
-gem 'picky',      '2.0.0.pre1'
+gem 'picky',      '2.0.0.pre2'
 gem 'rake'
 gem 'bundler'
 gem 'rack',       '~> 1.2.2'

data/prototypes/server/unicorn/app/application.rb

@@ -3,44 +3,33 @@
 # TODO Adapt the generated example
 #      (a library books finder) to what you need.
 #
-# Check the Wiki http://github.com/floere/picky/wiki for more options.
-# Ask me or the google group if you have questions or specific requests.
+# Questions? Mail me, IRC #picky, the google group, http://github.com/floere/picky/wiki.
 #
 class PickySearch < Application
 
-  # Indexing: How text is indexed.
+  # How text is indexed.
   #
   default_indexing removes_characters: /[^a-zA-Z0-9\s\/\-\"\&\.]/,
                    stopwords:          /\b(and|the|of|it|in|for)\b/,
                    splits_text_on:     /[\s\/\-\"\&\.]/
 
-  # Querying: How query text is handled.
+  # How query text is preprocessed.
   #
   default_querying removes_characters: /[^a-zA-Z0-9\s\/\-\,\&\"\~\*\:]/, # Picky needs control chars *"~: to pass through.
                    stopwords:          /\b(and|the|of|it|in|for)\b/,
                    splits_text_on:     /[\s\/\-\,\&]+/,
-
-                   maximum_tokens: 5, # Amount of tokens passing into a query (5 = default).
+                   maximum_tokens: 5, # Amount of tokens used in a search (5 = default).
                    substitutes_characters_with: CharacterSubstituters::WestEuropean.new # Normalizes special user input, Ä -> Ae, ñ -> n etc.
 
-  # Define an index. Use a database etc. source? Use an in-memory index or Redis?
-  # See http://github.com/floere/picky/wiki/Sources-Configuration#sources
-  #
-  books_index = Index::Memory.new :books, Sources::CSV.new(:title, :author, :year, file: 'app/library.csv')
-  books_index.define_category :title,
-                              similarity: Similarity::Phonetic.new(3), # Up to three similar title word indexed (default: No similarity).
-                              partial: Partial::Substring.new(from: 1) # Indexes substrings upwards from character 1 (default: -3),
-                                                                       # You'll find "picky" even when entering just a "p".
-  books_index.define_category :author,
-                              partial: Partial::Substring.new(from: 1)
-  books_index.define_category :year,
-                              partial: Partial::None.new # Partial substring searching on the year does not make
-                                                         # much sense, neither does similarity.
-
-  options = { :weights => { [:title, :author] => +3, [:title] => +1 } } # +/- points for combinations.
-
-  route %r{\A/books\Z} => Search.new(books_index, options)
+  library_src = Sources::CSV.new :title, :author, :year, file: 'app/library.csv'
+  books_index = Index::Memory.new :books, library_src do
+    category :title,
+             similarity: Similarity::Phonetic.new(3), # Default is no similarity.
+             partial: Partial::Substring.new(from: 1) # Default is from: -3.
+    category :author, partial: Partial::Substring.new(from: 1)
+    category :year, partial: Partial::None.new
+  end
 
-  # Note: You can pass a query multiple indexes and it will query in all of them.
+  route %r{\A/books\Z} => Search.new(books_index, :weights => { [:title, :author] => +3, [:title] => +1 })
 
 end

metadata

@@ -2,7 +2,7 @@
 name: picky-generators
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 2.0.0.pre1
+  version: 2.0.0.pre2
 platform: ruby
 authors: 
 - Florian Hanke
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-18 00:00:00 +01:00
+date: 2011-03-21 00:00:00 +01:00
 default_executable: picky-generate
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.0.0.pre1
+        version: 2.0.0.pre2
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -43,7 +43,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.0.0.pre1
+        version: 2.0.0.pre2
   type: :runtime
   version_requirements: *id003
 description: Generators for Picky.