configure_me 0.5.0 → 0.6.0

data/spec/lib/configure_me/loading_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe ConfigureMe::Loading do
+  class ConfigLoader
+    extend ConfigureMe::Loading
+  end
+
+  context 'a filename' do
+    subject { ConfigLoader }
+    it 'should raise an error for a non-existent file' do
+      lambda { subject.load('foo') }.should raise_error(ArgumentError)
+    end
+
+    it 'should load an existing file' do
+      File.stubs(:exists?).returns(true)
+      File.stubs(:open).returns({:foo => 'bar'}.to_yaml)
+      subject.expects(:from_hash)
+      subject.load('avalidfile')
+    end
+  end
+
+  context 'a hash' do
+    context 'with :app => {:setting1 => \'foo\', :setting2 => 845}' do
+      let(:config) { ConfigLoader.load(:app => {:setting1 => 'foo', :setting2 => 845}) }
+      describe 'the class' do
+        subject { config }
+        its(:config_name) { should eql('app') }
+      end
+
+      describe 'the instance' do
+        subject { config.new }
+        it { should respond_to(:setting1) }
+        it { should respond_to(:setting2) }
+        it { should_not respond_to(:setting3) }
+        its(:setting1) { should eql('foo') }
+        its(:setting2) { should eql(845) }
+        its(:parent_config) { should be_nil }
+      end
+    end
+
+    context 'with :group1 => {:setting1 => 6, :setting2 => \'foo\'}, :group2 => {:setting3 => 8, :setting4 => \'bar\'}' do
+
+      let(:config) {
+        ConfigLoader.load(
+          :group1 => {
+            :setting1 => 6,
+            :setting2 => 'foo'
+          },
+          :group2 => {
+            :setting3 => 8,
+            :setting4 => 'bar'
+          }
+        )
+      }
+      describe 'the class' do
+        subject { config }
+        its(:config_name) { should eql('root') }
+      end
+      describe 'the instance' do
+        let(:config_inst) { config.new }
+        subject { config_inst }
+        it { should respond_to(:group1) }
+        it { should respond_to(:group2) }
+        it { should_not respond_to(:group3) }
+
+        describe 'group1' do
+          subject { config_inst.group1 }
+          it { should_not be_nil }
+          it { should respond_to(:setting1) }
+          it { should respond_to(:setting2) }
+          it { should_not respond_to(:setting3) }
+          its(:setting1) { should eql(6) }
+          its(:setting2) { should eql('foo') }
+          its(:parent_config) { should eql(config_inst) }
+        end
+
+        describe 'group2' do
+          subject { config_inst.group2 }
+          it { should_not be_nil }
+          it { should respond_to(:setting3) }
+          it { should respond_to(:setting4) }
+          it { should_not respond_to(:setting1) }
+          its(:setting3) { should eql(8) }
+          its(:setting4) { should eql('bar') }
+          its(:parent_config) { should eql(config_inst) }
+        end
+      end
+    end
+  end
+
+  context 'something unsupported' do
+    subject { ConfigLoader }
+    it 'should raise an exception' do
+      lambda { subject.load(123) }.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/lib/configure_me/naming_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe ConfigureMe::Naming do
+  class NamingTester
+    include ConfigureMe::Naming
+  end
+
+  let(:persistence_klass) { stub(:model_name => 'persistence') }
+  before {
+    ConfigureMe.stubs(:persistence_klass).returns(persistence_klass)
+  }
+  subject { NamingTester }
+  context 'when persisting' do
+    before { NamingTester.stubs(:persisting?).returns(true) }
+    its(:model_name) { should eql('persistence') }
+  end
+
+  context 'when not persisting' do
+    before { NamingTester.stubs(:persisting?).returns(false) }
+    its(:model_name) { should_not eql('persistence') }
+  end
+end

data/spec/lib/configure_me/nesting_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe ConfigureMe::Nesting do
+  class RootConfig
+    include ConfigureMe::Nesting
+  end
+  class NestedConfig
+    include ConfigureMe::Nesting
+  end
+
+  subject { RootConfig }
+  it { should respond_to(:nest_me) }
+
+  context 'a nested class' do
+    before {
+      NestedConfig.stubs(:config_name).returns('nested')
+      RootConfig.stubs(:config_name).returns('root')
+      NestedConfig.nest_me(RootConfig)
+    }
+    subject { NestedConfig }
+    its(:nested_classes) { should be_empty }
+
+    context 'instance' do
+      let(:root_config) { RootConfig.new }
+      subject { root_config.nested }
+      its(:parent_config) { should eql(root_config) }
+      its(:children) { should be_empty }
+      its(:all_configs) { should have(1).items }
+    end
+  end
+
+  context 'a root class' do
+    before {
+      NestedConfig.stubs(:config_name).returns('nested')
+      RootConfig.stubs(:config_name).returns('root')
+      NestedConfig.nest_me(RootConfig)
+    }
+    subject { RootConfig }
+    its(:nested_classes) { should have(1).items }
+
+    context 'instance' do
+      let(:root_config) { RootConfig.new }
+      let(:nested_config) { root_config.nested }
+      before { root_config.nested }
+      subject { root_config }
+      it { should respond_to(:nested) }
+      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 }
+      its(:nested) { should eql(nested_config) }
+    end
+  end
+end

