picky-generators 2.7.0 → 3.0.0.pre1

data/lib/picky-generators/generators/selector.rb

@@ -1,18 +1,24 @@
 module Picky
-  
+
   module Generators
 
     # Selects the right generator.
     #
     class Selector
-  
+
       attr_reader :types
 
+      # TODO All-in-one-server.
+      #
       def initialize
         @types = {
           :sinatra_client       => [Client::Sinatra, :sinatra_client_name],
+          :client               => [Client::Sinatra, :client_name],
+
           :unicorn_server       => [Server::Unicorn, :unicorn_server_name],
-          :empty_unicorn_server => [Server::EmptyUnicorn, :empty_unicorn_server_name] 
+          :empty_unicorn_server => [Server::EmptyUnicorn, :empty_unicorn_server_name],
+          :sinatra_server       => [Server::Sinatra, :sinatra_server_name],
+          :server               => [Server::Sinatra, :server_name]
         }
       end
 
@@ -41,7 +47,7 @@ module Picky
         klass.new *args
       end
     end
-    
+
   end
-  
+
 end

data/lib/picky-generators/generators/server/sinatra.rb

@@ -0,0 +1,41 @@
+module Picky
+
+  module Generators
+
+    module Server
+
+      # Generates a new Picky Sinatra/Unicorn Server Example.
+      #
+      # Example:
+      #   > picky-generate sinatra_server my_lovely_unicorn
+      #
+      class Sinatra < Picky::Generators::Base
+
+        def initialize identifier, name, *args
+          super identifier, name, 'server/sinatra', *args
+        end
+
+        #
+        #
+        def generate
+          exclaim "Setting up Picky Sinatra Server \"#{name}\"."
+          create_target_directory
+          copy_all_files expand_prototype_path('server/sinatra')
+          exclaim "\"#{name}\" is a great project name! Have fun :)\n"
+          exclaim ""
+          exclaim "Next steps:"
+          exclaim "1. cd #{name}"
+          exclaim "2. bundle install"
+          exclaim "3. rake index"
+          exclaim "4. unicorn -c unicorn.rb"
+          exclaim "5. rake todo      # (optional) shows you where Picky needs input from you"
+          exclaim "                  #            if you want to define your own search."
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/picky-generators.rb

@@ -4,5 +4,6 @@ require File.expand_path '../picky-generators/generators/base', __FILE__
 require File.expand_path '../picky-generators/generators/client/sinatra', __FILE__
 require File.expand_path '../picky-generators/generators/server/unicorn', __FILE__
 require File.expand_path '../picky-generators/generators/server/empty_unicorn', __FILE__
+require File.expand_path '../picky-generators/generators/server/sinatra', __FILE__
 
 require File.expand_path '../picky-generators/generators/selector', __FILE__

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

@@ -3,7 +3,7 @@
 # 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.
 #
-class PickySearch < Application
+class PickySearch < Picky::Application
 
   # TODO Your search configuration here.
 

data/prototypes/server/shared_unicorn/Gemfile

@@ -2,7 +2,7 @@ source :gemcutter
 
 # Gems required by Picky.
 #
-gem 'picky',      '~> 2.0'
+gem 'picky',      '3.0.0.pre1'
 gem 'rake'
 gem 'bundler'
 gem 'rack',       '~> 1.2.2'
@@ -30,6 +30,6 @@ gem 'mysql'
 # Integration testing needs the client.
 #
 group :test do
+  gem 'picky-client', '3.0.0.pre1'
   gem 'rspec'
-  gem 'picky-client'
 end

data/prototypes/server/shared_unicorn/Rakefile

@@ -1 +1 @@
-require 'picky-tasks'
+require 'picky/tasks'

data/prototypes/server/shared_unicorn/app/logging.rb

@@ -1,7 +1,7 @@
 # Standard logging.
 #
 require 'logger'
-PickyLog = Loggers::Search.new ::Logger.new(File.expand_path('log/search.log', PICKY_ROOT))
+PickyLog = Picky::Loggers::Search.new ::Logger.new(File.expand_path('log/search.log', PICKY_ROOT))
 
 # Example with using the syslog logger.
 # Falling back to the standard log if it isn't available.
@@ -11,10 +11,10 @@ PickyLog = Loggers::Search.new ::Logger.new(File.expand_path('log/search.log', P
 # begin
 #   log_program_name = 'search/query'
 #   logger           = SyslogLogger.new log_program_name
-#   PickyLog        = Loggers::Search.new logger
+#   PickyLog        = Picky::Loggers::Search.new logger
 #   puts "Logging on syslog #{log_program_name}."
 # rescue StandardError
 #   puts "Could not connect to the syslog, using the normal log."
 #   require 'logger'
-#   PickyLog        = Loggers::Search.new ::Logger.new(File.join(PICKY_ROOT, 'log/search.log'))
+#   PickyLog        = Picky::Loggers::Search.new ::Logger.new(File.join(PICKY_ROOT, 'log/search.log'))
 # end

data/prototypes/server/shared_unicorn/config.ru

@@ -14,11 +14,11 @@ require 'picky'
 #
 # (in that order).
 #
-Loader.load_application
+Picky::Loader.load_application
 
 # Load the indexes into the memory.
 #
-Indexes.load_from_cache
+Picky::Indexes.reload
 
 # TODO Decide if you want to use the Unicorn killing trick. (Good with large data sets)
 #

data/prototypes/server/shared_unicorn/{unicorn.ru → unicorn.rb}

@@ -4,7 +4,7 @@ preload_app       true
 stderr_path       'log/unicorn.stderr.log'
 stdout_path       'log/unicorn.stdout.log'
 timeout           10
-worker_processes  2
+worker_processes  3
 
 # TODO Decide if you want to use the Unicorn killing trick. (Good with large data sets)
 #

data/prototypes/server/sinatra/Gemfile

@@ -0,0 +1,28 @@
+source :gemcutter
+
+# Gems required by Picky.
+#
+gem 'picky', '3.0.0.pre1'
+gem 'bundler'
+gem 'rake'
+gem 'rack'
+gem 'rack_fast_escape', '2009.06.24' # Optional.
+gem 'text'
+gem 'yajl-ruby', :require => 'yajl'
+
+# Should be optional, but isn't yet.
+#
+gem 'activesupport', '~> 3.0', :require => 'active_support/core_ext'
+gem 'activerecord',  '~> 3.0', :require => 'active_record'
+
+# Required by your project.
+#
+gem 'sinatra'
+gem 'unicorn'
+gem 'mysql' # Project specific.
+gem 'redis' # Project specific.
+
+group :test do
+  gem 'picky-client', '3.0.0.pre1'
+  gem 'rspec'
+end

data/prototypes/server/sinatra/Rakefile

@@ -0,0 +1,6 @@
+require 'picky/tasks'
+
+require 'rspec'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec

data/prototypes/server/sinatra/app.rb

@@ -0,0 +1,48 @@
+require 'sinatra/base'
+require 'picky'
+
+class BookSearch < Sinatra::Application
+
+  # We do this so we don't have to type
+  # Picky:: in front of everything.
+  #
+  include Picky
+
+  # Define an index.
+  #
+  books_index = Indexes::Memory.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,
+             splits_text_on:     /[\s\/\-\_\:\"\&\/]/
+    category :title,
+             similarity: Similarity::DoubleMetaphone.new(3),
+             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
+
+  # Index and load on USR1 signal.
+  #
+  Signal.trap('USR1') do
+    books_index.reindex # kill -USR1 <pid>
+  end
+
+  # Define a search over the books index.
+  #
+  search = Search.new(books_index) do
+    searching 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
+  end
+
+  # Route /books to the books search.
+  #
+  get '/books' do
+    results = search.search_with_text params[:query], params[:ids] || 20, params[:offset] || 0
+    results.to_json
+  end
+
+end

data/prototypes/server/sinatra/config.ru

@@ -0,0 +1,14 @@
+require File.expand_path '../app', __FILE__
+
+# Load all indexes.
+#
+Picky::Indexes.reload
+
+# Use Harakiri middleware to kill unicorn child after X requests.
+#
+# See http://vimeo.com/12614970 for more info.
+#
+# Rack::Harakiri.after = 1000
+# use Rack::Harakiri
+
+run BookSearch.new