has_settings 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+test/log/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Morten Primdahl
+
+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,17 @@
+= has_settings
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Morten Primdahl. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "has_settings"
+    gem.summary = %Q{Per row settings for ActiveRecord}
+    gem.description = %Q{This gem is an ActiveRecord extension which provides a convenient interface for managing per row settings}
+    gem.email = "morten@zendesk.com"
+    gem.homepage = "http://github.com/morten/has_settings"
+    gem.authors = ["Morten Primdahl"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "has_settings #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/has_settings.gemspec

@@ -0,0 +1,62 @@
+# 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{has_settings}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Morten Primdahl"]
+  s.date = %q{2010-11-04}
+  s.description = %q{This gem is an ActiveRecord extension which provides a convenient interface for managing per row settings}
+  s.email = %q{morten@zendesk.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "has_settings.gemspec",
+     "lib/has_settings.rb",
+     "lib/has_settings/active_record_extension.rb",
+     "lib/has_settings/has_settings_helper.rb",
+     "lib/has_settings/setting.rb",
+     "test/database.yml",
+     "test/fixtures/account_settings.yml",
+     "test/fixtures/accounts.yml",
+     "test/helper.rb",
+     "test/schema.rb",
+     "test/test_has_settings.rb"
+  ]
+  s.homepage = %q{http://github.com/morten/has_settings}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Per row settings for ActiveRecord}
+  s.test_files = [
+    "test/helper.rb",
+     "test/schema.rb",
+     "test/test_has_settings.rb"
+  ]
+
+  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_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/has_settings.rb

@@ -0,0 +1,14 @@
+require 'has_settings/setting'
+require 'has_settings/active_record_extension'
+require 'has_settings/has_settings_helper'
+
+module HasSettings
+  def self.ensure_settings_class(owner_class)
+    const_name = "#{owner_class.name}Settings".to_sym
+    unless Object.const_defined?(const_name)
+      settings_class = Object.const_set(const_name, Class.new(HasSettings::Setting))
+      settings_class.owner_class = owner_class
+    end
+    Object.const_get(const_name)
+  end
+end

data/lib/has_settings/active_record_extension.rb

@@ -0,0 +1,88 @@
+module HasSettings
+  module ActiveRecordExtension
+    module ClassMethods
+      def has_settings(&block)
+        settings_class = HasSettings.ensure_settings_class(self)
+        settings_class.instance_eval(&block)
+
+        has_many :settings, :class_name => settings_class.name, :dependent => :destroy do
+          moo = settings_class
+          def build(*setting_names)
+            setting_names.each do |setting_name|
+              self << settings_class.new(:name => setting_name)
+            end
+          end
+
+          # Define the settings query methods, e.g. +account.settings.wiffle?+
+          settings_class.list.each do |key|
+            # The query method, does this account have a given setting? account.settings.wiffle?
+            define_method "#{key}?" do
+              any? { |setting| setting.name.to_sym == key }
+            end
+
+            # The finder method which returns the setting if present, otherwise a new instance, allows
+            # non-destructive create and delete operations:
+            #
+            #   account.settings.wiffle.destroy
+            #   account.settings.wiffle.create
+            #
+            define_method "#{key}" do
+              instance = detect { |setting| setting.name.to_sym == key }
+              instance ||= settings_class.new(@owner.class.name.underscore.to_sym => @owner, :name => key.to_s)
+            end
+          end
+        end
+
+        include HasSettings::ActiveRecordExtension::InstanceMethods
+        alias_method_chain :update_attributes, :settings
+        alias_method_chain :update_attributes!, :settings
+
+      end
+    end
+
+    module InstanceMethods
+      # Allows you to check for multiple features like account.settings?(:suggestions, :suggestions_on_web)
+      def settings?(*setting_names)
+        setting_names.all? { |setting_name| settings.send("#{setting_name}?") }
+      end
+
+      def update_attributes_with_settings(attributes)
+        update_settings_attributes(attributes)
+        update_attributes_without_settings(attributes)
+      end
+
+      def update_attributes_with_settings!(attributes)
+        update_settings_attributes(attributes)
+        update_attributes_without_settings!(attributes)
+      end
+
+      private
+
+        def update_settings_attributes(attributes)
+          if attributes && settings_attributes = attributes.delete(:settings)
+            settings_attributes.each do |setting_name, value|
+              setting = settings.send(setting_name)
+              if setting.protected?
+                logger.warn("Someone tried to mass update the protected #{setting_name} setting")
+              else
+                if value == '1' || value == true
+                  setting.create
+                else
+                  setting.destroy
+                end
+              end
+            end
+            settings.reset
+          end
+        end
+    end
+
+    def self.included(receiver)
+      receiver.extend(ClassMethods)
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include HasSettings::ActiveRecordExtension
+end

data/lib/has_settings/has_settings_helper.rb

@@ -0,0 +1,18 @@
+module ActionView
+  module Helpers
+    def setting_check_box(model_name, method, options = {}, checked_value = "1", unchecked_value = "0")
+      the_model = @template.instance_variable_get("@#{model_name}")
+      throw "setting_check_box only work on models with settings" unless the_model.respond_to?(:settings)
+      options[:checked] = the_model.settings.send("#{method}?")
+      options[:id]    ||= "#{model_name}_settings_#{method}"
+      options[:name]    = "#{model_name}[settings][#{method}]"
+      @template.check_box(model_name, "settings_#{method}", options, checked_value, unchecked_value)
+    end
+
+    class FormBuilder
+      def setting_check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
+        @template.setting_check_box(@object_name, method, objectify_options(options), checked_value, unchecked_value)
+      end
+    end
+  end
+end

data/lib/has_settings/setting.rb

@@ -0,0 +1,71 @@
+module HasSettings
+  class Setting < ActiveRecord::Base
+    abstract_class = true
+
+    after_create   :reset_owner_association
+    after_destroy  :reset_owner_association
+
+    def create
+      if new_record?
+        super
+      end
+      self
+    end
+
+    def self.setting(key, options = nil)
+      @settings ||= {}
+      @settings[key] = options && options[:protected]
+    end
+
+    def self.list
+      @settings.keys
+    end
+
+    def self.table_name
+      name.tableize
+    end
+
+    def self.protected?(key)
+      @settings[key]
+    end
+
+    def protected?
+      self.class.protected?(self.name.to_sym)
+    end
+
+    private
+
+    def owner_class_instance
+      send(self.class.owner_class_sym)
+    end
+
+    def update_owner_timestamp
+      owner_class_instance.update_attribute(:updated_at, Time.now) if owner_class_instance && !owner_class_instance.new_record?
+    end
+
+    def reset_owner_association
+      owner_class_instance.settings.reload
+    end
+
+    def self.owner_class=(owner_class)
+      @owner_class_sym = owner_class.name.underscore.to_sym
+      belongs_to              owner_class_sym
+      validates_presence_of   owner_class_sym
+      validates_uniqueness_of :type, :scope => owner_class_key_sym
+
+      if owner_class.table_exists? && owner_class.column_names.include?('updated_at')
+        before_create   :update_owner_timestamp
+        before_destroy  :update_owner_timestamp
+      end
+    end
+
+    def self.owner_class_sym
+      @owner_class_sym
+    end
+
+    def self.owner_class_key_sym
+      "#{owner_class_sym}_id".to_sym
+    end
+  end
+
+end

data/test/database.yml

@@ -0,0 +1,7 @@
+test:
+  adapter: mysql
+  encoding: utf8
+  database: has_settings_test
+  username: root
+  password:
+  socket: /tmp/mysql.sock

data/test/fixtures/account_settings.yml

@@ -0,0 +1,7 @@
+account1_archive:
+  account_id: 1
+  name: archive
+
+account1_ssl:
+  account_id: 1
+  name: ssl

data/test/fixtures/accounts.yml

@@ -0,0 +1,3 @@
+account1:
+  name: My Account
+  id: 1

data/test/helper.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require 'active_record'
+require 'active_record/fixtures'
+require 'shoulda'
+
+ActiveRecord::Base.configurations = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.establish_connection('test')
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/log/test.log")
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'has_settings'
+ 
+class ActiveSupport::TestCase
+  include ActiveRecord::TestFixtures
+
+  def create_fixtures(*table_names)
+    if block_given?
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names) { yield }
+    else
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names)
+    end
+  end
+
+  self.use_transactional_fixtures = true
+  self.use_instantiated_fixtures  = false
+end
+
+ActiveSupport::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+$LOAD_PATH.unshift(ActiveSupport::TestCase.fixture_path)

