infopark_cloud_connector 6.8.0.210.ed204b0 → 6.8.0.322.c003f11

data/lib/rails_connector/obj.rb

@@ -4,13 +4,13 @@ require 'kvom'
 
 module RailsConnector
   # The CMS file class
+  # @api public
   class Obj
     extend ActiveModel::Naming
     include Kvom::ModelIdentity
 
     include DateAttribute
     include SEO
-    include ObjBody
 
     # Create a new Obj instance with the given values and attributes.
     # Normally this method should not be used.
@@ -25,11 +25,12 @@ module RailsConnector
 
     # instantiate an Obj instance from obj_data.
     # May result in an instance of a subclass of Obj according to STI rules.
-    def self.instantiate(obj_data) # :nodoc:
+    def self.instantiate(obj_data)
       obj_class = obj_data.value_of("_obj_class")
       Obj.compute_type(obj_class).new(obj_data)
     end
 
+    # @api public
     def id
       read_attribute('_id')
     end
@@ -38,6 +39,7 @@ module RailsConnector
 
     # Find an Obj by it's id.
     # If the paremeter is an Array containing ids, return a list of corresponding Objs.
+    # @api public
     def self.find(id_or_list)
       case id_or_list
       when Array
@@ -51,23 +53,24 @@ module RailsConnector
     # (notice: not yet implemented)
     # Returns a list of all Objs.
     # If invoked on a subclass of Obj, the result will be restricted to Obj of that subclass.
-    def self.all # :nodoc:
+    def self.all
       raise "not yet implemented!"
     end
 
     # (notice: not yet implemented)
     # returns an Array of all Objs with the given obj_class.
-    def self.find_all_by_obj_class(obj_class) # :nodoc:
+    def self.find_all_by_obj_class(obj_class)
       raise "not yet implemented!"
     end
 
     # Find the Obj with the given path.
     # Returns nil if no matching Obj exists.
+    # @api public
     def self.find_by_path(path)
       find_objs_by(:path, [path]).first.first
     end
 
-    def self.find_many_by_paths(pathes) # :nodoc:
+    def self.find_many_by_paths(pathes)
       find_objs_by(:path, pathes).map(&:first)
     end
 
@@ -75,22 +78,24 @@ module RailsConnector
     # Find an Obj with the given name.
     # If several Objs exist with the given name, one of them is chosen and returned.
     # If no Obj with the name exits, nil is returned.
-    def self.find_by_name(name) # :nodoc:
+    def self.find_by_name(name)
       raise "not yet implemented!"
     end
 
     # (notice: not yet implemented)
     # Find all Objs with the given name.
-    def self.find_all_by_name(name) # :nodoc:
+    def self.find_all_by_name(name)
       raise "not yet implemented!"
     end
 
     # Return the Obj with the given permalink or nil if no matching Obj exists.
+    # @api public
     def self.find_by_permalink(permalink)
       find_objs_by(:permalink, [permalink]).first.first
     end
 
     # Return the Obj with the given permalink or raise ResourceNotFound if no matching Obj exists.
+    # @api public
     def self.find_by_permalink!(permalink)
       find_by_permalink(permalink) or
         raise ResourceNotFound, "Could not find #{self} with permalink '#{permalink}'"
@@ -98,17 +103,17 @@ module RailsConnector
 
     # accepts the name of an "obj_by" - view and a list of keys.
     # returns a list of lists of Objs: a list of Objs for each given keys.
-    def self.find_objs_by(view, keys) # :nodoc:
+    def self.find_objs_by(view, keys)
       CmsBackend.find_obj_data_by(Workspace.current.data, view, keys).map do |list|
         list.map { |obj_data| Obj.instantiate(obj_data) }
       end
     end
 
-    def to_param # :nodoc:
+    def to_param
       id
     end
 
-    def self.configure_for_content(mode) # :nodoc:
+    def self.configure_for_content(mode)
       # this method exists only for compatibility with the fiona connector.
     end
 
@@ -120,21 +125,23 @@ module RailsConnector
     # * An invalid model name
     #
     # Rails' STI mechanism only considers the first case.
-    # In any other case, RailsConnector::Obj is used, except when explicitely asked
+    # In any other case, RailsConnector::Obj is used, except when explicitly asked
     # for a model in the RailsConnector namespace (RailsConnector::Permission etc.)
 
-    def self.compute_type(type_name) # :nodoc:
+    def self.compute_type(type_name)
       @compute_type_cache ||= {}
       @compute_type_cache [type_name] ||= try_type { type_name.constantize } || self
     end
 
     # return the Obj that is the parent of this Obj.
     # returns nil for the root Obj.
