mattock 0.2.9 → 0.2.10

data/lib/mattock/configuration-store.rb

@@ -0,0 +1,80 @@
+require 'valise'
+
+module Mattock
+  #Configuration for the set of Tasklibs - useful for when there are settings
+  #that shouldn't be part of the Rakefile, or are specific to a particular
+  #environment rather than a set of tasks - e.g. specific to each developer's
+  #laptop or the server.
+  #
+  #@example How to Use:
+  #  module CoolTasks
+  #    def config
+  #      @config ||= Mattock::ConfigurationStore.new("cool_tasks")
+  #    end
+  #
+  #    def preferences
+  #      config.loaded["preferences.yaml"]
+  #    end
+  #
+  #    class AwesomeLib < Mattock::Tasklib
+  #      setting :level, CoolTasks.preferences[:level]
+  #    end
+  #  end
+  #
+  #@example In Rakefile
+  #  CoolTasks.config.register_search_path(__FILE__)
+  #
+  #Having done that, any preferences.yaml file in any of several directories
+  #will get merged into a single hash and be available as CoolTasks.preferences
+  #
+  #The search path will look like:
+  #
+  # * /etc/mattock
+  # * /etc/cool_tasks
+  # * /usr/share/mattock
+  # * /usr/share/cool_tasks
+  # * ~/.mattock
+  # * ~/.cool_tasks
+  # * <Rakefile_dir>/.cool_tasks
+  #
+  # Each file found will be merged into the running hash, so preferences.yaml
+  # in the project dir will be able to override everything.
+  #
+  #Last bonus: any file can be added into that search path, and the 'closest'
+  #one will be found and returned by config.loaded[filename]
+  class ConfigurationStore
+    #@param [String] app_name The path component to represent this gem -
+    #  consider downcasing your root module
+    #@param [String] library_default_dir If present, a directory containing
+    #  default files that come in the gem
+    def initialize(app_name, library_default_dir = nil)
+      @app_name = app_name
+      @valise = Valise::Set.define do
+        rw "~/.#{@app_name}"
+        rw "~/.mattock"
+        rw "/usr/share/#{@app_name}"
+        rw "/usr/share/mattock"
+        rw "/etc/#{@app_name}"
+        rw "/etc/mattock"
+        ro library_default_dir unless library_default_dir.nil?
+        ro from_here("default_configuration")
+
+        handle "preferences.yaml", :yaml, :hash_merge
+      end
+
+      @loaded ||= Hash.new{|h,k| h[k] = @valise.find(k).contents}
+    end
+
+    attr_reader :loaded, :valise
+
+    def register_search_path(from_file)
+      directory = File::expand_path("../.#{@app_name}", from_file)
+      @valise.prepend_search_root(Valise::SearchRoot.new(directory))
+      loaded.clear
+    end
+
+    def user_preferences
+      loaded["preferences.yaml"]
+    end
+  end
+end

data/spec/configuration-store.rb

@@ -0,0 +1,24 @@
+require 'mattock/configuration-store'
+require 'file-sandbox'
+
+describe Mattock::ConfigurationStore do
+  include FileSandbox
+  let :store do
+    described_class.new("test", "default_configs").tap do |store|
+      store.register_search_path('./Rakefile')
+    end
+  end
+
+  before :each do
+    sandbox["default_configs/preferences.yaml"].contents = YAML::dump({"defaults" => "a", "local" => "b"})
+    sandbox[".test/preferences.yaml"].contents = YAML::dump({"local" => "c"})
+  end
+
+  it "should make default configs available" do
+    store.user_preferences["defaults"].should == "a"
+  end
+
+  it "should make local configs available" do
+    store.user_preferences["local"].should == "c"
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: mattock
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.9
+  version: 0.2.10
 platform: ruby
 authors: 
 - Judson Lester
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-07 00:00:00 Z
+date: 2012-03-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: corundum
@@ -28,11 +28,9 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+        version: "0.6"
   type: :runtime
   prerelease: false
   version_requirements: *id002
@@ -77,6 +75,7 @@ files:
 - lib/mattock/tasklib.rb
 - lib/mattock/task.rb
 - lib/mattock/configurable.rb
+- lib/mattock/configuration-store.rb
 - lib/mattock/cascading-definition.rb
 - lib/mattock.rb
 - doc/README
@@ -85,6 +84,7 @@ files:
 - spec/command-task.rb
 - spec/tasklib.rb
 - spec/configurable.rb
+- spec/configuration-store.rb
 - spec/yard-extensions.rb
 - spec/template-host.rb
 - spec_help/spec_helper.rb
@@ -98,7 +98,7 @@ rdoc_options:
 - --main
 - doc/README
 - --title
-- mattock-0.2.9 RDoc
+- mattock-0.2.10 RDoc
 require_paths: 
 - lib/
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -106,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 927991119
+      hash: -164997549
       segments: 
       - 0
       version: "0"