picky 2.5.2 → 2.6.0

data/lib/picky/indexing/indexes.rb

@@ -1,87 +0,0 @@
-module Indexing # :nodoc:all
-
-  # Registers the indexes held at index time, for indexing.
-  #
-  class Indexes
-
-    attr_reader :indexes
-
-    each_delegate :take_snapshot,
-                  :generate_caches,
-                  :backup_caches,
-                  :restore_caches,
-                  :check_caches,
-                  :clear_caches,
-                  :create_directory_structure,
-                  :to => :indexes
-
-    def initialize
-      clear
-    end
-
-    def to_s
-      indexes.indented_to_s
-    end
-
-    # Clears the array of indexes.
-    #
-    def clear
-      @indexes = []
-    end
-
-    # Registers an index with the indexes.
-    #
-    def register index
-      self.indexes << index
-    end
-
-    # Runs the indexers in parallel (index + cache).
-    #
-    def index randomly = true
-      take_snapshot
-
-      # Run in parallel.
-      #
-      timed_exclaim "Indexing using #{Cores.max_processors} processors, in #{randomly ? 'random' : 'given'} order."
-
-      # Run indexing/caching forked.
-      #
-      Cores.forked self.indexes, { randomly: randomly } do |an_index|
-        an_index.index!
-        an_index.cache!
-      end
-
-      timed_exclaim "Indexing finished."
-    end
-
-    # For integration testing – indexes for the tests
-    # without forking and shouting ;)
-    #
-    def index_for_tests
-      take_snapshot
-
-      self.indexes.each do |an_index|
-        an_index.index!
-        an_index.cache!
-      end
-    end
-
-    # Find a given index:category pair.
-    #
-    def find index_name, category_name = nil
-      index_name = index_name.to_sym
-
-      indexes.each do |index|
-        next unless index.name == index_name
-
-        return index unless category_name
-
-        found = index.find category_name
-        return found if found
-      end
-
-      raise %Q{Index "#{index_name}" not found. Possible indexes: "#{indexes.map(&:name).join('", "')}".}
-    end
-
-  end
-end

data/lib/picky/internals/adapters/rack/base.rb

@@ -1,27 +0,0 @@
-module Internals
-
-  module Adapters
-    # Adapter that is plugged into a Rack outlet.
-    #
-    module Rack
-    
-      # Subclasses of this class should respond to
-      # * to_app(options)
-      #
-      class Base
-      
-        # Puts together an appropriately structured Rack response.
-        #
-        # Note: Bytesize is needed to have special characters not trip up Rack.
-        #
-        def respond_with response, content_type = 'application/json'
-          [200, { 'Content-Type' => content_type, 'Content-Length' => response.bytesize.to_s }, [response]]
-        end
-      
-      end
-    
-    end
-  
-  end
-  
-end

data/lib/picky/internals/adapters/rack/live_parameters.rb

@@ -1,37 +0,0 @@
-module Internals
-
-  module Adapters
-  
-    #
-    #
-    module Rack
-    
-      class LiveParameters < Base
-
-        def initialize live_parameters
-          @live_parameters = live_parameters
-        end
-      
-        #
-        #
-        def to_app options = {}
-          # For capturing by the lambda block.
-          #
-          live_parameters = @live_parameters
-        
-          lambda do |env|
-            params = ::Rack::Request.new(env).params
-          
-            results = live_parameters.parameters params
-          
-            respond_with results.to_json
-          end
-        end
-      
-      end
-    
-    end
-  
-  end
-  
-end

data/lib/picky/internals/adapters/rack/query.rb

