configure_me 0.3.2 → 0.4.0

data/spec/configure_me/nesting_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe ConfigureMe::Nesting, 'the class' do
+  subject { ConfigureMe::Base }
+  it { should respond_to(:nest_me) }
+end
+
+describe ConfigureMe::Nesting do
+  before {
+    @parent_class = define_test_class('ParentConfig', ConfigureMe::Base)
+    @nested_class = define_test_class('NestedConfig', ConfigureMe::Base)
+    @parent_config = @parent_class.instance
+    @nested_config = @nested_class.instance
+    @parent_class.stubs(:instance).returns(@parent_config)
+    @nested_class.stubs(:instance).returns(@nested_config)
+    @nested_class.send(:nest_me, @parent_class)
+  }
+
+  context 'a nested class' do
+    subject { @nested_config }
+    its(:children) { should be_empty }
+    its(:all_configs) { should have(1).items }
+    its(:parent_config) { should eql(@parent_config) }
+  end
+
+  context 'a parent class' do
+    subject { @parent_config }
+    its(:children) { should have(1).items }
+    its(:children) { should eql(:nested => @nested_config) }
+    its(:all_configs) { should have(2).items }
+    its(:parent_config) { should be_nil }
+    it { should respond_to(:nested) }
+    its(:nested) { should eql(@nested_config) }
+    its(:class) { should respond_to(:nested) }
+  end
+end

data/spec/configure_me/persistence_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe ConfigureMe::Persistence do
+  before {
+    @persistence_class = define_test_class('PersistenceConfig', ConfigureMe::Base)
+    @config = @persistence_class.instance
+  }
+  subject { @config }
+  describe 'saving' do
+    before {
+      @config.stubs(:write_persist)
+      @config.stubs(:write_cache)
+      @config.stubs(:make_clean)
+      @temp_attrs = {:testsetting => 'newvalue'}
+      @config.stubs(:temp_attributes).returns(@temp_attrs)
+      @config.stubs(:persist_guard).yields
+    }
+    it 'should run callbacks' do
+      @config.expects(:run_callbacks).at_least_once.yields
+      @config.save
+    end
+    it 'should not run the validations if :validate => false is passed' do
+      @config.expects(:valid?).never
+      @config.save(:validate => false)
+    end
+    it 'should start a transaction' do
+      @config.expects(:persist_guard)
+      @config.save
+    end
+
+    it 'should persist the temp settings' do
+      @config.expects(:write_persist).with(:testsetting, 'newvalue')
+      @config.save
+    end
+
+    it 'should cache the temp settings' do
+      @config.expects(:write_cache).with(:testsetting, 'newvalue')
+      @config.save
+    end
+
+    it 'should clear the dirty status' do
+      @config.expects(:make_clean)
+      @config.save
+    end
+  end
+
+  describe 'update_attributes' do
+    before {
+      @config.stubs(:write_attribute)
+    }
+    it 'should store the new attributes' do
+      @config.stubs(:save)
+      @config.expects(:write_attribute).with(:testsetting, 'updatedvalue')
+      @config.update_attributes(:testsetting => 'updatedvalue')
+    end
+
+    it 'should attempt to save' do
+      @config.expects(:save)
+      @config.update_attributes(:testsetting => 'updatedvalue')
+    end
+  end
+end

