picky-generators 3.0.0.pre1 → 3.0.0.pre2

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

@@ -13,12 +13,11 @@ module Picky
       def initialize
         @types = {
           :sinatra_client       => [Client::Sinatra, :sinatra_client_name],
-          :client               => [Client::Sinatra, :client_name],
+          :client               => [Client::Sinatra, :sinatra_client_name],
 
-          :unicorn_server       => [Server::Unicorn, :unicorn_server_name],
-          :empty_unicorn_server => [Server::EmptyUnicorn, :empty_unicorn_server_name],
+          :classic_server       => [Server::Classic, :unicorn_server_name],
           :sinatra_server       => [Server::Sinatra, :sinatra_server_name],
-          :server               => [Server::Sinatra, :server_name]
+          :server               => [Server::Sinatra, :sinatra_server_name]
         }
       end
 

data/lib/picky-generators/generators/server/{unicorn.rb → classic.rb}

@@ -4,24 +4,24 @@ module Picky
 
     module Server
 
-      # Generates a new Picky Unicorn Server Example.
+      # Generates a new Picky Classic Server Example.
       #
       # Example:
-      #   > picky-generate unicorn_server my_lovely_unicorn
+      #   > picky-generate classic_server my_classic_directory
       #
-      class Unicorn < Picky::Generators::Base
+      class Classic < Picky::Generators::Base
 
         def initialize identifier, name, *args
-          super identifier, name, 'server/unicorn', *args
+          super identifier, name, 'server/classic', *args
         end
 
         #
         #
         def generate
-          exclaim "Setting up Picky Unicorn Server \"#{name}\"."
+          exclaim "Setting up Picky Classic Server \"#{name}\"."
           create_target_directory
           copy_all_files
-          copy_all_files expand_prototype_path('server/shared_unicorn')
+          copy_all_files expand_prototype_path('server/shared')
           exclaim "\"#{name}\" is a great project name! Have fun :)\n"
           exclaim ""
           exclaim "Next steps:"

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

@@ -7,7 +7,7 @@ module Picky
       # Generates a new Picky Sinatra/Unicorn Server Example.
       #
       # Example:
-      #   > picky-generate sinatra_server my_lovely_unicorn
+      #   > picky-generate sinatra_server my_sinatra_directory
       #
       class Sinatra < Picky::Generators::Base
 
@@ -20,7 +20,8 @@ module Picky
         def generate
           exclaim "Setting up Picky Sinatra Server \"#{name}\"."
           create_target_directory
-          copy_all_files expand_prototype_path('server/sinatra')
+          copy_all_files
+          copy_all_files expand_prototype_path('server/shared')
           exclaim "\"#{name}\" is a great project name! Have fun :)\n"
           exclaim ""
           exclaim "Next steps:"

data/lib/picky-generators.rb

@@ -1,9 +1,10 @@
 require File.expand_path '../picky-generators/generators/not_found_exception', __FILE__
 
 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/classic', __FILE__
 require File.expand_path '../picky-generators/generators/server/sinatra', __FILE__
 
 require File.expand_path '../picky-generators/generators/selector', __FILE__

data/prototypes/server/classic/Gemfile

@@ -0,0 +1,27 @@
+source :gemcutter
+
+# Gems required by Picky.
+#
+gem 'picky',      '3.0.0.pre2'
+gem 'rake'
+gem 'rack'
+gem 'rack-mount'
+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 'unicorn'
+gem 'mysql' # Project specific.
+gem 'redis' # Project specific.
+
+group :test do
+  gem 'picky-client', '3.0.0.pre2'
+  gem 'rspec'
+end

data/prototypes/server/classic/app/README

@@ -0,0 +1,4 @@
+All your application definitions go here.
+
+/app needs a the file defined by picky:
+  * application.rb - how to handle indexing, queries, routing.

data/prototypes/server/{unicorn → classic}/app/application.rb

@@ -1,11 +1,13 @@
 # encoding: utf-8
 #
+require File.expand_path '../logging', __FILE__
+
 # TODO Adapt the generated example
 #      (a library books finder) to what you need.
 #
 # Questions? Mail me, IRC #picky, the google group, http://github.com/floere/picky/wiki.
 #
