alchemy_cms 3.0.4 → 3.1.0.beta1

data/app/controllers/alchemy/api/base_controller.rb

@@ -0,0 +1,19 @@
+module Alchemy
+  class API::BaseController < Alchemy::BaseController
+    layout false
+    respond_to :json
+
+    rescue_from CanCan::AccessDenied,         with: :render_not_authorized
+    rescue_from ActiveRecord::RecordNotFound, with: :render_not_found
+
+    private
+
+    def render_not_authorized
+      render json: {error: 'Not authorized'}, status: 403
+    end
+
+    def render_not_found
+      render json: {error: 'Record not found'}, status: 404
+    end
+  end
+end

data/app/controllers/alchemy/api/contents_controller.rb

@@ -0,0 +1,35 @@
+module Alchemy
+  class API::ContentsController < API::BaseController
+
+    # Returns all contents as json object
+    #
+    # You can either load all or only these for :element_id param
+    #
+    def index
+      @contents = Content.accessible_by(current_ability, :index)
+      if params[:element_id]
+        @contents = @contents.where(element_id: params[:element_id])
+      end
+      respond_with @contents
+    end
+
+    # Returns a json object for content
+    #
+    # You can either load it from :id param
+    # or even more useful via passing the element id and the name of the content
+    #
+    #   $ bin/rake routes
+    #
+    # for more infos on how the url looks like.
+    #
+    def show
+      if params[:id]
+        @content = Content.find(params[:id])
+      elsif params[:element_id] && params[:name]
+        @content = Content.find_by!(element_id: params[:element_id], name: params[:name])
+      end
+      authorize! :show, @content
+      respond_with @content
+    end
+  end
+end

data/app/controllers/alchemy/api/elements_controller.rb

@@ -0,0 +1,29 @@
+module Alchemy
+  class API::ElementsController < API::BaseController
+
+    # Returns all elements as json object
+    #
+    # You can either load all or only these for :page_id param
+    #
+    # If you want to only load a specific type of element pass ?named=an_element_name
+    #
+    def index
+      @elements = Element.accessible_by(current_ability, :index)
+      if params[:page_id]
+        @elements = @elements.where(page_id: params[:page_id])
+      end
+      if params[:named]
+        @elements = @elements.named(params[:named])
+      end
+      respond_with @elements
+    end
+
+    # Returns a json object for element
+    #
+    def show
+      @element = Element.find(params[:id])
+      authorize! :show, @element
+      respond_with @element
+    end
+  end
+end

data/app/controllers/alchemy/api/pages_controller.rb

@@ -0,0 +1,32 @@
+module Alchemy
+  class API::PagesController < API::BaseController
+    before_action :load_page, only: [:show]
+
+    # Returns all pages as json object
+    #
+    def index
+      @pages = Page.accessible_by(current_ability, :index)
+      if params[:page_layout]
+        @pages = @pages.where(page_layout: params[:page_layout])
+      end
+      respond_with @pages
+    end
+
+    # Returns a json object for page
+    #
+    # You can either load the page via id or its urlname
+    #
+    def show
+      authorize! :show, @page
+      respond_with @page
+    end
+
+    private
+
+    def load_page
+      @page = Page.find_by(id: params[:id]) ||
+              Page.find_by(urlname: params[:urlname]) ||
+              raise(ActiveRecord::RecordNotFound)
+    end
+  end
+end

data/app/controllers/alchemy/contents_controller.rb

@@ -10,6 +10,7 @@ module Alchemy
     respond_to :json
 
     def show
+      ActiveSupport::Deprecation.warn('The Alchemy contents json API moved to `api` namespace. Please use `/api/contents` for json requests instead.')
       respond_with @content
     end
 

data/app/controllers/alchemy/elements_controller.rb

@@ -21,8 +21,11 @@ module Alchemy
 
       respond_to do |format|
         format.html
-        format.js   { @container_id = params[:container_id] }
-        format.json { render json: @element }
+        format.js { @container_id = params[:container_id] }
+        format.json do
+          ActiveSupport::Deprecation.warn("The Alchemy elements json API moved to `api` namespace. Please use `/api/elements` for json requests instead.")
+          render json: @element, serializer: LegacyElementSerializer
+        end
       end
     end
 

data/app/controllers/alchemy/pages_controller.rb

@@ -26,7 +26,10 @@ module Alchemy
               render xml: {error: 'Not found'}, status: 404
             end
           end
