settings_on_rails 0.1.30 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1902e352d4b86e9b07fb40e0b3364a32ebf810f2
-  data.tar.gz: 0ff9fa4d7d46470da596aab09983f07415b58980
+  metadata.gz: fbb69ae794bd085f9996cb04e3246afec69c2d50
+  data.tar.gz: 1994e3ead98a2075bdd71d0b406ffcd9a98e3487
 SHA512:
-  metadata.gz: a23b884b80b9b6fc85920e42cc5b368a680176bd78e8e6910570ec6cf1b907bb39d42bc17f16523f99024a4994689f47b5b878a4a3a14bae5e13247543f700f8
-  data.tar.gz: 49efc61fc8d8f6efabdcfaee240db7f47032084c622fbf75ba79d4899385f6944326cf4de84a1a66d8cfa7d5c68caf77c7846e2555df543647498ee5fecc7a90
+  metadata.gz: 5cfd24abffdbc9c209d7e921e19f33e0170b10fafa25682546119402c7c0897a6706388fc0172b029dce06a4504827eb2f7d9de3c69ba675deda69e2e2d787ee
+  data.tar.gz: cc40d8e46d5ed04e2757ce10f6b5c58d33d099bce48f9680a03dd3b578e8f83108b0c95774cfb290568f8a52856b3bda09dc8b6f6668c9b86e31def8bc121ac7

data/Gemfile

@@ -4,4 +4,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'coveralls', require: false
-
+gem 'byebug'

data/README.md

