real_settings 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.DS_Store

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in real_settings.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rspec-rails'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Macrow
+
+MIT License
+
+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.md

@@ -0,0 +1,164 @@
+# RealSettings
+
+RealSettings is a real settings tool for Rails3.
+
+RealSetting load default settings from config file, and store settings in memory.
+
+RealSetting can store settings in database.
+
+RealSetting can store different settings for your model(activerecord model only).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'real_settings'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install real_settings
+    
+Run install command and migrate database:
+
+    $ rails g real_settings:install
+    $ rake db:migrate
+    
+## Configuration in config/initializers/real_settings.rb
+
+```ruby
+Settings.config do
+  settings.app_name = "My Application Name"
+  settings.app_url = "http://www.my-application.com"
+  default_meta_keywords = "default meta keywords"
+  default_meta_description = "default meta description"
+  # add some settings here
+end
+```
+    
+## Features & Usage
+
+### RealSettings load default settings from config file
+            
+```ruby
+Settings.config do
+  settings.app_name = "My Application Name"
+  settings.app_url = "http://www.my-application.com"
+  default_meta_keywords = "default meta keywords"
+  default_meta_description = "default meta description"
+  ......
+end
+
+Settings.app_name # => "real_settings"
+Settings.app_url # => "http://www.real-settings.com"
+Settings.default_meta_keywords # => "default meta keywords"
+Settings.default_meta_description # => "default meta description"
+```
+ 
+### RealSettings can write settings into database
+
+```ruby
+Settings.admin_name # => nil
+Settings.admin_name = "Macrow"
+Settings.save!
+```
+
+### Support has_settings method
+
+```ruby    
+class User < ActiveReocrd::Base
+  has_settings
+end
+
+user = User.first
+user.settings.to_hash # => {}
+user.settings.email # => nil
+user.settings.email = "Macrow_wh@163.com"
+user.settings.email # => "Macrow_wh@163.com"
+user.settings.to_hash # => { :email => "Macrow_wh@163.com" }
+user.save! # save email settings in database
+
+another_user = User.last
+another_user.settings.to_hash # => {}
+another_user.settings.email # => nil
+```
+        
+### has_settings method with default values
+
+```ruby        
+class User < ActiveRecord::Base
+  has_settings :defaults => { :notebook => 'Macbook Pro', :mobile => 'iPhone 4' }
+end
+
+user = User.first
+user.settings.to_hash # => { :notebook => 'Macbook Pro', :mobile => 'iPhone 4' }
+user.settings.email # => nil
+user.settings.email = "Macrow_wh@163.com"
+user.settings.email # => "Macrow_wh@163.com"
+user.settings # => { :notebook => 'Macbook Pro', :mobile => 'iPhone 4', :email => "Macrow_wh@163.com" }
+user.save! # save email settings in database
+
+another_user = User.last
+another_user.settings.to_hash # => { :notebook => 'Macbook Pro', :mobile => 'iPhone 4' }
+another_user.settings.email # => nil
+```
+    
+### RealSettings load all settings in memory for performance in first query action
+
+```ruby    
+Settings.admin_name # => nil
+Settings.admin_name = "Macrow"
+Settings.admin_name # => "Macrow"
+Settings.reload!
+Settings.admin_name # => nil
+
+Settings.admin_name = "Macrow"
+Settings.save!
+Settings.admin_name # => "Macrow"
+Settings.reload!
+Settings.admin_name # => "Macrow"
+```
+        
+### Editing Global Settings
+
+```ruby        
+# Edit Form:
+form_for(Settings) do |f|
+  f.text_field :app_name
+  f.text_field :app_url
+  ......
+end
+
+# Update Action:
+Settings.update_attributes(params[:settings])
+```
+ 
+### Editing User's settings
+
+```ruby
+# config/routes.rb
+resources :users do
+  get 'settings/edit' => 'users#edit_settings'
+  put 'settings/update' => 'users#update_settings'
+end
+
+# User's settings Edit Form:
+form_for @user.settings, :as => :settings, :url => user_settings_update_path(@user), :method => :put do |f|
+  f.text_field :notebook
+  f.text_field :mobile
+  ......
+end
+
+# Update Action:
+@user = User.find(params[:user_id])
+@user.settings.update_attributes(params[:settings])
+```
+
+
+## License
+
+MIT License.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/generators/real_settings/USAGE

@@ -0,0 +1,9 @@
+Description:
+    install RealSettings for your application
+
+Example:
+    rails generate real_settings:install
+
+    This will create:
+        config/initializers/real_settings.rb
+        db/migrate/xxxxxxxxx_create_real_settings.rb

data/lib/generators/real_settings/install/install_generator.rb

@@ -0,0 +1,26 @@
+module RealSettings
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+    desc "Install RealSettings for your application."
+
+    def copy_initializers_files
+      template "real_settings.rb", "config/initializers/real_settings.rb"
+    end
+
+    def copy_migration_files
+      migration_template "migration.rb", "db/migrate/create_real_settings.rb"
+    end
+
+   def self.next_migration_number(dirname)
+     if ActiveRecord::Base.timestamped_migrations
+       Time.now.utc.strftime("%Y%m%d%H%M%S")
+     else
+       "%.3d" % (current_migration_number(dirname) + 1)
+     end
+   end
+   
+   
+   
+  end
+end

data/lib/generators/real_settings/install/templates/migration.rb

@@ -0,0 +1,17 @@
+class CreateRealSettings < ActiveRecord::Migration
+  def self.up
+    create_table :settings, :force => true do |t|
+      t.string  :key, :null => false
+      t.text    :value
+      t.integer :target_id
+      t.string  :target_type
+      t.timestamps
+    end
+
+    add_index :settings, [ :target_type, :target_id, :key ], :unique => true
+  end
+
+  def self.down
+    drop_table :settings
+  end
+end

data/lib/generators/real_settings/install/templates/real_settings.rb

@@ -0,0 +1,4 @@
+Settings.config do |settings|
+  # settings.app_name = "My Application Name"
+  # settings.app_url = "http://www.my-application.com"
+end

data/lib/real_settings/owner_settings.rb

@@ -0,0 +1,85 @@
+class OwnerSettings < Settings
+  @@__owner_settings, @@__owner_db_settings, @@__owner_temp_settings, @@__owner_loaded, @@__owner_default_settings  = {}, {}, {}, {}, {}
+  
+  class << self
+    def get_settings(owner, defaults)
+      @owner = owner
+      @@__owner_settings[owner_symbol] ||= {}
+      @@__owner_db_settings[owner_symbol] ||= {}
+      @@__owner_temp_settings[owner_symbol] ||= {}
+      @@__owner_default_settings[owner_type_symbol] ||= ( defaults || {} )
+      if @@__owner_loaded[owner_symbol].nil?
+        reload!
+        @@__owner_loaded[owner_symbol] = true
+      end
+      self
+    end
+    
+    def to_hash
+      @@__owner_default_settings[owner_type_symbol].merge(__settings)
+    end
+    
+    def target_id
+      @owner.id
+    end
+    
+    def target_type
+      @owner.class.base_class.to_s
+    end
+    
+    def owner_type_symbol
+      target_type.downcase.to_sym
+    end
+    
+    def owner_symbol
+      "#{target_type}_#{target_id}".downcase.to_sym
+    end
+    
+    def reload!
+      super
+      __settings
+    end
+    
+    def __settings
+      @@__owner_settings[owner_symbol]
+    end
+    
+    def __settings=(value)
+      @@__owner_settings[owner_symbol] = value
+    end
+
+    def __file_settings
+      {}
+    end
+    
+    def __file_settings=(value)
+      {}
+    end
+
+    def __db_settings
+      @@__owner_db_settings[owner_symbol]
+    end
+    
+    def __db_settings=(value)
+      @@__owner_db_settings[owner_symbol] = value
+    end
+
+    def __temp_settings
+      @@__owner_temp_settings[owner_symbol]
+    end
+    
+    def __temp_settings=(value)
+      @@__owner_temp_settings[owner_symbol] = value
+    end
+    
+    protected
+    
+    def __hook_for_load_owner_default_settings(key)
+      @@__owner_default_settings[owner_type_symbol][key]
+    end
+    
+    def __hook_for_delete_owner_default_settings(key, value)
+      value == @@__owner_default_settings[owner_type_symbol][key]
+    end
+  end
+end

data/lib/real_settings/relations.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Base.class_eval do
+  def self.has_settings(*args)
+    cattr_accessor :__default_settings_options
+    self.__default_settings_options = args.extract_options![:defaults]
+    
+    class_eval do
+      def settings
+        OwnerSettings.get_settings(self, __default_settings_options)
+      end
+      
+      after_destroy { |owner| owner.settings.target_settings.each { |s| s.destroy } }
+    end
+  end
+end

data/lib/real_settings/settings.rb

@@ -0,0 +1,103 @@
+class Settings < ActiveRecord::Base
+  attr_accessible :key, :value, :target_id, :target_type
+  @@__settings, @@__file_settings, @@__db_settings, @@__temp_settings = {}, {}, {}, {}
+  cattr_accessor :__settings, :__file_settings, :__db_settings, :__temp_settings
+  
+  class << self
+    def config
+      yield self
+      self.__file_settings = __temp_settings
+      reload!
+    end
+    
+    def to_hash
+      __settings
+    end
+    
+    def update_attributes(attributes)
+      if attributes.nil?
+        false
+      else
+        attributes.each { |key, value| send("#{key}=", value) }
+        save!
+      end
+    end
+    
+    def reload!
+      self.__temp_settings = {}
+      load!
+    end
+    
+    def save!
+      __file_settings.each { |key, value| __settings.delete(key) }
+      __settings.delete_if { |key, value| value == __db_settings[key] || __hook_for_delete_owner_default_settings(key, value) }
+      __settings.each do |key, value|
+        if __db_settings.has_key?(key)
+          where(:key => key).first.update_attribute(:value, value)
+        else
+          create!(:key => key, :value => value, :target_id => target_id, :target_type => target_type)
+        end
+      end
+      __db_settings.merge!(__settings)
+      __temp_settings = {}
+      calculate_settings
+    end
+    
+    def target_id
+      nil
+    end
+    
+    def target_type
+      nil
+    end
+    
+    def target_settings
+      where(:target_type => target_type).where(:target_id => target_id)
+    end
+    
+    def method_missing(name, *args)
+      if self.respond_to?(name)
+        super(name, args)
+      else
+        if name =~ /\w+=$/
+          __temp_settings[name.to_s.downcase.gsub('=', '').to_sym] = args.first
+          __settings[name.to_s.downcase.gsub('=', '').to_sym] = args.first
+        elsif name =~ /\w+/
+          __settings[name.to_s.downcase.to_sym] || __hook_for_load_owner_default_settings(name.to_s.downcase.to_sym)
+        else
+          raise NoMethodError
+        end
+      end
+    end
+    
+    protected
+    
+    def __hook_for_load_owner_default_settings(key)
+      nil
+    end
+    
+    def __hook_for_delete_owner_default_settings(key, value)
+      false
+    end
+    
+    private
+    
+    def load!
+      load_from_database!
+      calculate_settings
+    end
+    
+    def calculate_settings # load settings priority is file > database > temp
+      self.__settings = self.__temp_settings.merge(self.__db_settings).merge(self.__file_settings)
+    end
+    
+    def load_from_database!
+      begin
+        __db_settings = {}
+        where(:target_type => target_type, :target_id => target_id).order(:key).all.each { |s| self.__db_settings[s.key.to_sym] = s.value }
+      rescue
+        __db_settings = {}
+      end
+    end
+  end
+end

