persistent_settings 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - rbx
+  - 1.8.7

data/Gemfile

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

data/README.md

@@ -0,0 +1,30 @@
+# Persistent Settings
+
+A simple key value store for ActiveRecord based applications.
+
+Best used to store global app settings.
+
+## Installation
+
+Add it to your Gemfile
+
+    gem 'persistent_settings'
+
+Install
+
+    bundle install
+
+## Usage
+
+The gem adds a new class called Settings. It will automatically create new
+keys as you assign a value to them.
+
+    Settings.a_key = 'value'
+
+Reload your app:
+
+    Settings.a_key # => 'value'
+
+It accepts all kinds of objects as the value
+
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "cucumber/rake/task"
+
+RSpec::Core::RakeTask.new
+Cucumber::Rake::Task.new
+
+task :default => [ :spec, :cucumber ]

data/features/settings.feature

@@ -0,0 +1,6 @@
+Feature: Settings class
+
+  Scenario: Assign a new global setting
+    Given I assign "'a value'" to "a_key"
+    Then Settings should respond to "a_key"
+    Then "a_key" should hold "a value"

data/features/step_definitions/settings_steps.rb

@@ -0,0 +1,11 @@
+Given /^I assign "([^"]*)" to "([^"]*)"$/ do |value, key|
+  eval "Settings.#{key} = #{value}"
+end
+
+Then /^Settings should respond to "([^"]*)"$/ do |key|
+  Settings.should respond_to(key)
+end
+
+Then /^"([^"]*)" should hold "([^"]*)"$/ do |key, value|
+  Settings.send(key).should eq(value)
+end

data/features/support/env.rb

@@ -0,0 +1,9 @@
+require 'persistent_settings'
+
+::ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+::ActiveRecord::Schema.define(:version => 1) do
+  create_table :settings do |t|
+    t.column :var, :string
+    t.column :value, :string
+  end
+end

data/lib/persistent_settings.rb

@@ -0,0 +1,3 @@
+require "active_record"
+require "settings"
+require "settings/version"

data/lib/settings/version.rb

@@ -0,0 +1,3 @@
+class Settings < ActiveRecord::Base
+  VERSION = "1.0.0"
+end

data/lib/settings.rb

@@ -0,0 +1,48 @@
+class Settings < ActiveRecord::Base
+  serialize :value
+
+  def self.method_missing(method_name, *args)
+    if assignation?(method_name)
+      self.define_setter_and_getter(method_name)
+      self.send(method_name, args.first)
+    else
+      super
+    end
+  end
+
+  def self.define_setter_and_getter(method_name)
+    getter = method_name.to_s.chop
+
+    (class << self; self; end).instance_eval do
+      define_method method_name do |value|
+        persist(getter, value)
+        instance_variable_set(:"@#{getter}", value)
+      end
+
+      define_method getter do
+        instance_variable_get(:"@#{getter}")
+      end
+    end
+  end
+
+  def self.assignation?(method_name)
+    method_name.to_s.match(/=$/)
+  end
+
+  def self.persist(getter, value)
+    setting = Settings.where(:var => getter).last
+    if setting
+      setting.update_attribute(:value, value)
+    else
+      Settings.create(:var => getter, :value => value)
+    end
+  end
+
+  def self.load_from_persistance
+    self.all.each do |setting|
+      self.send("#{setting.var}=", setting.value)
+    end
+  end
+
+  load_from_persistance if connected? && table_exists?
+end

data/persistent_settings.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "persistent_settings"
+  s.version     = "1.0.0"
+  s.authors     = ["David Padilla"]
+  s.email       = ["david@crowdint.com"]
+  s.homepage    = ""
+  s.summary     = %q{Simple global Settings class for ActiveRecord based applications}
+  s.description = %q{Simple global Settings class for ActiveRecord based applications}
+
+  s.rubyforge_project = "persistent_settings"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'activerecord', '~> 3'
+  s.add_development_dependency "cucumber" , "~> 1.1.4"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"    , "~> 2.7.0"
+  s.add_development_dependency "sqlite3"  , "~> 1.3"
+end

data/spec/lib/settings_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Settings do
+  before do
+  end
+  describe :assignation? do
+    context "the method name ends with =" do
+      it "returns true" do
+        Settings.assignation?("method=").should be_true
+      end
+    end
+
+    context "the method name does not end with =" do
+      it "returns false" do
+        Settings.assignation?("method").should be_false
+      end
+    end
+  end
+
+  describe :define_setter_and_getter do
+    it "creates the setter and getter methods" do
+      Settings.define_setter_and_getter(:method_name=)
+      Settings.should respond_to(:method_name=)
+      Settings.should respond_to(:method_name)
+      Settings.should_receive(:persist)
+      Settings.method_name = 'value'
+      Settings.method_name.should == 'value'
+    end
+  end
+
+  describe :persist do
+    context "a value already persisted" do
+      before :each do
+        @setting = mock(Settings)
+        Settings.stub_chain(:where, :last).and_return(@setting)
+      end
+
+      it "updates the setting" do
+        @setting.should_receive(:update_attribute).with(:value, :new_value)
+        Settings.persist('some_method', :new_value)
+      end
+    end
+
+    context "a value that is not persisted" do
+      it "creates the setting" do
+        Settings.stub_chain(:where, :last).and_return(nil)
+        Settings.should_receive(:create).with(:var => 'new_method', :value => 'value')
+        Settings.persist('new_method', 'value')
+      end
+    end
+  end
+
+  describe :method_missing do
+    context "A method ending with =" do
+      it "calls define_setter_and_getter" do
+        Settings.should_receive(:define_setter_and_getter).with(:new_method=)
+        Settings.should_receive(:new_method=).with('value')
+        Settings.method_missing(:new_method=, 'value')
+      end
+    end
+
+    context "method that does not end with =" do
+      context "already persisted" do
+        before :each do
+          @setting = mock(Settings, :var => 'persisted_method', :value => 'some value')
+          Settings.stub(:all).and_return([@setting])
+        end
+
+        it "pulls the value from the database and creates its setter and getter" do
+          Settings.should_receive(:persisted_method=).with('some value')
+          Settings.load_from_persistance
+        end
+      end
+
+      context "not persisited" do
+        it "blows up" do
+          lambda {
+            Settings.just_a_method
+          }.should raise_error(NoMethodError)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'active_record'
+require 'persistent_settings'
+
+::ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: persistent_settings
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- David Padilla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70264754810580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70264754810580
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70264754810100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :development
+  prerelease: false
+  version_requirements: *70264754810100
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70264754809720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70264754809720
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70264754809180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70264754809180
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70264754808680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70264754808680
+description: Simple global Settings class for ActiveRecord based applications
+email:
+- david@crowdint.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- features/settings.feature
+- features/step_definitions/settings_steps.rb
+- features/support/env.rb
+- lib/persistent_settings.rb
+- lib/settings.rb
+- lib/settings/version.rb
+- persistent_settings.gemspec
+- spec/lib/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: persistent_settings
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Simple global Settings class for ActiveRecord based applications
+test_files:
+- features/settings.feature
+- features/step_definitions/settings_steps.rb
+- features/support/env.rb
+- spec/lib/settings_spec.rb
+- spec/spec_helper.rb