data/spec/configure_me/persisting_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper'
+
+describe ConfigureMe::Persisting, 'the class' do
+  subject { ConfigureMe::Base }
+  it { should respond_to(:persist_me) }
+  it { should respond_to(:persisting?) }
+
+  context 'when the persistence_klass is nil' do
+    before {
+      @persisting_klass = define_test_class('PersistingConfig', ConfigureMe::Base)
+      @persisting_klass.send(:persist_me)
+      ConfigureMe.stubs(:persistence_klass).returns(nil)
+    }
+    subject { @persisting_klass }
+    its(:persisting?) { should be_false }
+  end
+
+  describe 'persist_guard' do
+    before {
+      @persisting_klass = define_test_class('PersistingConfig', ConfigureMe::Base)
+    }
+    subject { @persisting_klass.instance }
+    context 'when transactions are supported' do
+      it 'should begin a transaction' do
+        @transaction_class = mock('TransactionClass') do
+          stubs(:transaction)
+        end
+        ConfigureMe.stubs(:persistence_klass).returns(@transaction_class)
+        @transaction_class.expects(:transaction)
+        subject.persist_guard
+      end
+    end
+
+    context 'when persisting with something else' do
+      it 'should just execute the block' do
+        @non_transaction_class = mock('NonTransactionClass')
+        ConfigureMe.stubs(:persistence_klass).returns(@non_transaction_class)
+        @testvalue = 'default'
+        subject.persist_guard do
+          @testvalue = 'changed'
+        end
+        @testvalue.should eql('changed')
+      end
+    end
+  end
+end
+
+describe ConfigureMe::Persisting, 'when persisting is enabled' do
+  before {
+    @persisting_class = define_test_class('PersistingConfig', ConfigureMe::Base)
+    @persisted_setting = mock('PersistedSetting') do
+      stubs(:value).returns('foo'.to_yaml)
+      stubs(:value=)
+      stubs(:save!)
+    end
+    @persistence_klass = mock('PersistenceKlass')
+    @persistence_klass.stubs(:find_or_create_by_key).returns(@persisted_setting)
+    @persistence_klass.stubs(:find_by_key).returns(@persisted_setting)
+    ConfigureMe.stubs(:persistence_klass).returns(@persistence_klass)
+    @persisting_class.send(:persist_me)
+  }
+  subject { @persisting_class.instance }
+
+  describe 'read_persist' do
+    it 'should read from the persistence store' do
+      @persistence_klass.expects(:find_by_key).once.returns(@persisted_setting)
+      subject.read_persist('persistedsetting')
+    end
+
+    context 'with a persisted value' do
+      it 'should return the converted value' do
+        subject.read_persist('persistedsetting').should eql('foo')
+      end
+    end
+
+    context 'with a non-persisted value' do
+      it 'should return nil' do
+        @persistence_klass.stubs(:find_by_key).returns(nil)
+        subject.read_persist('persistedsetting').should be_nil
+      end
+    end
+  end
+
+  describe 'write_persist' do
+    it 'should retrieve or create the setting' do
+      @persistence_klass.expects(:find_or_create_by_key).once.returns(@persisted_setting)
+      subject.write_persist('persistedsetting', 'newvalue')
+    end
+    it 'should update the value' do
+      @persisted_setting.expects(:value=).with('newvalue'.to_yaml)
+      subject.write_persist('persistedsetting', 'newvalue')
+    end
+    it 'should save the record' do
+      @persisted_setting.expects(:save!)
+      subject.write_persist('persistedsetting', 'newvalue')
+    end
+  end
+end
+
+describe ConfigureMe::Persisting, 'when persisting is disabled' do
+  before {
+    @persisting_class = define_test_class('PersistingConfig', ConfigureMe::Base)
+    @persisting_class.stubs(:persisting?).returns(false)
+  }
+  subject { @persisting_class.instance }
+
+  describe 'read_persist' do
+    it 'should not attempt to read from the persistence store' do
+      ConfigureMe.expects(:persistence_klass).never
+      subject.read_persist('persistedsetting')
+    end
+    it 'should return nil' do
+      subject.read_persist('persistedsetting').should be_nil
+    end
+  end
+
+  describe 'write_persist' do
+    it 'should not attempt to write to the persistence store' do
+      ConfigureMe.expects(:persistence_klass).never
+      subject.write_persist('persistedsetting', 'newvalue')
+    end
+  end
+end

data/spec/configure_me/setting_spec.rb

@@ -1,23 +1,190 @@
 require 'spec_helper'
 
 describe ConfigureMe::Setting do
-  before(:each) do
-    @owner = mock('owner') do
-      stubs(:define_attribute_methods)
+
+  def mock_setting(name, *args)
+    ConfigureMe::Setting.new(name, *args)
+  end
+
+  describe 'an instance' do
+    subject do
+      mock_setting(:foo, :type => :string, :default => 'bar')
+    end
+    it { should respond_to(:name) }
+    it { should respond_to(:type) }
+    it { should respond_to(:default) }
+    its(:name) { should eql('foo') }
+    its(:type) { should eql(:string) }
+    its(:default) { should eql('bar') }
+  end
+
+  describe 'inferring the type' do
+    context 'with a string default value' do
+      subject do
+        mock_setting(:foo, :default => 'stringvalue')
+      end
+      its(:type) { should eql(:string) }
+      its(:default) { should eql('stringvalue') }
+    end
+    context 'with a numeric default value' do
+      subject do
+        mock_setting(:foo, :default => 123)
+      end
+      its(:type) { should eql(:integer) }
+      its(:default) { should eql(123) }
+    end
+    context 'with a float default value' do
+      subject do
+        mock_setting(:foo, :default => 1.23)
+      end
+      its(:type) { should eql(:float) }
+      its(:default) { should eql(1.23) }
+    end
+    context 'with a boolean default value' do
+      subject do
+        mock_setting(:foo, :default => true)
+      end
+      its(:type) { should eql(:boolean) }
+      its(:default) { should eql(true) }
+    end
+    context 'with a nil default value' do
+      subject do
+        mock_setting(:foo, :default => nil)
+      end
+      its(:type) { should eql(:unknown) }
+      its(:default) { should be_nil }
+    end
+    context 'with an unsupported default value' do
+      it 'should raise an exception' do
+        lambda {
+          ConfigureMe::Setting.new(:foo, :default => {:invalid => 'hash'})
+        }.should raise_error(ConfigureMe::InvalidDefault)
+      end
     end
-    @setting = ConfigureMe::Setting.new(@owner, :foo, :string, :default => 'bar')
   end
 
-  it { @setting.should respond_to(:name) }
-  it { @setting.name.should eql('foo') }
-  it { @setting.should respond_to(:default) }
-  it { @setting.default.should eql('bar') }
+  describe 'convert' do
+    before(:each) do
+      @string_setting   = mock_setting(:stringsetting, :type => :string)
+      @integer_setting  = mock_setting(:integersetting, :type => :integer)
+      @float_setting    = mock_setting(:floatsetting, :type => :float)
+      @boolean_setting  = mock_setting(:booleansetting, :type => :boolean)
+    end
+    context 'an empty string' do
+      it 'should return "" with a string type' do
+        @string_setting.convert('').should eql('')
+      end
+      it 'should return 0 with an integer type' do
+        @integer_setting.convert('').should eql(0)
+      end
+      it 'should return 0.0 with a float type' do
+        @float_setting.convert('').should eql(0.0)
+      end
+      it 'should return nil with a boolean type' do
+        @boolean_setting.convert('').should be_nil
+      end
+    end
+    context 'a string value of "foo"' do
+      it 'should return "foo" with a string type' do
+        @string_setting.convert('foo').should eql('foo')
+      end
+      it 'should return 0 with an integer type' do
+        @integer_setting.convert('foo').should eql(0)
+      end
+      it 'should return 0.0 with a float type' do
+        @float_setting.convert('foo').should eql(0.0)
+      end
+      it 'should return false with a boolean type' do
+        @boolean_setting.convert('foo').should be_false
+      end
+    end
+
+    context 'an integer value of 123' do
+      it 'should return "123" with a string type' do
+        @string_setting.convert(123).should eql('123')
+      end
+      it 'should return 123 with an integer type' do
+        @integer_setting.convert(123).should eql(123)
+      end
+      it 'should return 123.0 with a float type' do
+        @float_setting.convert(123).should eql(123.0)
+      end
+      it 'should return false with a boolean type' do
+        @boolean_setting.convert(123).should be_false
+      end
+    end
+
+    context 'a float value of 1.23' do
+      it 'should return "1.23" with a string type' do
+        @string_setting.convert(1.23).should eql('1.23')
+      end
+      it 'should return 1 with an integer type' do
+        @integer_setting.convert(1.23).should eql(1)
+      end
+      it 'should return 1.23 with a float type' do
+        @float_setting.convert(1.23).should eql(1.23)
+      end
+      it 'should return false with a boolean type' do
+        @boolean_setting.convert(1.23).should be_false
+      end
+    end
+
+    context 'a boolean value of true' do
+      it 'should return "true" with a string type' do
+        @string_setting.convert(true).should eql('true')
+      end
+      it 'should return 1 with an integer type' do
+        @integer_setting.convert(true).should eql(1)
+      end
+      it 'should return 1.0 with a float type' do
+        @float_setting.convert(true).should eql(1.0)
+      end
+      it 'should return true with a boolean type' do
+        @boolean_setting.convert(true).should be_true
+      end
+    end
+
+    context 'a nil value' do
+      it 'should return "" with a string type' do
+        @string_setting.convert(nil).should eql('')
+      end
+      it 'should return 0 with an integer type' do
+        @integer_setting.convert(nil).should eql(0)
+      end
+      it 'should return 0.0 with a float type' do
+        @float_setting.convert(nil).should eql(0.0)
+      end
+      it 'should return false with a boolean type' do
+        @boolean_setting.convert(nil).should be_false
+      end
+    end
+
+    describe 'to string with an unsupported type' do
+      it 'should raise InvalidConversion' do
+        lambda { @string_setting.convert([]) }.should raise_error(ConfigureMe::InvalidConversion)
+      end
+    end
 