@@ -1,69 +0,0 @@
-module Internals
-
-  module Adapters
-    # This is an adapter that is plugged into a Rack outlet.
-    #
-    # It looks at what is given to it and generate an appropriate
-    # adapter for it.
-    #
-    # For example, if you give it a query, it will extract the query param etc.
-    # and call search_with_text on it if it is called by Rack.
-    #
-    module Rack
-
-      # TODO Rename to Search.
-      #
-      class Query < Base
-
-        @@defaults = {
-          query_key:    'query'.freeze,
-          ids_key:      'ids'.freeze,
-          offset_key:   'offset'.freeze,
-          content_type: 'application/json'.freeze
-        }
-
-        def initialize query
-          @query    = query
-          @defaults = @@defaults.dup
-        end
-
-        def to_app options = {}
-          # For capturing in the lambda.
-          #
-          query        = @query
-          query_key    = options[:query_key]    || @defaults[:query_key]
-          content_type = options[:content_type] || @defaults[:content_type]
-
-          lambda do |env|
-            params  = ::Rack::Request.new(env).params
-
-            results = query.search_with_text *extracted(params)
-
-            PickyLog.log results.to_log(params[query_key])
-
-            respond_with results.to_response, content_type
-          end
-        end
-
-        # Helper method to extract the params
-        #
-        # Defaults are 20 ids, offset 0.
-        #
-        UTF8_STRING = 'UTF-8'.freeze
-        def extracted params
-          [
-            # query is encoded in ASCII
-            #
-            params[@defaults[:query_key]]  && params[@defaults[:query_key]].force_encoding(UTF8_STRING),
-            params[@defaults[:ids_key]]    && params[@defaults[:ids_key]].to_i || 20,
-            params[@defaults[:offset_key]] && params[@defaults[:offset_key]].to_i || 0
-          ]
-        end
-
-      end
-
-    end
-
-  end
-
-end

data/lib/picky/internals/adapters/rack.rb

@@ -1,34 +0,0 @@
-module Internals
-
-  module Adapters
-
-    # This is an adapter that is plugged into a Rack outlet.
-    #
-    # It looks at what is given to it and generate an appropriate
-    # adapter for it.
-    #
-    # For example, if you give it a query, it will extract the query param etc.
-    # and call search_with_text on it if it is called by Rack.
-    #
-    # Usage:
-    #   Adapters::Rack.app_for(thing, options)
-    #
-    module Rack
-    
-      # Generates the appropriate app for Rack.
-      #
-      @@mapping = {
-        :search_with_text => Query,
-        :parameters       => LiveParameters
-      }
-      def self.app_for thing, options = {}
-        @@mapping.each_pair do |method, adapter|
-          return adapter.new(thing).to_app(options) if thing.respond_to?(method)
-        end
-      end
-    
-    end
-  
-  end
-  
-end

data/lib/picky/internals/calculations/location.rb

@@ -1,59 +0,0 @@
-module Internals
-  module Calculations # :nodoc:all
-
-    # A location calculation recalculates a 1-d location
-    # to the Picky internal 1-d "grid".
-    #
-    # For example, if you have a location x == 12.3456,
-    # it will be recalculated into 3, if the minimum is 9
-    # and the gridlength is 1.
-    #
-    class Location
-
-      attr_reader :minimum, :precision, :grid
-
-      def initialize user_grid, precision = nil
-        @user_grid = user_grid
-        @precision = precision || 1
-        @grid      = @user_grid / (@precision + 0.5)
-      end
-
-      def minimum= minimum
-        # Add a margin of 1 user grid.
-        #
-        minimum -= @user_grid
-
-        # Add plus 1 grid so that the index key never falls on 0.
-        # Why? to_i maps by default to 0.
-        #
-        minimum -= @grid
-
-        @minimum = minimum
-      end
-
-      #
-      #
-      def add_margin length
-        @minimum -= length
-      end
-
-      #
-      #
-      def recalculated_range location
-        range recalculate(location)
-      end
-      #
-      #
-      def range around_location
-        (around_location - @precision)..(around_location + @precision)
-      end
-      #
-      #
-      def recalculate location
-        ((location - @minimum) / @grid).floor
-      end
-
-    end
-
-  end
-end

data/lib/picky/internals/frontend_adapters/rack.rb

