jerry 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 602f20059904dc280342beeba26963492e75a566
-  data.tar.gz: e41a4ebdb936fa0beee388d153cbb505ba8f6c90
+  metadata.gz: 7b5cd829b2996185f8ef423ab36069d638754a23
+  data.tar.gz: 341a9a49bcc3a33149320ecd0ac003264a31e03f
 SHA512:
-  metadata.gz: 0a96708a2dc2bf0d3e8ce206e7763760ca08bf1570e58fa5ef8dd12530e03d432ab1bbcd6e4085f2f29efce794bfb236bed57a3bf93bde039849e9be70dc7f38
-  data.tar.gz: 93da221784a25aecda8d98ac356110a791a0b8e7aeca64923a6e7a81b38d2755ce17f34e6cc9c7f217461a19fc8ea62ab5b822a807608033b08c9e0655da8673
+  metadata.gz: 233d001c305c8f4b57a2b2fa850b32459aacb3d86ab8a071079653b886b3691b4b048017d66e7b61a923e959ae8aed47eba4867af491246f6b2e5e54da277365
+  data.tar.gz: 22afec9ff0c750bc7838a140aa356cc92df22a0d0cb0a8654628ffc9d7d91fe90e949974dc59674ff72707f0595acfd9448add6b05f42854d018d4309f303938

data/.yardopts

@@ -0,0 +1,2 @@
+--protected
+--no-private

data/lib/jerry/config.rb

@@ -1,9 +1,11 @@
-require 'jerry/sugar'
-
 class Jerry
+  # Indicated that an error occurred when defining a component
+  class ComponentError < StandardError; end
+
   # Base class for all jerry configs.
   #
-  # It defines all of the instance methods for a config
+  # A config is a class that tells jerry about a set of available
+  # components and how those should be created
   #
   # @abstract Subclass to define a config
   # @example
@@ -11,11 +13,42 @@ class Jerry
   #     component(:service) { MyService.new }
   #     component(:app) { MyApp.new rig(:service) }
   #   end
-  # @see Jerry::Sugar injected class methods
   class Config
-    # Injects Jerry::Sugar into inherited classes
-    def self.inherited(subclass)
-      subclass.send :extend, Jerry::Sugar
+    class << self
+      # @return [Array<Symbol>] list of the components defined by the config
+      def components
+        @components ||= []
+      end
+
+      # Defines a component
+      #
+      # @param [Symbol] name name of the component
+      # @param [Hash] options options hash see supported options
+      # @option options [Symbol] (:single) The scope of the component. Can be either :single or :instance.
+      #   When the scope is :single, only one instance of the component will be created and every call
+      #   to Jerry#rig will return the same instance. When the scope is :instance, every call to Jerry#rig
+      #   will return a new instance.
+      # @yield Block used to instantiate the component. This block in only called when Jerry#rig is called.
+      # @raise [Jerry::ComponentError] when the block is missing or the scope is invalid
+      def component(name, options={}, &block)
+        raise Jerry::ComponentError, "could not define component #{name}, block is missing" if block.nil?
+
+        scope = options[:scope] || :single
+        unless [:single, :instance].include? scope
+          raise Jerry::ComponentError, "could not define component #{name}, scope #{scope} is unknown"
+        end
+
+        define_method name do
+          case scope
+            when :single
+              cache[name] ||= instance_eval(&block)
+            when :instance
+              instance_eval(&block)
+          end
+        end
+
+        components << name
+      end
     end
 
     # @return [Array<Symbol>] list of components defined by the config
@@ -31,15 +64,20 @@ class Jerry
     protected
 
     # Creates a component
+    #
+    # This should be used inside the block passed to Config::component
     def rig(component)
       @jerry.rig component
     end
 
     # Check if given component exists
+    #
+    # This should be used inside the block passed to Config::component
     def knows?(component)
       @jerry.knows? component
     end
 
+    # Used internally to cache single instance components
     def cache
       @cache ||= {}
     end

data/lib/jerry/version.rb

@@ -1,3 +1,3 @@
 class Jerry
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/jerry.rb

@@ -12,10 +12,11 @@ require 'jerry/config'
 #   jerry = Jerry.new MyConfig.new
 #   jerry.rig :app #=> #<MyApp:...>
 class Jerry
+  # Indicated that an error occurred while rigging a component
   class RigError < StandardError; end
 
   # @param [Jerry::Config] configs Configs used to rig components. Multiple config can be given. If two configs
-  #   define the same component, the later one will have priority.
+  #   define the same component, the later config will have priority.
   def initialize(*configs)
     @index = {}
 

