marklogic 0.0.1

data/lib/marklogic/loggable.rb

@@ -0,0 +1,46 @@
+module MarkLogic
+  module Loggable
+    def logger
+      @logger ||= (rails_logger || default_logger)
+    end
+
+    # Get the rails logger.
+    #
+    # @example Get the rails logger.
+    #   Logging.rails_logger
+    #
+    # @return [ Logger ] The Rails logger.
+    #
+    # @since 1.0.0
+    def rails_logger
+      Rails.logger if defined?(Rails) && Rails.respond_to?(:logger)
+    end
+
+    # Get the default logger.
+    #
+    # @example Get the default logger.
+    #   Logging.default_logger
+    #
+    # @return [ Logger ] The default logger.
+    #
+    # @since 1.0.0
+    def default_logger
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::DEBUG
+      logger
+    end
+
+    # Set the logger.
+    #
+    # @example Set the logger.
+    #   Logging.logger = logger
+    #
+    # @return [ Logger ] The logger.
+    #
+    # @since 1.0.0
+    def logger=(logger)
+      @logger = logger
+    end
+  end
+  extend Loggable
+end

data/lib/marklogic/object_id.rb

@@ -0,0 +1,46 @@
+# encoding: UTF-8
+
+require 'securerandom'
+
+module MarkLogic
+  class ObjectId
+
+    def initialize
+      @id = SecureRandom.hex
+    end
+
+    def to_s
+      @id
+    end
+
+    class << self
+      def from_string(str)
+        object_id = allocate
+        object_id.instance_variable_set(:@id, str)
+        object_id
+      end
+
+      def legal?(string)
+        string.to_s =~ /^[0-9a-f]{32}$/i ? true : false
+      end
+    end
+
+    def ==(other)
+      to_s == other.to_s
+    end
+
+    def as_json(options=nil)
+      to_s
+    end
+
+    def to_json(options = nil)
+      as_json.to_json
+    end
+
+    def hash
+      to_s.hash
+    end
+
+    alias to_str to_s
+  end
+end

data/lib/marklogic/persistence.rb

@@ -0,0 +1,29 @@
+module MarkLogic
+  module Persistence
+    include MarkLogic::Loggable
+
+    def connection=(conn)
+      @connection = conn if conn
+    end
+
+    def connection
+      @connection
+    end
+
+    def manage_connection=(manage_conn)
+      @manage_connection = manage_conn if manage_conn
+    end
+
+    def manage_connection
+      @manage_connection ||= MarkLogic::Connection.manage_connection
+    end
+
+    def admin_connection=(admin_conn)
+      @admin_connection = admin_conn if admin_conn
+    end
+
+    def admin_connection
+      @admin_connection ||= MarkLogic::Connection.admin_connection
+    end
+  end
+end

data/lib/marklogic/queries.rb

@@ -0,0 +1,18 @@
+require 'marklogic/queries/base_query'
+require 'marklogic/queries/and_not_query'
+require 'marklogic/queries/and_query'
+require 'marklogic/queries/boost_query'
+require 'marklogic/queries/collection_query'
+require 'marklogic/queries/container_query'
+require 'marklogic/queries/directory_query'
+require 'marklogic/queries/document_fragment_query'
+require 'marklogic/queries/document_query'
+require 'marklogic/queries/locks_fragment_query'
+require 'marklogic/queries/near_query'
+require 'marklogic/queries/not_in_query'
+require 'marklogic/queries/not_query'
+require 'marklogic/queries/or_query'
+require 'marklogic/queries/properties_fragment_query'
+require 'marklogic/queries/range_query'
+require 'marklogic/queries/value_query'
+require 'marklogic/queries/word_query'

data/lib/marklogic/queries/and_not_query.rb

