settler 1.2.4 → 2.0.0

data/gemfiles/4.0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "appraisal", :group=>:test
+gem "jeweler", :group=>:test
+gem "sqlite3", :group=>:test
+gem "activerecord", "~> 4.0"
+gem "activesupport", "~> 4.0"
+

data/gemfiles/4.0.gemfile.lock

@@ -0,0 +1,81 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    appraisal (0.5.2)
+      bundler
+      rake
+    arel (4.0.0)
+    atomic (1.1.12)
+    builder (3.1.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.5)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    i18n (0.6.4)
+    jeweler (1.8.6)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    minitest (4.7.5)
+    multi_json (1.7.8)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    sqlite3 (1.3.7)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 4.0)
+  activesupport (~> 4.0)
+  appraisal
+  jeweler
+  sqlite3

data/lib/generators/settler/templates/migration.rb

@@ -2,7 +2,7 @@ class CreateSettingsTable < ActiveRecord::Migration
   def self.up
     create_table :settings, :force => true do |t|
       t.string  :key, :null => false
-      t.string  :alt
+      t.string  :label
       t.text    :value
       t.boolean :editable
       t.boolean :deletable

data/lib/generators/settler/templates/settler.yml

@@ -1,26 +1,26 @@
 settings: &settings
   google_analytics_key: &google
-    alt: Google analytics key
+    label: Google analytics key
     value: 'UA-xxxxxx-x'
     editable: true
     deletable: false
     validations:
       presence: true
   search_algorithm:
-    alt: Default search engine
+    label: Default search engine
     value: 'ferret'
     editable: true
     validations:
       inclusion: [ 'ferret' , 'sphinx' ]
   white_list:
-    alt: 'White-listed words'
+    label: 'White-listed words'
     value: 'herp, derp'
 
 development:
   <<: *settings  
   google_analytics_key:
     <<: *google
-    alt: Development Google analytics key
+    label: Development Google analytics key
     value: 'UA-xxxxxx-1'
 
 test:

data/lib/setting.rb

@@ -1,30 +1,20 @@
 require 'type_casters'
-require 'default_scope_patch' if defined?(ActiveRecord::VERSION) && ActiveRecord::VERSION::MAJOR >= 3
 
 # The Setting class is an AR model that encapsulates a Settler setting. The key if the setting is the only required attribute.\
 class Setting < ActiveRecord::Base  
-  cattr_accessor :rails3
-  self.rails3 = defined?(ActiveRecord::VERSION) && ActiveRecord::VERSION::MAJOR >= 3  
 
-  attr_readonly   :key
-  attr_accessible :key, :alt, :value
-  
-  validates_presence_of :key  
-  validate :setting_validations
-  
+  attr_readonly :key
+
   serialize :value
   
-  if rails3 
-    validate(:ensure_editable, :on => :update)
-    default_scope lambda{ where(['deleted = ? or deleted IS NULL', false]) }
-  else 
-    validate_on_update(:ensure_editable) 
-    default_scope :conditions => ['deleted = ? or deleted IS NULL', false]    
-  end  
+  validates :key, :presence => true
+  validate  :setting_validations
+  validate  :ensure_editable, :on => :update  
+
+  default_scope { where(['deleted = ? or deleted IS NULL', false]) }
   
-  scope_method = rails3 ? :scope : :named_scope
-  send scope_method, :editable, :conditions => { :editable => true }
-  send scope_method, :deletable, :conditions => { :deletable => true }  
+  scope :editable, lambda{ where(:editable => true) }
+  scope :deletable, lambda{ where(:deletable => true) }
   
   # Returns the value, typecasted if a typecaster is available.
   def value
@@ -55,7 +45,7 @@ class Setting < ActiveRecord::Base
   end
   
   def to_label
-    alt.present? ? alt : key
+    label.present? ? label : key
   end
   
   # Returns all valid values for this setting, which is based on the presence of an inclusion validator.
@@ -75,7 +65,7 @@ class Setting < ActiveRecord::Base
   # Returns false if the setting could not be destroyed.
   def destroy    
     if deletable?       
-      self.deleted = true if Setting.update_all({ :deleted => true }, { :id => self })
+      self.deleted = true if Setting.where(:id => self).update_all(:deleted => true)
       deleted?
     else 
       false
@@ -83,28 +73,23 @@ class Setting < ActiveRecord::Base
   end
   
   # Overrides the delete methods to ensure the default scope is not passed in the query
-  def delete *args;           Setting.without_default_scope{ super } end  
-  def self.delete_all *args;  Setting.without_default_scope{ super } end    
+  def delete *args;           Setting.unscoped{ super } end  
+  def self.delete_all *args;  Setting.unscoped{ super } end    
   
   # Resets this setting to the default stored in the settler configuration
   def reset!
     defaults = Settler.config[self.key]
-    self.alt = defaults['alt']
+    self.label = defaults['label']
     self.value = defaults['value']
     self.editable = defaults['editable']
     self.deletable = defaults['deletable']    
     self.deleted = false    
