ledermann-rails-settings 1.2.0 → 2.0.0

data/spec/support/matchers/perform_queries.rb

@@ -0,0 +1,18 @@
+RSpec::Matchers.define :perform_queries do |expected|
+  match do |block|
+    query_count(&block) == expected
+  end
+
+  failure_message_for_should do |actual|
+    "Expected to run #{expected} queries, got #{@counter.query_count}"
+  end
+
+  def query_count(&block)
+    @counter = ActiveRecord::QueryCounter.new
+    ActiveSupport::Notifications.subscribe('sql.active_record', @counter.to_proc)
+    yield
+    ActiveSupport::Notifications.unsubscribe(@counter.to_proc)
+
+    @counter.query_count
+  end
+end

data/spec/support/query_counter.rb

@@ -0,0 +1,17 @@
+module ActiveRecord
+  class QueryCounter
+    attr_reader :query_count
+
+    def initialize
+      @query_count = 0
+    end
+
+    def to_proc
+      lambda(&method(:callback))
+    end
+
+    def callback(name, start, finish, message_id, values)
+      @query_count += 1 unless %w(CACHE SCHEMA).include?(values[:name]) || values[:sql] == 'begin transaction' || values[:sql] == 'commit transaction'
+    end
+  end
+end

metadata

@@ -1,103 +1,78 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ledermann-rails-settings
-version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: 
-  segments: 
-  - 1
-  - 2
-  - 0
-  version: 1.2.0
+version: !ruby/object:Gem::Version
+  version: 2.0.0
 platform: ruby
-authors: 
+authors:
 - Georg Ledermann
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-07-21 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+date: 2013-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 2
-        - 3
-        version: "2.3"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
   name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
   type: :development
-  version_requirements: *id005
-description: 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.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: Settings gem for Ruby on Rails
+email:
 - mail@georg-ledermann.de
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Changelog.md
@@ -105,53 +80,57 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- ci/Gemfile.rails-2.3.x
-- ci/Gemfile.rails-3.0.x
 - ci/Gemfile.rails-3.1.x
 - ci/Gemfile.rails-3.2.x
-- init.rb
+- lib/generators/rails_settings/migration/migration_generator.rb
+- lib/generators/rails_settings/migration/templates/migration.rb
 - lib/rails-settings.rb
-- lib/rails-settings/active_record.rb
-- lib/rails-settings/null_store.rb
-- lib/rails-settings/scoped_settings.rb
-- lib/rails-settings/settings.rb
+- lib/rails-settings/base.rb
+- lib/rails-settings/configuration.rb
+- lib/rails-settings/scopes.rb
+- lib/rails-settings/setting_object.rb
 - lib/rails-settings/version.rb
 - rails-settings.gemspec
-- test/settings_test.rb
-- test/test_helper.rb
+- spec/configuration_spec.rb
+- spec/queries_spec.rb
+- spec/scopes_spec.rb
+- spec/serialize_spec.rb
+- spec/setting_object_spec.rb
+- spec/settings_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/perform_queries.rb
+- spec/support/query_counter.rb
 homepage: https://github.com/ledermann/rails-settings
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+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: ledermann-rails-settings
-rubygems_version: 1.8.24
+rubyforge_project: 
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
-summary: Settings management for ActiveRecord objects
-test_files: 
-- test/settings_test.rb
-- test/test_helper.rb
+specification_version: 4
+summary: 'Handling settings for ActiveRecord objects by storing them as serialized
+  Hash in a separate database table. Optional: Defaults and Namespaces.'
+test_files:
+- spec/configuration_spec.rb
+- spec/queries_spec.rb
+- spec/scopes_spec.rb
+- spec/serialize_spec.rb
+- spec/setting_object_spec.rb
+- spec/settings_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/perform_queries.rb
+- spec/support/query_counter.rb

data/ci/Gemfile.rails-2.3.x

@@ -1,5 +0,0 @@
-source :rubygems
-
-gem 'activerecord', '~> 2.3.14'
-gem 'sqlite3'
-gem 'rake'

