rubydora 1.8.1 → 1.9.0

data/lib/rubydora/digital_object.rb

@@ -2,10 +2,10 @@ module Rubydora
 
   # This class represents a Fedora object and provides
   # helpers for managing attributes, datastreams, and
-  # relationships. 
+  # relationships.
   #
-  # Using the extension framework, implementors may 
-  # provide additional functionality to this base 
+  # Using the extension framework, implementors may
+  # provide additional functionality to this base
   # implementation.
   class DigitalObject
     extend ActiveModel::Callbacks
@@ -18,14 +18,14 @@ module Rubydora
     extend Deprecation
 
     attr_reader :pid
-    
+
     # mapping object parameters to profile elements
     OBJ_ATTRIBUTES = {:state => :objState, :ownerId => :objOwnerId, :label => :objLabel, :logMessage => nil, :lastModifiedDate => :objLastModDate, :createdDate => :objCreateDate }
 
     OBJ_DEFAULT_ATTRIBUTES = { }
 
     define_attribute_methods OBJ_ATTRIBUTES.keys
-      
+
     OBJ_ATTRIBUTES.each do |attribute, profile_name|
       class_eval <<-RUBY
       def #{attribute.to_s}
@@ -39,7 +39,7 @@ module Rubydora
       RUBY
     end
 
-    def state= val
+    def state=(val)
       raise ArgumentError, "Allowed values for state are 'I', 'A' and 'D'. You provided '#{val}'" unless ['I', 'A', 'D'].include?(val)
       state_will_change! unless val == state
       @state = val
@@ -49,8 +49,8 @@ module Rubydora
     #
     # @param [String] pid
     # @param [Rubydora::Repository] context
-    # @raise [RecordNotFound] if the record is not found in Fedora 
-    def self.find pid, repository = nil, options = {}
+    # @raise [RecordNotFound] if the record is not found in Fedora
+    def self.find(pid, repository = nil, options = {})
       obj = self.new pid, repository, options
       if obj.new?
         raise Rubydora::RecordNotFound, "DigitalObject.find called for an object that doesn't exist"
@@ -63,7 +63,7 @@ module Rubydora
     # @param [String] pid
     # @param [Rubydora::Repository] repository context
     # @param [Hash] options default attribute values (used esp. for creating new datastreams
-    def self.find_or_initialize *args
+    def self.find_or_initialize(*args)
       self.new *args
     end
 
@@ -71,7 +71,7 @@ module Rubydora
     # @param [String] pid
     # @param [Hash] options
     # @param [Rubydora::Repository] context
-    def self.create pid, options = {}, repository = nil
+    def self.create(pid, options = {}, repository = nil)
       repository ||= Rubydora.repository
       assigned_pid = repository.ingest(options.merge(:pid => pid))
 
@@ -83,11 +83,11 @@ module Rubydora
     # may not already exist in the data store.
     #
     # Provides `after_initialize` callback for extensions
-    # 
+    #
     # @param [String] pid
     # @param [Rubydora::Repository] repository context
     # @param [Hash] options default attribute values (used esp. for creating new datastreams
-    def initialize pid, repository = nil, options = {}
+    def initialize(pid, repository = nil, options = {})
       run_callbacks :initialize do
         self.pid = pid
         @repository = repository
@@ -103,7 +103,6 @@ module Rubydora
       @audit_trail ||= repository.audit_trail(self.pid)
     end
 
-
     ##
     # Return a full uri pid (for use in relations, etc
     def uri
@@ -119,15 +118,15 @@ module Rubydora
     end
     alias :new? :new_record?
 
-    def asOfDateTime asOfDateTime = nil
-      if asOfDateTime == nil
+    def asOfDateTime(asOfDateTime = nil)
+      if asOfDateTime.nil?
         return @asOfDateTime
       end
 
-      return self.class.new(pid, @repository, @options.merge(:asOfDateTime => asOfDateTime))
+      self.class.new(pid, @repository, @options.merge(:asOfDateTime => asOfDateTime))
     end
 
-    def asOfDateTime= val
+    def asOfDateTime=(val)
       @asOfDateTime = val
     end
 
@@ -142,16 +141,15 @@ module Rubydora
 
     def versions
       repository.versions_for_object(pid).map do |changeDate|
-        self.class.new pid, repository, :asOfDateTime => changeDate 
+        self.class.new pid, repository, :asOfDateTime => changeDate
       end
     end
 
-
     # List of datastreams
