leather-satchel 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c531f034f0e6cf6c139f9eaa51b5280df321a2ce8ec370cc5f5429a1cfb9402
-  data.tar.gz: 0a05b7cb604130890d73f43db41b8b1459b4b588f2e375cb99c5afbf4b94fcc9
+  metadata.gz: 68c8bcfc5d888b8e09e26b80e3f702a5471f7b634b43110b29bc9ba2526ab56a
+  data.tar.gz: ed09570840b1cb66583bcd751261cd58cbc6cad155109e368cea3715bfc1a8ad
 SHA512:
-  metadata.gz: d8b4a4a05edab3a71ce914619af0d35b73348d51e1914eb763cd816deeeb4f8218b9110308d934b20f12f1230737b09742d93519e9399eaa3ddd923f4ef077c7
-  data.tar.gz: 65d7be73ad4b1bcf280ac3554df72cab3847432744257a66ae11b0e591f8b6ac2dd2cdf076a946af3758ce51cdcbc607e345381d26134c2fc1acfbe6099ed698
+  metadata.gz: 988f088540dff38dfc1fa7b2ece2f7b6e3e57509b7107e33db1e968813411585107dd85d83965c6e0651111f6bd82ccee2713257a5237fc3f8db34d02e0762dc
+  data.tar.gz: 5b927d0d3d4e3fc3120d7068650986a39b632423f95d5e453b07e79cb2c220620ce9f33f1cf5dac412abc17f55a42de46e39cc159d0fbfa22e4f402b2159b478

data/lib/leather/satchel.rb

@@ -20,18 +20,26 @@ module Leather
         end
       end
 
+      # Checks if a given @key exists in the container
+      # @param key [String|Symbol] The name we are checking
+      # @return [Boolean]
+      def contain?(key)
+        @keys.key?(key)
+      end
+
       # Inserts a service into the container under the name @key
-      # @param key [String|Symbol] The name of the service
-      # @param value [Any] The value of the container
+      # @param key [String|Symbol] The name of the value, service or factory
+      # @param value [Object] The object to store against @key
       def []=(key, value)
         @keys[key] = true
         @values[key] = value
       end
 
-      # Gets a service from the container
+      # Gets a value, service or factory from the container
       # @param key [String|Symbol] The name of the service to look for
-      # @return [Any] The stored service value
-      # @throw Error::UnknownIdentifierError
+      # @return [Object] The stored service value
+      # @raise [Error::UnknownIdentifierError] If the container doesn't contain
+      #   the requested key
       def [](key)
         raise Error::UnknownIdentifierError, key unless @keys.key?(key)
 
@@ -52,6 +60,7 @@ module Leather
       # Defines a factory service
       # @param service [Proc]
       # @return [Proc]
+      # @raise [Error::InvalidFactoryError] If the provided factory is not a Proc
       def factory(service)
         raise Error::InvalidFactoryError, service.class unless service.is_a?(Proc)
 
@@ -59,7 +68,7 @@ module Leather
         service
       end
 
-      # Deletes a stored service from the container if it exists
+      # Deletes a stored value, service or factory from the container if it exists
       # @param key [String|Symbol]
       def remove(key)
         return unless @keys.key?(key)

data/lib/leather/satchel/error/invalid_factory_error.rb

@@ -3,6 +3,7 @@
 module Leather
   module Satchel
     module Error
+      # Error raised if the provided factory is not the correct type
       class InvalidFactoryError < StandardError
         # InvalidFactoryError constructor
         # @param type [String]

data/lib/leather/satchel/error/unknown_identifier_error.rb

@@ -3,10 +3,10 @@
 module Leather
   module Satchel
     module Error
-      # Error to be raised if an identifier is unknown
+      # Error raised if the requested identifier is not known by the container
       class UnknownIdentifierError < StandardError
         # UnknownIdentifierError constructor
-        # @param identifier [String]
+        # @param identifier [String|Symbol]
         def initialize(identifier)
           message = "Unknown service identifier #{identifier}"
           super(message)

data/lib/leather/satchel/version.rb

@@ -2,6 +2,6 @@
 
 module Leather
   module Satchel
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leather-satchel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Christopher Birmingham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-14 00:00:00.000000000 Z
+date: 2020-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler