para 0.8.10 → 0.8.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2699b3fe934e113bc1679347cbe97ac94b0959c1
-  data.tar.gz: af695377ab693265ad2d1a28ae0e6588565dcc2d
+SHA256:
+  metadata.gz: 61c7a5614276ef1baeb61bc3374e309f17b3316e87bcf4694a3fdd5fb57ac3ed
+  data.tar.gz: 7af31c4c81ba3c3ac2b925ee719914e3d781e67c1033d225d668033d2a27243a
 SHA512:
-  metadata.gz: 44bf7f39afb5ac20c01ad50f91cf1c6ac34dbead25f7aa0d94dd4f9fa1fcd8c26f3228e85769a3d13859564fc6575da90b69294681da8dc4baabae733bbe2e91
-  data.tar.gz: ffeb5936f4db9c9b58a9e0d92135da5eb04ef24a5d5b4311a7ebf6cad355ba7b9b5fe8e50930ea981f1e812e4a483b26a38b67a6e3286573d38a0181c3193e14
+  metadata.gz: 3c0c2d1301ee1cf60438125c8067062809d05ca5ed5a61d8884f60ff72986bf10f1682a40c2f1fa3c00df81188f8530e950d8eda484d8cd4a179ea41e0843110
+  data.tar.gz: 518d36587de3461721498f6a76660a7c85ffb96eed5f3a8724cd7056855a21e83e509351b444538b6fe101792239ab908540603f9027fbe7960c908f286fb264

data/app/helpers/para/admin/page_helper.rb

@@ -2,13 +2,17 @@ module Para
   module Admin
     module PageHelper
       def page_top_bar(options = {})
-        content_tag(:div, class: 'page-title row') do
+        top_bar = content_tag(:div, class: 'page-title row') do
           content_tag(:h1, options[:title]) +
 
           if (actions = actions_for(options[:type]))
             actions.map(&method(:build_action)).join('').html_safe
           end
         end
+
+        # Return both top bar and component navigation to be displayed at the top of the
+        # page.
+        top_bar + component_navigation
       end
 
       def build_action(action)
@@ -30,6 +34,26 @@ module Para
           instance_eval(&action)
         end.compact
       end
+
+      def component_navigation
+        parent_component = (
+          @component.parent_component ||
+          @component.child_components.any? && @component
+        )
+
+        return unless parent_component
+
+        # If the component has a `model_type` option, therefore, an associated model,
+        # we try to render the partial from the relative path of the model, else we
+        # use the component class as the base target path
+        partial_target = parent_component.try(:model_type) || parent_component
+
+        render partial: find_partial_for(partial_target, :navigation),
+                locals: {
+                  parent_component: parent_component,
+                  active_component: @component
+                }
+      end
     end
   end
 end

data/app/models/application_record.rb

@@ -1,3 +1,6 @@
+# Base class used for the `AdminUser` model class as parent but automatically overriden
+# by application's own ApplicationRecord definition in Rails 5+
+#
 class ApplicationRecord < ActiveRecord::Base
   self.abstract_class = true
 end

data/app/models/para/application_record.rb

@@ -0,0 +1,20 @@
+module Para
+  # Base class for all para-specific models.
+  #
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+
+    private
+
+    # Adds the `optional: true` option to the belongs_to calls inside the provided block,
+    # but only for Rails 5.1+
+    #
+    def self.with_belongs_to_optional_option_if_needed(&block)
+      if ActiveRecord::Associations::Builder::BelongsTo.valid_options({}).include?(:optional)
+        with_options(optional: true, &block)
+      else
+        block.call
+      end
+    end
+  end
+end

data/app/models/para/cache/item.rb

@@ -3,7 +3,7 @@
 #
 module Para
   module Cache
-    class Item < ActiveRecord::Base
+    class Item < Para::ApplicationRecord
       def value
         Marshal.load(::Base64.decode64(self[:value])) if self[:value].present?
       end

data/app/models/para/component/base.rb

@@ -1,6 +1,6 @@
 module Para
   module Component
-    class Base < ActiveRecord::Base
+    class Base < Para::ApplicationRecord
       self.table_name = 'para_components'
 
       class_attribute :component_name
@@ -16,7 +16,14 @@ module Para
 
       configurable_on :controller
 
-      belongs_to :component_section, class_name: 'Para::ComponentSection'
+      with_belongs_to_optional_option_if_needed do
+        belongs_to :component_section, class_name: 'Para::ComponentSection'
+        belongs_to :parent_component, class_name: 'Para::Component::Base'
+      end
+
+      has_many :child_components, -> { ordered },
+                                  class_name: 'Para::Component::Base',
+                                  foreign_key: 'parent_component_id'
 
       validates :identifier, :type, presence: true
 
