refinerycms 0.9.8.9 → 0.9.9

data/settings/app/controllers/admin/refinery_settings_controller.rb

@@ -0,0 +1,77 @@
+module Admin
+  class RefinerySettingsController < Admin::BaseController
+
+    helper :refinery_settings
+
+    crudify :refinery_setting,
+            :title_attribute => :title,
+            :order => "name ASC",
+            :redirect_to_url => :redirect_to_where?
+
+    before_filter :sanitise_params, :only => [:create, :update]
+    after_filter :fire_setting_callback, :only => [:update]
+
+    def index
+      search_all_refinery_settings if searching?
+      paginate_all_refinery_settings
+
+      render :partial => 'refinery_settings' if request.xhr?
+    end
+
+    def new
+      if current_user.has_role?(:superuser) and params[:form_value_type].present?
+        @refinery_setting = RefinerySetting.new(:form_value_type => params[:form_value_type])
+      else
+        @refinery_setting = RefinerySetting.new(:form_value_type => 'text_area')
+      end
+    end
+
+    def edit
+      @refinery_setting = RefinerySetting.find(params[:id])
+
+      render :layout => false if request.xhr?
+    end
+
+  protected
+    def find_all_refinery_settings
+      @refinery_settings = RefinerySetting.order('name ASC')
+
+      unless current_user.has_role?(:superuser)
+        @refinery_settings = @refinery_settings.where("restricted <> ? ", true)
+      end
+
+      @refinery_settings
+    end
+
+    def search_all_refinery_settings
+      # search for settings that begin with keyword
+      term = "^" + params[:search].to_s.downcase.gsub(' ', '_')
+
+      # First find normal results, then weight them with the query.
+       @refinery_settings = find_all_refinery_settings.with_query(term)
+    end
+
+  private
+    def redirect_to_where?
+      (from_dialog? && session[:return_to].present?) ? session[:return_to] : admin_refinery_settings_url
+    end
+
+    # this fires before an update or create to remove any attempts to pass sensitive arguments.
+    def sanitise_params
+      params.delete(:callback_proc_as_string)
+      params.delete(:scoping)
+    end
+
+    def fire_setting_callback
+      begin
+        @refinery_setting.callback_proc.call
+      rescue
+        logger.warn('Could not fire callback proc. Details:')
+        logger.warn(@refinery_setting.inspect)
+        logger.warn($!.message)
+        logger.warn($!.backtrace)
+      end unless @refinery_setting.callback_proc.nil?
+    end
+
+  end
+end

data/settings/app/helpers/refinery_settings_helper.rb

@@ -0,0 +1,25 @@
+module RefinerySettingsHelper
+  def form_value_type
+    @refinery_setting.form_value_type.presence || 'text_area'
+  end
+
+  def refinery_setting_title(f)
+    if @refinery_setting.form_value_type == 'check_box'
+      raw "<h3>#{@refinery_setting.name.to_s.titleize}?</h3>"
+    else
+      f.label :value
+    end
+  end
+
+  def refinery_setting_field(f, help)
+    case form_value_type
+    when 'check_box'
+      raw "#{f.check_box :value, :value => @refinery_setting.form_value}
+           #{f.label :value, help.presence || t('enabled', :scope => 'admin.refinery_settings.form'),
+                     :class => 'stripped'}"
+    else
+      f.text_area :value, :value => @refinery_setting.form_value,
+                  :class => 'widest', :rows => 5
+    end
+  end
+end

data/settings/app/models/refinery_setting.rb

