picky 1.2.0 → 1.2.1

data/lib/picky/application.rb

@@ -222,8 +222,23 @@ class Application
     # Finalizes the routes.
     #
     def finalize # :nodoc:
+      check
       routing.freeze
     end
+    # Checks app for missing things.
+    #
+    # Warns if something is missing.
+    #
+    # TODO Good specs.
+    #
+    def check # :nodoc:
+      warnings = []
+      warnings << check_external_interface
+      puts "\n#{warnings.join(?\n)}\n\n" unless warnings.all? &:nil?
+    end
+    def check_external_interface
+      "WARNING: No routes defined for application configuration in #{self.class}." if routing.empty?
+    end
     
     # TODO Add more info if possible.
     #

data/lib/picky/cli.rb

@@ -4,10 +4,6 @@ module Picky
   #
   class CLI # :nodoc:all
     
-    def self.mapping
-      @@mapping
-    end
-    
     # Execute a command.
     #
     # Note: By default, help is displayed. I.e. when no command is given.
@@ -26,6 +22,27 @@ module Picky
         params.map { |param| "<#{param}>" }.join(' ') if params
       end
     end
+    class Statistics < Base
+      def execute name, args, params
+        relative_log_file            = args.shift
+        port                         = args.shift
+        
+        usage(name, params) || exit(1) unless relative_log_file
+        
+        ENV['PICKY_LOG_FILE']        = File.expand_path relative_log_file  
+        ENV['PICKY_STATISTICS_PORT'] = port
+        
+        begin
+          require 'picky-statistics'
+        rescue LoadError => e
+          require 'picky/extensions/object'
+          puts_gem_missing 'picky-statistics', 'the Picky statistics'
+          exit 1
+        end
+        
+        require 'picky-statistics/application/app'
+      end
+    end
     class Generate < Base
       def execute name, args, params
         system "picky-generate #{args.join(' ')}"
@@ -50,8 +67,12 @@ module Picky
     #
     @@mapping = {
       :generate => [Generate, 'thing_to_generate: e.g. "unicorn_server"', :parameters],
-      :help     => [Help]
+      :help     => [Help],
+      :stats    => [Statistics, 'logfile_to_use: e.g. log/search.log', 'port (optional)']
     }
+    def self.mapping
+      @@mapping
+    end
     
   end
   

data/lib/picky/extensions/object.rb

@@ -13,4 +13,10 @@ class Object # :nodoc:all
     puts text
   end
   
+  # Puts a text that informs the user of a missing gem.
+  #
+  def puts_gem_missing gem_name, message
+    puts "#{gem_name} gem missing!\nTo use #{message}, you need to:\n  1. Add the following line to Gemfile:\n     gem '#{gem_name}'\n  2. Then, run:\n     bundle update\n"
+  end
+  
 end

data/lib/picky/routing.rb

