alchemy_cms 3.2.1 → 3.3.0.rc1

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

@@ -1,6 +1,5 @@
 module Alchemy
   module Page::PageNaming
-
     extend ActiveSupport::Concern
     include NameConversions
     RESERVED_URLNAMES = %w(admin messages new)
@@ -21,7 +20,7 @@ module Alchemy
         on: :update,
         presence: {if: :redirects_to_external?}
 
-      before_save :set_title, :if => 'title.blank?', :unless => proc { systempage? || redirects_to_external? }
+      before_save :set_title, if: 'title.blank?', unless: proc { systempage? || redirects_to_external? }
       after_update :update_descendants_urlnames,
         if: -> { Config.get(:url_nesting) && (urlname_changed? || visible_changed?) }
       after_move :update_urlname!,
@@ -70,7 +69,7 @@ module Alchemy
     private
 
     def update_descendants_urlnames
-      self.reload
+      reload
       descendants.each do |descendant|
         next if descendant.redirects_to_external?
         descendant.update_urlname!

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

@@ -1,6 +1,5 @@
 module Alchemy
   module Page::PageNatures
-
     extend ActiveSupport::Concern
 
     def taggable?
@@ -8,12 +7,12 @@ module Alchemy
     end
 
     def rootpage?
-      !self.new_record? && self.parent_id.blank?
+      !new_record? && parent_id.blank?
     end
 
     def systempage?
       return true if Page.root.nil?
-      rootpage? || (self.parent_id == Page.root.id && !self.language_root?)
+      rootpage? || (parent_id == Page.root.id && !language_root?)
     end
 
     def folded?(user_id)
@@ -25,20 +24,20 @@ module Alchemy
       definition["feed"]
     end
 
-    # Returns true or false if the pages layout_description for config/alchemy/page_layouts.yml contains redirects_to_external: true
+    # Returns true or false if the pages definition for config/alchemy/page_layouts.yml contains redirects_to_external: true
     def redirects_to_external?
       !!definition["redirects_to_external"]
     end
 
     def has_controller?
-      !PageLayout.get(self.page_layout).nil? && !PageLayout.get(self.page_layout)["controller"].blank?
+      !PageLayout.get(page_layout).nil? && !PageLayout.get(page_layout)["controller"].blank?
     end
 
     def controller_and_action
-      if self.has_controller?
+      if has_controller?
         {
-          controller: self.layout_description["controller"].gsub(/(^\b)/, "/#{$1}"),
-          action: self.layout_description["action"]
+          controller: definition["controller"].gsub(/(^\b)/, "/#{$1}"),
+          action: definition["action"]
         }
       end
     end
@@ -59,26 +58,25 @@ module Alchemy
     # @param [Symbol] status_type
     #
     def status_title(status_type)
-      I18n.t(self.status[status_type].to_s, scope: "page_states.#{status_type}")
+      Alchemy.t(status[status_type].to_s, scope: "page_states.#{status_type}")
     end
 
     # Returns the self#page_layout definition from config/alchemy/page_layouts.yml file.
     def definition
-      return {} if self.systempage?
-      description = PageLayout.get(self.page_layout)
-      if description.nil?
-        log_warning "Page layout description for `#{self.page_layout}` not found. Please check `page_layouts.yml` file."
+      return {} if systempage?
+      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
-      description
+      definition
     end
-    alias_method :layout_description, :definition
 
     # 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
-      I18n.t(self.page_layout, :scope => :page_layout_names)
+      Alchemy.t(page_layout, scope: 'page_layout_names')
     end
 
     # Returns the name for the layout partial
@@ -110,5 +108,41 @@ module Alchemy
       read_attribute(:published_at) || updated_at
     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
+
+    private
+
+    def caching_enabled?
+      Alchemy::Config.get(:cache_pages) &&
+        Rails.application.config.action_controller.perform_caching
+    end
   end
 end

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

@@ -1,5 +1,4 @@
 module Alchemy
-
   # ActiveRecord scopes for Alchemy::Page
   #
   module Page::PageScopes
@@ -16,13 +15,13 @@ module Alchemy
 
       # All locked pages
       #
-      scope :all_locked, -> { where(locked: true) }
+      scope :locked, -> { where(locked: true) }
 
       # All pages locked by given user
       #
