timed_config 0.1.0 → 0.1.1

data/README.md

@@ -1,7 +1,7 @@
 TimedConfig
 ===========
 
-Starts a thread that loads a YAML config every X minutes
+Load a YAML config every X minutes
 
 Requirements
 ------------
@@ -18,7 +18,7 @@ Install
 #### config/environment.rb
 
 <pre>
-config.gem 'acts_as_archive'
+config.gem 'timed_config'
 </pre>
 
 ### Rails 3
@@ -26,31 +26,22 @@ config.gem 'acts_as_archive'
 #### Gemfile
 
 <pre>
-gem 'acts_as_archive'
+gem 'timed_config'
 </pre>
 
 ### Other
 
 <pre>
-require 'acts_as_archive'
+require 'timed_config'
 </pre>
 
-Starts by default
------------------
-
-<code>TimedConfig</code> will start automatically when you require it.
+Defaults
+--------
 
-If you are using Rails, it will try to find the config in <code>config/timed_config.yml</code>.
+If you are using Rails, <code>TimedConfig</code> will try to locate the YAML config at <code>config/timed_config.yml</code>.
 
 By default, the refresh period is set to 1 minute.
 
-Accessing the config
---------------------
-
-<pre>
-TimedConfig.config
-</pre>
-
 Changing defaults
 -----------------
 
@@ -59,4 +50,11 @@ TimedConfig.period = 120 # change period to two minutes
 TimedConfig.path = "path/to/yaml.yml"
 </pre>
 
-The config will reload any time one of these settings change.
+The config will reload any time a setting changes.
+
+Accessing the config
+--------------------
+
+<pre>
+TimedConfig.config
+</pre>

data/config/gemspec.yml

@@ -1,10 +1,10 @@
 name: timed_config
-version: 0.1.0
+version: 0.1.1
 authors:
   - Winton Welsh
 email: mail@wintoni.us
 homepage: http://github.com/winton/timed_config
-summary: Starts a thread that loads a YAML config every X minutes
-description: Starts a thread that loads a YAML config every X minutes
+summary: Load a YAML config every X minutes
+description: Load a YAML config every X minutes
 dependencies: null
 development_dependencies: null

data/lib/timed_config.rb

@@ -1,41 +1,44 @@
 require 'yaml'
 
 module TimedConfig
-  
   class <<self
-    attr_accessor :config
+    
+    def config
+      reload
+    end
     
     def path
       @path || (defined?(Rails) ? "#{Rails.root}/config/timed_config.yml" : nil)
     end
     
     def path=(p)
-      thread.stop rescue nil
       @path = p
-      thread.run
+      reload true
+      p
     end
     
     def period
       @period || 60
     end
     
-    def period=(seconds)
-      thread.stop rescue nil
-      @period = seconds
-      thread.run
+    def period=(p)
+      @period = p
+      reload true
+      p
     end
     
-    def thread
-      @thread ||= Thread.new do
-        while true
-          if TimedConfig.path && File.exists?(TimedConfig.path)
-            TimedConfig.config = YAML::load(File.open(TimedConfig.path))
-          end
-          sleep TimedConfig.period
+    def reload(force=false)
+      if force || !@last_load || Time.now >= (@last_load + period)
+        if TimedConfig.path && File.exists?(TimedConfig.path)
+          @config = YAML::load(File.open(TimedConfig.path))
+        else
+          @config = nil
         end
+        @last_load = Time.now
       end
+      @config
     end
     
-    TimedConfig.thread
+    TimedConfig.reload
   end
 end

data/spec/spec_helper.rb

@@ -8,4 +8,9 @@ TimedConfig::Gems.activate :rspec
 require "#{$root}/lib/timed_config"
 
 Spec::Runner.configure do |config|
+end
+
+def write_to_fixture(data)
+  config = "#{$root}/spec/fixtures/config.yml"
+  File.open(config, 'w') {|f| f.write(data) }
 end

data/spec/timed_config_spec.rb

@@ -1,17 +1,35 @@
 require 'spec_helper'
 
 describe TimedConfig do
-  it "should be sleeping" do
-    TimedConfig.thread.status.should == 'sleep'
+  
+  after(:all) do
+    FileUtils.rm "#{$root}/spec/fixtures/config.yml"
   end
   
   it "should not have set a config" do
     TimedConfig.config.should == nil
   end
   
-  it "should set a config when path set" do
+  it "should update config when path set" do
+    write_to_fixture "test: test"
     TimedConfig.path = "#{$root}/spec/fixtures/config.yml"
-    sleep 0.1
     TimedConfig.config.should == { 'test' => 'test' }
   end
+  
+  it "should update config when period set" do
+    write_to_fixture "test2: test2"
+    TimedConfig.period = 2
+    TimedConfig.config.should == { 'test2' => 'test2' }
+  end
+  
+  it "should not update config in one second" do
+    write_to_fixture "test3: test3"
+    sleep 1
+    TimedConfig.config.should == { 'test2' => 'test2' }
+  end
+  
+  it "should update config in two seconds" do
+    sleep 1
+    TimedConfig.config.should == { 'test3' => 'test3' }
+  end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: timed_config
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Winton Welsh
@@ -14,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-13 00:00:00 -08:00
+date: 2011-01-24 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: Starts a thread that loads a YAML config every X minutes
+description: Load a YAML config every X minutes
 email: mail@wintoni.us
 executables: []
 
@@ -37,7 +38,6 @@ files:
 - lib/timed_config.rb
 - lib/timed_config/gems.rb
 - rails/init.rb
-- spec/fixtures/config.yml
 - spec/fixtures/gemsets.yml
 - spec/fixtures/gemspec.yml
 - spec/spec_helper.rb
@@ -58,6 +58,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -66,18 +67,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
-summary: Starts a thread that loads a YAML config every X minutes
+summary: Load a YAML config every X minutes
 test_files: 
-- spec/fixtures/config.yml
 - spec/fixtures/gemsets.yml
 - spec/fixtures/gemspec.yml
 - spec/spec_helper.rb

data/spec/fixtures/config.yml

@@ -1 +0,0 @@
-test: test