picky-generators 3.0.1 → 3.1.0

data/prototypes/all_in_one/sinatra/app.rb

@@ -20,7 +20,7 @@ class BookSearch < Sinatra::Application
 
   # Define an index.
   #
-  books_index = Indexes::Memory.new :books do
+  books_index = Index.new :books do
     source   Sources::CSV.new(:title, :author, :year, file: "data/#{PICKY_ENVIRONMENT}/library.csv")
     indexing removes_characters: /[^a-zA-Z0-9\s\/\-\_\:\"\&\.]/i,
              stopwords:          /\b(and|the|of|it|in|for)\b/i,
@@ -41,11 +41,13 @@ class BookSearch < Sinatra::Application
   # Define a search over the books index.
   #
   books = Search.new books_index do
-    searching removes_characters: /[^a-zA-Z0-9\s\/\-\_\&\.\"\~\*\:\,]/i, # Picky needs control chars *"~:, to pass through.
+    searching substitutes_characters_with: CharacterSubstituters::WestEuropean.new, # Normalizes special user input, Ä -> Ae, ñ -> n etc.
+              removes_characters: /[^a-zA-Z0-9\s\/\-\_\&\.\"\~\*\:\,]/i, # Picky needs control chars *"~:, to pass through.
               stopwords:          /\b(and|the|of|it|in|for)\b/i,
-              splits_text_on:     /[\s\/\-\&]+/,
-              substitutes_characters_with: CharacterSubstituters::WestEuropean.new # Normalizes special user input, Ä -> Ae, ñ -> n etc.
-    boost [:title, :author] => +3, [:title] => +1
+              splits_text_on:     /[\s\/\-\&]+/
+
+    boost [:title, :author] => +3,
+          [:title]          => +1
   end
 
 

data/prototypes/all_in_one/sinatra/views/configure.haml

@@ -35,7 +35,9 @@
         %code
           %pre
             :preserve
-              BookSearch = Picky::Client.new :host => 'localhost', :port => 8080, :path => '/books'
+              BookSearch = Picky::Client.new :host => 'localhost',
+                                             :port => 8080,
+                                             :path => '/books'
       %p
         Both clients offer the options:
         %dl
@@ -54,7 +56,9 @@
           %pre
             :preserve
               get '/search/full' do
-                results = BookSearch.search params[:query], :ids => params[:ids], :offset => params[:offset]
+                results = BookSearch.search params[:query],
+                                            :ids    => params[:ids],
+                                            :offset => params[:offset]
                 results.extend Picky::Convenience
                 results.populate_with Book do |book|
                   book.to_s
@@ -66,13 +70,18 @@
         %strong hash
         with the results:
         %code
-          %pre results = BookSearch.search params[:query], :ids => params[:ids], :offset => params[:offset]
+          %pre
+            :preserve
+              results = BookSearch.search params[:query],
+                                          :ids => params[:ids],
+                                          :offset => params[:offset]
       %p
         This part takes the
         %strong hash
         and extends it with a few useful and convenient methods:
         %code
-          %pre results.extend Picky::Convenience
+          %pre
+            results.extend Picky::Convenience
       %p
         One of these methods is the
         %strong populate_with
@@ -101,7 +110,10 @@
           %pre
             :preserve
               results.entries do |book|
-                render book # or book.to_s, or however you like to render the book.
+                # Or use book.to_s, or however you like
+                # to render the book.
+                #
+                render book
               end
       %p
         At the end, encode the hash in JSON:
@@ -114,10 +126,14 @@
         %code
           %pre
             :preserve
-              BookSearch = Picky::Client.new :host => 'localhost', :port => 8080, :path => '/books'
+              BookSearch = Picky::Client.new :host => 'localhost',
+                                             :port => 8080,
+                                             :path => '/books'
 
               get '/search/full' do
-                results = BookSearch.search params[:query], :ids => params[:ids], :offset => params[:offset]
+                results = BookSearch.search params[:query],
+                                            :ids => params[:ids],
+                                            :offset => params[:offset]
 
                 results.extend Picky::Convenience
                 results.populate_with Book do |book|
@@ -131,14 +147,23 @@
         The view is even easier. Just add the line
         %code
           %pre
-            \= Picky::Helper.cached_interface
+            :preserve
+              = Picky::Helper.cached_interface
         if you use just one language, or
         %code
           %pre
-            \= Picky::Helper.interface :button => 'search', :no_results => 'No results!', :more => 'more'
+            :preserve
+              = Picky::Helper.interface :button     => 'search',
+                                        :no_results => 'No results!',
+                                        :more       => 'more'
         if you use multiple languages.
         (You'd use the options
-        %pre :button => t(:'search.button'), :no_results => t(:'search.no_results'), :more => t(:'search.more')
+        %code
+          %pre
+            :preserve
+              :button     => t(:'search.button'),
+              :no_results => t(:'search.no_results'),
+              :more       => t(:'search.more')
         of course, with proper i18n)
         The same options can be used for
         %strong #cached_interface
@@ -157,6 +182,7 @@
                   full: '/search/full',
 
                   // etc.
+                  //
         Just take a look at the possible javascript client options in that file.
       %p
         %strong Good luck my friend! *waves several stubby pink tentacles*

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

@@ -35,7 +35,9 @@
         %code
           %pre
             :preserve
-              BookSearch = Picky::Client.new :host => 'localhost', :port => 8080, :path => '/books'
+              BookSearch = Picky::Client.new :host => 'localhost',
+                                             :port => 8080,
+                                             :path => '/books'
       %p
         Both clients offer the options:
         %dl
@@ -54,7 +56,9 @@
           %pre
             :preserve
               get '/search/full' do
-                results = BookSearch.search params[:query], :ids => params[:ids], :offset => params[:offset]
+                results = BookSearch.search params[:query],
+                                            :ids    => params[:ids],
+                                            :offset => params[:offset]
                 results.extend Picky::Convenience
                 results.populate_with Book do |book|
                   book.to_s
@@ -66,13 +70,18 @@
         %strong hash
         with the results:
         %code
-          %pre results = BookSearch.search params[:query], :ids => params[:ids], :offset => params[:offset]
+          %pre
+            :preserve
+              results = BookSearch.search params[:query],
+                                          :ids => params[:ids],
+                                          :offset => params[:offset]
       %p
         This part takes the
         %strong hash
         and extends it with a few useful and convenient methods:
         %code
-          %pre results.extend Picky::Convenience
+          %pre
+            results.extend Picky::Convenience
       %p
         One of these methods is the
         %strong populate_with
@@ -101,7 +110,10 @@
           %pre
             :preserve
               results.entries do |book|
-                render book # or book.to_s, or however you like to render the book.
+                # Or use book.to_s, or however you like
+                # to render the book.
+                #
+                render book
               end
       %p
         At the end, encode the hash in JSON:
@@ -114,10 +126,14 @@
         %code
           %pre
             :preserve
-              BookSearch = Picky::Client.new :host => 'localhost', :port => 8080, :path => '/books'
+              BookSearch = Picky::Client.new :host => 'localhost',
+                                             :port => 8080,
+                                             :path => '/books'
 
               get '/search/full' do
-                results = BookSearch.search params[:query], :ids => params[:ids], :offset => params[:offset]
+                results = BookSearch.search params[:query],
+                                            :ids => params[:ids],
+                                            :offset => params[:offset]
 
                 results.extend Picky::Convenience
                 results.populate_with Book do |book|
@@ -131,14 +147,23 @@
         The view is even easier. Just add the line
         %code
           %pre
-            \= Picky::Helper.cached_interface
+            :preserve
+              = Picky::Helper.cached_interface
         if you use just one language, or
         %code
           %pre
-            \= Picky::Helper.interface :button => 'search', :no_results => 'No results!', :more => 'more'
+            :preserve
+              = Picky::Helper.interface :button     => 'search',
+                                        :no_results => 'No results!',
+                                        :more       => 'more'
         if you use multiple languages.
         (You'd use the options
-        %pre :button => t(:'search.button'), :no_results => t(:'search.no_results'), :more => t(:'search.more')
+        %code
+          %pre
+            :preserve
+              :button     => t(:'search.button'),
+              :no_results => t(:'search.no_results'),
+              :more       => t(:'search.more')
         of course, with proper i18n)
         The same options can be used for
         %strong #cached_interface
@@ -157,6 +182,7 @@
                   full: '/search/full',
 
                   // etc.
+                  //
         Just take a look at the possible javascript client options in that file.
       %p
         %strong Good luck my friend! *waves several stubby pink tentacles*

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

@@ -22,13 +22,13 @@ class BookSearch < Picky::Application
 
   # How query text is preprocessed. Move to Search block to make it search specific.
   #
-  searching removes_characters: /[^a-zA-Z0-9\s\/\-\_\&\.\"\~\*\:\,]/i, # Picky needs control chars *"~:, to pass through.
+  searching substitutes_characters_with: CharacterSubstituters::WestEuropean.new, # Normalizes special user input, Ä -> Ae, ñ -> n etc.
+            removes_characters: /[^a-zA-Z0-9\s\/\-\_\&\.\"\~\*\:\,]/i, # Picky needs control chars *"~:, to pass through.
             stopwords:          /\b(and|the|of|it|in|for)\b/i,
             splits_text_on:     /[\s\/\-\&]+/,
-            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.
+            maximum_tokens: 5   # Amount of tokens maximally used in a search.
 
-  books_index = Indexes::Memory.new :books do
+  books_index = Index.new :books do
     source   Sources::CSV.new(:title, :author, :year, file: "data/#{PICKY_ENVIRONMENT}/library.csv")
     category :title,
              similarity: Similarity::DoubleMetaphone.new(3), # Default is no similarity.

data/prototypes/server/sinatra/app.rb

@@ -11,7 +11,7 @@ class BookSearch < Sinatra::Application
 
   # Define an index.
   #
-  books_index = Indexes::Memory.new :books do
+  books_index = Index.new :books do
     source   Sources::CSV.new(:title, :author, :year, file: "data/#{PICKY_ENVIRONMENT}/library.csv")
     indexing removes_characters: /[^a-zA-Z0-9\s\/\-\_\:\"\&\.]/i,
              stopwords:          /\b(and|the|of|it|in|for)\b/i,
@@ -32,11 +32,12 @@ class BookSearch < Sinatra::Application
   # Define a search over the books index.
   #
   books = Search.new books_index do
-    searching removes_characters: /[^a-zA-Z0-9\s\/\-\_\&\.\"\~\*\:\,]/i, # Picky needs control chars *"~:, to pass through.
+    searching substitutes_characters_with: CharacterSubstituters::WestEuropean.new, # Normalizes special user input, Ä -> Ae, ñ -> n etc.
+              removes_characters: /[^a-zA-Z0-9\s\/\-\_\&\.\"\~\*\:\,]/i, # Picky needs control chars *"~:, to pass through.
               stopwords:          /\b(and|the|of|it|in|for)\b/i,
-              splits_text_on:     /[\s\/\-\&]+/,
-              substitutes_characters_with: CharacterSubstituters::WestEuropean.new # Normalizes special user input, Ä -> Ae, ñ -> n etc.
-    boost [:title, :author] => +3, [:title] => +1
+              splits_text_on:     /[\s\/\-\&]+/
+    boost [:title, :author] => +3,
+          [:title]          => +1
   end
 
   # Route /books to the books search and log when searching.

metadata

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