settings_lord 1.0.1 → 1.0.2

data/README.md

@@ -12,6 +12,10 @@ add to your Gemfile:
 
 	gem 'settings_lord'
 
+after this execute in console:
+	
+	rails g settings_lord
+
 ##Overview
 You can create settings via class methods:
 

data/lib/settings_lord/base.rb

@@ -1,6 +1,7 @@
 module SettingsLord
 
   ACTIVE_RECORD_COLUMNS = ['name','value','klass','parent_id']
+  RESERVED_REFLECTOR_WORDS = [:_name,:_klass,:_new_value,:_reflect_like_namespace,:_parent,:reflect]
 
   mattr_accessor :setting_creator
   mattr_accessor :meta_settings

data/lib/settings_lord/meta_setting_collection.rb

@@ -19,12 +19,12 @@ class SettingsLord::MetaSettingCollection
     @klasses_and_namespaces = {}
   end
 
-  def add(meta_option)
-    return false unless meta_option.is_a? SettingsLord::MetaSetting
+  def add(meta_setting)
+    return false unless meta_setting.is_a? SettingsLord::MetaSetting
 
-    remove_if_exists(meta_option)
-    fill_klasses_and_namespaces_table(meta_option)
-    self.collection << meta_option
+    remove_if_exists(meta_setting)
+    fill_klasses_and_namespaces_table(meta_setting)
+    self.collection << meta_setting
   end
 
   def has_klass?(klass_name)
@@ -36,10 +36,10 @@ class SettingsLord::MetaSettingCollection
   end
 
   def set_by(reflection)
-    reflection.name = remove_set_tag(reflection.name)
+    reflection._name = remove_set_tag(reflection._name)
 
     if meta_option = find_by_reflection(reflection)
-      meta_option.update_value(reflection.new_value)
+      meta_option.update_value(reflection._new_value)
     else
       return nil
     end
@@ -51,23 +51,23 @@ class SettingsLord::MetaSettingCollection
 
   def find_by_reflection(reflection)
     # we can't search without klass and name
-    return nil if reflection.klass.blank? || reflection.name.blank?
+    return nil if reflection._klass.blank? || reflection._name.blank?
 
     # check klass
-    return nil unless has_klass?(reflection.klass)
+    return nil unless has_klass?(reflection._klass)
 
     # check namespace if needed
-    if reflection.reflect_like_namespace
-      return nil unless klass_has_namespace?(reflection.klass, reflection.parent)
+    if reflection._reflect_like_namespace
+      return nil unless klass_has_namespace?(reflection._klass, reflection._parent)
     end
 
-    if reflection.reflect_like_namespace
+    if reflection._reflect_like_namespace
       result = @collection.select do |entry|
-        entry.klass == reflection.klass and entry.name == reflection.name and entry.parent == reflection.parent
+        entry.klass == reflection._klass and entry.name == reflection._name and entry.parent == reflection._parent
       end
     else
       result = @collection.select do |entry|
-        entry.klass == reflection.klass and entry.name == reflection.name
+        entry.klass == reflection._klass and entry.name == reflection._name
       end
     end
     

data/lib/settings_lord/reflector.rb

@@ -1,12 +1,25 @@
 class SettingsLord::Reflector
   # reflector hold klass/namespace information and reflect on name
 
-  attr_accessor :name,:klass,:new_value,:reflect_like_namespace,:parent
+  attr_accessor :_name,:_klass,:_new_value,:_reflect_like_namespace,:_parent
 
   def initialize(*args)
     setup_instance_variables!(args)
   end
 
+  # search for proper MetaOption in MetaOptionCollection and get/set needed value
+  def reflect
+    should_search = @meta.has_klass?(@_klass) or @meta.klass_has_namespace?(@_klass,@_name)
+    return nil unless should_search
+
+    if is_getter?
+      return create_sub_reflection! if should_create_sub_reflection?
+      return @meta.get_by(self)
+    else
+      return @meta.set_by(self)
+    end
+  end
+
   # method missing will be called only when we return Reflector object
   # this is default case when user attempt to nested option (option with namespace)
   # for example:
@@ -22,8 +35,8 @@ class SettingsLord::Reflector
   # when we return Reflector object this object already get klass and namespace information
   # we only need to setup called method name and some extra arguments
   def method_missing(called_name,*args,&block)
-    @name = called_name.to_sym
-    @new_value = args.first
+    @_name = called_name.to_sym
+    @_new_value = args.first
 
     result = self.reflect
 
