golden-setting 0.1.0

data/lib/golden/setting/resource.rb

@@ -0,0 +1,44 @@
+module Golden
+  module Setting
+    class Resource < Base
+      belongs_to :resource
+
+      class << self
+        def bind resource
+          @resource = resource
+          self
+        end
+
+        def unbind
+          @resource = nil
+          self
+        end
+
+        def with_resource resource = @resource
+          where(resource_type: resource.class.name).
+          where(resource_id: resource.id)
+        end
+
+        def named name, resource = @resource
+          with_resource(resource).where(name: name)
+        end
+
+        def object name, resource = @resource
+          named(name, resource).first
+        end
+
+        def new_object name, resource = @resource
+          named(name, resource).new
+        end
+
+        def first_or_new_object name, resource = @resource
+          named(name, resource).first_or_initialize
+        end
+
+        def select_object fields = %w{name value}, resource = @resource
+          with_resource(resource).select(fields)
+        end
+      end
+    end
+  end
+end

data/lib/golden/setting/value.rb

@@ -0,0 +1,67 @@
+module Golden
+  module Setting
+    module Value
+      extend ActiveSupport::Concern
+      included do
+        cattr_accessor :defaults
+        @@defaults = {}.with_indifferent_access
+      end
+
+      module ClassMethods
+        def object name
+          raise Error::SettingNoMethod, :object unless defined? super
+          super name
+        end
+
+        def new_object name
+          raise Error::SettingNoMethod, :new_object unless defined? super
+          super name
+        end
+
+        def first_or_new_object name
+          raise Error::SettingNoMethod, :first_or_new_object unless defined? super
+          super name
+        end
+
+        def [] name
+          record = object(name)
+          record ? record.value : defaults[name.to_sym]
+        end
+
+        def []= name, value
+          record = first_or_new_object(name)
+          if record.value != value
+            record.value = value
+            record.save!
+          end
+          value
+        end
+
+        def is_true? name
+          raise Error::SettingNoMethod, :is_true? unless defined? super
+          super
+        end
+
+        def save_default name, value
+          return unless self[name].nil?
+          record = first_or_new_object(name)
+          if record.value != value
+            record.group ||= Golden::Setting.default_group
+            record.value = value
+            record.save!
+          end
+          value
+        end
+      end
+
+      def value
+        return if self[:value].nil?
+        YAML::load self[:value]
+      end
+
+      def value= new_value
+        self[:value] = new_value.to_yaml
+      end
+    end
+  end
+end

data/lib/golden/setting/version.rb

@@ -0,0 +1,5 @@
+module Golden
+  module Setting
+    VERSION = '0.1.0'
+  end
+end

data/lib/golden/setting.rb

@@ -0,0 +1,54 @@
+require 'golden/setting/version'
+
+module Golden
+  module Setting
+    mattr_accessor :setting_class
+    @@setting_class = 'Setting'
+
+    mattr_accessor :table_name
+    @@table_name = 'golden_settings'
+
+    mattr_accessor :field_types
+    @@field_types = [
+      ['string', :string],
+      ['boolean', :boolean],
+      ['select', :select],
+      ['radio_buttons', :radio_buttons],
+      ['check_boxes', :check_boxes]
+    ]
+
+    mattr_accessor :groups
+    @@groups = []
+
+    mattr_accessor :default_group
+    @@default_group = ''
+
+    mattr_accessor :group_delimiter
+    @@group_delimiter = '.'
+
+    mattr_accessor :skip_groups_method
+    @@skip_groups_method = nil
+
+    mattr_accessor :skip_settings
+    @@skip_settings = []
+
+    mattr_accessor :default_tab
+    @@default_tab = ''
+
+    def self.configure
+      yield self
+    end
+  end
+end
+
+require 'golden/setting/error'
+require 'golden/setting/group'
+require 'golden/setting/name'
+require 'golden/setting/value'
+require 'golden/setting/form_option'
+require 'golden/setting/action'
+require 'golden/setting/base'
+require 'golden/setting/cache'
+require 'golden/setting/resource'
+
+require 'golden/setting/engine'