-    # @return [Array<Rubydora::Datastream>] 
+    # @return [Array<Rubydora::Datastream>]
     def datastreams
       @datastreams ||= begin
-        h = Hash.new { |h,k| h[k] = datastream_object_for(k) }                
+        h = Hash.new { |h,k| h[k] = datastream_object_for(k) }
 
         begin
           options = { :pid => pid, :profiles => 'true' }
@@ -160,8 +158,8 @@ module Rubydora
           # pre-3.6, the profiles parm will be ignored
           datastreams_xml.gsub! '<objectDatastreams', '<objectDatastreams xmlns="http://www.fedora.info/definitions/1/0/access/"' unless datastreams_xml =~ /xmlns=/
           doc = Nokogiri::XML(datastreams_xml)
-          doc.xpath('//access:datastream', {'access' => "http://www.fedora.info/definitions/1/0/access/"}).each do |ds| 
-            h[ds['dsid']] = datastream_object_for ds['dsid'] 
+          doc.xpath('//access:datastream', {'access' => "http://www.fedora.info/definitions/1/0/access/"}).each do |ds|
+            h[ds['dsid']] = datastream_object_for ds['dsid']
           end
           # post-3.6, full ds profiles will be returned
           doc.xpath('//access:datastreamProfile', {'access' => "http://www.fedora.info/definitions/1/0/access/"}).each do |ds|
@@ -176,18 +174,18 @@ module Rubydora
     end
     alias_method :datastream, :datastreams
 
-    # provide an hash-like way to access datastreams 
-    def fetch dsid
+    # provide an hash-like way to access datastreams
+    def fetch(dsid)
       datastreams[dsid]
     end
     alias_method :[], :fetch
 
-    # persist the object to Fedora, either as a new object 
+    # persist the object to Fedora, either as a new object
     # by modifing the existing object
     #
-    # also will save all `:changed?` datastreams that already exist 
+    # also will save all `:changed?` datastreams that already exist
     # new datastreams must be directly saved
-    # 
+    #
     # @return [Rubydora::DigitalObject] a new copy of this object
     def save
       check_if_read_only
@@ -196,7 +194,7 @@ module Rubydora
         if self.new?
           self.pid = repository.ingest to_api_params.merge(:pid => pid)
           @profile = nil #will cause a reload with updated data
-        else                       
+        else
           p = to_api_params
           unless p.empty?
             mod_time = repository.modify_object p.merge(:pid => pid)
@@ -237,11 +235,11 @@ module Rubydora
     # set the pid of the object
     # @param [String] pid
     # @return [String] the base pid
-    def pid= pid=nil
+    def pid=(pid=nil)
       @pid = pid.gsub('info:fedora/', '') if pid
     end
 
-    # datastream parameters 
+    # datastream parameters
     # @return [Hash]
     def to_api_params
       h = default_api_params
@@ -261,7 +259,7 @@ module Rubydora
     # instantiate a datastream object for a dsid
     # @param [String] dsid
     # @return [Datastream]
-    def datastream_object_for dsid, options = {}
+    def datastream_object_for(dsid, options = {})
       options[:asOfDateTime] ||= asOfDateTime if asOfDateTime
       Datastream.new self, dsid, options
     end
@@ -271,7 +269,7 @@ module Rubydora
     end
 
     private
-    def attribute_will_change! *args
+    def attribute_will_change!(*args)
       check_if_read_only
       super
     end

data/lib/rubydora/fc3_service.rb

@@ -23,28 +23,24 @@ module Rubydora
       end
     end
 
-
     # repository profile (from API-A-LITE data)
     # @return [Hash]
     def repository_profile
-      begin
-        profile_xml = self.describe.strip
-        h = ProfileParser.parse_repository_profile(profile_xml)
-        h.select { |key, value| value.length == 1 }.each do |key, value|
-          next if key == "objModels"
-          h[key] = value.first
-        end
-
-        h
-      rescue
-        nil
+      profile_xml = self.describe.strip
+      h = ProfileParser.parse_repository_profile(profile_xml)
+      h.select { |key, value| value.length == 1 }.each do |key, value|
+        next if key == 'objModels'
+        h[key] = value.first
       end
+      h
+    rescue
+      nil
     end
 
     def object_profile(pid, asOfDateTime = nil)
       options = {pid: pid}
       options[:asOfDateTime] = asOfDateTime if asOfDateTime
-      begin 
+      begin
         xml = object(options)
         ProfileParser.parse_object_profile(xml)
       rescue RestClient::ResourceNotFound
