resources_helper.rb in alchemy_cms-2.6.0.rc5

- old
+ new

@@ -1,14 +1,20 @@
 module Alchemy
   module ResourcesHelper
+    # = Alchemy::ResourceHelper
+    #
+    # Used to DRY up resource like structures in Alchemy's admin backend in combination with Alchemy::Resource
+    #
+    # See Alchemy::Resource for examples how to initialize a resource_handler
+    #
 
     def resource_window_size
       @resource_window_size ||= "420x#{100 + resource_handler.attributes.length * 40}"
     end
 
     def resource_instance_variable
-      instance_variable_get("@#{resource_handler.model_name}")
+      instance_variable_get("@#{resource_handler.resource_name}")
     end
 
     def resources_instance_variable
       instance_variable_get("@#{resource_handler.resources_name}")
     end
@@ -23,48 +29,111 @@
 
     def resource_scope
       @_resource_scope ||= [resource_url_proxy].concat(resource_handler.namespace_for_scope)
     end
 
-    def resources_path(resource=resource_handler.model, options={})
-      polymorphic_path (resource_scope + [resource]), options
+    def resources_path(resource_or_name=resource_handler.resources_name, options={})
+      polymorphic_path (resource_scope + [resource_or_name]), options
     end
 
-    def resource_path(resource=resource_handler.model, options={})
+    def resource_path(resource=resource_handler.resource_name, options={})
       resources_path(resource, options)
     end
 
     def new_resource_path(options={})
-      new_polymorphic_path (resource_scope + [resource_handler.model]), options
+      new_polymorphic_path (resource_scope + [resource_handler.resource_name]), options
     end
 
     def edit_resource_path(resource=nil, options={})
-      edit_polymorphic_path (resource_scope+([resource] or model_array)), options
+      path_segments = (resource_scope + [resource] or resource_handler.resource_array)
+      edit_polymorphic_path path_segments, options
     end
 
     def resource_permission_scope
       resource_handler.permission_scope
     end
 
     def resource_model_name
-      resource_handler.model_name
+      ActiveSupport::Deprecation.warn("resource_model_name is deprecated. Please use resource_name instead!")
+      resource_handler.resource_name
     end
 
+    def resource_name
+      resource_handler.resource_name
+    end
+
     def resource_model
       resource_handler.model
     end
 
-    def render_attribute(obj, attribute)
-      attr_array = attribute.split('.')
-      attr_array.each do |attr|
-        obj = obj.send(attr) if obj
+    # Returns the value from resource attribute
+    #
+    # If the attribute has a relation, the related object's attribute value will be returned.
+    #
+    # The output will be truncated after 50 chars.
+    #
+    # @param [Alchemy::Resource] resource
+    # @param [Hash] attribute
+    # @option options [Hash] :truncate (50) The length of the value returned.
+    #
+    # @return [String]
+    #
+    def render_attribute(resource, attribute, options={})
+      options.reverse_merge!(truncate: 50)
+      value = resource.send(attribute[:name])
+      if (relation = attribute[:relation]) && value.present?
+        record = relation[:model_association].klass.find(value)
+        value = record.send(relation[:attr_method])
+      elsif attribute[:type] == :datetime && value.present?
+        value = l(value)
       end
-      obj
+      value.to_s.truncate(options[:truncate])
+    rescue ActiveRecord::RecordNotFound => e
+      warning e
+      _t(:not_found)
     end
 
     def resource_help_text(attribute)
       if help_text = resource_handler.help_text_for(attribute)
         content_tag(:p, help_text, class: 'foot_note')
+      end
+    end
+
+    # Renders the human model name with a count as h1 header
+    def resources_header
+      content_tag :h1, "#{resources_instance_variable.total_count} #{resource_model.model_name.human(:count => resources_instance_variable.total_count)}"
+    end
+
+    # Returns true if the resource contains any relations
+    def contains_relations?
+      resource_handler.resource_relations.present?
+    end
+
+    # Returns an array of all resource_relations names
+    def resource_relations_names
+      resource_handler.resource_relations.collect { |k, v| v[:name].to_sym }
+    end
+
+    # Returns the attribute's column for sorting
+    #
+    # If the attribute contains a resource_relation, then the table and column for related model will be returned.
+    #
+    def sortable_resource_header_column(attribute)
+      if relation = attribute[:relation]
+        "#{relation[:model_association].table_name}.#{relation[:attr_method]}"
+      else
+        attribute[:name]
+      end
+    end
+
+    # Returns resource relations options hash for a rails select helper.
+    #
+    # @param [Hash] relation
+    # @returns Hash
+    #
+    def options_for_resource_relation_select(relation)
+      relation[:model_association].klass.all.collect do |r|
+        [r.send(relation[:attr_method]), r.id]
       end
     end
 
   end
 end