golden-setting 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73d045fd6c1c360eea89881dc9dd6ade617f1f79
+  data.tar.gz: 2b7c5cae33d3d537ec1cc25074ebfa3ff048cd0d
+SHA512:
+  metadata.gz: c086262dfc0d1d86c98a64f239c0890f7a7ee1d2dad4941e99550114bb527e0fdf6f31bc02133e61d528fbdd738ad6eb3a6d30ebafd542447128e278c95c2fdd
+  data.tar.gz: 7e4aa48952e29c8fdd73926e8173e56c604fa1d8bca831248a2e63355ae52127d1602032fb61fca41929732247edc09b4de58a586d22a9c80e8614503e3d8386

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in golden-setting.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tse-Ching Ho
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,198 @@
+# Golden Setting
+
+The `golden-setting` persists settings in database and keeps alive in cache.
+
+A web interface is provied to let users can update easily.
+
+## Requirement
+
+For Rails 4 project, `Gemfile` should have
+
+```ruby
+gem 'protected_attributes'
+gem 'devise', '~> 3.0.0.rc'
+gem 'cancan'
+gem 'simple_form', '~> 3.0.0.rc'
+gem 'anjlab-bootstrap-rails', require: 'bootstrap-rails'
+gem 'will_paginate'
+gem 'rails-theme-helper'
+```
+
+For Rails 3 project, `Gemfile` should have
+
+```ruby
+gem 'devise', '>= 2.0', '< 3.0'
+gem 'cancan'
+gem 'simple_form', '>= 2.0', '< 3.0'
+gem 'anjlab-bootstrap-rails', require: 'bootstrap-rails'
+gem 'will_paginate'
+gem 'rails-theme-helper'
+```
+
+Please make sure these gems are installed and configured properly.
+
+## Installation
+
+Add `golden-setting` to your application's Gemfile.
+
+```ruby
+gem 'golden-setting'
+```
+
+Then bundle gems, generate settings and migrate database.
+
+```ruby
+$ bundle
+$ rails generate golden:setting:install setting
+$ rake db:migrate
+```
+
+Remember add setting abilities for `cancan`.
+
+```
+can :index, Setting
+can :batch_update, Setting
+```
+
+## Configuration
+
+You will need to add these basic configures of `golden-setting` for your needs.
+
+* `groups` for grouping settings with a name
+# `default_group` for saving settings with a group
+* `default_tab` for a group of settings shown in tab views
+
+Edit `config/initializers/golden_setting.rb` for more detail.
+
+## Usage
+
+### Create/Read/Update/Destroy settings
+
+You can add setting with named group.
+
+```ruby
+Setting.add 'google', 'google_analytics_token', 12345
+Setting.add 'api', 'golden_api_credentials', { username: 'tsechingho', password: 'secret' }
+Setting.add 'theme', 'theme_color', 'golden', :select, "%w(golden white)"
+```
+
+or add setting with blank group.
+
+```ruby
+Setting.google_analytics_token = 12345
+Setting.golden_api_credentials = { username: 'tsechingho', password: 'secret' }
+Setting.theme_color = 'golden'
+```
+
+Read settings (group regardless).
+
+```ruby
+Setting.google_analytics_token
+Setting.golden_api_credentials
+Setting.theme_color
+```
+
+Update settings (group regardless).
+
+```ruby
+Setting.google_analytics_token = 'abced'
+Setting.merge!(:golden_api_credentials, password: 'topsecret')
+Setting.theme_color = 'white'
+```
+
+Destroy settings.
+
+```ruby
+Setting.destroy :google_analytics_token
+Setting.destroy :golden_api_credentials
+Setting.destroy :theme_color
+```
+
+### List settings
+
+You can add setting with complex name with `[]=` method, and retrieve with `[]` method.
+
+And list settings as key-value pair with/without name prefix.
+
+```ruby
+Setting['preferences.color'] = :blue
+Setting['preferences.size'] = :large
+Setting['license.key'] = 'ABC-DEF'
+Setting['license.key']
+Setting.list
+Setting.list('preferences.')
+```
+
+### Default settings
+
+You can add virtaul settings for your application by setting defaults.
+
+Add `config/initializers/golden_setting_defaults.rb`.
+
+```ruby
+YourApp::Application.config.after_initialize do
+  Setting.defaults[:administrator] = 'tsechingho'
+end
+```
+
+These virtaul settings were not saved in database.
+
+```ruby
+Setting.named('administrator').count    # => 0
+Setting.administrator    # => 'tsechingho'
+```
+
+You can also save default settings in database after initializing your application.
+
+```ruby
+YourApp::Application.config.after_initialize do
+  Setting.save_default :manager, 'tsechingho'
+end
+```
+
+These default settings were saved in database with default group.
+
+```ruby
+Setting.named('manager').count    # => 1
+Setting.object('manager').group    # => 'site'
+Setting.manager    # => 'tsechingho'
+```
+
+### Resourced settings
+
+Settings may be bound to any existing ActiveRecord object.
+
+```ruby
+class User < ActiveRecord::Base
+  include Golden::Setting::Resourced
+end
+```
+
+Then you can set or get settings.
+
+```ruby
+user = User.first
+user.settings.theme_color = 'golden'
+user.settings.theme_color    # => 'golden'
+user.settings.list    # => { "theme_color" => 'golden' }
+```
+
+You can find users having or not having some settings by (experimental) scopes.
+
+```ruby
+User.with_settings.to_a.size    # => 1
+User.with_settings_for('theme_color').count    # => 1
+User.without_settings.count
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/app/assets/javascripts/golden/setting/settings.js.coffee

@@ -0,0 +1,8 @@
+$ ->
+  $('.settings')
+    .on 'change', '#setting_field_type', ->
+      switch $(this).val()
+        when 'string', 'boolean'
+          $('.setting_field_values').hide()
+        else
+          $('.setting_field_values').show()

data/app/controllers/golden/setting/settings_controller.rb

@@ -0,0 +1,65 @@
+class Golden::Setting::SettingsController < ApplicationController
+  before_filter :authenticate_session!
+  before_filter :load_setting_class, only: [:index, :create, :list]
+  before_filter :new_setting, only: [:create]
+  load_and_authorize_resource :setting, class: Golden::Setting.setting_class, parent: false
+
+  respond_to :html
+
+  def index
+    @default_tab = Golden::Setting.default_tab
+    respond_with @settings
+  end
+
+  def show
+    respond_with @setting
+  end
+
+  def new
+    respond_with @setting
+  end
+
+  def edit
+  end
+
+  def create
+    @setting.save
+    respond_with @setting, location: setting_path(@setting)
+  end
+
+  def update
+    value = params[:setting].delete :value
+    @setting.value = value
+    @setting.update_attributes params[:setting]
+    respond_with @setting, location: setting_path(@setting)
+  end
+
+  def destroy
+    @setting.destroy
+    respond_with @setting, location: settings_path
+  end
+
+  def list
+    @settings = @settings.paginate page: params[:page]
+    respond_with @settings
+  end
+
+  def batch_update
+    params[:setting].each do |setting, value|
+      @setting_class.send "#{setting}=", value
+    end
+    redirect_to action: :index
+  end
+
+  protected
+
+  def load_setting_class
+    @setting_class = Golden::Setting.setting_class.constantize
+  end
+
+  def new_setting
+    value = params[:setting].delete :value
+    @setting = @setting_class.new params[:setting]
+    @setting.value = value
+  end
+end

data/app/helpers/golden/setting/settings_helper.rb

@@ -0,0 +1,52 @@
+module Golden
+  module Setting
+    module SettingsHelper
+      def setting_selectable? field_type
+        !%w{string boolean}.include? field_type
+      end
+
+      def setting_field_types
+        Golden::Setting.field_types.map do |key, value|
+          next if key.nil? or value.nil?
+          [I18n.t(key, scope: 'golden.setting.field_types'), value.to_sym]
+        end
+      end
+
+      def setting_field_values collection
+        return unless collection.present?
+        return collection unless collection.respond_to? :id
+        options_from_collection_for_select(collection, :id, :to_s, object.value)
+      end
+
+      def setting_groups
+        Golden::Setting.groups.map do |key, value|
+          next if key.nil? or value.nil?
+          [I18n.t(key, scope: 'golden.setting.groups'), value.to_s]
+        end
+      end
+
+      def setting_name name
+        I18n.t(name, scope: 'golden.setting.names')
+      end
+
+      def settings_nav_tab name, default
+        text = I18n.t(name, scope: 'golden.setting.groups')
+        nav_tab text, "settings-#{name}", "settings-#{default}"
+      end
+
+      def settings_tab_pane name, default, &block
+        tab_pane "settings-#{name}", "settings-#{default}", &block
+      end
+
+      def skip_setting_group? group
+        method = Golden::Setting.skip_groups_method
+        skiped = (method and respond_to?(method) and send(method, group))
+        group.blank? or skiped
+      end
+
+      def skip_setting? setting
+        Golden::Setting.skip_settings.include? setting
+      end
+    end
+  end
+end

data/app/models/concerns/golden/setting/resourced.rb

@@ -0,0 +1,48 @@
+module Golden
+  module Setting
+    module Resourced
+      extend ActiveSupport::Concern
+      include do
+      end
+
+      module ClassMethods
+        def with_settings
+          select("DISTINCT #{self.table_name}.*").
+          joins("JOIN `#{settings_table}` ON (#{join_settings_on})")
+        end
+
+        def with_settings_for name
+          joins("JOIN `#{settings_table}` ON (#{join_settings_on})").
+          where("`#{settings_table}`.name = ?", name)
+        end
+
+        def without_settings
+          joins("LEFT JOIN `#{settings_table}` ON (#{join_settings_on})").
+          where("`#{settings_table}`.id IS NULL")
+        end
+
+        def without_settings_for name
+          without_settings.
+          where("`#{settings_table}`.name = ?", name)
+        end
+
+        private
+
+        def settings_table
+          Golden::Setting::Base.table_name
+        end
+
+        def join_settings_on
+          [
+            "`#{settings_table}`.resource_type = '#{self.base_class.name}'",
+            "`#{settings_table}`.resource_id = `#{self.table_name}`.#{self.primary_key}"
+          ].join(' AND ')
+        end
+      end
+
+      def settings
+        Golden::Setting::Resource.bind(self)
+      end
+    end
+  end
+end

