golden-setting 0.1.0

data/config/locales/settings.en.yml

@@ -0,0 +1,52 @@
+en:
+  golden:
+    setting:
+      field_types:
+        string: 'String'
+        boolean: 'Boolean'
+        select: 'Select'
+        radio_buttons: 'Radio Buttons'
+        check_boxes: 'Check Boxes'
+      settings:
+        edit:
+          title: 'Editing setting'
+        index:
+          title: 'Settings'
+          list: 'List'
+        new:
+          title: 'New setting'
+        show:
+          title: 'Setting - %{name}'
+        list:
+          title: 'Listing settings'
+          index: 'Settings'
+        batch_form:
+          submit: 'Save'
+
+  activerecord:
+    models:
+      golden/setting/base: 'Setting'
+    attributes:
+      golden/setting/base:
+        group: 'Group'
+        name: 'Name'
+        value: 'Value'
+        resource: 'Resource belonged'
+        form_options: 'Form options'
+        field_type: 'Field type'
+        field_values: 'Field values'
+
+  simple_form:
+    labels:
+      setting:
+    hints:
+      setting:
+        field_values: 'Please define an array of values in Ruby.'
+    placeholders:
+      setting:
+
+  helpers:
+    submit:
+      setting:
+        create: 'Create %{model}'
+        update: 'Update %{model}'

data/config/locales/settings.zh-TW.yml

@@ -0,0 +1,52 @@
+zh-TW:
+  golden:
+    setting:
+      field_types:
+        string: '字串'
+        boolean: '布林值'
+        select: '下拉選單'
+        radio_buttons: '單選按鈕'
+        check_boxes: '多選按鈕'
+      settings:
+        edit:
+          title: '編輯設定'
+        index:
+          title: '設定管理'
+          list: '設定列表'
+        new:
+          title: '新增設定'
+        show:
+          title: '設定 - %{name}'
+        list:
+          title: '設定列表'
+          index: '設定管理'
+        batch_form:
+          submit: '儲存'
+
+  activerecord:
+    models:
+      golden/setting/base: '設定'
+    attributes:
+      golden/setting/base:
+        group: '類別'
+        name: '名稱'
+        value: '設定值'
+        resource: '專屬對象'
+        form_options: '表單格式'
+        field_type: '欄位型式'
+        field_values: '欄位值選項'
+
+  simple_form:
+    labels:
+      setting:
+    hints:
+      setting:
+        field_values: '請以 Ruby 語法定義一個欄位值陣列。'
+    placeholders:
+      setting:
+
+  helpers:
+    submit:
+      setting:
+        create: '建立%{model}'
+        update: '確認'

data/config/routes.rb

@@ -0,0 +1,8 @@
+Golden::Setting::Engine.routes.draw do
+  resources :settings do
+    collection do
+      get :list
+      put :batch_update
+    end
+  end
+end

data/golden-setting.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'golden/setting/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'golden-setting'
+  spec.version       = Golden::Setting::VERSION
+  spec.authors       = ['Tse-Ching Ho']
+  spec.email         = ['tsechingho@gmail.com']
+  spec.description   = %q{Golden Setting persists settings in database and keep alive in cache.}
+  spec.summary       = %q{persists settings in database and keep alive in cache.}
+  spec.homepage      = 'https://github.com/goldenio/golden-setting'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 3.2.13', '< 5'
+  spec.add_dependency 'railties', '>= 3.2.13', '< 5'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 2.13.0'
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/generators/golden/setting/USAGE

@@ -0,0 +1,18 @@
+Description:
+    It will generate model and migration for use.
+
+Example:
+    rails generate golden:setting:install setting
+
+    This will create/modify:
+        db/migrate/20130516050309_create_golden_settings.rb
+        app/models/setting.rb
+        app/assets/javascripts/application.js
+        app/assets/stylesheets/application.css
+        config/initializers/golden_setting.rb
+        config/application.rb
+        config/locales/golden/settings.en.yml
+        config/locales/golden/settings.zh-TW.yml
+        config/routes.rb
+        app/controllers/application_controller.rb
+        app/views/layouts/application.html.erb

data/lib/generators/golden/setting/install_generator.rb

