druthers 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGM1OGQ0ZTM1OTliNWUwYmY3NDMxNWRkN2Q5NTRmNTRmYTJhMDNkMA==
+  data.tar.gz: !binary |-
+    YmMyNWQ3Mjc0YzBiMTUzNGFjZDdlYTljODdhODA3MTI1ZDZhYTZjMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MmJmNjJiMGY4NTI2MzlkNmQzMTg1NGFlYjgwMTEzYWI3MTI3YjdhN2RhOTdj
+    ZjdlN2ZjNjRhZDQyY2M1Yjk4MThhY2U5YzUxZGMxMzY1NGEwMmJkOTE2YmU4
+    NDhiM2ZlZmNjNzllMzQwY2FkYmMwNDMwMjEzYmExNTNlOGYyNGM=
+  data.tar.gz: !binary |-
+    M2YyMTcwNmY0YWUyM2QxNGI4M2UyODExMDViNjM0ZDM2ZjA3Mzc5ZDc3Nzdi
+    MWQ4NThiYzFiOWJiZjllNDg2NWU5OTZmZmVjMjZlZjJlY2M2MTdjOGQyOTgw
+    ZmY5YTIyMGI2YzVmY2VkMmJjZDQ3MTZhODY2ZTM5YTU4YzljZmE=

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 1.9.3
+
+gemfile:
+  - ci/Gemfile.rails-4.0.x
+  - ci/Gemfile.rails-3.2.x
+
+env:
+  - DB=sqlite
+  - DB=mysql
+  - DB=postgresql
+
+script: bundle exec rake --trace
+
+before_script:
+  - mysql -e 'create database druthers_test'
+  - psql -c 'create database druthers_test' -U postgres

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## v0.0.1
+
+First Post!

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in druthers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matthew McEachen
+
+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,123 @@
+# Druthers
+
+[![Build Status](https://api.travis-ci.org/mceachen/druthers.png?branch=master)](https://travis-ci.org/mceachen/druthers)
+[![Gem Version](https://badge.fury.io/rb/druthers.png)](http://rubygems.org/gems/druthers)
+[![Code Climate](https://codeclimate.com/github/mceachen/druthers.png)](https://codeclimate.com/github/mceachen/druthers)
+
+```Druthers``` is the simplest performant solution to storing application-specific settings via
+ActiveRecord.
+
+When you use an off-the-shelf Rails application, frequently you'll need to store
+configuration information specific to your installation.
+
+If you store that information in a flat file, and you subsequently upgrade the rails application,
+you'll need to make sure your settings don't get overwritten. If you're running multiple servers,
+you'll need to store those settings in a shared datastore. If you're already using ActiveRecord,
+we might as well use ActiveRecord to store this.
+
+Druthers is a simple enhancement to a key/value model that adds caching and the ability to override
+behavior for specific settings.
+
+As opposed to ```rails-settings``` and forks, ```method_missing``` isn't used anywhere. *HURRAY!*
+
+## Supported versions
+
+The latest versions of
+* Rails 3.2 & 4.0
+* Ruby 1.9.3 & 2.0.0
+* SQLite, MySQL, and PostgreSQL
+
+Every valid combination is [tested via Travis](https://travis-ci.org/mceachen/druthers).
+
+## Usage
+
+Assuming your configuration is stored via a ```Setting``` model:
+
+```ruby
+class Setting < ActiveRecord::Base
+
+  # Add class-level getter/setters for your settings:
+  def_druthers :quest, :favourite_colour
+
+  # This is not required, but allows for more than just string values:
+  serialize :value
+
+  # This will be used as the value of `Setting.quest` if it is not set.
+  def default_quest
+    "to find the holy grail"
+  end
+
+  # This validation will be only run for instances whose key == "favourite_color":
+  def validate_favourite_colour
+    add_error("we're right out of teal, sorry") if value == "teal"
+  end
+end
+```
+
+You can get values:
+
+```ruby
+Setting.quest
+=> "to find the holy grail" # <- because we defined default_quest above
+
+Setting.favourite_color
+=> nil # <- no default
+```
+
+You can set values:
+
+```ruby
+Setting.favourite_color = "red"
+```
+
+If you want to store more than just strings, use
+[serialize](http://apidock.com/rails/ActiveRecord/AttributeMethods/Serialization/ClassMethods/serialize),
+which is in the above example, and is not required.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'druthers'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Add a model:
+
+```
+rails g model Setting key:string value:text
+```
+
+Edit the resulting migration to add an index. Here's a complete example:
+
+```ruby
+class CreateSettings < ActiveRecord::Migration
+  def change
+    create_table :settings do |t|
+      t.string :key
+      t.text :value
+      t.timestamps
+    end
+    add_index :settings, [:key], :unique => true, :name => 'key_udx'
+  end
+end
+```
+
+Finally, edit your model, adding ```has_druthers``` and the appropriate defaults and validations.
+See the Usage section above for more details.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add tests and code
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', 'README.md']
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.libs.push "test"
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/ci/Gemfile.rails-3.2.x

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec :path => '..'
+
+gem 'activerecord', '~> 3.2.0'

data/ci/Gemfile.rails-4.0.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec :path => '..'
+
+# rspec-rails reverts to 2.3.1 (old and broken) unless you fetch the whole rails enchilada:
+gem 'rails', '~> 4.0.0'

data/druthers.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'druthers/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'druthers'
+  spec.version = Druthers::VERSION
+  spec.authors = ["Matthew McEachen"]
+  spec.email = ["matthew+github@mceachen.org"]
+  spec.description = %q{Simple, performant settings for your Rails application}
+  spec.summary = ''
+  spec.homepage = 'https://github.com/mceachen/druthers'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.add_dependency 'activerecord', '>= 3.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'mysql2'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'minitest-great_expectations'
+  spec.add_development_dependency 'minitest-reporters' unless ENV['CI']
+end

data/lib/druthers/def.rb

@@ -0,0 +1,21 @@
+require 'druthers/support'
+
+module Druthers
+  VALID_METHOD_NAME = /\A\w+\z/
+  module Def
+    def def_druthers(*keys)
+      include Support
+      keys.each do |ea|
+        fail "setting keys must be alphanumeric" unless ea.to_s =~ Druthers::VALID_METHOD_NAME
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def self.#{ea}=(value)
+            self.set_druther(:#{ea}, value)
+          end
+          def self.#{ea}
+            get_druther(:#{ea})
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/druthers/support.rb

@@ -0,0 +1,51 @@
+require 'active_support/concern'
+module Druthers
+  module Support
+    extend ActiveSupport::Concern
+
+    included do
+      validate :validate_druthers
+    end
+
+    def validate_druthers
+      sym = "validate_#{key}".to_sym
+      send(sym) if respond_to?(sym)
+    end
+
+    module ClassMethods
+      # This can be overridden by the consumer
+      def druthers_cache
+        @druthers_cache ||= ActiveSupport::Cache::MemoryStore.new(expires_in: 10.minutes)
+      end
+
+      # Directly access the setting with the given key name.
+      # Note that overriding this method shouldn't be done directly.
+      # Use one of the event methods instead.
+      def get_druther(key)
+        druthers_cache.fetch(key) do
+          val = where(key: key).pluck(:value).to_a
+          val.present? ? val.first : send_druthers_event(:default, key)
+        end
+      end
+
+      def set_druther(key, value)
+        obj = where(key: key).first_or_initialize
+        if obj.respond_to? :update!
+          # Rails 4.x:
+          obj.update!(value: value)
+        else
+          # Rails 3.x:
+          obj.update_attributes!(value: value)
+        end
+        # Only update the cache if the update! succeeded:
+        druthers_cache.write(key, value)
+        obj
+      end
+
+      def send_druthers_event(event_name, key)
+        sym = "#{event_name}_#{key}".to_sym
+        send(sym) if respond_to?(sym)
+      end
+    end
+  end
+end

data/lib/druthers/version.rb

@@ -0,0 +1,3 @@
+module Druthers
+  VERSION = Gem::Version.new("0.0.1")
+end

data/lib/druthers.rb

@@ -0,0 +1,7 @@
+require 'active_support'
+require 'active_record'
+
+ActiveSupport.on_load :active_record do
+  require 'druthers/def'
+  ActiveRecord::Base.send :extend, Druthers::Def
+end

data/test/database.yml

@@ -0,0 +1,17 @@
+sqlite:
+  adapter: <%= "jdbc" if defined? JRUBY_VERSION %>sqlite3
+  database: test/sqlite.db
+  timeout: 500
+  pool: 50
+postgresql:
+  adapter: postgresql
+  username: postgres
+  database: druthers_test
+  min_messages: ERROR
+  pool: 50
+mysql:
+  adapter: mysql2
+  host: localhost
+  username: root
+  database: druthers_test
+  pool: 50

data/test/minitest_helper.rb

@@ -0,0 +1,21 @@
+require 'erb'
+require 'active_record'
+require 'druthers'
+require 'tmpdir'
+
+db_config = File.expand_path("database.yml", File.dirname(__FILE__))
+ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(db_config)).result)
+
+def env_db
+  ENV["DB"] || "mysql"
+end
+
+ActiveRecord::Base.establish_connection(env_db)
+ActiveRecord::Migration.verbose = false
+
+require 'test_models'
+require 'minitest/autorun'
+require 'minitest/great_expectations'
+require 'minitest/reporters' unless ENV['CI']
+
+Thread.abort_on_exception = true

data/test/setting_test.rb

@@ -0,0 +1,56 @@
+require 'minitest_helper'
+
+describe Setting do
+  before :each do
+    Setting.delete_all
+  end
+
+  describe 'validations' do
+    def assert_saved_and_valid(key)
+      Setting.where(key: key).first.valid?.must_be_true
+    end
+
+    it 'works on defined settings without a validation' do
+      Setting.quest = 'to eat bacon in moderation'
+      assert_saved_and_valid('quest')
+    end
+
+    it 'works on defined settings with a validation' do
+      Setting.favourite_colour = 'green'
+      assert_saved_and_valid('favourite_colour')
+    end
+
+    it 'raises validation errors correctly' do
+      proc { Setting.favourite_colour = 'invalid' }.
+        must_raise ActiveRecord::RecordInvalid
+    end
+
+    it 'allows unknown settings' do
+      Setting.create do |ea|
+        ea.key = 'airspeed'
+      end.valid?.must_be_true
+    end
+  end
+
+  describe 'defaults' do
+    it 'returns proper defaults' do
+      Setting.quest.must_equal 'to find the holy grail'
+      Setting.favourite_colour.must_be_nil
+      Setting.things.must_equal [1, 2, 3]
+    end
+  end
+
+  describe 'serialized persistence' do
+    it "works with arrays" do
+      a = [3, 4, 5]
+      Setting.things = a
+      Setting.where(key: 'things').first.value.must_equal a
+    end
+
+    it "works with hashes" do
+      h = {hello: 'world'}
+      Setting.hashish = h
+      Setting.where(key: 'hashish').first.value.must_equal h
+    end
+  end
+end

data/test/test_models.rb

@@ -0,0 +1,25 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :settings, :force => true do |t|
+    t.string :key
+    t.text :value
+    t.timestamps
+  end
+  add_index :settings, [:key], :unique => true, :name => 'key_udx'
+end
+
+class Setting < ActiveRecord::Base
+  def_druthers :quest, :favourite_colour, :things, :hashish
+  serialize :value
+
+  def self.default_quest
+    "to find the holy grail"
+  end
+
+  def self.default_things
+    [1, 2, 3]
+  end
+
+  def validate_favourite_colour
+    errors.add(:value, "invalid is invalid WERD") if value == "invalid"
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: druthers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew McEachen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-great_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple, performant settings for your Rails application
+email:
+- matthew+github@mceachen.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ci/Gemfile.rails-3.2.x
+- ci/Gemfile.rails-4.0.x
+- druthers.gemspec
+- lib/druthers.rb
+- lib/druthers/def.rb
+- lib/druthers/support.rb
+- lib/druthers/version.rb
+- test/database.yml
+- test/minitest_helper.rb
+- test/setting_test.rb
+- test/test_models.rb
+homepage: https://github.com/mceachen/druthers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- test/database.yml
+- test/minitest_helper.rb
+- test/setting_test.rb
+- test/test_models.rb
+has_rdoc: