abyss 0.3.2 → 0.4.0

data/lib/abyss.rb

@@ -21,30 +21,76 @@ module Abyss
   #
   # Examples:
   #
-  # Abyss.configure do
-  #   three do
-  #     levels do
-  #       deep do
-  #         day "Monday"
+  #     Abyss.configure do
+  #       three do
+  #         levels do
+  #           deep do
+  #             day "Monday"
+  #           end
+  #         end
   #       end
   #     end
-  #   end
-  # end
   #
-  # Abyss.has?("three/levels/deep/day") #=> true
-  # Abyss.has?("non/existent/thing")    #=> false
+  #     Abyss.has?("three/levels/deep/day") #=> true
+  #     Abyss.has?("non/existent/thing")    #=> false
   #
   def self.has?(path)
+    get(path) ? true : false
+  end
+
+  # Gets a value at a given configuration path, slash-separated
+  #
+  # Returns: Target value or nil
+  #
+  # Examples:
+  #
+  #     Abyss.configure do
+  #       three do
+  #         levels do
+  #           deep do
+  #             day "Monday"
+  #           end
+  #         end
+  #       end
+  #     end
+  #
+  #     Abyss.get("three/levels/deep/day") #=> "Monday"
+  #     Abyss.has("non/existent/thing")    #=> nil
+  #
+  def self.get(path)
     path.split('/').inject(Abyss.configuration) do |acc, current_path_item|
       begin
         target = acc.send(current_path_item)
-        return false if target.nil?
+        return nil if target.nil?
       rescue NoMethodError
-        return false
+        return nil
       end
       target
     end
-    true
+  end
+
+  # Gets a value at a given configuration path, slash-separated. This version
+  # raises an error if the value isn't defined.
+  #
+  # Returns: Target value
+  #
+  # Examples:
+  #
+  #     Abyss.configure do
+  #       three do
+  #         levels do
+  #           deep do
+  #             day "Monday"
+  #           end
+  #         end
+  #       end
+  #     end
+  #
+  #     Abyss.get("three/levels/deep/day") #=> "Monday"
+  #     Abyss.has("non/existent/thing")    # Raises Abyss::Errors::NotFound
+  #
+  def self.get!(path)
+    get(path) || raise(Abyss::Errors::NotFound.new(path))
   end
 
 end

data/lib/abyss/errors.rb

@@ -2,6 +2,18 @@ module Abyss
 
   module Errors
 
+    class NotFound < RuntimeError
+      attr_accessor :path
+
+      def initialize(path)
+        self.path = path
+      end
+
+      def message
+        "Value at '#{path}' not found."
+      end
+    end
+
     class AbstractMethod < RuntimeError
       attr_accessor :name
 

data/lib/abyss/version.rb

@@ -1,3 +1,3 @@
 module Abyss
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/spec/abyss_spec.rb

@@ -18,34 +18,63 @@ describe Abyss do
 
   end
 
-  describe '.has?' do
-
-    context "when given a path to an existing configuration" do
-
-      before do
-        Abyss.configure do
-          three do
-            levels do
-              deep do
-                here "hey!"
-              end
+  describe 'access and validation mechanisms' do
+
+    before do
+      Abyss.configure do
+        three do
+          levels do
+            deep do
+              here "hey!"
             end
           end
         end
       end
+    end
+
+    describe '.has?' do
+
+      it 'returns true when the value exists' do
+        Abyss.has?('three/levels/deep/here').should be_true
+      end
+
+      context "when the config doesn't exist" do
 
-      specify { Abyss.has?('three/levels/deep/here').should be_true }
+        before do
+          Abyss.configuration = nil
+          Abyss.configure {}
+        end
+
+        specify { Abyss.has?('three/levels/deep/here').should be_false }
+        specify { Abyss.has?('nope').should be_false }
+
+      end
 
     end
 
-    context "when the config doesn't exist" do
+    describe '.get' do
+
+      it 'returns the value when it exists' do
+        Abyss.get('three/levels/deep/here').should == 'hey!'
+      end
 
-      before do
-        Abyss.configure {}
+      it "returns nil if it doesn't" do
+        Abyss.get('nope').should be_false
+        Abyss.get('no/can/do').should be_false
       end
 
-      specify { Abyss.has?('three/levels/deep/here').should be_false }
-      specify { Abyss.has?('nope').should be_false }
+    end
+
+    describe '.get!' do
+
+      it 'returns the value when it exists' do
+        Abyss.get('three/levels/deep/here').should == 'hey!'
+      end
+
+      it "raises an error when it doesn't" do
+        expect { Abyss.get!('nope').should be_false }.to raise_error Abyss::Errors::NotFound, /'nope' not found/
+        expect { Abyss.get!('no/can/do').should be_false }.to raise_error Abyss::Errors::NotFound, /'no\/can\/do' not found/
+      end
 
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: abyss
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-31 00:00:00.000000000 Z
+date: 2012-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70318152924440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,12 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70318152924440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 description: Manage arbitrarily-deep configurations through a friendly DSL.
 email:
 - jesseltrimble@gmail.com
@@ -58,15 +63,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -772610373107186531
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -772610373107186531
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Manage arbitrarily-deep configurations through a friendly DSL.