pg-xml 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7fafbeb6bb53498ffc42dd1efe5d683c451a28c
+  data.tar.gz: cf61d5ecfe41b83d6835cd251152b2551403747a
+SHA512:
+  metadata.gz: de4899da7e8003a8b68fdad57419f9d8a2049ba5c579bc270aa0447570db23c4741d2618637970959ef7aa6c93f26e5afefae83da8d641bed56aec706b01da60
+  data.tar.gz: c44359eba77634a371d44f581b652d6a6f0b5772b511327a54251e1bc5887c9e87a25b13a3509a9ae1f3f455286e266b3af1eec1f911f8c245afaf0406140f7f

data/lib/pg-xml/activerecord.rb

@@ -0,0 +1,85 @@
+# use, e.g.,
+#   has_xml_column :properties
+# in your ActiveRecord model
+
+# in a migration, use e.g.
+#   add_xpath_index :users, :properties, '/xml/first_name'
+# to index into the XML
+
+module ActiveRecord
+
+  class Base
+    
+    # define the has_xml_column :col_name name
+    def self.has_xml_column attr_name
+      
+      # serialize using the custom serializer
+      serialize attr_name, ActiveRecord::Coders::XML
+      # validate XML before saving
+      validate "validate_#{attr_name}_xml"
+      
+      # define the attribute writer to accept a string
+      # and convert it to XML
+      define_method("#{attr_name}=") do |val|
+        if val.is_a? String
+          val = PgXML.load(val)
+        end
+        self[attr_name] = val
+      end
+      
+      # validate XML before writing to database
+      define_method("validate_#{attr_name}_xml") do
+        # TODO make this work with hpricot
+        return true if self[attr_name].nil? || self[attr_name].errors == []
+        self[attr_name].errors.each do |e|
+          errors.add(attr_name, e.to_s)
+        end
+        return false
+      end
+      
+    end
+  end
+
+  # support the add_xpath_index and make it reversible
+  module ConnectionAdapters
+    module SchemaStatements
+    
+      # enable adding an xpath index
+      def add_xpath_index table_name, column_name, path, index_name=nil
+        # generate an index name
+        index_name ||= "index_#{table_name}_on_#{column_name}__#{path}"
+        index_name = index_name.downcase.gsub(/[^a-z0-9]/, '_')
+
+        # create the index
+        execute "CREATE INDEX #{index_name} ON #{table_name}(xpath('#{path}',#{column_name}))"
+      end
+
+    
+      # can call in any of the following ways
+      # remove_xpath_index :users, :properties, '/xml/name'
+      # remove_xpath_index :index_users_on_properties__xml_name
+      # remove_xpath_index :users, :properties, '/xml/name', :index_users_on_properties__xml_name
+      def remove_xpath_index index_name_or_table_name, column_name=nil, path=nil, index_name=nil
+        # figure out which version was called
+        index_name = index_name_or_table_name if !column_name
+
+        # transform index name
+        index_name ||= "index_#{table_name}_on_#{column_name}__#{path}"
+        index_name = index_name.downcase.gsub(/[^a-z0-9]/, '_')
+      
+        # drop the index
+        execute "DROP INDEX #{index_name}"
+      end
+      
+      # TODO this doesn't get called -- why?
+      # adding the xpath index should be reversible
+      def invert_add_xpath_index(args)
+        # table_name, column_name, path, index_name = *args
+        # [:remove_index, [table_name, column_name, path, index_name]]
+        [:remove_xpath_index, args]
+      end
+      
+    end
+  end
+  
+end

data/lib/pg-xml/coder.rb

@@ -0,0 +1,28 @@
+module ActiveRecord
+  module Coders
+    class XML
+      
+      def self.load(xml_string)
+        new(PgXML.default).load(xml_string)
+      end
+
+      def self.dump(xml_document)
+        new(PgXML.default).dump(xml_document)
+      end
+
+      def initialize(default=nil)
+        @default=default
+      end
+
+      def dump(xml_document)
+        (xml_document.nil? && @default.nil?) ? nil : PgXML.dump( xml_document || @default )
+      end
+
+      def load(xml_string)
+        xml_string.nil? ? @default : PgXML.load(xml_string)
+      end
+
+    end
+  end
+end
+

data/lib/pg-xml/pg_xml.rb

@@ -0,0 +1,38 @@
+# note: none of this is tested against Hpricot
+# the goal was to allow either hpricot or nokogiri, but
+# support for "using either" is half-assed at best
+
+module PgXML
+  
+  # complex line of code determining whether we have access to nokogiri or hpricot.
+  XML_PARSER_TYPE = ( require('nokogiri') || true rescue          # evaluates to true if we have nokogiri
+                      require('hpricot') && false rescue          # evaluates to valse if we have hpricot
+                      raise LoadError, "Either nokogiri or hpricot is required" # raises an error if we have neither
+                    ) ? :nokogiri : :hpricot
+  
+  # get which XML parser we are using
+  def self.parser_type
+    XML_PARSER_TYPE
+  end
+  
+  def self.load xml_str
+    parse xml_str
+  end
+  
+  def self.dump xml_document
+    xml_document.to_s
+  end
+  
+  # Valid xml requires a root node.
+  def self.default
+    parse '<xml></xml>'
+  end
+  
+  # use our parser to create an XML document
+  # warning: nokogiri is friendly -- if you feed it invalid XML it will fail silently
+  # Nokogiri::XML.parse('<xml><xml>').to_s ~> <xml><xml/></xml>
+  def self.parse xml_str
+    XML_PARSER_TYPE == :nokogiri ? Nokogiri::XML.parse(xml_str) : Hpricot(xml_str)
+  end
+                   
+end

data/lib/pg-xml.rb

@@ -0,0 +1,7 @@
+require 'active_support'
+
+# ActiveSupport.on_load :active_record do
+require "pg-xml/pg_xml"
+require "pg-xml/coder"
+require "pg-xml/activerecord"
+# end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: pg-xml
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kai Stinchcombe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: postgresql xml datatype support for activerecord -- heavily based on
+  pg-hstore and activerecord-postgres-hstore
+email:
+- k@i.stinchcom.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pg-xml.rb
+- lib/pg-xml/activerecord.rb
+- lib/pg-xml/coder.rb
+- lib/pg-xml/pg_xml.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/pg-xml
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: postgresql xml datatype support for activerecord -- heavily based on pg-hstore
+  and activerecord-postgres-hstore
+test_files: []