shamu 0.0.20 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 984152520f292cc5454b58d1a2622cb4baa4b22c
-  data.tar.gz: 82fbc5924edd73df6e0111e9ad6a1f13226d1774
+  metadata.gz: 6cae4307a05211be596027da64335d8e7ea8a873
+  data.tar.gz: 11c2070a6bab4b24e9770dbb6c92bd00f39b10ca
 SHA512:
-  metadata.gz: 1be5f5704edb9aee60b15c57379efb7c736179c54dc9fe4b4463ed1323ed31ccafe2a4311205a358071f5a34b14409897c73ad4760eda7970882091ae49395b5
-  data.tar.gz: 821a2d3666993ccf08ca3cbfb71292368ccf8153d719c1d9edfbbf514005c3769d94724a8d5e023be8859c70ed365db636127c5b0f7c004fca2da5750150c70b
+  metadata.gz: 626bd61e2a680af882d36bea800ce9229213e92dd0b1c474dd81aba7834768ea5659b87ec3294cdd59b077885a24a7869fa848b77eade04fa0971394f56a76fe
+  data.tar.gz: 9b3bab05830afd1b09bb9662348a6e404d7b03e2e817407afb5d0b70e035a20a3f3e1358bbab4bdbadbe1e072c755382b933bcd2122a6a4ff296e85964501ace

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shamu (0.0.20)
+    shamu (0.0.21)
       activemodel (>= 5.0)
       activesupport (>= 5.0)
       crc32 (~> 1)
@@ -104,7 +104,7 @@ GEM
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     lumberjack (1.0.12)
-    mail (2.6.5)
+    mail (2.6.6)
       mime-types (>= 1.16, < 4)
     method_source (0.8.2)
     mime-types (3.1)

data/lib/shamu/entities.rb

@@ -9,6 +9,7 @@ module Shamu
     require "shamu/entities/identity_cache"
     require "shamu/entities/entity_path"
     require "shamu/entities/html_sanitation"
+    require "shamu/entities/static_repository"
     require "shamu/entities/entity_lookup_service"
     require "shamu/entities/opaque_id"
     require "shamu/entities/opaque_entity_lookup_service"

data/lib/shamu/entities/static_repository.rb

@@ -0,0 +1,83 @@
+module Shamu
+  module Entities
+
+    # Implements an in-memory store of entities for static entities (rich enum
+    # types) offering standard read methods #find, #lookup and #list.
+    class StaticRepository
+
+      def initialize( entities, missing_entity_class: nil )
+        raise ArgumentError, :entities if entities.map( &:id ).count != entities.map( &:id ).uniq.count
+
+        entities = entities.dup.freeze unless entities.frozen?
+
+        @entities             = entities
+        @missing_entity_class = missing_entity_class || NullEntity.for( entities.first.class )
+        @lookup_cache         = {}
+      end
+
+      # Find an entity with the given value on the named attribute.
+      #
+      # @param [Object] value to look for.
+      # @param [Symbol] attribute to interrogate.
+      # @return [Entity] the entity if found.
+      # @raise [Shamu::NotFoundError] if the entity could not be found.
+      def find_by( attribute, value )
+        cache = attribute_cache( attribute )
+        cache.fetch value do
+          cache[ value ] = find_by_attribute( attribute, value )
+        end
+      end
+
+      # Find an entity with the given id.
+      #
+      # @return [Entity] the entity if found.
+      # @raise [Shamu::NotFoundError] if the entity could not be found.
+      def find( id = :not_set, &block )
+        raise ArgumentError, :id if id == :not_set && !block_given?
+
+        value = block_given? ? yield : find_by( :id, id )
+        value || not_found!
+      end
+
+      # Lookup all the entities in the repository with the given ids.
+      # @param [Array<Integer>] ids
+      # @return [List<Entity>] the matching entities.
+      def lookup( *ids )
+        cache = attribute_cache( :id )
+        matching = ids.map do |id|
+          entity = cache.fetch( id ) do
+            entities.find { |e| e.id == id }
+          end
+
+          entity || missing_entity_class.new
+        end
+
+        List.new matching
+      end
+
+      # @return [List<Entity>] all the entities in the repository.
+      def list
+        List.new entities
+      end
+
+      private
+
+        attr_reader :entities, :missing_entity_class
+
+        def not_found!
+          raise Shamu::NotFoundError
+        end
+
+        def attribute_cache( attribute )
+          @lookup_cache.fetch( attribute ) do
+            @lookup_cache[ attribute ] = {}
+          end
+        end
+
+        def find_by_attribute( attribute, value )
+          entities.find { |e| e.send( attribute ) == value } || not_found!
+        end
+
+    end
+  end
+end

data/lib/shamu/services/service.rb

@@ -340,14 +340,6 @@ module Shamu
           end
         end
 
-        # @param [String,Integer,#to_model_id] value
-        # @return [Boolean] true if the value looks like an ID.
-        def model_id?( value )
-          case Array( value ).first
-          when Integer then true
-          when String  then ToModelIdExtension::Strings::NUMERIC_PATTERN =~ value
-          end
-        end
     end
   end
 end

data/lib/shamu/to_model_id_extension.rb

@@ -6,6 +6,15 @@ module Shamu
   # models by id.
   module ToModelIdExtension
 
+    # @param [String,Integer,#to_model_id] value
+    # @return [Boolean] true if the value looks like an ID.
+    def self.model_id?( value )
+      case Array( value ).first
+      when Integer then true
+      when String  then ToModelIdExtension::Strings::NUMERIC_PATTERN =~ value
+      end
+    end
+
     # Extend common classes to add `to_model_id` method.
     def self.extend!
       Integer.include Integers