-class PickySearch < Picky::Application
+class BookSearch < Picky::Application
 
   # So we don't have to write Picky::
   # in front of everything.
@@ -35,8 +37,11 @@ class PickySearch < Picky::Application
     category :year, partial: Partial::None.new
   end
 
-  route %r{\A/books\Z} => Search.new(books_index) do
-    boost [:title, :author] => +3, [:title] => +1
+  books = Search.new books_index do
+    boost [:title, :author] => +3,
+          [:title] => +1
   end
 
+  route %r{\A/books\Z} => books
+
 end

data/prototypes/server/{shared_unicorn → classic}/app/logging.rb

@@ -1,7 +1,11 @@
+# Separate file since this is usually what is
+# environment specific.
+#
+
 # Standard logging.
 #
 require 'logger'
-PickyLog = Picky::Loggers::Search.new ::Logger.new(File.expand_path('log/search.log', PICKY_ROOT))
+Picky.logger = 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.
@@ -10,11 +14,10 @@ PickyLog = Picky::Loggers::Search.new ::Logger.new(File.expand_path('log/search.
 #
 # begin
 #   log_program_name = 'search/query'
-#   logger           = SyslogLogger.new log_program_name
-#   PickyLog        = Picky::Loggers::Search.new logger
+#   Picky.logger    = SyslogLogger.new log_program_name
 #   puts "Logging on syslog #{log_program_name}."
 # rescue StandardError
 #   puts "Could not connect to the syslog, using the normal log."
 #   require 'logger'
-#   PickyLog        = Picky::Loggers::Search.new ::Logger.new(File.join(PICKY_ROOT, 'log/search.log'))
+#   Picky.logger = Logger.new(File.join(PICKY_ROOT, 'log/search.log'))
 # end

data/prototypes/server/{shared_unicorn → classic}/config.ru

@@ -4,12 +4,6 @@ require 'picky'
 
 # Load your application. This requires the following files in
 #
-#  * lib/initializers/*.rb
-#  * lib/tokenizers/*.rb
-#  * lib/indexers/*.rb
-#  * lib/query/*.rb
-#
-#  * app/logging.rb
 #  * app/application.rb
 #
 # (in that order).
@@ -34,4 +28,4 @@ Picky::Indexes.reload
 #
 # Note: Needs to be the same constant name as in app/application.rb.
 #
-run PickySearch
+run BookSearch

data/prototypes/server/{shared_unicorn → classic}/script/console

@@ -30,5 +30,5 @@ puts ""
 puts "Now you can for example create a query instance."
 puts "\x1b[1;30mbooks = Search.new(Indexes[:books]); nil\x1b[m"
 puts "and search on it"
-puts "\x1b[1;30mbooks.search_with_text 'bla'\x1b[m"
+puts "\x1b[1;30mbooks.search 'bla', 20, 0\x1b[m"
 exec "#{options[:irb]} #{libs} --simple-prompt"

data/prototypes/server/classic/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+ENV['PICKY_ENV'] = 'test'
+
+require 'picky'
+
+Picky.logger = Logger.new STDOUT
+puts "Using STDOUT as test log."
+
+Picky::Loader.load_application

data/prototypes/server/sinatra/Gemfile

@@ -2,8 +2,7 @@ source :gemcutter
 
 # Gems required by Picky.
 #
-gem 'picky', '3.0.0.pre1'
-gem 'bundler'
+gem 'picky', '3.0.0.pre2'
 gem 'rake'
 gem 'rack'
 gem 'rack_fast_escape', '2009.06.24' # Optional.
@@ -23,6 +22,6 @@ gem 'mysql' # Project specific.
 gem 'redis' # Project specific.
 
 group :test do
-  gem 'picky-client', '3.0.0.pre1'
+  gem 'picky-client', '3.0.0.pre2'
   gem 'rspec'
 end

data/prototypes/server/sinatra/app.rb

@@ -1,5 +1,6 @@
 require 'sinatra/base'
 require 'picky'
+require File.expand_path '../logging', __FILE__
 
 class BookSearch < Sinatra::Application
 
@@ -30,7 +31,7 @@ class BookSearch < Sinatra::Application
 
   # Define a search over the books index.
   #
-  search = Search.new(books_index) do
+  books = 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\/\-\&]+/,
@@ -38,10 +39,11 @@ class BookSearch < Sinatra::Application
     boost [:title, :author] => +3, [:title] => +1
   end
 
-  # Route /books to the books search.
+  # Route /books to the books search and log when searching.
   #
   get '/books' do
-    results = search.search_with_text params[:query], params[:ids] || 20, params[:offset] || 0
+    results = books.search params[:query], params[:ids] || 20, params[:offset] || 0
+    AppLogger.info results.to_log(params[:query])
     results.to_json
   end
 

data/prototypes/server/sinatra/logging.rb

@@ -0,0 +1,24 @@
+# Separate file since this is usually what is
+# environment specific.
+# (But go ahead and place the code in app.rb if you wish)
+#
+
+# Standard logging.
+#
+require 'logger'
+AppLogger = 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.
+# (For example, because it is used locally and syslog is
+# only available on the servers)
+#
+# begin
+#   log_program_name = 'search/query'
+#   Picky.logger    = SyslogLogger.new log_program_name
+#   puts "Logging on syslog #{log_program_name}."
+# rescue StandardError
+#   puts "Could not connect to the syslog, using the normal log."
+#   require 'logger'
+#   Picky.logger = Logger.new(File.join(PICKY_ROOT, 'log/search.log'))
+# end

data/spec/lib/picky-generators/generators/selector_spec.rb

@@ -10,7 +10,7 @@ describe Picky::Generators::Selector do
     
     describe "generator_for_class" do
       it "should return me a generator for the given class" do
-        @selector.generator_for_class(Picky::Generators::Server::Unicorn, :identifier, :some_args).should be_kind_of(Picky::Generators::Server::Unicorn)
+        @selector.generator_for_class(Picky::Generators::Server::Classic, :identifier, :some_args).should be_kind_of(Picky::Generators::Server::Classic)
       end
     end
     
@@ -19,7 +19,7 @@ describe Picky::Generators::Selector do
         lambda { @selector.generator_for('sinatra_client', 'some_project') }.should_not raise_error
       end
       it "should not raise if a generator is available" do
-        lambda { @selector.generator_for('unicorn_server', 'some_project') }.should_not raise_error
+        lambda { @selector.generator_for('classic_server', 'some_project') }.should_not raise_error
       end
       it "should not raise if a generator is available" do
         lambda { @selector.generator_for('sinatra_server', 'some_project') }.should_not raise_error

data/spec/lib/picky-generators/generators/server/classic_spec.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe Picky::Generators::Server::Classic do
+  
+  before(:each) do
+    @classic = Picky::Generators::Server::Classic.new :classic_server, 'classic_server_dir_name'
+    @classic.stub! :exclaim
+  end
+  
+  context "after initialize" do
+    it 'has the right identifier' do
+      @classic.identifier.should == :classic_server
+    end
+    it 'has the right name' do
+      @classic.name.should == 'classic_server_dir_name'
+    end
+    it 'has the right prototype dir' do
+      @classic.prototype_basedir.should == File.expand_path('../../../../../../prototypes/server/classic', __FILE__)
+    end
+  end
+  
+  describe "generate" do
+    it "should do things in order" do
+      @classic.should_receive(:exclaim).once.ordered # Initial explanation
+      @classic.should_receive(:create_target_directory).once.ordered
+      @classic.should_receive(:copy_all_files).twice.ordered
+      @classic.should_receive(:exclaim).at_least(9).times.ordered # Some user steps to do
+      
+      @classic.generate
+    end
+  end
+  
+end

data/spec/lib/picky-generators/generators/server/sinatra_spec.rb

@@ -25,7 +25,7 @@ describe Picky::Generators::Server::Sinatra do
     it "should do things in order" do
       @sinatra.should_receive(:exclaim).once.ordered # Initial explanation
       @sinatra.should_receive(:create_target_directory).once.ordered
-      @sinatra.should_receive(:copy_all_files)
+      @sinatra.should_receive(:copy_all_files).twice.ordered
       @sinatra.should_receive(:exclaim).at_least(9).times.ordered # Some user steps to do
       
       @sinatra.generate

metadata

@@ -2,7 +2,7 @@
 name: picky-generators
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 3.0.0.pre1
+  version: 3.0.0.pre2
 platform: ruby
 authors: 
 - Florian Hanke
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-07 00:00:00 +10:00
+date: 2011-08-11 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.0.pre1
+        version: 3.0.0.pre2
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -43,7 +43,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 3.0.0.pre1
+        version: 3.0.0.pre2
   type: :runtime
   version_requirements: *id003
 description: Generators for Picky.
@@ -59,9 +59,8 @@ files:
 - lib/picky-generators/generators/client/sinatra.rb
 - lib/picky-generators/generators/not_found_exception.rb
 - lib/picky-generators/generators/selector.rb
-- lib/picky-generators/generators/server/empty_unicorn.rb
+- lib/picky-generators/generators/server/classic.rb
 - lib/picky-generators/generators/server/sinatra.rb
-- lib/picky-generators/generators/server/unicorn.rb
 - lib/picky-generators.rb
 - prototypes/client/sinatra/app.rb
 - prototypes/client/sinatra/book.rb
@@ -78,44 +77,35 @@ files:
 - prototypes/client/sinatra/stylesheets/picky.css
 - prototypes/client/sinatra/views/configure.haml
 - prototypes/client/sinatra/views/search.haml
-- prototypes/server/empty_unicorn/app/application.rb
-- prototypes/server/shared_unicorn/app/db.yml
-- prototypes/server/shared_unicorn/app/logging.rb
-- prototypes/server/shared_unicorn/app/README
-- prototypes/server/shared_unicorn/config.ru
-- prototypes/server/shared_unicorn/Gemfile
-- prototypes/server/shared_unicorn/log/README
-- prototypes/server/shared_unicorn/Rakefile
-- prototypes/server/shared_unicorn/script/console
-- prototypes/server/shared_unicorn/tmp/pids/README
-- prototypes/server/shared_unicorn/tmp/README
-- prototypes/server/shared_unicorn/unicorn.rb
+- prototypes/server/classic/app/application.rb
+- prototypes/server/classic/app/db.yml
+- prototypes/server/classic/app/logging.rb
+- prototypes/server/classic/app/README
+- prototypes/server/classic/config.ru
+- prototypes/server/classic/Gemfile
+- prototypes/server/classic/log/README
+- prototypes/server/classic/script/console
+- prototypes/server/classic/spec/spec_helper.rb
+- prototypes/server/shared/data/development/library.csv
+- prototypes/server/shared/data/production/library.csv
+- prototypes/server/shared/data/test/library.csv
+- prototypes/server/shared/Rakefile
+- prototypes/server/shared/spec/integration_spec.rb
+- prototypes/server/shared/tmp/pids/README
+- prototypes/server/shared/unicorn.rb
 - prototypes/server/sinatra/app.rb
 - prototypes/server/sinatra/config.ru
-- prototypes/server/sinatra/data/development/library.csv
-- prototypes/server/sinatra/data/production/library.csv
-- prototypes/server/sinatra/data/test/library.csv
 - prototypes/server/sinatra/Gemfile
 - prototypes/server/sinatra/log/README
 - prototypes/server/sinatra/log/unicorn.stderr.log
 - prototypes/server/sinatra/log/unicorn.stdout.log
-- prototypes/server/sinatra/Rakefile
-- prototypes/server/sinatra/spec/integration_spec.rb
+- prototypes/server/sinatra/logging.rb
 - prototypes/server/sinatra/spec/spec_helper.rb
-- prototypes/server/sinatra/tmp/pids/README
-- prototypes/server/sinatra/unicorn.rb
-- prototypes/server/unicorn/app/application.rb
-- prototypes/server/unicorn/data/development/library.csv
-- prototypes/server/unicorn/data/production/library.csv
-- prototypes/server/unicorn/data/test/library.csv
-- prototypes/server/unicorn/Rakefile
-- prototypes/server/unicorn/spec/integration_spec.rb
-- prototypes/server/unicorn/spec/spec_helper.rb
 - spec/lib/picky-generators/generators/base_spec.rb
 - spec/lib/picky-generators/generators/client/sinatra_spec.rb
 - spec/lib/picky-generators/generators/selector_spec.rb
+- spec/lib/picky-generators/generators/server/classic_spec.rb
 - spec/lib/picky-generators/generators/server/sinatra_spec.rb
-- spec/lib/picky-generators/generators/server/unicorn_spec.rb
 - bin/picky-generate
 has_rdoc: true
 homepage: http://floere.github.com/picky
@@ -149,5 +139,5 @@ test_files:
 - spec/lib/picky-generators/generators/base_spec.rb
 - spec/lib/picky-generators/generators/client/sinatra_spec.rb
 - spec/lib/picky-generators/generators/selector_spec.rb
+- spec/lib/picky-generators/generators/server/classic_spec.rb
 - spec/lib/picky-generators/generators/server/sinatra_spec.rb
-- spec/lib/picky-generators/generators/server/unicorn_spec.rb

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

@@ -1,40 +0,0 @@
-module Picky
-
-  module Generators
-
-    module Server
-
-      # Generates a new empty Picky Unicorn Server.
-      #
-      # Example:
-      #   > picky-generate unicorn_server my_lovely_unicorn
-      #
-      class EmptyUnicorn < Picky::Generators::Base
-
-        def initialize identifier, name, *args
-          super identifier, name, 'server/empty_unicorn', *args
-        end
-
-        #
-        #
-        def generate
-          exclaim "Setting up Picky Unicorn Server \"#{name}\"."
-          create_target_directory
-          copy_all_files expand_prototype_path('server/shared_unicorn')
-          copy_all_files
-          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 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/prototypes/server/empty_unicorn/app/application.rb

@@ -1,10 +0,0 @@
-# encoding: utf-8
-#
-# 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 < Picky::Application
-
-  # TODO Your search configuration here.
-
-end

data/prototypes/server/shared_unicorn/Gemfile

@@ -1,35 +0,0 @@
-source :gemcutter
-
-# Gems required by Picky.
-#
-gem 'picky',      '3.0.0.pre1'
-gem 'rake'
-gem 'bundler'
-gem 'rack',       '~> 1.2.2'
-gem 'rack-mount', '~> 0.6.13'
-gem 'text',       '~> 0.2.0'
-gem 'yajl-ruby',  '~> 0.8.1', :require => 'yajl'
-
-# Should be optional, but isn't yet. Sorry.
-#
-gem 'activesupport', '~> 3.0', :require => 'active_support/core_ext'
-gem 'activerecord',  '~> 3.0', :require => 'active_record'
-
-# Optional. Makes rack faster.
-#
-gem 'rack_fast_escape', '2009.06.24'
-
-# Optional. Use your preferred web server.
-#
-gem 'unicorn'
-
-# Optional. Use your preferred database adapter.
-#
-gem 'mysql'
-
-# Integration testing needs the client.
-#
-group :test do
-  gem 'picky-client', '3.0.0.pre1'
-  gem 'rspec'
-end

data/prototypes/server/shared_unicorn/Rakefile

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

data/prototypes/server/shared_unicorn/app/README

@@ -1,5 +0,0 @@
-All your application definitions go here.
-
-/app needs a few files defined by picky:
-  * application.rb - how to handle indexing, queries, routing.
-  * logging.rb

data/prototypes/server/sinatra/unicorn.rb

@@ -1,17 +0,0 @@
-listen            '0.0.0.0:8080'
-pid               'tmp/pids/unicorn.pid'
-preload_app       true
-stderr_path       'log/unicorn.stderr.log'
-stdout_path       'log/unicorn.stdout.log'
-timeout           10
-worker_processes  3
-
-# TODO Decide if you want to use the Unicorn killing trick. (Good with large data sets)
-#
-# After forking, the GC is disabled, because we
-# kill off the workers after x requests and fork
-# new ones – so the GC doesn't run.
-#
-# after_fork do |_, _|
-#   GC.disable
-# end

data/prototypes/server/unicorn/Rakefile

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