refinerycms-settings 1.0.11 → 2.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+Gemfile.lock
+spec/dummy

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--drb
+--format Fuubar

data/.travis.yml

@@ -0,0 +1,16 @@
+before_script:
+  - "bundle exec rake refinery:testing:dummy_app > /dev/null"
+script: "bundle exec rspec ./spec"
+notifications:
+  email:
+    - parndt@gmail.com
+    - ugis.ozolss@gmail.com
+env:
+  - DB=postgresql
+  - DB=mysql
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx
+  - jruby

data/Gemfile

@@ -0,0 +1,74 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'friendly_id', :git => 'git://github.com/norman/friendly_id.git'
+
+git 'git://github.com/resolve/refinerycms.git' do
+  gem 'refinerycms'
+
+  group :development, :test do
+    gem 'refinerycms-testing'
+  end
+end
+
+group :development, :test do
+  require 'rbconfig'
+
+  platforms :jruby do
+    gem 'activerecord-jdbcsqlite3-adapter'
+    gem 'activerecord-jdbcmysql-adapter'
+    gem 'activerecord-jdbcpostgresql-adapter'
+    gem 'jruby-openssl'
+  end
+
+  unless defined?(JRUBY_VERSION)
+    gem 'sqlite3'
+    gem 'mysql2'
+    gem 'pg'
+  end
+
+  platforms :mswin, :mingw do
+    gem 'win32console'
+    gem 'rb-fchange', '~> 0.0.5'
+    gem 'rb-notifu', '~> 0.0.4'
+  end
+
+  platforms :ruby do
+    gem 'spork', '0.9.0.rc9'
+    gem 'guard-spork'
+
+    unless ENV['TRAVIS']
+      if RbConfig::CONFIG['target_os'] =~ /darwin/i
+        gem 'rb-fsevent', '>= 0.3.9'
+        gem 'growl',      '~> 1.0.3'
+      end
+      if RbConfig::CONFIG['target_os'] =~ /linux/i
+        gem 'rb-inotify', '>= 0.5.1'
+        gem 'libnotify',  '~> 0.1.3'
+        gem 'therubyracer', '~> 0.9.9'
+      end
+    end
+  end
+
+  platforms :jruby do
+    unless ENV['TRAVIS']
+      if RbConfig::CONFIG['target_os'] =~ /darwin/i
+        gem 'growl',      '~> 1.0.3'
+      end
+      if RbConfig::CONFIG['target_os'] =~ /linux/i
+        gem 'rb-inotify', '>= 0.5.1'
+        gem 'libnotify',  '~> 0.1.3'
+      end
+    end
+  end
+end
+
+# Refinery/rails should pull in the proper versions of these
+group :assets do
+  gem 'sass-rails'
+  gem 'coffee-rails'
+  gem 'uglifier'
+end
+
+gem 'jquery-rails'

data/Rakefile

@@ -0,0 +1,19 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+ENGINE_PATH = File.dirname(__FILE__)
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+
+if File.exists?(APP_RAKEFILE)
+  load 'rails/tasks/engine.rake'
+end
+
+require "refinerycms-testing"
+Refinery::Testing::Railtie.load_tasks
+Refinery::Testing::Railtie.load_dummy_tasks(ENGINE_PATH)
+
+load File.expand_path('../tasks/rspec.rake', __FILE__)

data/app/controllers/refinery/admin/settings_controller.rb

@@ -0,0 +1,55 @@
+module ::Refinery
+  module Admin
+    class SettingsController < ::Refinery::AdminController
+
+      helper "refinery/admin/settings"
+
+      crudify :'refinery/setting',
+              :order => "name ASC",
+              :redirect_to_url => :redirect_to_where?,
+              :xhr_paging => true
+
+      before_filter :sanitise_params, :only => [:create, :update]
+
+      def new
+        form_value_type = ((current_refinery_user.has_role?(:superuser) && params[:form_value_type]) || 'text_area')
+        @setting = ::Refinery::Setting.new(:form_value_type => form_value_type)
+      end
+
+      def edit
+        @setting = ::Refinery::Setting.find(params[:id])
+
+        render :layout => false if request.xhr?
+      end
+
+    protected
+      def find_all_settings
+        @settings = ::Refinery::Setting.order('name ASC')
+
+        unless current_refinery_user.has_role?(:superuser)
+          @settings = @settings.where("restricted <> ? ", true)
+        end
+
+        @settings
+      end
+
+      def search_all_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.
+         @settings = find_all_settings.with_query(term)
+      end
+
+    private
+      def redirect_to_where?
+        (from_dialog? && session[:return_to].present?) ? session[:return_to] : refinery.admin_settings_path
+      end
+
+      # this fires before an update or create to remove any attempts to pass sensitive arguments.
+      def sanitise_params
+        params.delete(:scoping)
+      end
+    end
+  end
+end