+    # @api public
     def parent
       root? ? nil : Obj.find_by_path(parent_path)
     end
 
     # Returns an Array of all the ancestor objects, starting at the root and ending at this object's parent.
+    # @api public
     def ancestors
       return [] if root?
       ancestor_paths = parent_path.scan(/\/[^\/]+/).inject([""]) do |list, component|
@@ -145,6 +152,7 @@ module RailsConnector
     end
 
     # return a list of all child Objs.
+    # @api public
     def children
       Obj.find_objs_by(:ppath, [path]).first
     end
@@ -152,11 +160,13 @@ module RailsConnector
     ### ATTRIBUTES #################
 
     # returns the Obj's path as a String.
+    # @api public
     def path
       read_attribute('_path') or raise "Obj without path"
     end
 
     # returns the Obj's name, i.e. the last component of the path.
+    # @api public
     def name
       if root?
         ""
@@ -189,17 +199,20 @@ module RailsConnector
     end
 
     # Returns the root Obj, i.e. the Obj with the path "/"
+    # @api public
     def self.root
       Obj.find_by_path("/") or raise ResourceNotFound, "Obj.root not found: There is no Obj with path '/'."
     end
 
     # Returns the homepage object. This can be overwritten in your application's +ObjExtensions+.
     # Use <tt>Obj#homepage?</tt> to check if an object is the homepage.
+    # @api public
     def self.homepage
       root
     end
 
     # returns the obj's permalink.
+    # @api public
     def permalink
       read_attribute('_permalink')
     end
@@ -208,6 +221,7 @@ module RailsConnector
     # By default a controller matching the Obj's obj_class will be used.
     # If the controller does not exist, the CmsController will be used as a fallback.
     # Overwrite this method to force a different controller to be used.
+    # @api public
     def controller_name
       obj_class
     end
@@ -215,20 +229,24 @@ module RailsConnector
     # This method determines the action that should be invoked when the Obj is requested.
     # The default action is 'index'.
     # Overwrite this method to force a different action to be used.
+    # @api public
     def controller_action_name
       "index"
     end
 
     # Returns true if the current object is the homepage object.
+    # @api public
     def homepage?
       self == self.class.homepage
     end
 
     # Returns the title of the content or the name.
+    # @api public
     def display_title
       self.title || name
     end
 
+    # @api public
     def title
       read_attribute('title')
     end
@@ -264,6 +282,7 @@ module RailsConnector
     end
 
     # Returns true if this object is active (time_when is in object's time interval)
+    # @api public
     def active?(time_when = nil)
       return false unless valid_from
       time_then = time_when || Obj.preview_time
@@ -271,7 +290,7 @@ module RailsConnector
     end
 
     # compatibility with legacy apps.
-    def suppress_export # :nodoc:
+    def suppress_export
       suppressed? ? 1 : 0
     end
 
@@ -307,12 +326,14 @@ module RailsConnector
     end
 
     # Returns true if this object is the root object.
+    # @api public
     def root?
       path == "/"
     end
 
     # Returns a list of exportable? children excluding the binary? ones unless :all is specfied.
     # This is mainly used for navigations.
+    # @api public
     def toclist(*args)
       return [] unless publication?
       time = args.detect {|value| value.kind_of? Time}
@@ -322,6 +343,7 @@ module RailsConnector
     end
 
     # Returns the sorted +toclist+, respecting sort order and type of this Obj.
+    # @api public
     def sorted_toclist(*args)
       list = self.toclist(*args)
       return [] if list.blank?
@@ -353,36 +375,37 @@ module RailsConnector
       return self.sort_order == "descending" ? sorted_list.reverse : sorted_list
     end
 
-    def sort_order # :nodoc:
+    def sort_order
       read_attribute('_sort_order') == 1 ? "descending" : "ascending"
     end
 
-    def sort_type1 # :nodoc:
+    def sort_type1
       converted_sort_type('_sort_type1')
     end
 
-    def sort_type2 # :nodoc:
+    def sort_type2
       converted_sort_type('_sort_type2')
     end
 
-    def sort_type3 # :nodoc:
+    def sort_type3
       converted_sort_type('_sort_type3')
     end
 
-    def sort_key1 # :nodoc:
+    def sort_key1
       read_attribute('_sort_key1')
     end
 
-    def sort_key2 # :nodoc:
+    def sort_key2
       read_attribute('_sort_key2')
     end
 
-    def sort_key3 # :nodoc:
+    def sort_key3
       read_attribute('_sort_key3')
     end
 
     # Returns the Object with the given name next in the hierarchy
     # returns nil if no object with the given name was found.
