activedocument 0.4.2 → 0.5

data/lib/ActiveDocument/active_document.rb

@@ -50,25 +50,20 @@ module ActiveDocument
   # -------------------
   #  == Dynamic Accessors
   # In addition to the ability to access the underlying XML document (as a Nokogiri XML Document) you have the ability
-  # to access the XML as attributes of your domain object via dynamic attribute accessors (eg. domain_object.element_name) The rules for using accessors
-  # are as follows:
-  #  1. If the element_name is a simple type (i.e. text node with no children <tt><example>text</exmample></tt>)
-  #     1. If there is only one occurence of the element, return its text value
-  #     2. If there are multiple occurences of the element, return a list of each text value
-  #  2. If the element_name is a complex type (e.g. <tt><example><text>hi</text></example></tt>)
-  #     1. If there is only one ocurence of the element then return it as a Nokoguri Element
-  #     2. If there are multiple occurences of the element, return a list of Nokoguri Elements
+  # to access the XML as attributes of your domain object via dynamic attribute accessors (eg. domain_object.element_name).
+  # Attribute accessors always return instances of ActiveDocument::ActiveDocument::PartialResult. This class works just
+  # like a regular ActiveDocument::ActiveDocument::Base object in that you access its members like regular properties.
   #
-  # More complex dynamic accessors are also supported. They still adhere to the rules above, but instead of just looking
+  # More complex dynamic accessors are also supported. Instead of just looking
   # for an element anywhere in the document, you can be more specific. For example, domain_object.chapter.paragraph
   # will find all paragraph elements that are children of chapter elements.
   # -------------------
   class Base < Finder
     include ClassLevelInheritableAttributes
-    inheritable_attributes_list :my_namespaces, :my_default_namespace, :root
+    inheritable_attributes_list :my_namespaces, :my_default_namespace, :root, :my_attribute_namespaces, :my_default_attribute_namespaces
     @my_namespaces = Hash.new
-    @my_default_namespace = String.new
-    attr_reader :document, :uri, :my_namespaces, :my_default_namespace, :root
+    @my_default_namespace = nil
+    attr_reader :document, :uri, :my_namespaces, :my_default_namespace, :root, :my_attribute_namespaces, :my_default_attribute_namespaces
 
 
     # create a new instance with an optional xml string to use for constructing the model
@@ -106,7 +101,7 @@ module ActiveDocument
 
     def [](key)
       namespace = namespace_for_element(key)
-      if namespace.empty?
+      if namespace.nil? || namespace.empty?
         @document.root.xpath("@#{key}").to_s
       else
         @document.root.xpath("@ns:#{key}", {'ns' => namespace}).to_s
@@ -117,7 +112,7 @@ module ActiveDocument
       set_attribute(key, value)
     end
 
-    # enables the dynamic finders
+    # enables the dynamic property accessors
     def method_missing(method_id, * arguments, & block)
       @@log.debug("ActiveDocument::Base at line #{__LINE__}: method called is #{method_id} with arguments #{arguments}")
       method = method_id.to_s
@@ -147,22 +142,52 @@ module ActiveDocument
         namespace
       end
 
+      def namespace_for_attribute(attribute)
+        namespace = nil
+        if !@my_attribute_namespaces.nil? && @my_attribute_namespaces[attribute]
+          namespace = @my_attribute_namespaces[attribute]
+        else
+          namespace = @my_default_attribute_namespace unless @my_default_attribute_namespace.nil?
+        end
+        namespace
+      end
+
       def namespaces(namespace_hash)
         @my_namespaces = namespace_hash
       end
 
+      def attribute_namespaces(namespace_hash)
+        @my_attribute_namespaces = namespace_hash
+      end
+
       def add_namespace(element, uri)
         @my_namespaces[element.to_s] == uri
       end
 
+      def add_attribute_namespace(attribute, uri)
+        @my_attribute_namespaces[attribute.to_s] == uri
+      end
+
       def remove_namespace(element)
         @my_namespaces.delete element
       end
 
+      def remove_attribute_namespace(attribute)
+        @my_attribute_namespaces.delete attribute
+      end
+
       def default_namespace(namespace)
         @my_default_namespace = namespace # todo should this just be an entry in namespaces?
       end
 
+      def root(root)
+        @root = root
+      end
+
+      def default_attribute_namespace(namespace)
+        @my_default_attribute_namespace = namespace # todo should this just be an entry in namespaces?
+      end
+
       def delete(uri)
         @@ml_http.send_xquery(@@xquery_builder.delete(uri))
       end
@@ -171,8 +196,33 @@ module ActiveDocument
       def method_missing(method_id, * arguments, & block)
         @@log.debug("ActiveDocument::Base at line #{__LINE__}: method called is #{method_id} with arguments #{arguments}")
         method = method_id.to_s
