refinerycms-settings 1.0.11 → 2.0.0

data/config/locales/zh-TW.yml

@@ -1,47 +1,29 @@
 zh-TW:
-  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 樣式表給前端使用, 可藉由這個設定來開啟或是關閉這個選項."
-          image_dialogue_sizes: 這個設定可以生效插入圖片的對話方框. 您必須完成不同大小的縮圖並且改變它.
-          image_thumbnails: 如果您修改了這個選項, 您必須執行 rake images:regenerate (或是 rake image:update, 如果您只是增加了更多縮圖), 否則這個設定將不會影響任何已存在網站上的圖片.
-          menu_hide_children: 從選單中隱藏任何次頁面, 即使它們是存在的.
-          new_page_parts: 開啟在頁面編輯器可新增新頁面區塊 (內容區) 的功能.
-          page_title: 提供非常複雜的選項讓您設定頁面標題. 在這裡你可以設定自訂的 CSS 類別或是不同的標籤, 或是加上紀錄著頁面層級關係的導覽列.
-          pages_advanced_options_include_seo: 這可控制是否 SEO 選項會顯示在頁面上的進階選項中.
-          preferred_image_view: 這可控制圖片插件如何呈現目前這些已存在網站上的圖片 - grid 表示 '格狀模式' 以及 list 表示 '列表模式'. 圖片插件本身提供一個按鈕可以自動切換這些模式.
-          refinery_enable_backend_reordering: 您可以移除可以重新排列插件顯示順序的功能.
-          refinery_menu_cache_action_suffix: 這可控制用來使用在快取網站選單的金鑰. 如果您正在使用佈景主題, 那最不要改變預設值, 讓佈景主題來為您處裡.
-          show_contact_privacy_link: 您可以隱藏或是顯示在聯絡人表單確認按鈕旁的隱私條款頁面連結.
-          site_name: 這是您的網站名稱, 它將會顯示在網站標題, Refinery 的後台管理系統, 以及部份有頁尾版權宣告的佈景主題中.
-          theme: 輸入您想要開啟的佈景主題名稱. 它將會馬上生效並且確認為是有效的名稱.
-          use_google_ajax_libraries: 如果您想要使用 Google 的 AJAX CDN 請設定為 true.
-          use_marketable_urls: 將網址從 /pages/about 改變為 /about 並且自動處理與其他插件的衝突.
-          use_resource_caching: 建議在 production 模式中開啟這個選項, 它會將 javascript assets 與樣式表 assets 包裹成一個單一檔案來減少您網站被請求的次數並且達到加速的效果.
-          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: 限制

data/config/routes.rb

@@ -1,8 +1,5 @@
-::Refinery::Application.routes.draw do
-  scope(:path => 'refinery', :as => 'admin', :module => 'admin') do
-    resources :settings,
-              :except => :show,
-              :as => :refinery_settings,
-              :controller => :refinery_settings
+Refinery::Core::Engine.routes.draw do
+  namespace :admin, :path => 'refinery' do
+    resources :settings, :except => :show
   end
 end

data/db/migrate/20100913234710_create_refinerycms_settings_schema.rb

@@ -1,24 +1,16 @@
 class CreateRefinerycmsSettingsSchema < ActiveRecord::Migration
-  def self.up
-    create_table ::RefinerySetting.table_name, :force => true do |t|
-      t.string   "name"
-      t.text     "value"
-      t.boolean  "destroyable",             :default => true
-      t.datetime "created_at"
-      t.datetime "updated_at"
-      t.string   "scoping"
-      t.boolean  "restricted",              :default => false
-      t.string   "callback_proc_as_string"
-    end
-
-    add_index ::RefinerySetting.table_name, ["name"], :name => "index_#{::RefinerySetting.table_name}_on_name"
-  end
+  def change
+    create_table :refinery_settings do |t|
+      t.string    :name
+      t.text      :value
+      t.boolean   :destroyable,             :default => true
+      t.string    :scoping
+      t.boolean   :restricted,              :default => false
+      t.string    :form_value_type
 
-  def self.down
-    [::RefinerySetting].reject{|m|
-      !(defined?(m) and m.respond_to?(:table_name))
-    }.each do |model|
-      drop_table model.table_name
+      t.timestamps
     end
+
+    add_index :refinery_settings, :name
   end
 end

data/lib/refinery/generators/refinery/settings/settings_generator.rb

