settingsdb-rails 1.0.5

data/lib/settingsdb/settings.rb

@@ -0,0 +1,121 @@
+require 'settingsdb/defaults'
+require 'active_support/concern'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'yaml'
+
+module SettingsDB::Settings # :nodoc:
+  extend ActiveSupport::Concern
+
+  included do
+    reset_cache!
+  end
+
+  def remove_from_cache # :nodoc:
+    self.class.delete_from_cache(self)
+  end
+
+  module ClassMethods
+
+    ##
+    # :call-seq:
+    #   Model[:key] -> value
+    #   Model[:namespace, :key] -> value
+    #
+    # Returns the value for the given key.
+    # If a namespace is given then the key lookup is restricted
+    # to that namespace. Unqualified keys are looked up in the
+    # +:default+ namespace.
+    def [](namespace = :default, index)
+      obj = get_setting(namespace, index)
+      return obj.read_attribute(setting_value_field) if obj
+      SettingsDB::Defaults[namespace, index]
+    end
+
+
+    ##
+    # :call-seq:
+    #   Model[:key] = value -> value
+    #   Model[:namespace, :key] = value -> value
+    #
+    # Sets the value for +:key+ to +value+ and commits the new value to
+    # the database. If +:namespace+ is given, the key is set in that
+    # namespace only, if +:namespace+ is not given then +:default+ is
+    # used.
+    def []=(namespace = :default, index, value)
+      obj = get_setting(namespace, index)
+      if obj
+        obj.instance_eval do
+          write_attribute(setting_value_field, value)
+        end
+        obj.save
+        write_cache(obj)
+      else
+        obj = write_cache(self.create(setting_name_field => index, setting_namespace_field => namespace, setting_value_field => value))
+      end
+    end
+
+    def delete_from_cache(setting) # :nodoc:
+      write_cache(setting,true)
+    end
+
+    ##
+    # :call-seq:
+    #   reset_cache! -> true
+    #
+    # Resets the internal setting cache
+    def reset_cache!
+      @@cache = { :default => {} }.with_indifferent_access
+      true
+    end
+
+    ##
+    # :call-seq:
+    #   cache -> hash
+    #
+    # Returns a deep copy of the internal setting cache
+    def cache
+      # Do a deep copy
+      Marshal.load(Marshal.dump(@@cache))
+    end
+
+    ##
+    # :call-seq:
+    #   cache! -> hash
+    #
+    # Returns a reference to the internal setting cache.
+    # USE WITH CAUTION!
+    def cache!
+      @@cache
+    end
+
+    protected
+    def write_cache(setting, remove = nil) # :nodoc:
+      index, namespace = setting.read_attribute(setting_name_field), setting.read_attribute(setting_namespace_field)
+      if @@cache[namespace] && @@cache[namespace].has_key?(index)
+        if remove
+          @@cache[namespace].delete(setting.read_attribute(setting_name_field))
+        else
+          @@cache[namespace][index] = setting
+        end
+      elsif !remove
+        @@cache[namespace] = { index => setting }
+        setting
+      end
+    end
+
+    def read_cache(namespace, index) # :nodoc:
+      if @@cache[namespace]
+        @@cache[namespace][index]
+      end
+    end
+
+    def get_setting(namespace, index) # :nodoc:
+      if obj = read_cache(namespace, index)
+        obj
+      else
+        obj = where(["#{setting_namespace_field} = ? AND #{setting_name_field} = ?", namespace, index]).first
+        write_cache(obj) if obj
+      end
+    end
+  end
+end

data/lib/settingsdb/version.rb

@@ -0,0 +1,3 @@
+module SettingsDB # :nodoc:
+  VERSION = "1.0.5"
+end

data/test/acts_as_setting_test.rb

@@ -0,0 +1,90 @@
+require 'test_helper'
+
+class ActsAsSettingTest < ActiveSupport::TestCase
+
+  setup do
+    ConfigA.destroy_all
+    ConfigA.reset_cache!
+    ConfigB.destroy_all
+    ConfigB.reset_cache!
+  end
+
+  test "modules exists" do
+    assert_kind_of Module, SettingsDB
+    assert_kind_of Module, SettingsDB::ActsAsSetting
+    assert_kind_of Class, ConfigA
+    assert_kind_of Class, ConfigB
+  end
+
+  test "config_a_setting_name_field should be key" do
+    assert_equal :key, ConfigA.setting_name_field
+  end
+
+  test "config_b_setting_name_field should be name" do
+    assert_equal :name, ConfigB.setting_name_field
+  end
+
+  test "config_a_setting_namespace_field should be scope" do
+    assert_equal :scope, ConfigA.setting_namespace_field
+  end
+
+  test "config_b_setting_namespace_field should be namespace" do
+    assert_equal :namespace, ConfigB.setting_namespace_field
+  end
+
+  test "config_a model creates a new setting when key is assigned" do
+    ConfigA[:foo] = :bar
+    item = ConfigA.where(:key => :foo, :scope => :default).first
+    assert_not_nil item
+    assert_equal :bar, item.value
+    assert_equal :bar, ConfigA[:foo]
+  end
+
+  test "config_b model creates a new setting when key is assigned" do
+    ConfigB[:foo] = :bar
+    item = ConfigB.where(:name => :foo, :namespace => :default).first
+    assert_not_nil item
+    assert_equal :bar, item.value
+    assert_equal :bar, ConfigB[:foo]
+  end
+
+  test "settings model gives distinct values from different namespaces" do
+    ConfigB[:foo] = :bar
+    ConfigB[:plugin, :foo] = :baz
+    obj = ConfigB.where(:name => :foo, :namespace => :default).first
+    assert_not_nil obj
+    assert_equal :bar, obj.value
+    obj = ConfigB.where(:name => :foo, :namespace => :plugin).first
+    assert_not_nil obj
+    assert_equal :baz, obj.value
+  end
+
+  test "settings model does not cache using create" do
+    obj = ConfigB.create(:name => 'foo', :namespace => 'default', :value => :bar)
+    cache = ConfigB.cache!
+    assert_nil cache[:default][:foo]
+  end
+
+  test "settings model caches on array index" do
+    obj = ConfigB.create(:name => :foo, :namespace => :default, :value => :bar)
+    cache = ConfigB.cache!
+    assert_nil cache[:default][:foo]
+    assert_equal :bar, ConfigB[:foo]
+    assert_equal :bar, cache[:default][:foo].value
+  end
+
+  test "settings model removes cache entry on destroy" do
+    ConfigB[:foo] = :bar
+    cache = ConfigB.cache!
+    assert_equal :bar, cache[:default][:foo].value
+    cache[:default][:foo].destroy
+    assert_nil cache[:default][:foo]
+  end
+
+  test "settings model falls back to default if no setting found" do
+    assert_nil ConfigB[:bar]
+    SettingsDB::Defaults[:bar] = :baz
+    assert_equal :baz, SettingsDB::Defaults[:bar]
+    assert_equal :baz, ConfigB[:bar]
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/config_a.rb

@@ -0,0 +1,3 @@
+class ConfigA < ActiveRecord::Base
+  acts_as_setting :setting_name_field => :key, :setting_namespace_field => :scope
+end

data/test/dummy/app/models/config_b.rb

@@ -0,0 +1,3 @@
+class ConfigB < ActiveRecord::Base
+  acts_as_setting
+end

data/test/dummy/app/models/test_setting.rb

@@ -0,0 +1,3 @@
+class TestSetting < ActiveRecord::Base
+  include SettingsDB::Settings
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "settingsdb-rails"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,30 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,60 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to Rails.root.join("public/assets")
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end