-        # identify element search methods
-        if method =~ /find_by_(.*)$/ and arguments.length > 0
+        # identify attribute search methods
+        if method =~ /find_by_attribute_(.*)$/ and arguments.length >= 2
+          attribute = $1.to_sym
+          element = arguments[0]
+          value = arguments[1]
+          if arguments[2]
+            root = arguments[2]
+          else
+            root = @root || self.class.name
+          end
+          if arguments[3]
+            element_namespace = arguments[3]
+          else
+            element_namespace = namespace_for_element(element)
+          end
+          if arguments[4]
+            attribute_namespace = arguments[4]
+          else
+            attribute_namespace = namespace_for_attribute(attribute)
+          end
+          if arguments[5]
+            root_namespace = arguments[5]
+          else
+            root_namespace = namespace_for_element(root)
+          end
+          execute_attribute_finder(element, attribute, value, root, element_namespace, attribute_namespace, root_namespace)
+        elsif method =~ /find_by_(.*)$/ and arguments.length > 0 # identify element search methods
           value = arguments[0]
           element = $1.to_sym
           if arguments[1]
@@ -195,21 +245,25 @@ module ActiveDocument
 
       end
 
-      # Returns an ActiveXML object representing the requested information. If no document exists at that uri then an
-      # empty domain object is created and returned
+      # Returns an ActiveXML object representing the requested information. If no document exists at that uri then
+      # a LoadException is thrown
       def load(uri)
-        self.new(@@ml_http.send_xquery(@@xquery_builder.load(uri)), uri)
+        document = @@ml_http.send_xquery(@@xquery_builder.load(uri))
+        if document.empty?
+          raise LoadException, "File #{uri} not found", caller
+        end
+        self.new(document, uri)
       end
 
       # Finds all documents of this type that contain the word anywhere in their structure
       def find_by_word(word, root=@root, namespace=@my_default_namespace)
-        SearchResults.new(@@ml_http.send_xquery(@@xquery_builder.find_by_word(word, root, namespace)))
+        xquery = @@xquery_builder.find_by_word(word, root, namespace)
+        @@log.info("ActiveDocument.execute_find_by_word at line #{__LINE__}: #{xquery}")
+        SearchResults.new(@@ml_http.send_xquery(xquery))
       end
 
-
     end # end inner class
 
-
     class PartialResult < self
       include Enumerable
       # todo should this contain a reference to its parent?
@@ -244,8 +298,8 @@ module ActiveDocument
         @document.text
       end
 
-      def each(&block)
-        @document.each(&block)
+      def each(& block)
+        @document.each(& block)
       end
 
     end
@@ -296,7 +350,7 @@ module ActiveDocument
 
     def set_attribute(attribute, value)
       namespace = namespace_for_element(attribute)
-      node = if namespace.empty?
+      node = if namespace.nil? || namespace.empty?
         @document.xpath("@#{attribute}")
       else
         @document.xpath("@ns:#{attribute}", {'ns' => namespace})
@@ -330,5 +384,9 @@ module ActiveDocument
 
   end
 
+  class LoadException < PersistenceException
+
+  end
+
 
 end # end module

data/lib/ActiveDocument/finder.rb

@@ -37,7 +37,11 @@ module ActiveDocument
       @@log.debug("ActiveDocument::Finder at line #{__LINE__}: method called is #{method_id} with arguments #{arguments}")
       method = method_id.to_s
       # identify finder methods
-      if method =~ /find_by_(.*)$/ and arguments.length > 0
+      # todo verify these parameters
+      if method =~ /find_by_attribute_(.*)$/ and arguments.length > 0
+        namespace = arguments[1] if arguments.length == 2
+        execute_attribute_finder($1.to_sym, arguments[0], nil, namespace)
+      elsif method =~ /find_by_(.*)$/ and arguments.length > 0
         namespace = arguments[1] if arguments.length == 2
         execute_finder($1.to_sym, arguments[0], nil, namespace)
       else
@@ -51,11 +55,17 @@ module ActiveDocument
       SearchResults.new(@@ml_http.send_xquery(xquery))
     end
 
+      def self.execute_attribute_finder(element, attribute, value, root = nil, element_namespace = nil, attribute_namespace = nil, root_namespace = nil)
+      xquery = @@xquery_builder.find_by_attribute(element, attribute, value, root, element_namespace, attribute_namespace, root_namespace)
+      @@log.info("Finder.execute_attribute_finder at line #{__LINE__}: #{xquery}")
+      SearchResults.new(@@ml_http.send_xquery(xquery))
+    end
+
     def self.search(search_string, start = 1, page_length = 10, options = nil)
       start ||= 1
       page_length ||= 10
       search_text = @@xquery_builder.search(search_string, start, page_length, options)
