alchemy_cms 3.3.3 → 3.4.0.rc1

data/app/models/alchemy/essence_picture_view.rb

@@ -0,0 +1,68 @@
+module Alchemy
+  # Renders an essence picture view
+  class EssencePictureView
+    include ActionView::Helpers::AssetTagHelper
+    include ActionView::Helpers::UrlHelper
+    include Rails.application.routes.url_helpers
+
+    attr_reader :content, :essence, :html_options, :options, :picture
+
+    DEFAULT_OPTIONS = {
+      show_caption: true,
+      disable_link: false
+    }
+
+    def initialize(content, options = {}, html_options = {})
+      @content = content
+      @options = DEFAULT_OPTIONS.update(content.settings).update(options)
+      @html_options = html_options
+      @essence = content.essence
+      @picture = essence.picture
+    end
+
+    def render
+      return if picture.blank?
+
+      output = caption ? img_tag + caption : img_tag
+
+      if is_linked?
+        output = link_to(output, url_for(essence.link), {
+          title: essence.link_title.presence,
+          target: essence.link_target == "blank" ? "_blank" : nil,
+          data: {link_target: essence.link_target.presence}
+        })
+      end
+
+      if caption
+        content_tag(:figure, output, {class: essence.css_class.presence}.merge(html_options))
+      else
+        output
+      end
+    end
+
+    private
+
+    def caption
+      return unless show_caption?
+      @_caption ||= content_tag(:figcaption, essence.caption)
+    end
+
+    def img_tag
+      @_img_tag ||= image_tag(
+        essence.picture_url(options), {
+          alt: essence.alt_tag.presence,
+          title: essence.title.presence,
+          class: caption ? nil : essence.css_class.presence
+        }.merge(caption ? {} : html_options)
+      )
+    end
+
+    def show_caption?
+      options[:show_caption] && essence.caption.present?
+    end
+
+    def is_linked?
+      !options[:disable_link] && essence.link.present?
+    end
+  end
+end

data/app/models/alchemy/language.rb

@@ -19,7 +19,7 @@
 
 module Alchemy
   class Language < ActiveRecord::Base
-    belongs_to :site
+    belongs_to :site, required: true
     has_many :pages
 
     before_validation :set_locale, if: -> { locale.blank? }
@@ -52,11 +52,10 @@ module Alchemy
     before_destroy :check_for_default
     after_destroy :delete_language_root_page
 
-    default_scope { on_site(Site.current) }
-
-    scope :published,      -> { where(public: true) }
-    scope :with_root_page, -> { joins(:pages).where(Page.table_name => {language_root: true}) }
-    scope :on_site,        ->(s) { s.present? ? where(site_id: s.id) : all }
+    scope :published,       -> { where(public: true) }
+    scope :with_root_page,  -> { joins(:pages).where(Page.table_name => {language_root: true}) }
+    scope :on_site,         ->(s) { s ? where(site_id: s.id) : all }
+    scope :on_current_site, -> { on_site(Site.current) }
 
     class << self
       # Store the current language in the current thread.
@@ -74,11 +73,10 @@ module Alchemy
         current.pages.language_roots.first
       end
 
-      # Default language
+      # Default language for current site
       def default
-        find_by(default: true)
+        on_current_site.find_by(default: true)
       end
-      alias_method :get_default, :default
     end
 
     def label(attrib)
@@ -165,7 +163,7 @@ module Alchemy
     end
 
     def unpublish_pages
-      pages.update_all(public: false)
+      pages.update_all(public_on: nil, public_until: nil)
     end
   end
 end

data/app/models/alchemy/language/code.rb

@@ -13,7 +13,10 @@ module Alchemy::Language::Code
     def find_by_code(code)
       codes = code.split('-')
       codes << '' if codes.length == 1
-      find_by_language_code_and_country_code(*codes)
+      on_current_site.find_by(
+        language_code: codes[0],
+        country_code: codes[1]
+      )
     end
   end
 end

data/app/models/alchemy/page.rb

@@ -3,12 +3,12 @@
 # Table name: alchemy_pages
 #
 #  id               :integer          not null, primary key
-#  name             :string(255)
-#  urlname          :string(255)
-#  title            :string(255)
-#  language_code    :string(255)
+#  name             :string
+#  urlname          :string
+#  title            :string
+#  language_code    :string
 #  language_root    :boolean
-#  page_layout      :string(255)
+#  page_layout      :string
 #  meta_keywords    :text
 #  meta_description :text
 #  lft              :integer
@@ -17,7 +17,7 @@
 #  depth            :integer
 #  visible          :boolean          default(FALSE)
 #  public           :boolean          default(FALSE)
-#  locked           :boolean          default(FALSE)
+#  locked_at        :datetime
 #  locked_by        :integer
 #  restricted       :boolean          default(FALSE)
 #  robot_index      :boolean          default(TRUE)
