rails-3-settings 0.1.1

data/.project

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>rails-settings</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+		<nature>org.radrails.rails.core.railsnature</nature>
+	</natures>
+</projectDescription>

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2006 Alex Wayne
+Some additional features added 2009 by Georg Ledermann
+
+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 PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL 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,91 @@
+= Settings Gem
+
+Settings is a plugin that makes managing a table of global key, value pairs easy.
+Think of it like a global Hash stored in you database, that uses simple ActiveRecord
+like methods for manipulation.  Keep track of any global setting that you dont want
+to hard code into your rails app.  You can store any kind of object.  Strings, numbers,
+arrays, or any object. Ported to Rails 3!
+
+
+== Setup
+
+Edit your Gemfile:
+  gem "rails-settings", :git => "git://github.com/100hz/rails-settings.git"
+  
+Generate your settings:
+  rails g settings <settings_name>
+
+Now just put that migration in the database with:
+  rake db:migrate
+
+
+== Usage
+
+The syntax is easy.  First, lets create some settings to keep track of:
+
+  MySettings.admin_password = 'supersecret'
+  MySettings.date_format    = '%m %d, %Y'
+  MySettings.cocktails      = ['Martini', 'Screwdriver', 'White Russian']
+  MySettings.foo            = 123
+  MySettings.credentials    = { :username => 'tom', :password => 'secret' }
+
+Now lets read them back:
+
+  MySettings.foo            # returns 123
+
+Changing an existing setting is the same as creating a new setting:
+
+  MySettings.foo = 'super duper bar'
+
+For changing an existing setting which is a Hash, you can merge new values with existing ones:
+  MySettings.merge! :credentials, :password => 'topsecret'
+  MySettings.credentials    # returns { :username => 'tom', :password => 'topsecret' }
+
+Decide you dont want to track a particular setting anymore?
+
+  MySettings.destroy :foo
+  MySettings.foo            # returns nil
+
+Want a list of all the settings?
+
+  MySettings.all            # returns {'admin_password' => 'super_secret', 'date_format' => '%m %d, %Y'}
+
+You need name spaces and want a list of settings for a give name space? Just choose your prefered named space delimiter and use Settings.all like this:
+
+  MySettings['preferences.color'] = :blue
+  MySettings['preferences.size'] = :large
+  MySettings['license.key'] = 'ABC-DEF'
+  MySettings.all('preferences.')   # returns { 'preferences.color' => :blue, 'preferences.size' => :large }
+
+Set defaults for certain settings of your app.  This will cause the defined settings to return with the
+Specified value even if they are not in the database.  Make a new file in config/initializers/settings.rb
+with the following:
+
+  MySettings.defaults[:some_setting] = 'footastic'
+  
+Now even if the database is completely empty, you app will have some intelligent defaults:
+
+  MySettings.some_setting   # returns 'footastic'
+
+Settings may be bound to any existing ActiveRecord object. Define this association like this:
+
+  class User < ActiveRecord::Base
+    has_settings
+  end
+
+Then you can set/get a setting for a given user instance just by doing this:
+
+  user = User.find(123)
+  user.settings.color = :red
+  user.settings.color # returns :red
+  user.settings.all # { "color" => :red }
+
+I you want to find users having or not having some settings, there are named scopes for this:
+
+  User.with_settings # => returns a scope of users having any setting
+  User.with_settings_for('color') # => returns a scope of users having a 'color' setting
+  
+  User.without_settings # returns a scope of users having no setting at all (means user.settings.all == {})
+  User.without_settings('color') # returns a scope of users having no 'color' setting (means user.settings.color == nil)
+
+That's all there is to it! Enjoy!

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new() do |gem|
+    gem.name = "rails-3-settings"
+    gem.summary = "Settings is a plugin that makes managing a table of global key, value pairs easy. Think of it like a global Hash stored in you database, that uses simple ActiveRecord like methods for manipulation.  Keep track of any global setting that you dont want to hard code into your rails app.  You can store any kind of object.  Strings, numbers, arrays, or any object. Ported to Rails 3!"
+    gem.email = "rails-settings@theblackestbox.net"
+    gem.homepage = "http://github.com/100hz/rails-settings"
+    gem.authors = ["Squeegy","Georg Ledermann","100hz"]
+    gem.add_dependency "rails", ">= 3.0.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+
+task :default => :release

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/generators/settings/settings_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators/migration'
+
+    class SettingsGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+  
+      argument :name, :type => :string, :default => "my_settings"
+  
+      source_root File.expand_path('../templates', __FILE__)  
+  
+      @@migrations = false
+      
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          if @@migrations          
+            (current_migration_number(dirname) + 1)
+          else
+            @@migrations = true
+            Time.now.utc.strftime("%Y%m%d%H%M%S")
+          end
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end  
+
+      def settings      
+        #generate(:model, name, "--skip-migration")
+        template "model.rb", File.join("app/models",class_path,"#{file_name}.rb"), :force => true
+        migration_template "migration.rb", "db/migrate/create_settings.rb"
+      end
+    end

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

