infopark_fiona_connector 7.0.0 → 7.0.1.5.2.3.rc6

data/lib/rails_connector/basic_obj.rb

@@ -1,28 +1,36 @@
 require "json"
-require 'openssl'
+require "openssl"
+require "rails_connector/fiona_datetime"
 
 module RailsConnector
-
   # The CMS file class
   #
   # [children] an Array of objects, Obj, of which this one is the parent
   # [parent] the Obj of which this one is a child - nil for the root object
   # @api public
   class BasicObj < CmsBaseModel
+    include RailsConnector::Meta
+
     CRYPT_KEY = "\xd7\x28\x9c\x63\xd6\x29\xdf\x20\xcd\x32\xcf\x30\xcf\x30\xcf\x30\xdf\x20\xb6\x49"\
         "\x91\x6e\x99\x66\x90\x6f\x8f\x70\x9e\x61\x8d\x72\x94\x6b\xdf\x20\xbe\x41\xb8\x47\xc4\x3b"\
         "\xdf\x20\xbd\x42\x9a\x65\x8d\x72\x93\x6c\x96\x69\x91\x6e".freeze
 
-    include DateAttribute
+    PREDEFINED_ATTRIBUTES = %w(blob body title channels sort_key1 sort_type1 sort_key2 sort_type2
+                               sort_key3 sort_type3 sort_order).freeze
 
     self.store_full_sti_class = false
 
+    def self.inherited(subclass)
+      super
+      subclass.delegate_attributes
+    end
+
     def self.configure_for_content(which)
       case which
       when :released then configure_column_information("objs", true)
       when :edited
         configure_column_information("preview_objs", false)
-        has_many(:arel_permissions, :class_name => "::RailsConnector::Permission", :foreign_key => "object_id")
+        has_many(:arel_permissions, class_name: "::RailsConnector::Permission", foreign_key: "object_id")
       else
         raise "configure_for_content called with unknown parameter #{which}"
       end
@@ -36,10 +44,58 @@ module RailsConnector
       self.inheritance_column = "obj_class"
 
       @@use_cached_permissions = use_cached_permissions
+      descendants.each do |klass|
+        klass.reset_table_name
+        klass.initialize_attributes
+      end
+
+      RailsConnector::Meta::EagerLoader.instance.obj_classes.each do |class_name, obj_class|
+        next unless obj_class
+
+        next unless /^[A-Z]/.match?(class_name)
+
+        klass = class_name.safe_constantize
+        next unless klass
+
+        klass.initialize_attributes if klass < RailsConnector::BasicObj
+      end
     end
 
-    # use released contents as a default
-    configure_for_content(:released)
+    def self.initialize_attributes
+      PREDEFINED_ATTRIBUTES.each do |attribute|
+        send(:define_attribute, attribute, ActiveRecord::Type::String.new)
+      end
+
+      return if obj_class_definition.blank?
+
+      obj_class_definition.custom_attributes.each_key do |attribute|
+        send(:define_attribute, attribute, ActiveRecord::Type::String.new)
+      end
+    end
+
+    def self.delegate_attributes
+      PREDEFINED_ATTRIBUTES.each do |attribute|
+        delegate attribute, to: :attr_dict
+      end
+
+      return if obj_class_definition.blank?
+
+      obj_class_definition.custom_attributes.each_key do |attribute|
+        delegate attribute, to: :attr_dict
+      end
+    end
+
+    attribute :last_changed, :fiona_datetime
+    attribute :valid_from, :fiona_datetime
+    attribute :valid_until, :fiona_datetime
+    attribute :suppress_export, :boolean
+    attribute :is_edited, :boolean
+    attribute :is_released, :boolean
+
+    delegate :sort_keys, to: :attr_dict
+    delegate :body_data_path, to: :attr_dict
+    delegate :empty?, to: :attr_dict
+    delegate :text_links, to: :attr_dict
 
     # Patch to avoid a type_condition being added by ActiveRecord::Base.add_conditions! for Obj.find(params):
     def self.descends_from_active_record?
@@ -65,6 +121,11 @@ module RailsConnector
       # We don't cache types at all here.
     end
 
+    def self.reset_reflections
+      has_many :children, class_name: "Obj", foreign_key: "parent_obj_id"
+      belongs_to :parent, class_name: "Obj", foreign_key: "parent_obj_id"
+    end
+
     # @api public
     def permissions
       @@use_cached_permissions ? attr_dict.permissions : arel_permissions
@@ -101,12 +162,6 @@ module RailsConnector
       @@homepage_id = nil
     end
 
-     # returns the obj's permalink.
-     # @api public
-     def permalink
-       self[:permalink]
-     end
-
     # This method determines the controller that should be invoked when the Obj is requested.
     # 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.
@@ -131,7 +186,7 @@ module RailsConnector
     # and thus requires no extra database access.
     # @api public
     def homepage?
-      self.id == (@@homepage_id ||= self.class.homepage.id)
+      id == (@@homepage_id ||= self.class.homepage.id)
     end
 
     # This method is used to calculate a part of a URL of an obj.
@@ -150,15 +205,17 @@ module RailsConnector
     # Returns the title of the content or the name.
     # @api public
     def display_title
-      self.title || name
+      title || name
     end
 
-    OBJECT_TYPES = {
-      '2' => :document,
-      '5' => :publication,
-      'B' => :image,
-      'C' => :generic
-    }.freeze unless defined?(OBJECT_TYPES)
+    unless defined?(OBJECT_TYPES)
+      OBJECT_TYPES = {
+        "2" => :document,
+        "5" => :publication,
+        "B" => :image,
+        "C" => :generic
+      }.freeze
+    end
 
     # Returns the type of the object: :document, :publication, :image or :generic
     # @api public
@@ -169,7 +226,7 @@ module RailsConnector
     # Returns true if image? or generic?
     # @api public
     def binary?
-      [:image, :generic].include? object_type
+      %i(image generic).include? object_type
     end
 
     # Returns true if object_type == :image
@@ -199,7 +256,8 @@ module RailsConnector
     # Returns true if this object is active.
     # @api public
     def active?
-      return false if !valid_from
+      return false unless valid_from
+
       valid_from <= Time.now && (!valid_until || Time.now <= valid_until)
     end
 
@@ -208,13 +266,13 @@ module RailsConnector
     # and edited? will always return false in this case.
     # @api public
     def edited?
-      (is_edited == 1)
+      is_edited
     end
 
     # Returns true if this object has released content
     # @api public
     def released?
-      (is_released == 1)
+      is_released
     end
 
     # Returns true if the Obj is suppressed.
@@ -223,7 +281,7 @@ module RailsConnector
     # as a standalone web page.
     # @api public
     def suppressed?
-      suppress_export == 1
+      suppress_export
     end
 
     # Returns true if the export of the object is not suppressed and the content is active?
@@ -254,15 +312,13 @@ module RailsConnector
       parent_obj_id.nil?
     end
 
-    has_many :children, :class_name => 'Obj', :foreign_key => 'parent_obj_id'
-    belongs_to :parent, :class_name => 'Obj', :foreign_key => 'parent_obj_id'
-
     # 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?
-      toclist = children.to_a.select{ |toc| toc.exportable? }
+
+      toclist = children.to_a.select { |toc| toc.exportable? }
       toclist = toclist.reject { |toc| toc.binary? } unless args.include?(:all)
       toclist
     end
@@ -270,20 +326,20 @@ module RailsConnector
     # Returns the sorted +toclist+, respecting sort order and type of this Obj.
     # @api public
     def sorted_toclist(*args)
-      list = self.toclist(*args)
+      list = toclist(*args)
       return [] if list.blank?
 
-      cached_sort_key1 = self.sort_key1
-      cached_sort_type1 = self.sort_type1
+      cached_sort_key1 = sort_key1
+      cached_sort_type1 = sort_type1
 
       sorted_list =
         if cached_sort_key1.blank?
-          list.sort { |left_obj, right_obj| left_obj.name <=> right_obj.name }
+          list.sort_by(&:name)
         else
-          cached_sort_key2 = self.sort_key2
-          cached_sort_type2 = self.sort_type2
-          cached_sort_key3 = self.sort_key3
-          cached_sort_type3 = self.sort_type3
+          cached_sort_key2 = sort_key2
+          cached_sort_type2 = sort_type2
+          cached_sort_key3 = sort_key3
+          cached_sort_type3 = sort_type3
 
           list.sort do |left_obj, right_obj|
             compare = compare_on_sort_key(left_obj, right_obj, cached_sort_key1, cached_sort_type1)
@@ -297,19 +353,7 @@ module RailsConnector
           end
         end
 
-      return self.sort_order == "descending" ? sorted_list.reverse : sorted_list
-    end
-
-    def sort_key1
-      self[:sort_key1]
-    end
-
-    def sort_key2
-      self[:sort_key2]
-    end
-
-    def sort_key3
-      self[:sort_key3]
+      sort_order == "descending" ? sorted_list.reverse : sorted_list
     end
 
     # Returns an Array of all the ancestor objects, starting at the root and ending at this object's parent.
@@ -326,9 +370,10 @@ module RailsConnector
     # returns nil if no object with the given name was found.
     # @api public
     def find_nearest(name)
-      obj = self.children.find_by_name(name)
-      return obj if obj and obj.active?
-      parent.find_nearest(name) unless self.root?
+      obj = children.find_by_name(name)
+      return obj if obj&.active?
+
+      parent.find_nearest(name) unless root?
     end
 
     # Returns the value of the attribute specified by its name.
@@ -336,26 +381,15 @@ module RailsConnector
     # Passing an invalid key will not raise an error, but return nil.
     # @api public
     def [](key)
-      # convenience access to name
-      return name if key.to_sym == :name
+      if has_attribute?(key)
+        begin
+          return attr_dict.send(key) if attr_dict.respond_to?(key)
 
-      # regular activerecord attributes
-      if @attributes.include?(key.to_s)
-        if key == :valid_from or key == :valid_until or key == :last_changed
-          return as_date(super(key))
-        else
-          return super(key)
+          read_attribute(key)
+        rescue NoMethodError
+          nil
         end
       end
-
-      # Unknown Obj attributes are delegated to the corresponding instance of AttrDict.
-      begin
-        return (attr_dict.send key)
-      rescue NoMethodError
-      end
-
-      # fallback
-      return nil
     end
 
     # Reloads the attributes of this object from the database, invalidates custom attributes
@@ -384,9 +418,7 @@ module RailsConnector
     # 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
-      attr_dict.body_length
-    end
+    delegate :body_length, to: :attr_dict
 
     # Override this method to provide an external url
     # where the content (the body) of this Obj can be downloaded.
@@ -422,11 +454,13 @@ module RailsConnector
       @attr_values ||= begin
         encoded_and_encrypted_attr_values = read_attribute(:attr_values)
         return {} unless encoded_and_encrypted_attr_values
+
         encrypted_attr_values = Base64.decode64(encoded_and_encrypted_attr_values)
-        if !encrypted_attr_values.starts_with?('Salted__') || encrypted_attr_values.length < 16
-          raise 'attr_values has wrong format'
+        if !encrypted_attr_values.starts_with?("Salted__") || encrypted_attr_values.length < 16
+          raise "attr_values has wrong format"
         end
-        cipher = OpenSSL::Cipher.new('rc4')
+
+        cipher = OpenSSL::Cipher.new("rc4")
         cipher.decrypt
         salt = encrypted_attr_values[8..15]
         cipher.pkcs5_keyivgen(CRYPT_KEY, salt, 1)
@@ -462,40 +496,19 @@ module RailsConnector
       rslt
     end
 
-    # @api public
-    def last_changed
-      self[:last_changed]
-    end
-
-    # @api public
-    def valid_from
-      self[:valid_from]
-    end
-
-    # @api public
-    def valid_until
-      self[:valid_until]
-    end
-
-    # deprecated, use file_extension instead
-    def content_type
-      logger.warn "DEPRECATION WARNING: Obj#content_type is deprecated, use file_extension instead"
-      file_extension
-    end
-
     # Returns the MIME-type as determined from the file_extension - see MIME::Types
     # @api public
     def mime_type
       @mime_type ||= compute_mime_type
     end
 
-    def respond_to?(method_id, include_private=false)
+    def respond_to?(method_id, include_private = false)
       if super
         true
       elsif %w(_attr_dict _attr_defs _attr_values).include?(method_id.to_s)
         # prevent infinite recursion when calling "attr_*" below,
         # since rails checks the absence of an "_attr_*" method internally
-        return false
+        false
       else
         attr_dict.respond_to?(method_id)
       end
@@ -503,44 +516,20 @@ module RailsConnector
 
     private
 
-    def as_date(value)
-      DateAttribute.parse(value) unless value.nil?
-    end
-
-    # Forwards any unknown method call to a corresponding instance
-    # of AttrDict and thus provides access to object fields, i.e. content.
-    #
-    # In case of an invalid method call, an error is raised.
-    #
-    # Hint: Use [] instead to suppress error messages.
-    def method_missing(method_id, *args)
-      super
-    rescue NoMethodError, NameError
-      # prevent infinite recursion when calling "attr_*" below,
-      # since rails checks the absence of an "_attr_*" method internally
-      raise if %w(_attr_dict _attr_defs _attr_values).include?(method_id.to_s)
-
-      if attr_dict.respond_to?(method_id)
-        attr_dict.send method_id, *args
-      else
-        raise
-      end
-    end
-
     def fiona_fields
       @fiona_fields ||=
-        ['name', 'obj_class', 'workflow', 'suppressexport', 'permalink'].inject({}) do |all,field|
+        %w(name obj_class workflow suppressexport permalink).inject({}) do |all, field|
           all.merge! field => {
-            'titles' => {'de' => field.humanize, 'en' => field.humanize},
-            'type' => 'string',
-            'help_texts' => {'de' => field, 'en' => field}
+            "titles" => { "de" => field.humanize, "en" => field.humanize },
+            "type" => "string",
+            "help_texts" => { "de" => field, "en" => field }
           }
         end
     end
 
     def compute_mime_type
       MIME::Types.type_for(file_extension).first.content_type
-    rescue
+    rescue StandardError
       binary? ? "application/octet-stream" : "text/plain"
     end
 
@@ -557,7 +546,15 @@ module RailsConnector
         left_value <=> right_value
       else
         if my_sort_type == "numeric"
-          (left_value.to_i rescue 0) <=> (right_value.to_i rescue 0)
+          (begin
+             left_value.to_i
+           rescue StandardError
+             0
+           end) <=> (begin
+                                            right_value.to_i
+                     rescue StandardError
+                       0
+                                          end)
         else
           left_value.to_s.downcase <=> right_value.to_s.downcase
         end
@@ -570,8 +567,5 @@ module RailsConnector
     rescue NameError, ActiveRecord::ActiveRecordError
       nil
     end
-
   end
-
 end
-