-          format.json { render json: @page }
+          format.json do
+            ActiveSupport::Deprecation.warn('The Alchemy pages json API moved to `api` namespace. Please use `/api/pages` for json requests instead.')
+            render json: @page
+          end
         end
       end
     end

data/app/controllers/alchemy/pictures_controller.rb

@@ -62,52 +62,20 @@ module Alchemy
     # Return the processed image dependent of size and cropping parameters
     def processed_image
       @image = @picture.image_file
+      @upsample = params[:upsample] == 'true' ? true : false
       if @image.nil?
         raise MissingImageFileError, "Missing image file for #{@picture.inspect}"
       end
       if @size.present?
-        if params[:crop_size].present? && params[:crop_from].present?
-          @image = @image.thumb xy_crop_geometry_string(params)
-          @image.thumb(resize_geometry_string)
-        elsif params[:crop]
-          @image.thumb(center_crop_geometry_string)
+        if params[:crop_size].present? && params[:crop_from].present? || params[:crop].present?
+          @picture.crop(@size, params[:crop_from], params[:crop_size], @upsample)
         else
-          @image.thumb(resize_geometry_string)
+          @picture.resize(@size, @upsample)
         end
       else
         @image
       end
     end
 
-    # Returns the Imagemagick geometry string for cropping the image.
-    def xy_crop_geometry_string(params)
-      crop_from_x, crop_from_y = params[:crop_from].split('x')
-      "#{params[:crop_size]}+#{crop_from_x}+#{crop_from_y}"
-    end
-
-    # Returns the Imagemagick geometry string used to resize the image.
-    #
-    # Prevents upscaling unless :upsample param is true.
-    def resize_geometry_string
-      params[:upsample] == 'true' ? @size : "#{@size}>"
-    end
-
-    # Returns the Imagemagick geometry string used to crop the image.
-    #
-    # Prevents upscaling unless :upsample param is true
-    def center_crop_geometry_string
-      params[:upsample] == 'true' ? "#{@size}#" : "#{normalized_sizes(*@size.split('x'))}#"
-    end
-
-    # Ensure we're not trying to scale the image up. Used only for cropping.
-    def normalized_sizes(width, height)
-      if width.to_i > @image.width
-        width = @image.width
-      end
-      if height.to_i > @image.height
-        height = @image.height
-      end
-      "#{width}x#{height}"
-    end
   end
 end

data/app/helpers/alchemy/admin/essences_helper.rb

@@ -59,11 +59,14 @@ module Alchemy
 
       def essence_picture_thumbnail(content, options)
         return if content.ingredient.blank?