@@ -0,0 +1,14 @@
+module MarkLogic
+  module Queries
+    class AndNotQuery < BaseQuery
+      def initialize(positive_query, negative_query)
+        @positive_query = positive_query
+        @negative_query = negative_query
+      end
+
+      def to_xqy
+        %Q{cts:and-not-query(#{@positive_query.to_xqy},#{@negative_query.to_xqy})}
+      end
+    end
+  end
+end

data/lib/marklogic/queries/and_query.rb

@@ -0,0 +1,14 @@
+module MarkLogic
+  module Queries
+    class AndQuery < BaseQuery
+      def initialize(*args)
+        @queries = args.flat_map{ |i| i }
+      end
+
+      def to_xqy
+        sub_queries = @queries.map { |q| q.to_xqy }.join(',')
+        %Q{cts:and-query((#{sub_queries}))}
+      end
+    end
+  end
+end

data/lib/marklogic/queries/base_query.rb

@@ -0,0 +1,40 @@
+module MarkLogic
+  module Queries
+    class BaseQuery
+
+      # Helper function to add a sub query into a parent query
+      #
+      # @param [ BaseQuery ] parent The parent query
+      # @param [ BaseQuery ] query The sub-query to add
+      #
+      # @since 1.0.0
+      def add_sub_query(parent, query)
+        query_json = query.to_json
+        query_key = query_json.keys[0]
+        parent[query_key] = query_json[query_key]
+      end
+
+      # Returns the value of the query appropriately formatted
+      #
+      # @param [ Any ] original_value The value to format
+      # @param [ String ] type The data type
+      #
+      # @since 1.0.0
+      def query_value(original_value, type = nil)
+        if original_value.kind_of?(Array)
+          value = original_value.map { |v| query_value(v) }.join(',')
+        elsif original_value.kind_of?(TrueClass)
+          value = 'fn:true()'
+        elsif original_value.kind_of?(FalseClass)
+          value = 'fn:false()'
+        elsif original_value.kind_of?(ObjectId)
+          value = %Q{"#{original_value.to_s}"}
+        elsif original_value.kind_of?(String) || type == "string"
+          value = %Q{"#{original_value}"}
+        else
+          value = original_value
+        end
+      end
+    end
+  end
+end

data/lib/marklogic/queries/boost_query.rb

@@ -0,0 +1,14 @@
+module MarkLogic
+  module Queries
+    class BoostQuery< BaseQuery
+      def initialize(matching_query, boosting_query)
+        @matching_query = matching_query
+        @boosting_query = boosting_query
+      end
+
+      def to_xqy
+        %Q{cts:boost-query(#{@matching_query.to_xqy},#{@boosting_query.to_xqy})}
+      end
+    end
+  end
+end

data/lib/marklogic/queries/collection_query.rb

@@ -0,0 +1,14 @@
+module MarkLogic
+  module Queries
+    class CollectionQuery < BaseQuery
+      def initialize(collection_uris)
+        @collection_uris = collection_uris
+      end
+
+      def to_xqy
+        uris = query_value(@collection_uris)
+        %Q{cts:collection-query((#{uris}))}
+      end
+    end
+  end
+end

data/lib/marklogic/queries/container_query.rb

@@ -0,0 +1,15 @@
+module MarkLogic
+  module Queries
+    class ContainerQuery< BaseQuery
+      def initialize(name, query, options = {})
+        @name = name
+        @query = query
+        @options = options
+      end
+
+      def to_xqy
+        %Q{cts:json-property-scope-query("#{@name}",#{@query.to_xqy})}
+      end
+    end
+  end
+end

data/lib/marklogic/queries/directory_query.rb

@@ -0,0 +1,20 @@
+module MarkLogic
+  module Queries
+    class DirectoryQuery< BaseQuery
+      def initialize(uris, depth = nil)
+        @directory_uris = uris
+        @depth = depth
+      end
+
+      def to_xqy
+        uris = query_value(@directory_uris)
+
+        if @depth.nil?
+          %Q{cts:directory-query((#{uris}))}
+        else
+          %Q{cts:directory-query((#{uris}),"#{@depth}")}
+        end
+      end
+    end
+  end
+end

data/lib/marklogic/queries/document_fragment_query.rb

@@ -0,0 +1,13 @@
+module MarkLogic
+  module Queries
+    class DocumentFragmentQuery < BaseQuery
+      def initialize(query)
+        @query = query
+      end
+
+      def to_xqy
+        %Q{cts:document-fragment-query(#{@query.to_xqy})}
+      end
+    end
+  end
+end

data/lib/marklogic/queries/document_query.rb

@@ -0,0 +1,14 @@
+module MarkLogic
+  module Queries
+    class DocumentQuery < BaseQuery
+      def initialize(uris)
+        @uris = uris
+      end
+
+      def to_xqy
+        uris = query_value(@uris)
+        %Q{cts:document-query((#{uris}))}
+      end
+    end
+  end
+end

data/lib/marklogic/queries/geospatial_query.rb

@@ -0,0 +1,44 @@
+module MarkLogic
+  module Queries
+    class GeospatialQuery < BaseQuery
+      def initialize(name, regions, options = {})
+        @name = name
+        @regions = regions
+        @options = options || {}
+        @weight = @options.delete(:weight) || 1.0
+      end
+
+      def options=(opts)
+        @options = opts
+      end
+
+      def options
+        opts = []
+        @options.each do |k, v|
+          dashed_key = k.to_s.gsub(/_/, '-')
+          case k.to_s
+          when "coordinate_system", "units", "type", "score_function", "slope_factor"
+            opts << %Q{"#{dashed_key}=#{v}"}
+          when /(boundaries)_included/
+            opts << (v == true ? %Q{"#{$1}-included"} : %Q{"#{$1}-excluded"})
+          when /([a-z\-]+_excluded)/
+            opts << %Q{"#{dashed_key}"}
+          when "cached"
+            opts << (v == true ? %Q{"cached"} : %Q{"uncached"})
+          when "zero", "synonym"
+            opts << %Q{"#{dashed_key}"}
+          # else
+          #   opts << %Q{"#{v}"}
+          end
+        end
+
+        opts
+      end
+
+      def to_xqy
+        regions = query_value(@regions)
+        %Q{cts:json-property-geospatial-query("#{@name}",(#{regions}),(#{options.join(',')}),#{@weight})}
+      end
+    end
+  end
+end

data/lib/marklogic/queries/locks_fragment_query.rb

@@ -0,0 +1,13 @@
+module MarkLogic
+  module Queries
+    class LocksFragmentQuery< BaseQuery
+      def initialize(query)
+        @query = query
+      end
+
+      def to_xqy
+        %Q{cts:locks-fragment-query(#{@query.to_xqy})}
+      end
+    end
+  end
+end

data/lib/marklogic/queries/near_query.rb

@@ -0,0 +1,31 @@
+module MarkLogic
+  module Queries
+    class NearQuery< BaseQuery
+      def initialize(queries, distance = 10, distance_weight = 1.0, options = {})
+        @queries = queries
+        @distance = distance
+        @distance_weight = distance_weight
+        @ordered = options.delete(:ordered)
+      end
+
+      def to_json
+        json = {
+          "near-query" => {
+            "queries" => @queries.map { |q| q.to_json }
+          }
+        }
+
+        json["near-query"]["queries"].push({ "distance" => @distance }) if @distance
+        json["near-query"]["queries"].push({ "distance-weight" => @distance_weight }) if @distance_weight
+        json["near-query"]["queries"].push({ "ordered" => @ordered })
+        json
+      end
+
+      def to_xqy
+        queries = @queries.map { |q| q.to_xqy }.join(',')
+        ordered = (@ordered == true ? %Q{"ordered"} : %Q{"unordered"}) if !@ordered.nil?
+        %Q{cts:near-query((#{queries}),#{@distance},(#{ordered}),#{@distance_weight})}
+      end
+    end
+  end
+end

data/lib/marklogic/queries/not_in_query.rb

@@ -0,0 +1,14 @@
+module MarkLogic
+  module Queries
+    class NotInQuery< BaseQuery
+      def initialize(positive_query, negative_query)
+        @positive_query = positive_query
+        @negative_query = negative_query
+      end
+
+      def to_xqy
+        %Q{cts:not-in-query(#{@positive_query.to_xqy},#{@negative_query.to_xqy})}
+      end
+    end
+  end
+end

data/lib/marklogic/queries/not_query.rb

@@ -0,0 +1,13 @@
+module MarkLogic
+  module Queries
+    class NotQuery< BaseQuery
+      def initialize(query)
+        @query = query
+      end
+
+      def to_xqy
+        %Q{cts:not-query(#{@query.to_xqy})}
+      end
+    end
+  end
+end