data/app/views/golden/setting/settings/_batch_form.html.erb

@@ -0,0 +1,24 @@
+<%= simple_form_for setting_class,
+  as: :setting,
+  url: batch_update_settings_path,
+  method: :put,
+  html: { class: 'form-horizontal' } do |f| %>
+
+  <%= f.error_notification %>
+
+  <% settings.each do |setting| %>
+    <% next if skip_setting? setting.name %>
+    <div class="form-inputs">
+      <%= f.input setting.name,
+        as: setting.field_type,
+        collection: setting_field_values(setting.field_values),
+        label: setting_name(setting.name),
+        include_blank: false,
+        input_html: { value: setting.value } %>
+    </div>
+  <% end %>
+
+  <div class="form-actions">
+    <%= submit_button f, t('.submit') %>
+  </div>
+<% end %>

data/app/views/golden/setting/settings/_form.html.erb

@@ -0,0 +1,25 @@
+<div class="form-inputs">
+  <%= f.input :field_type,
+    as: :select,
+    collection: setting_field_types,
+    include_blank: false,
+    required: true %>
+  <%= f.input :field_values,
+    as: :text,
+    required: true,
+    wrapper_html: {
+      class: setting_selectable?(f.object.field_type) ? '' : 'hide'
+    } %>
+  <%= f.input :group,
+    as: :select,
+    collection: setting_groups,
+    include_blank: false %>
+  <%= f.input :name %>
+  <%= f.input :value,
+    as: f.object.field_type,
+    collection: setting_field_values(f.object.field_values),
+    include_blank: false,
+    input_html: {
+      value: f.object.value
+    } %>
+</div>

