picky 3.1.2 → 3.1.3

data/lib/picky/backends/file/basic.rb

@@ -13,6 +13,8 @@ module Picky
       #
       class Basic
 
+        include Helpers::File
+
         attr_reader :cache_path,  # This index file's location.
                     :mapping_file # The index file's mapping file (loaded into memory for quick access).
 
@@ -34,6 +36,50 @@ module Picky
           :index
         end
 
+        # Will copy the index file to a location that
+        # is in a directory named "backup" right under
+        # the directory the index file is in.
+        #
+        def backup
+          mapping_file.backup
+
+          prepare_backup backup_directory(cache_path)
+          FileUtils.cp cache_path, target, verbose: true
+        end
+
+        # Copies the file from its backup location back
+        # to the original location.
+        #
+        def restore
+          mapping_file.restore
+
+          FileUtils.cp backup_file_path_of(cache_path), cache_path, verbose: true
+        end
+
+        # Deletes the file.
+        #
+        def delete
+          mapping_file.delete
+
+          `rm -Rf #{cache_path}`
+        end
+
+        # Is this cache file suspiciously small?
+        # (less than 8 Bytes of size)
+        #
+        def cache_small?
+          size_of(cache_path) < 8
+        end
+
+        # Is the cache ok? (existing and larger than
+        # zero Bytes in size)
+        #
+        # A small cache is still ok.
+        #
+        def cache_ok?
+          size_of(cache_path) > 0
+        end
+
       end
 
     end

data/lib/picky/backends/helpers/file.rb

@@ -0,0 +1,43 @@
+module Picky
+
+  module Backends
+
+    module Helpers
+
+      # Common file helpers.
+      #
+      module File
+
+        # The backup directory of this file.
+        # Equal to the file's dirname plus /backup
+        #
+        def backup_directory path
+          ::File.join ::File.dirname(path), 'backup'
+        end
+
+        # Prepares the backup directory for the file.
+        #
+        def prepare_backup target
+          FileUtils.mkdir target unless Dir.exists?(target)
+        end
+
+        # The backup filename.
+        #
+        def backup_file_path_of path
+          dir, name = ::File.split path
+          ::File.join dir, 'backup', name
+        end
+
+        # Extracts the size of the file in Bytes.
+        #
+        def size_of path
+          `ls -l #{path} | awk '{print $5}'`.to_i
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/picky/backends/memory/basic.rb

@@ -13,6 +13,8 @@ module Picky
       #
       class Basic
 
+        include Helpers::File
+
         # This file's location.
         #
         attr_reader :cache_path
@@ -39,20 +41,6 @@ module Picky
           FileUtils.cp cache_path, target, verbose: true
         end
 
-        # The backup directory of this file.
-        # Equal to the file's dirname plus /backup
-        #
-
-        def backup_directory
-          ::File.join ::File.dirname(cache_path), 'backup'
-        end
-
-        # Prepares the backup directory for the file.
-        #
-        def prepare_backup target
-          FileUtils.mkdir target unless Dir.exists?(target)
-        end
-
         # Copies the file from its backup location back
         # to the original location.
         #
@@ -60,13 +48,6 @@ module Picky
           FileUtils.cp backup_file_path_of(cache_path), cache_path, verbose: true
         end
 
-        # The backup filename.
-        #
-        def backup_file_path_of path
-          dir, name = ::File.split path
-          ::File.join dir, 'backup', name
-        end
-
         # Deletes the file.
         #
         def delete
@@ -82,6 +63,7 @@ module Picky
         def cache_small?
           size_of(cache_path) < 8
         end
+
         # Is the cache ok? (existing and larger than
         # zero Bytes in size)
         #
@@ -90,11 +72,6 @@ module Picky
         def cache_ok?
           size_of(cache_path) > 0
         end
-        # Extracts the size of the file in Bytes.
-        #
-        def size_of path
-          `ls -l #{path} | awk '{print $5}'`.to_i
-        end
 
         #
         #

data/lib/picky/loader.rb

@@ -111,6 +111,7 @@ module Picky
 
       # Index store handling.
       #
+      load_relative 'backends/helpers/file'
       load_relative 'backends/backend'
 
       load_relative 'backends/redis'

data/lib/picky/query/allocation.rb

@@ -52,13 +52,8 @@ module Picky
 
       #
       #
-      def keep identifiers = [] # categories
-        @combinations.keep identifiers
-      end
-      #
-      #
-      def remove identifiers = [] # categories
-        @combinations.remove identifiers
+      def remove categories = []
+        @combinations.remove categories
       end
 
       # Sort highest score first.

data/lib/picky/query/allocations.rb

@@ -38,19 +38,12 @@ module Picky
         @allocations = @allocations.shift amount
       end
 