data/spec/config_spec.rb

@@ -4,10 +4,11 @@ require 'jerry/config'
 describe Jerry::Config do
   let(:klass) {Class.new(Jerry::Config)}
 
-  it 'should extend the its subclass with Jerry::Sugar when inherited' do
-    expect(klass.singleton_class.included_modules).to include Jerry::Sugar
-    expect(klass).to respond_to :components
-    expect(klass).to respond_to :component
+  describe 'subclass' do
+    it 'should respond to all inherited class methods' do
+      expect(klass).to respond_to :components
+      expect(klass).to respond_to :component
+    end
   end
 
   describe '#components' do
@@ -61,4 +62,111 @@ describe Jerry::Config do
       expect(config.instance_eval { knows? :something }).to be_truthy
     end
   end
+
+  describe 'class methods' do
+    describe '#component' do
+      it 'should create a method with the given name' do
+        klass.component(:my_component) {}
+
+        expect(klass.new).to respond_to(:my_component)
+      end
+
+      it 'should add the name to the list of components' do
+        klass.component(:target) {}
+
+        expect(klass.components).to include(:target)
+      end
+
+      it 'should raise an error when scope is unknown' do
+        expect{klass.component(:target, scope: :not_a_thing) {}}.to raise_error(Jerry::ComponentError)
+      end
+
+      it 'should raise an error when block is missing' do
+        expect{klass.component :target}.to raise_error(Jerry::ComponentError)
+      end
+
+      describe 'defined method' do
+        it 'should have the right self set' do
+          klass.component(:_self) { self }
+          instance = klass.new
+
+          expect(instance._self).not_to be_a Class
+          expect(instance._self).to be_a klass
+          expect(instance._self).to eq(instance)
+        end
+
+        context 'with scope set to :single' do
+          it 'should only call the block once' do
+            call_count = 0
+            klass.component(:target, scope: :single) {call_count += 1}
+            instance = klass.new
+
+            3.times {instance.target}
+
+            expect(call_count).to eq(1)
+          end
+
+          it 'should keep returning the first created component' do
+            call_count = 0
+            klass.component(:target, scope: :single) {call_count += 1}
+            instance = klass.new
+
+            expect(instance.target).to eq(1)
+            expect(instance.target).to eq(1)
+            expect(instance.target).to eq(1)
+          end
+        end
+
+        context 'with scope set to :instance' do
+          it 'should call the block every time' do
+            call_count = 0
+            klass.component(:target, scope: :instance) {call_count += 1}
+            instance = klass.new
+
+            3.times {instance.target}
+
+            expect(call_count).to eq(3)
+          end
+
+          it 'should return a new instance every time' do
+            call_count = 0
+            klass.component(:target, scope: :instance) {call_count += 1}
+            instance = klass.new
+
+            expect(instance.target).to eq(1)
+            expect(instance.target).to eq(2)
+            expect(instance.target).to eq(3)
+          end
+        end
+
+        context 'with no scope' do
+          it 'should only call the block once' do
+            call_count = 0
+            klass.component(:target) {call_count += 1}
+            instance = klass.new
+
+            3.times {instance.target}
+
+            expect(call_count).to eq(1)
+          end
+
+          it 'should keep returning the first created component' do
+            call_count = 0
+            klass.component(:target) {call_count += 1}
+            instance = klass.new
+
+            expect(instance.target).to eq(1)
+            expect(instance.target).to eq(1)
+            expect(instance.target).to eq(1)
+          end
+        end
+      end
+    end
+
+    describe '#components' do
+      it 'should default to an empty array' do
+        expect(klass.components).to eq([])
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jerry
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Boris Bera
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-21 00:00:00.000000000 Z
+date: 2014-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -84,12 +85,10 @@ files:
 - jerry.gemspec
 - lib/jerry.rb
 - lib/jerry/config.rb
-- lib/jerry/sugar.rb
 - lib/jerry/version.rb
 - spec/config_spec.rb
 - spec/jerry_spec.rb
 - spec/spec_helper.rb
-- spec/sugar_spec.rb
 - spec/support/silence_warnings.rb
 homepage: http://github.com/beraboris/jerry
 licenses:
@@ -119,6 +118,5 @@ test_files:
 - spec/config_spec.rb
 - spec/jerry_spec.rb
 - spec/spec_helper.rb
-- spec/sugar_spec.rb
 - spec/support/silence_warnings.rb
 has_rdoc: 

data/lib/jerry/sugar.rb

