picky 4.1.0 → 4.2.0

data/lib/picky/category.rb

@@ -79,7 +79,7 @@ module Picky
     def dump
       exact.dump
       partial.dump
-      timed_exclaim %Q{  "#{identifier}": Dumped -> #{index_directory.gsub("#{PICKY_ROOT}/", '')}/#{name}_*.}
+      Picky.logger.dump self
     end
 
     # Returns the backend.

data/lib/picky/category_indexed.rb

@@ -7,7 +7,7 @@ module Picky
     # Loads the index from cache.
     #
     def load
-      timed_exclaim %Q{  "#{identifier}": Loading index from cache.}
+      Picky.logger.load self
       clear_realtime # THINK Should we really explicitly clear the realtime? Or should it just be loaded?
       exact.load
       partial.load

data/lib/picky/extensions/object.rb

@@ -1,5 +1,7 @@
 class Object # :nodoc:all
-
+  
+  # TODO Remove.
+  
   # Puts a text in the form:
   #   12:34:56: text here
   #
@@ -10,8 +12,8 @@ class Object # :nodoc:all
   # Just puts the given text.
   #
   def exclaim text
-    STDOUT.puts text
-    STDOUT.flush
+    Picky.logger.info text
+    Picky.logger.flush
   end
 
   # Puts a text that informs the user of a missing gem.

data/lib/picky/helpers/indexing.rb

@@ -6,12 +6,10 @@ module Picky
     module Indexing
 
       include Measuring
-
-      # Returns a duration in seconds.
-      #
+      
       def timed_indexing scheduler, &block
-        timed_exclaim "Indexing using #{scheduler.fork? ? 'multiple processes' : 'a single process'}."
-        timed_exclaim "Indexing finished after #{timed(&block).round}s."
+        Picky.logger.info "Picky is indexing using #{scheduler.fork? ? 'multiple processes' : 'a single process'}: "
+        Picky.logger.info " Done in #{timed(&block).round}s.\n"
       end
 
     end

data/lib/picky/indexers/base.rb

@@ -40,7 +40,7 @@ module Picky
       end
 
       def notify_finished prepared_file
-        timed_exclaim %Q{  "#{@index_or_category.identifier}": Tokenized -> #{prepared_file.path.gsub("#{PICKY_ROOT}/", '')}.}
+        Picky.logger.tokenize @index_or_category, prepared_file
       end
 
     end

data/lib/picky/indexes_indexing.rb

@@ -26,7 +26,7 @@ module Picky
       indexes.each { |index| index.prepare scheduler }
       scheduler.finish
 
-      timed_exclaim "Tokenizing finished, generating data for indexes from tokenized data."
+      # timed_exclaim "Tokenizing finished, generating data for indexes from tokenized data."
 
       indexes.each { |index| index.cache scheduler }
       scheduler.finish

data/lib/picky/loader.rb

@@ -192,6 +192,13 @@ module Picky
         load_relative 'api/category/partial'
         load_relative 'api/category/similarity'
         load_relative 'api/search/boost'
+        
+        # Loggers.
+        #
+        load_relative 'loggers/silent'
+        load_relative 'loggers/concise'
+        load_relative 'loggers/verbose'
+        load_relative 'loggers/default'
 
         # Tokenizer.
         #

data/lib/picky/loggers/concise.rb

@@ -0,0 +1,49 @@
+module Picky
+  
+  module Loggers
+    
+    # The verbose logger outputs little information.
+    #
+    class Concise < Silent
+      
+      attr_reader :tokenized,
+                  :dumped,
+                  :loaded
+      
+      def initialize *args
+        super *args
+        
+        reset
+      end
+      
+      def reset
+        @tokenized = false
+        @dumped    = false
+        @loaded    = false
+      end
+      
+      def info text
+        io.write text
+      end
+      
+      def tokenize(*)
+        progress 'T'
+      end
+      
+      def dump(*)
+        progress 'D'
+      end
+      
+      def load(*)
+        progress
+      end
+      
+      def progress type = '.'
+        io.write type
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/picky/loggers/default.rb

@@ -0,0 +1,10 @@
+module Picky
+  module Loggers
+    
+    # Default is the concise logger.
+    #
+    remove_const :Default if defined? Default
+    Default = Concise.new
+    
+  end
+end

data/lib/picky/loggers/silent.rb

@@ -0,0 +1,41 @@
+module Picky
+  
+  module Loggers
+    
+    # The silent logger just gobbles up all information.
+    #
+    class Silent
+      
+      attr_reader :io
+      
+      def initialize io = STDOUT
+        @io = io
+      end
+      
+      def info(*)
+        
+      end
+      
+      def tokenize(*)
+        
+      end
+      
+      def dump(*)
+        
+      end
+      
+      def load(*)
+        
+      end
+      
+      # Flush this logger.
+      #
+      def flush
+        io.flush
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/picky/loggers/verbose.rb

@@ -0,0 +1,37 @@
+module Picky
+  
+  module Loggers
+    
+    # The verbose logger outputs all information.
+    #
+    class Verbose < Silent
+      
+      def info text
+        timed_exclaim text
+      end
+      
+      def tokenize index_or_category, prepared_file
+        timed_exclaim %Q{  "#{index_or_category.identifier}": Tokenized -> #{prepared_file.path.gsub("#{PICKY_ROOT}/", '')}.}
+      end
+      
+      def dump category
+        timed_exclaim %Q{  "#{category.identifier}": Dumped -> #{category.index_directory.gsub("#{PICKY_ROOT}/", '')}/#{category.name}_*.}
+      end
+      
+      def load category
+        timed_exclaim %Q{  "#{category.identifier}": Loading index from cache.}
+      end
+      
+      # Puts a text in the form:
+      #   12:34:56: text here
+      #
+      def timed_exclaim text
+        io.puts "#{Time.now.strftime("%H:%M:%S")}: #{text}"
+        flush
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/picky.rb

@@ -32,5 +32,7 @@ module Picky
   class << self
     attr_accessor :logger
   end
+  
+  self.logger = Loggers::Default
 
 end

data/spec/lib/loggers/concise_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Picky::Loggers::Concise do
+  
+  let(:io) { StringIO.new }
+  let(:logger) { described_class.new io }
+
+  describe 'more complicated test case' do
+    it 'is correct' do
+      logger.info 'Tokenizing '
+      logger.tokenize :some_category
+      logger.tokenize :some_category
+      logger.tokenize :some_category
+      logger.info ' Dumping '
+      logger.dump :some_category
+      logger.dump :some_category
+      logger.info ' Loading '
+      logger.load :some_category
+      logger.load :some_category
+      logger.load :some_category
+      logger.load :some_category
+      
+      io.string.should == 'Tokenizing TTT Dumping DD Loading ....'
+    end
+  end
+
+end

data/spec/lib/loggers/silent_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Picky::Loggers::Silent do
+  
+  let(:io) { StringIO.new }
+  let(:logger) { described_class.new io }
+
+  describe 'more complicated test case' do
+    it 'is correct' do
+      logger.info 'Tokenizing '
+      logger.tokenize :some_category
+      logger.tokenize :some_category
+      logger.tokenize :some_category
+      logger.info ' Dumping '
+      logger.dump :some_category
+      logger.dump :some_category
+      logger.info ' Loading '
+      logger.load :some_category
+      logger.load :some_category
+      logger.load :some_category
+      logger.load :some_category
+      
+      io.string.should == ''
+    end
+  end
+
+end

data/spec/lib/loggers/verbose_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Picky::Loggers::Verbose do
+  
+  let(:io) { StringIO.new }
+  let(:logger) { described_class.new io }
+
+  describe 'more complicated test case' do
+    it 'is correct' do
+      index    = Picky::Index.new :some_index
+      category = Picky::Category.new :some_category, index
+      file = stub :file, :path => 'some/path'
+      
+      Time.stub! :now => Time.new('zeros')
+      
+      logger.info 'Tokenizing '
+      logger.tokenize category, file
+      logger.tokenize category, file
+      logger.tokenize category, file
+      logger.info ' Dumping '
+      logger.dump category
+      logger.dump category
+      logger.info ' Loading '
+      logger.load category
+      logger.load category
+      logger.load category
+      logger.load category
+      
+      io.string.should == "00:00:00: Tokenizing \n00:00:00:   \"some_index:some_category\": Tokenized -> some/path.\n00:00:00:   \"some_index:some_category\": Tokenized -> some/path.\n00:00:00:   \"some_index:some_category\": Tokenized -> some/path.\n00:00:00:  Dumping \n00:00:00:   \"some_index:some_category\": Dumped -> index/test/some_index/some_category_*.\n00:00:00:   \"some_index:some_category\": Dumped -> index/test/some_index/some_category_*.\n00:00:00:  Loading \n00:00:00:   \"some_index:some_category\": Loading index from cache.\n00:00:00:   \"some_index:some_category\": Loading index from cache.\n00:00:00:   \"some_index:some_category\": Loading index from cache.\n00:00:00:   \"some_index:some_category\": Loading index from cache.\n"
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: picky
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-24 00:00:00.000000000 Z
+date: 2012-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70259240903180 !ruby/object:Gem::Requirement
+  requirement: &70345542373860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70259240903180
+  version_requirements: *70345542373860
 - !ruby/object:Gem::Dependency
   name: picky-client
-  requirement: &70259240902680 !ruby/object:Gem::Requirement
+  requirement: &70345542373360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.2.0
   type: :development
   prerelease: false
-  version_requirements: *70259240902680
+  version_requirements: *70345542373360
 - !ruby/object:Gem::Dependency
   name: text
-  requirement: &70259240902260 !ruby/object:Gem::Requirement
+  requirement: &70345542372920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70259240902260
+  version_requirements: *70345542372920
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70259240901800 !ruby/object:Gem::Requirement
+  requirement: &70345542372440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70259240901800
+  version_requirements: *70345542372440
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70259240901300 !ruby/object:Gem::Requirement
+  requirement: &70345542371940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70259240901300
+  version_requirements: *70345542371940
 - !ruby/object:Gem::Dependency
   name: procrastinate
-  requirement: &70259240900800 !ruby/object:Gem::Requirement
+  requirement: &70345542371440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70259240900800
+  version_requirements: *70345542371440
 - !ruby/object:Gem::Dependency
   name: rack_fast_escape
-  requirement: &70259240900420 !ruby/object:Gem::Requirement
+  requirement: &70345542371000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70259240900420
+  version_requirements: *70345542371000
 description: Fast Ruby semantic text search engine with comfortable single field interface.
 email: florian.hanke+picky@gmail.com
 executables:
@@ -197,6 +197,10 @@ files:
 - lib/picky/interfaces/live_parameters/master_child.rb
 - lib/picky/interfaces/live_parameters/unicorn.rb
 - lib/picky/loader.rb
+- lib/picky/loggers/concise.rb
+- lib/picky/loggers/default.rb
+- lib/picky/loggers/silent.rb
+- lib/picky/loggers/verbose.rb
 - lib/picky/migrations/from_30_to_31.rb
 - lib/picky/performant.rb
 - lib/picky/query/allocation.rb
@@ -333,6 +337,9 @@ files:
 - spec/lib/interfaces/live_parameters/master_child_spec.rb
 - spec/lib/interfaces/live_parameters/unicorn_spec.rb
 - spec/lib/loader_spec.rb
+- spec/lib/loggers/concise_spec.rb
+- spec/lib/loggers/silent_spec.rb
+- spec/lib/loggers/verbose_spec.rb
 - spec/lib/query/allocation_spec.rb
 - spec/lib/query/allocations_spec.rb
 - spec/lib/query/boosts_spec.rb
@@ -479,6 +486,9 @@ test_files:
 - spec/lib/interfaces/live_parameters/master_child_spec.rb
 - spec/lib/interfaces/live_parameters/unicorn_spec.rb
 - spec/lib/loader_spec.rb
+- spec/lib/loggers/concise_spec.rb
+- spec/lib/loggers/silent_spec.rb
+- spec/lib/loggers/verbose_spec.rb
 - spec/lib/query/allocation_spec.rb
 - spec/lib/query/allocations_spec.rb
 - spec/lib/query/boosts_spec.rb