data/lib/shamu/version.rb

@@ -2,7 +2,7 @@
 
 module Shamu
   # The primary version number
-  VERSION_NUMBER  = "0.0.20"
+  VERSION_NUMBER  = "0.0.21"
 
   # Version suffix such as 'beta' or 'alpha'
   VERSION_SUFFIX  = ""

data/spec/lib/shamu/entities/static_repository_spec.rb

@@ -0,0 +1,129 @@
+require "spec_helper"
+
+module StaticRepositorySpec
+  class Entity < Shamu::Entities::Entity
+    attribute :id
+    attribute :name
+  end
+end
+
+describe Shamu::Entities::StaticRepository do
+  let( :entities ) do
+    [
+      scorpion.fetch( StaticRepositorySpec::Entity, { id: 10, name: "First" }, {} ),
+      scorpion.fetch( StaticRepositorySpec::Entity, { id: 20, name: "Last" }, {} ),
+    ]
+  end
+  let( :repository ) do
+    Shamu::Entities::StaticRepository.new entities
+  end
+
+  it "does not allow duplicate keys" do
+    expect do
+      Shamu::Entities::StaticRepository.new [
+        StaticRepositorySpec::Entity.new( id: 1 ),
+        StaticRepositorySpec::Entity.new( id: 1 ),
+      ]
+    end.to raise_exception ArgumentError
+  end
+
+  it "requires at least one entity" do
+    expect do
+      Shamu::Entities::StaticRepository.new
+    end.to raise_exception ArgumentError
+  end
+
+  describe "#find" do
+    it "finds by id" do
+      expect( repository.find( 10 ) ).to be entities.first
+    end
+
+    it "raises when not found" do
+      expect do
+        repository.find( 0 )
+      end.to raise_exception Shamu::NotFoundError
+    end
+
+    it "yields to block" do
+      expect do |b|
+        repository.find do
+          b.to_proc.call
+          true
+        end
+      end.to yield_control
+    end
+
+    it "raises if no argument and no block" do
+      expect do
+        repository.find
+      end.to raise_exception ArgumentError
+    end
+
+    it "raises when not found by block" do
+      expect do
+        repository.find { false }
+      end.to raise_exception Shamu::NotFoundError
+    end
+  end
+
+  describe "#find_by" do
+    it "finds by id" do
+      expect( repository.find_by( :id, 10 ) ).to be entities.first
+    end
+
+    it "raises when not found" do
+      expect do
+        repository.find_by :id, 0
+      end.to raise_exception Shamu::NotFoundError
+    end
+
+    it "caches lookup" do
+      expect( repository ).to receive( :find_by_attribute ).and_call_original
+      repository.find_by :id, 10
+
+      expect( repository ).not_to receive( :find_by_attribute )
+      repository.find_by :id, 10
+    end
+
+    it "finds by name" do
+      expect( repository.find_by( :name, "Last" ) ).to be entities.last
+    end
+
+    it "caches lookup by name" do
+      expect( repository ).to receive( :find_by_attribute ).and_call_original
+      repository.find_by( :name, "First" )
+
+      expect( repository ).not_to receive( :find_by_attribute )
+      repository.find_by( :name, "First" )
+    end
+  end
+
+  describe "#lookup" do
+    it "finds all ids" do
+      list = repository.lookup 10, 20
+      expect( list.to_a ).to eq entities
+    end
+
+    it "uses missing entity if not found" do
+      list = repository.lookup 20, 30
+
+      expect( list.first ).to be entities.last
+      expect( list.last ).not_to be_present
+    end
+
+    it "returns an Entities::List" do
+      expect( repository.lookup ).to be_a Shamu::Entities::List
+    end
+  end
+
+  describe "#list" do
+    it "lists all records" do
+      expect( repository.list.to_a ).to eq entities
+    end
+
+    it "returns an Entities::List" do
+      expect( repository.list ).to be_a Shamu::Entities::List
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shamu
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.21
 platform: ruby
 authors:
 - Paul Alexander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-14 00:00:00.000000000 Z
+date: 2017-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -265,6 +265,7 @@ files:
 - lib/shamu/entities/opaque_entity_lookup_service.rb
 - lib/shamu/entities/opaque_id.rb
 - lib/shamu/entities/paged_list.rb
+- lib/shamu/entities/static_repository.rb
 - lib/shamu/error.rb
 - lib/shamu/events.rb
 - lib/shamu/events/README.md
@@ -404,6 +405,7 @@ files:
 - spec/lib/shamu/entities/opaque_entity_lookup_service_spec.rb
 - spec/lib/shamu/entities/opaque_id_spec.rb
 - spec/lib/shamu/entities/paged_list_spec.rb
+- spec/lib/shamu/entities/static_repository_spec.rb
 - spec/lib/shamu/events/active_record/migration_spec.rb
 - spec/lib/shamu/events/active_record/service_spec.rb
 - spec/lib/shamu/events/events_service_spec.rb
@@ -526,6 +528,7 @@ test_files:
 - spec/lib/shamu/entities/opaque_entity_lookup_service_spec.rb
 - spec/lib/shamu/entities/opaque_id_spec.rb
 - spec/lib/shamu/entities/paged_list_spec.rb
+- spec/lib/shamu/entities/static_repository_spec.rb
 - spec/lib/shamu/events/active_record/migration_spec.rb
 - spec/lib/shamu/events/active_record/service_spec.rb
 - spec/lib/shamu/events/events_service_spec.rb