@@ -1,41 +0,0 @@
-class Jerry
-  class ComponentError < StandardError; end
-
-  # Contains all the class helper methods that are injected when you inherit from Jerry::Config
-  module Sugar
-    # @return [Array<Symbol>] list of the components defined by the config
-    def components
-      @components ||= []
-    end
-
-    # Defines a component
-    #
-    # @param [Symbol] name name of the component
-    # @param [Hash] options options hash see supported options
-    # @option options [Symbol] (:single) The scope of the component. Can be either :single or :instance.
-    #   When the scope is :single, only one instance of the component will be created and every call
-    #   to Jerry#rig will return the same instance. When the scope is :instance, every call to Jerry#rig
-    #   will return a new instance.
-    # @yield Block used to instantiate the component. This block in only called when Jerry#rig is called.
-    # @raise [Jerry::ComponentError] when the block is missing or the scope is invalid
-    def component(name, options={}, &block)
-      raise Jerry::ComponentError, "could not define component #{name}, block is missing" if block.nil?
-
-      scope = options[:scope] || :single
-      unless [:single, :instance].include? scope
-        raise Jerry::ComponentError, "could not define component #{name}, scope #{scope} is unknown"
-      end
-
-      define_method name do
-        case scope
-          when :single
-            cache[name] ||= instance_eval(&block)
-          when :instance
-            instance_eval(&block)
-        end
-      end
-
-      components << name
-    end
-  end
-end

data/spec/sugar_spec.rb

@@ -1,111 +0,0 @@
-require 'rspec'
-require 'jerry/config'
-
-describe Jerry::Sugar do
-  let(:sugar) {Class.new Jerry::Config}
-
-  describe '#component' do
-    it 'should create a method with the given name' do
-      sugar.component(:my_component) {}
-
-      expect(sugar.new).to respond_to(:my_component)
-    end
-
-    it 'should add the name to the list of components' do
-      sugar.component(:target) {}
-
-      expect(sugar.components).to include(:target)
-    end
-
-    it 'should raise an error when scope is unknown' do
-      expect{sugar.component(:target, scope: :not_a_thing) {}}.to raise_error(Jerry::ComponentError)
-    end
-
-    it 'should raise an error when block is missing' do
-      expect{sugar.component :target}.to raise_error(Jerry::ComponentError)
-    end
-
-    describe 'defined method' do
-      it 'should have the right self set' do
-        sugar.component(:_self) { self }
-        instance = sugar.new
-
-        expect(instance._self).not_to be_a Class
-        expect(instance._self).to be_a sugar
-        expect(instance._self).to eq(instance)
-      end
-
-      context 'with scope set to :single' do
-        it 'should only call the block once' do
-          call_count = 0
-          sugar.component(:target, scope: :single) {call_count += 1}
-          instance = sugar.new
-
-          3.times {instance.target}
-
-          expect(call_count).to eq(1)
-        end
-
-        it 'should keep returning the first created component' do
-          call_count = 0
-          sugar.component(:target, scope: :single) {call_count += 1}
-          instance = sugar.new
-
-          expect(instance.target).to eq(1)
-          expect(instance.target).to eq(1)
-          expect(instance.target).to eq(1)
-        end
-      end
-
-      context 'with scope set to :instance' do
-        it 'should call the block every time' do
-          call_count = 0
-          sugar.component(:target, scope: :instance) {call_count += 1}
-          instance = sugar.new
-
-          3.times {instance.target}
-
-          expect(call_count).to eq(3)
-        end
-
-        it 'should return a new instance every time' do
-          call_count = 0
-          sugar.component(:target, scope: :instance) {call_count += 1}
-          instance = sugar.new
-
-          expect(instance.target).to eq(1)
-          expect(instance.target).to eq(2)
-          expect(instance.target).to eq(3)
-        end
-      end
-
-      context 'with no scope' do
-        it 'should only call the block once' do
-          call_count = 0
-          sugar.component(:target) {call_count += 1}
-          instance = sugar.new
-
-          3.times {instance.target}
-
-          expect(call_count).to eq(1)
-        end
-
-        it 'should keep returning the first created component' do
-          call_count = 0
-          sugar.component(:target) {call_count += 1}
-          instance = sugar.new
-
-          expect(instance.target).to eq(1)
-          expect(instance.target).to eq(1)
-          expect(instance.target).to eq(1)
-        end
-      end
-    end
-  end
-
-  describe '#components' do
-    it 'should default to an empty array' do
-      expect(sugar.components).to eq([])
-    end
-  end
-end