@@ -31,6 +31,8 @@
 #  language_id      :integer
 #  cached_tag_list  :text
 #  published_at     :datetime
+#  public_on        :datetime
+#  public_until     :datetime
 #
 
 module Alchemy
@@ -43,17 +45,32 @@ module Alchemy
       do_not_autogenerate: true,
       do_not_sweep: true,
       visible: false,
-      public: false,
-      locked: false,
+      public_on: nil,
+      public_until: nil,
+      locked_at: nil,
       locked_by: nil
     }
-    SKIPPED_ATTRIBUTES_ON_COPY = %w(id updated_at created_at creator_id updater_id lft rgt depth urlname cached_tag_list)
+
+    SKIPPED_ATTRIBUTES_ON_COPY = %w(
+      id
+      updated_at
+      created_at
+      creator_id
+      updater_id
+      lft
+      rgt
+      depth
+      urlname
+      cached_tag_list
+    )
+
     PERMITTED_ATTRIBUTES = [
       :meta_description,
       :meta_keywords,
       :name,
       :page_layout,
-      :public,
+      :public_on,
+      :public_until,
       :restricted,
       :robot_index,
       :robot_follow,
@@ -73,6 +90,7 @@ module Alchemy
     belongs_to :language
 
     has_one :site, through: :language
+    has_many :site_languages, through: :site, source: :languages
     has_many :folded_pages
     has_many :legacy_urls, class_name: 'Alchemy::LegacyPageUrl'
 
@@ -84,12 +102,29 @@ module Alchemy
     attr_accessor :do_not_sweep
     attr_accessor :do_not_validate_language
 
-    before_save :set_language_code, if: -> { language.present? }, unless: :systempage?
-    before_save :set_restrictions_to_child_pages, if: :restricted_changed?, unless: :systempage?
-    before_save :inherit_restricted_status, if: -> { parent && parent.restricted? }, unless: :systempage?
-    before_save :update_published_at, if: -> { public && read_attribute(:published_at).nil? }, unless: :systempage?
-    before_create :set_language_from_parent_or_default, if: -> { language_id.blank? }, unless: :systempage?
-    after_update :create_legacy_url, if: :urlname_changed?, unless: :redirects_to_external?
+    before_save :set_language_code,
+      if: -> { language.present? },
+      unless: :systempage?
+
+    before_save :set_restrictions_to_child_pages,
+      if: :restricted_changed?,
+      unless: :systempage?
+
+    before_save :inherit_restricted_status,
+      if: -> { parent && parent.restricted? },
+      unless: :systempage?
+
+    before_save :set_published_at,
+      if: -> { public? && published_at.nil? },
+      unless: :systempage?
+
+    before_create :set_language_from_parent_or_default,
+      if: -> { language_id.blank? },
+      unless: :systempage?
+
+    after_update :create_legacy_url,
+      if: :urlname_changed?,
+      unless: :redirects_to_external?
 
     # Concerns
     include Alchemy::Page::PageScopes
@@ -99,6 +134,9 @@ module Alchemy
     include Alchemy::Page::PageCells
     include Alchemy::Page::PageElements
 
+    # site_name accessor
+    delegate :name, to: :site, prefix: true, allow_nil: true
+
     # Class methods
     #
     class << self
@@ -281,16 +319,16 @@ module Alchemy
     end
     alias_method :next_page, :next
 
-    # Locks the page to given user without updating the timestamps
+    # Locks the page to given user
     #
     def lock_to!(user)
-      update_columns(locked: true, locked_by: user.id)
+      update_columns(locked_at: Time.current, locked_by: user.id)
     end
 
     # Unlocks the page without updating the timestamps
     #
     def unlock!
-      if update_columns(locked: false, locked_by: nil)
+      if update_columns(locked_at: nil, locked_by: nil)
         Page.current_preview = nil
       end
     end
@@ -335,12 +373,18 @@ module Alchemy
 
     # Publishes the page.
     #
-    # Sets +public+ to true and the +published_at+ value to current time.
+    # Sets +public_on+ and the +published_at+ value to current time
+    # and resets +public_until+ to nil
     #
     # The +published_at+ attribute is used as +cache_key+.
     #
     def publish!
-      update_columns(published_at: Time.current, public: true)
+      current_time = Time.current
+      update_columns(
+        published_at: current_time,
+        public_on: current_time,
+        public_until: nil
+      )
     end
 
     # Updates an Alchemy::Page based on a new ordering to be applied to it
@@ -380,10 +424,9 @@ module Alchemy
         public: true
       }.update(options)
 