data/app/views/golden/setting/settings/_setting.html.erb

@@ -0,0 +1,18 @@
+<section>
+  <p>
+    <b><%= setting.class.human_attribute_name :group %>:</b>
+    <%= t(setting.group, scope: 'settings.groups') %>
+  </p>
+  <p>
+    <b><%= setting.class.human_attribute_name :name %>:</b>
+    <%= setting.name %>
+  </p>
+  <p>
+    <b><%= setting.class.human_attribute_name :value %>:</b>
+    <%= setting.value %>
+  </p>
+  <p>
+    <b><%= setting.class.human_attribute_name :form_options %>:</b>
+    <%= setting.form_options %>
+  </p>
+</section>

data/app/views/golden/setting/settings/_table.html.erb

@@ -0,0 +1,34 @@
+<table class="table table-striped table-bordered">
+  <thead>
+    <tr>
+      <th><%= setting_class.human_attribute_name :group %></th>
+      <th><%= setting_class.human_attribute_name :name %></th>
+      <th><%= setting_class.human_attribute_name :value %></th>
+      <th><%= setting_class.human_attribute_name :form_options %></th>
+      <th><%= t('helpers.actions') %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% settings.each do |setting| %>
+      <tr>
+        <td><%= setting.group %></td>
+        <td><%= setting.name %></td>
+        <td><%= setting.value %></td>
+        <td><%= setting.form_options %></td>
+        <td class="action">
+          <%= render_btn_group do |btn|
+            if can? :show, setting
+              btn << link_to_show(setting_path(setting))
+            end
+            if can? :edit, setting
+              btn << link_to_edit(edit_setting_path(setting))
+            end
+            if can? :destroy, setting
+              btn << link_to_destroy(setting_path(setting))
+            end
+          end %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/golden/setting/settings/edit.html.erb

@@ -0,0 +1,30 @@
+<article>
+  <header>
+    <h1><%= t('.title') %></h1>
+  </header>
+
+  <%= render_list class: 'nav nav-tabs' do |li|
+    if can? :index, @setting.class
+      li << [link_to(t('helpers.index'), settings_path), { class: 'pull-right' }]
+    end
+    if can? :list, @setting.class
+      li << [link_to(t('.list'), list_settings_path), { class: 'pull-right' }]
+    end
+    if can? :show, @setting
+      li << [link_to(t('helpers.show'), setting_path(@setting)), { class: 'pull-right' }]
+    end
+  end %>
+
+  <div>
+    <%= simple_form_for @setting, as: :setting, url: setting_path(@setting) do |f| %>
+      <%= f.error_notification %>
+      <%= render 'form', f: f %>
+      <div class="form-actions">
+        <%= submit_button f %>
+      </div>
+    <% end %>
+  </div>
+
+  <footer>
+  </footer>
+</article>

data/app/views/golden/setting/settings/index.html.erb

@@ -0,0 +1,33 @@
+<article>
+  <header>
+    <h1><%= t('.title') %></h1>
+  </header>
+
+  <%= render_list class: 'nav nav-tabs' do |li|
+    if can? :new, @setting_class
+      li << [link_to(t('helpers.new'), new_setting_path), { class: 'pull-right' }]
+    end
+    if can? :list, @setting_class
+      li << [link_to(t('.list'), list_settings_path), { class: 'pull-right' }]
+    end
+    Golden::Setting.groups.each do |key, value|
+      next if skip_setting_group? key
+      li << settings_nav_tab(key, @default_tab)
+    end
+  end %>
+
+  <div class="tab-content">
+    <% Golden::Setting.groups.each do |key, value| %>
+      <% next if skip_setting_group? key %>
+      <%= settings_tab_pane key, @default_tab do %>
+        <%= render 'batch_form',
+          settings: @setting_class.without_resource.grouped(key),
+          setting_class: @setting_class
+        %>
+      <% end %>
+    <% end %>
+  </div>
+
+  <footer>
+  </footer>
+</article>

data/app/views/golden/setting/settings/list.html.erb

@@ -0,0 +1,19 @@
+<article>
+  <header>
+    <h1><%= t('.title') %></h1>
+  </header>
+
+  <%= render_list class: 'nav nav-tabs' do |li|
+    if can? :index, @setting_class
+      li << [link_to(t('.index'), settings_path), { class: 'pull-right' }]
+    end
+  end %>
+
+  <div>
+    <%= render 'table', settings: @settings, setting_class: @setting_class %>
+    <%= render 'application/pagination', collection: @settings %>
+  </div>
+
+  <footer>
+  </footer>
+</article>

data/app/views/golden/setting/settings/new.html.erb

@@ -0,0 +1,27 @@
+<article>
+  <header>
+    <h1><%= t('.title') %></h1>
+  </header>
+
+  <%= render_list class: 'nav nav-tabs' do |li|
+    if can? :index, @setting.class
+      li << [link_to(t('helpers.index'), settings_path), { class: 'pull-right' }]
+    end
+    if can? :list, @setting.class
+      li << [link_to(t('.list'), list_settings_path), { class: 'pull-right' }]
+    end
+  end %>
+
+  <div>
+    <%= simple_form_for @setting, as: :setting, url: settings_path do |f| %>
+      <%= f.error_notification %>
+      <%= render 'form', f: f %>
+      <div class="form-actions">
+        <%= submit_button f %>
+      </div>
+    <% end %>
+  </div>
+
+  <footer>
+  </footer>
+</article>

data/app/views/golden/setting/settings/show.html.erb

@@ -0,0 +1,24 @@
+<article>
+  <header>
+    <h1><%= t('.title', name: @setting.name) %></h1>
+  </header>
+
+  <%= render_list class: 'nav nav-tabs' do |li|
+    if can? :index, @setting.class
+      li << [link_to(t('helpers.index'), settings_path), { class: 'pull-right' }]
+    end
+    if can? :list, @setting.class
+      li << [link_to(t('.list'), list_settings_path), { class: 'pull-right' }]
+    end
+    if can? :edit, @setting
+      li << [link_to(t('helpers.edit'), edit_setting_path(@setting)), { class: 'pull-right' }]
+    end
+  end %>
+
+  <div>
+    <%= render 'setting', setting: @setting %>
+  </div>
+
+  <footer>
+  </footer>
+</article>