alchemy_cms 2.9.1 → 3.0.0.rc5

data/app/models/alchemy/page/{page_cells.rb → cells.rb}

@@ -1,5 +1,5 @@
 module Alchemy
-  module Page::PageCells
+  module Page::Cells
 
     extend ActiveSupport::Concern
 
@@ -58,7 +58,7 @@ module Alchemy
       layout_description['elements'].uniq - element_names_from_cells
     end
 
-  private
+    private
 
     # Creates cells that are defined in page's page_layout definition.
     def create_cells

data/app/models/alchemy/page/{page_elements.rb → elements.rb}

@@ -1,14 +1,14 @@
 module Alchemy
-  module Page::PageElements
+  module Page::Elements
 
     extend ActiveSupport::Concern
 
     included do
       attr_accessor :do_not_autogenerate
 
-      has_many :elements, :order => :position
+      has_many :elements, -> { order(:position) }
       has_many :contents, :through => :elements
-      has_and_belongs_to_many :to_be_sweeped_elements, :class_name => 'Alchemy::Element', :uniq => true, :join_table => 'alchemy_elements_alchemy_pages'
+      has_and_belongs_to_many :to_be_sweeped_elements, -> { uniq }, class_name: 'Alchemy::Element', join_table: 'alchemy_elements_alchemy_pages'
 
       after_create :autogenerate_elements, :unless => proc { systempage? || do_not_autogenerate }
       after_update :trash_not_allowed_elements, :if => :page_layout_changed?
@@ -181,7 +181,7 @@ module Alchemy
     # If the page has cells, it looks if there are elements to generate.
     #
     def autogenerate_elements
-      elements_already_on_page = self.elements.available.collect(&:name)
+      elements_already_on_page = self.elements.available.pluck(:name)
       elements = self.layout_description["autogenerate"]
       if elements.present?
         elements.each do |element|
@@ -246,8 +246,7 @@ module Alchemy
         cell.elements
       else
         Alchemy::Logger.warn("Cell with name `#{name}` could not be found!", caller.first)
-        # Returns an empty relation. Can be removed with the release of Rails 4
-        self.elements.where('1 = 0')
+        Element.none
       end
     end
 

data/app/models/alchemy/page/{page_naming.rb → naming.rb}

@@ -1,12 +1,12 @@
 module Alchemy
-  module Page::PageNaming
+  module Page::Naming
 
     extend ActiveSupport::Concern
     include NameConversions
     RESERVED_URLNAMES = %w(admin messages new)
 
     included do
-      before_validation :set_urlname, :if => :renamed?, :unless => proc { systempage? || redirects_to_external? }
+      before_validation :set_urlname, :if => :renamed?, :unless => proc { systempage? || redirects_to_external? || name.blank? }
 
       validates_presence_of :name
       validates_length_of :urlname, :minimum => 3, :if => 'urlname.present?'
@@ -31,19 +31,14 @@ module Alchemy
     end
 
     # Makes a slug of all ancestors urlnames including mine and delimit them be slash.
-    # So the whole path is stored as urlname in tha database.
+    # So the whole path is stored as urlname in the database.
     def update_urlname!
       names = ancestors.visible.contentpages.where(language_root: nil).map(&:slug).compact
       new_urlname = (names << slug).join('/')
-      # update without callbacks
-      if new_record?
-        write_attribute :urlname, new_urlname
-      else
-        if urlname != new_urlname
-          legacy_urls.create(:urlname => urlname)
-        end
-        update_column :urlname, new_urlname
+      if urlname != new_urlname
+        legacy_urls.create(urlname: urlname)
       end
+      update_column(:urlname, new_urlname)
     end
 
     # Returns always the last part of a urlname path

data/app/models/alchemy/page/{page_natures.rb → natures.rb}

@@ -1,5 +1,5 @@
 module Alchemy
-  module Page::PageNatures
+  module Page::Natures
 
     extend ActiveSupport::Concern
 
@@ -27,7 +27,7 @@ module Alchemy
 
     # Returns true or false if the pages layout_description for config/alchemy/page_layouts.yml contains redirects_to_external: true
     def redirects_to_external?