@@ -0,0 +1,212 @@
+class RefinerySetting < ActiveRecord::Base
+
+  FORM_VALUE_TYPES = [
+    ['Multi-line', 'text_area'],
+    ['Checkbox', 'check_box']
+  ]
+
+  validates :name, :presence => true
+
+  serialize :value # stores into YAML format
+  serialize :callback_proc_as_string
+
+  # Docs for acts_as_indexed http://github.com/dougal/acts_as_indexed
+  acts_as_indexed :fields => [:name]
+
+  before_save do |setting|
+    setting.restricted = false if setting.restricted.nil?
+  end
+
+  after_save do |setting|
+    setting.class.rewrite_cache
+  end
+
+  class << self
+    # Number of settings to show per page when using will_paginate
+    def per_page
+      12
+    end
+
+    def ensure_cache_exists!
+      if (result = Rails.cache.read(cache_key)).nil?
+        result = rewrite_cache
+      end
+
+      result
+    end
+    protected :ensure_cache_exists!
+
+    def cache_read(name = nil, scoping = nil)
+      result = ensure_cache_exists!
+
+      if name.present?
+        scoping = scoping.to_s if scoping.is_a?(Symbol)
+        result = result.detect do |rs|
+          rs[:name] == name.to_s.downcase.to_sym and rs[:scoping] == scoping
+        end
+        result = result[:value] if !result.nil? and result.keys.include?(:value)
+      end
+
+      result
+    end
+
+    def to_cache(settings)
+      settings.collect do |rs|
+        {
+          :name => rs.name.to_s.downcase.to_sym,
+          :value => rs.value,
+          :scoping => rs.scoping,
+          :destroyable => rs.destroyable
+        }
+      end
+    end
+
+    def rewrite_cache
+      # delete cache
+      Rails.cache.delete(cache_key)
+
+      # generate new cache
+      result = (to_cache(all) if (table_exists? rescue false))
+
+      # write cache
+      Rails.cache.write(cache_key, result)
+
+      # return cache, or lack thereof.
+      result ||= []
+    end
+
+    def cache_key
+      [Refinery.base_cache_key, 'refinery_settings_cache'].join('_')
+    end
+
+    # find_or_set offers a convenient way to
+    def find_or_set(name, the_value, options={})
+      # Merge default options with supplied options.
+      options = {
+        :scoping => nil, :restricted => false,
+        :callback_proc_as_string => nil, :form_value_type => 'text_area'
+      }.merge(options)
+
+      # try to find the setting first
+      value = get(name, :scoping => options[:scoping])
+
+      # if the setting's value is nil, store a new one using the existing functionality.
+      value = set(name, options.merge({:value => the_value})) if value.nil?
+
+      # Return what we found.
+      value
+    end
+
+    alias :get_or_set :find_or_set
+
+    # Retrieve the current value for the setting whose name is supplied.
+    def get(name, options = {})
+      options = {:scoping => nil}.update(options)
+      cache_read(name, options[:scoping])
+    end
+
+    alias :[] :get
+
+    def set(name, value)
+      return (value.is_a?(Hash) ? value[:value] : value) unless (table_exists? rescue false)
+
+      scoping = (value[:scoping] if value.is_a?(Hash) and value.has_key?(:scoping))
+      setting = find_or_initialize_by_name_and_scoping(:name => name.to_s, :scoping => scoping)
+
+      # you could also pass in {:value => 'something', :scoping => 'somewhere'}
+      unless value.is_a?(Hash) and value.has_key?(:value)
+        setting.value = value
+      else
+        # set the value last, so that the other attributes can transform it if required.
+        setting.form_value_type = value[:form_value_type] || 'text_area' if setting.respond_to?(:form_value_type)
+        setting.scoping = value[:scoping] if value.has_key?(:scoping)
+        setting.callback_proc_as_string = value[:callback_proc_as_string] if value.has_key?(:callback_proc_as_string)
+        setting.destroyable = value[:destroyable] if value.has_key?(:destroyable)
+        setting.value = value[:value]
+      end
+
+      # Save because we're in a setter method.
+      setting.save
+
+      # Return the value
+      setting.value
+    end
+
+    # DEPRECATED for removal at >= 0.9.9
+    def []=(name, value)
+      warning = ["\n*** DEPRECATION WARNING ***"]
+      warning << "You should not use this anymore: RefinerySetting[#{name.inspect}] = #{value.inspect}."
+      warning << "\nInstead, you should use RefinerySetting.set(#{name.inspect}, #{value.inspect})"
+      warning << ""
+      warning << "Called from: #{caller.first.inspect}\n\n"
+      $stdout.puts warning.join("\n")
+
+      set(name, value)
+    end
+  end
+
+  # prettier version of the name.
+  # site_name becomes Site Name
+  def title
+    name.titleize
+  end
+
+  # form_value is so that on the web interface we can display a sane value.
+  def form_value
+    unless self[:value].blank? or self[:value].is_a?(String)
+      YAML::dump(self[:value])
+    else
+      self[:value]
+    end
+  end
+
+  def value
+    replacements!(self[:value])
+  end
+
+  def value=(new_value)
+    # must convert "1" to true and "0" to false when supplied using 'check_box', unfortunately.
+    if ["1", "0"].include?(new_value) and form_value_type == 'check_box'
+      new_value = new_value == "1" ? true : false
+    end
+
+    # must convert to string if true or false supplied otherwise it becomes 0 or 1, unfortunately.
+    if [true, false].include?(new_value)
+      new_value = new_value.to_s
+    end
+
+    super
+  end
+
+  def callback_proc
+    eval("Proc.new{#{callback_proc_as_string} }") if callback_proc_as_string.present?
+  end
+
+private
+  # Below is not very nice, but seems to be required. The problem is when Rails
+  # serialises a fields like booleans it doesn't retrieve it back out as a boolean
+  # it just returns a string. This code maps the two boolean values
+  # correctly so that a boolean is returned instead of a string.
+  REPLACEMENTS = {"true" => true, "false" => false}
+
+  def replacements!(current_value)
+    # This bit handles true and false so that true and false are actually returned
+    # not "0" and "1"
+    REPLACEMENTS.each do |current, new_value|
+      current_value = new_value if current_value == current
+    end
+
+    # converts the serialised value back to an integer
+    # if the value is an integer
+    begin
+      if current_value.to_i.to_s == current_value
+        current_value = current_value.to_i
+      end
+    rescue
+      current_value
+    end
+
+    current_value
+  end
+
+end

