sequel 4.36.0 → 5.61.0

data/lib/sequel/plugins/xml_serializer.rb

@@ -23,15 +23,15 @@ module Sequel
     #
     # You can provide options to control the XML output:
     #
-    #   puts album.to_xml(:only=>:name)
-    #   puts album.to_xml(:except=>[:id, :artist_id])
+    #   puts album.to_xml(only: :name)
+    #   puts album.to_xml(except: [:id, :artist_id])
     #   # Output:
     #   # <?xml version="1.0"?>
     #   # <album>
     #   #   <name>RF</name>
     #   # </album>
     #
-    #   album.to_xml(:include=>:artist)
+    #   album.to_xml(include: :artist)
     #   # Output:
     #   # <?xml version="1.0"?>
     #   # <album>
@@ -47,7 +47,7 @@ module Sequel
     # You can use a hash value with <tt>:include</tt> to pass options
     # to associations:
     #
-    #   album.to_xml(:include=>{:artist=>{:only=>:name}})
+    #   album.to_xml(include: {artist: {only: :name}})
     #   # Output:
     #   # <?xml version="1.0"?>
     #   # <album>
@@ -63,12 +63,12 @@ module Sequel
     # of which return all objects in the dataset:
     #
     #   Album.to_xml
-    #   Album.filter(:artist_id=>1).to_xml(:include=>:tags)
+    #   Album.where(artist_id: 1).to_xml(include: :tags)
     #
     # If you have an existing array of model instances you want to convert to
     # XML, you can call the class to_xml method with the :array option:
     #
-    #   Album.to_xml(:array=>[Album[1], Album[2]])
+    #   Album.to_xml(array: [Album[1], Album[2]])
     #
     # In addition to creating XML, this plugin also enables Sequel::Model
     # classes to create instances directly from XML using the from_xml class
@@ -80,7 +80,7 @@ module Sequel
     # The array_from_xml class method exists to parse arrays of model instances
     # from xml:
     #
-    #   xml = Album.filter(:artist_id=>1).to_xml
+    #   xml = Album.where(artist_id: 1).to_xml
     #   albums = Album.array_from_xml(xml)
     #
     # These does not necessarily round trip, since doing so would let users
@@ -89,7 +89,7 @@ module Sequel
     # fields, you can use the :fields option, which will call set_fields with
     # the given fields:
     #
-    #   Album.from_xml(album.to_xml, :fields=>%w'id name')
+    #   Album.from_xml(album.to_xml, fields: %w'id name')
     #
     # If you want to update an existing instance, you can use the from_xml
     # instance method:
@@ -99,11 +99,11 @@ module Sequel
     # Both of these allow creation of cached associated objects, if you provide
     # the :associations option:
     #
-    #   album.from_xml(xml, :associations=>:artist)
+    #   album.from_xml(xml, associations: :artist)
     #
     # You can even provide options when setting up the associated objects:
     #
-    #   album.from_xml(xml, :associations=>{:artist=>{:fields=>%w'id name', :associations=>:tags}})
+    #   album.from_xml(xml, associations: {artist: {fields: %w'id name', associations: :tags}})
     #
     # Usage:
     #
@@ -115,17 +115,17 @@ module Sequel
     module XmlSerializer
       module ClassMethods
         # Proc that camelizes the input string, used for the :camelize option
-        CAMELIZE = proc(&:camelize)
+        CAMELIZE = :camelize.to_proc
 
         # Proc that dasherizes the input string, used for the :dasherize option
-        DASHERIZE = proc(&:dasherize)
+        DASHERIZE = :dasherize.to_proc
 
         # Proc that returns the input string as is, used if
         # no :name_proc, :dasherize, or :camelize option is used.
         IDENTITY = proc{|s| s}
 
         # Proc that underscores the input string, used for the :underscore option
-        UNDERSCORE = proc(&:underscore)
+        UNDERSCORE = :underscore.to_proc
 
         # Return an array of instances of this class based on
         # the provided XML.
@@ -137,28 +137,27 @@ module Sequel
           node.children.reject{|c| c.is_a?(Nokogiri::XML::Text)}.map{|c| from_xml_node(c, opts)}
         end
 
-        # Return an instance of this class based on the provided
-        # XML.
+        # Return an instance of this class based on the provided XML.
         def from_xml(xml, opts=OPTS)
           from_xml_node(Nokogiri::XML(xml).children.first, opts)
         end
 
         # Return an instance of this class based on the given
         # XML node, which should be Nokogiri::XML::Node instance.
-        # This should probably not be used directly by user code.
+        # This should not be used directly by user code.
         def from_xml_node(parent, opts=OPTS)
           new.from_xml_node(parent, opts)
         end
 
         # Return an appropriate Nokogiri::XML::Builder instance
-        # used to create the XML.  This should probably not be used
+        # used to create the XML.  This should not be used
         # directly by user code.
         def xml_builder(opts=OPTS)
           if opts[:builder]
             opts[:builder]
           else
             builder_opts = if opts[:builder_opts]
-              opts[:builder_opts]
+              Hash[opts[:builder_opts]]
             else
               {}
             end
@@ -169,7 +168,7 @@ module Sequel
 
         # Return a proc (or any other object that responds to []),
         # used for formatting XML tag names when serializing to XML.
-        # This should probably not be used directly by user code.
+        # This should not be used directly by user code.
         def xml_deserialize_name_proc(opts=OPTS)
           if opts[:name_proc]
             opts[:name_proc]
@@ -182,7 +181,7 @@ module Sequel
 
         # Return a proc (or any other object that responds to []),
         # used for formatting XML tag names when serializing to XML.
-        # This should probably not be used directly by user code.
+        # This should not be used directly by user code.
         def xml_serialize_name_proc(opts=OPTS)
           pr = if opts[:name_proc]
             opts[:name_proc]
@@ -234,10 +233,10 @@ module Sequel
           if assocs = opts[:associations]
             assocs = case assocs
             when Symbol
-              {assocs=>{}}
+              {assocs=>OPTS}
             when Array
               assocs_tmp = {}
-              assocs.each{|v| assocs_tmp[v] = {}}
+              assocs.each{|v| assocs_tmp[v] = OPTS}
               assocs_tmp
             when Hash
               assocs
@@ -343,24 +342,24 @@ module Sequel
 
           name_proc = model.xml_serialize_name_proc(opts)
           x = model.xml_builder(opts)
-          x.send(name_proc[opts.fetch(:root_name, model.send(:underscore, model.name).gsub('/', '__')).to_s]) do |x1|
+          x.public_send(name_proc[opts.fetch(:root_name, model.send(:underscore, model.name).gsub('/', '__')).to_s]) do |x1|
             cols.each do |c|
               attrs = {}
               if types
-                attrs[:type] = db_schema.fetch(c, {})[:type]
+                attrs[:type] = db_schema.fetch(c, OPTS)[:type]
               end
               v = vals[c]
               if v.nil?
                 attrs[:nil] = ''
               end
-              x1.send(name_proc[c.to_s], v, attrs)
+              x1.public_send(name_proc[c.to_s], v, attrs)
             end
             if inc.is_a?(Hash)
               inc.each{|k, v| to_xml_include(x1, k, v)}
             else
               Array(inc).each{|i| to_xml_include(x1, i)}
             end
-            yield x1 if block_given?
+            yield x1 if defined?(yield)
           end
           x.to_xml
         end
@@ -371,15 +370,15 @@ module Sequel
         # the xml.
         def to_xml_include(node, i, opts=OPTS)
           name_proc = model.xml_serialize_name_proc(opts)
-          objs = send(i)
+          objs = public_send(i)
           if objs.is_a?(Array) && objs.all?{|x| x.is_a?(Sequel::Model)}
-            node.send(name_proc[i.to_s]) do |x2|
+            node.public_send(name_proc[i.to_s]) do |x2|
               objs.each{|obj| obj.to_xml(opts.merge(:builder=>x2))}
             end
           elsif objs.is_a?(Sequel::Model)
             objs.to_xml(opts.merge(:builder=>node, :root_name=>i))
           else
-            node.send(name_proc[i.to_s], objs)
+            node.public_send(name_proc[i.to_s], objs)
           end
         end
       end
@@ -390,7 +389,7 @@ module Sequel
         # as well as the :array_root_name option for specifying the name of
         # the root node that contains the nodes for all of the instances.
         def to_xml(opts=OPTS)
-          raise(Sequel::Error, "Dataset#to_xml") unless row_proc
+          raise(Sequel::Error, "Dataset#to_xml") unless row_proc || @opts[:eager_graph]
           x = model.xml_builder(opts)
           name_proc = model.xml_serialize_name_proc(opts)
           array = if opts[:array]
@@ -399,7 +398,7 @@ module Sequel
           else
             all
           end
-          x.send(name_proc[opts.fetch(:array_root_name, model.send(:pluralize, model.send(:underscore, model.name))).to_s]) do |x1|
+          x.public_send(name_proc[opts.fetch(:array_root_name, model.send(:pluralize, model.send(:underscore, model.name))).to_s]) do |x1|
             array.each do |obj|
               obj.to_xml(opts.merge(:builder=>x1))
             end