@@ -0,0 +1,20 @@
+module Refinery
+  class SettingsGenerator < Rails::Generators::Base
+
+    def rake_db
+      rake("refinery_settings:install:migrations")
+    end
+
+    def append_load_seed_data
+      create_file 'db/seeds.rb' unless File.exists?(File.join(destination_root, 'db', 'seeds.rb'))
+      append_file 'db/seeds.rb', :verbose => true do
+        <<-EOH
+
+# Added by Refinery CMS Settings engine
+Refinery::Settings::Engine.load_seed
+        EOH
+      end
+    end
+
+  end
+end

data/lib/refinery/settings/engine.rb

@@ -0,0 +1,26 @@
+module Refinery
+  module Settings
+    class Engine < ::Rails::Engine
+      include Refinery::Engine
+
+      isolate_namespace Refinery
+      engine_name :refinery_settings
+
+      config.autoload_paths += %W( #{config.root}/lib )
+
+      initializer "register refinery_settings plugin" do
+        Refinery::Plugin.register do |plugin|
+          plugin.pathname = root
+          plugin.name = 'refinery_settings'
+          plugin.version = %q{2.0.0}
+          plugin.menu_match = %r{refinery/settings$}
+          plugin.url = { :controller => '/refinery/admin/settings' }
+        end
+      end
+
+      config.after_initialize do
+        Refinery.register_engine(Refinery::Settings)
+      end
+    end
+  end
+end

data/lib/refinery/settings.rb

@@ -0,0 +1,22 @@
+require 'refinerycms-core'
+
+module Refinery
+  autoload :SettingsGenerator, 'generators/refinery/settings/settings_generator'
+
+  module Settings
+
+    require 'refinery/settings/engine'
+
+    class << self
+      attr_writer :root
+
+      def root
+        @root ||= Pathname.new(File.expand_path('../../../', __FILE__))
+      end
+
+      def factory_paths
+        @factory_paths ||= [ root.join('spec/factories').to_s ]
+      end
+    end
+  end
+end

data/lib/refinerycms-settings.rb

@@ -1,32 +1 @@
-require 'refinerycms-base'
-
-module Refinery
-  module Settings
-
-    class << self
-      attr_accessor :root
-      def root
-        @root ||= Pathname.new(File.expand_path('../../', __FILE__))
-      end
-    end
-
-    class Engine < ::Rails::Engine
-
-      initializer 'serve static assets' do |app|
-        app.middleware.insert_after ::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/public"
-      end
-
-      config.after_initialize do
-        ::Refinery::Plugin.register do |plugin|
-          plugin.pathname = root
-          plugin.name = 'refinery_settings'
-          plugin.url = {:controller => '/admin/refinery_settings'}
-          plugin.version = %q{1.0.0}
-          plugin.menu_match = /(refinery|admin)\/(refinery_)?settings$/
-        end
-      end
-    end
-  end
-end
-
-::Refinery.engines << 'settings'
+require 'refinery/settings'

data/readme.md

@@ -0,0 +1,46 @@
+# Settings
+
+![Refinery Settings](http://refinerycms.com/system/images/0000/0666/settings.png)
+
+## About
+
+Refinery Settings was extracted from Refinery CMS just before 2.0.0 was released
+and can now be used separately.
+
+## How do I Make my Own Settings?
+
+### In view
+
+Settings can be really useful, especially when you have custom display logic or
+new plugins that need to behave in different ways.
+
+To best explain how settings work, let's use an example. Say you have a client
+who has a display in a local trade show every year and 2 months before the trade
+show, they want to display a little banner in the header of all pages.
+
+Once the trade show is finished, the client needs to be able to hide it again
+until next year. This is what your ``application.html.erb`` file might look like:
+
+    ...
+    <div id='header'>
+      <h1>My Company</h1>
+
+      <% if ::Refinery::Setting.find_or_set(:show_trade_show_banner, false) %>
+        <%= image_tag ('trade-show-banner.jpg') %>
+      <% end %>
+    </div>
+    ...
+
+The following will automatically create a new Refinery setting called
+"show_trade_show_banner" and set its default to ``false``.
+If that setting already exists, it just reads in what the current value is.
+
+So as you can see, this is quite clever because you can quickly define new settings
+ and their defaults right from the view as you need them.
+
+This setting would then show up in the backend in the 'Settings' area where the
+client could change the value as their trade show approaches. Easy as pie!
+
+### In Controller
+
+    limit = Refinery::Setting.find_or_set(:list_limit, 20)

data/refinerycms-settings.gemspec

@@ -1,92 +1,20 @@
 # Encoding: UTF-8
-# DO NOT EDIT THIS FILE DIRECTLY! Instead, use lib/gemspec.rb to generate it.
 
 Gem::Specification.new do |s|
+  s.platform          = Gem::Platform::RUBY
   s.name              = %q{refinerycms-settings}
-  s.version           = %q{1.0.11}
+  s.version           = %q{2.0.0}
   s.summary           = %q{Settings engine for Refinery CMS}
-  s.description       = %q{The default settings engine that is required by Refinery CMS core. Adds programmer creatable, user editable settings for each engine.}
-  s.date              = %q{2012-05-18}
+  s.description       = %q{Adds programmer creatable, user editable settings.}
   s.email             = %q{info@refinerycms.com}
   s.homepage          = %q{http://refinerycms.com}
   s.rubyforge_project = %q{refinerycms}
-  s.authors           = ['Resolve Digital', 'Philip Arndt', 'David Jones', 'Steven Heidel', 'Uģis Ozols']
+  s.authors           = ['Philip Arndt', 'Uģis Ozols']
   s.license           = %q{MIT}
   s.require_paths     = %w(lib)
-  s.executables       = %w()
 
-  s.add_dependency    'activerecord', '~> 3.0.10'
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files -- spec/*`.split("\n")
 
-  s.files             = [
-    'app',
-    'app/controllers',
-    'app/controllers/admin',
-    'app/controllers/admin/refinery_settings_controller.rb',
-    'app/helpers',
-    'app/helpers/refinery_settings_helper.rb',
-    'app/models',
-    'app/models/refinery_setting.rb',
-    'app/views',
-    'app/views/admin',
-    'app/views/admin/refinery_settings',
-    'app/views/admin/refinery_settings/_actions.html.erb',
-    'app/views/admin/refinery_settings/_form.html.erb',
-    'app/views/admin/refinery_settings/_records.html.erb',
-    'app/views/admin/refinery_settings/_refinery_setting.html.erb',
-    'app/views/admin/refinery_settings/_refinery_settings.html.erb',
-    'app/views/admin/refinery_settings/edit.html.erb',
-    'app/views/admin/refinery_settings/index.html.erb',
-    'app/views/admin/refinery_settings/new.html.erb',
-    'config',
-    'config/locales',
-    'config/locales/bg.yml',
-    'config/locales/cs.yml',
-    'config/locales/da.yml',
-    'config/locales/de.yml',
-    'config/locales/el.yml',
-    'config/locales/en.yml',
-    'config/locales/es.yml',
-    'config/locales/fi.yml',
-    'config/locales/fr.yml',
-    'config/locales/it.yml',
-    'config/locales/jp.yml',
-    'config/locales/lolcat.yml',
-    'config/locales/lt.yml',
-    'config/locales/lv.yml',
-    'config/locales/nb.yml',
-    'config/locales/nl.yml',
-    'config/locales/pl.yml',
-    'config/locales/pt-BR.yml',
-    'config/locales/rs.yml',
-    'config/locales/ru.yml',
-    'config/locales/sk.yml',
-    'config/locales/sl.yml',
-    'config/locales/sv.yml',
-    'config/locales/vi.yml',
-    'config/locales/zh-CN.yml',
-    'config/locales/zh-TW.yml',
-    'config/routes.rb',
-    'db',
-    'db/migrate',
-    'db/migrate/20100913234710_create_refinerycms_settings_schema.rb',
-    'db/migrate/20100926142529_add_value_type_to_refinery_settings.rb',
-    'features',
-    'features/manage_refinery_settings.feature',
-    'features/step_definitions',
-    'features/step_definitions/setting_steps.rb',
-    'features/support',
-    'features/support/paths.rb',
-    'lib',
-    'lib/gemspec.rb',
-    'lib/generators',
-    'lib/generators/refinerycms_settings_generator.rb',
-    'lib/refinerycms-settings.rb',
-    'license.md',
-    'refinerycms-settings.gemspec',
-    'spec',
-    'spec/models',
-    'spec/models/refinery_setting_spec.rb'
-  ]
-
-  s.add_dependency 'refinerycms-base', '= 1.0.11'
+  s.add_dependency 'refinerycms-core', '2.0.0'
 end

data/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_PATH = File.expand_path('../..',  __FILE__)
+load File.expand_path('../../spec/dummy/script/rails',  __FILE__)

data/spec/factories/settings.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :setting, :class => Refinery::Setting do
+    name "Refinery CMS setting"
+  end
+end

data/spec/models/refinery/setting_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+module Refinery
+  describe Setting do
+
+    before(:each) do
+      ::Refinery::Setting.set(:creating_from_scratch, nil)
+      ::Refinery::Setting.set(:rspec_testing_creating_from_scratch, nil)
+    end
+
+    context "set" do
+      it "should create a setting that didn't exist" do
+        ::Refinery::Setting.get(:creating_from_scratch, :scoping => 'rspec_testing').should eq(nil)
+        ::Refinery::Setting.set(:creating_from_scratch, {:value => "Look, a value", :scoping => 'rspec_testing'}).should eq("Look, a value")
+      end
+
+      it "should override an existing setting" do
+        @set = ::Refinery::Setting.set(:creating_from_scratch, {:value => "a value", :scoping => 'rspec_testing'})
+        @set.should eq("a value")
+
+        @new_set = ::Refinery::Setting.set(:creating_from_scratch, {:value => "newer replaced value", :scoping => 'rspec_testing'})
+        @new_set.should eq("newer replaced value")
+      end
+
+      it "should default to form_value_type text_area" do
+        @set = ::Refinery::Setting.set(:creating_from_scratch, {:value => "a value", :scoping => 'rspec_testing'})
+        ::Refinery::Setting.find_by_name(:creating_from_scratch.to_s, :conditions => {:scoping => 'rspec_testing'}).form_value_type.should eq("text_area")
+      end
+
+      it "should fix true as a value to 'true' (string)" do
+        @set = ::Refinery::Setting.set(:creating_from_scratch, {:value => true, :scoping => 'rspec_testing'})
+        ::Refinery::Setting.find_by_name(:creating_from_scratch.to_s, :conditions => {:scoping => 'rspec_testing'})[:value].should eq('true')
+        @set.should eq(true)
+      end
+
+      it "should fix false as a value to 'false' (string)" do
+        @set = ::Refinery::Setting.set(:creating_from_scratch, {:value => false, :scoping => 'rspec_testing'})
+        ::Refinery::Setting.find_by_name(:creating_from_scratch.to_s, :conditions => {:scoping => 'rspec_testing'})[:value].should eq('false')
+        @set.should eq(false)
+      end
+
+      it "should fix '1' as a value with a check_box form_value_type to true" do
+        @set = ::Refinery::Setting.set(:creating_from_scratch, {:value => "1", :scoping => 'rspec_testing', :form_value_type => 'check_box'})
+        ::Refinery::Setting.find_by_name(:creating_from_scratch.to_s, :conditions => {:scoping => 'rspec_testing'})[:value].should eq('true')
+        @set.should eq(true)
+      end
+
+      it "should fix '0' as a value with a check_box form_value_type to false" do
+        @set = ::Refinery::Setting.set(:creating_from_scratch, {:value => "0", :scoping => 'rspec_testing', :form_value_type => 'check_box'})
+        ::Refinery::Setting.find_by_name(:creating_from_scratch.to_s, :conditions => {:scoping => 'rspec_testing'})[:value].should eq('false')
+        @set.should eq(false)
+      end
+    end
+
+    context "get" do
+      it "should retrieve a seting that was created" do
+        @set = ::Refinery::Setting.set(:creating_from_scratch, {:value => "some value", :scoping => 'rspec_testing'})
+        @set.should eq('some value')
+
+        @get = ::Refinery::Setting.get(:creating_from_scratch, :scoping => 'rspec_testing')
+        @get.should eq('some value')
+      end
+
+      it "should also work with setting scoping using string and getting via symbol" do
+        @set = ::Refinery::Setting.set(:creating_from_scratch, {:value => "some value", :scoping => 'rspec_testing'})
+        @set.should eq('some value')
+
+        @get = ::Refinery::Setting.get(:creating_from_scratch, :scoping => :rspec_testing)
+        @get.should eq('some value')
+      end
+
+      it "should also work with setting scoping using symbol and getting via string" do
+        @set = ::Refinery::Setting.set(:creating_from_scratch, {:value => "some value", :scoping => :rspec_testing})
+        @set.should eq('some value')
+
+        @get = ::Refinery::Setting.get(:creating_from_scratch, :scoping => 'rspec_testing')
+        @get.should eq('some value')
+      end
+    end
+
+    context "find_or_set" do
+      it "should create a non existant setting" do
+        @created = ::Refinery::Setting.find_or_set(:creating_from_scratch, 'I am a setting being created', :scoping => 'rspec_testing')
+
+        @created.should eq("I am a setting being created")
+      end
+
+      it "should not override an existing setting" do
+        @created = ::Refinery::Setting.set(:creating_from_scratch, {:value => 'I am a setting being created', :scoping => 'rspec_testing'})
+        @created.should eq("I am a setting being created")
+
+        @find_or_set_created = ::Refinery::Setting.find_or_set(:creating_from_scratch, 'Trying to change an existing value', :scoping => 'rspec_testing')
+
+        @created.should eq("I am a setting being created")
+      end
+
+      it "should work without scoping" do
+        ::Refinery::Setting.find_or_set(:rspec_testing_creating_from_scratch, 'Yes it worked').should eq('Yes it worked')
+      end
+    end
+
+  end
+end

data/spec/requests/refinery/admin/settings_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+module Refinery
+  module Admin
+    describe "Settings" do
+      login_refinery_user
+
+      context "when no settings" do
+        before(:each) { Refinery::Setting.destroy_all }
+
+        it "invites to create one" do
+          visit refinery.admin_settings_path
+          page.should have_content("There are no settings yet. Click 'Add new setting' to add your first setting.")
+        end
+      end
+
+      it "shows add new setting link" do
+        visit refinery.admin_settings_path
+        page.should have_content("Add new setting")
+        page.should have_selector("a[href*='/refinery/settings/new']")
+      end
+
+      context "new/create" do
+        it "adds setting", :js => true do
+          visit refinery.admin_settings_path
+          click_link "Add new setting"
+
+          page.should have_selector('iframe#dialog_iframe')
+
+          page.within_frame('dialog_iframe') do
+            fill_in "Name", :with => "test setting"
+            fill_in "Value", :with => "true"
+
+            click_button "Save"
+          end
+
+          page.should have_content("'Test Setting' was successfully added.")
+          page.should have_content("Test Setting - true")
+        end
+      end
+
+      context "pagination" do
+        before(:each) do
+          (Refinery::Setting.per_page + 1).times do
+            FactoryGirl.create(:setting)
+          end
+        end
+
+        specify "page links" do
+          visit refinery.admin_settings_path
+
+          page.should have_selector("a[href*='settings?page=2']")
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+
+def setup_environment
+  # Configure Rails Environment
+  ENV["RAILS_ENV"] ||= 'test'
+
+  require File.expand_path("../dummy/config/environment", __FILE__)
+
+  require 'rspec/rails'
+  require 'capybara/rspec'
+  require 'factory_girl_rails'
+
+  Rails.backtrace_cleaner.remove_silencers!
+
+  RSpec.configure do |config|
+    config.mock_with :rspec
+    config.treat_symbols_as_metadata_keys_with_true_values = true
+    config.filter_run :focus => true
+    config.run_all_when_everything_filtered = true
+  end
+
+  # set javascript driver for capybara
+  Capybara.javascript_driver = :selenium
+end
+
+def each_run
+  ActiveSupport::Dependencies.clear
+
+  FactoryGirl.reload
+
+  # Requires supporting files with custom matchers and macros, etc,
+  # in ./support/ and its subdirectories including factories.
+  ([Rails.root.to_s] | ::Refinery::Plugins.registered.pathnames).map{|p|
+    Dir[File.join(p, 'spec', 'support', '**', '*.rb').to_s]
+  }.flatten.sort.each do |support_file|
+    require support_file
+  end
+end
+
+# If spork is available in the Gemfile it'll be used but we don't force it.
+unless (begin; require 'spork'; rescue LoadError; nil end).nil?
+  Spork.prefork do
+    # Loading more in this block will cause your tests to run faster. However,
+    # if you change any configuration or code from libraries loaded here, you'll
+    # need to restart spork for it take effect.
+    setup_environment
+  end
+
+  Spork.each_run do
+    # This code will be run each time you run your specs.
+    each_run
+  end
+else
+  setup_environment
+  each_run
+end

data/tasks/rspec.rake

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new