@@ -0,0 +1,86 @@
+require 'active_record/migration'
+
+class Golden::Setting::InstallGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  # argument :name, type: :string, default: 'setting'
+
+  def self.next_migration_number dirname
+    next_migration_number = current_migration_number(dirname) + 1
+    ActiveRecord::Migration.next_migration_number(next_migration_number)
+  end
+
+  def generate_migration
+    file = 'create_golden_settings.rb'
+    #migration_template file, File.join('db/migrate', class_path, file)
+  end
+
+  def generate_model
+    # generate :model, name, '--skip-migration'
+    file = 'setting.rb'
+    log :model, file
+    template file, File.join('app/models', class_path, "#{file_name}.rb"), verbose: false
+  end
+
+  def inject_javascript
+    file = 'app/assets/javascripts/application.js'
+    log :javascripts, 'application.js'
+    sentinel = "//= require_tree .\n"
+    insert_into_file file, before: sentinel, verbose: false do
+      "//= require golden/setting/settings\n"
+    end
+  end
+
+  def inject_stylesheet
+    file = 'app/assets/stylesheets/application.css'
+    log :stylesheets, 'application.css'
+    sentinel = " *= require_self\n"
+    insert_into_file file, before: sentinel, verbose: false do
+      " *= require golden/setting/settings\n"
+    end
+  end
+
+  def generate_initializer
+    file = 'golden_setting.rb'
+    log :initializer, file
+    template file, File.join('config/initializers', class_path, file), verbose: false
+  end
+
+  def add_locales_path
+    file = 'config/application.rb'
+    sentinel = "# config.i18n.default_locale = :de\n"
+    insert_into_file file, after: sentinel do
+      "    config.i18n.load_path += Dir[Rails.root.join('config', 'locales', '**', '*.{rb,yml}').to_s]\n"
+    end
+  end
+
+  def generate_locales
+    files = %w{settings.en.yml settings.zh-TW.yml}
+    files.each do |file|
+      log :locales, "golden/#{file}"
+      template file, File.join('config/locales/golden', class_path, file), verbose: false
+    end
+  end
+
+  def inject_routes
+    route "mount Golden::Setting::Engine, at: '/'\n"
+  end
+
+  def inject_controller
+    file = 'app/controllers/application_controller.rb'
+    sentinel = "protect_from_forgery with: :exception\n"
+    insert_into_file file, after: sentinel do
+      "  alias_method :authenticate_session!, :authenticate_user!\n"
+    end
+  end
+
+  def inject_layout
+    file = 'app/views/layouts/application.html.erb'
+    sentinel = "<%= yield %>\n"
+    gsub_file file, "<%= yield %>\n" do |match|
+      %Q{<div class="<%= controller_name %>"><%= yield %></div>\n}
+    end
+  end
+end

data/lib/generators/golden/setting/templates/create_golden_settings.rb

@@ -0,0 +1,17 @@
+class CreateGoldenSettings < ActiveRecord::Migration
+  def change
+    create_table :golden_settings do |t|
+      t.string     :group
+      t.string     :name, null: false
+      t.text       :value
+      t.string     :form_options
+      t.references :resource, polymorphic: true
+      t.timestamps
+    end
+
+    add_index :golden_settings,
+      [:group, :name, :resource_id, :resource_type],
+      unique: true,
+      name: 'index_golden_settings_on_group_and_name_and_resource'
+  end
+end

data/lib/generators/golden/setting/templates/golden_setting.rb

@@ -0,0 +1,36 @@
+Golden::Setting.configure do |config|
+  # Define setting class.
+  #config.setting_class = 'Setting'
+
+  # Define database table.
+  #config.table_name = 'golden_settings'
+
+  # Add extra field types with array of name and value.
+  # Name will be used as translation key.
+  # Value is a symbol name of field types used by `simple_form`.
+  #config.field_types += [
+  #  ['string', :string]
+  #]
+
+  # Add avaiable groups with array of name and value.
+  # Name will be used as translation key.
+  # Default is a blank array. You SHOULD give one at least
+  config.groups += [
+    ['site', 'site']
+  ]
+
+  # Define default group with name of groups.
+  # Default is ''.
+  config.default_group = 'site'
+
+  # Don't show groups by given method.
+  #config.skip_groups_method = nil
+
+  # Don't show listed settings.
+  #config.skip_settings += %W{
+  #}
+
+  # Define default tab with name of groups.
+  # Default is ''.
+  config.default_tab = 'site'
+end

