refinerycms-core 0.9.9.1

data/lib/refinery/helpers/form_helper.rb

@@ -0,0 +1,66 @@
+require 'action_view'
+require 'action_view/helpers'
+
+ActionView::Helpers::FormHelper.module_eval do
+
+  def required_label(object_name, method, text = nil, options = {})
+    options = {:class => "required"}.merge!(options)
+
+    label(object_name, method, "#{label_humanize_text(object_name, method, text, options)} *", options)
+  end
+
+
+  def label_humanize_text object_name, method, text = nil, options = {}
+    if text.blank?
+      text = object_name.classify.constantize.respond_to?(:human_attribute_name) ? object_name.classify.constantize.human_attribute_name(method) : method.to_s
+    else
+      text = text.to_s
+    end
+    text.humanize
+  end
+
+end
+
+ActionView::Helpers::FormBuilder.module_eval do
+
+  def required_label(method, text = nil, options = {})
+    @template.required_label(@object_name, method, text, objectify_options(options))
+  end
+
+end
+
+ActionView::Helpers::FormTagHelper.module_eval do
+
+  def required_label_tag(name, text = nil, options = {})
+    options = {:class => "required"}.merge!(options)
+    text ||= "#{name.to_s.humanize} *"
+
+    label_tag(name, text, options)
+  end
+
+end
+
+
+# I18n labels automatically
+module ActionView
+  module Helpers
+    class InstanceTag
+      def to_label_tag(text = nil, options = {})
+        options = options.stringify_keys
+        name_and_id = options.dup
+        add_default_name_and_id(name_and_id)
+        options.delete("index")
+        options["for"] ||= name_and_id["id"]
+        if text.blank?
+          content = method_name.humanize
+          if object.class.respond_to?(:human_attribute_name)
+            content = object.class.human_attribute_name(method_name)
+          end
+        else
+          content = text.to_s
+        end
+        label_tag(name_and_id["id"], content, options)
+      end
+    end
+  end
+end

data/lib/refinery/helpers/head_helper.rb

