picky 4.0.0pre1 → 4.0.0pre2

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

@@ -1,67 +0,0 @@
-module Picky
-
-  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 on it if it is called by Rack.
-    #
-    module Rack
-
-      class Search < 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 *extracted(params)
-
-            Picky.logger && Picky.logger.info(results)
-
-            respond_with results.to_json, 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/application.rb

@@ -1,268 +0,0 @@
-module Picky
-
-  # = Picky Applications
-  #
-  # A Picky Application is where you configure the whole search engine.
-  #
-  # This is a step-by-step description on how to configure your Picky app.
-  #
-  # Start by subclassing Application:
-  #   class MyGreatSearch < Application
-  #     # Your configuration goes here.
-  #   end
-  # The generator
-  #   $ picky generate unicorn_server project_name
-  # will generate an example <tt>project_name/app/application.rb</tt> file for you
-  # with some example code inside.
-  #
-  # == Index.new(name)
-  #
-  # Next, define where your data comes from, creating an <tt>Index</tt>. You use the <tt>Index.new</tt> method for that:
-  #   my_index = Index.new :some_index_name
-  # You give the index a name (or identifier), and a source (see Sources), where its data comes from. Let's do that:
-  #   class MyGreatSearch < Application
-  #
-  #     books = Index.new :books do
-  #       source Sources::CSV.new(:title, :author, :isbn, file:'app/library.csv')
-  #     end
-  #
-  #   end
-  # Now we have an index <tt>books</tt>.
-  #
-  # That on itself won't do much good.
-  #
-  # Note that a Redis index is also available: Index.new.
-  #
-  # == category(identifier, options = {})
-  #
-  # Picky needs us to define categories on the data.
-  #
-  # Categories help your user find data.
-  # It's best if you look at an example yourself: http://floere.github.com/picky/examples.html
-  #
-  # Let's go ahead and define a category:
-  #   class MyGreatSearch < Application
-  #
-  #     books = Index.new :books do
-  #       source   Sources::CSV.new(:title, :author, :isbn, file:'app/library.csv')
-  #       category :title
-  #     end
-  #
-  #   end
-  # Now we could already run the indexer:
-  #   $ rake index
-  #
-  # (You can define similarity or partial search capabilities on a category, see http://github.com/floere/picky/wiki/Categories-configuration for info)
-  #
-  # So now we have indexed data (the title), but nobody to ask the index anything.
-  #
-  # == Search.new(*indexes, options = {})
-  #
-  # We need somebody who asks the index (a Query object, also see http://github.com/floere/picky/wiki/Queries-Configuration):
-  #    books_search = Search.new books
-  #
-  # Now we have somebody we can ask about the index. But no external interface.
-  #
-  # == route(/regexp1/ => search1, /regexp2/ => search2, ...)
-  #
-  # Let's add a URL path (a Route, see http://github.com/floere/picky/wiki/Routing-configuration) to which we can send our queries. We do that with the route method:
-  #   route %r{^/books$} => books_query
-  # In full glory:
-  #   class MyGreatSearch < Application
-  #
-  #     books = Index.new :books do
-  #       source   Sources::CSV.new(:title, :author, :isbn, file:'app/library.csv')
-  #       category :title
-  #     end
-  #
-  #     route %r{^/books$} => Search.new(books)
-  #
-  #   end
-  # That's it!
-  #
-  # Now run the indexer and server:
-  #   $ rake index
-  #   $ rake start
-  # Run your first query:
-  #   $ curl 'localhost:8080/books?query=hello server'
-  #
-  # Nice, right? Your first query!
-  #
-  # Maybe you don't find everything. We need to process the data before it goes into the index.
-  #
-  # == indexing(options = {})
-  #
-  # That's what the <tt>indexing</tt> method is for:
-  #   indexing options
-  # Read more about the options here: http://github.com/floere/picky/wiki/Indexing-configuration
-  #
-  # Same thing with the search text – we need to process that as well.
-  #
-  # == searching(options = {})
-  #
-  # Analog to the indexing method, we use the <tt>searching</tt> method.
-  #   searching options
-  # Read more about the options here: http://github.com/floere/picky/wiki/Searching-Configuration
-  #
-  # And that's all there is. It's incredibly powerful though, as you can combine, weigh, refine to the max.
-  #
-  # == Wiki
-  #
-  # Read more in the Wiki: http://github.com/floere/picky/wiki
-  #
-  # Have fun!
-  #
-  # == Full example
-  #
-  # Our example, fully fleshed out with indexing, querying, and weights:
-  #   class MyGreatSearch < Application
-  #
-  #     indexing removes_characters: /[^a-zA-Z0-9\.]/,
-  #              stopwords: /\b(and|or|in|on|is|has)\b/,
-  #              splits_text_on: /\s/,
-  #              removes_characters_after_splitting: /\./,
-  #              substitutes_characters_with: CharacterSubstituters::WestEuropean.new,
-  #              normalizes_words: [
-  #                [/(.*)hausen/, 'hn'],
-  #                [/\b(\w*)str(eet)?/, 'st']
-  #              ]
-  #
-  #     searching removes_characters: /[^a-zA-Z0-9\s\/\-\,\&\"\~\*\:]/,
-  #               stopwords: /\b(and|the|of|it|in|for)\b/,
-  #               splits_text_on: /[\s\/\-\,\&]+/,
-  #               removes_characters_after_splitting: /\./,
-  #               substitutes_characters_with: CharacterSubstituters::WestEuropean.new,
-  #               maximum_tokens: 4
-  #
-  #     books = Index.new :books do
-  #       source   Sources::CSV.new(:title, :author, :isbn, file:'app/library.csv')
-  #       category :title,
-  #                qualifiers: [:t, :title, :titre],
-  #                partial:    Partial::Substring.new(:from => 1),
-  #                similarity: Similarity::DoubleMetaphone.new(2)
-  #       category :author,
-  #                partial: Partial::Substring.new(:from => -2)
-  #       category :isbn
-  #     end
-  #
-  #     route %r{^/books$} => Search.new(books) do
-  #       boost [:title, :author] => +3, [:author, :title] => -1
-  #     end
-  #
-  #   end
-  # That's actually already a full-blown Picky App!
-  #
-  class Application
-
-    class << self
-
-      # API
-      #
-
-      # Returns a configured tokenizer that
-      # is used for indexing by default.
-      #
-      def indexing options = {}
-        Tokenizer.index_default = Tokenizer.new(options)
-      end
-
-      # Returns a configured tokenizer that
-      # is used for querying by default.
-      #
-      def searching options = {}
-        Tokenizer.query_default = Tokenizer.new(options)
-      end
-
-      # Routes.
-      #
-      def route options
-        raise "Warning: block passed into #route method, not into Search.new!" if block_given?
-        rack_adapter.route options
-      end
-
-      # A Picky application implements the Rack interface.
-      #
-      # Delegates to its routing to handle a request.
-      #
-      def call env
-        rack_adapter.call env
-      end
-      def rack_adapter # :nodoc:
-        @rack_adapter || reset_rack_adapter
-      end
-      def reset_rack_adapter
-        @rack_adapter = FrontendAdapters::Rack.new
-      end
-
-      # Reloads & finalizes the apps.
-      #
-      def reload
-        Loader.load_user 'app'             # Sinatra appfile.
-        Loader.load_user 'app/application' # Standard Picky appfile.
-        finalize_apps
-        exclaim "Loaded Picky application(s) with environment '#{PICKY_ENVIRONMENT}' in #{PICKY_ROOT} on Ruby #{RUBY_VERSION}."
-      end
-
-      # Finalize the subclass as soon as it
-      # has finished loading.
-      #
-      attr_reader :apps # :nodoc:
-      def initialize_apps # :nodoc:
-        @apps ||= []
-      end
-      def inherited app # :nodoc:
-        initialize_apps
-        apps << app
-      end
-      def finalize_apps # :nodoc:
-        initialize_apps
-        apps.each &:finalize
-      end
-      # Finalizes the routes.
-      #
-      def finalize # :nodoc:
-        check
-        rack_adapter.finalize
-      end
-      # Checks app for missing things.
-      #
-      # Warns if something is missing.
-      #
-      def check # :nodoc:
-        warnings = []
-        warnings << check_external_interface
-        warn "\n#{warnings.join(?\n)}\n\n" unless warnings.all? &:nil?
-      end
-      def check_external_interface
-        "WARNING: No routes defined for application configuration in #{self.class}." if rack_adapter.empty?
-      end
-
-      def to_stats
-        <<-APP
-  \033[1mIndexing (default)\033[m:
-  #{Tokenizer.index_default.indented_to_s}
-
-  \033[1mQuerying (default)\033[m:
-  #{Tokenizer.query_default.indented_to_s}
-
-  \033[1mIndexes\033[m:
-  #{Indexes.to_s.indented_to_s}
-
-  \033[1mRoutes\033[m:
-  #{to_routes.indented_to_s}
-  APP
-      end
-
-      def to_routes
-        rack_adapter.to_s
-      end
-
-      def to_s # :nodoc:
-        self.name
-      end
-
-    end
-
-  end
-
-end

data/lib/picky/frontend_adapters/rack.rb

@@ -1,161 +0,0 @@
-module Picky
-
-  module FrontendAdapters
-
-    # TODO Rename to Routing again. Push everything back into appropriate Adapters.
-    #
-    class Rack # :nodoc:all
-
-      def initialize
-        check_gem
-      end
-
-      # 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
-
-      #
-      #
-      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 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' }, [EMPTY_STRING]] },
-        404 => lambda { |_| [404, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, [EMPTY_STRING]] }
-      }
-
-      #
-      #
-      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