picky 2.7.0 → 3.0.0.pre1

data/lib/picky/frontend_adapters/rack.rb

@@ -1,144 +1,159 @@
-require 'rack/mount'
+module Picky
 
-module FrontendAdapters
+  module FrontendAdapters
 
-  # TODO Rename to Routing again. Push everything back into appropriate Adapters.
-  #
-  class Rack # :nodoc:all
-
-    #
+    # TODO Rename to Routing again. Push everything back into appropriate Adapters.
     #
-    def reset_routes
-      @routes = ::Rack::Mount::RouteSet.new
-    end
-    def routes
-      @routes || reset_routes
-    end
-    def finalize
-      routes.freeze
-    end
+    class Rack # :nodoc:all
 
-    # Routing simply delegates to the route set to handle a request.
-    #
-    def call env
-      routes.call env
-    end
+      def initialize
+        check_gem
+      end
 
-    # API method.
-    #
-    def route options = {}
-      mappings, route_options = split options
-      mappings.each do |url, query|
-        route_one url, query, route_options
+      # Tries to require the rest_client gem.
+      #
+      def check_gem # :nodoc:
+        require 'rack/mount'
+      rescue LoadError
+        warn_gem_missing 'rack-mount', 'the Picky routing'
+        exit 1
       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
+
+      #
+      #
+      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
-      [mappings, route_options]
-    end
-    def route_one url, query, route_options = {}
-      raise RouteTargetNilError.new(url) unless query
-      routes.add_route Adapters::Rack.app_for(query, route_options), default_options(url, route_options), {}, query.to_s
-    end
-    class RouteTargetNilError < StandardError
-      def initialize url
-        @url = url
+      # 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 to_s
-        "Routing for #{@url.inspect} was defined with a nil target object, i.e. #{@url.inspect} => nil."
+      def route_one url, query, route_options = {}
+        raise RouteTargetNilError.new(url) unless query
+        routes.add_route 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
-    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' }, ['']] }
-    }
+      # 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
+      #
+      #
+      def default_options url, route_options = {}
+        url = normalized url
 
-      options = { request_method: 'GET' }.merge route_options
+        options = { request_method: 'GET' }.merge route_options
 
-      options[:path_info] = url if url
+        options[:path_info] = url if url
 
-      options.delete :content_type
+        options.delete :content_type
 
-      query_params = options.delete :query
-      options[:query_string] = %r{#{generate_query_string(query_params)}} if query_params
+        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
+        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
+      # 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 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
+      # 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
 
-    # 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

data/lib/picky/generators/aliases.rb

@@ -1,3 +1,5 @@
-Partial    = Generators::Partial
-Similarity = Generators::Similarity
-Weights    = Generators::Weights
+module Picky
+  Partial    = Generators::Partial
+  Similarity = Generators::Similarity
+  Weights    = Generators::Weights
+end

data/lib/picky/generators/base.rb

@@ -1,13 +1,17 @@
-module Generators # :nodoc:all
+module Picky
 
-  # A cache generator holds an index.
-  #
-  class Base
+  module Generators # :nodoc:all
 
-    attr_reader :inverted
+    # A cache generator holds an index.
+    #
+    class Base
+
+      attr_reader :inverted
+
+      def initialize inverted
+        @inverted = inverted
+      end
 
-    def initialize inverted
-      @inverted = inverted
     end
 
   end

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

@@ -1,5 +1,9 @@
-module Generators
-  module Partial
-    Default = Substring.new from: -3, to: -1
+module Picky
+
+  module Generators
+    module Partial
+      Default = Substring.new from: -3, to: -1
+    end
   end
+
 end

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

@@ -1,27 +1,31 @@
-module Generators
+module Picky
 
-  module Partial
+  module Generators
 
-    # Does not generate a partial index.
-    #
-    class None < Strategy
+    module Partial
 
-      # Returns an empty index.
+      # Does not generate a partial 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
+      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

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

@@ -1,23 +1,27 @@
-module Generators
+module Picky
 
-  module Partial
+  module Generators
 
-    # 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.
+    module Partial
+
+      # Superclass for partial strategies.
       #
-      def use_exact_for_partial?
-        false
+      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

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

@@ -1,117 +1,121 @@
-module Generators
+module Picky
 
-  module Partial
+  module Generators
 
-    # Generates the right substrings for use in the substring strategy.
-    #
-    class SubstringGenerator
+    module Partial
 
-      attr_reader :from, :to
-
-      def initialize from, to
-        @from, @to = from, to
+      # Generates the right substrings for use in the substring strategy.
+      #
+      class SubstringGenerator
 
-        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
+        attr_reader :from, :to
 
-      end
+        def initialize from, to
+          @from, @to = from, to
 
-    end
+          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
 
-    # 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
+        end
 
-      # 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.
+      # The subtoken partial strategy.
       #
-      def from
-        @generator.from
-      end
-
-      # Delegator to generator#to.
+      # 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)
       #
-      def to
-        @generator.to
-      end
+      class Substring < Strategy
 
-      # Generates a partial index from the given inverted index.
-      #
-      def generate_from inverted
-        result = {}
+        # 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
 
-        # Generate for each key token the subtokens.
+        # Delegator to generator#from.
         #
-        i = 0
-        j = 0
-        inverted.each_key do |token|
-          i += 1
-          if i == 5000
-            j += 1
-            timed_exclaim %Q{#{"%8i" % (i*j)} generated (current token: "#{token}").}
-            i = 0
-          end
-          generate_for token, inverted, result
+        def from
+          @generator.from
         end
 
-        # Remove duplicate ids.
+        # Delegator to generator#to.
         #
-        # THINK If it is unique for a subtoken, it is
-        #       unique for all derived longer tokens.
+        def to
+          @generator.to
+        end
+
+        # Generates a partial index from the given inverted index.
         #
-        result.each_value &:uniq!
+        def generate_from inverted
+          result = {}
+
+          # Generate for each key token the subtokens.
+          #
+          i = 0
+          j = 0
+          inverted.each_key do |token|
+            i += 1
+            if i == 5000
+              j += 1
+              timed_exclaim %Q{#{"%8i" % (i*j)} generated (current token: "#{token}").}
+              i = 0
+            end
+            generate_for token, inverted, result
+          end
 
-        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!
 
-      private
+          result
+        end
 
-        # 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, inverted, result
-          @generator.each_subtoken(token) do |subtoken|
-            if result[subtoken]
-              result[subtoken] += inverted[token] # unique
-            else
-              result[subtoken] = inverted[token].dup
+        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, inverted, result
+            @generator.each_subtoken(token) do |subtoken|
+              if result[subtoken]
+                result[subtoken] += inverted[token] # unique
+              else
+                result[subtoken] = inverted[token].dup
+              end
             end
           end
-        end
+
+      end
 
     end
 

data/lib/picky/generators/partial_generator.rb

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

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

@@ -1,7 +1,11 @@
-module Generators
-  module Similarity
-    # Default is no similarity.
-    #
-    Default = None.new
+module Picky
+
+  module Generators
+    module Similarity
+      # Default is no similarity.
+      #
+      Default = None.new
+    end
   end
+
 end