-      !!definition["redirects_to_external"]
+      definition["redirects_to_external"]
     end
 
     def has_controller?
@@ -81,9 +81,33 @@ module Alchemy
       I18n.t(self.page_layout, :scope => :page_layout_names)
     end
 
-    # Overwrites the cache_key method.
-    def cache_key(request = nil)
-      "alchemy/pages/#{id}"
+    # Returns the name for the layout partial
+    #
+    def layout_partial_name
+      page_layout.parameterize.underscore
+    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
+
+    # 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
 
   end

data/app/models/alchemy/page/{page_scopes.rb → scopes.rb}

@@ -2,21 +2,21 @@ module Alchemy
 
   # ActiveRecord scopes for Alchemy::Page
   #
-  module Page::PageScopes
+  module Page::Scopes
     extend ActiveSupport::Concern
 
     included do
       # All language root pages
       #
-      scope :language_roots, where(language_root: true)
+      scope :language_roots, -> { where(language_root: true) }
 
       # All layout pages
       #
-      scope :layoutpages, where(layoutpage: true)
+      scope :layoutpages, -> { where(layoutpage: true) }
 
       # All locked pages
       #
-      scope :all_locked, where(locked: true)
+      scope :all_locked, -> { where(locked: true) }
 
       # All pages locked by given user
       #
@@ -26,29 +26,29 @@ module Alchemy
 
       # All not locked pages
       #
-      scope :not_locked, where(locked: false)
+      scope :not_locked, -> { where(locked: false) }
 
       # All visible pages
       #
-      scope :visible, where(visible: true)
+      scope :visible, -> { where(visible: true) }
 
       # All public pages
       #
-      scope :published, where(public: true)
+      scope :published, -> { where(public: true) }
 
       # All not restricted pages
       #
-      scope :not_restricted, where(restricted: false)
+      scope :not_restricted, -> { where(restricted: false) }
 
       # All restricted pages
       #
-      scope :restricted, where(restricted: true)
+      scope :restricted, -> { where(restricted: true) }
 
       # All pages that are a published language root
       #
       scope :public_language_roots, -> {
         published.language_roots.where(
-          language_code: Language.all_codes_for_published
+          language_code: Language.published.pluck(:code)
         )
       }
 
@@ -66,17 +66,17 @@ 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.
       #
       # Used for flushing all pages caches at once.
       #
-      scope :flushables, not_locked.published.contentpages
+      scope :flushables, -> { not_locked.published.contentpages }
 
       # All searchable pages
       #
-      scope :searchables, not_restricted.published.contentpages
+      scope :searchables, -> { not_restricted.published.contentpages }
 
       # All pages from +Alchemy::Site.current+
       #
@@ -86,7 +86,7 @@ module Alchemy
 
       # All pages for xml sitemap
       #
-      scope :sitemap, from_current_site.published.contentpages.where(sitemap: true)
+      scope :sitemap, -> { from_current_site.published.contentpages.where(sitemap: true) }
     end
 
   end

data/app/models/alchemy/page/{page_users.rb → users.rb}

@@ -1,5 +1,5 @@
 module Alchemy
-  module Page::PageUsers
+  module Page::Users
     extend ActiveSupport::Concern
 
     # Returns the name of the creator of this page.
@@ -8,7 +8,7 @@ module Alchemy
     # does not respond to +#name+ it returns +'unknown'+
     #
     def creator_name
-      (creator && creator.respond_to?(:name) ? creator.name : nil) || I18n.t('unknown')
+      (creator && creator.try(:name)) || I18n.t('unknown')
     end
 
     # Returns the name of the last updater of this page.
@@ -17,7 +17,7 @@ module Alchemy
     # does not respond to +#name+ it returns +'unknown'+
     #
     def updater_name
-      (updater && updater.respond_to?(:name) ? updater.name : nil) || I18n.t('unknown')
+      (updater && updater.try(:name)) || I18n.t('unknown')
     end
 
     # Returns the name of the user currently editing this page.
@@ -26,7 +26,7 @@ module Alchemy
     # does not respond to +#name+ it returns +'unknown'+
     #
     def locker_name
