data-provider 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83fa8bd4be333b6f8270042fdd45a36715bca717
-  data.tar.gz: 4d325d45f0dda818c3f31203053aa31428c65fa3
+  metadata.gz: 6553850094492d6ea8435a9098391c95b90ac4c7
+  data.tar.gz: 31ef7fcd6b10dc7b0cb4fa64bb70fce514bccd67
 SHA512:
-  metadata.gz: cf0452e4da45cb8e89276369b30f71c250e6820b2a2fef3b335562de10a082b3ec73dfb1de6b2858db6a500836f5cc128e31aff40956b168fa39054a35770c86
-  data.tar.gz: 685221df20098653c37366fde7082fa0cf10e537dbe8b86d2c198316edc6541671a33f2ccfd160f14a9a754c0bb6ab19730a0d603478168deea8a45e78279c31
+  metadata.gz: f8ee310527986bcb7e2dc97643410f1d3baddc40b4ce2e632aa2745bf985bdbbcfec12b0146f736e7694039a7f0a4e0b0bf26b811a03b66ab96d3b047250758c
+  data.tar.gz: 30df84e79b9746a38c6076d7a7eda4406de47e910d069bdf6c9c746c1125bae4db9d403298599668db6d11c3ea1cf2a91faed298b3e545dc35021ecfdd89fa3f

data/data-provider.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "data-provider"
-  s.version = '0.2.2'
+  s.version = '0.2.3'
   s.files = `git ls-files`.split($/)
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]

data/lib/data_provider/base.rb

@@ -143,7 +143,7 @@ module DataProvider
         return self
       end
 
-      # classes/modules can't be cloned, so add behave just like add!
+      # classes/modules can't be cloned, so add behaves just like add!
       alias :add :add!
       alias :add_scoped :add_scoped!
     end # module ClassMethods

data/lib/data_provider/container.rb

@@ -27,6 +27,10 @@ module DataProvider
       end
     end
 
+    def default_priority
+      options[:default_priority].to_i
+    end
+
     def provider identifier, opts = {}, &block
       add_provider(identifier, opts, block_given? ? block : nil)
     end
@@ -290,12 +294,18 @@ module DataProvider
 
     # returns the requested provider as a Provider object
     def get_provider(id, opts = {})
-      if opts[:skip]
-        matches = providers.find_all{|args| args.first == id}
-        args = matches[opts[:skip].to_i]
-      else
-        args = providers.find{|args| args.first == id}
+      # get all matching providers
+      matching_provider_args = providers.find_all{|args| args.first == id}
+      # sort providers on priority, form high to low
+      matching_provider_args.sort! do |args_a, args_b|
+        # we want to sort from high priority to low, but providers with the same priority level
+        # should stay in the same order because among those, the last one added has the highest priority
+        # (last added means first in the array, since they are pushed into the beginning of the array)
+        (Provider.new(*args_b).priority || self.default_priority) <=> (Provider.new(*args_a).priority || self.default_priority)
       end
+      # if no skip option is given, opts[:skip].to_i will result in zero, so it'll grab thefirst from the array
+      # if the array is empty, args will always turn out nil
+      args = matching_provider_args[opts[:skip].to_i]
 
       return args.nil? ? nil : Provider.new(*args)
     end

data/lib/data_provider/provider.rb

@@ -16,5 +16,8 @@ module DataProvider
       [options[:requires]].flatten.compact
     end
 
+    def priority
+      options[:priority]
+    end
   end # module Provider
 end # module DataProvider