-      # Keeps combinations.
-      #
-      # Only those passed in remain.
-      #
-      def keep identifiers = []
-        @allocations.each { |allocation| allocation.keep identifiers } unless identifiers.empty?
-      end
       # Removes combinations.
       #
       # Only those passed in are removed.
       #
-      def remove identifiers = []
-        @allocations.each { |allocation| allocation.remove identifiers } unless identifiers.empty?
+      def remove categories = []
+        @allocations.each { |allocation| allocation.remove categories } unless categories.empty?
       end
 
       # Returns the top amount ids.

data/lib/picky/query/combination.rb

@@ -61,12 +61,6 @@ module Picky
         "#{bundle.identifier}:#{token.identifier}"
       end
 
-      # Is the identifier in the given identifiers?
-      #
-      def in? identifiers
-        identifiers.include? identifier
-      end
-
       # Note: Required for uniq!
       #
       def hash

data/lib/picky/query/combinations.rb

@@ -37,26 +37,15 @@ module Picky
         weights.score_for @combinations
       end
 
-      # Filters the tokens and identifiers such that only identifiers
-      # that are passed in, remain, including their tokens.
+      # Filters the tokens and categories such that categories
+      # that are passed in, are removed.
       #
       # Note: This method is not totally independent of the calculate_ids one.
       #       Since identifiers are only nullified, we need to not include the
       #       ids that have an associated identifier that is nil.
       #
-      def keep identifiers = []
-        @combinations.reject! { |combination| !combination.in?(identifiers) }
-      end
-
-      # Filters the tokens and identifiers such that identifiers
-      # that are passed in, are removed, including their tokens.
-      #
-      # Note: This method is not totally independent of the calculate_ids one.
-      #       Since identifiers are only nullified, we need to not include the
-      #       ids that have an associated identifier that is nil.
-      #
-      def remove identifiers = []
-        @combinations.reject! { |combination| combination.in?(identifiers) }
+      def remove categories = []
+        @combinations.reject! { |combination| categories.include?(combination.category) }
       end
 
       #

data/lib/picky/query/indexes.rb

@@ -13,7 +13,8 @@ module Picky
     #
     class Indexes
 
-      attr_reader :indexes
+      attr_reader :indexes,
+                  :ignored_categories
 
       # Creates a new Query::Indexes.
       #
@@ -24,10 +25,11 @@ module Picky
         IndexesCheck.check_backend_types indexes
 
         @indexes = indexes
-        @mapper  = Query::QualifierCategoryMapper.new
+
         map_categories
       end
       def map_categories
+        @mapper = Query::QualifierCategoryMapper.new
         @indexes.each do |index|
           index.each_category do |category|
             @mapper.add category
@@ -35,6 +37,21 @@ module Picky
         end
       end
 
+      # Ignore the categories with these qualifiers.
+      #
+      # Example:
+      #   search = Search.new(index1, index2, index3) do
+      #     ignore :name, :first_name
+      #   end
+      #
+      # Cleans up / optimizes after being called.
+      #
+      def ignore *qualifiers
+        @ignored_categories ||= []
+        @ignored_categories += qualifiers.map { |qualifier| @mapper.map qualifier }.compact
+        @ignored_categories.uniq!
+      end
+
       # Returns a number of prepared (sorted, reduced etc.) allocations for the given tokens.
       #
       def prepared_allocations_for tokens, weights = {}
@@ -57,9 +74,9 @@ module Picky
         #
         # allocations.reduce_to some_amount
 
-        # Remove identifiers from allocations.
+        # Remove categories from allocations.
         #
-        # allocations.remove some_array_of_identifiers_to_remove
+        allocations.remove ignored_categories if ignored_categories
 
         allocations
       end

data/lib/picky/search.rb

@@ -21,11 +21,13 @@ module Picky
     attr_accessor :tokenizer,
                   :weights
 
+    delegate :ignore,
+             :to => :indexes
+
     # Takes:
     # * A number of indexes
     #
-    # TODO Add identifiers_to_remove (rename) and reduce_allocations_to_amount (rename).
-    # TODO categories_to_remove ?
+    # TODO Add reduce_allocations_to_amount (rename).
     #
     # It is also possible to define the tokenizer and weights like so.
     # Example:

data/spec/lib/application_spec.rb

@@ -73,6 +73,7 @@ describe Picky::Application do
           
           buks_search = Picky::Search.new(books_index) do
             searching removes_characters: /[buks]/
+            ignore    :author
           end
           route %r{^/buks} => buks_search
         end

data/spec/lib/backends/memory/basic_spec.rb

@@ -12,7 +12,7 @@ describe Picky::Backends::Memory::Basic do
   
   describe 'backup_directory' do
     it "returns the cache path's backup path" do
-      file.backup_directory.should == 'some/cache/path/to/backup'
+      file.backup_directory('some/cache/path/to/file').should == 'some/cache/path/to/backup'
     end
   end
   

data/spec/lib/query/allocation_spec.rb