data/test/schema.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table "account_settings", :force => true do |t|
+    t.string   "name"
+    t.integer  "account_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "accounts", :force => true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/test/test_has_settings.rb

@@ -0,0 +1,73 @@
+require 'helper'
+
+class Account < ActiveRecord::Base
+  has_settings do
+    setting :archive_reports
+    setting :ssl, :protected => true
+    setting :archive
+    setting :reports
+  end
+end
+
+class TestHasSettings < ActiveSupport::TestCase
+  context "settings" do
+    fixtures :accounts, :account_settings
+    
+    should "be accessable from the owner association" do
+      a = Account.create(:name => 'name')
+      assert a.settings.empty?
+      assert !a.settings.archive?
+      assert a.settings.archive.create
+      assert a.settings.size == 1
+      assert a.settings.archive?
+      assert a.settings.archive.id == a.settings.archive.create.id
+    end
+    
+    should "be destroyable via the association" do
+      a = accounts(:account1)
+      assert a.settings.archive?
+      assert a.settings.archive.destroy
+      a.settings.reload
+      assert !a.settings.archive?
+    end
+    
+    should "have convenience methods for checking presence" do
+      a = accounts(:account1)
+      assert a.settings.archive?
+      assert a.settings.ssl?
+      assert !a.settings.reports?
+    end
+    
+    should "support mass updates" do
+      a = Account.create(:name => 'name')
+      assert a.settings.empty?
+      assert !a.settings.archive?
+      assert !a.settings.reports?
+
+      a.update_attributes(:settings => { :archive => '1', :reports => '1' })
+      assert a.settings.archive?
+      assert a.settings.reports?
+
+      a.update_attributes(:settings => { :archive => '0', :reports => '0' })
+      assert !a.settings.archive?
+      assert !a.settings.reports?
+    end
+    
+    should "support protecting certain settings from mass updates" do
+      a = Account.create(:name => 'name')
+      assert a.settings.empty?
+      assert !a.settings.archive?
+      assert !a.settings.ssl?
+
+      a.update_attributes(:settings => {:archive => '1', :ssl => '1'})
+      assert a.settings.archive?
+      assert !a.settings.ssl?
+
+      assert a.settings.ssl.create
+      assert a.settings.ssl?
+      a.update_attributes(:settings => {:archive => '0', :ssl => '0'})
+      assert !a.settings.archive?
+      assert a.settings.ssl?
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: has_settings
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Morten Primdahl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-04 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  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
+description: This gem is an ActiveRecord extension which provides a convenient interface for managing per row settings
+email: morten@zendesk.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- has_settings.gemspec
+- lib/has_settings.rb
+- lib/has_settings/active_record_extension.rb
+- lib/has_settings/has_settings_helper.rb
+- lib/has_settings/setting.rb
+- test/database.yml
+- test/fixtures/account_settings.yml
+- test/fixtures/accounts.yml
+- test/helper.rb
+- test/schema.rb
+- test/test_has_settings.rb
+has_rdoc: true
+homepage: http://github.com/morten/has_settings
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Per row settings for ActiveRecord
+test_files: 
+- test/helper.rb
+- test/schema.rb
+- test/test_has_settings.rb