data/lib/generators/golden/setting/templates/setting.rb

@@ -0,0 +1,3 @@
+class <%= class_name %> < Golden::Setting::Base
+  include Golden::Setting::Cache
+end

data/lib/generators/golden/setting/templates/settings.en.yml

@@ -0,0 +1,15 @@
+en:
+  golden:
+    setting:
+      groups:
+        site: 'Site'
+      names:
+        site_title: 'Site Title'
+
+# simple_form:
+#   labels:
+#     setting:
+#   hints:
+#     setting:
+#   placeholders:
+#     setting:

data/lib/generators/golden/setting/templates/settings.zh-TW.yml

@@ -0,0 +1,15 @@
+zh-TW:
+  golden:
+    setting:
+      groups:
+        site: '網站'
+      names:
+        site_title: '名稱'
+
+# simple_form:
+#   labels:
+#     setting:
+#   hints:
+#     setting:
+#   placeholders:
+#     setting:

data/lib/golden/setting/action.rb

@@ -0,0 +1,58 @@
+module Golden
+  module Setting
+    module Action
+      extend ActiveSupport::Concern
+      included do
+      end
+
+      module ClassMethods
+        # Setting.add 'theme', 'name', 'golden', :select, %w(golden white)
+        def add group, name, value, field_type = nil, field_values = nil
+          object(name) ||
+          new_object(name).tap do |s|
+            s.group = group
+            s.value = value
+            s.field_type = field_type if field_type
+            s.field_values = field_values if field_values
+            s.save!
+          end
+        end
+
+        def destroy name
+          raise Error::SettingNotFound, name unless self[name]
+          object(name).destroy
+        end
+
+        def select_object
+          raise Error::SettingNoMethod, :select_object unless defined? super
+          super
+        end
+
+        def list starting_with = nil
+          result = {}
+          records = select_object
+          if starting_with
+            records = records.where('name LIKE ?', "#{starting_with}%")
+          end
+          records.each do |record|
+            result[record.name] = record.value
+          end
+          result.with_indifferent_access
+        end
+
+        def merge! name, value
+          raise Error::SettingNotFound, name unless self[name]
+          raise Error::SettingNotHash, value unless value.is_a? Hash
+
+          old_value = self[name] || {}
+          raise Error::SettingNotHash, old_value unless old_value.is_a? Hash
+
+          new_value = old_value.merge(value)
+          self[name] = new_value if new_value != old_value
+
+          new_value
+        end
+      end
+    end
+  end
+end

data/lib/golden/setting/base.rb

@@ -0,0 +1,47 @@
+module Golden
+  module Setting
+    class Base < ActiveRecord::Base
+      include Error
+      include Group
+      include Name
+      include Value
+      include FormOption
+      include Action
+
+      self.table_name = Golden::Setting.table_name
+
+      class << self
+        def without_resource
+          where(resource_type: nil, resource_id: nil)
+        end
+
+        def named name
+          without_resource.where(name: name)
+        end
+
+        def select_object fields = %w{name value}
+          without_resource.select(fields)
+        end
+
+        def method_missing method, *args
+          super method, *args
+        rescue NoMethodError
+          name = method.to_s
+          if name =~ /=$/
+            name.gsub!('=', '')
+            self[name] = args.first
+          elsif name =~ /\?$/
+            name.gsub!('?', '')
+            self.is_true? name
+          else
+            self[name]
+          end
+        end
+      end
+
+      # def initialize attributes = nil, options = {}
+      #   super attributes, options
+      # end
+    end
+  end
+end

data/lib/golden/setting/cache.rb

@@ -0,0 +1,55 @@
+module Golden
+  module Setting
+    module Cache
+      extend ActiveSupport::Concern
+      included do
+        after_create :rewrite_cache
+        after_update :rewrite_cache
+        after_destroy :delete_cache
+      end
+
+      module ClassMethods
+        def fetch_cache name
+          if block_given?
+            ::Rails.cache.fetch("setting:#{name}") { yield }
+          else
+            ::Rails.cache.fetch "setting:#{name}"
+          end
+        end
+
+        def rewrite_cache name, value
+          ::Rails.cache.write "setting:#{name}", value
+        end
+
+        def delete_cache name
+          ::Rails.cache.delete "setting:#{name}"
+        end
+
+        def [] name
+          obj = fetch_cache(name) { super(name) }
+          obj || defaults[name.to_sym]
+        end
+
+        def []= name, value
+          if self[name] != value
+            super name, value
+          end
+        end
+
+        def is_true? name
+          fetch_cache("#{name}?") { super(name) }
+        end
+      end
+
+      def rewrite_cache
+        self.class.rewrite_cache name, value
+        self.class.rewrite_cache "#{name}?", self.class.base_class.is_true?(name)
+      end
+
+      def delete_cache
+        self.class.delete_cache name
+        self.class.delete_cache "#{name}?"
+      end
+    end
+  end
+end