data/spec/lib/configure_me/persistence_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe ConfigureMe::Persistence do
+  class PersistenceTester
+    extend ActiveModel::Callbacks
+    include ConfigureMe::Persistence
+  end
+
+  let(:test_class) { define_test_class('PersistenceConfig', PersistenceTester) }
+  let(:config) { test_class.new }
+  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/lib/configure_me/persisting_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe ConfigureMe::Persisting do
+
+  class PersistingTester
+    include ConfigureMe::Persisting
+  end
+  subject { PersistingTester }
+  it { should respond_to(:persist_me) }
+  it { should respond_to(:persisting?) }
+
+  let(:persisting_klass) { define_test_class('PersistingConfig', PersistingTester) }
+
+  context 'when the persistence_klass is nil' do
+    before {
+      persisting_klass.send(:persist_me)
+      ConfigureMe.stubs(:persistence_klass).returns(nil)
+    }
+    subject { persisting_klass }
+    its(:persisting?) { should be_false }
+  end
+
+  describe 'persist_guard' do
+    subject { persisting_klass.new }
+    context 'when transactions are supported' do
+      it 'should begin a transaction' do
+        @transaction_class = mock('TransactionClass') do
+          expects(:transaction)
+        end
+        ConfigureMe.stubs(:persistence_klass).returns(@transaction_class)
+        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
+
+  context 'when persisting is enabled' do
+    let(:persisted_setting) { stub(:value => 'foo'.to_yaml, :value= => nil, :save! => nil) }
+    before {
+      @persistence_klass = stub(:find_or_create_by_key => persisted_setting, :find_by_key => persisted_setting)
+      ConfigureMe.stubs(:persistence_klass).returns(@persistence_klass)
+      persisting_klass.stubs(:persisting?).returns(true)
+    }
+    subject { persisting_klass.new }
+
+    describe 'read_persist' do
+      before { subject.stubs(:storage_key).returns('key') }
+      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
+      before { subject.stubs(:storage_key).returns('key') }
+      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.new }
+#
+#  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
+end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'rubygems'
 require 'simplecov'
-SimpleCov.start
+SimpleCov.start do
+  add_filter "/spec/"
+end
 require 'bundler/setup'
 Bundler.require(:default)
 require 'rspec/core'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configure_me
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-02 00:00:00.000000000Z
+date: 2012-01-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &22468760 !ruby/object:Gem::Requirement
+  requirement: &19476980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,21 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *22468760
+  version_requirements: *19476980
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &19476340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *19476340
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &22463680 !ruby/object:Gem::Requirement
+  requirement: &19475680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +43,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *22463680
+  version_requirements: *19475680
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &22463200 !ruby/object:Gem::Requirement
+  requirement: &19474860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +54,10 @@ dependencies:
         version: 0.5.4
   type: :development
   prerelease: false
-  version_requirements: *22463200
+  version_requirements: *19474860
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &22462720 !ruby/object:Gem::Requirement
+  requirement: &19474400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +65,29 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *22462720
+  version_requirements: *19474400
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &19473920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.10
+  type: :development
+  prerelease: false
+  version_requirements: *19473920
+- !ruby/object:Gem::Dependency
+  name: libnotify
+  requirement: &19473240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *19473240
 description: Simple gem to assist with persisting configuration data.
 email:
 - theprime@codingprime.com
@@ -66,6 +99,7 @@ files:
 - .rspec
 - .rvmrc
 - Gemfile
+- Guardfile
 - README.rdoc
 - Rakefile
 - configure_me.gemspec
@@ -73,7 +107,6 @@ files:
 - 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
@@ -87,16 +120,15 @@ files:
 - 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/lib/configure_me/attribute_methods_spec.rb
+- spec/lib/configure_me/base_spec.rb
+- spec/lib/configure_me/caching_spec.rb
+- spec/lib/configure_me/loading_spec.rb
+- spec/lib/configure_me/naming_spec.rb
+- spec/lib/configure_me/nesting_spec.rb
+- spec/lib/configure_me/persistence_spec.rb
+- spec/lib/configure_me/persisting_spec.rb
+- spec/lib/configure_me/setting_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_model_lint.rb
 homepage: http://www.github.com/t3hpr1m3/configure_me
@@ -124,15 +156,14 @@ signing_key:
 specification_version: 3
 summary: Simple configuration library
 test_files:
-- 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/lib/configure_me/attribute_methods_spec.rb
+- spec/lib/configure_me/base_spec.rb
+- spec/lib/configure_me/caching_spec.rb
+- spec/lib/configure_me/loading_spec.rb
+- spec/lib/configure_me/naming_spec.rb
+- spec/lib/configure_me/nesting_spec.rb
+- spec/lib/configure_me/persistence_spec.rb
+- spec/lib/configure_me/persisting_spec.rb
+- spec/lib/configure_me/setting_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_model_lint.rb

data/lib/configure_me/identity.rb

@@ -1,15 +0,0 @@
-module ConfigureMe
-  module Identity
-    def config_key
-      to_param
-    end
-
-    def config_name
-      self.class.name.split('::').last.gsub(/^(.*)Config$/, '\1').underscore
-    end
-
-    def storage_key(name)
-      "#{config_key}-#{name.to_s}"
-    end
-  end
-end

data/spec/configure_me/attribute_methods_spec.rb

@@ -1,113 +0,0 @@
-require 'spec_helper'
-
-describe ConfigureMe::AttributeMethods do
-  before {
-    @config_class = define_test_class('MyTestConfig', ConfigureMe::Base)
-  }
-  subject { @config_class.instance }
-  it 'make clean should clear the temp_attributes' do
-    subject.send(:temp_attributes).expects(:clear)
-    subject.send(:make_clean)
-  end
-end
-
-describe ConfigureMe::AttributeMethods, 'reading an attribute' do
-  before {
-    @config_class = define_test_class('MyTestConfig', ConfigureMe::Base)
-    @config_class.send(:setting, :testsetting, :default => 'foo')
-    @config = @config_class.instance
-    @config.stubs(:read_cache)
-    @config.stubs(:read_persist)
-  }
-  subject { @config }
-  it 'should call "read_attribute"' do
-    @config.expects(:read_attribute).with('testsetting')
-    subject.testsetting
-  end
-  context 'with a pristine instance' do
-    it 'should attempt to read from the cache' do
-      subject.expects(:read_cache)
-      subject.testsetting
-    end
-    it 'should attempt to read from the persistence store' do
-      subject.expects(:read_persist)
-      subject.testsetting
-    end
-    it 'should return the default value' do
-      subject.testsetting.should eql('foo')
-    end
-  end
-  context 'with a persisted value' do
-    context 'with a non-cached value' do
-      before { @config.stubs(:read_cache).returns(nil) }
-      it 'should attempt to read from the cache' do
-        subject.expects(:read_cache).returns(nil)
-        subject.testsetting
-      end
-      it 'should attempt to read from the persistence store' do
-        subject.expects(:read_persist)
-        subject.testsetting
-      end
-      it 'should write the value to the cache' do
-        subject.stubs(:read_persist).returns('persisted')
-        subject.expects(:write_cache).with(:testsetting, 'persisted')
-        subject.testsetting
-      end
-      it 'should return the persisted value' do
-        subject.stubs(:read_cache).returns('persisted')
-        subject.testsetting.should eql('persisted')
-      end
-    end
-
-    context 'with a cached value' do
-      before { @config.stubs(:read_cache).returns('cached') }
-      it 'should attempt to read from the cache' do
-        subject.expects(:read_cache).returns('cached')
-        subject.testsetting
-      end
-      it 'should not attempt to read from the persistence store' do
-        subject.expects(:read_persist).never
-        subject.testsetting
-      end
-      it 'should return the cached value' do
-        subject.testsetting.should eql('cached')
-      end
-    end
-  end
-
-  context 'with a dirty value' do
-    before { @config.stubs(:testsetting_changed?).returns(true) }
-    it 'should not attempt to read from the cache' do
-      subject.expects(:read_cache).never
-      subject.testsetting
-    end
-    it 'should not attempt to read from the persistence store' do
-      subject.expects(:read_persist).never
-      subject.testsetting
-    end
-    it 'should return the value from the temp_attributes hash' do
-      subject.expects(:temp_attributes).returns(:testsetting => 'iamdirty')
-      subject.testsetting.should eql('iamdirty')
-    end
-  end
-end
-
-describe ConfigureMe::AttributeMethods, 'writing an attribute' do
-  before {
-    @config_class = define_test_class('MyTestConfig', ConfigureMe::Base)
-    @config_class.send(:setting, :testsetting, :default => 'foo')
-    @config = @config_class.instance
-    @config.stubs(:read_cache)
-    @config.stubs(:read_persist)
-  }
-  subject { @config }
-
-  it 'should set the attribute to dirty' do
-    subject.expects(:make_dirty).with(:testsetting)
-    subject.testsetting = 'newvalue'
-  end
-  it 'should write the value to the temp_attributes hash' do
-    subject.testsetting = 'newvalue'
-    subject.send(:temp_attributes)[:testsetting].should eql('newvalue')
-  end
-end