data/spec/container_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe DataProvider::Container do
-    # Example implementation of DataProvider::Base
+  # Example implementation of DataProvider::Base
   let(:container){
     DataProvider::Container.new.tap do |container|
       container.provider :sum, :requires => [:array] do
@@ -60,6 +60,48 @@ describe DataProvider::Container do
     end
   end
 
+  describe "#default_priority" do
+    it "gives the default priority for providers" do
+      expect(DataProvider::Container.new.default_priority).to eq 0 # zero is the default default
+    end
+
+    describe ":default_priority" do
+      it "lets the owner specify the default_priority at initialize-time" do
+        expect(DataProvider::Container.new(:default_priority => 100).default_priority).to eq 100
+      end
+    end
+  end
+
+  describe "#provider" do
+    it "lets the owner add a new provider to the container" do
+      c = DataProvider::Container.new
+      expect(c.has_provider?(:no_yet)).to be false
+    end
+
+    describe ":priority" do
+      it "by default -without explicitly specified priorities- gives highest priority to the latest added provider" do
+        c = DataProvider::Container.new
+        c.provider(:foo){ 'bar' } # only one at this point
+        expect(c.take(:foo)).to eq 'bar'
+        c.provider(:foo){ 'cafe' } # last added, so get highest priority
+        expect(c.take(:foo)).to eq 'cafe'
+      end
+
+      it "lets the owner specify a priority level for the provider" do
+        c = DataProvider::Container.new
+        c.provider(:foo, :priority => 10){ 'bar' } # only one at this point
+        expect(c.take(:foo)).to eq 'bar'
+        c.provider(:foo){ 'cafe' } # last added, but default priority is 0, so lower prio
+        expect(c.take(:foo)).to eq 'bar'
+        c.provider(:foo, :priority => 5){ 'dive' } # lower explicit prio
+        expect(c.take(:foo)).to eq 'bar'
+        c.provider(:foo, :priority => 11){ 'lounge' } # higher explicit prio
+        expect(c.take(:foo)).to eq 'lounge'
+        
+      end
+    end
+  end
+
   describe "#has_providers_with_scope?" do
     let(:container){
       DataProvider::Container.new.tap do |container|
@@ -840,5 +882,14 @@ describe DataProvider::Container do
       expect{instance.take(:whatever)}.to raise_error(DataProvider::ProviderMissingException)
     end
 
+    it "plays nice with the :priority option" do
+      c = DataProvider::Container.new
+      c.provider(:foo){ 'bar0' }
+      expect(c.take(:foo)).to eq 'bar0'
+      c.provider(:foo, :priority => 5){ 'bar5' }
+      expect(c.take(:foo)).to eq 'bar5'
+      c.provider(:foo, :priority => 3){ 'bar3' }
+      expect(c.take(:foo)).to eq 'bar5'
+    end
   end
 end

data/spec/data_provider_spec.rb

@@ -153,4 +153,69 @@ describe "Exceptions" do
   it "can call missing methods" do
     expect { provider.take(:nomethod) }.to raise_error(NameError)
   end
-end
+end
+
+describe "#provider" do
+  describe ":priority" do
+
+    module PriorityHighModule
+      include DataProvider::Base
+
+      provider :foo, :priority => 12 do
+        'bar12'
+      end
+    end
+
+    module PriorityLowModule
+      include DataProvider::Base
+
+      provider :foo, :priority => 2 do
+        'bar2'
+      end
+    end
+
+    class PriorityClass
+      include DataProvider::Base
+
+      provider :foo do
+        'bar0'
+      end
+
+      provider :foo, :priority => 10 do
+        'bar10'
+      end
+
+      provider :foo, :priority => 5 do
+        'bar5'
+      end
+    end
+
+    class PrioritizedClass
+      include DataProvider::Base
+      add PriorityLowModule
+      add PriorityHighModule
+      provider :foo, :priority => 10 do
+        'bar10'
+      end
+    end
+
+    class UnprioritizedClass
+      include DataProvider::Base
+
+      provider :foo, :priority => 10 do
+        'bar10'
+      end
+
+      add PriorityHighModule
+      add PriorityLowModule
+    end
+
+    it "lets the owner specify a priority level or the provider" do
+      instance = PriorityClass.new
+      expect(instance.take(:foo)).to eq 'bar10'
+      expect(PrioritizedClass.new.take(:foo)).to eq 'bar12'
+      expect(UnprioritizedClass.new.take(:foo)).to eq 'bar12'
+    end
+
+  end # :priority
+end # #provider

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data-provider
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Mark van de Korput
@@ -14,28 +14,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
 description: A library of Ruby classes to help create consistent data interfaces
@@ -44,8 +44,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -70,17 +70,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A library of Ruby classes to help create consistent data interfaces