picky-generators 1.1.0

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

@@ -0,0 +1,20 @@
+# Standard logging.
+#
+require 'logger'
+PickyLog = 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.
+# (For example, because it is used locally and syslog is
+# only available on the servers)
+#
+# begin
+#   log_program_name = 'search/query'
+#   logger           = SyslogLogger.new log_program_name
+#   PickyLog        = 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'))
+# end

data/prototypes/server/unicorn/config.ru

@@ -0,0 +1,35 @@
+# Require the gem. This loads the search framework.
+#
+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).
+#
+Loader.load_application
+
+# Load the indexes into the memory.
+#
+Indexes.load_from_cache
+
+# Use Harakiri middleware to kill worker child after X requests.
+#
+# Works only with web servers that fork worker children and which
+# fork new children, like for example Unicorn.
+#
+Rack::Harakiri.after = 50
+use Rack::Harakiri
+
+# Start accepting requests.
+#
+# Note: Needs to be the same constant name as in app/application.rb.
+#
+run PickySearch

data/prototypes/server/unicorn/log/README

@@ -0,0 +1 @@
+Logs go here by default.

data/prototypes/server/unicorn/script/console

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+#
+irb = 'irb'
+
+require 'optparse'
+options = { :sandbox => false, :irb => irb }
+OptionParser.new do |opt|
+  opt.banner = "Usage: console [environment] [options]"
+  opt.on("--irb=[#{irb}]", 'Invoke a different irb.') { |v| options[:irb] = v }
+  opt.parse!(ARGV)
+end
+
+libs =  " -r irb/completion"
+libs << %( -r "picky" )
+
+mapping = {
+  'p' => 'production',
+  'd' => 'development',
+  't' => 'test'
+}
+given_env = ARGV.first
+ENV['PICKY_ENV'] = mapping[given_env] || given_env || ENV['PICKY_ENV'] || 'development'
+
+puts "Use \x1b[1;30mLoader.load_application\x1b[m to load app."
+puts "Use \x1b[1;30mIndexes.load_from_cache\x1b[m after that to load indexes."
+puts "Copy the following line to do just that:"
+puts "\x1b[1;30mLoader.load_application; Indexes.load_from_cache; nil\x1b[m"
+puts ""
+puts "Now you can for example create a query instance."
+puts "\x1b[1;30mfull_books = Query::Full.new(Indexes[:books]); nil\x1b[m"
+puts "and search on it"
+puts "\x1b[1;30mfull_books.search_with_text 'bla'\x1b[m"
+exec "#{options[:irb]} #{libs} --simple-prompt"

data/prototypes/server/unicorn/unicorn.ru

@@ -0,0 +1,15 @@
+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  2
+
+# 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/spec/lib/picky-generators/generators/base_spec.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Picky::Generators do
+  
+  describe Picky::Generators::Base do
+    
+    before(:each) do
+      @generators = Picky::Generators::Base.new :identifier, 'some_name', 'some/path'
+      @generators.stub! :exclaim
+    end
+    
+    context "after initialize" do
+      it 'has the right identifier' do
+        @generators.identifier.should == :identifier
+      end
+      it 'has the right name' do
+        @generators.name.should == 'some_name'
+      end
+      it 'has the right prototype dir' do
+        @generators.prototype_basedir.should == File.expand_path('../../../../../prototypes/some/path', __FILE__)
+      end
+    end
+    
+    describe "create_target_directory" do
+      context "file exists" do
+        before(:each) do
+          File.stub! :exists? => true
+        end
+        it "should just tell the user that" do
+          @generators.stub! :target_directory => :some_target_directory
+          
+          @generators.should_receive(:exists).once.with :some_target_directory
+          
+          @generators.create_target_directory
+        end
+        it "should not make the directory" do
+          FileUtils.should_receive(:mkdir).never
+          
+          @generators.create_target_directory
+        end
+      end
+      context "file does not exist" do
+        before(:each) do
+          File.stub! :exists? => false
+          FileUtils.stub! :mkdir
+        end
+        it "should make the directory" do
+          @generators.stub! :target_directory => :some_target_directory
+          
+          FileUtils.should_receive(:mkdir).once.with :some_target_directory
+          
+          @generators.create_target_directory
+        end
+        it "should tell the user" do
+          @generators.stub! :target_directory => :some_target_directory
+          
+          @generators.should_receive(:created).once.with :some_target_directory
+          
+          @generators.create_target_directory
+        end
+      end
+    end
+    
+    describe "target_filename_for" do
+      it "should return the right filename" do
+        @generators.stub! :target_directory => 'some_target_directory'
+        
+        test_filename = File.expand_path 'some/file/name', @generators.prototype_basedir
+        
+        @generators.target_filename_for(test_filename).should == 'some_target_directory/some/file/name'
+      end
+    end
+    
+    describe "target_directory" do
+      it "should return the right dir name" do
+        @generators.target_directory.should == File.expand_path('../../../../../some_name', __FILE__)
+      end
+    end
+    
+  end
+  
+end

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