+    # @api public
     def find_nearest(name)
       obj = self.class.find_by_path(root? ? "/#{name}" : "#{path}/#{name}")
       return obj if obj and obj.active?
@@ -416,6 +439,7 @@ module RailsConnector
 
     # Returns the value of an internal or external attribute specified by its name.
     # Passing an invalid key will not raise an error, but return nil.
+    # @api public
     def [](key)
       key = key.to_s
       if OLD_INTERNAL_KEYS.include?(key)
@@ -433,6 +457,7 @@ module RailsConnector
     # Reloads the attributes of this object from the database.
     # Notice that the ruby class of this Obj instance will NOT change,
     # even if the obj_class in the database has changed.
+    # @api public
     def reload
       obj_data = CmsBackend.find_obj_data_by(Workspace.current.data, :id, [id.to_s]).first.first
       update_data(obj_data)
@@ -442,18 +467,22 @@ module RailsConnector
       read_attribute('_text_links')
     end
 
+    # @api public
     def obj_class
       read_attribute('_obj_class')
     end
 
+    # @api public
     def last_changed
       read_attribute('_last_changed')
     end
 
+    # @api public
     def valid_from
       read_attribute('_valid_from')
     end
 
+    # @api public
     def valid_until
       read_attribute('_valid_until')
     end
@@ -463,6 +492,7 @@ module RailsConnector
     # Override this method in subclasses to define a different content_type.
     # Note that only Objs with content_type "text/html"
     # will be rendered with layout and templates by the DefaultCmsController.
+    # @api public
     def content_type
       if binary?
         body_content_type
@@ -474,15 +504,68 @@ module RailsConnector
 
     # returns the extension (the part after the last dot) from the Obj's name.
     # returns an empty string if no extension is present in the Obj's name.
+    # @api public
     def file_extension
       File.extname(name)[1..-1] || ""
     end
 
-    def to_liquid # :nodoc:
+    # Returns the body (main content) of the Obj for non-binary Objs.
+    # Returns nil for binary Objs.
+    # @api public
+    def body
+      if binary?
+        nil
+      else
+        StringTagging.tag_as_html(read_attribute('body'), self)
+      end
+    end
+
+    # for binary Objs body_length equals the file size
+    # for non-binary Objs body_length equals the number of characters in the body (main content)
+    # @api public
+    def body_length
+      if binary?
+        blob = find_blob
+        blob ? blob.length : 0
+      else
+        (body || "").length
+      end
+    end
+
+    # returns an URL to retrieve the Obj's body for binary Objs.
+    # returns nil for non-binary Objs.
+    # @api public
+    def body_data_url
+      if binary?
+        blob = find_blob
+        blob.url if blob
+      end
+    end
+
+    def body_data_path
+      # not needed/supported when using cloud connector.
+      nil
+    end
+
+    # returns the content type of the Obj's body for binary Objs.
+    # returns nil for non-binary Objs.
+    # @api public
+    def body_content_type
+      if binary?
+        blob = find_blob
+        if blob
+          blob.content_type
+        else
+          "application/octet-stream"
+        end
+      end
+    end
+
+    def to_liquid
       LiquidSupport::ObjDrop.new(self)
     end
 
-    def respond_to?(method_id, include_private=false) # :nodoc:
+    def respond_to?(method_id, include_private=false)
       if has_attribute?(method_id)
         true
       else
@@ -490,11 +573,11 @@ module RailsConnector
       end
     end
 
-    def self.preview_time=(t) # :nodoc:
+    def self.preview_time=(t)
       Thread.current[:preview_time] = t
     end
 
-    def self.preview_time # :nodoc:
+    def self.preview_time
       Thread.current[:preview_time] || Time.now
     end
 
@@ -547,7 +630,12 @@ module RailsConnector
       DateAttribute.parse(value) unless value.nil?
     end
 
-    def method_missing(method_name, *args) # :nodoc:
+    def find_blob
+      blob_spec = read_attribute('blob')
+      Blob.find(blob_spec["id"]) if blob_spec
+    end
+
+    def method_missing(method_name, *args)
       if has_attribute?(method_name)
         read_attribute(method_name.to_s)
       else

data/lib/rails_connector/obj_data.rb

@@ -1,4 +1,3 @@
-#:enddoc:
 module RailsConnector
 
   class ObjData
@@ -24,14 +23,12 @@ module RailsConnector
       case key
       when "_text_links"
         "linklist"
-      when "_valid_from"
+      when "_valid_from", "_valid_until", "_last_changed"
         "date"
-      when "_valid_until"
-        "date"
-      when "_last_changed"
-        "date"
-      when "title"
+      when "title", "body"
         "html"
+      when "blob"
+        "binary"
       else
         nil
       end