service_bureau 0.1.0 → 1.0.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzZkOGZmNWI1Y2FkMjU5OGJiODNlZDUzN2MzZWQ2ODNiYzA0ZDgwYg==
+    OWI3ZTYwZmU5YTQ5ODZiZWEzZDZmZTAyYTNkNGY4ZGUzNGIyM2NiNQ==
   data.tar.gz: !binary |-
-    ZjNiZWYxMTVkMzIwM2U4ZGE4MTUzMDZmMjAzYmIwODkzZTVmMGY1Zg==
+    ZmI5YWY3Y2UwMDNlYjY1Y2FhMTMwNDc1NzIzZDlmNmNjOGQ3YWE3OA==
 SHA512:
   metadata.gz: !binary |-
-    MWNkOTdiZDFkYzNjMTYwNjBmMGY4MDViOGMyNmY3YTI4YjJiZTg2NGM4Y2Zk
-    NTA5Nzg1OWM3MWM5Y2I3ZTJmNzgyYTEzYjkxZjMxZmE4YTkwZGFmZmRjNDkx
-    MGE4MjBjZjdkNmNhMjA3OGRiM2RlMWVhNDdkYTlmYWEyYjBmMjM=
+    MTcxMjdlZWQzMDdlZDRjMGE1N2FlNzI4NjI3N2JkZDdlZDU5YzEzZTYxYTE4
+    NGI2ZWQ3ZGYwZmIxNmU1ZWYzODI2YTM0NmRmNDhjODYwNmJlODE3NmU4MDQw
+    ZDQwYTVjNDhjNmQwYWFiNTk2ODdjYWY3NWY0Zjg5YmJjMDZjNmM=
   data.tar.gz: !binary |-
-    NWIxM2JiNmEwNjVjNjFhMDhhNGI3NTQ2ZmYwYzIyODk4OGViNWNjNzdkZmVm
-    ZDUwMjg5OGI1NzYyZTk4YWRjZGQ2MTMzNzNjN2Q1MTIzMTRkMWM2MDIwMTlh
-    YzU3MTljMTUwNmQ4Njg0OTcyMzkyNzllNzY5NzQ0ZjcxNmIyNTM=
+    ZDY0ZDRkNTZhMzAyYWNmZTNhMWIwOWM1ZjIxM2U3ODI3ZWUxYWQwMjBmN2Iw
+    ODc3NmYyOWIxZDJhZjE0MmJkMWI1MjRiZDQ1MmI1ZTlhNjRlYjM0YmRjYTI3
+    YmFjMGIxOGI1YWFiYzY1NmQ0ODdjODliMTkxYzU4OWFkZmY3OTM=

data/lib/service_bureau.rb

@@ -3,7 +3,11 @@ require "service_bureau/locations"
 require "service_bureau/locator"
 require "service_bureau/services"
 
+# Provides easy access to service dependencies, as well
+# as a way to inject them as dependencies.
 module ServiceBureau
+  # Raised when a requested service is not configured
   class UnknownServiceError < StandardError;end
+  # Raised when a requested service cannot be instantiated.
   class UncallableFactoryError < StandardError;end
 end

data/lib/service_bureau/locations.rb

@@ -1,18 +1,41 @@
 module ServiceBureau
+  # Stores the factories for all the configured services
   class Locations
     class << self
+      # Configures the factories for each service
+      #
+      # Each service should be configured with an
+      # object that responds to 'call'
+      #
+      # @example
+      #   ServiceBureau::Locations.configure do |c|
+      #     c.my_service MyService.public_method(:new)
+      #     c.other_service ->(arg){ OtherService.new(arg) }
+      #   end
+      #
+      # @return nothing
+      # @yield ServiceBureau::Locations
+      # @yieldreturn nothing
       def configure(&block)
         yield self
       end
 
+      # @api private
+      # Gets the map of service keys to factories.
+      #
+      # @return [Hash] mapping service keys to factories
       def factory_map
         @factory_map ||= {}
       end
 
+      # Removes all the registered services.
+      #
+      # @return [Hash] the empty factory_map
       def clear
         factory_map.clear
       end
 
+      # @private
       def method_missing(method_name, *args, &block)
         if args.size == 1 && !block_given?
           factory_map[method_name] = args.first

data/lib/service_bureau/locator.rb

@@ -1,14 +1,26 @@
 module ServiceBureau
+  # Finds service factories and instantiates services
   class Locator
+    # Initializes a new Locator with the mapping of service keys to factories.
     def initialize
       @service_factories = ServiceBureau::Locations.factory_map
     end
 
+    # Finds a factory and instantiates a service
+    #
+    # @param service_key [Symbol] the service to look up
+    # @param args will be passed to the factory's call method.
+    #
+    # @return An instance of the service
+    #
+    # @raise [UnknownServiceError] If a factory cannot be found.
+    # @raise [UncallableFactoryError] If a factory is found, but does not respond to call
     def self.get_service service_key, *args
       @instance ||= new
       @instance.get_service service_key, *args
     end
 
+    # (see .get_service)
     def get_service service_key, *args
       service_factories.fetch(service_key).call *args
 

data/lib/service_bureau/services.rb

@@ -1,4 +1,24 @@
 module ServiceBureau
+  # When mixed in to a class, it provides a handle for
+  # all configured services.
+  # It also provides an injector method for each service
+  # so that altenative implementations can be easily
+  # injected e.g. for testing.
+  #
+  # @example
+  #   ServiceBureau::Locations.configure do |c|
+  #     c.my_service MyService.public_method(:new)
+  #   end
+  #
+  #   Class MyClass
+  #     include ServiceBureau::Services
+  #   end
+  #
+  #   obj = MyClass.new
+  #   obj.my_service # => returns the result of: MyService.new
+  #
+  #   obj.my_service = double('a fake service')
+  #   obj.my_service # => returns the test double
   module Services
     def self.included(base)
       ServiceBureau::Locations.factory_map.keys.each do |service|

data/lib/service_bureau/version.rb

@@ -1,3 +1,4 @@
 module ServiceBureau
-  VERSION = "0.1.0"
+  # The current ServiceBureau version
+  VERSION = "1.0.1"
 end

data/service_bureau.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["mattvanhorn@gmail.com"]
   spec.description   = %q{Something of a cross between a Service Locator and an Abstract Factory to enable easier use of the ServiceObject pattern.}
   spec.summary       = %q{An easy way to provide access to your service classes without creating a lot of coupling}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/mattvanhorn/service_bureau"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: service_bureau
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Matt Van Horn
@@ -72,7 +72,7 @@ files:
 - lib/service_bureau/version.rb
 - service_bureau.gemspec
 - spec/service_bureau_spec.rb
-homepage: ''
+homepage: https://github.com/mattvanhorn/service_bureau
 licenses:
 - MIT
 metadata: {}