data/ci/Gemfile.rails-3.0.x

@@ -1,5 +0,0 @@
-source :rubygems
-
-gem 'activerecord', '~> 3.0.12'
-gem 'sqlite3'
-gem 'rake'

data/init.rb

@@ -1 +0,0 @@
-require 'rails-settings'

data/lib/rails-settings/active_record.rb

@@ -1,38 +0,0 @@
-ActiveRecord::Base.class_eval do
-  def self.has_settings
-    class_eval do
-      def settings
-        ScopedSettings.for_target(self)
-      end
-
-      def self.settings
-        ScopedSettings.for_target(self)
-      end
-
-      def settings=(hash)
-        hash.each { |k,v| settings[k] = v }
-      end
-
-      after_destroy { |user| user.settings.target_scoped.delete_all }
-
-      scope_method = ActiveRecord::VERSION::MAJOR < 3 ? :named_scope : :scope
-      
-      send scope_method, :with_settings, :joins => "JOIN settings ON (settings.target_id = #{self.table_name}.#{self.primary_key} AND
-                                                                      settings.target_type = '#{self.base_class.name}')",
-                                         :select => "DISTINCT #{self.table_name}.*" 
-
-      send scope_method, :with_settings_for, lambda { |var| { :joins => "JOIN settings ON (settings.target_id = #{self.table_name}.#{self.primary_key} AND
-                                                                              settings.target_type = '#{self.base_class.name}') AND
-                                                                              settings.var = '#{var}'" } }
-                                                               
-      send scope_method, :without_settings, :joins => "LEFT JOIN settings ON (settings.target_id = #{self.table_name}.#{self.primary_key} AND
-                                                                 settings.target_type = '#{self.base_class.name}')",
-                                            :conditions => 'settings.id IS NULL'
-                                     
-      send scope_method, :without_settings_for, lambda { |var| { :joins => "LEFT JOIN settings ON (settings.target_id = #{self.table_name}.#{self.primary_key} AND
-                                                                                      settings.target_type = '#{self.base_class.name}') AND
-                                                                                      settings.var = '#{var}'",
-                                                                 :conditions => 'settings.id IS NULL' } }
-    end
-  end
-end

data/lib/rails-settings/null_store.rb

@@ -1,48 +0,0 @@
-unless defined?(ActiveSupport::Cache::NullStore)
-  # Copied from Rails 3
-  # https://github.com/rails/rails/blob/master/activesupport/lib/active_support/cache/null_store.rb
-  module ActiveSupport
-    module Cache
-      # A cache store implementation which doesn't actually store anything. Useful in
-      # development and test environments where you don't want caching turned on but
-      # need to go through the caching interface.
-      #
-      # This cache does implement the local cache strategy, so values will actually
-      # be cached inside blocks that utilize this strategy. See
-      # ActiveSupport::Cache::Strategy::LocalCache for more details.
-      class NullStore < Store
-        def initialize(options = nil)
-          super()
-          extend Strategy::LocalCache
-        end
-
-        def clear(options = nil)
-        end
-
-        def cleanup(options = nil)
-        end
-
-        def increment(name, amount = 1, options = nil)
-        end
-
-        def decrement(name, amount = 1, options = nil)
-        end
-
-        def delete_matched(matcher, options = nil)
-        end
-
-        protected
-          def read_entry(key, options) # :nodoc:
-          end
-
-          def write_entry(key, entry, options) # :nodoc:
-            true
-          end
-
-          def delete_entry(key, options) # :nodoc:
-            false
-          end
-      end
-    end
-  end
-end

data/lib/rails-settings/scoped_settings.rb

@@ -1,14 +0,0 @@
-class ScopedSettings < Settings
-  def self.for_target(target)
-    @target = target
-    self
-  end
-  
-  def self.target_id
-    @target.is_a?(Class) ? nil : @target.id
-  end
-  
-  def self.target_type
-    @target.is_a?(Class) ? @target.name : @target.class.base_class.to_s
-  end
-end

data/lib/rails-settings/settings.rb

@@ -1,142 +0,0 @@
-class Settings < ActiveRecord::Base
-  class SettingNotFound < RuntimeError; end
-  
-  cattr_accessor :defaults
-  self.defaults = {}.with_indifferent_access
-
-  # cache must follow the contract of ActiveSupport::Cache. Defaults to no-op.
-  cattr_accessor :cache
-  self.cache = ActiveSupport::Cache::NullStore.new
-
-  # options passed to cache.fetch() and cache.write(). example: {:expires_in => 5.minutes}
-  cattr_accessor :cache_options
-  self.cache_options = {}
-
-  def self.cache_key(var_name)
-    [target_id, target_type, var_name].compact.join("::")
-  end
-
-  # Support old plugin
-  if defined?(SettingsDefaults::DEFAULTS)
-    self.defaults = SettingsDefaults::DEFAULTS.with_indifferent_access
-  end
-  
-  #get or set a variable with the variable as the called method
-  def self.method_missing(method, *args)
-    if self.respond_to?(method)
-      super
-    else
-      method_name = method.to_s
-    
-      #set a value for a variable
-      if method_name =~ /=$/
-        var_name = method_name.gsub('=', '')
-        value = args.first
-        self[var_name] = value
-    
-      #retrieve a value
-      else
-        self[method_name]
-      
-      end
-    end
-  end
-  
-  #destroy the specified settings record
-  def self.destroy(var_name)
-    var_name = var_name.to_s
-    begin
-      target(var_name).destroy
-      cache.delete(cache_key(var_name))
-      true
-    rescue NoMethodError
-      raise SettingNotFound, "Setting variable \"#{var_name}\" not found"
-    end
-  end
-
-  def self.delete_all(conditions = nil)
-    cache.clear
-    super
-  end
-
-  #retrieve all settings as a hash (optionally starting with a given namespace)
-  def self.all(starting_with=nil)
-    options = starting_with ? { :conditions => "var LIKE '#{starting_with}%'"} : {}
-    vars = target_scoped.find(:all, {:select => 'var, value'}.merge(options))
-    
-    result = {}
-    vars.each do |record|
-      result[record.var] = record.value
-    end
-    defaults = @@defaults.select{ |k, v| k =~ /^#{starting_with}/ }
-    defaults = Hash[defaults] if defaults.is_a?(Array)
-    defaults.merge(result).with_indifferent_access
-  end
-  
-  #get a setting value by [] notation
-  def self.[](var_name)
-    cache.fetch(cache_key(var_name), cache_options) do
-      if var = target(var_name)
-        var.value
-      else
-        if target_id.nil?
-          @@defaults[var_name.to_s]
-        else
-          target_type.constantize.settings[var_name.to_s]
-        end
-      end
-    end
-  end
-  
-  #set a setting value by [] notation
-  def self.[]=(var_name, value)
-    record = target_scoped.find_or_initialize_by_var(var_name.to_s)
-    record.value = value
-    record.save!
-    cache.write(cache_key(var_name), value, cache_options)
-    value
-  end
-  
-  def self.merge!(var_name, hash_value)
-    raise ArgumentError unless hash_value.is_a?(Hash)
-    
-    old_value = self[var_name] || {}
-    raise TypeError, "Existing value is not a hash, can't merge!" unless old_value.is_a?(Hash)
-    
-    new_value = old_value.merge(hash_value)
-    self[var_name] = new_value if new_value != old_value
-    
-    new_value
-  end
-
-  def self.target(var_name)
-    target_scoped.find_by_var(var_name.to_s)
-  end
-  
-  #get the value field, YAML decoded
-  def value
-    YAML::load(self[:value])
-  end
-  
-  #set the value field, YAML encoded
-  def value=(new_value)
-    self[:value] = new_value.to_yaml
-  end
-  
-  def self.target_scoped
-    Settings.scoped_by_target_type_and_target_id(target_type, target_id)
-  end
-  
-  #Deprecated!
-  def self.reload # :nodoc:
-    self
-  end
-  
-  def self.target_id
-    nil
-  end
-
-  def self.target_type
-    nil
-  end
-end