-    rails3 ? save(:validate => false) : save(false)
-  end
-  
-  # Can be used to get *all* settings, including deleted settings.
-  def self.without_default_scope &block
-    Setting.with_exclusive_scope(&block)
+    save(:validate => false)
   end
   
   # Deleted scope is specified as a method as it needs to be an exclusive scope
   def self.deleted
-    Setting.without_default_scope{ Setting.all :conditions => { :deleted => true } }
+    unscoped { Setting.where(:deleted => true) }
   end 
   
 private
@@ -130,7 +115,7 @@ private
   
   # Ensures uneditable settings cannot be updated.
   def ensure_editable
-    errors.add(:value, I18n.t('settler.errors.editable', :default => 'cannot be changed')) if value_changed? && !editable? 
+    errors.add(:base, I18n.t('settler.errors.editable', :default => 'Setting cannot be changed')) if changed? && !editable? 
   end 
     
 end

data/lib/settler.rb

@@ -1,6 +1,5 @@
 require 'yaml'
 require 'erb'
-require 'hash_extension'
 require 'type_casters'
 require 'setting'
 
@@ -19,9 +18,9 @@ class Settler
       self.config = File.exist?(source) ? YAML.load(ERB.new(File.read(source)).result).to_hash : {}
       self.config = config[namespace] || {} if namespace
       self.config.each do  |key, attributes| 
-        Setting.without_default_scope do 
-          setting = Setting.find_or_create_by_key(:key => key) do |s|
-             s.alt = attributes['alt']
+        Setting.unscoped do 
+          setting = Setting.where(:key => key).first || Setting.create(:key => key) do |s|
+             s.label = attributes['label']
              s.value = attributes['value']             
              s.editable = attributes['editable']
              s.deletable = attributes['deletable']
@@ -41,7 +40,7 @@ class Settler
     # Returns an array of all setting keys
     def settings(options = {})
       Settler.load! if config.nil?
-      Setting.all(:order => options[:order]).map(&:key)
+      Setting.order(options[:order]).pluck(:key)
     end  
     
     # Returns a list of validations to perform on a setting.

data/settler.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "settler"
-  s.version = "1.2.4"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Reinier de Lange"]
-  s.date = "2012-12-17"
+  s.date = "2013-08-12"
   s.description = "Settler can be used for defining application wide settings in Rails. Settings are loaded from a YAML file and stored in the database using ActiveRecord to allow users to update settings on the fly. The YAML configuration allows you to not only specify defaults, but setting value validations and typecasts as well!"
   s.email = "r.j.delange@nedforce.nl"
   s.extra_rdoc_files = [
@@ -18,50 +18,55 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".travis.yml",
+    "Appraisals",
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
     "LICENSE",
     "README.rdoc",
     "Rakefile",
     "VERSION",
-    "generators/settler/settler_generator.rb",
-    "generators/settler/templates/migration.rb",
-    "generators/settler/templates/settler.yml",
+    "gemfiles/3.0.gemfile",
+    "gemfiles/3.0.gemfile.lock",
+    "gemfiles/3.2.gemfile",
+    "gemfiles/3.2.gemfile.lock",
+    "gemfiles/4.0.gemfile",
+    "gemfiles/4.0.gemfile.lock",
     "init.rb",
-    "lib/default_scope_patch.rb",
     "lib/generators/settler/USAGE",
     "lib/generators/settler/settler_generator.rb",
     "lib/generators/settler/templates/migration.rb",
     "lib/generators/settler/templates/settler.yml",
-    "lib/hash_extension.rb",
     "lib/setting.rb",
     "lib/settler.rb",
     "lib/type_casters.rb",
     "settler.gemspec",
     "test/custom_typecaster.rb",
     "test/database.yml",
-    "test/helper.rb",
     "test/schema.rb",
     "test/settler.yml",
+    "test/test_helper.rb",
     "test/test_settler.rb"
   ]
   s.homepage = "http://github.com/moiristo/settler"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "2.0.6"
   s.summary = "Settler manages global application settings in Rails"
-  s.test_files = ["test/custom_typecaster.rb", "test/database.yml", "test/debug.log", "test/helper.rb", "test/schema.rb", "test/settler.yml", "test/test_settler.rb"]
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<sqlite3>, [">= 0"])
-      s.add_runtime_dependency(%q<rails>, [">= 0"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.2"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.2"])
     else
-      s.add_dependency(%q<sqlite3>, [">= 0"])
-      s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 3.2"])
+      s.add_dependency(%q<activesupport>, [">= 3.2"])
     end
   else
-    s.add_dependency(%q<sqlite3>, [">= 0"])
-    s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 3.2"])
+    s.add_dependency(%q<activesupport>, [">= 3.2"])
   end
 end
 

data/test/schema.rb

