valise 0.6 → 0.7

data/lib/valise/debugging.rb

@@ -0,0 +1,19 @@
+module Valise
+  module Debugging
+    def remark
+    end
+
+    class << self
+      attr_reader :remark_to
+
+      def enable(destination)
+        @remark_to = destination
+        class_eval do
+          def remark
+            self.class.remark_to.puts(yield)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/valise/errors.rb

@@ -1,30 +1,34 @@
 module Valise
-  class Error < ::Exception; end
+  module Errors
+    class Error < ::Exception; end
 
-  class PathOutsideOfRoot < Error; end
-  class PathNotInRoot < Error; end
-  class PathNotFound < Error; end
-  class ReadOnly < Error; end
-  class VirtualSearchPath < Error; end
-  class MalformedTree < Error; end
-  class RootNotInSet < Error; end
+    class PathOutsideOfRoot < Error; end
+    class PathNotInRoot < Error; end
+    class PathNotFound < Error; end
+    class ReadOnly < Error; end
+    class NotFound < Error; end
+    class VirtualSearchPath < Error; end
+    class MalformedTree < Error; end
+    class RootNotInSet < Error; end
+    class UnderIndented < Error; end
 
-  class WouldClobber < Error
-    def initialize(item)
-      @item = item
-      super("Would clobber #{item.segments.inspect}")
+    class WouldClobber < Error
+      def initialize(item)
+        @item = item
+        super("Would clobber #{item.segments.inspect}")
+      end
+
+      attr_reader :item
     end
 
-    attr_reader :item
-  end
+    class CantPopulate < Error
+      def initialize(item, cause)
+        @item = item
+        @original_exception = cause
+        super("Couldn't populate #{item.segments.inspect}: #{cause.class}: #{cause.message}")
+      end
 
-  class CantPopulate < Error
-    def initialize(item, cause)
-      @item = item
-      @original_exception = cause
-      super("Couldn't populate #{item.segments.inspect}: #{cause.class}: #{cause.message}")
+      attr_reader :item, :original_exception
     end
-
-    attr_reader :item, :original_exception
   end
 end

data/lib/valise/path-matcher.rb

@@ -106,7 +106,7 @@ module Valise
       if segments.empty?
         @value = result
       else
-        raise "File globs can only be used as suffixes"
+        raise ArgumentError, "File globs can only be used as suffixes"
       end
     end
   end

data/lib/valise/search-root.rb

@@ -61,7 +61,7 @@ module Valise
 
     def insert(item)
       if(File::exists?(item.full_path))
-        raise WouldClobber.new(Item.new(item.stack.segments, self, nil))
+        raise Errors::WouldClobber.new(Item.new(item.stack.segments, self, nil))
       else
         write(item)
         return item
@@ -79,11 +79,11 @@ module Valise
     end
 
     def write(item)
-      raise ReadOnly
+      raise Errors::ReadOnly
     end
 
     def insert(item)
-      raise ReadOnly
+      raise Errors::ReadOnly
     end
   end
 
@@ -93,7 +93,7 @@ module Valise
     end
 
     def segments
-      raise VirtualSearchPath, "does not have a real path"
+      raise Errors::VirtualSearchPath, "does not have a real path"
     end
 
     def present?(segments)
@@ -126,7 +126,7 @@ module Valise
       check_path = path[0..-2]
       until check_path.empty?
         if @files.has_key?(check_path)
-          raise MalformedTree, "Tried to add items below #{path[0..-2]} which is not a directory"
+          raise Errors::MalformedTree, "Tried to add items below #{path[0..-2]} which is not a directory"
         end
         check_path.pop
       end

data/lib/valise/set/definer.rb

@@ -0,0 +1,64 @@
+require 'valise/utils'
+require 'valise/search-root'
+require 'valise/item'
+
+module Valise
+  class Set
+    class StemmedDefiner
+      include Unpath
+      def initialize(path, set)
+        @segments = unpath(path)
+        @target = set
+      end
+
+      def rw(name)
+        @target.add_search_root(
+          StemDecorator.new(@segments, SearchRoot.new(name)))
+      end
+
+      def ro(name)
+        @target.add_search_root(
+          StemDecorator.new(@segments, ReadOnlySearchRoot.new(name)))
+      end
+    end
+
+    class Definer
+      include Unpath
+      def initialize(set)
+        @target = set
+      end
+
+      def rw(name, path = nil)
+        @target.add_search_root(SearchRoot.new(name))
+      end
+
+      def ro(name, path = nil)
+        @target.add_search_root(ReadOnlySearchRoot.new(name))
+      end
+
+      def stemmed(path, &block)
+        definer = StemmedDefiner.new(path, @target)
+        definer.instance_eval(&block) unless block.nil?
+        return definer
+      end
+
+      def from_here(rel_path)
+        m = /(.*):\d+/.match(caller[0])
+        dir = ::File::dirname(::File::expand_path(m[1]))
+
+        unpath(dir) + unpath(rel_path)
+      end
+
+      def handle(path, serialization, merge_diff = nil)
+        @target.add_handler(unpath(path),
+                            Valise::Serialization[serialization],
+                            Valise::MergeDiff[merge_diff])
+      end
+
+      def defaults(name=nil, &block)
+        loc = DefinedDefaults.define(&block)
+        @target.add_search_root(loc)
+      end
+    end
+  end
+end