@@ -1,4 +1,4 @@
-# SettingsOnRails
+# Settings on Rails
 [![Build Status](https://travis-ci.org/allenwq/settings_on_rails.svg?branch=master)](https://travis-ci.org/allenwq/settings_on_rails)
 [![Coverage Status](https://coveralls.io/repos/allenwq/settings_on_rails/badge.svg?branch=master)](https://coveralls.io/r/allenwq/settings_on_rails?branch=master)
 
@@ -46,7 +46,6 @@ Get settings
 @blog.settings(:theme).background_color # returns 'blue'
 
 @blog.settings(:post).pagination # returns nil if not set
-
 ```
 
 ## Default Values
@@ -56,7 +55,8 @@ class Blog < ActiveRecord::Base
   has_settings_on :column
 
   has_settings do |s|
-    s.has_key :theme, defaults:{ background_color: 'red', text_size: 50 }
+    s.key :theme, defaults:{ background_color: 'red', text_size: 50 }
+    s.attr :title, default: 'My Space'
   end
 end
 ```
@@ -64,24 +64,38 @@ OR
 ```ruby
 class Blog < ActiveRecord::Base
   has_settings_on :column do |s|
-    s.define :theme, defaults:{ background_color: 'red', text_size: 50 }
+    s.key :theme, defaults:{ background_color: 'red', text_size: 50 }
+    s.attr :title, default: 'My Space'
   end
 end
 ```
 
-## Nested/Multiple Keys
-
+You can get these defaults by:
+```ruby
+@blog.settings(:theme).background_color # 'red'
+@blog.settings(:theme).text_size # 50
+@blog.settings.title # 'My Space'
+```
 
+## Nested Keys
+Settings on Rails supports nested keys
 ```ruby
-@blog.settings(:theme, :homepage).background_color = 'white'
-#OR
+# Set
 @blog.settings(:theme).settings(:homepage).background_color = 'white'
+# Get
+@blog.settings(:theme).settings(:homepage).background_color # 'white'
+```
 
+# Multiple Keys
+You can also define you nested keys in following ways, it's equal to nested keys
+```ruby
+# Set
+@blog.settings(:theme, :homepage).background_color = 'white'
+# Get
 @blog.settings(:theme, :homepage).background_color # 'white'
-#OR
-@blog.settings(:theme).settings(:homepage).background_color # 'white'
 ```
 
+
 ## Method Name Customization
 You can customize the name of the settings method
 ```ruby

data/lib/settings_on_rails/base.rb

@@ -3,20 +3,24 @@ module SettingsOnRails
     extend ActiveSupport::Concern
 
     module ClassMethods
-      def has_settings_on(column, options = {})
-        SettingsColumn.setup(self, column)
+      def has_settings_on(column, options = {}, &block)
+        Configuration.init(self, column)
 
         method_name = options[:method] || :settings
         define_method method_name do |*keys|
-          column = SettingsColumn.check!(self)
+          column = Configuration.check!(self)
 
-          SettingsHandler.new(keys, self, column, method_name)
+          Settings.new(keys, self, column, method_name)
         end
+
+        has_settings(&block)
       end
 
-      def has_settings
-        raise NoSettingsColumnError unless SettingsColumn::NAME
-        yield if block_given?
+      def has_settings(*keys)
+        settings = HasSettings.new(keys, self, Configuration::DEFAULTS_COLUMN)
+        yield settings if block_given?
+
+        settings
       end
     end
   end

data/lib/settings_on_rails/configuration.rb

@@ -0,0 +1,54 @@
+module SettingsOnRails
+  module Configuration
+    NAME_COLUMN = :settings_column_name
+    DEFAULTS_COLUMN = :default_settings
+
+    # Initialize needed variables for given class
+    # @param [ActiveRecord] klass, the Model who has settings
+    # @param [Symbol] column, the column to store settings
+    def self.init(klass, column)
+      raise ArgumentError.new("has_settings_on: symbol expected, but got a #{column.class}") unless column.is_a?(Symbol)
+
+      klass.class_eval do
+        class_attribute Configuration::NAME_COLUMN, Configuration::DEFAULTS_COLUMN
+
+        serialize column, Hash
+        Configuration::init_defaults_column(self)
+        Configuration::init_name_column(self, column)
+      end
+    end
+
+    # Returns the name of settings column for that instance
+    def self.column_name(instance)
+      instance.class.send(Configuration::NAME_COLUMN)
+    end
+
+    # Check for the validity of the settings column
+    # Returns the column name if valid
+    def self.check!(instance)
+      settings_column_name = column_name(instance)
+      raise NoSettingsColumnError unless settings_column_name
+      raise ColumnNotExistError unless instance.has_attribute?(settings_column_name)
+      raise InvalidColumnTypeError if column_type_not_text?(instance, settings_column_name)
+
+      settings_column_name
+    end
+
+    # init to Hash {} for data attribute in klass if nil
+    def self.init_defaults_column(klass)
+      defaults = klass.send(Configuration::DEFAULTS_COLUMN)
+      klass.send(Configuration::DEFAULTS_COLUMN.to_s + '=', {}) unless defaults
+    end
+
+    def self.init_name_column(klass, column_name)
+      klass.send(Configuration::NAME_COLUMN.to_s + '=', column_name)
+    end
+
+
+    private
+
+    def self.column_type_not_text?(instance, settings_column)
+      return true if instance.column_for_attribute(settings_column).try(:sql_type) != 'text'
+    end
+  end
+end

data/lib/settings_on_rails/has_settings.rb

@@ -0,0 +1,68 @@
+require 'settings_on_rails/key_tree_builder'
+
+module SettingsOnRails
+  # Creates a object to save default settings
+  #
+  # @param [Array] keys, the symbol keys in a array
+  # @param [Class] target_model, default values will be saved in an class attribute in target model
+  # @param [Symbol] column_name, the column name in target_model to save default values
+  # @param [HasSettings] parent, parent has_settings object
+  class HasSettings < KeyTreeBuilder
+    def initialize(keys, target_model, column_name, parent = nil)
+      super(keys, target_model, column_name, parent)
+
+      @target_model = target_model
+      @column_name = column_name
+    end
+
+    REGEX_ATTR = /\A([a-z]\w*)\Z/i
+
+    # Declare a key, with default values
+    #
+    # @param [Symbol] keys
+    # @param [Hash] options, the last param must be an option with a defaults hash
+    def key(*keys)
+      options = keys.extract_options!
+      raise ArgumentError.new("has_settings: Option :defaults expected, but got #{options.keys.join(', ')}") unless options.blank? || (options.keys == [:defaults])
+      keys.each do |key_name|
+        raise ArgumentError.new("has_settings: symbol expected, but got a #{key_name.class}") unless key_name.is_a?(Symbol)
+      end
+
+      options[:defaults].each do |k, v|
+        has_settings(*keys).attr(k, default: v)
+      end
+    end
+
+    # Declare an attribute with default value
+    #
+    # @param [Symbol] value
+    # @param [Hash] options, options with a default Hash
+    def attr(value, options = {})
+      raise ArgumentError.new("has_settings: symbol expected, but got a #{value.class}") unless value.is_a?(Symbol)
+      raise ArgumentError.new("has_settings: Option :default expected, but got #{options.keys.join(', ')}") unless options.blank? || (options.keys == [:default])
+
+      default_value = options[:default]
+      raise 'Error' unless value.to_s =~ REGEX_ATTR
+
+      _set_value(value.to_s, default_value)
+    end
+
+    def has_settings(*keys)
+      settings = HasSettings.new(keys, @target_model, @column_name, self)
+      yield settings if block_given?
+      settings
+    end
+
+    private
+
+    def _set_value(name, v)
+      build_nodes
+
+      if v.nil?
+        current_node.delete(name)
+      else
+        current_node[name] = v
+      end
+    end
+  end
+end

data/lib/settings_on_rails/key_tree_builder.rb

@@ -0,0 +1,68 @@
+module SettingsOnRails
+  class KeyTreeBuilder
+    attr_accessor :keys, :parent
+
+    # All keys must be symbols, and attributes are strings
+    # Thus we can differentiate settings(:key).attr and settings(:key, :attr)
+    def initialize(keys, target_obj, target_column_name, parent)
+      keys.each do |key_name|
+        raise ArgumentError.new("has_settings: symbol expected, but got a #{key_name.class}") unless key_name.is_a?(Symbol)
+      end
+      @keys = keys
+      @target_obj = target_obj
+      @column_name = target_column_name
+      @parent = parent
+    end
+
+    # Returns column[key_chain[0]][key_chain[1]][...]
+    def current_node
+      return nil unless _key_node_exist?
+
+      _key_chain.inject(_target_column) { |h, key| h[key] }
+    end
+
+    # Call this method before set any values
+    def build_nodes
+      value = _target_column
+
+      for key in _key_chain
+        value[key] = {} unless value[key]
+        value = value[key]
+      end
+    end
+
+    private
+
+    def _key_node_exist?
+      value = _target_column
+
+      for key in _key_chain
+        value = value[key]
+        return false unless value
+      end
+
+      true
+    end
+
+    # Returns a key chain which includes all parent's keys and self keys
+    def _key_chain
+      handler = self
+      key_chain = []
+
+      begin
+        key_chain = handler.keys + key_chain
+        handler = handler.parent
+      end while handler
+
+      key_chain
+    end
+
+    def _target_column
+      if @target_obj.respond_to?(:read_attribute)
+        @target_obj.read_attribute(@column_name.to_sym)
+      else
+        @target_obj.send(@column_name.to_sym)
+      end
+    end
+  end
+end

data/lib/settings_on_rails/settings.rb

@@ -0,0 +1,65 @@
+require 'settings_on_rails/key_tree_builder'
+
+module SettingsOnRails
+  class Settings < KeyTreeBuilder
+    def initialize(keys, target_object, settings_column_name, method_name, parent = nil)
+      super(keys, target_object, settings_column_name, parent)
+      @target_object = target_object
+      @column_name = settings_column_name
+      @method_name = method_name
+
+      self.class_eval do
+        define_method(method_name, instance_method(:_settings))
+      end
+    end
+
+    REGEX_SETTER = /\A([a-z]\w*)=\Z/i
+    REGEX_GETTER = /\A([a-z]\w*)\Z/i
+
+    def respond_to?(method_name, include_priv=false)
+      super || method_name.to_s =~ REGEX_SETTER
+    end
+
+    def method_missing(method_name, *args, &block)
+      if method_name.to_s =~ REGEX_SETTER && args.size == 1
+        _set_value($1, args.first)
+      elsif method_name.to_s =~ REGEX_GETTER && args.size == 0
+        _get_value($1) || _default_settings($1)
+      else
+        super
+      end
+    end
+
+    private
+
+    def _settings(*keys)
+      raise ArgumentError, 'wrong number of arguments (0 for 1..n)' if keys.size == 0
+
+      Settings.new(keys, @target_object, @column_name, @method_name, self)
+    end
+
+    def _get_value(name)
+      node = current_node
+
+      node[name] if node
+    end
+
+    def _set_value(name, v)
+      return if _get_value(name) == v
+
+      @target_object.send("#{@column_name}_will_change!")
+      build_nodes
+
+      if v.nil?
+        current_node.delete(name)
+      else
+        current_node[name] = v
+      end
+    end
+
+    def _default_settings(name)
+      default_node = KeyTreeBuilder.new(keys, @target_object.class, Configuration::DEFAULTS_COLUMN, parent).current_node
+      default_node[name] if default_node
+    end
+  end
+end

data/lib/settings_on_rails/version.rb

@@ -1,3 +1,3 @@
 module SettingsOnRails
-  VERSION = '0.1.30'
+  VERSION = '0.2.0'
 end

data/lib/settings_on_rails.rb

@@ -1,6 +1,7 @@
 require 'settings_on_rails/base'
-require 'settings_on_rails/settings_column'
-require 'settings_on_rails/settings_handler'
+require 'settings_on_rails/configuration'
+require 'settings_on_rails/settings'
+require 'settings_on_rails/has_settings'
 require 'settings_on_rails/exceptions'
 require 'settings_on_rails/version'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: settings_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.30
+  version: 0.2.0
 platform: ruby
 authors:
 - ALLEN WANG QIANG
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-09 00:00:00.000000000 Z
+date: 2015-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -98,9 +98,11 @@ files:
 - Rakefile
 - lib/settings_on_rails.rb
 - lib/settings_on_rails/base.rb
+- lib/settings_on_rails/configuration.rb
 - lib/settings_on_rails/exceptions.rb
-- lib/settings_on_rails/settings_column.rb
-- lib/settings_on_rails/settings_handler.rb
+- lib/settings_on_rails/has_settings.rb
+- lib/settings_on_rails/key_tree_builder.rb
+- lib/settings_on_rails/settings.rb
 - lib/settings_on_rails/version.rb
 - settings_on_rails.gemspec
 homepage: https://github.com/allenwq/settings_on_rails

data/lib/settings_on_rails/settings_column.rb

@@ -1,32 +0,0 @@
-module SettingsOnRails
-  module SettingsColumn
-    NAME = :__settings_column
-
-    def self.setup(klass, column)
-      klass.class_eval do
-        class << self; attr_accessor SettingsColumn::NAME; end
-
-        serialize column, Hash
-        self.send(SettingsColumn::NAME.to_s + '=', column.to_sym)
-      end
-    end
-
-    def self.column(instance)
-      instance.class.send(SettingsColumn::NAME)
-    end
-
-    def self.check!(instance)
-      settings_column = column(instance)
-      raise NoSettingsColumnError unless settings_column
-      raise ColumnNotExistError unless instance.has_attribute?(settings_column)
-      raise InvalidColumnTypeError if column_type_not_text?(instance, settings_column)
-
-      settings_column
-    end
-
-    private
-    def self.column_type_not_text?(instance, settings_column)
-      return true if instance.column_for_attribute(settings_column).try(:sql_type) != 'text'
-    end
-  end
-end

data/lib/settings_on_rails/settings_handler.rb

@@ -1,118 +0,0 @@
-module SettingsOnRails
-  class SettingsHandler
-    PREFIX = '_'
-
-    attr_accessor :keys, :parent
-    def initialize(keys, target_object, column, method_name, parent = nil)
-      @keys = _prefix(keys.dup)
-      @target_object = target_object
-      @column = column
-      @method_name = method_name
-      @parent = parent
-
-      self.class_eval do
-        define_method(method_name, instance_method(:_settings))
-      end
-    end
-
-    REGEX_SETTER = /\A([a-z]\w*)=\Z/i
-    REGEX_GETTER = /\A([a-z]\w*)\Z/i
-
-    def respond_to?(method_name, include_priv=false)
-      super || method_name.to_s =~ REGEX_SETTER
-    end
-
-    def method_missing(method_name, *args, &block)
-      if method_name.to_s =~ REGEX_SETTER && args.size == 1
-        _set_value($1, args.first)
-      elsif method_name.to_s =~ REGEX_GETTER && args.size == 0
-        _get_value($1)
-      else
-        super
-      end
-    end
-
-    private
-    def _settings(*keys)
-      raise ArgumentError, 'wrong number of arguments (0 for 1..n)' if keys.size == 0
-
-      SettingsHandler.new(keys, @target_object, @column, @method_name, self)
-    end
-
-    def _get_value(name)
-      node = _get_key_node
-
-      if node
-        node[name]
-      else
-        nil
-      end
-    end
-
-    def _set_value(name, v)
-      return if _get_value(name) == v
-
-      @target_object.send("#{@column}_will_change!")
-      _build_key_tree
-      node = _get_key_node
-      if v.nil?
-        node.delete(name)
-      else
-        node[name] = v
-      end
-    end
-
-    def _key_node_exist?
-      value = _target_column
-
-      for key in _key_chain
-          value = value[key]
-          return false unless value
-      end
-
-      true
-    end
-
-    def _get_key_node
-      ret = _key_node_exist?
-      return nil unless ret
-
-      _key_chain.inject(_target_column) { |h, key| h[key] }
-    end
-
-    def _build_key_tree
-      value = _target_column
-
-      for key in _key_chain
-        value[key] = {} unless value[key]
-        value = value[key]
-      end
-    end
-
-    def _target_column
-      @target_object.read_attribute(@column.to_sym)
-    end
-
-    # prefix keys with _, to differentiate `settings(:key_a, :key_b)` and settings(:key_a).key_b
-    # thus _ becomes an reserved field
-    def _prefix(keys)
-      for i in 0..(keys.length - 1)
-        keys[i] = (PREFIX + keys[i].to_s).to_sym
-      end
-      keys
-    end
-
-    # Returns a key chain which includes all parent's keys and self keys
-    def _key_chain
-      handler = self
-      key_chain = []
-
-      begin
-        key_chain = handler.keys + key_chain
-        handler = handler.parent
-      end while handler
-
-      key_chain
-    end
-  end
-end