@@ -0,0 +1,17 @@
+class CreateSettings < ActiveRecord::Migration
+  def self.up
+    create_table :settings do |t|
+      t.string :var, :null => false
+      t.text   :value, :null => true
+      t.integer :thing_id, :null => true
+      t.string :thing_type, :limit => 30, :null => true
+      t.timestamps
+    end
+    
+    add_index :settings, [ :thing_type, :thing_id, :var ], :unique => true
+  end
+
+  def self.down
+    drop_table :settings
+  end
+end

data/lib/generators/settings/templates/model.rb

@@ -0,0 +1,3 @@
+class <%= class_name %> < RailsSettings::Settings
+  
+end

data/lib/rails-settings.rb

@@ -0,0 +1,5 @@
+require "rails-settings/settings"
+require "rails-settings/scoped_settings"
+
+
+require "rails-settings/railtie" if defined?(Rails) && Rails.version >= "3"

data/lib/rails-settings/railtie.rb

@@ -0,0 +1,43 @@
+module RailsSettings
+  class Railtie < Rails::Railtie
+    
+    initializer 'rails_settings.initialize', :after => :after_initialize do      
+      Railtie.extend_active_record
+    end
+
+  end
+  
+  class Railtie
+    def self.extend_active_record
+      ActiveRecord::Base.class_eval do
+        def self.has_settings
+          class_eval do
+            def settings
+              RailsSettings::ScopedSettings.for_thing(self)
+            end
+            
+            scope :with_settings, :joins => "JOIN settings ON (settings.thing_id = #{self.table_name}.#{self.primary_key} AND
+                                                                     settings.thing_type = '#{self.base_class.name}')",
+                                        :select => "DISTINCT #{self.table_name}.*" 
+      
+            scope :with_settings_for, lambda { |var| { :joins => "JOIN settings ON (settings.thing_id = #{self.table_name}.#{self.primary_key} AND
+                                                                                          settings.thing_type = '#{self.base_class.name}') AND
+                                                                                          settings.var = '#{var}'" } }
+                                                                     
+            scope :without_settings, :joins => "LEFT JOIN settings ON (settings.thing_id = #{self.table_name}.#{self.primary_key} AND
+                                                                             settings.thing_type = '#{self.base_class.name}')",
+                                           :conditions => 'settings.id IS NULL'
+                                           
+            scope :without_settings_for, lambda { |var| { :joins => "LEFT JOIN settings ON (settings.thing_id = #{self.table_name}.#{self.primary_key} AND
+                                                                                                  settings.thing_type = '#{self.base_class.name}') AND
+                                                                                                  settings.var = '#{var}'",
+                                                                :conditions => 'settings.id IS NULL' } }
+          end
+        end
+      end
+    end
+    
+  end
+end
+
+

data/lib/rails-settings/scoped_settings.rb

@@ -0,0 +1,13 @@
+module RailsSettings
+  class ScopedSettings < Settings
+    def self.for_thing(object)
+      @object = object
+      self
+    end
+    
+    def self.thing_scoped
+      Settings.scoped_by_thing_type_and_thing_id(@object.class.base_class.to_s, @object.id)
+    end
+ 
+  end
+end

data/lib/rails-settings/settings.rb

