ledermann-rails-settings 1.2.1 → 2.0.0

data/lib/rails-settings/base.rb

@@ -0,0 +1,36 @@
+module RailsSettings
+  module Base
+    def self.included(base)
+      base.class_eval do
+        has_many :setting_objects,
+                 :as         => :target,
+                 :autosave   => true,
+                 :dependent  => :delete_all,
+                 :class_name => self.setting_object_class_name
+
+        def settings(var)
+          raise ArgumentError unless var.is_a?(Symbol)
+          raise ArgumentError.new("Unknown key: #{var}") unless self.class.default_settings[var]
+
+          setting_objects.detect { |s| s.var == var.to_s } || setting_objects.build(:var => var.to_s)
+        end
+
+        def settings=(value)
+          if value.nil?
+            setting_objects.each(&:mark_for_destruction)
+          else
+            raise ArgumentError
+          end
+        end
+
+        def settings?(var=nil)
+          if var.nil?
+            setting_objects.any? { |setting_object| !setting_object.marked_for_destruction? && setting_object.value.present? }
+          else
+            settings(var).value.present?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings/configuration.rb

@@ -0,0 +1,32 @@
+module RailsSettings
+  class Configuration
+    def initialize(*args, &block)
+      options = args.extract_options!
+      klass = args.shift
+      keys = args
+
+      raise ArgumentError unless klass
+
+      @klass = klass
+      @klass.class_attribute :default_settings, :setting_object_class_name
+      @klass.default_settings = {}
+      @klass.setting_object_class_name = options[:class_name] || 'RailsSettings::SettingObject'
+
+      if block_given?
+        yield(self)
+      else
+        keys.each do |k|
+          key(k)
+        end
+      end
+
+      raise ArgumentError.new('has_settings: No keys defined') if @klass.default_settings.blank?
+    end
+
+    def key(name, options={})
+      raise ArgumentError.new("has_settings: Symbol expected, but got a #{name.class}") unless name.is_a?(Symbol)
+      raise ArgumentError.new("has_settings: Option :defaults expected, but got #{options.keys.join(', ')}") unless options.blank? || (options.keys == [:defaults])
+      @klass.default_settings[name] = (options[:defaults] || {}).stringify_keys.freeze
+    end
+  end
+end

data/lib/rails-settings/scopes.rb

@@ -0,0 +1,33 @@
+module RailsSettings
+  module Scopes
+    def self.included(base)
+      base.class_eval do
+        scope :with_settings, lambda {
+          joins("INNER JOIN settings ON #{settings_join_condition}").
+          uniq
+        }
+
+        scope :with_settings_for, lambda { |var|
+          raise ArgumentError unless var.is_a?(Symbol)
+          joins("INNER JOIN settings ON #{settings_join_condition} AND settings.var = '#{var}'")
+        }
+
+        scope :without_settings, lambda {
+          joins("LEFT JOIN settings ON #{settings_join_condition}").
+          where('settings.id IS NULL')
+        }
+
+        scope :without_settings_for, lambda { |var|
+          raise ArgumentError unless var.is_a?(Symbol)
+          joins("LEFT JOIN settings ON  #{settings_join_condition} AND settings.var = '#{var}'").
+          where('settings.id IS NULL')
+        }
+
+        def self.settings_join_condition
+          "settings.target_id   = #{table_name}.#{primary_key} AND
+           settings.target_type = '#{base_class.name}'"
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings/setting_object.rb

@@ -0,0 +1,64 @@
+module RailsSettings
+  class SettingObject < ActiveRecord::Base
+    self.table_name = 'settings'
+
+    belongs_to :target, :polymorphic => true
+
+    validates_presence_of :var, :value, :target_type
+    validate do
+      unless _target_class.default_settings[var.to_sym]
+        errors.add(:var, "#{var} is not defined!")
+      end
+    end
+
+    serialize :value, Hash
+
+    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 block_given?
+        super
+      else
+        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
+    end
+
+  private
+    def _get_value(name)
+      value[name] || _target_class.default_settings[var.to_sym][name]
+    end
+
+    def _set_value(name, v)
+      if value[name] != v
+        value_will_change!
+
+        if v.nil?
+          value.delete(name)
+        else
+          value[name] = v
+        end
+      end
+    end
+
+    def _target_class
+      target_type.constantize
+    end
+
+    def update(*)
+      # Patch ActiveRecord to save serialized attributes only if they are changed
+      # https://github.com/rails/rails/blob/3-2-stable/activerecord/lib/active_record/attribute_methods/dirty.rb#L70
+      super(changed) if changed?
+    end
+  end
+end