data/lib/golden/setting/engine.rb

@@ -0,0 +1,16 @@
+module Golden
+  module Setting
+    class Engine < ::Rails::Engine
+      isolate_namespace Golden::Setting
+      engine_name :golden_setting
+
+      config.autoload_paths += [
+        root.join('app', 'models', 'concerns').to_s
+      ]
+
+      config.after_initialize do
+        Golden::Setting::Base.table_name = Golden::Setting.table_name
+      end
+    end
+  end
+end

data/lib/golden/setting/error.rb

@@ -0,0 +1,38 @@
+module Golden
+  module Setting
+    module Error
+      class SettingNotFound < RuntimeError
+        def initialize name, msg = nil
+          @name = name
+          super msg
+        end
+
+        def to_s
+          "Setting name '#{@name}' not found!"
+        end
+      end
+
+      class SettingNoMethod < NoMethodError
+        def initialize method, msg = nil
+          @method = method
+          super msg
+        end
+
+        def to_s
+          raise "Please define method '#{@method}' first!"
+        end
+      end
+
+      class SettingNotHash < TypeError
+        def initialize value, msg = nil
+          @value = value
+          super msg
+        end
+
+        def to_s
+          "Setting value '#{@value}' is not a hash!"
+        end
+      end
+    end
+  end
+end

data/lib/golden/setting/form_option.rb

@@ -0,0 +1,69 @@
+module Golden
+  module Setting
+    module FormOption
+      extend ActiveSupport::Concern
+      included do
+        cattr_accessor :default_form_options
+        @@default_form_options = {
+          type: :string,
+          collection: []
+        }
+        serialize :form_options
+        attr_accessible :field_type, :field_values
+      end
+
+      module ClassMethods
+        def is_true? name
+          record = object(name)
+          raise Error::SettingNotFound, name unless record
+
+          case record.field_type
+          when :boolean
+            self[name] == '1'
+          else
+            self[name].present?
+          end
+        end
+      end
+
+      def initialize attributes = nil, options = {}
+        super attributes, options
+        self.form_options
+      end
+
+      def form_options
+        case self[:form_options]
+        when String
+          YAML::load self[:form_options]
+        when Hash
+          super
+        else
+          self[:form_options] = default_form_options.dup
+        end
+      end
+
+      def field_type
+        form_options[:type]
+      end
+
+      def field_type= new_value
+        return unless new_value
+        self.form_options[:type] = new_value.to_sym
+      end
+
+      def field_values
+        case form_options[:collection]
+        when String
+          eval form_options[:collection]
+        else
+          form_options[:collection]
+        end
+      end
+
+      def field_values= new_value
+        return unless new_value
+        self.form_options[:collection] = eval(new_value)
+      end
+    end
+  end
+end

data/lib/golden/setting/group.rb

@@ -0,0 +1,17 @@
+module Golden
+  module Setting
+    module Group
+      extend ActiveSupport::Concern
+      included do
+        attr_accessible :group
+        # validates :group, presence: true
+      end
+
+      module ClassMethods
+        def grouped name
+          where(group: name)
+        end
+      end
+    end
+  end
+end

data/lib/golden/setting/name.rb

@@ -0,0 +1,30 @@
+module Golden
+  module Setting
+    module Name
+      extend ActiveSupport::Concern
+      included do
+        attr_accessible :name
+        validates :name, presence: true
+      end
+
+      module ClassMethods
+        def named name
+          raise Error::SettingNoMethod, :named unless defined? super
+          super
+        end
+
+        def object name
+          named(name).first
+        end
+
+        def new_object name
+          named(name).new
+        end
+
+        def first_or_new_object name
+          named(name).first_or_initialize
+        end
+      end
+    end
+  end
+end