picky 4.0.0pre2 → 4.0.0pre3

data/aux/picky/cli.rb

@@ -104,7 +104,7 @@ module Picky
 
     # Maps commands to the other gem's command.
     #
-    # TODO Try to load the other gems and get the commands dynamically.
+    # THINK Try to load the other gems and get the commands dynamically.
     #
     @@mapping = {
       :generate => [Generate, :'{client,server,all_in_one}', :'app_directory_name'],

data/lib/picky/backends/backend.rb

@@ -6,22 +6,6 @@ module Picky
     #
     class Backend
 
-      attr_reader :inverted,
-                  :weights,
-                  :similarity,
-                  :configuration
-
-      def initialize options = {}
-        @inverted      = options[:inverted]
-        @weights       = options[:weights]
-        @similarity    = options[:similarity]
-        @configuration = options[:configuration]
-      end
-
-      def extract_lambda_or thing, *args
-        thing && (thing.respond_to?(:call) && thing.call(*args) || thing)
-      end
-
       # Returns the total score of the combinations.
       #
       # Default implementation. Override to speed up.

data/lib/picky/backends/file.rb

@@ -14,36 +14,31 @@ module Picky
       #   [:token] # => [id, id, id, id, id] (an array of ids)
       #
       def create_inverted bundle
-        extract_lambda_or(inverted, bundle) ||
-          JSON.new(bundle.index_path(:inverted))
+        JSON.new bundle.index_path(:inverted)
       end
       # Returns an object that on #initial, #load returns an object that responds to:
       #   [:token] # => 1.23 (a weight)
       #
       def create_weights bundle
-        extract_lambda_or(weights, bundle) ||
-          JSON.new(bundle.index_path(:weights))
+        JSON.new bundle.index_path(:weights)
       end
       # Returns an object that on #initial, #load returns an object that responds to:
       #   [:encoded] # => [:original, :original] (an array of original symbols this similarity encoded thing maps to)
       #
       def create_similarity bundle
-        extract_lambda_or(similarity, bundle) ||
-          JSON.new(bundle.index_path(:similarity))
+        JSON.new bundle.index_path(:similarity)
       end
       # Returns an object that on #initial, #load returns an object that responds to:
       #   [:key] # => value (a value for this config key)
       #
       def create_configuration bundle
-        extract_lambda_or(configuration, bundle) ||
-          JSON.new(bundle.index_path(:configuration))
+        JSON.new bundle.index_path(:configuration)
       end
       # Returns an object that on #initial, #load returns an object that responds to:
       #   [id] # => [:sym1, :sym2]
       #
       def create_realtime bundle
-        extract_lambda_or(similarity, bundle) ||
-          JSON.new(bundle.index_path(:realtime))
+        JSON.new bundle.index_path(:realtime)
       end
 
     end

data/lib/picky/backends/memory.rb

@@ -9,40 +9,35 @@ module Picky
       #   [:token] # => [id, id, id, id, id] (an array of ids)
       #
       def create_inverted bundle
-        extract_lambda_or(inverted, bundle) ||
-          JSON.new(bundle.index_path(:inverted))
+        JSON.new bundle.index_path(:inverted)
       end
       # Returns an object that on #initial, #load returns
       # an object that responds to:
       #   [:token] # => 1.23 (a weight)
       #
       def create_weights bundle
-        extract_lambda_or(weights, bundle) ||
-          JSON.new(bundle.index_path(:weights))
+        JSON.new bundle.index_path(:weights)
       end
       # Returns an object that on #initial, #load returns
       # an object that responds to:
       #   [:encoded] # => [:original, :original] (an array of original symbols this similarity encoded thing maps to)
       #
       def create_similarity bundle
-        extract_lambda_or(similarity, bundle) ||
-          Marshal.new(bundle.index_path(:similarity))
+        Marshal.new bundle.index_path(:similarity)
       end
       # Returns an object that on #initial, #load returns
       # an object that responds to:
       #   [:key] # => value (a value for this config key)
       #
       def create_configuration bundle
-        extract_lambda_or(configuration, bundle) ||
-          JSON.new(bundle.index_path(:configuration))
+        JSON.new bundle.index_path(:configuration)
       end
       # Returns an object that on #initial, #load returns
       # an object that responds to:
       #   [id] # => [:sym1, :sym2]
       #
       def create_realtime bundle
-        extract_lambda_or(similarity, bundle) ||
-          JSON.new(bundle.index_path(:realtime))
+        JSON.new bundle.index_path(:realtime)
       end
 
     end

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

@@ -24,14 +24,14 @@ module Picky
 
           @empty     = options[:empty]
           @initial   = options[:initial]
-          @immediate = options[:immediate]
+          @realtime = options[:realtime]
         end
 
         # The empty index that is used for putting the index
         # together.
         #
         def empty
-          @empty && @empty.clone || (@immediate ? self.reset : {})
+          @empty && @empty.clone || (@realtime ? self.reset : {})
         end
 
         # The initial content before loading.
@@ -40,7 +40,7 @@ module Picky
         #       this just returns the same thing as #load.
         #
         def initial
-          @initial && @initial.clone || (@immediate ? self.reset : {})
+          @initial && @initial.clone || (@realtime ? self.reset : {})
         end
 
         # Returns itself.

data/lib/picky/backends/redis/list.rb

@@ -27,7 +27,7 @@ module Picky
         # Writes the hash into Redis.
         #
         def dump hash
-          unless @immediate
+          unless @realtime
             clear
             # client.pipelined do
               hash.each_pair do |key, values|
@@ -54,9 +54,9 @@ module Picky
 
         # Set a single list.
         #
-        # TODO Clear? Maybe only add the difference?
-        #
         def []= key, values
+          delete key
+
           redis_key = "#{namespace}:#{key}"
           i = 0
           values.each do |value|
@@ -64,9 +64,8 @@ module Picky
             client.zadd redis_key, i, value
           end
 
-          # We need to return the whole list.
-          #
-          self[key]
+          DirectlyManipulable.make self, values, key
+          values
         end
 
       end

data/lib/picky/backends/redis/string.rb

@@ -23,7 +23,7 @@ module Picky
         # Note: We could use multi, but it did not help.
         #
         def dump hash
-          unless @immediate
+          unless @realtime
             clear
             hash.each_pair do |key, value|
               client.hset namespace, key, value

data/lib/picky/backends/redis.rb

@@ -7,17 +7,15 @@ module Picky
     class Redis < Backend
 
       attr_reader :client,
-                  :immediate
+                  :realtime
 
       def initialize options = {}
-        super options
-
         maybe_load_hiredis
         check_hiredis_gem
         check_redis_gem
 
         @client    = options[:client] || ::Redis.new(:db => (options[:db] || 15))
-        @immediate = options[:immediate]
+        @realtime = options[:realtime]
       end
       def maybe_load_hiredis
         require 'hiredis'
@@ -39,36 +37,31 @@ module Picky
       #   [:token] # => [id, id, id, id, id] (an array of ids)
       #
       def create_inverted bundle
-        extract_lambda_or(inverted, bundle, client) ||
-          List.new(client, "#{PICKY_ENVIRONMENT}:#{bundle.identifier}:inverted", immediate: immediate)
+        List.new client, "#{PICKY_ENVIRONMENT}:#{bundle.identifier}:inverted", realtime: realtime
       end
       # Returns an object that on #initial, #load returns an object that responds to:
       #   [:token] # => 1.23 (a weight)
       #
       def create_weights bundle
-        extract_lambda_or(weights, bundle, client) ||
-          Float.new(client, "#{PICKY_ENVIRONMENT}:#{bundle.identifier}:weights", immediate: immediate)
+        Float.new client, "#{PICKY_ENVIRONMENT}:#{bundle.identifier}:weights", realtime: realtime
       end
       # Returns an object that on #initial, #load returns an object that responds to:
       #   [:encoded] # => [:original, :original] (an array of original symbols this similarity encoded thing maps to)
       #
       def create_similarity bundle
-        extract_lambda_or(similarity, bundle, client) ||
-          List.new(client, "#{PICKY_ENVIRONMENT}:#{bundle.identifier}:similarity", immediate: immediate)
+        List.new client, "#{PICKY_ENVIRONMENT}:#{bundle.identifier}:similarity", realtime: realtime
       end
       # Returns an object that on #initial, #load returns an object that responds to:
       #   [:key] # => value (a value for this config key)
       #
       def create_configuration bundle
-        extract_lambda_or(configuration, bundle, client) ||
-          String.new(client, "#{PICKY_ENVIRONMENT}:#{bundle.identifier}:configuration", immediate: immediate)
+        String.new client, "#{PICKY_ENVIRONMENT}:#{bundle.identifier}:configuration", realtime: realtime
       end
       # Returns an object that on #initial, #load returns an object that responds to:
       #   [id] # => [:sym1, :sym2]
       #
       def create_realtime bundle
-        extract_lambda_or(similarity, bundle) ||
-          List.new(client, "#{bundle.identifier}:realtime", immediate: immediate)
+        List.new client, "#{bundle.identifier}:realtime", realtime: realtime
       end
 
       # Does the Redis version already include
@@ -162,12 +155,12 @@ module Picky
       # Note: We use the amount and offset hints to speed Redis up.
       #
       def ids combinations, amount, offset
-        # TODO FIXME This is actually not correct:
-        #            A dumped/loaded Redis backend should use
-        #            the Redis backend calculation method.
-        #            So loaded? would be more appropriate.
+        # TODO This is actually not correct:
+        #      A dumped/loaded Redis backend should use
+        #      the Redis backend calculation method.
+        #      So loaded? would be more appropriate.
         #
-        if immediate
+        if realtime
           # Just checked once on the first call.
           #
           if redis_with_scripting?
@@ -187,12 +180,18 @@ module Picky
                 # Assume it's using EVALSHA.
                 #
                 begin
-                  client.evalsha @@ids_sent_once,
-                                 identifiers.size,
-                                 *identifiers,
-                                 generate_intermediate_result_id,
-                                 offset,
-                                 (offset + amount)
+                  if identifiers.size > 1
+                    client.evalsha @@ids_sent_once,
+                                   identifiers.size,
+                                   *identifiers,
+                                   generate_intermediate_result_id,
+                                   offset,
+                                   (offset + amount)
+                  else
+                    client.zrange identifiers.first,
+                                  offset,
+                                  (offset + amount)
+                  end
                 rescue RuntimeError => e
                   # Make the server have a SHA-1 for the script.
                   #
@@ -219,8 +218,6 @@ module Picky
 
                 # Little optimization.
                 #
-                # TODO Include in the scripting version as well.
-                #
                 if identifiers.size > 1
                   # Intersect and store.
                   #

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

@@ -14,21 +14,21 @@ module Picky
           @cache_path   = "#{cache_path}.sqlite3"
           @empty        = options[:empty]
           @initial      = options[:initial]
-          @self_indexed = options[:self_indexed]
+          @realtime = options[:realtime]
 
           lazily_initialize_client
         end
 
         def initial
-          @initial && @initial.clone || (@self_indexed ? self.reset : {})
+          @initial && @initial.clone || (@realtime ? self.reset : {})
         end
 
         def empty
-          @empty && @empty.clone || (@self_indexed ? self.reset.asynchronous : {})
+          @empty && @empty.clone || (@realtime ? self.reset.asynchronous : {})
         end
 
         def dump internal
-          dump_sqlite internal unless @self_indexed
+          dump_sqlite internal unless @realtime
           self
         end
 

data/lib/picky/backends/sqlite.rb

@@ -4,11 +4,10 @@ module Picky
 
     class SQLite < Backend
 
-      attr_reader :self_indexed
+      attr_reader :realtime
 
       def initialize options = {}
-        super options
-        @self_indexed = options[:self_indexed]
+        @realtime = options[:realtime]
 
         require 'sqlite3'
       rescue LoadError => e
@@ -19,36 +18,31 @@ module Picky
       #   [:token] # => [id, id, id, id, id] (an array of ids)
       #
       def create_inverted bundle
-        extract_lambda_or(inverted, bundle) ||
-          StringKeyArray.new(bundle.index_path(:inverted), self_indexed: self_indexed)
+        StringKeyArray.new bundle.index_path(:inverted), realtime: realtime
       end
       # Returns an object that on #initial, #load returns an object that responds to:
       #   [:token] # => 1.23 (a weight)
       #
       def create_weights bundle
-        extract_lambda_or(weights, bundle) ||
-          Value.new(bundle.index_path(:weights), self_indexed: self_indexed)
+        Value.new bundle.index_path(:weights), realtime: realtime
       end
       # Returns an object that on #initial, #load returns an object that responds to:
       #   [:encoded] # => [:original, :original] (an array of original symbols this similarity encoded thing maps to)
       #
       def create_similarity bundle
-        extract_lambda_or(similarity, bundle) ||
-          StringKeyArray.new(bundle.index_path(:similarity), self_indexed: self_indexed)
+        StringKeyArray.new bundle.index_path(:similarity), realtime: realtime
       end
       # Returns an object that on #initial, #load returns an object that responds to:
       #   [:key] # => value (a value for this config key)
       #
       def create_configuration bundle
-        extract_lambda_or(configuration, bundle) ||
-          Value.new(bundle.index_path(:configuration), self_indexed: self_indexed)
+        Value.new bundle.index_path(:configuration), realtime: realtime
       end
       # Returns an object that on #initial, #load returns an object that responds to:
       #   [id] # => [:sym1, :sym2]
       #
       def create_realtime bundle
-        extract_lambda_or(similarity, bundle) ||
-          IntegerKeyArray.new(bundle.index_path(:realtime), self_indexed: self_indexed)
+        IntegerKeyArray.new bundle.index_path(:realtime), realtime: realtime
       end
 
     end

data/lib/picky/bundle.rb

@@ -35,19 +35,20 @@ module Picky
                   :backend_weights,
                   :backend_similarity,
                   :backend_configuration,
+                  :backend_realtime,
 
-                  :weights_strategy,
+                  :weight_strategy,
                   :partial_strategy,
                   :similarity_strategy
 
     delegate :[], :[]=,        :to => :configuration
     delegate :index_directory, :to => :category
 
-    def initialize name, category, weights_strategy, partial_strategy, similarity_strategy, options = {}
+    def initialize name, category, weight_strategy, partial_strategy, similarity_strategy, options = {}
       @name     = name
       @category = category
 
-      @weights_strategy    = weights_strategy
+      @weight_strategy     = weight_strategy
       @partial_strategy    = partial_strategy
       @similarity_strategy = similarity_strategy
 
@@ -70,21 +71,31 @@ module Picky
     # Initializes all necessary indexes from the backend.
     #
     def reset_backend
-      # Extract specific indexes from backend.
-      #
-      @backend_inverted      = backend.create_inverted      self
-      @backend_weights       = backend.create_weights       self
-      @backend_similarity    = backend.create_similarity    self
+      create_backends
+      initialize_backends
+    end
+
+    # Extract specific indexes from backend.
+    #
+    def create_backends
+      @backend_inverted      = backend.create_inverted self
+      @backend_weights       = backend.create_weights self
+      @backend_similarity    = backend.create_similarity self
       @backend_configuration = backend.create_configuration self
-      @backend_realtime      = backend.create_realtime      self
+      @backend_realtime      = backend.create_realtime self
+    end
 
-      # Initial indexes.
-      #
-      # Note that if the weights strategy doesn't need to be saved,
-      # the strategy itself pretends to be an index.
-      #
+    # Initial indexes.
+    #
+    # Note that if the weights strategy doesn't need to be saved,
+    # the strategy itself pretends to be an index.
+    #
+    def initialize_backends
+      # @inverted, @weights, @similarity, @configuration, @realtime = backend.initial weight_strategy
       @inverted      = @backend_inverted.initial
-      @weights       = @weights_strategy.saved?? @backend_weights.initial : @weights_strategy
+      # TODO @weights = @weight_strategy.initial || @backend_weights.initial
+      #
+      @weights       = @weight_strategy.saved?? @backend_weights.initial : @weight_strategy
       @similarity    = @backend_similarity.initial
       @configuration = @backend_configuration.initial
       @realtime      = @backend_realtime.initial
@@ -94,30 +105,27 @@ module Picky
     # internal backend instance.
     #
     def empty
-      empty_inverted
-      empty_weights
-      empty_similarity
-      empty_configuration
-      empty_realtime
-    end
-    def empty_inverted
       @inverted = @backend_inverted.empty
-    end
-    def empty_weights
       # THINK about this. Perhaps the strategies should implement the backend methods?
       #
-      @weights = @weights_strategy.saved?? @backend_weights.empty : @weights_strategy
-    end
-    def empty_similarity
+      @weights = @weight_strategy.saved? ? @backend_weights.empty : @weight_strategy
       @similarity = @backend_similarity.empty
-    end
-    def empty_configuration
       @configuration = @backend_configuration.empty
-    end
-    def empty_realtime
       @realtime = @backend_realtime.empty
     end
 
+    # Delete all index files.
+    #
+    def delete
+      @backend_inverted.delete       if @backend_inverted.respond_to? :delete
+      # THINK about this. Perhaps the strategies should implement the backend methods?
+      #
+      @backend_weights.delete        if @backend_weights.respond_to?(:delete) && @weight_strategy.saved?
+      @backend_similarity.delete     if @backend_similarity.respond_to? :delete
+      @backend_configuration.delete  if @backend_configuration.respond_to? :delete
+      @backend_realtime.delete  if @backend_realtime.respond_to? :delete
+    end
+
     # Get a list of similar texts.
     #
     # Note: Does not return itself.
@@ -156,18 +164,6 @@ module Picky
       ::File.join index_directory, "#{category.name}_#{name}#{ "_#{type}" if type }"
     end
 
-    # Delete all index files.
-    #
-    def delete
-      @backend_inverted.delete       if @backend_inverted.respond_to? :delete
-      # THINK about this. Perhaps the strategies should implement the backend methods?
-      #
-      @backend_weights.delete        if @backend_weights.respond_to?(:delete) && @weights_strategy.saved?
-      @backend_similarity.delete     if @backend_similarity.respond_to? :delete
-      @backend_configuration.delete  if @backend_configuration.respond_to? :delete
-      @backend_realtime.delete  if @backend_realtime.respond_to? :delete
-    end
-
     def to_s
       "#{self.class}(#{identifier})"
     end

data/lib/picky/bundle_indexed.rb

@@ -25,6 +25,21 @@ module Picky
     #
     def ids sym_or_string
       @inverted[sym_or_string] || []
+      # TODO ?
+      #
+      # if @key_format
+      #   class << self
+      #     def ids
+      #       (@inverted[sym_or_string] || []).map &@key_format
+      #     end
+      #   end
+      # else
+      #   class << self
+      #     def ids
+      #       @inverted[sym_or_string] || []
+      #     end
+      #   end
+      # end
     end
 
     # Get a weight for the given symbol.
@@ -64,9 +79,9 @@ module Picky
     # Loads the weights index.
     #
     def load_weights
-      # THINK about this. Perhaps the strategies should implement the backend methods?
+      # TODO @weights = @weight_strategy.load || @backend_weights.load
       #
-      self.weights = @backend_weights.load if @weights_strategy.saved?
+      self.weights = @backend_weights.load if @weight_strategy.saved?
     end
     # Loads the similarity index.
     #

data/lib/picky/bundle_indexing.rb

@@ -31,37 +31,12 @@ module Picky
     # Saves the indexes in a dump file.
     #
     def dump
-      dump_inverted
-      dump_similarity
-      dump_weights
-      dump_configuration
-      dump_realtime
-    end
-    # Dumps the core index.
-    #
-    def dump_inverted
       @backend_inverted.dump @inverted
-    end
-    # Dumps the weights index.
-    #
-    def dump_weights
       # THINK about this. Perhaps the strategies should implement the backend methods? Or only the internal index ones?
       #
-      @backend_weights.dump @weights if @weights_strategy.saved?
-    end
-    # Dumps the similarity index.
-    #
-    def dump_similarity
+      @backend_weights.dump @weights if @weight_strategy.saved?
       @backend_similarity.dump @similarity if @similarity_strategy.saved?
-    end
-    # Dumps the configuration.
-    #
-    def dump_configuration
       @backend_configuration.dump @configuration
-    end
-    # Dumps the realtime.
-    #
-    def dump_realtime
       @backend_realtime.dump @realtime
     end
 

data/lib/picky/bundle_realtime.rb

@@ -24,7 +24,7 @@ module Picky
           #
           @similarity.delete self.similarity_strategy.encoded(str_or_sym)
         else
-          @weights[str_or_sym] = self.weights_strategy.weight_for ids.size
+          @weights[str_or_sym] = self.weight_strategy.weight_for ids.size
         end
       end
 
@@ -53,7 +53,7 @@ module Picky
 
       # Weights.
       #
-      @weights[str_or_sym] = self.weights_strategy.weight_for ids.size
+      @weights[str_or_sym] = self.weight_strategy.weight_for ids.size
 
       # Similarity.
       #
@@ -74,10 +74,6 @@ module Picky
         #
         similars.delete str_or_sym if similars.include? str_or_sym
         similars << str_or_sym
-
-        # Uses the sort order of the strategy.
-        #
-        self.similarity_strategy.sort similars, str_or_sym
       end
     end
 

data/lib/picky/category_indexing.rb

@@ -31,7 +31,7 @@ module Picky
       with_data_snapshot do
         scheduler.schedule do
           indexer.prepare categories, scheduler
-          nil # TODO Needed so procrastinate is happy. Remove in 4.0.
+          nil # Note: Needed so procrastinate is happy.
         end
       end
     end
@@ -43,7 +43,7 @@ module Picky
         empty
         retrieve
         dump
-        nil # TODO Needed so procrastinate is happy. Remove in 4.0.
+        nil # Note: Needed so procrastinate is happy.
       end
     end
 

data/lib/picky/generators/similarity/phonetic.rb

@@ -36,7 +36,9 @@ module Picky
 
         # Sorts the index values in place.
         #
-        def sort ary, code
+        # Not used currently.
+        #
+        def prioritize! ary, code
           ary.sort_by_levenshtein! code
           ary.slice! amount, ary.size # THINK size is not perfectly correct, but anyway
         end

data/lib/picky/index_indexing.rb

@@ -105,7 +105,7 @@ module Picky
     # capsule, i.e. a block/lambda.
     #
     def extract_source
-      @source = @source.respond_to?(:call) ? @source.call : @source
+      @source.respond_to?(:call) ? @source.call : @source
     end
     def check_source source # :nodoc:
       raise ArgumentError.new(<<-SOURCE