-  it "define_methods! should call the owner class's define_attribute_methods with false" do
-    owner = mock('owner') do
-      expects(:define_attribute_methods).with(true)
+    describe 'with an unknown type' do
+      before(:each) do
+        @unknown = mock_setting(:unknownsetting, :default => nil)
+      end
+      it 'should set the type to :string when a string value is converted' do
+        @unknown.convert('string')
+        @unknown.type.should eql(:string)
+      end
+      it 'should set the type to :integer when an integer value is converted' do
+        @unknown.convert(123)
+        @unknown.type.should eql(:integer)
+      end
+      it 'should set the type to :float when a float value is converted' do
+        @unknown.convert(1.23)
+        @unknown.type.should eql(:float)
+      end
+      it 'should set the type to :boolean when a boolean value is converted' do
+        @unknown.convert(true)
+        @unknown.type.should eql(:boolean)
+      end
     end
-    setting = ConfigureMe::Setting.new(owner, :foo, :string, :default => 'bar')
-    setting.define_methods!
   end
 end

data/spec/spec_helper.rb

@@ -2,9 +2,15 @@ require 'rubygems'
 require 'bundler/setup'
 Bundler.require(:default)
 require 'rspec/core'
+require 'support/active_model_lint'
 
 require 'configure_me'
 
 RSpec.configure do |config|
   config.mock_with :mocha
 end
+
+def define_test_class(name, base)
+  Object.send(:remove_const, name.to_sym) if Object.const_defined?(name)
+  Object.const_set(name, Class.new(base))
+end

data/spec/support/active_model_lint.rb

@@ -0,0 +1,16 @@
+shared_examples_for "ActiveModel" do
+  require 'test/unit/assertions'
+  include ActiveModel::Lint::Tests
+  include Test::Unit::Assertions
+
+  # to_s is to support ruby-1.9
+  ActiveModel::Lint::Tests.public_instance_methods.map{|m| m.to_s}.grep(/^test/).each do |m|
+    example m.gsub('_',' ') do
+      send m
+    end
+  end
+
+  def model
+    subject
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: configure_me
 version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Josh Williams
@@ -15,61 +15,44 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-06 00:00:00 -06:00
-default_executable: 
+date: 2011-05-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activemodel
+  name: rails
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 1
         segments: 
         - 3
         - 0
-        - 1
-        version: 3.0.1
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
         - 3
-        - 0
-        - 1
-        version: 3.0.1
+        version: 3.0.3
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 7
         segments: 
         - 2