@@ -31,6 +38,13 @@ module Para
         )
       end
 
+      def main_navigation_name
+        ::I18n.t(
+          "components.main_navigation.#{ identifier }",
+          default: name
+        )
+      end
+
       def exportable?
         false
       end

data/app/models/para/component_resource.rb

@@ -1,5 +1,5 @@
 module Para
-  class ComponentResource < ActiveRecord::Base
+  class ComponentResource < Para::ApplicationRecord
     belongs_to :component, class_name: 'Para::Component::Base'
     belongs_to :resource, polymorphic: true
   end

data/app/models/para/component_section.rb

@@ -1,5 +1,5 @@
 module Para
-  class ComponentSection < ActiveRecord::Base
+  class ComponentSection < Para::ApplicationRecord
     has_many :components, -> { ordered }, class_name: 'Para::Component::Base',
              autosave: true, foreign_key: :component_section_id,
              dependent: :destroy

data/app/models/para/library/file.rb

@@ -1,6 +1,6 @@
 module Para
   module Library
-    class File < ActiveRecord::Base
+    class File < Para::ApplicationRecord
       if defined?(ActiveStorage)
         has_one_attached :attachment
 

data/app/models/para/page/section.rb

@@ -1,21 +1,14 @@
 module Para
   module Page
-    class Section < ActiveRecord::Base
+    class Section < Para::ApplicationRecord
       self.table_name = 'para_page_sections'
 
       acts_as_orderable parent: :page, as: :sections
 
-      page_relation_options = { polymorphic: true }
-
-      # Make Rails 5+ belongs_to relation optional for the parent page, to allow
-      # using sections in other contexts that directly included into pages
-      #
-      if ActiveRecord::Associations::Builder::BelongsTo.valid_options({}).include?(:optional)
-        page_relation_options[:optional] = true
+      with_belongs_to_optional_option_if_needed do
+        belongs_to :page, polymorphic: true
       end
 
-      belongs_to :page, page_relation_options
-
       def css_class
         @css_class ||= self.class.name.demodulize.underscore.gsub(/_/, '-')
       end

data/app/models/para/page/section_resource.rb

@@ -1,6 +1,6 @@
 module Para
   module Page
-    class SectionResource < ActiveRecord::Base
+    class SectionResource < Para::ApplicationRecord
       self.table_name = 'para_page_section_resources'
 
       acts_as_orderable parent: :section, as: :section_resources

data/app/views/para/admin/resources/_navigation.html.haml

@@ -0,0 +1,10 @@
+.top-nav-tabs-affix-placeholder
+  %ul.top-nav-tabs-affix.nav.nav-tabs{ role: "tablist", "data-top-level-affix": true }
+    %li{ class: ("active" if active_component == parent_component) }
+      = link_to parent_component.path do
+        = parent_component.name
+
+    - parent_component.child_components.each do |child_component|
+      %li{ class: ("active" if active_component == child_component) }
+        = link_to child_component.path do
+          = child_component.name

data/app/views/para/admin/shared/_navigation.html.haml

@@ -16,7 +16,7 @@
             - component_section.components.each do |component|
               - if can?(:manage, component) && show_component?(component)
                 %li.component-item{ class: (@component == component) && 'active' }
-                  = link_to component.name, component.path
+                  = link_to component.main_navigation_name, component.path
 
     - else
       %li.component-section-item

data/db/migrate/20201210152223_add_parent_component_to_para_components.rb

@@ -0,0 +1,6 @@
+class AddParentComponentToParaComponents < ActiveRecord::Migration[5.0]
+  def change
+    add_reference :para_components, :parent_component, foreign_key: false
+    add_foreign_key :para_components, :para_components, column: :parent_component_id
+  end
+end

data/lib/para/components_configuration.rb

@@ -1,7 +1,7 @@
 module Para
   class ComponentsConfiguration
-    class UndefinedComponentTypeError < StandardError
-    end
+    class UndefinedComponentTypeError < StandardError; end
+    class ComponentTooDeepError < StandardError; end
 
     def draw(&block)
       return unless components_installed?
@@ -48,7 +48,24 @@ module Para
     end
 
     def component_configuration_for(identifier)
-      sections.map(&:components).flatten.find { |c| c.identifier.to_s == identifier.to_s }
+      sections.each do |section|
+        section.components.each do |component|
+          # If one of the section component has the searched identifier return it
+          if component.identifier.to_s == identifier.to_s
+            return component
+          else
+            component.child_components.each do |child_component|
+              # If one of the component children has the searched identifier return it
+              if child_component.identifier.to_s == identifier.to_s
+                return child_component
+              end
+            end
+          end
+        end
+      end
+
+      # Return nil if the identifier was not found
+      nil
     end
 
     private