-      SearchResults.new(@@ml_http.send_xquery(search_text)) # todo support options node
+      SearchResults.new(@@ml_http.send_xquery(search_text))
     end
 
     # returns a hash where the key is the terms of the co-occurrence separated by a | and the value is the frequency count

data/lib/ActiveDocument/mark_logic_query_builder.rb

@@ -13,7 +13,7 @@
 #   limitations under the License.
 
 module ActiveDocument
-
+# todo create new unit tests for this class - the old ones were no good
   class MarkLogicQueryBuilder
 
     def load(uri)
@@ -32,16 +32,16 @@ module ActiveDocument
          xdmp:default-permissions(),
          xdmp:default-collections())
 GENERATED
-      
+
     end
 
     # This method does a full text search
     def find_by_word(word, root, namespace)
-      xquery = <<GENERATED
-import module namespace search = "http://marklogic.com/appservices/search"at "/MarkLogic/appservices/search/search.xqy";
-search:search("#{word}",
-<options xmlns="http://marklogic.com/appservices/search">
-GENERATED
+      xquery = <<-GENERATED
+        import module namespace search = "http://marklogic.com/appservices/search"at "/MarkLogic/appservices/search/search.xqy";
+        search:search("#{word}",
+        <options xmlns="http://marklogic.com/appservices/search">
+        GENERATED
       unless root.nil?
         xquery << "<searchable-expression"
 
@@ -53,12 +53,35 @@ GENERATED
       xquery << "</options>)"
     end
 
-    def find_by_element(element, value, root = nil, element_namespace = nil, root_namespace = nil)
-      xquery = <<GENERATED
-import module namespace search = "http://marklogic.com/appservices/search"at "/MarkLogic/appservices/search/search.xqy";
-search:search("word:#{value}",
-<options xmlns="http://marklogic.com/appservices/search">
-GENERATED
+    def find_by_element(element, value, root, element_namespace, root_namespace)
+      xquery = <<-GENERATED
+        import module namespace search = "http://marklogic.com/appservices/search"at "/MarkLogic/appservices/search/search.xqy";
+        search:search("word:#{value}",
+        <options xmlns="http://marklogic.com/appservices/search">
+      GENERATED
+      unless root.nil?
+        xquery << "<searchable-expression"
+        xquery << "  xmlns:a=\"#{root_namespace}\"" unless root_namespace.nil?
+        xquery << '>/'
+        xquery << "a:" unless root_namespace.nil?
+        xquery << "#{root}</searchable-expression>"
+      end
+      xquery << <<-CONSTRAINT
+        <constraint name="word">
+        <word>
+        <element ns="#{element_namespace unless element_namespace.nil?}" name="#{element}"/>
+        </word>
+        </constraint></options>)
+      CONSTRAINT
+    end
+
+    def find_by_attribute(element, attribute, value, root, element_namespace, attribute_namespace, root_namespace)
+      # todo should the searchable expression portion be refactored?
+      xquery = <<-GENERATED
+        import module namespace search = "http://marklogic.com/appservices/search"at "/MarkLogic/appservices/search/search.xqy";
+        search:search("word:#{value}",
+        <options xmlns="http://marklogic.com/appservices/search">
+      GENERATED
       unless root.nil?
         xquery << "<searchable-expression"
         xquery << "  xmlns:a=\"#{root_namespace}\"" unless root_namespace.nil?
@@ -66,13 +89,14 @@ GENERATED
         xquery << "a:" unless root_namespace.nil?
         xquery << "#{root}</searchable-expression>"
       end
-      xquery << <<CONSTRAINT
-<constraint name="word">
-<word>
-<element ns="#{element_namespace unless element_namespace.nil?}" name="#{element}"/>
-</word>
-</constraint></options>)
-CONSTRAINT
+      xquery << <<-CONSTRAINT
+        <constraint name="word">
+        <word>
+          <attribute ns="#{attribute_namespace unless attribute_namespace.nil?}" name="#{attribute}"/>
+          <element ns="#{element_namespace unless element_namespace.nil?}" name="#{element}"/>
+        </word>
+        </constraint></options>)
+      CONSTRAINT
     end
 
     def search(search_text, start, page_length, options)

metadata

@@ -4,9 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  version: "0.5"
 platform: ruby
 authors: 
 - Clark D. Richey, Jr.
@@ -14,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-21 00:00:00 -07:00
+date: 2010-09-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,7 +39,6 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/active_document.rb
 - lib/ActiveDocument/active_document.rb
 - lib/ActiveDocument/finder.rb
 - lib/ActiveDocument/inheritable.rb
@@ -50,6 +48,7 @@ files:
 - lib/ActiveDocument/search_match.rb
 - lib/ActiveDocument/search_result.rb
 - lib/ActiveDocument/search_results.rb
+- lib/active_document.rb
 - lib/activedocument.rb
 has_rdoc: true
 homepage: http://github.com/crichey/ActiveDocument