alchemy_cms 5.1.4 → 6.0.0.b1

data/app/models/alchemy/page/page_naming.rb

@@ -1,85 +1,87 @@
 # frozen_string_literal: true
 
 module Alchemy
-  module Page::PageNaming
-    extend ActiveSupport::Concern
-    include NameConversions
-    RESERVED_URLNAMES = %w(admin messages new)
+  class Page < BaseRecord
+    module PageNaming
+      extend ActiveSupport::Concern
+      include NameConversions
+      RESERVED_URLNAMES = %w(admin messages new)
 
-    included do
-      before_validation :set_urlname,
-        if: :renamed?,
-        unless: -> { name.blank? }
+      included do
+        before_validation :set_urlname,
+          if: :renamed?,
+          unless: -> { name.blank? }
 
-      validates :name,
-        presence: true
-      validates :urlname,
-        uniqueness: { scope: [:language_id, :layoutpage], if: -> { urlname.present? } },
-        exclusion: { in: RESERVED_URLNAMES },
-        length: { minimum: 3, if: -> { urlname.present? } }
+        validates :name,
+          presence: true
+        validates :urlname,
+          uniqueness: { scope: [:language_id, :layoutpage], if: -> { urlname.present? } },
+          exclusion: { in: RESERVED_URLNAMES },
+          length: { minimum: 3, if: -> { urlname.present? } }
 
-      before_save :set_title,
-        if: -> { title.blank? }
+        before_save :set_title,
+          if: -> { title.blank? }
 
-      after_update :update_descendants_urlnames,
-        if: :saved_change_to_urlname?
+        after_update :update_descendants_urlnames,
+          if: :saved_change_to_urlname?
 
-      after_move :update_urlname!
-    end
+        after_move :update_urlname!
+      end
 
-    # Returns true if name or urlname has changed.
-    def renamed?
-      name_changed? || urlname_changed?
-    end
+      # Returns true if name or urlname has changed.
+      def renamed?
+        name_changed? || urlname_changed?
+      end
 
-    # Makes a slug of all ancestors urlnames including mine and delimit them be slash.
-    # So the whole path is stored as urlname in the database.
-    def update_urlname!
-      new_urlname = nested_url_name
-      if urlname != new_urlname
-        legacy_urls.create(urlname: urlname)
-        update_column(:urlname, new_urlname)
+      # Makes a slug of all ancestors urlnames including mine and delimit them be slash.
+      # So the whole path is stored as urlname in the database.
+      def update_urlname!
+        new_urlname = nested_url_name
+        if urlname != new_urlname
+          legacy_urls.create(urlname: urlname)
+          update_column(:urlname, new_urlname)
+        end
       end
-    end
 
-    # Returns always the last part of a urlname path
-    def slug
-      urlname.to_s.split("/").last
-    end
+      # Returns always the last part of a urlname path
+      def slug
+        urlname.to_s.split("/").last
+      end
 
-    private
+      private
 
-    def update_descendants_urlnames
-      reload
-      descendants.each(&:update_urlname!)
-    end
+      def update_descendants_urlnames
+        reload
+        descendants.each(&:update_urlname!)
+      end
 
-    # Sets the urlname to a url friendly slug.
-    # Either from name, or if present, from urlname.
-    # The urlname contains the whole path including parent urlnames.
-    def set_urlname
-      self[:urlname] = nested_url_name
-    end
+      # Sets the urlname to a url friendly slug.
+      # Either from name, or if present, from urlname.
+      # The urlname contains the whole path including parent urlnames.
+      def set_urlname
+        self[:urlname] = nested_url_name
+      end
 
-    def set_title
-      self[:title] = name
-    end
+      def set_title
+        self[:title] = name
+      end
 
-    # Converts the given name into an url friendly string.
-    #
-    # Names shorter than 3 will be filled up with dashes,
-    # so it does not collidate with the language code.
-    #
-    def converted_url_name
-      url_name = convert_to_urlname(slug.blank? ? name : slug)
-      url_name.rjust(3, "-")
-    end
+      # Converts the given name into an url friendly string.
+      #
+      # Names shorter than 3 will be filled up with dashes,
+      # so it does not collidate with the language code.
+      #
+      def converted_url_name
+        url_name = convert_to_urlname(slug.blank? ? name : slug)
+        url_name.rjust(3, "-")
+      end
 
