picky 4.12.13 → 4.13.0

data/lib/picky/categories.rb

@@ -53,7 +53,7 @@ module Picky
     #
     def << category
       reset_qualifier_mapper # TODO Have an add method on QualifierMapper?
-      categories << category unless categories.include? category # This is wrong, and needs to be handled in index.rb
+      categories << category unless categories.include? category # TODO This is wrong, and needs to be handled in index.rb
       category_hash[category.name] = category
     end
 

data/lib/picky/categories_indexed.rb

@@ -59,8 +59,6 @@ module Picky
     #
     # Note: Once I thought this was called too often. But it is not (18.01.2011).
     #
-    # TODO Called too often?
-    #
     def possible_categories token
       token.predefined_categories(qualifier_mapper) || categories
     end

data/lib/picky/category.rb

@@ -42,7 +42,7 @@ module Picky
     end
     
     def configure_from options
-      @from      = options[:from]
+      @from      = options.delete :from
       
       # Instantly extracted to raise an error instantly.
       #
@@ -61,6 +61,8 @@ module Picky
     # TODO I do a lot of helper method calls here. Refactor?
     #
     def configure_indexes_from options
+      warn_if_unknown options
+      
       weights    = weights_from options
       partial    = partial_from options
       similarity = similarity_from options
@@ -70,6 +72,20 @@ module Picky
 
       @prepared  = Backends::Prepared::Text.new prepared_index_path
     end
+    # Since the options hash might contain options that do not exist,
+    # we should warn people if they use the wrong options.
+    # (Problem is that if the option is not found, then Picky will use the default)
+    #
+    # TODO Rewrite it such that this does not need to be maintained separately.
+    #
+    @@known_keys = [:indexing, :partial, :qualifier, :qualifiers, :ranging, :similarity, :source, :weight]
+    def warn_if_unknown options
+      warn <<-WARNING if options && (options.keys - @@known_keys).size > 0
+
+Warning: Category options #{options} for category #{name} contain an unknown option.
+         Working options are: #{@@known_keys}.
+WARNING
+    end
     def weights_from options
       Generators::Weights.from options[:weight], index_name, name
     end

data/lib/picky.rb

@@ -18,7 +18,7 @@ module Picky
 
   # External libraries.
   #
-  # TODO Remove active support.
+  # TODO Remove active support, as a goal.
   #
   require 'active_support/core_ext/logger'
   require 'active_support/core_ext/object/blank'

data/spec/lib/category_indexed_spec.rb

@@ -7,14 +7,14 @@ describe Picky::Category do
       source []
     end
     @partial_strategy    = stub :partial, :each_partial => nil, :use_exact_for_partial? => false
-    @weight_strategy    = stub :weights, :saved? => true
+    @weight_strategy     = stub :weights, :saved? => true, :weight_for => :some_weight
     @similarity_strategy = stub :similarity, :encode => nil, :prioritize => nil
 
     @exact   = stub :exact, :dump => nil
     @partial = stub :partial, :dump => nil
 
     @category = described_class.new :some_name, @index, :partial    => @partial_strategy,
-                                                        :weights    => @weight_strategy,
+                                                        :weight     => @weight_strategy,
                                                         :similarity => @similarity_strategy,
                                                         :qualifiers => [:q, :qualifier]
 

data/spec/lib/category_spec.rb

@@ -45,6 +45,24 @@ describe Picky::Category do
       category.prepared_index_path.should == 'spec/temp/index/test/some_index/some_category'
     end
   end
+  
+  describe 'options' do
+    let(:category) { described_class.new :some_category, index }
+    it 'warns on wrong options' do
+      category.should_receive(:warn).once.with <<-WARNING
+
+Warning: Category options {:weights=>:some_weight} for category some_category contain an unknown option.
+         Working options are: [:indexing, :partial, :qualifier, :qualifiers, :ranging, :similarity, :source, :weight].
+WARNING
+      
+      category.warn_if_unknown :weights => :some_weight
+    end
+    it 'does not warn on right options' do
+      category.should_receive(:warn).never
+      
+      category.warn_if_unknown :weight => :some_weight
+    end
+  end
 
   context 'tokenizer' do
     context 'options hash' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: picky
 version: !ruby/object:Gem::Version
-  version: 4.12.13
+  version: 4.13.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-08 00:00:00.000000000 Z
+date: 2013-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.12.13
+        version: 4.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.12.13
+        version: 4.13.0
 - !ruby/object:Gem::Dependency
   name: text
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +128,6 @@ files:
 - lib/picky/backends/file/json.rb
 - lib/picky/backends/file.rb
 - lib/picky/backends/helpers/file.rb
-- lib/picky/backends/internal.rb
 - lib/picky/backends/memory/basic.rb
 - lib/picky/backends/memory/json.rb
 - lib/picky/backends/memory/marshal.rb

data/lib/picky/backends/internal.rb

@@ -1,23 +0,0 @@
-module Picky
-
-  module Backends
-
-    module Internal
-
-      # Nothing needs to be deleted from it.
-      #
-      def delete _
-
-      end
-
-      # It does not need to be cleared.
-      #
-      def clear
-
-      end
-
-    end
-
-  end
-
-end