service_bureau 0.0.1 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjdhMDFkZTZlNTMxMWMyMzA1YTRlMDQ5ODU1Yzg1ZjQyMDE3YTFlZg==
+    MzZkOGZmNWI1Y2FkMjU5OGJiODNlZDUzN2MzZWQ2ODNiYzA0ZDgwYg==
   data.tar.gz: !binary |-
-    OGE4OTI2NDI3MTE2MWZiODM0MGE1YTZjZWU1M2RjYzY0MzcyMzM5ZQ==
+    ZjNiZWYxMTVkMzIwM2U4ZGE4MTUzMDZmMjAzYmIwODkzZTVmMGY1Zg==
 SHA512:
   metadata.gz: !binary |-
-    NWUzY2IyMDQ5MjVjOTNlNDYxYWM2Nzk4NjkwOWIwNTMyYWFjYjE5NDJiZjVi
-    ZjkyNjBhYjhlMzU4Y2U5MDVmNWRiYmYyMWZjNDRmZTdlNTNjNWRiZDkzZjU4
-    MGY1ZTc5NzQ1MzA4Njg5MjRlMDYxMWNlZWZkOWRmYzZjYzEzMTQ=
+    MWNkOTdiZDFkYzNjMTYwNjBmMGY4MDViOGMyNmY3YTI4YjJiZTg2NGM4Y2Zk
+    NTA5Nzg1OWM3MWM5Y2I3ZTJmNzgyYTEzYjkxZjMxZmE4YTkwZGFmZmRjNDkx
+    MGE4MjBjZjdkNmNhMjA3OGRiM2RlMWVhNDdkYTlmYWEyYjBmMjM=
   data.tar.gz: !binary |-
-    NWM0YzgwZDc5NmEwMDU4ODIyMzg1ZGE4YmQ2NjczOThmZDg2M2Y2ZDhjNmE1
-    ZDRiOWQ1Y2Y5MDNmNzdlZDIzM2UwMzg1NWI1MDJhODA1NDQ5OGMxMGIyYmVm
-    MWJkNmM2ZGI5NDhjNjJjODVmODhkNzhkYjY3NzM5YzA3YjI2ZmE=
+    NWIxM2JiNmEwNjVjNjFhMDhhNGI3NTQ2ZmYwYzIyODk4OGViNWNjNzdkZmVm
+    ZDUwMjg5OGI1NzYyZTk4YWRjZGQ2MTMzNzNjN2Q1MTIzMTRkMWM2MDIwMTlh
+    YzU3MTljMTUwNmQ4Njg0OTcyMzkyNzllNzY5NzQ0ZjcxNmIyNTM=

data/README.md

@@ -27,6 +27,8 @@ A factory can be any object that responds to `#call` - a Proc, lambda, method ob
 
 If your service requires arguments to initialize it, make sure the proc accepts them.
 
+If you are using Rails, this would go into an initializer.
+
 ```ruby
   ServiceBureau::Locations.configure do |config|
     config.my_service ->{ MyService.instance }
@@ -83,7 +85,18 @@ describe MyClass
 end
 ```
 
-### As a regular class method lookup
+### An instance method lookup
+```ruby
+class MyClass
+  def my_method
+    locator = ServiceBureau::Locator.new
+    service = locator.get_service(:my_service, 'any', 'arguments')
+    result = service.do_something
+  end
+end
+```
+
+### A class method lookup
 ```ruby
 class MyClass
   def my_method
@@ -93,6 +106,8 @@ class MyClass
 end
 ```
 
+### Notes
+
 The handle to the instance will memoize it, and only instantiate it the first time it is called.
 If you need a new instance, you can use the injector to clear out the old one,
 or you can use the class method on Locator to get a new instance (and you can use the injector
@@ -118,6 +133,66 @@ class MyClass
 end
 ```
 
+### Rails Example with services that need services.
+
+Yo dawg! I heard you  like services, so I put a service in your service.
+This is helpful if you like keeping you application amde up of small, composable, well-focused pieces of functionality.
+```ruby
+  # config/initializers/services.rb
+  ServiceBureau::Locations.configure do |config|
+    config.my_service_a MyServiceA.public_method(:new)
+    config.my_service_b MyServiceB.public_method(:new)
+    config.my_service_c MyServiceC.public_method(:new)
+  end
+
+  # app/services/my_service_a.rb
+  class MyServiceA
+    def work
+      puts "service a"
+    end
+  end
+
+  # app/services/my_service_b.rb
+  class MyServiceB
+    include ServiceBureau::Services
+
+    def work
+      puts "service b"
+      puts my_service_c.work
+    end
+  end
+
+  # app/services/my_service_c.rb
+  class MyServiceC
+    def work
+      puts "service c"
+    end
+  end
+
+  # app/models/client.rb
+  class Client
+    include ServiceBureau::Services
+
+    def do_something
+      puts my_service_a.work
+      puts my_service_b.work
+    end
+  end
+```
+
+```
+> client = Client.new
+# => #<Client:0x007deadbeef000>
+> client.do_something
+
+# =>
+  service a
+
+  service b
+  service c
+```
+
+
 
 ## Contributing
 

data/lib/service_bureau/locator.rb

@@ -4,6 +4,11 @@ module ServiceBureau
       @service_factories = ServiceBureau::Locations.factory_map
     end
 
+    def self.get_service service_key, *args
+      @instance ||= new
+      @instance.get_service service_key, *args
+    end
+
     def get_service service_key, *args
       service_factories.fetch(service_key).call *args
 

data/lib/service_bureau/version.rb

@@ -1,3 +1,3 @@
 module ServiceBureau
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/service_bureau_spec.rb

@@ -39,6 +39,32 @@ describe ServiceBureau::Locator do
       end
     end
   end
+
+  describe '.get_service' do
+    it "gets a configured service" do
+      found_svc = ServiceBureau::Locator.get_service :some_service
+      expect(found_svc).to equal a_service_obj
+    end
+
+    it "instantiates a service with args given" do
+      expect(factory).to receive(:call).with('foo')
+      ServiceBureau::Locator.get_service :other_service, 'foo'
+    end
+
+    context 'when no service is registered' do
+      it "raises UnknownServiceError" do
+        expect{ ServiceBureau::Locator.get_service :no_such_svc }
+          .to raise_error(ServiceBureau::UnknownServiceError)
+      end
+    end
+
+    context 'when the factory registered is not callable' do
+      it "raises UncallableFactoryError" do
+        expect{ ServiceBureau::Locator.get_service :bones_mccoy }
+          .to raise_error(ServiceBureau::UncallableFactoryError)
+      end
+    end
+  end
 end
 
 describe ServiceBureau::Locations do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: service_bureau
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Matt Van Horn