-    def nested_url_name
-      if parent&.language_root?
-        converted_url_name
-      else
-        [parent&.urlname, converted_url_name].compact.join("/")
+      def nested_url_name
+        if parent&.language_root?
+          converted_url_name
+        else
+          [parent&.urlname, converted_url_name].compact.join("/")
+        end
       end
     end
   end

data/app/models/alchemy/page/page_natures.rb

@@ -1,171 +1,168 @@
 # frozen_string_literal: true
 
 module Alchemy
-  module Page::PageNatures
-    extend ActiveSupport::Concern
-
-    def public?
-      current_time = Time.current
-      already_public_for?(current_time) && still_public_for?(current_time)
-    end
-
-    def expiration_time
-      public_until? ? public_until - Time.current : nil
-    end
-
-    def taggable?
-      definition["taggable"] == true
-    end
+  class Page < BaseRecord
+    module PageNatures
+      extend ActiveSupport::Concern
+
+      # Determines if this page has a public version and this version is public.
+      #
+      # @see PageVersion#public?
+      # @returns Boolean
+      def public?
+        language.public? && !!public_version&.public?
+      end
 
-    deprecate :taggable?, deprecator: Alchemy::Deprecation
+      def expiration_time
+        public_until ? public_until - Time.current : nil
+      end
 
-    def rootpage?
-      !new_record? && parent_id.blank?
-    end
+      def taggable?
+        definition["taggable"] == true
+      end
 
-    def folded?(user_id)
-      return unless Alchemy.user_class < ActiveRecord::Base
+      deprecate :taggable?, deprecator: Alchemy::Deprecation
 
-      folded_pages.where(user_id: user_id, folded: true).any?
-    end
+      def rootpage?
+        !new_record? && parent_id.blank?
+      end
 
-    def contains_feed?
-      definition["feed"]
-    end
+      def folded?(user_id)
+        return unless Alchemy.user_class < ActiveRecord::Base
 
-    # Returns an Array of Alchemy roles which are able to edit this template
-    #
-    #     # config/alchemy/page_layouts.yml
-    #     - name: contact
-    #       editable_by:
-    #         - freelancer
-    #         - admin
-    #
-    # @returns Array
-    #
-    def has_limited_editors?
-      definition["editable_by"].present?
-    end
+        folded_pages.where(user_id: user_id, folded: true).any?
+      end
 
-    def editor_roles
-      return unless has_limited_editors?
+      def contains_feed?
+        definition["feed"]
+      end
 
-      definition["editable_by"]
-    end
+      # Returns an Array of Alchemy roles which are able to edit this template
+      #
+      #     # config/alchemy/page_layouts.yml
+      #     - name: contact
+      #       editable_by:
+      #         - freelancer
+      #         - admin
+      #
+      # @returns Array
+      #
+      def has_limited_editors?
+        definition["editable_by"].present?
+      end
 
-    # True if page locked_at timestamp and locked_by id are set
-    def locked?
-      locked_by? && locked_at?
-    end
+      def editor_roles
+        return unless has_limited_editors?
 
-    # Returns a Hash describing the status of the Page.
-    #
-    def status
-      {
-        public: public?,
-        locked: locked?,
-        restricted: restricted?,
-      }
-    end
+        definition["editable_by"]
+      end
 
-    # Returns the translated status for given status type.
-    #
-    # @param [Symbol] status_type
-    #
-    def status_title(status_type)
-      Alchemy.t(status[status_type].to_s, scope: "page_states.#{status_type}")
-    end
+      # True if page locked_at timestamp and locked_by id are set
+      def locked?
+        locked_by? && locked_at?
+      end
 
-    # Returns the self#page_layout definition from config/alchemy/page_layouts.yml file.
-    def definition
-      definition = PageLayout.get(page_layout)
-      if definition.nil?
-        log_warning "Page definition for `#{page_layout}` not found. Please check `page_layouts.yml` file."
-        return {}
+      # Returns a Hash describing the status of the Page.
+      #
+      def status
+        {
+          public: public?,
+          locked: locked?,
+          restricted: restricted?,
+        }
       end
-      definition
-    end
 
-    # Returns translated name of the pages page_layout value.
-    # Page layout names are defined inside the config/alchemy/page_layouts.yml file.
-    # Translate the name in your config/locales language yml file.
-    def layout_display_name
-      Alchemy.t(page_layout, scope: "page_layout_names")
-    end
+      # Returns the translated status for given status type.
+      #
+      # @param [Symbol] status_type
+      #
+      def status_title(status_type)
+        Alchemy.t(status[status_type].to_s, scope: "page_states.#{status_type}")
+      end
 
-    # Returns the name for the layout partial
-    #
-    def layout_partial_name
-      page_layout.parameterize.underscore
-    end
+      # Returns the self#page_layout definition from config/alchemy/page_layouts.yml file.
+      def definition
+        definition = PageLayout.get(page_layout)
+        if definition.nil?
+          log_warning "Page definition for `#{page_layout}` not found. Please check `page_layouts.yml` file."
+          return {}
+        end
+        definition
+      end
 
-    # Returns the key that's taken for cache path.
-    #
-    # Uses the +published_at+ value that's updated when the user publishes the page.
-    #
-    # If the page is the current preview it uses the updated_at value as cache key.
-    #
-    def cache_key
-      if Page.current_preview == self
-        "alchemy/pages/#{id}-#{updated_at}"
-      else
-        "alchemy/pages/#{id}-#{published_at}"
+      # Returns translated name of the pages page_layout value.
+      # Page layout names are defined inside the config/alchemy/page_layouts.yml file.
+      # Translate the name in your config/locales language yml file.
+      def layout_display_name
+        Alchemy.t(page_layout, scope: "page_layout_names")
       end
-    end
 
-    # We use the published_at value for the cache_key.
-    #
-    # If no published_at value is set yet, i.e. because it was never published,
-    # we return the updated_at value.
-    #
-    def published_at
-      read_attribute(:published_at) || updated_at
-    end
+      # Returns the name for the layout partial
+      #
+      def layout_partial_name
+        page_layout.parameterize.underscore
+      end
 
-    # Returns true if the page cache control headers should be set.
-    #
-    # == Disable Alchemy's page caching globally
-    #
-    #     # config/alchemy/config.yml
-    #     ...
-    #     cache_pages: false
-    #
-    # == Disable caching on page layout level
-    #
-    #     # config/alchemy/page_layouts.yml
-    #     - name: contact
-    #       cache: false
-    #
-    # == Note:
-    #
-    # This only sets the cache control headers and skips rendering of the page body,
-    # if the cache is fresh.
-    # This does not disable the fragment caching in the views.
-    # So if you don't want a page and it's elements to be cached,
-    # then be sure to not use <% cache element %> in the views.
-    #
-    # @returns Boolean
-    #
-    def cache_page?
-      return false unless caching_enabled?
-
-      page_layout = PageLayout.get(self.page_layout)
-      page_layout["cache"] != false && page_layout["searchresults"] != true
-    end
+      # Returns the key that's taken for cache path.
+      #
+      # Uses the +published_at+ value that's updated when the user publishes the page.
+      #
+      # If the page is the current preview it uses the updated_at value as cache key.
+      #
+      def cache_key
+        if Page.current_preview == self
+          "alchemy/pages/#{id}-#{updated_at}"
+        else
+          "alchemy/pages/#{id}-#{published_at}"
+        end
+      end
 
-    private
+      # We use the published_at value for the cache_key.
+      #
+      # If no published_at value is set yet, i.e. because it was never published,
+      # we return the updated_at value.
+      #
+      def published_at
+        read_attribute(:published_at) || updated_at
+      end
 
-    def caching_enabled?
-      Alchemy::Config.get(:cache_pages) &&
-        Rails.application.config.action_controller.perform_caching
-    end
+      # Returns true if the page cache control headers should be set.
+      #
+      # == Disable Alchemy's page caching globally
+      #
+      #     # config/alchemy/config.yml
+      #     ...
+      #     cache_pages: false
+      #
+      # == Disable caching on page layout level
+      #
+      #     # config/alchemy/page_layouts.yml
+      #     - name: contact
+      #       cache: false
+      #
+      # == Note:
+      #
+      # This only sets the cache control headers and skips rendering of the page body,
+      # if the cache is fresh.
+      # This does not disable the fragment caching in the views.
+      # So if you don't want a page and it's elements to be cached,
+      # then be sure to not use <% cache element %> in the views.
+      #
+      # @returns Boolean
+      #
+      def cache_page?
+        return false unless caching_enabled?
+
+        page_layout = PageLayout.get(self.page_layout)
+        page_layout["cache"] != false && page_layout["searchresults"] != true
+      end
 
-    def already_public_for?(time)
-      !public_on.nil? && public_on <= time
-    end
+      private
 
-    def still_public_for?(time)
-      public_until.nil? || public_until >= time
+      def caching_enabled?
+        Alchemy::Config.get(:cache_pages) &&
+          Rails.application.config.action_controller.perform_caching
+      end
     end
   end
 end