@@ -43,17 +43,9 @@ describe Picky::Query::Allocation do
   
   describe 'remove' do
     it 'should delegate to the combinations' do
-      @combinations.should_receive(:remove).once.with [:some_identifiers]
+      @combinations.should_receive(:remove).once.with [:some_categories]
       
-      @allocation.remove [:some_identifiers]
-    end
-  end
-  
-  describe 'keep' do
-    it 'should delegate to the combinations' do
-      @combinations.should_receive(:keep).once.with [:some_identifiers]
-      
-      @allocation.keep [:some_identifiers]
+      @allocation.remove [:some_categories]
     end
   end
   

data/spec/lib/query/allocations_spec.rb

@@ -31,39 +31,13 @@ describe Picky::Query::Allocations do
         @allocations.remove
       end
     end
-    context 'identifiers not empty' do
+    context 'categories not empty' do
       it 'should remove each' do
-        @allocation1.should_receive(:remove).once.with :some_identifier
-        @allocation2.should_receive(:remove).once.with :some_identifier
-        @allocation3.should_receive(:remove).once.with :some_identifier
+        @allocation1.should_receive(:remove).once.with :some_category
+        @allocation2.should_receive(:remove).once.with :some_category
+        @allocation3.should_receive(:remove).once.with :some_category
 
-        @allocations.remove :some_identifier
-      end
-    end
-  end
-
-  describe 'keep' do
-    before(:each) do
-      @allocation1 = stub :allocation1
-      @allocation2 = stub :allocation2
-      @allocation3 = stub :allocation3
-      @allocations = described_class.new [@allocation1, @allocation2, @allocation3]
-    end
-    context 'identifiers empty' do
-      it 'should do nothing' do
-        @allocation1.should_receive(:keep).never
-        @allocation2.should_receive(:keep).never
-
-        @allocations.keep
-      end
-    end
-    context 'identifiers not empty' do
-      it 'should filter each' do
-        @allocation1.should_receive(:keep).once.with :some_identifier
-        @allocation2.should_receive(:keep).once.with :some_identifier
-        @allocation3.should_receive(:keep).once.with :some_identifier
-
-        @allocations.keep :some_identifier
+        @allocations.remove :some_category
       end
     end
   end

data/spec/lib/query/combination_spec.rb

@@ -26,18 +26,6 @@ describe Picky::Query::Combination do
     end
   end
 
-  describe 'in?' do
-    before(:each) do
-      @combination.stub! :identifier => :some_identifier
-    end
-    it 'should check if the given identifiers include the identifier' do
-      @combination.in?([:some_other_identifier, :some_identifier, :some_other_identifier]).should == true
-    end
-    it 'should check if the given identifiers include the identifier' do
-      @combination.in?([:some_other_identifier, :some_other_identifier]).should == false
-    end
-  end
-
   describe 'to_result' do
     context 'functional with qualifier' do
       before(:each) do

data/spec/lib/query/combinations_spec.rb

@@ -80,27 +80,14 @@ describe Picky::Query::Combinations do
   
   describe 'remove' do
     before(:each) do
-      @combination1 = stub :combination1, :in? => false
-      @combination2 = stub :combination2, :in? => true
-      @combination3 = stub :combination3, :in? => true
+      @combination1 = stub :combination1, :category => :other
+      @combination2 = stub :combination2, :category => :to_remove
+      @combination3 = stub :combination3, :category => :to_remove
 
       @combinations = described_class.new [@combination1, @combination2, @combination3]
     end
     it 'should remove the combinations' do
-      @combinations.remove([:any]).should == [@combination1]
-    end
-  end
-
-  describe 'keep' do
-    before(:each) do
-      @combination1 = stub :combination1, :in? => false
-      @combination2 = stub :combination2, :in? => true
-      @combination3 = stub :combination3, :in? => true
-
-      @combinations = described_class.new [@combination1, @combination2, @combination3]
-    end
-    it 'should filter the combinations' do
-      @combinations.keep([:any]).should == [@combination2, @combination3]
+      @combinations.remove([:to_remove]).should == [@combination1]
     end
   end
 

metadata

@@ -2,7 +2,7 @@
 name: picky
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 3.1.2
+  version: 3.1.3
 platform: ruby
 authors: 
 - Florian Hanke
@@ -32,7 +32,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 3.1.2
+        version: 3.1.3
   type: :development
   version_requirements: *id002
 description: Fast Ruby semantic text search engine with comfortable single field interface.
@@ -55,6 +55,7 @@ files:
 - lib/picky/backends/file/basic.rb
 - lib/picky/backends/file/json.rb
 - lib/picky/backends/file.rb
+- lib/picky/backends/helpers/file.rb
 - lib/picky/backends/memory/basic.rb
 - lib/picky/backends/memory/json.rb
 - lib/picky/backends/memory/marshal.rb