-      (locker && locker.respond_to?(:name) ? locker.name : nil) || I18n.t('unknown')
+      (locker && locker.try(:name)) || I18n.t('unknown')
     end
 
   end

data/app/models/alchemy/picture.rb

@@ -1,61 +1,81 @@
-require 'acts-as-taggable-on'
-require 'dragonfly'
+# == Schema Information
+#
+# Table name: alchemy_pictures
+#
+#  id                :integer          not null, primary key
+#  name              :string(255)
+#  image_file_name   :string(255)
+#  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)
+#  cached_tag_list   :text
+#  image_file_uid    :string(255)
+#  image_file_size   :integer
+#
 
 module Alchemy
   class Picture < ActiveRecord::Base
     include Alchemy::NameConversions
+    include Alchemy::Touching
+    include Alchemy::Picture::Sweeping
 
-    has_many :essence_pictures, :class_name => 'Alchemy::EssencePicture', :foreign_key => 'picture_id'
-    has_many :contents, :through => :essence_pictures
-    has_many :elements, :through => :contents
-    has_many :pages, :through => :elements
+    has_many :essence_pictures, class_name: 'Alchemy::EssencePicture', foreign_key: 'picture_id'
+    has_many :contents, through: :essence_pictures
+    has_many :elements, through: :contents
+    has_many :pages, through: :elements
 
     # Raise error, if picture is in use (aka. assigned to an EssencePicture)
     #
-    # === CAUTION:
-    # This HAS to be placed for Dragonfly's class methods, to ensure this runs before Dragonfly's before_destroy callback.
+    # === CAUTION
     #
-    before_destroy :unless => :deletable? do
-      raise PictureInUseError, I18n.t(:cannot_delete_picture_notice) % { :name => name }
+    # This HAS to be placed for Dragonfly's class methods,
+    # 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 }
     end
 
-    image_accessor :image_file do
+    dragonfly_accessor :image_file, app: :alchemy_pictures do
       if Config.get(:preprocess_image_resize).present?
         after_assign { |a| a.process!(:resize, "#{Config.get(:preprocess_image_resize)}>") }
       end
     end
 
     validates_presence_of :image_file
-    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'], :case_sensitive => false, :message => I18n.t("not a valid image")
+    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'],
+      case_sensitive: false,
+      message: I18n.t("not a valid image")
 
     acts_as_taggable
 
-    attr_accessible(
-      :image_file,
-      :name,
-      :tag_list,
-      :upload_hash
-    )
-
     stampable stamper_class_name: Alchemy.user_class_name
 
-    scope :recent, where("#{self.table_name}.created_at > ?", Time.now-24.hours).order(:created_at)
-    scope :deletable, where("alchemy_pictures.id NOT IN (SELECT picture_id FROM alchemy_essence_pictures)")
-    scope :without_tag, where("cached_tag_list IS NULL OR cached_tag_list = ''")
+    scope :named,       ->(name) { where("name LIKE ?", "%#{name}%") }
+    scope :recent,      -> { where("#{self.table_name}.created_at > ?", Time.now - 24.hours).order(:created_at) }
+    scope :deletable,   -> { where('alchemy_pictures.id NOT IN (SELECT picture_id FROM alchemy_essence_pictures)') }
+    scope :without_tag, -> { where("cached_tag_list IS NULL OR cached_tag_list = ''") }
+
+    after_update :touch_contents
 
     # Class methods
 
     class << self
 
       def find_paginated(params, per_page)
-        Picture.where("name LIKE ?", "%#{params[:query]}%").page(params[:page] || 1).per(per_page).order(:name)
+        Picture.named(params[:query]).page(params[:page] || 1).per(per_page).order(:name)
       end
 
       def last_upload
         last_picture = Picture.last
-        return Picture.scoped unless last_picture
-        Picture.where(:upload_hash => last_picture.upload_hash)
+        return Picture.all unless last_picture
+        Picture.where(upload_hash: last_picture.upload_hash)
       end
 
       def filtered_by(filter = '')
@@ -64,7 +84,7 @@ module Alchemy
           when 'last_upload' then last_upload
           when 'without_tag' then without_tag
         else
-          scoped
+          all
         end
       end
 
@@ -72,6 +92,32 @@ module Alchemy
 
     # Instance methods
 