data/lib/valise/set.rb

@@ -0,0 +1,148 @@
+require 'valise/debugging'
+require 'valise/errors'
+require 'valise/search-root'
+require 'valise/utils'
+require 'valise/stack'
+require 'valise/path-matcher'
+require 'valise/stem-decorator'
+require 'valise/set/definer'
+
+module Valise
+  class Set
+    include Debugging
+    include Enumerable
+
+    def initialize
+      @search_roots = []
+      @merge_diff = PathMatcher.new
+      @serialization = PathMatcher.new
+    end
+
+    def inspect
+      @search_roots.inspect
+    end
+
+    def reverse
+      set = Set.new
+      set.search_roots = @search_roots.reverse
+      set
+    end
+
+    def define(&block)
+      definer = Definer.new(self)
+      definer.instance_eval(&block)
+      return self
+    end
+
+    def self.define(&block)
+      return self.new.define(&block)
+    end
+
+    def prepend_search_root(search_root)
+      @search_roots.unshift(search_root)
+    end
+
+    def add_search_root(search_root)
+      @search_roots << search_root
+    end
+
+    def add_handler(segments, serialization_class, merge_diff_class)
+      @merge_diff[segments] = merge_diff_class unless merge_diff_class.nil?
+      @serialization[segments] = serialization_class unless serialization_class.nil?
+    end
+
+    def +(other)
+      result = self.class.new
+      result.search_roots = @search_roots + other.search_roots
+      result.merge_handlers(*other.handler_lists)
+      result.merge_handlers(*handler_lists)
+      return result
+    end
+
+    attr_accessor :search_roots
+    protected :search_roots, :search_roots=
+
+      include Unpath
+    def get(path)
+      return Stack.new(path, self,
+                       merge_diff(path),
+                       serialization(path))
+    end
+
+    def merge_diff(path)
+      @merge_diff[unpath(path)]
+    end
+
+    def serialization(path)
+      @serialization[unpath(path)]
+    end
+
+    def merge_handlers(merge_diff, serialization)
+      @merge_diff.merge!(merge_diff)
+      @serialization.merge!(serialization)
+    end
+
+    def handler_lists
+      [@merge_diff, @serialization]
+    end
+
+    def find(path)
+      item = get(path).present.first
+      return item unless item.nil?
+      raise Errors::NotFound, "#{path} not found in #{@search_roots.inspect}"
+    end
+
+    def each(&block)
+      @search_roots.each(&block)
+    end
+
+    def files
+      unless block_given?
+        return self.enum_for(:files)
+      end
+
+      visited = {}
+      @search_roots.each do |root|
+        root.each do |segments|
+          unless visited.has_key?(segments)
+            item = find(segments)
+            visited[segments] = item
+            yield(item)
+          end
+        end
+      end
+      return visited
+    end
+
+    def not_above(root)
+      index = @search_roots.index(root)
+      raise Errors::RootNotInSet if index.nil?
+      set = self.class.new
+      set.search_roots = @search_roots[index..-1]
+      set
+    end
+
+    def below(root)
+      index = @search_roots.index(root)
+      raise Errors::RootNotInSet if index.nil?
+      set = self.class.new
+      set.search_roots = @search_roots[(index+1)..-1]
+      set
+    end
+
+    def [](index)
+      return @search_roots[index]
+    end
+
+    def populate(to = self)
+      files do |item|
+        contents = item.contents
+        to_stack = to.get(item.segments)
+        to_stack = yield(to_stack) if block_given?
+        target = to_stack.writable.first
+        next if target.present?
+        target.contents = contents
+      end
+    end
+  end
+end

data/lib/valise/stem-decorator.rb

@@ -10,7 +10,7 @@ module Valise
       if top_part == @stem
         return segments[@stem.length..-1]
       else
-        raise PathOutsideOfRoot
+        raise Errors::PathOutsideOfRoot
       end
     end
 