data/settings/app/views/admin/refinery_settings/_form.html.erb

@@ -0,0 +1,62 @@
+<%= form_for [:admin, @refinery_setting] do |f| %>
+
+  <%= render :partial => "/shared/admin/error_messages",
+             :locals => {
+               :object => @refinery_setting,
+               :include_object_name => true
+             } %>
+
+  <div class='field'>
+    <%= f.label :name %>
+  <% if action_name =~ /(new)|(create)/ %>
+    <%= f.text_field :name, :class => "larger widest" %>
+  <% else %>
+    <label class='stripped' for='refinery_setting_value'>
+      <%= @refinery_setting.name.titleize %>
+    </label>
+    <span class="preview">- (<%= @refinery_setting.name %>)</span>
+  <% end %>
+  <% if current_user.has_role?(:superuser) and !@refinery_setting.persisted? %>
+    <div class='field'>
+      <%= f.label :form_value_type %>
+      <%= f.select :form_value_type, RefinerySetting::FORM_VALUE_TYPES -%>
+    </div>
+  <% end %>
+  <% unless action_name =~ /(new)|(create)/ or (help = t(@refinery_setting.name, :scope => 'admin.refinery_settings.form.help', :default => '')).blank? or @refinery_setting.form_value_type == 'check_box'  %>
+    <p>
+      <span><%= help %></span>
+    </p>
+  <% end %>
+  <% if current_user.has_role?(:superuser) %>
+    <span class='label_with_help'>
+      <%= f.label :restricted %>
+      <%= refinery_help_tag t('restricted', :scope => 'admin.refinery_settings.form.help') %>
+    </span>
+    <%= f.check_box :restricted %>
+    <%= f.label :restricted, t('.yes_make_this_setting_restricted'), :class => 'stripped' %>
+  <% end %>
+  </div>
+  <div class='field'>
+    <%= refinery_setting_title(f) %>
+    <%= refinery_setting_field(f, help) %>
+  </div>
+
+  <%= render :partial => "/shared/admin/form_actions",
+             :locals => {
+               :f => f,
+               :continue_editing => false,
+               :hide_cancel => from_dialog?,
+               :submit_button_title => t('.restart_may_be_in_order_html'),
+               :delete_title => t('delete', :scope => 'admin.refinery_settings'),
+               :delete_confirmation => t('message', :scope => 'shared.admin.delete',
+                                         :title => @refinery_setting.name.to_s.titleize),
+               :hide_delete => (!@refinery_setting.persisted? or !@refinery_setting.destroyable or from_dialog?)
+              } %>
+<% end -%>
+<% content_for :javascripts do %>
+  <script>
+    $('#refinery_setting_form_value_type').change(function(e) {
+      window.location = location_url + ((location_url.indexOf("?") > -1 ? "&" : "?") + "form_value_type=" + $(this).val());
+    });
+  </script>
+<% end if current_user.has_role?(:superuser) %>