@@ -142,6 +142,12 @@ class Routing # :nodoc:all
     String === url ? %r{#{url}} : url
   end
   
+  # Returns true if there are no routes defined.
+  #
+  def empty?
+    routes.length.zero?
+  end
+  
   # TODO Beautify.
   #
   def to_s

data/lib/picky/sources/couch.rb

@@ -35,10 +35,58 @@ module Sources
   #
   class Couch < Base
     
+    # If your Couch DB uses UUID keys, use
+    #  Sources::Couch.new(:title, keys: Sources::Couch::UUIDKeys.new)
+    # Do not forget to reconvert the UUID Key from an integer in the client:
+    #  uuid = UUIDTools::UUID.parse_int(id)
+    #  uuid.to_s
+    #
+    class UUIDKeys
+      def initialize
+        # Tries to require the uuidtools gem.
+        #
+        begin
+          require 'uuidtools'
+        rescue LoadError
+          puts_gem_missing 'uuidtools', 'UUID keys in a CouchDB source'
+          exit 1
+        end
+      end
+      def to_i id
+        uuid = UUIDTools::UUID.parse id
+        uuid.to_i
+      end
+    end
+    
+    # If your Couch DB uses Hex keys, use
+    #  Sources::Couch.new(:title, keys: Sources::Couch::HexKeys.new)
+    # Do not forget to reconvert the Hex Key from an integer in the client:
+    #  id.to_s(16)
+    #
+    class HexKeys
+      def to_i id
+        id.hex
+      end
+    end
+    
+    # If your Couch DB uses Integer keys, use
+    #  Sources::Couch.new(:title, keys: Sources::Couch::IntegerKeys.new)
+    #
+    class IntegerKeys
+      def to_i id
+        id
+      end
+    end
+    
+    #
+    #
     def initialize *category_names, options
       check_gem
+      
       Hash === options && options[:url] || raise_no_db_given(category_names)
       @db = RestClient::Resource.new options.delete(:url), options
+      
+      @to_i_strategy = options.delete(:keys) || HexKeys.new
     end
     
     # Tries to require the rest_client gem.
@@ -46,7 +94,7 @@ module Sources
     def check_gem # :nodoc:
       require 'rest_client'
     rescue LoadError
-      puts "Rest-client gem missing!\nTo use the CouchDB source, you need to:\n  1. Add the following line to Gemfile:\n     gem 'rest-client'\n  2. Then, run:\n     bundle update\n"
+      puts_gem_missing 'rest-client', 'the CouchDB source'
       exit 1
     end
 
@@ -54,10 +102,11 @@ module Sources
     #
     # See important note, above.
     #
+    @@id_key = '_id'
     def harvest type, category
       category_name = category.from.to_s
       get_data do |doc|
-        yield doc['_id'].hex, doc[category_name] || next
+        yield @to_i_strategy.to_i(doc[@@id_key]), doc[category_name] || next
       end
     end
     

data/lib/picky/sources/delicious.rb

@@ -20,7 +20,7 @@ module Sources
     def check_gem # :nodoc:
       require 'www/delicious'
     rescue LoadError
-      puts "Delicious gem missing!\nTo use the delicious source, you need to:\n  1. Add the following line to Gemfile:\n     gem 'www-delicious'\n  2. Then, run:\n     bundle update\n"
+      puts_gem_missing 'www-delicious', 'the delicious source'
       exit 1
     end
     

data/spec/lib/cli_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+# We need to load the CLI file explicitly as the CLI is not loaded with the Loader (not needed in the server, only for script runs).
+#
+require File.expand_path '../../../lib/picky/cli', __FILE__
+
+# TODO Finish this prototype Spec, redesign.
+#
+describe Picky::CLI do
+  
+  describe Picky::CLI::Base do
+    before(:each) do
+      @executor = Picky::CLI::Base.new
+    end
+    describe 'usage' do
+      it 'calls puts with an usage' do
+        @executor.should_receive(:puts).once.with "Usage\n  picky some_name <param1> <param 2 (optional)>"
+        
+        @executor.usage :some_name, [:param1, 'param 2 (optional)']
+      end
+    end
+    describe 'params_to_s' do
+      it 'returns the right string' do
+        @executor.params_to_s([:param1, 'param 2 (optional)']).should == '<param1> <param 2 (optional)>'
+      end
+    end
+  end
+  
+end

data/spec/lib/extensions/object_spec.rb

@@ -23,4 +23,12 @@ describe Object do
     end
   end
   
+  describe 'puts_gem_missing' do
+    it 'should puts right' do
+      @object.should_receive(:puts).once.with "gnorf gem missing!\nTo use gnarble gnarf, you need to:\n  1. Add the following line to Gemfile:\n     gem 'gnorf'\n  2. Then, run:\n     bundle update\n"
+      
+      @object.puts_gem_missing 'gnorf', 'gnarble gnarf'
+    end
+  end
+  
 end

data/spec/lib/routing_spec.rb

@@ -35,6 +35,25 @@ describe Routing do
       "rack.input"=>'' }
   end
   
+  context 'empty?' do
+    context 'no routes' do
+      before(:each) do
+        @routing.reset_routes
+      end
+      it 'returns the right answer' do
+        @routing.empty?.should == true
+      end
+    end
+    context 'with routes' do
+      before(:each) do
+        @routing.route %r{something} => :some_query
+      end
+      it 'returns the right answer' do
+        @routing.empty?.should == false
+      end
+    end
+  end
+  
   context 'real routes' do
     before(:each) do
       @routing.reset_routes

data/spec/lib/sources/couch_spec.rb

@@ -2,33 +2,115 @@ require 'spec_helper'
 
 describe Sources::Couch do
   
-  context "without database" do
-    it "should fail correctly" do
-      lambda { @source = Sources::Couch.new(:a, :b, :c) }.should raise_error(Sources::NoCouchDBGiven)
+  describe 'UUIDKeys' do
+    before(:each) do
+      @keys = Sources::Couch::UUIDKeys.new
+    end
+    it 'converts uuids' do
+      @keys.to_i('550e8400-e29b-41d4-a716-446655440000').should == 113059749145936325402354257176981405696
     end
   end
-  
-  context "with database" do
+  describe 'HexKeys' do
+    before(:each) do
+      @keys = Sources::Couch::HexKeys.new
+    end
+    it 'converts uuids' do
+      @keys.to_i('7f').should == 127
+    end
+  end
+  describe 'IntegerKeys' do
     before(:each) do