@@ -35,13 +35,13 @@ module Valise
 
     def writable?(segments)
       @search_root.writable?(under_stem(segments))
-    rescue PathOutsideOfRoot
+    rescue Errors::PathOutsideOfRoot
       return false
     end
 
     def present?(segments)
       @search_root.present?(under_stem(segments))
-    rescue PathOutsideOfRoot
+    rescue Errors::PathOutsideOfRoot
       return false
     end
 

data/lib/valise/utils.rb

@@ -5,13 +5,12 @@ module Valise
       first = lines.shift
       match = /^(\s*)<<</.match(first)
       unless(match.nil?)
-        catch(:haircut) do
-          return lines.map do |line|
-            raise line if /^#{match[1]}|^\s*$/ !~ line
-            throw :haircut if /^#{match[1]}|^\s*$/ !~ line
-            line.sub(/^#{match[1]}/, "")
-          end.join("\n")
-        end
+        return lines.map do |line|
+          unless /^#{match[1]}|^\s*$/ =~ line
+            raise Errors::UnderIndented, line
+          end
+          line.sub(/^#{match[1]}/, "")
+        end.join("\n")
       end
       return string
     end
@@ -29,7 +28,7 @@ module Valise
         if (parts.find{|part| not (String === part or Symbol === part)}.nil?)
           parts = parts.map{|part| part.to_s}
         else
-          raise "path must be composed of strings or symbols"
+          raise ArgumentError, "path must be composed of strings or symbols"
         end
       when String
         parts = parts.split(::File::Separator)
@@ -39,7 +38,7 @@ module Valise
         parts = parts.path
         parts = parts.split(::File::Separator)
       else
-        raise "path must be String, Array of Strings or File"
+        raise ArgumentError, "path must be String, Array of Strings or File"
       end
 
       parts = parts.map do |part|

data/lib/valise.rb

@@ -1,221 +1,8 @@
+require 'valise/set'
 require 'valise/errors'
-require 'valise/search-root'
-require 'valise/utils'
-require 'valise/stack'
-require 'valise/path-matcher'
-require 'valise/stem-decorator'
 
 module Valise
-  module Debugging
-    def remark
-    end
-
-    class << self
-      attr_reader :remark_to
-
-      def enable(destination)
-        @remark_to = destination
-        class_eval do
-          def remark
-            self.class.remark_to.puts(yield)
-          end
-        end
-      end
-    end
-  end
-
-  class Set
-    include Debugging
-    include Enumerable
-
-    class StemmedDefiner
-      include Unpath
-      def initialize(path, set)
-        @segments = unpath(path)
-        @target = set
-      end
-
-      def rw(name)
-        @target.add_search_root(
-          StemDecorator.new(@segments, SearchRoot.new(name)))
-      end
-
-      def ro(name)
-        @target.add_search_root(
-          StemDecorator.new(@segments, ReadOnlySearchRoot.new(name)))
-      end
-    end
-
-    class Definer
-      include Unpath
-      def initialize(set)
-        @target = set
-      end
-
-      def rw(name, path = nil)
-        @target.add_search_root(SearchRoot.new(name))
-      end
-
-      def ro(name, path = nil)
-        @target.add_search_root(ReadOnlySearchRoot.new(name))
-      end
-
-      def stemmed(path, &block)
-        definer = StemmedDefiner.new(path, @target)
-        definer.instance_eval(&block) unless block.nil?
-        return definer
-      end
-
-      def from_here(rel_path)
-        m = /(.*):\d+/.match(caller[0])
-        dir = ::File::dirname(::File::expand_path(m[1]))
-
-        unpath(dir) + unpath(rel_path)
-      end
-
-      def handle(path, serialization, merge_diff = nil)
-        @target.add_handler(unpath(path),
-                            Valise::Serialization[serialization],
-                            Valise::MergeDiff[merge_diff])
-      end
-
-      def defaults(name=nil, &block)
-        loc = DefinedDefaults.define(&block)
-        @target.add_search_root(loc)
-      end
-    end
-
-    def initialize
-      @search_roots = []
-      @merge_diff = PathMatcher.new
-      @serialization = PathMatcher.new
-    end
-
-    def inspect
-      @search_roots.inspect
-    end
-
-    def reverse
-      set = Set.new
-      set.search_roots = @search_roots.reverse
-      set
-    end
-
-    def define(&block)
-      definer = Definer.new(self)
-      definer.instance_eval(&block)
-      return self
-    end
-
-    def self.define(&block)
-      return self.new.define(&block)
-    end
-
-    def prepend_search_root(search_root)
-      @search_roots.unshift(search_root)
-    end
-
-    def add_search_root(search_root)
-      @search_roots << search_root
-    end
-
-    def add_handler(segments, serialization_class, merge_diff_class)
-      @merge_diff[segments] = merge_diff_class unless merge_diff_class.nil?
-      @serialization[segments] = serialization_class unless serialization_class.nil?
-    end
-
-    def +(other)
-      result = self.class.new
-      result.search_roots = @search_roots + other.search_roots
-      result.merge_handlers(*other.handler_lists)
-      result.merge_handlers(*handler_lists)
-      return result
-    end
-
-    attr_accessor :search_roots
-    protected :search_roots, :search_roots=
-
-      include Unpath
-    def get(path)
-      return Stack.new(path, self,
-                       merge_diff(path),
-                       serialization(path))
-    end
-
-    def merge_diff(path)
-      @merge_diff[unpath(path)]
-    end
-
-    def serialization(path)
-      @serialization[unpath(path)]
-    end
-
-    def merge_handlers(merge_diff, serialization)
-      @merge_diff.merge!(merge_diff)
-      @serialization.merge!(serialization)
-    end
-
-    def handler_lists
-      [@merge_diff, @serialization]
-    end
-
-    def find(path)
-      item = get(path).present.first
-      return item unless item.nil?
-      raise "#{path} not found in #{@search_roots.inspect}"
-    end
-
-    def each(&block)
-      @search_roots.each(&block)
-    end
-
-    def files
-      unless block_given?
-        return self.enum_for(:files)
-      end
-
-      visited = {}
-      @search_roots.each do |root|
-        root.each do |segments|
-          unless visited.has_key?(segments)
-            item = find(segments)
-            visited[segments] = item
-            yield(item)
-          end
-        end
-      end
-      return visited
-    end
-
-    def not_above(root)
-      index = @search_roots.index(root)
-      raise RootNotInSet if index.nil?
-      set = self.class.new
-      set.search_roots = @search_roots[index..-1]
-      set
-    end
-
-    def below(root)
-      index = @search_roots.index(root)
-      raise RootNotInSet if index.nil?
-      set = self.class.new
-      set.search_roots = @search_roots[(index+1)..-1]
-      set
-    end
-
-    def [](index)
-      return @search_roots[index]
-    end
-
-    def populate(to = self)
-      files do |item|
-        contents = item.contents
-        to_stack = to.get(item.segments)
-        to_stack = yield(to_stack) if block_given?
-        target = to_stack.writable.first
-        next if target.present?
-        target.contents = contents
-      end
-    end
+  def self.define(&block)
+    Valise::Set.define(&block)
   end
 end

metadata

@@ -1,36 +1,36 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: valise
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: '0.7'
   prerelease: 
-  version: "0.6"
 platform: ruby
-authors: 
+authors:
 - Judson Lester
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-08 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: corundum
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &88576980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.0.1
   type: :development
   prerelease: false
-  version_requirements: *id001
-description: "  Valise provides an API for accessing configuration and data files for your\n  application, including the population of default values, and managing search\n  paths.  Written to encourage a cross-platform approach to maintaining configs\n  for an application.\n"
-email: 
+  version_requirements: *88576980
+description: ! "  Valise provides an API for accessing configuration and data files
+  for your\n  application, including the population of default values, and managing
+  search\n  paths.  Written to encourage a cross-platform approach to maintaining
+  configs\n  for an application.\n"
+email:
 - nyarly@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - doc/README
 - doc/Specification
 - doc/Specifications
@@ -95,11 +95,14 @@ extra_rdoc_files:
 - doc/coverage/lib-fileset-populator_rb.html
 - doc/coverage/screen.css
 - doc/coverage/print.css
-files: 
+files:
 - doc/README
 - doc/Specification
 - doc/Specifications
 - lib/valise.rb
+- lib/valise/debugging.rb
+- lib/valise/set/definer.rb
+- lib/valise/set.rb
 - lib/valise/errors.rb
 - lib/valise/item.rb
 - lib/valise/path-matcher.rb
@@ -183,38 +186,37 @@ files:
 - doc/coverage/screen.css
 - doc/coverage/print.css
 homepage: http://valise.rubyforge.org/
-licenses: 
+licenses:
 - MIT
 post_install_message: Another tidy package brought to you by Judson
-rdoc_options: 
+rdoc_options:
 - --inline-source
 - --main
 - doc/README
 - --title
-- valise-0.6 RDoc
-require_paths: 
+- valise-0.7 RDoc
+require_paths:
 - lib/
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 940501423
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -446270865
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: valise
-rubygems_version: 1.8.11
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Manage configuration and data files simply
-test_files: 
+test_files:
 - spec_help/gem_test_suite.rb