@@ -0,0 +1,35 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe Picky::Generators::Client::Sinatra do
+  
+  before(:each) do
+    @sinatra = Picky::Generators::Client::Sinatra.new :sinatra_client, 'sinatra_client_dir_name'
+    @sinatra.stub! :exclaim
+  end
+  
+  context "after initialize" do
+    it 'has the right identifier' do
+      @sinatra.identifier.should == :sinatra_client
+    end
+    it 'has the right name' do
+      @sinatra.name.should == 'sinatra_client_dir_name'
+    end
+    it 'has the right prototype dir' do
+      @sinatra.prototype_basedir.should == File.expand_path('../../../../../../prototypes/client/sinatra', __FILE__)
+    end
+  end
+  
+  describe "generate" 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).once.ordered
+      @sinatra.should_receive(:exclaim).at_least(7).times.ordered # Some user steps to do
+      
+      @sinatra.generate
+    end
+  end
+  
+end

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

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Picky::Generators::Selector do
+  
+  describe "main class" do
+    before(:each) do
+      @selector = Picky::Generators::Selector.new
+    end
+    
+    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)
+      end
+    end
+    
+    describe "generator_for" do
+      it "should not raise if a generator is available" 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
+      end
+      
+      it "should raise if a generator is not available" do
+        lambda { @selector.generator_for('blarf', 'gnorf') }.should raise_error(Picky::Generators::NotFoundException)
+      end
+    end
+    
+    describe "generate" do
+      it "should raise a NoGeneratorException if called with the wrong params" do
+        lambda { @selector.generate('blarf', 'gnorf') }.should raise_error(Picky::Generators::NotFoundException)
+      end
+      it "should not raise on the right params" do
+        @selector.stub! :generator_for_class => stub(:generator, :generate => nil)
+        
+        lambda { @selector.generate('sinatra_client', 'some_project') }.should_not raise_error
+      end
+    end
+  end
+  
+end

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

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification 
+name: picky-generators
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- Florian Hanke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-12 00:00:00 +01:00
+default_executable: picky-generate
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: picky
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: picky-client
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id003
+description: Generators for Picky.
+email: florian.hanke+picky-generators@gmail.com
+executables: 
+- picky-generate
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/picky-generators/generators/base.rb
+- 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/unicorn.rb
+- lib/picky-generators.rb
+- prototypes/client/sinatra/app.rb
+- prototypes/client/sinatra/book.rb
+- prototypes/client/sinatra/config.ru
+- prototypes/client/sinatra/Gemfile
+- prototypes/client/sinatra/images/picky.png
+- prototypes/client/sinatra/javascripts/jquery-1.3.2.js
+- prototypes/client/sinatra/javascripts/jquery-1.4.3.min.js
+- prototypes/client/sinatra/javascripts/jquery.scrollTo-1.4.2.js
+- prototypes/client/sinatra/javascripts/jquery.timer.js
+- prototypes/client/sinatra/javascripts/picky.min.js
+- prototypes/client/sinatra/library.csv
+- prototypes/client/sinatra/stylesheets/stylesheet.css
+- prototypes/client/sinatra/stylesheets/stylesheet.sass
+- prototypes/client/sinatra/views/configure.haml
+- prototypes/client/sinatra/views/search.haml
+- prototypes/server/unicorn/app/application.rb
+- prototypes/server/unicorn/app/db.yml
+- prototypes/server/unicorn/app/library.csv
+- prototypes/server/unicorn/app/logging.rb
+- prototypes/server/unicorn/app/README
+- prototypes/server/unicorn/config.ru
+- prototypes/server/unicorn/Gemfile
+- prototypes/server/unicorn/log/README
+- prototypes/server/unicorn/Rakefile
+- prototypes/server/unicorn/script/console
+- prototypes/server/unicorn/tmp/pids/README
+- prototypes/server/unicorn/tmp/README
+- prototypes/server/unicorn/unicorn.ru
+- 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/unicorn_spec.rb
+- bin/picky-generate
+has_rdoc: true
+homepage: http://floere.github.com/picky
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: http://rubyforge.org/projects/picky
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Generators for Picky the Ruby Search Engine.
+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/unicorn_spec.rb