-      scope :all_locked_by, ->(user) {
+      scope :locked_by, ->(user) {
         if user.class.respond_to? :primary_key
-          all_locked.where(locked_by: user.send(user.class.primary_key))
+          locked.where(locked_by: user.send(user.class.primary_key))
         end
       }
 
@@ -50,7 +49,7 @@ module Alchemy
       #
       scope :public_language_roots, -> {
         published.language_roots.where(
-          language_code: Language.published.pluck(:code)
+          language_code: Language.published.pluck(:language_code)
         )
       }
 
@@ -68,7 +67,9 @@ module Alchemy
 
       # Returns all content pages.
       #
-      scope :contentpages, -> { where(layoutpage: [false, nil]).where(Page.arel_table[:parent_id].not_eq(nil)) }
+      scope :contentpages, -> {
+        where(layoutpage: [false, nil]).where(Page.arel_table[:parent_id].not_eq(nil))
+      }
 
       # Returns all public contentpages that are not locked.
       #
@@ -98,6 +99,5 @@ module Alchemy
       #
       scope :sitemap, -> { from_current_site.published.contentpages.where(sitemap: true) }
     end
-
   end
 end

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

@@ -26,7 +26,7 @@ module Alchemy
     # does not respond to +#name+ it returns +'unknown'+
     #
     def creator_name
-      (creator && creator.try(:name)) || I18n.t('unknown')
+      (creator && creator.try(:name)) || Alchemy.t('unknown')
     end
 
     # Returns the name of the last updater of this page.
@@ -35,7 +35,7 @@ module Alchemy
     # does not respond to +#name+ it returns +'unknown'+
     #
     def updater_name
-      (updater && updater.try(:name)) || I18n.t('unknown')
+      (updater && updater.try(:name)) || Alchemy.t('unknown')
     end
 
     # Returns the name of the user currently editing this page.
@@ -44,7 +44,7 @@ module Alchemy
     # does not respond to +#name+ it returns +'unknown'+
     #
     def locker_name
-      (locker && locker.try(:name)) || I18n.t('unknown')
+      (locker && locker.try(:name)) || Alchemy.t('unknown')
     end
 
     private

data/app/models/alchemy/picture.rb

@@ -37,16 +37,22 @@ module Alchemy
     # to ensure this runs before Dragonfly's before_destroy callback.
     #
     before_destroy unless: :deletable? do
-      raise PictureInUseError, I18n.t(:cannot_delete_picture_notice) % { name: name }
+      raise PictureInUseError, Alchemy.t(:cannot_delete_picture_notice) % { name: name }
     end
 
     # Enables Dragonfly image processing
     dragonfly_accessor :image_file, app: :alchemy_pictures do
       # Preprocess after uploading the picture
       after_assign do |p|
-        if Config.get(:preprocess_image_resize).present?
-          p.thumb!("#{Config.get(:preprocess_image_resize)}>")
-        end
+        resize = Config.get(:preprocess_image_resize)
+        p.thumb!(resize) if resize.present?
+      end
+    end
+
+    # We need to define this method here to have it available in the validations below.
+    class << self
+      def allowed_filetypes
+        Config.get(:uploader).fetch('allowed_filetypes', {}).fetch('alchemy/pictures', [])
       end
     end
 
@@ -54,20 +60,20 @@ module Alchemy
     validates_size_of :image_file, maximum: Config.get(:uploader)['file_size_limit'].megabytes
     validates_property :format,
       of: :image_file,
-      in: Config.get(:uploader)['allowed_filetypes']['pictures'],
+      in: allowed_filetypes,
       case_sensitive: false,
-      message: I18n.t("not a valid image")
+      message: Alchemy.t("not a valid image")
 
     acts_as_taggable
 
     stampable stamper_class_name: Alchemy.user_class_name
 
     scope :named, ->(name) {
-      where("#{self.table_name}.name LIKE ?", "%#{name}%")
+      where("#{table_name}.name LIKE ?", "%#{name}%")
     }
 
     scope :recent, -> {
-      where("#{self.table_name}.created_at > ?", Time.now - 24.hours).order(:created_at)
+      where("#{table_name}.created_at > ?", Time.current - 24.hours).order(:created_at)
     }
 
     scope :deletable, -> {
@@ -75,7 +81,7 @@ module Alchemy
     }
 
     scope :without_tag, -> {
-      where("#{self.table_name}.cached_tag_list IS NULL OR #{self.table_name}.cached_tag_list = ''")
+      where("#{table_name}.cached_tag_list IS NULL OR #{table_name}.cached_tag_list = ''")
     }
 
     after_update :touch_contents
@@ -83,35 +89,35 @@ module Alchemy
     # Class methods
 
     class << self
+      def last_upload
+        last_picture = Picture.last
+        return Picture.all unless last_picture
+        Picture.where(upload_hash: last_picture.upload_hash)
+      end
 
-      # Returns filtered, paginated and ordered picture collection.
-      def find_paginated(params, per_page)
-        @pictures = Picture.all
+      def search_by(params, query, per_page = nil)
+        pictures = query.result
 
         if params[:tagged_with].present?
-          @pictures = @pictures.tagged_with(params[:tagged_with])
+          pictures = pictures.tagged_with(params[:tagged_with])
         end
+
         if params[:filter].present?
-          @pictures = @pictures.filtered_by(params[:filter])
-        end
-        if params[:query].present?
-          @pictures = @pictures.named(params[:query])
+          pictures = pictures.filtered_by(params[:filter])
         end
 
-        @pictures.page(params[:page] || 1).per(per_page).order(:name)
-      end
+        if per_page
+          pictures = pictures.page(params[:page] || 1).per(per_page)
+        end
 
-      def last_upload
-        last_picture = Picture.last
-        return Picture.all unless last_picture
-        Picture.where(upload_hash: last_picture.upload_hash)
+        pictures.order(:name)
       end
 
       def filtered_by(filter = '')
         case filter
-          when 'recent'      then recent
-          when 'last_upload' then last_upload
-          when 'without_tag' then without_tag
+        when 'recent'      then recent
+        when 'last_upload' then last_upload
+        when 'without_tag' then without_tag
         else
           all
         end
@@ -120,6 +126,16 @@ module Alchemy
 
     # Instance methods
 
+    def previous(params = {})
+      query = Picture.ransack(params[:q])
+      Picture.search_by(params, query).where("name < ?", name).last
+    end
+
+    def next(params = {})
+      query = Picture.ransack(params[:q])
+      Picture.search_by(params, query).where("name > ?", name).first
+    end
+
     # Updates name and tag_list attributes.
     #
     # Used by +Admin::PicturesController#update_multiple+
@@ -131,7 +147,7 @@ module Alchemy
         self.name = params[:pictures_name]
       end
       self.tag_list = params[:pictures_tag_list]
-      self.save!
+      save!
     end
 
     # Returns a Hash suitable for jquery fileupload json.
@@ -147,10 +163,10 @@ module Alchemy
     # Returns an uri escaped name.
     #
     def urlname
-      if self.name.blank?
-        "image_#{self.id}"
+      if name.blank?
+        "image_#{id}"
       else
-        ::CGI.escape(self.name.gsub(/\.(gif|png|jpe?g|tiff?)/i, '').gsub(/\./, ' '))
+        ::CGI.escape(name.gsub(/\.(gif|png|jpe?g|tiff?)/i, '').tr('.', ' '))
       end
     end
 
@@ -192,7 +208,7 @@ module Alchemy
     # 200 x 100
     #
     def image_file_dimensions
-      "#{image_file_width} x #{image_file_height}"
+      "#{image_file_width}x#{image_file_height}"
     end
 
     # Returns a security token for signed picture rendering requests.
@@ -211,10 +227,9 @@ module Alchemy
       params = params.dup.stringify_keys
       params.update({
         'crop' => params['crop'] ? 'crop' : nil,
-        'id' => self.id
+        'id' => id
       })
       PictureAttributes.secure(params)
     end
-
   end
 end

data/app/models/alchemy/picture/transformations.rb

@@ -1,5 +1,4 @@
 module Alchemy
-
   # This concern can extend classes that expose image_file, image_file_width and image_file_height.
   # It provides methods for cropping and resizing.
   #
@@ -58,7 +57,7 @@ module Alchemy
     # Returns the rendered resized image using imagemagick directly.
     #
     def resize(size, upsample = false)
-      self.image_file.thumb(upsample ? size : "#{size}>")
+      image_file.thumb(upsample ? size : "#{size}>")
     end
 
     # Given a string with an x, this function returns a Hash with point
@@ -67,7 +66,7 @@ module Alchemy
     def sizes_from_string(string = "0x0")
       string = "0x0" if string.nil? || string.empty?
 
-      raise ArgumentError unless string.match(/(\d*x\d*)/)
+      raise ArgumentError unless string =~ /(\d*x\d*)/
 
       width, height = string.scan(/(\d*)x(\d*)/)[0].map(&:to_i)
 
@@ -121,13 +120,13 @@ module Alchemy
     # Returns true if the class we're included in has a meaningful render_size attribute
     #
     def render_size?
-      self.respond_to?(:render_size) && !self.render_size.nil? && !self.render_size.empty?
+      respond_to?(:render_size) && !render_size.nil? && !render_size.empty?
     end
 
     # Returns true if the class we're included in has a meaningful crop_size attribute
     #
-     def crop_size?
-      self.respond_to?(:crop_size) && !self.crop_size.nil? && !self.crop_size.empty?
+    def crop_size?
+      respond_to?(:crop_size) && !crop_size.nil? && !crop_size.empty?
     end
 
     private
@@ -202,7 +201,7 @@ module Alchemy
         x1: point[:x],
         y1: point[:y],
         x2: point[:x] + mask[:width],
-        y2: point[:y] + mask[:height],
+        y2: point[:y] + mask[:height]
       }
     end
 
@@ -230,7 +229,7 @@ module Alchemy
       if is_smaller_than(dimensions) && upsample == false
         dimensions = reduce_to_image(dimensions)
       end
-      self.image_file.thumb("#{dimensions_to_string(dimensions)}#")
+      image_file.thumb("#{dimensions_to_string(dimensions)}#")
     end
 
     # Use imagemagick to custom crop an image. Uses -thumbnail for better performance when resizing.
@@ -241,7 +240,7 @@ module Alchemy
 
       resize_argument = "-resize #{dimensions_to_string(dimensions)}"
       resize_argument += ">" unless upsample
-      self.image_file.convert "#{crop_argument} #{resize_argument}"
+      image_file.convert "#{crop_argument} #{resize_argument}"
     end
 
     # Used when centercropping.