@@ -38,54 +51,33 @@ class SettingsLord::Reflector
     end
   end
 
-  # search for proper MetaOption in MetaOptionCollection and get/set needed value
-  def reflect()
-    should_search = @meta.has_klass?(@klass) or @meta.klass_has_namespace?(@klass,@name)
-    return nil unless should_search
+  private
 
-    if is_getter?
-      return create_sub_reflection if should_create_sub_reflection?
-      return @meta.get_by(self)
-    else
-      return @meta.set_by(self)
-    end
+  # @name/@_parent/@klass should always be represented as Symbol
+  def setup_instance_variables!(args)
+    args = args.extract_options!
+    @_name = args[:name].to_sym
+    @_new_value = args[:new_value]
+    @_klass = args[:klass]
+    @_klass = args[:klass].model_name.underscore.to_sym if @_klass.is_a? Class
+    @_reflect_like_namespace = args[:reflect_like_namespace] || false
+    @meta = SettingsLord.meta_settings
   end
 
-  def should_create_sub_reflection?
-    @reflect_like_namespace == false and @meta.klass_has_namespace?(@klass,@name)
+  def is_getter?
+    not @_name.to_s.end_with?('=')
   end
 
-  def create_sub_reflection
+  def create_sub_reflection!
     reflection = self.dup
-    reflection.reflect_like_namespace = true
-    reflection.parent = reflection.name.to_sym
-    reflection.name = nil
+    reflection._reflect_like_namespace = true
+    reflection._parent = reflection._name.to_sym
+    reflection._name = nil
     return reflection
   end
 
-  def is_getter?
-    not @name.to_s.end_with?('=')
-  end
-
-  def default_value_called?
-    !!@name.to_s.match(/[a-zA-Z0-9]_default_value/) 
-  end
-
-  def remove_default_value_tag_from_string
-    @name.to_s.gsub(/_default_value/,'').to_sym 
-  end
-
-  private
-
-  # @name/@parent/@klass should always be represented as Symbol
-  def setup_instance_variables!(args)
-    args = args.extract_options!
-    @name = args[:name].to_sym
-    @new_value = args[:new_value]
-    @klass = args[:klass]
-    @klass = args[:klass].model_name.underscore.to_sym if @klass.is_a? Class
-    @reflect_like_namespace = args[:reflect_like_namespace] || false
-    @meta = SettingsLord.meta_settings
+  def should_create_sub_reflection?
+    @_reflect_like_namespace == false and @meta.klass_has_namespace?(@_klass,@_name)
   end
 
 end

data/lib/settings_lord/setting_creator.rb

@@ -27,6 +27,8 @@ class SettingsLord::SettingCreator
     options.assert_valid_keys(@meta::VALID_KEYS)
     options = check_and_maintain_options(options)
 
+		check_reserved_words(name)
+
     options[:klass] = @klass # option should know class
     options[:parent] = @parent.name.to_sym if @parent
     options[:name] = name
@@ -46,6 +48,14 @@ class SettingsLord::SettingCreator
     return options
   end
 
+	def check_reserved_words(name)
+		SettingsLord::RESERVED_REFLECTOR_WORDS.each do |word|
+			if name == word
+				raise Exception, "'#{word}' is reserved by SettingsLord."
+			end
+		end
+	end
+
   def check_bool_flags(options)
     @meta::BOOL_KEYS.each do |key|
       if options[key] and not @meta::BOOL_CLASSES.include?(options[key].class)

data/lib/settings_lord/version.rb

@@ -3,7 +3,7 @@ module SettingsLord
 
     MAJOR = 1
     MINOR = 0
-    PATCH = 1
+    PATCH = 2
 
     STRING = [MAJOR,MINOR,PATCH].compact.join('.')
 

data/test/settings_lord_test.rb

@@ -7,6 +7,14 @@ class SettingsLordTest < ActiveSupport::TestCase
     SettingsLord.meta_settings.instance_variable_set :@collection, []
   end
 
+	test "should not accept reserved reflector word" do
+		assert_raise Exception do
+			Setting.settings do
+				_name
+			end
+		end
+	end
+
 	test "should accept only boolean values" do
 		assert_nothing_raised do
 			Setting.settings do

metadata

@@ -2,7 +2,7 @@
 name: settings_lord
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - pechrorin_andrey
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-30 00:00:00 +04:00
+date: 2011-07-20 00:00:00 +04:00
 default_executable: 
 dependencies: []