-      self_and_siblings
-        .where(["#{self.class.table_name}.lft #{dir} ?", lft])
-        .where(public: options[:public])
-        .where(restricted: options[:restricted])
+      pages = self_and_siblings.where(["#{Page.table_name}.lft #{dir} ?", lft])
+      pages = options[:public] ? pages.published : pages.not_public
+      pages.where(restricted: options[:restricted])
         .reorder(dir == '>' ? 'lft' : 'lft DESC')
         .limit(1).first
     end
@@ -402,7 +445,7 @@ module Alchemy
       legacy_urls.find_or_create_by(urlname: urlname_was)
     end
 
-    def update_published_at
+    def set_published_at
       self.published_at = Time.current
     end
   end

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

@@ -2,6 +2,15 @@ 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
@@ -33,6 +42,11 @@ module Alchemy
       !PageLayout.get(page_layout).nil? && !PageLayout.get(page_layout)["controller"].blank?
     end
 
+    # True if page locked_at timestamp and locked_by id are set
+    def locked?
+      locked_by? && locked_at?
+    end
+
     def controller_and_action
       if has_controller?
         {
@@ -144,5 +158,13 @@ module Alchemy
       Alchemy::Config.get(:cache_pages) &&
         Rails.application.config.action_controller.perform_caching
     end
+
+    def already_public_for?(time)
+      !public_on.nil? && public_on <= time
+    end
+
+    def still_public_for?(time)
+      public_until.nil? || public_until >= time
+    end
   end
 end

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

@@ -15,7 +15,7 @@ module Alchemy
 
       # All locked pages
       #
-      scope :locked, -> { where(locked: true) }
+      scope :locked, -> { where.not(locked_at: nil, locked_by: nil) }
 
       # All pages locked by given user
       #
@@ -27,16 +27,12 @@ module Alchemy
 
       # All not locked pages
       #
-      scope :not_locked, -> { where(locked: false) }
+      scope :not_locked, -> { where(locked_at: nil, locked_by: nil) }
 
       # All visible pages
       #
       scope :visible, -> { where(visible: true) }
 
-      # All public pages
-      #
-      scope :published, -> { where(public: true) }
-
       # All not restricted pages
       #
       scope :not_restricted, -> { where(restricted: false) }
@@ -99,5 +95,23 @@ module Alchemy
       #
       scope :sitemap, -> { from_current_site.published.contentpages.where(sitemap: true) }
     end
+
+    module ClassMethods
+      # All public pages
+      #
+      def published
+        where("#{table_name}.public_on <= :time AND " \
+              "(#{table_name}.public_until IS NULL " \
+              "OR #{table_name}.public_until >= :time)", time: Time.current)
+      end
+
+      # All not public pages
+      #
+      def not_public
+        where("#{table_name}.public_on IS NULL OR " \
+              "#{table_name}.public_on >= :time OR " \
+              "#{table_name}.public_until <= :time", time: Time.current)
+      end
+    end
   end
 end

data/app/models/alchemy/picture.rb

@@ -3,22 +3,25 @@
 # Table name: alchemy_pictures
 #
 #  id                :integer          not null, primary key
-#  name              :string(255)
-#  image_file_name   :string(255)
+#  name              :string
+#  image_file_name   :string
 #  image_file_width  :integer
 #  image_file_height :integer
 #  created_at        :datetime         not null
 #  updated_at        :datetime         not null
 #  creator_id        :integer
 #  updater_id        :integer
-#  upload_hash       :string(255)
+#  upload_hash       :string
 #  cached_tag_list   :text
-#  image_file_uid    :string(255)
+#  image_file_uid    :string
 #  image_file_size   :integer
+#  image_file_format :string
 #
 
 module Alchemy
   class Picture < ActiveRecord::Base
+    CONVERTIBLE_FILE_FORMATS = %w(gif jpg jpeg png).freeze
+
     include Alchemy::NameConversions
     include Alchemy::Touching
     include Alchemy::Picture::Sweeping
@@ -183,6 +186,36 @@ module Alchemy
       convert_to_humanized_name(image_file_name, suffix)
     end
 
+    # Returns the format the image should be rendered with
+    #
+    # Only returns a format differing from original if an +image_output_format+
+    # is set in config and the image has a convertible file format.
+    #
+    def default_render_format
+      if convertible?
+        Config.get(:image_output_format)
+      else
+        image_file_format
+      end
+    end
+
+    # Returns true if the image can be converted
+    #
+    # If the +image_output_format+ is set to +nil+ or +original+ or the
+    # image has not a convertible file format (i.e. SVG) this returns +false+
+    #
+    def convertible?
+      Config.get(:image_output_format) &&
+        Config.get(:image_output_format) != 'original' &&
+        has_convertible_format?
+    end
+
+    # Returns true if the image can be converted into other formats
+    #
+    def has_convertible_format?
+      image_file_format.in?(CONVERTIBLE_FILE_FORMATS)
+    end
+
     # Checks if the picture is restricted.
     #
     # A picture is only restricted if it's assigned on restricted pages only.