+    # Updates name and tag_list attributes.
+    #
+    # Used by +Admin::PicturesController#update_multiple+
+    #
+    # Note: Does not delete name value, if the form field is blank.
+    #
+    def update_name_and_tag_list!(params)
+      if params[:pictures_name].present?
+        self.name = params[:pictures_name]
+      end
+      self.tag_list = params[:pictures_tag_list]
+      self.save!
+    end
+
+    # Returns a Hash suitable for jquery fileupload json.
+    #
+    def to_jq_upload
+      {
+        name: image_file_name,
+        size: image_file_size,
+        error: errors[:image_file].join
+      }
+    end
+
+    # Returns an uri escaped name.
+    #
     def urlname
       if self.name.blank?
         "image_#{self.id}"
@@ -80,34 +126,42 @@ module Alchemy
       end
     end
 
+    # Returns the suffix of the filename.
+    #
     def suffix
       image_file.ext
     end
 
+    # Returns a humanized, readable name from image filename.
+    #
     def humanized_name
       return "" if image_file_name.blank?
       convert_to_humanized_name(image_file_name, suffix)
     end
 
-    # Returning true if picture's width is greater than it's height
+    # Returns true if picture's width is greater than it's height
+    #
     def landscape_format?
       image_file.landscape?
     end
     alias_method :landscape?, :landscape_format?
 
-    # Returning true if picture's width is smaller than it's height
+    # Returns true if picture's width is smaller than it's height
+    #
     def portrait_format?
       image_file.portrait?
     end
     alias_method :portrait?, :portrait_format?
 
-    # Returning true if picture's width and height is equal
+    # Returns true if picture's width and height is equal
+    #
     def square_format?
       image_file.aspect_ratio == 1.0
     end
     alias_method :square?, :square_format?
 
-    # Returns the default centered image mask for a given size
+    # Returns the default centered image mask for a given size.
+    #
     def default_mask(size)
       raise "No size given" if size.blank?
       width = size.split('x')[0].to_i
@@ -133,18 +187,19 @@ module Alchemy
         y2 = image_file_height
       end
       {
-        :x1 => x1,
-        :y1 => y1,
-        :x2 => x2,
-        :y2 => y2
+        x1: x1,
+        y1: y1,
+        x2: x2,
+        y2: y2
       }
     end
 
+    # Returns a size value String for the thumbnail used in essence picture editors.
+    #
     def cropped_thumbnail_size(size)
       return "111x93" if size == "111x93" || size.blank?
       x = size.split('x')[0].to_i
       y = size.split('x')[1].to_i
-      return "111x93" if x.zero? || y.zero?
       if (x > y)
         zoom_factor = 111.0 / x
         new_x = 111
@@ -157,15 +212,30 @@ module Alchemy
       "#{new_x.round}x#{new_y.round}"
     end
 
-    # Checks if the picture is restricted, because it is attached on restricted pages only
+    # Checks if the picture is restricted.
+    #
+    # A picture is only restricted if it's assigned on restricted pages only.
+    #
+    # Once a picture is assigned on a not restricted page,
+    # it is considered public and therefore not restricted any more,
+    # even if it is also assigned on a restricted page.
+    #
     def restricted?
       pages.any? && pages.not_restricted.blank?
     end
 
+    # Returns true if picture is not assigned to any EssencePicture.
+    #
     def deletable?
       !essence_pictures.any?
     end
 
+    # A size String from original image file values.
+    #
+    # == Example
+    #
+    # 200 x 100
+    #
     def image_file_dimensions
       "#{image_file_width} x #{image_file_height}"
     end
@@ -183,10 +253,12 @@ module Alchemy
     # to sign them.
     #
     def security_token(params = {})
-      @params = params.stringify_keys
-      @params.update({'crop' => @params['crop'] ? 'crop' : nil, 'id' => self.id})
-      @params.delete_if { |k,v| v.nil? }
-      PictureAttributes.secure(@params)
+      params = params.dup.stringify_keys
+      params.update({
+        'crop' => params['crop'] ? 'crop' : nil,
+        'id' => self.id
+      })
+      PictureAttributes.secure(params)
     end
 
   end