data/app/helpers/refinery/admin/settings_helper.rb

@@ -0,0 +1,29 @@
+module ::Refinery
+  module Admin
+    module SettingsHelper
+      def form_value_type
+        @setting.form_value_type.presence || 'text_area'
+      end
+
+      def setting_title(f)
+        if @setting.form_value_type == 'check_box'
+          raw "<h3>#{@setting.name.to_s.titleize}?</h3>"
+        else
+          f.label :value
+        end
+      end
+
+      def setting_field(f, help)
+        case form_value_type
+        when 'check_box'
+          raw "#{f.check_box :value, :value => @setting.form_value}
+               #{f.label :value, help.presence || t('enabled', :scope => 'refinery.admin.settings.form'),
+                         :class => 'stripped'}"
+        else
+          f.text_area :value, :value => @setting.form_value,
+                      :class => 'widest', :rows => 5
+        end
+      end
+    end
+  end
+end

data/app/models/refinery/setting.rb

@@ -0,0 +1,204 @@
+module Refinery
+  class Setting < Refinery::Core::BaseModel
+    extend FriendlyId
+    friendly_id :name
+
+    FORM_VALUE_TYPES = [
+      ['Multi-line', 'text_area'],
+      ['Checkbox', 'check_box']
+    ]
+
+    validates :name, :presence => true
+
+    serialize :value # stores into YAML format
+
+    # Docs for acts_as_indexed http://github.com/dougal/acts_as_indexed
+    acts_as_indexed :fields => [:name]
+
+    attr_accessible :name, :value, :destroyable,
+                    :scoping, :restricted, :form_value_type
+
+    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, :multithread => true)).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, :multithread => true)
+
+        # generate new cache
+        result = (to_cache(all) if (table_exists? rescue false))
+
+        # write cache
+        Rails.cache.write(cache_key, result, :multithread => true)
+
+        # return cache, or lack thereof.
+        result ||= []
+      end
+
+      def cache_key
+        [Refinery::Core.base_cache_key, '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,
+          :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.to_s, 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.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
+    end
+
+    # prettier version of the name.
+    # site_name becomes Site Name
+    def title
+      result = name.to_s.titleize
+      result << " (#{scoping.titleize})" if scoping.is_a?(String)
+      result
+    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
+
+    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
+end

data/app/views/refinery/admin/settings/_actions.html.erb

@@ -0,0 +1,8 @@
+<ul>
+  <li>
+    <%= render '/refinery/admin/search', :url => refinery.admin_settings_path %>
+  </li>
+  <li>
+    <%= link_to t('.new'), refinery.new_admin_setting_path(:dialog => true), :class => "add_icon" %>
+  </li>
+</ul>

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

@@ -0,0 +1,54 @@
+<%= form_for [refinery, :admin, @setting] do |f| %>
+
+  <%= render '/refinery/admin/error_messages', :object => @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='setting_value'>
+      <%= @setting.title %>
+    </label>
+    <span class="preview">- (<%= @setting.name %>)</span>
+  <% end %>
+  <% if current_refinery_user.has_role?(:superuser) && @setting.new_record? %>
+    <div class='field'>
+      <%= f.label :form_value_type %>
+      <%= f.select :form_value_type, ::Refinery::Setting::FORM_VALUE_TYPES -%>
+    </div>
+  <% end %>
+  <% unless action_name =~ /(new)|(create)/ or (help = t(@setting.name, :scope => 'refinery.admin.settings.form.help', :default => '')).blank? or @setting.form_value_type == 'check_box'  %>
+    <p>
+      <span><%= help %></span>
+    </p>
+  <% end %>
+  <% if current_refinery_user.has_role?(:superuser) %>
+    <span class='label_with_help'>
+      <%= f.label :restricted %>
+      <%= refinery_help_tag t('restricted', :scope => 'refinery.admin.settings.form.help') %>
+    </span>
+    <%= f.check_box :restricted %>
+    <%= f.label :restricted, t('.yes_make_this_setting_restricted'), :class => 'stripped' %>
+  <% end %>
+  </div>
+  <div class='field'>
+    <%= setting_title(f) %>
+    <%= setting_field(f, help) %>
+  </div>
+
+  <%= render '/refinery/admin/form_actions', :f => f,
+             :continue_editing => false,
+             :hide_cancel => from_dialog?,
+             :submit_button_title => t('.restart_may_be_in_order_html'),
+             :delete_title => t('delete', :scope => 'refinery.admin.settings'),
+             :delete_confirmation => t('message', :scope => 'refinery.admin.delete', :title => @setting.title),
+             :hide_delete => (@setting.new_record? or !@setting.destroyable or from_dialog?) %>
+<% end -%>
+<% content_for :javascripts do %>
+  <script>
+    $('#setting_form_value_type').change(function(e) {
+      window.location = location_url + ((location_url.indexOf("?") > -1 ? "&" : "?") + "form_value_type=" + $(this).val());
+    });
+  </script>
+<% end if current_refinery_user.has_role?(:superuser) %>

data/app/views/refinery/admin/settings/_records.html.erb

@@ -0,0 +1,21 @@
+<% if searching? %>
+  <h2>
+    <%= t('results_for', :scope => 'refinery.admin.search', :query => params[:search]) %>
+  </h2>
+<% end %>
+<div class='pagination_container'>
+  <% if @settings.any? %>
+    <%= render 'settings' %>
+  <% else %>
+    <p>
+      <% if searching? %>
+        <%= t('no_results', :scope => 'refinery.admin.search') %>
+      <% else %>
+        <strong>
+          <%= t('.empty_set') %>
+          <%= t('.create_first', :link => t('new', :scope => 'refinery.admin.settings.actions')) %>
+        </strong>
+      <% end %>
+    </p>
+  <% end %>
+</div>

data/app/views/refinery/admin/settings/_setting.html.erb

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

data/app/views/refinery/admin/settings/_settings.html.erb

@@ -0,0 +1,4 @@
+<%= will_paginate @settings if Refinery::Admin::SettingsController.pageable? %>
+<ul class="<%= ['pagination_frame', pagination_css_class].compact.join(' ') %>">
+  <%= render :partial => 'setting', :collection => @settings %>
+</ul>

data/app/views/refinery/admin/settings/edit.html.erb

@@ -0,0 +1 @@
+<%= render 'form' %>

data/app/views/{admin/refinery_settings → refinery/admin/settings}/index.html.erb

@@ -1,8 +1,8 @@
 <div id='records'>
-  <%= render :partial => 'records' %>
+  <%= render 'records' %>
 </div>
 <div id='actions'>
-  <%= render :partial => 'actions' %>
+  <%= render 'actions' %>
 </div>
 <% content_for :javascripts do %>
   <script>

data/app/views/refinery/admin/settings/new.html.erb

@@ -0,0 +1 @@
+<%= render 'form' %>

data/config/locales/bg.yml

@@ -1,47 +1,29 @@
 bg:
-  plugins:
-    refinery_settings:
-      title: Настройки
-      description: Управление на настройките в Refinery
-  admin:
-    refinery_settings:
-      delete: Изтриване на тази настройка завинаги
-      edit: Редактиране на тази настройка
-      actions:
-        new: Добавяне на нова настройка
-      records:
-        empty_set: Все още няма настройки.
-        create_first: 'Натиснете "%{link}", за да въведете нова.'
-      form:
-        enabled: "Включване на тази настройка."
-        restart_may_be_in_order_html: "<strong>Моля, обърнете внимание</strong>, че е възможно да се наложи да рестартирате уебсайта, за да бъде приложена тази настройка."
-        yes_make_this_setting_restricted: "Ограничаване на тази настройка единствено до привилегировани потребители."
-        help:
-          restricted: По този начин единствено привилегированите потребители (като Вас) могат да преглеждат и редактират тази настройка. 
-          activity_show_limit: "Тази настройка ограничава броя на елементите, които могат да бъдат показвани на таблото."
-          analytics_page_code: Този код активира проследяването на Google Analytics на Вашия сайт. Настройката е изключена ако се остави празна или се въведе стойност "UA-xxxxxx-x". При това положение не се правят повече обръщения към Google Analytics.
-          frontend_refinery_stylesheets_enabled: "По подразбиране в Refinery са включени стилове за CSS за Вашия уебсайт. Това не пречи да използвате и Ваши. Тази настройка разрешава или забранява стиловете за CSS по подразбиране."
-          image_dialogue_sizes: "Тази настройка се отнася до диалога за вмъкване на изображение. След като направите промени тук, се налага да актуализирате размера на малките изображения."
-          image_thumbnails: 'Ако промените тази настройка, се налага отново да генерирате Вашите изображения, чрез командата "rake images:regenerate" (или чрез "rake images:update", ако само сте добавяли още малки изображения). Иначе промяната ще се отрази само за изображенията, добавяни занапред.'
-          menu_hide_children: "Скриване на всички подстраници от менюто, дори и те да съществуват."
-          new_page_parts: Разрешаване добавянето на нови части от страници (секции за съдържание) при редактиране.
-          page_title: "Комплексна настройка, определяща заглавието на страница. Тук можете да въведете клас за CSS; различен етикет; да включите или изключите изписването на йерархията от страници и др."
-          pages_advanced_options_include_seo: Определяне дали настройките за оптимизация на търсачки да бъдат показвани в разширените настройки на дадена страница.
-          preferred_image_view: 'Чрез тази настройка се задава, как да бъдат преглеждани съществуващите изображения: като списък или като решетка. Това може да бъде указано и чрез бутон в секция "Изображения".'
-          refinery_enable_backend_reordering: Премахване на възможността за подреждане на добавките.
-          refinery_menu_cache_action_suffix: "Тази настройка указва ключа, който да бъде използван за кеширане на менюто на сайта. Ако използвате тема, тогава е най-добре да оставите стойността, която всяка тема задава по подразбиране."
-          show_contact_privacy_link: Скриване или показване на политиката за поверителност във формата за контакт.
-          site_name: "Тази настройка указва наименованието на Вашия уебсайт. То ще бъде показвано в заглавната част на страницата, в редактора на сайта и при някои теми в условията за ползване."
-          theme: "Въвеждане наименованието на темата, която да бъде използвана. При правилно въведена тема, тя ще бъде приложена веднага."
-          use_google_ajax_libraries: 'За използването на "Google AJAX CDN", задайте стойност "true".'
-          use_marketable_urls: 'Промяна на уеб адресите от "/pages/about" на "/about" и автоматично разрешаване на евентуални конфликти с останалите добавки.'
-          use_resource_caching: "Когато внедрявате системата е препоръчително да разрешите тази настройка. По този начин всички файлове с код за CSS и JavaScript ще бъдат обединени в по един файл. Така броя на заявките към Вашия уебсайт ще бъде намален и производителността ще се подобри. "
-          approximate_ascii: 'Въведете "true", ако в заглавието на страниците използвате символи за ударение или други диакритични знаци. Така символи, като: ā, č, ž, ще бъдат преобразувани съответно в: a, c, z. По този начин няма да се визуализират странни символи в лентата за адреси при някои браузъри.'
+  refinery:
+    plugins:
+      refinery_settings:
+        title: Настройки
+        description: Управление на настройките в Refinery
+    admin:
+      settings:
+        delete: Изтриване на тази настройка завинаги
+        edit: Редактиране на тази настройка
+        actions:
+          new: Добавяне на нова настройка
+        records:
+          empty_set: Все още няма настройки.
+          create_first: 'Натиснете "%{link}", за да въведете нова.'
+        form:
+          enabled: "Включване на тази настройка."
+          restart_may_be_in_order_html: "<strong>Моля, обърнете внимание</strong>, че е възможно да се наложи да рестартирате уебсайта, за да бъде приложена тази настройка."
+          yes_make_this_setting_restricted: "Ограничаване на тази настройка единствено до привилегировани потребители."
+          help:
+            restricted: По този начин единствено привилегированите потребители (като Вас) могат да преглеждат и редактират тази настройка. 
   activerecord:
     models:
-      refinery_setting: настройка
+      refinery/setting: настройка
     attributes:
-      refinery_setting:
+      refinery/setting:
         name: Наименование
         value: Стойност
         restricted: Ограничена