@@ -1,7 +1,7 @@
 ActiveRecord::Schema.define(:version => 0) do   
   create_table :settings, :force => true do |t|
     t.string  :key, :null => false
-    t.string  :alt
+    t.string  :label
     t.text    :value
     t.boolean :editable
     t.boolean :deletable

data/test/settler.yml

@@ -1,6 +1,6 @@
 settings:
   google_analytics_key:
-    alt: Google analytics key 
+    label: Google analytics key 
     value: 'UA-xxxxxx-x'
     editable: true
     deletable: false    
@@ -8,34 +8,34 @@ settings:
       format: !ruby/regexp "/^UA-.{6}-.$/i" 
       presence: true
   search_algorithm:
-    alt: Default search engine
+    label: Default search engine
     value: 'ferret'
     editable: false
     deletable: true
     validations:
       inclusion: [ 'ferret' , 'sphinx' ]
   bool_value:
-    alt: A boolean that should be typecasted
+    label: A boolean that should be typecasted
     value: true
     typecast: boolean    
   float_value:
-    alt: A float that should be typecasted
+    label: A float that should be typecasted
     value: 0.25
     typecast: float 
   integer_value:
-    alt: An integer that should be typecasted
+    label: An integer that should be typecasted
     value: 3
     typecast: integer          
   datetime_value:
-    alt: A datetime that should be typecasted
+    label: A datetime that should be typecasted
     value: "2012-01-15"
     typecast: datetime  
   password_value:
-    alt: A password value that should be typecasted
+    label: A password value that should be typecasted
     value: '123456'
     typecast: password            
   custom_value:
-    alt: An integer that should be custom typecasted
+    label: An integer that should be custom typecasted
     value: 1
     typecast: CustomTypecaster      
 

data/test/{helper.rb → test_helper.rb}

@@ -1,7 +1,7 @@
 require 'rubygems'
-#require 'debugger'
 require 'test/unit'
 require 'pp'
+# require 'debugger'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -10,6 +10,7 @@ gem "activerecord"
 require 'fileutils'
 require 'active_record'
 require 'active_support/core_ext/class/attribute_accessors'
+require 'active_support/buffered_logger'
 
 def load_schema
   config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))

data/test/test_settler.rb

@@ -1,8 +1,8 @@
-require 'helper'
+require 'test_helper'
 
 class TestSettler < Test::Unit::TestCase
   def setup
-    Setting.without_default_scope{ Setting.delete_all }
+    Setting.delete_all
     Settler.source = File.dirname(__FILE__) + '/settler.yml'
     Settler.namespace = 'settings'    
     Settler.load!
@@ -36,13 +36,7 @@ class TestSettler < Test::Unit::TestCase
   end
   
   def test_should_not_create_instance
-    if RUBY_VERSION.starts_with?("1.9")
-      assert_nil Settler.new
-    else      
-      assert_raise NoMethodError do
-        Settler.new
-      end
-    end
+    assert_nil Settler.new
   end
   
   def test_should_report_or_raise_missing    
@@ -89,14 +83,14 @@ class TestSettler < Test::Unit::TestCase
   def test_should_not_update_uneditable_setting
     uneditable_setting = Settler.search_algorithm
     assert !uneditable_setting.update_attributes(:value => 'sphinx')
-    assert Setting.rails3 ? uneditable_setting.errors[:value].any? : uneditable_setting.errors.on(:value).present?
+    assert uneditable_setting.errors[:base].any?
     assert_equal 'ferret', Settler[:search_algorithm]
   end
   
   def test_should_manually_update_uneditable_setting
     uneditable_setting = Settler.search_algorithm
     assert uneditable_setting.update_attribute(:value, 'sphinx')
-    assert Setting.rails3 ? uneditable_setting.errors[:value].empty? : uneditable_setting.errors.on(:value).nil?
+    assert uneditable_setting.errors[:value].empty?
     assert_equal 'sphinx', Settler[:search_algorithm]
   end  
   
@@ -112,16 +106,10 @@ class TestSettler < Test::Unit::TestCase
     assert_equal 'google_analytics_key', setting.reload.key
   end
   
-  def test_should_not_update_protected_attributes
-    setting = Settler.google_analytics_key
-    assert setting.update_attributes(:key => 'new_key', :alt => 'new_alt', :value => 'UA-xxxxxx-1', :editable => false, :deletable => true, :deleted => true)
-    setting.reload
-    assert_equal 'google_analytics_key', setting.key
-    assert_equal 'new_alt', setting.alt         
-    assert_equal 'UA-xxxxxx-1', setting.value    
-    assert setting.editable?        
-    assert !setting.deletable?
-    assert_nil setting.deleted    
+  def test_should_not_update_uneditable_settings
+    setting = Settler.google_analytics_key    
+    assert !setting.update_attributes(:key => 'new_key', :label => 'new_label', :value => 'UA-xxxxxx-1', :editable => false, :deletable => true, :deleted => true)
+    assert setting.errors[:base].any?
   end
   
   def test_should_get_scopes