data/lib/real_settings/version.rb

@@ -0,0 +1,3 @@
+module RealSettings
+  VERSION = "0.0.1"
+end

data/lib/real_settings.rb

@@ -0,0 +1,4 @@
+require 'real_settings/version'
+require 'real_settings/settings'
+require 'real_settings/owner_settings'
+require 'real_settings/relations'

data/real_settings.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/real_settings/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Macrow"]
+  gem.email         = ["Macrow_wh@163.com"]
+  gem.description   = %q{A real settings tool for Rails3}
+  gem.summary       = %q{A real settings tool for Rails3}
+  gem.homepage      = ""
+
+  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.name          = "real_settings"
+  gem.require_paths = ["lib"]
+  gem.version       = RealSettings::VERSION
+end

data/spec/real_settings_spec.rb

@@ -0,0 +1,150 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "RealSettings" do
+  setup_db
+
+  before(:each) do
+    @app_name = "real_settings"
+    @app_url = "http://github.real_settings.com"
+    Settings.config do |settings|
+      settings.app_name = @app_name
+      settings.app_url = @app_url
+    end
+    @user1 = User.create!(:name => 'admin1')
+    @user2 = User.create!(:name => 'admin2')
+  end
+  
+  it "load default settings from config file" do
+    Settings.app_name.should == @app_name
+    Settings.app_url.should == @app_url
+  end
+  
+  it "load settings priority is file > database > temp" do
+    Settings.create(:key => 'app_name', :value => 'name from database')
+    Settings.create(:key => 'app_url', :value => 'url from database')
+    Settings.reload!
+    Settings.app_name.should == @app_name
+    Settings.app_url.should == @app_url
+    
+    Settings.app_name = 'new name'
+    Settings.app_name.should == 'new name'
+    Settings.reload!
+    Settings.app_name.should == @app_name
+    
+  end
+  
+  it "load default settings from database" do
+    Settings.create(:key => 'another_name', :value => 'name from database')
+    Settings.create(:key => 'another_url', :value => 'url from database')
+    Settings.reload!
+    Settings.another_name.should == 'name from database'
+    Settings.another_url.should == 'url from database'
+  end
+  
+  it "reload feature" do
+    Settings.new_name.should == nil
+    Settings.new_name = 'new name'
+    Settings.new_name.should == 'new name'
+    Settings.reload!
+    Settings.new_name.should == nil    
+  end
+  
+  it "save settings into database" do
+    Settings.new_name.should == nil
+    Settings.new_name = 'new name'
+    Settings.save!
+    Settings.new_name.should == 'new name'
+    Settings.reload!
+    Settings.new_name.should == 'new name'
+    
+    Settings.create(:key => 'another_name', :value => 'name from database')
+    Settings.another_name = 'new name'
+    Settings.save!
+    Settings.another_name.should == 'new name'
+  end
+  
+  it "has_settings without default values" do
+    @account1 = Account.create!(:name => 'account1')
+    @account1.settings.to_hash.should == {}
+  end
+  
+  it "user has settings different with global settings" do
+    @user1.settings.editor = 'textmate'
+    @user1.settings.editor.should == 'textmate'
+    @user1.settings.reload!
+    @user1.settings.editor.should == nil
+    @user1.settings.editor = 'textmate'
+    @user1.settings.save!
+    @user1.settings.reload!
+    @user1.settings.editor.should == 'textmate'
+    
+    Settings.editor.should == nil
+  end
+  
+  it "user has same settings with global settings" do
+    @user1.settings.app_name.should == nil
+    @user1.settings.app_name = 'app name for user'
+    @user1.settings.save!
+    @user1.settings.app_name.should == 'app name for user'
+    Settings.app_name.should == @app_name
+  end
+  
+  it "diferent users have same settings" do
+    @user1.settings.editor = 'textmate'
+    @user2.settings.editor = 'vim'
+    @user1.settings.editor.should == 'textmate'
+    @user2.settings.editor.should == 'vim'
+    @user1.settings.reload!
+    @user2.settings.reload!
+    @user1.settings.editor.should == nil
+    @user2.settings.editor.should == nil
+    
+    @user1.settings.editor = 'textmate'
+    @user2.settings.editor = 'vim'
+    @user1.settings.save!
+    @user2.settings.save!
+    @user1.settings.editor.should == 'textmate'
+    @user2.settings.editor.should == 'vim'
+  end
+  
+  it "diferent users have different settings" do
+    @user1.settings.editor = 'textmate'    
+    @user2.settings.editor.should == nil
+    @user1.settings.save!
+    @user2.settings.editor.should == nil
+  end
+  
+  it "user has default settings" do
+    # has_settings :defaults => { :notebook => 'Macbook Pro', :mobile => 'iPhone 4' }
+    @user1.settings.to_hash[:notebook].should == 'Macbook Pro'
+    @user1.settings.to_hash[:mobile].should == 'iPhone 4'    
+    @user1.settings.notebook.should == 'Macbook Pro'
+    @user1.settings.mobile.should == 'iPhone 4'
+    @user1.settings.notebook = 'Macbook Air'
+    @user1.settings.mobile = 'iPhone 4S'
+    @user1.settings.notebook.should == 'Macbook Air'
+    @user1.settings.mobile.should == 'iPhone 4S'    
+    @user1.settings.reload!
+    @user1.settings.notebook.should == 'Macbook Pro'
+    @user1.settings.mobile.should == 'iPhone 4'
+
+    @user1.settings.notebook = 'Macbook Air'
+    @user1.settings.mobile = 'iPhone 4S'
+    @user1.settings.save!
+    @user1.settings.notebook.should == 'Macbook Air'
+    @user1.settings.mobile.should == 'iPhone 4S'
+    @user1.settings.reload!
+    @user1.settings.notebook.should == 'Macbook Air'
+    @user1.settings.mobile.should == 'iPhone 4S'
+    
+    @user2.settings.notebook.should == 'Macbook Pro'
+    @user2.settings.mobile.should == 'iPhone 4'
+  end
+  
+  it "be sure destroy settings after destroy user" do
+    @user1.settings.new_feature = "new setting for user"
+    @user1.settings.save!
+    @user1.destroy
+    Settings.where(:key => 'new_feature').all.should be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'rspec'
+require 'active_record'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'real_settings')
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Migration.verbose = false
+
+class User < ActiveRecord::Base
+  has_settings :defaults => { :notebook => 'Macbook Pro', :mobile => 'iPhone 4' }
+end
+
+class Account < ActiveRecord::Base
+  has_settings
+end
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :settings do |t|
+      t.string :key, :null => false
+      t.text   :value, :null => true
+      t.integer :target_id, :null => true
+      t.string :target_type, :null => true
+      t.timestamps
+    end
+    add_index :settings, [ :target_type, :target_id, :key ], :unique => true
+    
+    create_table :users do |t|
+      t.string :name
+    end
+    
+    create_table :accounts do |t|
+      t.string :name
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: real_settings
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Macrow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-08 00:00:00.000000000 Z
+dependencies: []
+description: A real settings tool for Rails3
+email:
+- Macrow_wh@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/real_settings/.DS_Store
+- lib/generators/real_settings/USAGE
+- lib/generators/real_settings/install/.DS_Store
+- lib/generators/real_settings/install/install_generator.rb
+- lib/generators/real_settings/install/templates/migration.rb
+- lib/generators/real_settings/install/templates/real_settings.rb
+- lib/real_settings.rb
+- lib/real_settings/owner_settings.rb
+- lib/real_settings/relations.rb
+- lib/real_settings/settings.rb
+- lib/real_settings/version.rb
+- real_settings.gemspec
+- spec/real_settings_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.8.24
+signing_key: 
+specification_version: 3
+summary: A real settings tool for Rails3
+test_files:
+- spec/real_settings_spec.rb
+- spec/spec_helper.rb