data/lib/rails-settings/version.rb

@@ -1,3 +1,3 @@
 module RailsSettings
-  VERSION = '1.2.1'
-end
+  VERSION = '2.0.0'
+end

data/rails-settings.gemspec

@@ -1,27 +1,25 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rails-settings/version'
 
-Gem::Specification.new do |s|
-  s.name        = 'ledermann-rails-settings'
-  s.version     = RailsSettings::VERSION
-  s.authors     = ['Georg Ledermann']
-  s.email       = ['mail@georg-ledermann.de']
-  s.homepage    = 'https://github.com/ledermann/rails-settings'
-  s.summary     = %q{Settings management for ActiveRecord objects}
-  s.description = %q{Ruby Gem that makes managing a table of key/value pairs easy. Think of it like a Hash stored in you database, that uses simple ActiveRecord like methods for manipulation.}
+Gem::Specification.new do |gem|
+  gem.name          = 'ledermann-rails-settings'
+  gem.version       = RailsSettings::VERSION
+  gem.authors       = ['Georg Ledermann']
+  gem.email         = ['mail@georg-ledermann.de']
+  gem.description   = %q{Settings gem for Ruby on Rails}
+  gem.summary       = %q{Handling settings for ActiveRecord objects by storing them as serialized Hash in a separate database table. Optional: Defaults and Namespaces.}
+  gem.homepage      = 'https://github.com/ledermann/rails-settings'
 
-  s.rubyforge_project = 'ledermann-rails-settings'
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
+  gem.add_dependency 'activerecord', '~> 3.1'
 
-  s.add_dependency 'activerecord', '>= 2.3'
-
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'sqlite3'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'sqlite3', '~> 1.3'
+  gem.add_development_dependency 'rspec', '~> 2.13'
 end

data/spec/configuration_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+module RailsSettings
+  class Dummy
+  end
+
+  describe Configuration, 'successful' do
+    it "should define single key" do
+      Configuration.new(Dummy, :dashboard)
+
+      Dummy.default_settings.should == { :dashboard => {} }
+      Dummy.setting_object_class_name.should == 'RailsSettings::SettingObject'
+    end
+
+    it "should define multiple keys" do
+      Configuration.new(Dummy, :dashboard, :calendar)
+
+      Dummy.default_settings.should == { :dashboard => {}, :calendar => {} }
+      Dummy.setting_object_class_name.should == 'RailsSettings::SettingObject'
+    end
+
+    it "should define single key with class_name" do
+      Configuration.new(Dummy, :dashboard, :class_name => 'MyClass')
+      Dummy.default_settings.should == { :dashboard => {} }
+      Dummy.setting_object_class_name.should == 'MyClass'
+    end
+
+    it "should define multiple keys with class_name" do
+      Configuration.new(Dummy, :dashboard, :calendar, :class_name => 'MyClass')
+
+      Dummy.default_settings.should == { :dashboard => {}, :calendar => {} }
+      Dummy.setting_object_class_name.should == 'MyClass'
+    end
+
+    it "should define using block" do
+      Configuration.new(Dummy) do |c|
+        c.key :dashboard
+        c.key :calendar
+      end
+
+      Dummy.default_settings.should == { :dashboard => {}, :calendar => {} }
+      Dummy.setting_object_class_name.should == 'RailsSettings::SettingObject'
+    end
+
+    it "should define using block with defaults" do
+      Configuration.new(Dummy) do |c|
+        c.key :dashboard, :defaults => { :theme => 'red' }
+        c.key :calendar, :defaults => { :scope => 'all' }
+      end
+
+      Dummy.default_settings.should == { :dashboard => { 'theme' => 'red' }, :calendar => { 'scope' => 'all'} }
+      Dummy.setting_object_class_name.should == 'RailsSettings::SettingObject'
+    end
+
+    it "should define using block and class_name" do
+      Configuration.new(Dummy, :class_name => 'MyClass') do |c|
+        c.key :dashboard
+        c.key :calendar
+      end
+
+      Dummy.default_settings.should == { :dashboard => {}, :calendar => {} }
+      Dummy.setting_object_class_name.should == 'MyClass'
+    end
+  end
+
+  describe Configuration, 'failure' do
+    it "should fail without args" do
+      expect {
+        Configuration.new
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should fail without keys" do
+      expect {
+        Configuration.new(Dummy)
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should fail without keys in block" do
+      expect {
+        Configuration.new(Dummy) do |c|
+        end
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should fail with keys not being symbols" do
+      expect {
+        Configuration.new(Dummy, 42, "string")
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should fail with keys not being symbols" do
+      expect {
+        Configuration.new(Dummy) do |c|
+          c.key 42, "string"
+        end
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should fail with unknown option" do
+      expect {
+        Configuration.new(Dummy) do |c|
+          c.key :dashboard, :foo => {}
+        end
+      }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/queries_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe 'Queries performed' do
+  context 'New record' do
+    let!(:user) { User.new :name => 'Mr. Pink' }
+
+    it 'should be saved by one SQL query' do
+      expect {
+        user.save!
+      }.to perform_queries(1)
+    end
+
+    it 'should be saved with settings for one key by two SQL queries' do
+      expect {
+        user.settings(:dashboard).foo = 42
+        user.settings(:dashboard).bar = 'string'
+        user.save!
+      }.to perform_queries(2)
+    end
+
+    it 'should be saved with settings for two keys by three SQL queries' do
+      expect {
+        user.settings(:dashboard).foo = 42
+        user.settings(:dashboard).bar = 'string'
+        user.settings(:calendar).bar = 'string'
+        user.save!
+      }.to perform_queries(3)
+    end
+  end
+
+  context 'Existing record without settings' do
+    let!(:user) { User.create! :name => 'Mr. Pink' }
+
+    it 'should be saved without SQL queries' do
+      expect {
+        user.save!
+      }.to perform_queries(0)
+    end
+
+    it 'should be saved with settings for one key by two SQL queries' do
+      expect {
+        user.settings(:dashboard).foo = 42
+        user.settings(:dashboard).bar = 'string'
+        user.save!
+      }.to perform_queries(2)
+    end
+
+    it 'should be saved with settings for two keys by three SQL queries' do
+      expect {
+        user.settings(:dashboard).foo = 42
+        user.settings(:dashboard).bar = 'string'
+        user.settings(:calendar).bar = 'string'
+        user.save!
+      }.to perform_queries(3)
+    end
+  end
+
+  context 'Existing record with settings' do
+    let!(:user) do
+      User.create! :name => 'Mr. Pink' do |user|
+        user.settings(:dashboard).theme = 'pink'
+        user.settings(:calendar).scope = 'all'
+      end
+    end
+
+    it 'should be saved without SQL queries' do
+      expect {
+        user.save!
+      }.to perform_queries(0)
+    end
+
+    it 'should be saved with settings for one key by one SQL queries' do
+      expect {
+        user.settings(:dashboard).foo = 42
+        user.settings(:dashboard).bar = 'string'
+        user.save!
+      }.to perform_queries(1)
+    end
+
+    it 'should be saved with settings for two keys by two SQL queries' do
+      expect {
+        user.settings(:dashboard).foo = 42
+        user.settings(:dashboard).bar = 'string'
+        user.settings(:calendar).bar = 'string'
+        user.save!
+      }.to perform_queries(2)
+    end
+
+    it 'should be destroyed by two SQL queries' do
+      expect {
+        user.destroy
+      }.to perform_queries(2)
+    end
+
+    it "should update settings by one SQL query" do
+      expect {
+        user.settings(:dashboard).update_attributes! :foo => 'bar'
+      }.to perform_queries(1)
+    end
+
+    it "should not touch database if there are no changes made" do
+      expect {
+        user.settings(:dashboard).update_attributes :theme => 'pink'
+        user.settings(:calendar).update_attributes :scope => 'all'
+      }.to perform_queries(0)
+    end
+  end
+end

data/spec/scopes_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'scopes' do
+  let!(:user1) { User.create! :name => 'Mr. White' do |user| user.settings(:dashboard).theme = 'white' end }
+  let!(:user2) { User.create! :name => 'Mr. Blue' }
+
+  it "should find objects with existing settings" do
+    User.with_settings.should eq([user1])
+  end
+
+  it "should find objects with settings for key" do
+    User.with_settings_for(:dashboard).should eq([user1])
+    User.with_settings_for(:foo).should eq([])
+  end
+
+  it "should records without settings" do
+    User.without_settings.should eq([user2])
+  end
+
+  it "should records without settings for key" do
+    User.without_settings_for(:foo).should eq([user1, user2])
+    User.without_settings_for(:dashboard).should eq([user2])
+  end
+
+  it "should require symbol as key" do
+    [ nil, "string", 42 ].each do |invalid_key|
+      expect { User.without_settings_for(invalid_key) }.to raise_error(ArgumentError)
+      expect { User.with_settings_for(invalid_key)    }.to raise_error(ArgumentError)
+    end
+  end
+end