-      @source = Sources::Couch.new :a, :b, :c, url: 'http://localhost:5984/picky'
-      RestClient::Request.should_receive(:execute).any_number_of_times.and_return %{{"rows":[{"doc":{"_id":"7f","a":"a data","b":"b data","c":"c data"}}]}}
-    end
-    
-    describe "harvest" do
-      it "yields the right data" do
-        field = stub :b, :from => :b
-        @source.harvest :anything, field do |id, token|
-          id.should    eql(127) 
-          token.should eql('b data')
-        end.should have(1).item
+      @keys = Sources::Couch::IntegerKeys.new
+    end
+    it 'converts uuids' do
+      @keys.to_i('123').should == '123'
+    end
+  end
+  
+  describe 'special keys' do
+    context 'uuid keys' do
+      context "with database" do
+        before(:each) do
+          @source = Sources::Couch.new :a, :b, :c, url: 'http://localhost:5984/picky', keys: Sources::Couch::UUIDKeys.new
+          RestClient::Request.should_receive(:execute).any_number_of_times.and_return %{{"rows":[{"doc":{"_id":"550e8400-e29b-41d4-a716-446655440000","a":"a data","b":"b data","c":"c data"}}]}}
+        end
+
+        describe "harvest" do
+          it "yields the right data" do
+            field = stub :b, :from => :b
+            @source.harvest :anything, field do |id, token|
+              id.should    eql(113059749145936325402354257176981405696) 
+              token.should eql('b data')
+            end.should have(1).item
+          end
+        end
+
+        describe "get_data" do
+          it "yields each line" do
+            @source.get_data do |data|
+              data.should == { "_id" => "550e8400-e29b-41d4-a716-446655440000", "a" => "a data", "b" => "b data", "c" => "c data" }
+            end.should have(1).item
+          end
+        end
       end
     end
-    
-    describe "get_data" do
-      it "yields each line" do
-        @source.get_data do |data|
-          data.should == { "_id" => "7f", "a" => "a data", "b" => "b data", "c" => "c data" }
-        end.should have(1).item
+    context 'integer keys' do
+      context "with database" do
+        before(:each) do
+          @source = Sources::Couch.new :a, :b, :c, url: 'http://localhost:5984/picky', keys: Sources::Couch::IntegerKeys.new
+          RestClient::Request.should_receive(:execute).any_number_of_times.and_return %{{"rows":[{"doc":{"_id":"123","a":"a data","b":"b data","c":"c data"}}]}}
+        end
+
+        describe "harvest" do
+          it "yields the right data" do
+            field = stub :b, :from => :b
+            @source.harvest :anything, field do |id, token|
+              id.should    eql('123') 
+              token.should eql('b data')
+            end.should have(1).item
+          end
+        end
+
+        describe "get_data" do
+          it "yields each line" do
+            @source.get_data do |data|
+              data.should == { "_id" => "123", "a" => "a data", "b" => "b data", "c" => "c data" }
+            end.should have(1).item
+          end
+        end
+      end
+    end
+  end
+  
+  context 'default keys' do
+    context "without database" do
+      it "should fail correctly" do
+        lambda { @source = Sources::Couch.new(:a, :b, :c) }.should raise_error(Sources::NoCouchDBGiven)
+      end
+    end
+
+    context "with database" do
+      before(:each) do
+        @source = Sources::Couch.new :a, :b, :c, url: 'http://localhost:5984/picky'
+        RestClient::Request.should_receive(:execute).any_number_of_times.and_return %{{"rows":[{"doc":{"_id":"7f","a":"a data","b":"b data","c":"c data"}}]}}
+      end
+
+      describe "harvest" do
+        it "yields the right data" do
+          field = stub :b, :from => :b
+          @source.harvest :anything, field do |id, token|
+            id.should    eql(127) 
+            token.should eql('b data')
+          end.should have(1).item
+        end
+      end
+
+      describe "get_data" do
+        it "yields each line" do
+          @source.get_data do |data|
+            data.should == { "_id" => "7f", "a" => "a data", "b" => "b data", "c" => "c data" }
+          end.should have(1).item
+        end
       end
     end
   end

data/spec/lib/sources/delicious_spec.rb

@@ -15,7 +15,7 @@ describe Sources::Delicious do
           @source.should_receive(:require).any_number_of_times.and_raise LoadError
         end
         it "puts & exits" do
-          @source.should_receive(:puts).once.with "Delicious gem missing!\nTo use the delicious source, you need to:\n  1. Add the following line to Gemfile:\n     gem 'www-delicious'\n  2. Then, run:\n     bundle update\n"
+          @source.should_receive(:puts).once.with "www-delicious gem missing!\nTo use the delicious source, you need to:\n  1. Add the following line to Gemfile:\n     gem 'www-delicious'\n  2. Then, run:\n     bundle update\n"
           @source.should_receive(:exit).once.with 1
           
           @source.check_gem

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 2
-  - 0
-  version: 1.2.0
+  - 1
+  version: 1.2.1
 platform: ruby
 authors: 
 - Florian Hanke
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-17 00:00:00 +01:00
+date: 2010-12-20 00:00:00 +01:00
 default_executable: picky
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -161,6 +161,7 @@ files:
 - spec/lib/cacher/weights_generator_spec.rb
 - spec/lib/calculations/location_spec.rb
 - spec/lib/character_substituters/west_european_spec.rb
+- spec/lib/cli_spec.rb
 - spec/lib/configuration/index_spec.rb
 - spec/lib/cores_spec.rb
 - spec/lib/extensions/array_spec.rb
@@ -267,6 +268,7 @@ test_files:
 - spec/lib/cacher/weights_generator_spec.rb
 - spec/lib/calculations/location_spec.rb
 - spec/lib/character_substituters/west_european_spec.rb
+- spec/lib/cli_spec.rb
 - spec/lib/configuration/index_spec.rb
 - spec/lib/cores_spec.rb
 - spec/lib/extensions/array_spec.rb