data/spec/base_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+describe Golden::Setting::Base do
+  let(:golden) { '#F2BE45' }
+  let(:red) { '#C83C23' }
+  let(:now) { Time.now }
+  let(:languages) { %w(ruby html css javascript) }
+  let(:cart) { {pencil: 5, rubber: 2, book: languages}  }
+  let(:cart_item) { {icecream: 3} }
+  let(:layout) { {'layout.color' => red, 'layout.background-color' => golden} }
+
+  context 'Value Type' do
+    it 'can deal with String value' do
+      Setting.color = golden
+      Setting.color.should eq golden
+      Setting.color.class.should be String
+    end
+
+    it 'can deal with true value' do
+      Setting.editable = true
+      Setting.editable.should eq true
+      Setting.editable.class.should be TrueClass
+    end
+
+    it 'can deal with false value' do
+      Setting.editable = false
+      Setting.editable.should eq false
+      Setting.editable.class.should be FalseClass
+    end
+
+    it 'can deal with Symbol value' do
+      Setting.background = :golden
+      Setting.background.should eq :golden
+      Setting.background.class.should be Symbol
+    end
+
+    it 'can deal with Time value' do
+      Setting.booted_at = now
+      Setting.booted_at.should eq now
+      Setting.booted_at.class.should be Time
+    end
+
+    it 'can deal with Array value' do
+      Setting.languages = languages
+      Setting.languages.should eq languages
+      Setting.languages.class.should be Array
+    end
+
+    it 'can deal with Hash value' do
+      Setting.shopping = cart
+      Setting.shopping.should eq cart
+      Setting.shopping.class.should be Hash
+    end
+  end
+
+  context 'Naming' do
+    it 'can deal with complex name' do
+      Setting['layout.color'] = red
+      Setting['layout.color'].should eq red
+      Setting['layout.background-color'] = golden
+      Setting['layout.background-color'].should eq golden
+    end
+  end
+
+  context 'Action' do
+    before :each do
+      Setting.destroy_all
+    end
+
+    it 'can merge hash values' do
+      Setting.shopping = cart
+      Setting.merge! 'shopping', cart_item
+      Setting.shopping.should_not eq cart
+      Setting.shopping.should eq cart.merge(cart_item)
+    end
+
+    it 'can list settings' do
+      Setting.count.should eq 0
+      Setting.languages = languages
+      Setting['layout.color'] = red
+      Setting['layout.background-color'] = golden
+      Setting.count.should eq 3
+      Setting.all.count.should eq 3
+      Setting.list('layout.').count.should eq 2
+      Setting.list('layout.').should eq layout
+    end
+
+    it 'can destory a setting' do
+      Setting.languages = languages
+      Setting.count.should eq 1
+      Setting.destroy :languages
+      Setting.languages.should eq nil
+      Setting.count.should eq 0
+    end
+  end
+
+  context 'Default' do
+    before :each do
+      Setting.destroy_all
+    end
+
+    after :each do
+      Setting.defaults = {}.with_indifferent_access
+    end
+
+    it 'can deal with default value' do
+      Setting.respond_to?(:defaults).should be true
+      Setting.color.should eq nil
+      Setting.defaults[:color] = golden
+      Setting.color.should eq golden
+      Setting.count.should eq 0
+    end
+
+    it 'can save default value with default group' do
+      # Golden::Setting.default_group = 'theme'
+      Setting.respond_to?(:save_default).should be true
+      Setting.color.should eq nil
+      Setting.save_default :color, golden
+      Setting.named(:color).count.should eq 1
+      Setting.object(:color).value.should eq golden
+      Setting.object(:color).group.should eq Golden::Setting.default_group
+      Setting.color.should eq golden
+    end
+  end
+end

data/spec/cache_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe 'Golden::Setting::Base with Cache' do
+  let(:golden) { '#F2BE45' }
+  let(:red) { '#C83C23' }
+
+  context 'Default' do
+    before :each do
+      CachedSetting.destroy_all
+      Rails.cache.clear
+    end
+
+    after :each do
+      CachedSetting.defaults = {}.with_indifferent_access
+    end
+
+    it 'can use default value, while cached value of setting is nil' do
+      CachedSetting.respond_to?(:defaults).should be true
+      CachedSetting.color.should eq nil
+      CachedSetting.defaults[:color] = golden
+      CachedSetting.color.should eq golden
+      CachedSetting.count.should eq 0
+    end
+
+    it 'can save default values, while cached value of setting is nil' do
+      CachedSetting.respond_to?(:save_default).should be true
+      CachedSetting.named(:color).count.should eq 0
+      CachedSetting.color.should be nil
+
+      CachedSetting.save_default :color, red
+      CachedSetting.named(:color).count.should eq 1
+      CachedSetting.object(:color).value.should eq red
+      CachedSetting.color.should eq red
+
+      CachedSetting.save_default :color, golden
+      CachedSetting.object(:color).value.should eq red
+      CachedSetting.color.should eq red
+    end
+  end
+end