data/settings/app/views/admin/refinery_settings/_refinery_setting.html.erb

@@ -0,0 +1,23 @@
+<li class='clearfix record <%= cycle("on", "on-hover") %>'>
+  <span class='title'>
+    <%= t(refinery_setting.name, :default => refinery_setting.name.to_s.titleize) %>
+    <span class="preview">- <%= truncate(refinery_setting.value.to_s, :length => 40) %></span>
+  </span>
+  <span class='actions'>
+    <%= link_to refinery_icon_tag('application_edit.png'),
+                edit_admin_refinery_setting_path(refinery_setting, :dialog => true, :width => 725, :height => 525),
+                :title => t('edit', :scope => 'admin.refinery_settings') %>
+    <%= link_to refinery_icon_tag('delete.png'),
+                admin_refinery_setting_path(refinery_setting),
+                :class => 'cancel confirm-delete',
+                :title => t('delete', :scope => 'admin.refinery_settings'),
+                :confirm => t('message', :scope => 'shared.admin.delete', :title => refinery_setting.title),
+                :method => :delete if refinery_setting.destroyable %>
+
+    <% unless (help = t(refinery_setting.name, :scope => 'admin.refinery_settings.form.help', :default => '')).blank? %>
+      <%= link_to refinery_icon_tag('information.png'), '#',
+                  :tooltip => help,
+                  :class => 'suppress' %>
+    <% end %>
+  </span>
+</li>

data/settings/app/views/admin/refinery_settings/_refinery_settings.html.erb

@@ -0,0 +1,5 @@
+<%= will_paginate @refinery_settings %>
+<ul class="<%= ['pagination_frame', pagination_css_class].compact.join(' ') %>">
+  <%= render :partial => 'refinery_setting',
+             :collection => @refinery_settings %>
+</ul>

data/settings/app/views/admin/refinery_settings/index.html.erb

@@ -0,0 +1,49 @@
+<div id='records'>
+  <% if searching? %>
+    <h2>
+      <%= t('results_for', :scope => 'shared.admin.search', :query => params[:search]) %>
+    </h2>
+  <% end %>
+  <% if @refinery_settings.any? %>
+    <div class='pagination_container'>
+      <%= render :partial => 'refinery_settings' %>
+    </div>
+  <% else %>
+    <p>
+      <% if searching? %>
+        <%= t('no_results', :scope => 'shared.admin.search') %>
+      <% else %>
+        <strong>
+          <%= t('.empty_set') %>
+          <%= t('.create_first', :link => t('.new')) %>
+        </strong>
+      <% end %>
+    </p>
+  <% end %>
+</div>
+<div id='actions'>
+  <ul>
+    <li>
+      <%= render :partial => "/shared/admin/search",
+                 :locals => {
+                   :url => admin_refinery_settings_url
+                 } %>
+    </li>
+    <li>
+      <%= link_to t('.new'), new_admin_refinery_setting_url({
+                               :dialog => true,
+                               :width => 725,
+                               :height => 475
+                             }), :class => "add_icon" %>
+    </li>
+  </ul>
+</div>
+<% content_for :javascripts do %>
+  <script>
+    $(document).ready(function() {
+      $('#records ul li .actions a[href*=edit]').each(function(i, li) {
+        $(li).attr('name', $(li).attr('tooltip'));
+      });
+    });
+  </script>
+<% end -%>