+        crop = !(content.essence.crop_size.blank? && content.essence.crop_from.blank?) ||
+          (content_settings_value(content, :crop, options) == true || content_settings_value(content, :crop, options) == "true")
         image_options = {
-          size: content.ingredient.cropped_thumbnail_size(content.essence.render_size.blank? ? options[:image_size] : content.essence.render_size),
+          size: content.essence.thumbnail_size(content.essence.render_size.blank? ? content_settings_value(content, :size, options) : content.essence.render_size, crop),
           crop_from: content.essence.crop_from.blank? ? nil : content.essence.crop_from,
           crop_size: content.essence.crop_size.blank? ? nil : content.essence.crop_size,
-          crop: content.essence.crop_size.blank? && content.essence.crop_from.blank? ? 'crop' : nil
+          crop: crop ? 'crop' : nil,
+          upsample: content_settings_value(content, :upsample, options)
         }
         image_tag(
           alchemy.thumbnail_path({

data/app/helpers/alchemy/essences_helper.rb

@@ -92,7 +92,10 @@ module Alchemy
     # Renders a essence picture
     #
     def render_essence_picture_view(content, options, html_options)
-      options = {show_caption: true, disable_link: false}.update(options)
+      options = {
+        show_caption: true,
+        disable_link: false
+      }.update(content.settings).update(options)
       return if content.ingredient.blank?
       if content.essence.caption.present? && options[:show_caption]
         caption = content_tag(:figcaption, content.essence.caption, id: "#{dom_id(content.ingredient)}_caption", class: "image_caption")
@@ -121,5 +124,15 @@ module Alchemy
       end
     end
 
+    # Fetches value from settings of given content
+    #
+    # @param content [Alchemy::Content] - The content that settings should be taken
+    # @param key [Symbol]               - The hash key you want to fetch the value from
+    # @param options [Hash]             - An optional Hash that can override the settings.
+    #                                     Normally passed as options hash into the content editor view
+    def content_settings_value(content, key, options = {})
+      content.settings.update(options || {}).symbolize_keys[key.to_sym]
+    end
+
   end
 end

data/app/models/alchemy/content.rb

@@ -51,6 +51,14 @@ module Alchemy
     scope :essence_selects,   -> { where(essence_type: "Alchemy::EssenceSelect") }
     scope :essence_texts,     -> { where(essence_type: "Alchemy::EssenceText") }
     scope :named,             ->(name) { where(name: name) }
+    scope :available,         -> { published.not_trashed }
+    scope :published,         -> { joins(:element).merge(Element.published) }
+    scope :not_trashed,       -> { joins(:element).merge(Element.not_trashed) }
+    scope :not_restricted,    -> { joins(:element).merge(Element.not_restricted) }
+
+    delegate :restricted?, to: :element, allow_nil: true
+    delegate :trashed?,    to: :element, allow_nil: true
+    delegate :public?,     to: :element, allow_nil: true
 
     class << self
       # Returns the translated label for a content name.
@@ -99,9 +107,7 @@ module Alchemy
     # Settings from the elements.yml definition
     def settings
       return {} if description.blank?
-      @settings ||= description['settings']
-      return {} if @settings.blank?
-      @settings.symbolize_keys
+      @settings ||= description.fetch('settings', {}).symbolize_keys
     end
 
     def siblings
@@ -115,6 +121,25 @@ module Alchemy
       essence.ingredient
     end
 
+    # Serialized object representation for json api
+    #
+    def serialize
+      {
+        name: name,
+        value: serialized_ingredient,
+        link: essence.try(:link)
+      }.delete_if { |_k, v| v.blank? }
+    end
+
+    # Ingredient value from essence for json api
+    #
+    # If the essence responds to +serialized_ingredient+ method it takes this
+    # otherwise it uses the ingredient column.
+    #
+    def serialized_ingredient
+      essence.try(:serialized_ingredient) || ingredient
+    end
+
     # Sets the ingredient from essence
     def ingredient=(value)
       raise EssenceMissingError if essence.nil?
@@ -184,7 +209,10 @@ module Alchemy
 
     # Returns true if this content should be taken for element preview.
     def preview_content?
-      !!description['take_me_for_preview']
+      if description['take_me_for_preview']
+        ActiveSupport::Deprecation.warn("Content definition's `take_me_for_preview` key is deprecated. Please use `as_element_title` instead.")
+      end
+      !!description['take_me_for_preview'] || !!description['as_element_title']
     end
 
     # Proxy method that returns the preview text from essence.

data/app/models/alchemy/element.rb

@@ -52,7 +52,7 @@ module Alchemy
     scope :trashed,           -> { where(position: nil).order('updated_at DESC') }
     scope :not_trashed,       -> { where(Element.arel_table[:position].not_eq(nil)) }
     scope :published,         -> { where(public: true) }
-    scope :not_restricted,    -> { joins(:page).where('alchemy_pages' => {restricted: false}) }
+    scope :not_restricted,    -> { joins(:page).merge(Page.not_restricted) }
     scope :available,         -> { published.not_trashed }
     scope :named,             ->(names) { where(name: names) }
     scope :excluded,          ->(names) { where(arel_table[:name].not_in(names)) }
@@ -361,7 +361,7 @@ module Alchemy
               "fields.#{content_name}.#{error}".to_sym,
               "errors.#{error}".to_sym
             ],
-            field: Content.translated_label_for(content_name, name)
+            field: Content.translated_label_for(content_name)
           )
         end
       end
@@ -421,20 +421,6 @@ module Alchemy
       "alchemy/elements/#{name}_view"
     end
 
-    # Returns the key that's taken for cache path.
-    #
-    # Uses the page's +published_at+ value that's updated when the user publishes the page.
-    #
-    # If the page is the current preview it uses the element's updated_at value as cache key.
-    #
-    def cache_key
-      if Page.current_preview == self.page
-        "alchemy/elements/#{id}-#{updated_at}"
-      else
-        "alchemy/elements/#{id}-#{page.published_at}"
-      end
-    end
-
     private
 
     # creates the contents for this element as described in the elements.yml

data/app/models/alchemy/element/presenters.rb

@@ -39,7 +39,7 @@ module Alchemy
     #
     # It's taken from the first Content found in the +elements.yml+ description file.
     #
-    # You can flag a Content as +take_me_for_preview+ to take this as preview.
+    # You can flag a Content as +as_element_title+ to take this as preview.
     #
     # @param maxlength [Fixnum] (30)
     #   Length of characters after the text will be cut off.
@@ -63,7 +63,7 @@ module Alchemy
     #         type: EssenceText
     #       - name: text
     #         type EssenceRichtext
-    #         take_me_for_preview: true
+    #         as_element_title: true
     #
     # With "I want to tell you a funky story" as stripped_body for the EssenceRichtext Content produces:
     #

data/app/models/alchemy/essence_file.rb

@@ -27,6 +27,11 @@ module Alchemy
       attachment.name.to_s[0..max-1]
     end
 
+    # Returns a serialized ingredient value for json api
+    def serialized_ingredient
+      attachment_url
+    end
+
     private
 
     def routes

data/app/models/alchemy/essence_picture.rb

@@ -26,9 +26,12 @@ module Alchemy
     acts_as_essence ingredient_column: 'picture'
 
     belongs_to :picture
+    delegate :image_file_width, :image_file_height, :image_file, to: :picture
     before_save :fix_crop_values
     before_save :replace_newlines
 
+    include Alchemy::Picture::Transformations
+
     # The url to show the picture.
     #
     # Takes all values like +name+ and crop sizes (+crop_from+, +crop_size+ from the build in graphical image cropper)
@@ -70,14 +73,15 @@ module Alchemy
     #
     def cropping_mask
       return if crop_from.blank? || crop_size.blank?
-      crop_from = read_attribute(:crop_from).split('x')
-      crop_size = read_attribute(:crop_size).split('x')
-      {
-        x1: crop_from[0].to_i,
-        y1: crop_from[1].to_i,
-        x2: crop_from[0].to_i + crop_size[0].to_i,
-        y2: crop_from[1].to_i + crop_size[1].to_i
-      }
+      crop_from = point_from_string(read_attribute(:crop_from))
+      crop_size = sizes_from_string(read_attribute(:crop_size))
+
+      point_and_mask_to_points(crop_from, crop_size)
+    end
+
+    # Returns a serialized ingredient value for json api
+    def serialized_ingredient
+      picture_url(content.settings)
     end
 
     private

data/app/models/alchemy/picture.rb

@@ -22,6 +22,7 @@ module Alchemy
     include Alchemy::NameConversions
     include Alchemy::Touching
     include Alchemy::Picture::Sweeping
+    include Alchemy::Picture::Transformations
 
     has_many :essence_pictures, class_name: 'Alchemy::EssencePicture', foreign_key: 'picture_id'
     has_many :contents, through: :essence_pictures
@@ -143,80 +144,6 @@ module Alchemy
       convert_to_humanized_name(image_file_name, suffix)
     end
 
-    # Returns true if picture's width is greater than it's height
-    #
-    def landscape_format?
-      image_file.landscape?
-    end
-    alias_method :landscape?, :landscape_format?
-
-    # Returns true if picture's width is smaller than it's height
-    #
-    def portrait_format?
-      image_file.portrait?
-    end
-    alias_method :portrait?, :portrait_format?
-
-    # 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.
-    #
-    def default_mask(size)
-      raise "No size given" if size.blank?
-      width = size.split('x')[0].to_i
-      height = size.split('x')[1].to_i
-      if (width > height)
-        zoom_factor = image_file_width.to_f / width
-        mask_height = (height * zoom_factor).round
-        x1 = 0
-        x2 = image_file_width
-        y1 = (image_file_height - mask_height) / 2
-        y2 = y1 + mask_height
-      elsif (width == 0 && height == 0)
-        x1 = 0
-        x2 = image_file_width
-        y1 = 0
-        y2 = image_file_height
-      else
-        zoom_factor = image_file_height.to_f / height
-        mask_width = (width * zoom_factor).round
-        x1 = (image_file_width - mask_width) / 2
-        x2 = x1 + mask_width
-        y1 = 0
-        y2 = image_file_height
-      end
-      {
-        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
-        new_y = y * zoom_factor
-      else
-        zoom_factor = 93.0 / y
-        new_x = x * zoom_factor
-        new_y = 93
-      end
-      "#{new_x.round}x#{new_y.round}"
-    end
-
     # Checks if the picture is restricted.
     #
     # A picture is only restricted if it's assigned on restricted pages only.