@@ -1,150 +0,0 @@
-require 'rack/mount'
-
-module Internals
-
-  module FrontendAdapters
-
-    # TODO Rename to Routing again. Push everything back into appropriate Adapters.
-    #
-    class Rack # :nodoc:all
-
-      #
-      #
-      def reset_routes
-        @routes = ::Rack::Mount::RouteSet.new
-      end
-      def routes
-        @routes || reset_routes
-      end
-      def finalize
-        routes.freeze
-      end
-
-      # Routing simply delegates to the route set to handle a request.
-      #
-      def call env
-        routes.call env
-      end
-
-      # API method.
-      #
-      def route options = {}
-        mappings, route_options = split options
-        mappings.each do |url, query|
-          route_one url, query, route_options
-        end
-      end
-      # Splits the route method options
-      # into real options and route options (/regexp/ => thing or 'some/path' => thing).
-      #
-      def split options
-        mappings      = {}
-        route_options = {}
-        options.each_pair do |key, value|
-          if Regexp === key or String === key
-            mappings[key] = value
-          else
-            route_options[key] = value
-          end
-        end
-        [mappings, route_options]
-      end
-      def route_one url, query, route_options = {}
-        raise RouteTargetNilError.new(url) unless query
-        routes.add_route Internals::Adapters::Rack.app_for(query, route_options), default_options(url, route_options), {}, query.to_s
-      end
-      class RouteTargetNilError < StandardError
-        def initialize url
-          @url = url
-        end
-        def to_s
-          "Routing for #{@url.inspect} was defined with a nil target object, i.e. #{@url.inspect} => nil."
-        end
-      end
-      #
-      #
-      def root status
-        answer %r{^/$}, STATUSES[status]
-      end
-      #
-      #
-      def default status
-        answer nil, STATUSES[status]
-      end
-
-
-
-      # TODO Can Rack handle this for me?
-      #
-      # Note: Rack-mount already handles the 404.
-      #
-      STATUSES = {
-        200 => lambda { |_| [200, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, ['']] },
-        404 => lambda { |_| [404, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, ['']] }
-      }
-
-      #
-      #
-      def default_options url, route_options = {}
-        url = normalized url
-
-        options = { request_method: 'GET' }.merge route_options
-
-        options[:path_info] = url if url
-
-        options.delete :content_type
-
-        query_params = options.delete :query
-        options[:query_string] = %r{#{generate_query_string(query_params)}} if query_params
-
-        options
-      end
-      #
-      #
-      def generate_query_string query_params
-        raise "At least one query string condition is needed." if query_params.size.zero?
-        raise "Too many query param conditions (only 1 allowed): #{query_params}" if query_params.size > 1
-        k, v = query_params.first
-        "#{k}=#{v}"
-      end
-
-      # Setup a route that answers using the given app.
-      #
-      def answer url = nil, app = nil
-        routes.add_route (app || STATUSES[200]), default_options(url)
-      end
-
-      # Returns a regular expression for the url if it is given a String-like object.
-      #
-      def normalized url
-        url.respond_to?(:to_str) ? %r{#{url}} : url
-      end
-
-      # Returns true if there are no routes defined.
-      #
-      def empty?
-        routes.length.zero?
-      end
-
-      # TODO Beautify. Rewrite!
-      #
-      def to_s
-        max_length = routes.instance_variable_get(:@routes).reduce(0) do |current_max, route|
-          route_length = route.conditions[:path_info].source.to_s.size
-          route_length > current_max ? route_length : current_max
-        end
-        "Note: Anchored (\u2713) regexps are faster, e.g. /\\A.*\\Z/ or /^.*$/.\n\n" +
-        routes.instance_variable_get(:@routes).map do |route|
-          path_info = route.conditions[:path_info]
-          anchored = ::Rack::Mount::Utils.regexp_anchored?(path_info)
-          anchored_ok = anchored ? "\u2713" : " "
-          source = path_info.source
-          "#{anchored_ok}  #{source.ljust(max_length)} => #{route.name}"
-        end.join("\n")
-      end
-
-    end
-
-  end
-
-end

data/lib/picky/internals/generators/base.rb

@@ -1,19 +0,0 @@
-module Internals
-
-  module Generators # :nodoc:all
-  
-    # A cache generator holds an index.
-    #
-    class Base
-    
-      attr_reader :index
-    
-      def initialize index
-        @index = index
-      end
-    
-    end
-  
-  end
-  
-end

data/lib/picky/internals/generators/partial/default.rb

@@ -1,7 +0,0 @@
-module Internals
-  module Generators
-    module Partial
-      Default = Substring.new from: -3, to: -1
-    end
-  end
-end

data/lib/picky/internals/generators/partial/none.rb

@@ -1,35 +0,0 @@
-module Internals
-
-  module Generators
-
-    module Partial
-
-      # Does not generate a partial index.
-      #
-      class None < Strategy
-
-        # Returns an empty index.
-        #
-        def generate_from index
-          {}
-        end
-      
-        # Returns if this strategy's generated file is saved.
-        #
-        def saved?
-          false
-        end
-      
-        # Do not use the partial bundle for getting ids and weights.
-        #
-        def use_exact_for_partial?
-          true
-        end
-
-      end
-
-    end
-
-  end
-  
-end

data/lib/picky/internals/generators/partial/strategy.rb

@@ -1,29 +0,0 @@
-module Internals
-
-  module Generators
-
-    module Partial
-
-      # Superclass for partial strategies.
-      #
-      class Strategy < Generators::Strategy
-      
-        # Defines whether to use the exact bundle
-        # instead of the partial one.
-        #
-        # Default is @false@.
-        #
-        # For example: 
-        #  Partial::None.new # Uses the exact index instead of the partial one.
-        #
-        def use_exact_for_partial?
-          false
-        end
-      
-      end
-
-    end
-
-  end
-
-end

data/lib/picky/internals/generators/partial/substring.rb

@@ -1,122 +0,0 @@
-module Internals
-
-  module Generators
-
-    module Partial
-    
-      # Generates the right substrings for use in the substring strategy.
-      #
-      class SubstringGenerator
-      
-        attr_reader :from, :to
-      
-        def initialize from, to
-          @from, @to = from, to
-        
-          if @to.zero?
-            def each_subtoken token, &block
-              token.each_subtoken @from, &block
-            end
-          else
-            def each_subtoken token, &block
-              token[0..@to].intern.each_subtoken @from, &block
-            end
-          end
-        
-        end
-      
-      end
-    
-      # The subtoken partial strategy.
-      #
-      # If given "florian"
-      # it will index "floria", "flori", "flor", "flo", "fl", "f"
-      # (Depending on what the given from value is, the example is with option from: 1)
-      #
-      class Substring < Strategy
-      
-        # The from option signifies where in the symbol it
-        # will start in generating the subtokens.
-        #
-        # Examples:
-        #
-        # With :hello, and to: -1 (default)
-        # * from: 1 # => [:hello, :hell, :hel, :he, :h]
-        # * from: 4 # => [:hello, :hell]
-        #
-        # With :hello, and to: -2
-        # * from: 1 # => [:hell, :hel, :he, :h]
-        # * from: 4 # => [:hell]
-        #
-        def initialize options = {}
-          from     = options[:from] || 1
-          to = options[:to] || -1
-          @generator = SubstringGenerator.new from, to
-        end
-      
-        # Delegator to generator#from.
-        #
-        def from
-          @generator.from
-        end
-      
-        # Delegator to generator#to.
-        #
-        def to
-          @generator.to
-        end
-      
-        # Generates a partial index from the given index.
-        #
-        def generate_from index
-          result = {}
-        
-          # Generate for each key token the subtokens.
-          #
-          i = 0
-          index.each_key do |token|
-            i += 1
-            if i == 5000
-              timed_exclaim "Generating partial tokens for token #{token}. This appears every 5000 tokens."
-              i = 0
-            end
-            generate_for token, index, result
-          end
-        
-          # Remove duplicate ids.
-          #
-          # THINK If it is unique for a subtoken, it is
-          #       unique for all derived longer tokens.
-          #
-          result.each_value &:uniq!
-        
-          result
-        end
-      
-        private
-        
-          # To each shortened token of :test
-          # :test, :tes, :te, :t
-          # add all ids of :test
-          #
-          # "token" here means just text.
-          #
-          # THINK Could be improved by appending the aforegoing ids?
-          #
-          def generate_for token, index, result
-            @generator.each_subtoken(token) do |subtoken|
-              if result[subtoken]
-                result[subtoken] += index[token] # unique
-              else
-                result[subtoken] = index[token].dup
-              end
-            end
-          end
-        
-      end
-    
-    end
-  
-  end
-  
-end

data/lib/picky/internals/generators/partial_generator.rb

@@ -1,19 +0,0 @@
-module Internals
-
-  module Generators
-
-    # The partial generator uses a subtoken(downto:1) generator as default.
-    #
-    class PartialGenerator < Base
-    
-      # Generate a partial index based on the given index.
-      #
-      def generate strategy = Partial::Substring.new(from: 1)
-        strategy.generate_from self.index
-      end
-
-    end
-  
-  end
-  
-end