@@ -0,0 +1,112 @@
+module RailsSettings
+  class Settings < ActiveRecord::Base
+    
+    set_table_name 'settings'
+    
+    class SettingNotFound < RuntimeError; end
+    
+    cattr_accessor :defaults
+    @@defaults = {}.with_indifferent_access
+    
+    # Support old plugin
+    if defined?(SettingsDefaults::DEFAULTS)
+      @@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)
+      method_name = method.to_s
+      super(method, *args)
+      
+    rescue NoMethodError
+      #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
+    
+    #destroy the specified settings record
+    def self.destroy(var_name)
+      var_name = var_name.to_s
+      if self[var_name]
+        object(var_name).destroy
+        true
+      else
+        raise SettingNotFound, "Setting variable \"#{var_name}\" not found"
+      end
+    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 = thing_scoped.find(:all, {:select => 'var, value'}.merge(options))
+      
+      result = {}
+      vars.each do |record|
+        result[record.var] = record.value
+      end
+      result.with_indifferent_access
+    end
+    
+    #get a setting value by [] notation
+    def self.[](var_name)
+      if var = object(var_name)
+        var.value
+      elsif @@defaults[var_name.to_s]
+        @@defaults[var_name.to_s]
+      else
+        nil
+      end
+    end
+    
+    #set a setting value by [] notation
+    def self.[]=(var_name, value)
+      var_name = var_name.to_s
+      
+      record = object(var_name) || thing_scoped.new(:var => var_name)
+      record.value = value
+      record.save!
+      
+      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.object(var_name)
+      thing_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.thing_scoped
+      self.scoped_by_thing_type_and_thing_id(nil, nil)
+    end
+    
+    
+  end
+end

data/rails-settings.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rails-settings}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Squeegy", "Georg Ledermann", "100hz"]
+  s.date = %q{2010-10-07}
+  s.email = %q{rails-settings@theblackestbox.net}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".project",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/generators/settings/settings_generator.rb",
+     "lib/generators/settings/templates/migration.rb",
+     "lib/generators/settings/templates/model.rb",
+     "lib/rails-settings.rb",
+     "lib/rails-settings/railtie.rb",
+     "lib/rails-settings/scoped_settings.rb",
+     "lib/rails-settings/settings.rb",
+     "rails-settings.gemspec",
+     "rails/init.rb"
+  ]
+  s.homepage = %q{http://theblackestbox.net}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Settings is a plugin that makes managing a table of global key, value pairs easy. Think of it like a global Hash stored in you database, that uses simple ActiveRecord like methods for manipulation.  Keep track of any global setting that you dont want to hard code into your rails app.  You can store any kind of object.  Strings, numbers, arrays, or any object. Ported to Rails 3!}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.0"])
+    else
+      s.add_dependency(%q<rails>, [">= 3.0.0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 3.0.0"])
+  end
+end
+

data/rails/init.rb

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

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: rails-3-settings
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.1
+platform: ruby
+authors: 
+  - Squeegy
+  - Georg Ledermann
+  - 100hz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-14 00:00:00 +02:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rails
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 3.0.0
+    type: :runtime
+    version_requirements: *id001
+description: 
+email: rails-settings@theblackestbox.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - README.rdoc
+files: 
+  - .project
+  - MIT-LICENSE
+  - README.rdoc
+  - Rakefile
+  - VERSION
+  - lib/generators/settings/settings_generator.rb
+  - lib/generators/settings/templates/migration.rb
+  - lib/generators/settings/templates/model.rb
+  - lib/rails-settings.rb
+  - lib/rails-settings/railtie.rb
+  - lib/rails-settings/scoped_settings.rb
+  - lib/rails-settings/settings.rb
+  - rails-settings.gemspec
+  - rails/init.rb
+has_rdoc: true
+homepage: http://github.com/100hz/rails-settings
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 3
+summary: Settings is a plugin that makes managing a table of global key, value pairs easy. Think of it like a global Hash stored in you database, that uses simple ActiveRecord like methods for manipulation.  Keep track of any global setting that you dont want to hard code into your rails app.  You can store any kind of object.  Strings, numbers, arrays, or any object. Ported to Rails 3!
+test_files: []
+