data/spec/resource_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Golden::Setting::Resource do
+  let(:golden) { '#F2BE45' }
+  let(:red) { '#C83C23' }
+  let(:manager) { Manager.where(email: 'test@example.com').create }
+
+  context 'Without Cache' do
+    before :each do
+      Setting.destroy_all
+    end
+
+    it 'can set values only belong to manager' do
+      manager.settings.color = golden
+      manager.settings.color.should eq golden
+
+      manager.settings.named(:color).count.should eq 1
+      Setting.count.should eq 1
+      Setting.named(:color).count.should eq 0
+      Setting.color = red
+      Setting.named(:color).count.should eq 1
+      Setting.count.should eq 2
+      manager.settings.named(:color).count.should eq 1
+    end
+
+    it '#object need to #bind user first' do
+      manager.settings.color = golden
+      manager.settings.color.should eq golden
+
+      Setting.color.should be nil
+      Setting.object(:color).should eq nil
+
+      # bind would cause such wrong thing
+      Golden::Setting::Resource.object(:color).should_not be nil
+      Golden::Setting::Resource.object(:color).value.should eq golden
+
+      Golden::Setting::Resource.bind(manager).color.should eq golden
+      Golden::Setting::Resource.bind(manager)[:color].should eq golden
+
+      Golden::Setting::Resource.object(:color, manager).should_not be nil
+      Golden::Setting::Resource.object(:color, manager).value.should eq golden
+
+      Golden::Setting::Resource.unbind
+    end
+
+    it 'returns a scope of users having any setting' do
+      pending
+      User.with_settings
+    end
+
+    it 'returns a scope of users having a color setting' do
+      pending
+      User.with_settings_for('color')
+    end
+
+    it 'returns a scope of users having no setting at all (means user.settings.all == {})' do
+      pending
+      User.without_settings
+    end
+
+    it 'returns a scope of users having no color setting (means user.settings.color == nil)' do
+      pending
+      User.without_settings_for('color')
+    end
+  end
+
+  context 'With Cache' do
+    before :each do
+      Setting.destroy_all
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/concern'
+require 'action_dispatch'
+module Rails
+  class << self
+    def env
+      @_env ||= 'test'
+    end
+
+    def cache
+      @cache ||= ActiveSupport::Cache::MemoryStore.new
+    end
+  end
+end
+require 'rails/engine'
+require 'rails/railtie'
+require 'active_record'
+
+require 'golden/setting'
+Golden::Setting::Engine.config.autoload_paths.each do |path|
+  $LOAD_PATH.unshift path
+end
+require 'golden/setting/resourced'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

data/spec/support/models.rb

@@ -0,0 +1,15 @@
+require 'active_record'
+
+class ::Setting < Golden::Setting::Base
+end
+
+class ::CachedSetting < Golden::Setting::Base
+  include Golden::Setting::Cache
+end
+
+class User < ::ActiveRecord::Base
+end
+
+class Manager < User
+  include Golden::Setting::Resourced
+end

data/spec/support/schema.rb

@@ -0,0 +1,26 @@
+require 'active_support/core_ext/logger'
+require 'active_record'
+require 'sqlite3'
+
+# ActiveRecord::Base.logger = Logger.new(STDOUT)
+ActiveRecord::Base.configurations = true
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: ':memory:'
+)
+
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Schema.define(version: 1) do
+  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
+
+  create_table :users do |t|
+    t.string :email, null: false
+  end
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: golden-setting
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tse-Ching Ho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Golden Setting persists settings in database and keep alive in cache.
+email:
+- tsechingho@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/golden/setting/settings.js.coffee
+- app/assets/stylesheets/golden/setting/settings.css.sass
+- app/controllers/golden/setting/settings_controller.rb
+- app/helpers/golden/setting/settings_helper.rb
+- app/models/concerns/golden/setting/resourced.rb
+- app/views/golden/setting/settings/_batch_form.html.erb
+- app/views/golden/setting/settings/_form.html.erb
+- app/views/golden/setting/settings/_setting.html.erb
+- app/views/golden/setting/settings/_table.html.erb
+- app/views/golden/setting/settings/edit.html.erb
+- app/views/golden/setting/settings/index.html.erb
+- app/views/golden/setting/settings/list.html.erb
+- app/views/golden/setting/settings/new.html.erb
+- app/views/golden/setting/settings/show.html.erb
+- config/locales/settings.en.yml
+- config/locales/settings.zh-TW.yml
+- config/routes.rb
+- golden-setting.gemspec
+- lib/generators/golden/setting/USAGE
+- lib/generators/golden/setting/install_generator.rb
+- lib/generators/golden/setting/templates/create_golden_settings.rb
+- lib/generators/golden/setting/templates/golden_setting.rb
+- lib/generators/golden/setting/templates/setting.rb
+- lib/generators/golden/setting/templates/settings.en.yml
+- lib/generators/golden/setting/templates/settings.zh-TW.yml
+- lib/golden/setting.rb
+- lib/golden/setting/action.rb
+- lib/golden/setting/base.rb
+- lib/golden/setting/cache.rb
+- lib/golden/setting/engine.rb
+- lib/golden/setting/error.rb
+- lib/golden/setting/form_option.rb
+- lib/golden/setting/group.rb
+- lib/golden/setting/name.rb
+- lib/golden/setting/resource.rb
+- lib/golden/setting/value.rb
+- lib/golden/setting/version.rb
+- spec/base_spec.rb
+- spec/cache_spec.rb
+- spec/resource_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: https://github.com/goldenio/golden-setting
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: persists settings in database and keep alive in cache.
+test_files:
+- spec/base_spec.rb
+- spec/cache_spec.rb
+- spec/resource_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb