settingsdb-rails 1.0.5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,43 @@
+= SettingsDB-Rails
+
+SettingsDB provides an easy to use mechanism for keeping application settings
+in your database.  It also provides a namespacing mechanism to keep settings
+from different areas separate, as well as a defaults option.
+
+== Getting Started
+
+Add settingsdb-rails to your Gemfile:
+
+  gem 'settingsdb-rails'
+
+To install the model, migration, and defaults initializer:
+
+  rails generate settingsdb:install
+  rake db:migrate
+
+This will create a `settings` model, migration, and initializer file.
+Now just reference settings in your code:
+
+  <% title Setting[:site_title] %>
+
+To create a new setting just set its value:
+
+  Setting[:site_title] = "My Awesome Site!"
+
+Non-qualified key operations use the `:default` namespace, to set a key
+in a particular namespace:
+
+  Setting[:myplugin, :site_title] = "My Awesome Plugin Site!"
+
+To set application defaults, use `SettingsDB::Defaults`:
+
+  SettingsDB::Defaults[:site_title] = 'Untitled'
+  SettingsDB::Defaults[:myplugin, :site_title] = 'Untitled Plugin'
+
+Or use a block:
+
+  SettingsDB::Defaults.config do |c|
+    c[:site_title] = 'Untitled'
+    c[:myplugin, :site_title] = 'Untitled Plugin'
+  end
+

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SettingsDB-Rails'
+  rdoc.main     = 'README.rdoc'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.exclude('lib/settingsdb-rails.rb', 'lib/settingsdb/version.rb')
+  rdoc.rdoc_files.exclude('lib/generators/**/*')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/generators/settingsdb/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate settingsdb Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/settingsdb/install_generator.rb

@@ -0,0 +1,103 @@
+require 'rails/generators/named_base'
+require 'rails/generators/migration'
+require 'rails/generators/active_record/migration'
+require 'active_record'
+require 'settingsdb/generators/generated_attribute'
+
+module SettingsDB::Generators # :nodoc: all
+  class InstallGenerator < Rails::Generators::NamedBase
+    include Rails::Generators::Migration
+    extend ActiveRecord::Generators::Migration
+
+    namespace "settingsdb:install"
+    argument :name, :type => :string, :default => 'settings'
+    argument :attributes, :type => :array, :default => [], :banner => "field:type[[:index][:default]] ..."
+    source_root File.expand_path('../templates', __FILE__)
+
+
+    desc "Creates a SettingsDB initializer, Model, and Migration"
+    class_option :model, :desc => 'Generate the model', :type => :boolean, :default => true
+    class_option :migration, :desc => 'Generate the migration', :type => :boolean, :default => true
+
+    def add_settingsdb_model
+      return if !options.model? || model_exists?
+      invoke 'active_record:model', [name.singularize], :migration => false
+    end
+
+    def inject_settingsdb_content
+      return if !options.model?
+      inject_into_class(model_path, model_class, "  acts_as_setting\n")
+    end
+
+    def add_settingsdb_migration
+      return if !options.migration?
+      if migration_exists?
+        migration_template 'migration_exists.rb', "db/migrate/settingsdb_add_settings_columns_to_#{table_name}"
+      else
+        migration_template 'migration.rb', "db/migrate/settingsdb_create_#{table_name}"
+      end
+    end
+
+    def add_settingsdb_initializer
+      return if initializer_exists?
+      template 'initializer.rb', 'config/initializers/settingsdb.rb'
+    end
+
+    protected
+    # override Rails::Generators::NamedBase#parse_attributes! to customize attribute parsing
+    def parse_attributes!
+      self.attributes = (attributes || []).map do |key_value|
+        name, type, index, default = key_value.split(/:/)
+        opts = {}
+        if default
+          opts[:default] = default
+        end
+        if index
+          index_type, constraint = index.split(/,/)
+          if constraint == 'not_null'
+            opts[:null] = false
+          end
+        end
+        create_attribute(name, type, index_type, opts)
+      end
+    end
+
+    def create_attribute(*args)
+      if Rails.version[0,3].to_f >= 3.2
+        Rails::Generators::GeneratedAttribute.new(*args)
+      else
+        SettingsDB::Generators::GeneratedAttribute.new(*args)
+      end
+    end
+
+    # Helper methods shamelessly copied from Devise
+    def file_name
+      name.underscore
+    end
+
+    def model_class
+      class_name.singularize
+    end
+
+    def model_path
+      @model_path ||= File.join('app', 'models', class_path, "#{file_name.singularize}.rb")
+    end
+
+    def migration_path
+      @migration_path ||= File.join("db", "migrate")
+    end
+
+    def model_exists?
+      File.exists?(File.join(destination_root, model_path))
+    end
+
+    def migration_exists?
+      Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/settingsdb_create_#{table_name}.rb$/).first
+    end
+
+    def initializer_exists?
+      File.exists?(File.join(destination_root, File.join(%w(config initializers settingsdb.rb))))
+    end
+
+  end
+end

data/lib/generators/settingsdb/templates/initializer.rb

@@ -0,0 +1,3 @@
+SettingsDB::Defaults.config do |config|
+  #config[:setting] = :value
+end

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

@@ -0,0 +1,18 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :<%= table_name %> do |t|
+      t.string :namespace, :null => false, :default => 'default'
+      t.string :name, :null => false
+      t.text :value
+<% attributes.each do |attr| -%>
+      t.<%= attr.type %> :<%= attr.name %><%= attr.inject_options %>
+<% end -%>
+    end
+
+    add_index :<%= table_name %>, [:namespace, :name], :unique => true
+    add_index :<%= table_name %>, :name
+<% attributes.reject {|attr| !attr.has_index?}.each do |attr| -%>
+    add_index :<%= table_name %>, :<%= attr.name %><%= attr.inject_index_options %>
+<% end -%>
+  end
+end

data/lib/generators/settingsdb/templates/migration_exists.rb

@@ -0,0 +1,10 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    add_column :<%= table_name %>, :namespace, :string, :null => false, :default => 'default'
+    add_column :<%= table_name %>, :name, :string, :null => false
+    add_column :<%= table_name %>, :value, :text
+
+    add_index :<%= table_name %>, [:namespace, :name], :unique => true
+    add_index :<%= table_name %>, :name
+  end
+end

data/lib/settingsdb-rails.rb

@@ -0,0 +1,6 @@
+module SettingsDB # :nodoc:
+end
+
+require 'settingsdb/defaults'
+require 'settingsdb/settings'
+require 'settingsdb/acts_as_setting'

data/lib/settingsdb/acts_as_setting.rb

@@ -0,0 +1,48 @@
+module SettingsDB::ActsAsSetting # :nodoc:
+  extend ActiveSupport::Concern
+
+  included do
+  end
+
+  module ClassMethods
+    ##
+    # This method causes the model to import the SettingsDB behavior
+    # A SettingsDB enabled modle requires 3 fields: name, namespace, and value
+    # This method also takes options to override the default names of these fields.
+    # === Options
+    # *:setting_namespace_field*:: Override namespace field-name (default: +:namespace+)
+    # *:setting_name_field*:: Override name field-name (default: +:name+)
+    # *:setting_value_field*:: Override value field-name (default: +:value+)
+    #
+    # === Examples
+    #
+    # To use the default field names in your model, no options are needed:
+    #
+    #   class Setting < ActiveRecord::Base
+    #     acts_as_setting
+    #   end
+    #
+    # If your model needs to rename a setting field's name pass them as options
+    # to +acts_as_settings+.  Here the +Configuration+ model keeps the namespace
+    # value in the +:scope+ field, and the setting name value in the +:key+ field:
+    #
+    #   class Configuration < ActiveRecord::Base
+    #     acts_as_setting :setting_namespace_field => :scope, :setting_name_field => :key
+    #   end
+    #
+    def acts_as_setting(options = {})
+      cattr_accessor :setting_namespace_field, :setting_name_field, :setting_value_field
+      self.setting_name_field = (options[:setting_name_field] || :name).to_sym
+      self.setting_namespace_field = (options[:setting_namespace_field] || :namespace).to_sym
+      self.setting_value_field = (options[:setting_value_field] || :value).to_sym
+      class_eval(<<-BLOCK, __FILE__, __LINE__ + 1)
+  include SettingsDB::Settings
+  serialize :#{setting_value_field}
+  before_destroy :remove_from_cache
+
+BLOCK
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, SettingsDB::ActsAsSetting

data/lib/settingsdb/defaults.rb

@@ -0,0 +1,91 @@
+require 'active_support/core_ext/hash/indifferent_access'
+class SettingsDB::Defaults
+
+  ##
+  # :call-seq:
+  #   Defaults[:key] -> value (from :default namespace)
+  #   Defaults[:p1, :key] -> value (from :p1 namespace)
+  #
+  # Returns the value for the index. If namespace is given
+  # returns the value for the index in that namespace.
+  # When no namespace is given, the :default namespace is used.
+  def self.[](namespace = :default, index)
+    @@defaults[namespace][index] if @@defaults[namespace]
+  end
+
+  ##
+  # :call-seq:
+  #   Defaults[:key] = value -> 'value' (in :default namespace)
+  #   Defaults[:p1, :key] = value -> 'value' (in :p1 namespace)
+  #
+  # Sets the value for the index.
+  # If a namespace is given then the index is set in that namespace
+  # else it is set in the default namespace.
+  def self.[]=(namespace = :default, index, value)
+    if @@defaults[namespace] && @@defaults[namespace].has_key?(index)
+      @@defaults[namespace][index] = value
+    else
+      @@defaults[namespace] = { index => value }
+      value
+    end
+  end
+
+  ##
+  # :call-seq:
+  #   Defaults.config -> hash
+  #   Defaults.config {|config| ...}
+  #
+  # If given a block yields self. If no block is given
+  # the hash of default values is returned.
+  # === Example
+  #   Defaults.config do |conf|
+  #     conf[:key1] = value1
+  #     conf[:ns1, :key1] = value2
+  #   end
+  #
+  # If no block is given the default hash is returned and
+  # can be manipulated directly:
+  #
+  #   default_hash = Defaults.config
+  #   default_hash[:default][:key1] = value1
+  #   default_hash[:ns1] = { :key1 => value2 }
+  def self.config # :yields: config
+    if block_given?
+      yield self
+    end
+    self
+  end
+
+  ##
+  # :call-seq:
+  #   reset! -> Defaults
+  #
+  # Deletes all the default settings.
+  def self.reset!
+    @@defaults = { :default => {} }.with_indifferent_access
+    self
+  end
+
+  ##
+  # :call-seq:
+  #   defaults! -> hash
+  #
+  # Returns the actual reference to the internal defaults hash.
+  # USE THIS WITH CARE!
+  def self.defaults!
+    @@defaults
+  end
+
+  ##
+  # :call-seq:
+  #   defaults -> hash
+  #
+  # Returns a deep copy of the defaults hash, modifying this will
+  # have no impact on Defaults[] results.
+  def self.defaults
+    # Do a deep copy
+    Marshal.load(Marshal.dump(@@defaults))
+  end
+
+  reset!
+end

data/lib/settingsdb/generators/generated_attribute.rb

@@ -0,0 +1,104 @@
+# This was copied from rails 3.2 to extend the support to earlier rails versions
+require 'active_support/time'
+require 'active_support/core_ext/object/inclusion'
+require 'active_support/core_ext/object/blank'
+
+module SettingsDB::Generators # :nodoc: all
+  class GeneratedAttribute
+    attr_accessor :name, :type
+    attr_reader   :attr_options
+
+    class << self
+      def parse(column_definition)
+        name, type, has_index = column_definition.split(':')
+
+        # if user provided "name:index" instead of "name:string:index"
+        # type should be set blank so GeneratedAttribute's constructor
+        # could set it to :string
+        has_index, type = type, nil if %w(index uniq).include?(type)
+
+        type, attr_options = *parse_type_and_options(type)
+        new(name, type, has_index, attr_options)
+      end
+
+      private
+
+      # parse possible attribute options like :limit for string/text/binary/integer or :precision/:scale for decimals
+      # when declaring options curly brackets should be used
+      def parse_type_and_options(type)
+        case type
+          when /(string|text|binary|integer){(\d+)}/
+            return $1, :limit => $2.to_i
+          when /decimal{(\d+),(\d+)}/
+            return :decimal, :precision => $1.to_i, :scale => $2.to_i
+          else
+            return type, {}
+        end
+      end
+    end
+
+    def initialize(name, type=nil, index_type=false, attr_options={})
+      @name           = name
+      @type           = (type.presence || :string).to_sym
+      @has_index      = %w(index uniq).include?(index_type)
+      @has_uniq_index = %w(uniq).include?(index_type)
+      @attr_options   = attr_options
+    end
+
+    def field_type
+      @field_type ||= case type
+        when :integer              then :number_field
+        when :float, :decimal      then :text_field
+        when :time                 then :time_select
+        when :datetime, :timestamp then :datetime_select
+        when :date                 then :date_select
+        when :text                 then :text_area
+        when :boolean              then :check_box
+        else :text_field
+      end
+    end
+
+    def default
+      @default ||= case type
+        when :integer                     then 1
+        when :float                       then 1.5
+        when :decimal                     then "9.99"
+        when :datetime, :timestamp, :time then Time.now.to_s(:db)
+        when :date                        then Date.today.to_s(:db)
+        when :string                      then name == "type" ? "" : "MyString"
+        when :text                        then "MyText"
+        when :boolean                     then false
+        when :references, :belongs_to     then nil
+        else ""
+      end
+    end
+
+    def human_name
+      name.to_s.humanize
+    end
+
+    def index_name
+      reference? ? "#{name}_id" : name
+    end
+
+    def reference?
+      self.type.in?([:references, :belongs_to])
+    end
+
+    def has_index?
+      @has_index
+    end
+
+    def has_uniq_index?
+      @has_uniq_index
+    end
+
+    def inject_options
+      @attr_options.blank? ? '' : ", #{@attr_options.to_s.gsub(/[{}]/, '')}"
+    end
+
+    def inject_index_options
+      has_uniq_index? ? ", :unique => true" : ''
+    end
+  end
+end