+        - 2
         - 0
-        - 1
-        version: 2.0.1
+        version: 2.2.0
   type: :development
-  version_requirements: *id003
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rcov
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -81,11 +64,11 @@ dependencies:
         - 9
         version: 0.9.9
   type: :development
-  version_requirements: *id004
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: mocha
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -97,39 +80,7 @@ dependencies:
         - 8
         version: 0.9.8
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: cucumber
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 51
-        segments: 
-        - 0
-        - 9
-        - 4
-        version: 0.9.4
-  type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: activerecord
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 3
-        - 0
-        - 1
-        version: 3.0.1
-  type: :development
-  version_requirements: *id007
+  version_requirements: *id004
 description: Simple gem to assist with persisting configuration data.
 email: 
 - theprime@codingprime.com
@@ -143,27 +94,39 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
-- README.md
+- README.rdoc
 - Rakefile
 - configure_me.gemspec
-- features/memory.feature
-- features/step_definitions/base_steps.rb
 - lib/configure_me.rb
+- lib/configure_me/attribute_methods.rb
 - lib/configure_me/base.rb
 - lib/configure_me/caching.rb
+- lib/configure_me/identity.rb
+- lib/configure_me/loading.rb
+- lib/configure_me/naming.rb
 - lib/configure_me/nesting.rb
+- lib/configure_me/persistence.rb
 - lib/configure_me/persisting.rb
 - lib/configure_me/setting.rb
-- lib/configure_me/settings.rb
+- lib/configure_me/validations.rb
 - lib/configure_me/version.rb
-- lib/generators/configure_me_generator.rb
-- lib/generators/templates/initializer.rb
-- lib/generators/templates/migration.rb
-- lib/generators/templates/model.rb
+- lib/generators/configure_me/setup_generator.rb
+- lib/generators/configure_me/templates/initializer.rb
+- lib/generators/configure_me/templates/migration.rb
+- lib/generators/configure_me/templates/model.erb
+- lib/generators/configure_me/templates/model.rb
+- spec/configure_me/attribute_methods_spec.rb
 - spec/configure_me/base_spec.rb
+- spec/configure_me/caching_spec.rb
+- spec/configure_me/identity_spec.rb
+- spec/configure_me/loading_spec.rb
+- spec/configure_me/naming_spec.rb
+- spec/configure_me/nesting_spec.rb
+- spec/configure_me/persistence_spec.rb
+- spec/configure_me/persisting_spec.rb
 - spec/configure_me/setting_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
+- spec/support/active_model_lint.rb
 homepage: http://www.github.com/t3hpr1m3/configure_me
 licenses: []
 
@@ -193,13 +156,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: configure_me
-rubygems_version: 1.3.7
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Simple configuration library
 test_files: 
-- features/memory.feature
-- features/step_definitions/base_steps.rb
+- spec/configure_me/attribute_methods_spec.rb
 - spec/configure_me/base_spec.rb
+- spec/configure_me/caching_spec.rb
+- spec/configure_me/identity_spec.rb
+- spec/configure_me/loading_spec.rb
+- spec/configure_me/naming_spec.rb
+- spec/configure_me/nesting_spec.rb
+- spec/configure_me/persistence_spec.rb
+- spec/configure_me/persisting_spec.rb
 - spec/configure_me/setting_spec.rb
 - spec/spec_helper.rb
+- spec/support/active_model_lint.rb
+has_rdoc: 

data/features/memory.feature

@@ -1,16 +0,0 @@
-Feature: Store configuration in memory
-	In order to store configuration information
-	As a ruby developer
-	I want to create a configuration class that stores settings in memory
-
-	Scenario: Simple configuration object
-		Given a Configuration class that derives from ConfigureMe::Base
-		And I add a "color" setting with a type of "string" and a default of "red"
-		When I create an instance of the class
-		And I read the "color" setting
-		Then the result should be "red"
-
-		When I set the "color" setting to "blue"
-		And I read the "color" setting
-		Then the result should be "blue"
-