@@ -54,7 +50,7 @@ module Rubydora
 
     def datastream_profile(pid, dsid, validateChecksum, asOfDateTime = nil)
       xml = begin
-        options = { pid: pid, dsid: dsid}
+        options = {pid: pid, dsid: dsid}
         options[:validateChecksum] = validateChecksum if validateChecksum
         options[:asOfDateTime] = asOfDateTime if asOfDateTime
         options[:validateChecksum] = true if config[:validateChecksum]

data/lib/rubydora/fedora_url_helpers.rb

@@ -2,17 +2,17 @@ module Rubydora
   module FedoraUrlHelpers
     # Fedora API documentation available at {https://wiki.duraspace.org/display/FCR30/REST+API}
     API_DOCUMENTATION = 'https://wiki.duraspace.org/display/FCR30/REST+API'
-    
-    # Generate a REST API compatible URI 
+
+    # Generate a REST API compatible URI
     # @param [String] base base URI
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def url_for base, options = nil
+    def url_for(base, options = nil)
       return base unless options.is_a? Hash
-      "#{base}" + (("?#{options.map { |key, value|  "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}"}.join("&")  }" if options and not options.empty?) || '')
+      "#{base}" + (("?#{options.map { |key, value|  "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}"}.join("&")  }" if options && !options.empty?) || '')
     end
 
-    def describe_repository_url options = nil
+    def describe_repository_url(options = nil)
       url_for("describe", options)
     end
 
@@ -20,23 +20,23 @@ module Rubydora
     # @param [String] pid
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def object_url pid, options = nil
+    def object_url(pid, options = nil)
       url_for("objects" + (("/#{CGI::escape(pid.to_s.gsub('info:fedora/', ''))}" if pid) || ''), options)
     end
 
-    def new_object_url options = nil
+    def new_object_url(options = nil)
       object_url "new", options
     end
 
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def next_pid_url options = nil
+    def next_pid_url(options = nil)
       url_for("objects/nextPID", options)
     end
 
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def find_objects_url options = nil
+    def find_objects_url(options = nil)
       url_for("objects", options)
     end
 
@@ -46,7 +46,7 @@ module Rubydora
     # @param [String] method
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def dissemination_url pid, sdef = nil, method = nil, options = nil
+    def dissemination_url(pid, sdef = nil, method = nil, options = nil)
       raise ArgumentError, "You must provide a pid" unless pid
       url_for(object_url(pid) + "/methods" +  (("/#{CGI::escape(sdef)}" if sdef) || '') +  (("/#{CGI::escape(method)}" if method) || ''), options)
     end
@@ -56,18 +56,17 @@ module Rubydora
     # @param [String] dsid
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def datastream_url pid, dsid, options = nil
-      raise ArgumentError, "You must provide a pid and a dsid" unless pid and dsid
+    def datastream_url(pid, dsid, options = nil)
+      raise ArgumentError, "You must provide a pid and a dsid" unless pid && dsid
       url_for(object_url(pid) + "/datastreams/#{CGI::escape(dsid)}", options)
     end
 
-
     # Generate a base datastream REST API endpoint URI
     # @param [String] pid
     # @param [String] dsid
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def datastreams_url pid, options = nil
+    def datastreams_url(pid, options = nil)
       raise ArgumentError, "You must provide a pid" unless pid
       url_for(object_url(pid) + "/datastreams", options)
     end
@@ -76,7 +75,7 @@ module Rubydora
     # @param [String] dsid
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def datastream_content_url pid, dsid = nil, options = nil
+    def datastream_content_url(pid, dsid = nil, options = nil)
       url_for(datastream_url(pid, dsid) +  "/content", options)
     end
 
@@ -84,49 +83,49 @@ module Rubydora
     # @param [String] dsid
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def datastream_history_url pid, dsid = nil, options = nil
+    def datastream_history_url(pid, dsid = nil, options = nil)
       url_for(datastream_url(pid, dsid) +  "/history", options)
     end
 
     # @param [String] pid
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def validate_object_url pid, options = nil
+    def validate_object_url(pid, options = nil)
       url_for(object_url(pid) + "/validate", options)
     end
 
     # @param [String] pid
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def export_object_url pid, options = nil
+    def export_object_url(pid, options = nil)
       url_for(object_url(pid) + "/export", options)
     end
 
     # @param [String] pid
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def object_versions_url pid, options = nil
+    def object_versions_url(pid, options = nil)
       url_for(object_url(pid) + "/versions", options)
     end
 
     # @param [String] pid
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def object_xml_url pid, options = nil
+    def object_xml_url(pid, options = nil)
       url_for(object_url(pid) + "/objectXML", options)
     end
 
     # @param [String] pid
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def object_relationship_url pid, options = nil
+    def object_relationship_url(pid, options = nil)
       url_for(object_url(pid) + "/relationships", options)
     end
 
     # @param [String] pid
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def new_object_relationship_url pid, options = nil
+    def new_object_relationship_url(pid, options = nil)
       url_for(object_relationship_url(pid) + "/new", options)
     end
   end

data/lib/rubydora/models_mixin.rb

@@ -4,18 +4,18 @@ module Rubydora
   # FIXME: Ruby 1.9 provides instance_exec, which should make it
   # possible to subsume this into Rubydora::RelationshipsMixin
   module ModelsMixin
- 
+
     # Provides an accessor to the object content models
     # @param [Hash] args
     # @option args [Array] :values if nil, will query the resource index for related objects
-    # @return [ArrayWithCallback<Rubydora::DigitalObject>] an array that will call the #relationship_changed callback when values are modified 
-    def models args = {}
+    # @return [ArrayWithCallback<Rubydora::DigitalObject>] an array that will call the #relationship_changed callback when values are modified
+    def models(args = {})
       @models = nil if args.delete(:refetch)
       @models ||= relationship('info:fedora/fedora-system:def/model#hasModel', :values => args[:values] || profile['objModels'] || [])
     end
 
     # provides a setter that behaves as does #models
-    def models= arr
+    def models=(arr)
       arr &&= [arr] unless arr.is_a? Array
       old = models.dup || []
       arr = @models = relationship('info:fedora/fedora-system:def/model#hasModel', :values => arr.flatten)

data/lib/rubydora/profile_parser.rb

@@ -1,6 +1,6 @@
 module Rubydora
   module ProfileParser
-    def self.parse_datastream_profile profile_xml
+    def self.parse_datastream_profile(profile_xml)
       # since the profile may be in the management or the access namespace, use the CSS selector
       ndoc = Nokogiri::XML(profile_xml)
       doc = (ndoc.name == 'datastreamProfile') ? ndoc : ndoc.css('datastreamProfile').first
@@ -12,24 +12,24 @@ module Rubydora
       end
     end
 
-    def self.hash_datastream_profile_node doc
+    def self.hash_datastream_profile_node(doc)
       h = doc.xpath('./*').inject({}) do |sum, node|
                    sum[node.name] ||= []
                    sum[node.name] << node.text
                    sum
-                 end.reject { |key, values| values.nil? or values.empty? }
+                 end.reject { |key, values| values.nil? || values.empty? }
       h.select { |key, values| values.length == 1 }.each do |key, values|
-        h[key] = values.reject { |x| x.empty? }.first 
+        h[key] = values.reject { |x| x.empty? }.first
       end
 
       h['dsSize'] &&= h['dsSize'].to_i rescue h['dsSize']
       h['dsCreateDate'] &&= Time.parse(h['dsCreateDate']) rescue h['dsCreateDate']
-      h['dsChecksumValid'] &&= h['dsChecksumValid'] == 'true' 
-      h['dsVersionable'] &&= h['dsVersionable'] == 'true' 
+      h['dsChecksumValid'] &&= h['dsChecksumValid'] == 'true'
+      h['dsVersionable'] &&= h['dsVersionable'] == 'true'
       h.with_indifferent_access
     end
 
-    def self.parse_object_profile profile_xml
+    def self.parse_object_profile(profile_xml)
       profile_xml.gsub! '<objectProfile', '<objectProfile xmlns="http://www.fedora.info/definitions/1/0/access/"' unless profile_xml =~ /xmlns=/
       doc = Nokogiri::XML(profile_xml)
       h = doc.xpath('/access:objectProfile/*', {'access' => "http://www.fedora.info/definitions/1/0/access/"} ).inject({}) do |sum, node|
@@ -50,7 +50,7 @@ module Rubydora
       h.with_indifferent_access
     end
 
-    def self.parse_repository_profile profile_xml
+    def self.parse_repository_profile(profile_xml)
       profile_xml.gsub! '<fedoraRepository', '<fedoraRepository xmlns="http://www.fedora.info/definitions/1/0/access/"' unless profile_xml =~ /xmlns=/
       doc = Nokogiri::XML(profile_xml)
       xmlns = { 'access' => "http://www.fedora.info/definitions/1/0/access/"  }