@@ -0,0 +1,17 @@
+module Refinery
+  module Helpers
+    module HeadHelper
+
+      def stylesheets_for_head(stylesheets, theme = false)
+        # you can disable the use of the built-in refinery stylesheets by disabling the setting.
+        stylesheets.map! {|ss| ["refinery/#{ss}", ss] }.flatten! if RefinerySetting.find_or_set(:frontend_refinery_stylesheets_enabled, true)
+
+        # if theme is set, use themed stylesheet links.
+        stylesheets.map! {|ss| ss =~ /^refinery\// ? ss : "/theme/stylesheets/#{ss}" } if theme
+
+        stylesheets
+      end
+
+    end
+  end
+end

data/lib/refinery/helpers/html_truncation_helper.rb

@@ -0,0 +1,25 @@
+require 'truncate_html'
+
+module Refinery
+  module Helpers
+    module HtmlTruncationHelper
+
+      # Like the Rails _truncate_ helper but doesn't break HTML tags, entities, and words.
+      # <script> tags pass through and are not counted in the total.
+      # the omission specified _does_ count toward the total length count.
+      # use :link => link_to('more', post_path), or something to that effect
+      def truncate(text, options = {})
+        return unless text.present?
+        return super unless options.delete(:preserve_html_tags) == true # ensure preserve_html_tags doesn't pass through
+
+        max_length = options[:length] || 30
+        omission = options[:omission] || "..."
+
+        return truncate_html(text,
+                             :length => max_length,
+                             :word_boundary => true,
+                             :omission => omission)
+      end
+    end
+  end
+end

data/lib/refinery/helpers/image_helper.rb

@@ -0,0 +1,49 @@
+module Refinery
+  module Helpers
+    module ImageHelper
+
+      # replace all system images with a thumbnail version of them (handy for all images inside a page part)
+      # for example, <%= content_fu(@page[:body], '96x96#c') %> converts all /system/images to a 96x96 cropped thumbnail
+      def content_fu(content, thumbnail)
+        content.gsub(%r{<img.+?src=['"](/system/images/.+?)/.+?/>}) do |image_match|
+           begin
+             uid = Dragonfly::Job.from_path(
+                      "#{image_match.match(%r{(/system/images/.+?)/})[1]}", Dragonfly[:images]
+                   ).uid
+
+             image_fu Image.where(:image_uid => uid).first, thumbnail
+           rescue
+             # FAIL, don't care why but return what we found initially.
+             image_match
+           end
+         end
+      end
+
+      # image_fu is a helper for inserting an image that has been uploaded into a template.
+      # Say for example that we had a @model.image (@model having a belongs_to :image relationship)
+      # and we wanted to display a thumbnail cropped to 200x200 then we can use image_fu like this:
+      # <%= image_fu @model.image, '200x200' %> or with no thumbnail: <%= image_fu @model.image %>
+      def image_fu(image, geometry = nil, options={})
+        if image.present?
+          # call rails' image tag function with default alt tag.
+          # if any other options were supplied these are merged in and can replace the defaults.
+          # if the geomtry is nil, then we know the image height and width already.
+          # detect nil geometry or cropping presence which is where we can guess the dimensions
+          unless geometry.nil? or !(split_geometry = geometry.to_s.split('#')).many? or !(split_geometry = split_geometry.first.split('x')).many?
+            image_width, image_height = split_geometry
+          else
+            image_with = nil
+            image_height = nil
+          end
+
+          image_tag(image.thumbnail(geometry).url, {
+            :alt => image.respond_to?(:title) ? image.title : image.image_name,
+            :width => image_width,
+            :height => image_height
+          }.merge(options))
+        end
+      end
+
+    end
+  end
+end

data/lib/refinery/helpers/menu_helper.rb

@@ -0,0 +1,68 @@
+module Refinery
+  module Helpers
+    module MenuHelper
+
+      # Adds conditional caching
+      def cache_if(condition, name = {}, &block)
+        if condition
+          cache(name, &block)
+        else
+          yield
+        end
+
+        # for <%= style helpers vs <% style
+        nil
+      end
+
+      # This was extracted from app/views/shared/_menu_branch.html.erb
+      # to remove the complexity of that template by reducing logic in the view.
+      def css_for_menu_branch(menu_branch, menu_branch_counter, sibling_count = nil, collection = [], selected_item = nil)
+        css = []
+        css << "selected" if selected_page_or_descendant_page_selected?(menu_branch, collection, selected_item)
+        css << "first" if menu_branch_counter == 0
+        css << "last" if menu_branch_counter == (sibling_count ||= menu_branch.shown_siblings.size)
+        css
+      end
+
+      # Determines whether any page underneath the supplied page is the current page according to rails.
+      # Just calls selected_page? for each descendant of the supplied page.
+      # if you pass a collection it won't check its own descendants but use the collection supplied.
+      def descendant_page_selected?(page, collection = [], selected_item = nil)
+        return false unless page.has_descendants? or (selected_item && !selected_item.in_menu?)
+
+        descendants = if collection.present? and (!selected_item or (selected_item && selected_item.in_menu?))
+          collection.select{ |item| item.parent_id == page.id }
+        else
+          page.descendants
+        end
+
+        descendants.any? do |descendant|
+          selected_item ? selected_item == descendant : selected_page?(descendant)
+        end
+      end
+
+      def selected_page_or_descendant_page_selected?(page, collection = [], selected_item = nil)
+        selected = false
+        selected = selected_item ? selected_item === page : selected_page?(page)
+        selected = descendant_page_selected?(page, collection, selected_item) unless selected
+        selected
+      end
+
+      # Determine whether the supplied page is the currently open page according to Refinery.
+      # Also checks whether Rails thinks it is selected after that using current_page?
+      def selected_page?(page)
+        # ensure we match the path without the locale.
+        path = request.path
+        if defined?(::Refinery::I18n) and ::Refinery::I18n.enabled?
+          path = path.split("/#{::I18n.locale}").last
+        end
+
+        (path =~ Regexp.new(page.menu_match) if page.menu_match.present?) or
+          (path == page.link_url) or
+          (path == page.nested_path) or
+          current_page?(page)
+      end
+
+    end
+  end
+end

data/lib/refinery/helpers/meta_helper.rb

@@ -0,0 +1,67 @@
+module Refinery
+  module Helpers
+    module MetaHelper
+
+      # This is used to display the title of the current object (normally a page) in the browser's titlebar.
+      #
+      def browser_title(yield_title=nil)
+        [
+          (yield_title if yield_title.present?),
+          @meta.browser_title.present? ? @meta.browser_title : @meta.path,
+          RefinerySetting.find_or_set(:site_name, "Company Name")
+        ].compact.join(" - ")
+      end
+
+      # you can override the object used for the title by supplying options[:object]
+      # this object must support custom_title_type if you want custom titles.
+      def page_title(options = {})
+        object = options.fetch(:object, @meta)
+        options.delete(:object)
+        options = RefinerySetting.find_or_set(:page_title, {
+          :chain_page_title => false,
+          :ancestors => {
+            :separator => " | ",
+            :class => 'ancestors',
+            :tag => 'span'
+          },
+          :page_title => {
+            :class => nil,
+            :tag => nil,
+            :wrap_if_not_chained => false
+          }
+        }).merge(options)
+
+        title = []
+        objects = (options[:chain_page_title] and object.respond_to?(:ancestors)) ? [object.ancestors, object] : [object]
+
+        objects.flatten.compact.each do |obj|
+          if obj.respond_to?(:custom_title_type)
+            title << case obj.custom_title_type
+              when "text"
+                obj.custom_title
+              when "image"
+                image_fu(obj.custom_title_image, nil, {:alt => obj.title}) rescue obj.title
+              else
+                obj.title
+              end
+          else
+            title << obj.title
+          end
+        end
+
+        final_title = title.pop
+        if (options[:page_title][:wrap_if_not_chained] and title.empty?) and options[:page_title][:tag].present?
+          css = " class='#{options[:page_title][:class]}'" if options[:page_title][:class].present?
+          final_title = "<#{options[:page_title][:tag]}#{css}>#{final_title}</#{options[:page_title][:tag]}>"
+        end
+
+        if title.empty?
+          return final_title.to_s.html_safe
+        else
+          return "<#{options[:ancestors][:tag]} class='#{options[:ancestors][:class]}'>#{title.join options[:ancestors][:separator]}#{options[:ancestors][:separator]}</#{options[:ancestors][:tag]}>#{final_title}".html_safe
+        end
+      end
+
+    end
+  end
+end

data/lib/refinery/helpers/pagination_helper.rb

@@ -0,0 +1,16 @@
+module Refinery
+  module Helpers
+    module PaginationHelper
+
+      # Figures out the CSS classname to apply to your pagination list for animations.
+      def pagination_css_class
+        if request.xhr? and params[:from_page].present? and params[:page].present?
+          "frame_#{params[:from_page].to_s > params[:page].to_s ? 'left' : 'right'}"
+        else
+          "frame_center"
+        end
+      end
+
+    end
+  end
+end

data/lib/refinery/helpers/script_helper.rb

@@ -0,0 +1,36 @@
+module Refinery
+  module Helpers
+    module ScriptHelper
+
+      # This function helps when including both the jquery and jqueryui libraries.
+      # If you use this function then whenever we update or relocate the version of jquery or jquery ui in use
+      # we will update the reference here and your existing application starts to use it.
+      # Use <%= jquery_include_tags %> to include it in your <head> section.
+      def jquery_include_tags(options={})
+        # Merge in options
+        options = {
+          :caching => (Rails.root.writable? and RefinerySetting.find_or_set(:use_resource_caching, true)),
+          :google => RefinerySetting.find_or_set(:use_google_ajax_libraries, false),
+          :jquery_ui => true
+        }.merge(options)
+
+        # render the tags normally unless
+        unless options[:google] and !local_request?
+          if options[:jquery_ui]
+            javascript_include_tag  "jquery#{"-min" if Rails.env.production?}", "jquery-ui-custom-min",
+                                    :cache => ("cache/jquery" if options[:caching])
+          else
+            javascript_include_tag "jquery#{"-min" if Rails.env.production?}"
+          end
+        else
+          "#{javascript_include_tag("http://www.google.com/jsapi").gsub(".js", "")}
+          <script>
+            google.load('jquery', '1.5.0');
+            #{"google.load('jqueryui', '1.8.9');" if options[:jquery_ui]}
+          </script>".html_safe
+        end
+      end
+
+    end
+  end
+end

data/lib/refinery/helpers/site_bar_helper.rb

@@ -0,0 +1,24 @@
+module Refinery
+  module Helpers
+    module SiteBarHelper
+
+      # Generates the link to determine where the site bar switch button returns to.
+      def site_bar_switch_link
+        link_to_if(admin?, t('.switch_to_your_website'),
+                  (if session.keys.include?(:website_return_to) and session[:website_return_to].present?
+                    session[:website_return_to]
+                   else
+                    root_path
+                   end)) do
+          link_to t('.switch_to_your_website_editor'),
+                  (if session.keys.include?(:refinery_return_to) and session[:refinery_return_to].present?
+                    session[:refinery_return_to]
+                   else
+                    admin_root_path
+                   end rescue admin_root_path)
+        end
+      end
+
+    end
+  end
+end

data/lib/refinery/helpers/tag_helper.rb

@@ -0,0 +1,21 @@
+module Refinery
+  module Helpers
+    module TagHelper
+
+      # Returns <span class='help' title='Your Input'>(help)</span>
+      # Remember to wrap your block with <span class='label_with_help'></span> if you're using a label next to the help tag.
+      def refinery_help_tag(title='')
+        title = h(title) unless title.html_safe?
+
+        "<span class=\"help\" title=\"#{title}\">(#{t('help', :scope => 'shared.admin')})</span>".html_safe
+      end
+
+      # This is just a quick wrapper to render an image tag that lives inside refinery/icons.
+      # They are all 16x16 so this is the default but is able to be overriden with supplied options.
+      def refinery_icon_tag(filename, options = {})
+        image_tag "refinery/icons/#{filename}", {:width => 16, :height => 16}.merge(options)
+      end
+
+    end
+  end
+end

data/lib/refinery/helpers/translation_helper.rb

@@ -0,0 +1,17 @@
+module Refinery
+  module Helpers
+    module TranslationHelper
+
+      # Overrides Rails' core I18n.t() function to produce a more helpful error message.
+      # The default one wreaks havoc with CSS and makes it hard to understand the problem.
+      def t(key, options = {})
+        if (val = super) =~ /class.+?translation_missing/
+          val = val.to_s.gsub(/<span[^>]*>/, 'i18n: ').gsub('</span>', '').gsub(', ', '.')
+        end
+
+        val
+      end
+
+    end
+  end
+end

data/lib/refinery/link_renderer.rb

@@ -0,0 +1,55 @@
+class Refinery::LinkRenderer < WillPaginate::ViewHelpers::LinkRenderer
+
+# TODO: Rewrite for WillPaginate 3 API
+
+=begin
+
+  attr_accessor :url
+
+  def url_for(page)
+    # extract any url parameter and store it for subsequent requests but delete it
+    # this is so that we don't end up with it being an attribute of the resulting HTML.
+    @url ||= @options.delete(:url) || {}
+    page_one = page == 1
+    @url_params = {}
+    # page links should preserve GET parameters
+    stringified_merge @url_params, @template.params if @template.request.get?
+    stringified_merge @url_params, @options[:params] if @options[:params]
+
+    if complex = param_name.index(/[^\w-]/)
+      page_param = parse_query_parameters("#{param_name}=#{page}")
+
+      stringified_merge @url_params, page_param
+    else
+      @url_params[param_name] = page_one ? 1 : 2
+    end
+
+    url = @template.url_for(@url_params.merge!(@url).to_options)
+    return url if page_one
+
+    if complex
+      @url_string = url.sub(%r!((?:\?|&amp;)#{CGI.escape param_name}=)#{page}!, '\1@')
+      return url
+    else
+      @url_string = url
+      @url_params[param_name] = 3
+      @template.url_for(@url_params).split(//).each_with_index do |char, i|
+        if char == '3' and url[i, 1] == '2'
+          @url_string[i] = '@'
+          break
+        end
+      end
+    end
+    # finally!
+    @url_string.sub '@', page.to_s
+  end
+
+private
+
+  def param_name
+    @options[:param_name].to_s
+  end
+
+=end
+
+end