@@ -60,6 +77,10 @@ module Para
 
         section.components.each do |component|
           components_ids_hash[component.identifier] = component.model.id
+
+          component.child_components.each do |child_component|
+            components_ids_hash[child_component.identifier] = child_component.model.id
+          end
         end
       end
     end
@@ -129,8 +150,8 @@ module Para
         instance_eval(&block)
       end
 
-      def component(*args)
-        components << Component.new(*args)
+      def component(*args, &block)
+        components << Component.new(*args, &block)
       end
 
       def components
@@ -149,13 +170,17 @@ module Para
     end
 
     class Component
-      attr_accessor :identifier, :type, :shown_if, :options, :model
+      attr_accessor :identifier, :type, :shown_if, :options, :model, :parent
 
-      def initialize(identifier, type_identifier, shown_if: nil, **options)
-        self.identifier = identifier.to_s
-        self.type = Para::Component.registered_components[type_identifier]
-        self.options = options
-        self.shown_if = shown_if
+      def initialize(identifier, type_identifier, shown_if: nil, **options, &block)
+        @identifier = identifier.to_s
+        @type = Para::Component.registered_components[type_identifier]
+        @options = options
+        @shown_if = shown_if
+        @parent = options.delete(:parent)
+
+        # Build child components if a block is provided
+        instance_eval(&block) if block
 
         unless type
           raise UndefinedComponentTypeError.new(
@@ -165,10 +190,29 @@ module Para
         end
       end
 
+      def component(*args, **child_options, &block)
+        # Do not allow nesting components more than one level as the display of illimited
+        # child nesting deepness is not implemented
+        if parent
+          raise ComponentTooDeepError, "Cannot nest components more than one level"
+        end
+
+        child_component_options = child_options.merge(parent: self)
+        child_components << Component.new(*args, **child_component_options, &block)
+      end
+
+      def child_components
+        @child_components ||= []
+      end
+
       def refresh(attributes = {})
-        self.model = type.where(identifier: identifier).first_or_initialize
+        @model = type.where(identifier: identifier).first_or_initialize
         model.update_with(attributes.merge(options_with_defaults))
         model.save!
+
+        child_components.each_with_index do |child_component, child_index|
+          child_component.refresh(component_section: nil, position: child_index)
+        end
       end
 
       # Ensures unset :configuration store options are set to nil to allow
@@ -179,7 +223,14 @@ module Para
         configurable_keys += options.keys
         configurable_keys.uniq!
 
-        configurable_keys.each_with_object({}) do |key, hash|
+        options_with_defaults = {}
+
+        # Assign parent component resource to the final attribute options, assigning nil
+        # if the `:parent` option is empty, to allow extracting a component from its
+        # parent by just moving the component call outside of its parent block.
+        options_with_defaults[:parent_component] = parent&.model
+
+        configurable_keys.each_with_object(options_with_defaults) do |key, hash|
           hash[key] = options[key]
         end
       end

data/lib/para/version.rb

@@ -1,3 +1,3 @@
 module Para
-  VERSION = '0.8.10'
+  VERSION = '0.8.11'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: para
 version: !ruby/object:Gem::Version
-  version: 0.8.10
+  version: 0.8.11
 platform: ruby
 authors:
 - Valentin Ballestrino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-27 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -595,6 +595,7 @@ files:
 - app/helpers/para/tree_helper.rb
 - app/models/application_record.rb
 - app/models/para/ability.rb
+- app/models/para/application_record.rb
 - app/models/para/cache/item.rb
 - app/models/para/component/base.rb
 - app/models/para/component/crud.rb
@@ -629,6 +630,7 @@ files:
 - app/views/para/admin/resources/_form.html.haml
 - app/views/para/admin/resources/_imports_menu.html.haml
 - app/views/para/admin/resources/_list.html.haml
+- app/views/para/admin/resources/_navigation.html.haml
 - app/views/para/admin/resources/_per_page_select.html.haml
 - app/views/para/admin/resources/_remote_nested_form.html.haml
 - app/views/para/admin/resources/_subclassable_add_button.html.haml
@@ -670,6 +672,7 @@ files:
 - db/migrate/20160905134106_create_para_library_files.rb
 - db/migrate/20161006105728_create_para_cache_items.rb
 - db/migrate/20170324125547_create_para_page_section_resources.rb
+- db/migrate/20201210152223_add_parent_component_to_para_components.rb
 - lib/generators/para/admin_user/admin_user_generator.rb
 - lib/generators/para/component/component_generator.rb
 - lib/generators/para/component/crud/crud_generator.rb
@@ -851,8 +854,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Rails admin engine