frenetic 2.0.0 → 3.0.0

data/spec/structure_registry_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Frenetic::StructureRegistry do
+  let(:retriever_class) { described_class::Retriever }
+
+  subject(:instance) do
+    Frenetic::StructureRegistry.new(retriever_class:retriever_class)
+  end
+
+  describe '#construct' do
+    let(:resource) { Class.new }
+    let(:attributes) do
+      {
+        'id' => 123
+      }
+    end
+    let(:key) { 'MockKey' }
+
+    subject { super().construct(resource, attributes, key) }
+
+    it 'returns an instantiated Structure class' do
+      expect(subject).to be_a Struct::MockKey
+    end
+
+    it 'assigns the specified attributes to the Struct instance' do
+      expect(subject.id).to eq 123
+    end
+
+    it 'registers the Struct' do
+      subject
+      expect(instance.signatures).to_not be_empty
+    end
+  end
+
+  describe '#fetch' do
+    let(:mock_retriever) { double('MockRetriever') }
+    let(:retriever_class) { double('MockRetrieverClass', new: mock_retriever) }
+    let(:resource) { Class.new }
+    let(:attributes) do
+      {
+        'id' => 123
+      }
+    end
+    let(:key) { 'MockKey' }
+
+    subject { super().fetch(resource, attributes, key) }
+
+    it 'invokes Frenetic::StructureRegistry::Retriever#call' do
+      allow(mock_retriever).to receive(:call)
+      subject
+      expect(mock_retriever).to have_received(:call)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frenetic
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Derek Lindahl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-28 00:00:00.000000000 Z
+date: 2015-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: rack-cache
   requirement: !ruby/object:Gem::Requirement
@@ -209,7 +209,8 @@ files:
 - lib/frenetic/concerns/hal_linked.rb
 - lib/frenetic/concerns/member_rest_methods.rb
 - lib/frenetic/concerns/persistence.rb
-- lib/frenetic/concerns/structured.rb
+- lib/frenetic/concerns/related.rb
+- lib/frenetic/concerns/structure_method_definer.rb
 - lib/frenetic/connection.rb
 - lib/frenetic/errors.rb
 - lib/frenetic/hypermedia_link.rb
@@ -218,13 +219,17 @@ files:
 - lib/frenetic/resource.rb
 - lib/frenetic/resource_collection.rb
 - lib/frenetic/resource_mockery.rb
+- lib/frenetic/structure_registry.rb
+- lib/frenetic/structure_registry/rebuilder.rb
+- lib/frenetic/structure_registry/retriever.rb
 - lib/frenetic/version.rb
 - spec/behaviors/alternate_string_identifier_spec.rb
 - spec/briefly_memoizable_spec.rb
 - spec/concerns/hal_linked_spec.rb
 - spec/concerns/member_rest_methods_spec.rb
 - spec/concerns/persistence_spec.rb
-- spec/concerns/structured_spec.rb
+- spec/concerns/related_spec.rb
+- spec/concerns/structure_method_definer_spec.rb
 - spec/connection_spec.rb
 - spec/fixtures/test_api_requests.rb
 - spec/frenetic_spec.rb
@@ -235,6 +240,9 @@ files:
 - spec/resource_mockery_spec.rb
 - spec/resource_spec.rb
 - spec/spec_helper.rb
+- spec/structure_registry/rebuilder_spec.rb
+- spec/structure_registry/retriever_spec.rb
+- spec/structure_registry_spec.rb
 - spec/support/i18n.rb
 - spec/support/rspec.rb
 - spec/support/timecop.rb
@@ -271,7 +279,8 @@ test_files:
 - spec/concerns/hal_linked_spec.rb
 - spec/concerns/member_rest_methods_spec.rb
 - spec/concerns/persistence_spec.rb
-- spec/concerns/structured_spec.rb
+- spec/concerns/related_spec.rb
+- spec/concerns/structure_method_definer_spec.rb
 - spec/connection_spec.rb
 - spec/fixtures/test_api_requests.rb
 - spec/frenetic_spec.rb
@@ -282,6 +291,9 @@ test_files:
 - spec/resource_mockery_spec.rb
 - spec/resource_spec.rb
 - spec/spec_helper.rb
+- spec/structure_registry/rebuilder_spec.rb
+- spec/structure_registry/retriever_spec.rb
+- spec/structure_registry_spec.rb
 - spec/support/i18n.rb
 - spec/support/rspec.rb
 - spec/support/timecop.rb

data/lib/frenetic/concerns/structured.rb

@@ -1,48 +0,0 @@
-class Frenetic
-  module Structured
-    # Stores the unique signature of each Resource Structure
-    # Used to determine when a Structure has changed and thus
-    # needs to be redefined.
-    @@signatures = {}
-
-    def struct_key
-      "#{self.class}::FreneticResourceStruct".gsub '::', ''
-    end
-
-    def signature
-      @attrs.keys.sort.join('')
-    end
-
-    def structure
-      if structure_expired?
-        rebuild_structure!
-      else
-        fetch_structure
-      end
-    end
-
-    def fetch_structure
-      Struct.const_get struct_key
-    end
-
-    def rebuild_structure!
-      destroy_structure!
-      @@signatures[struct_key] = signature
-      Struct.new(struct_key, *@attrs.keys)
-    end
-
-    def structure_expired?
-      @@signatures[struct_key] != signature
-    end
-
-    def structure_defined?
-      Struct.constants.include? struct_key.to_sym
-    end
-
-    def destroy_structure!
-      return unless structure_defined?
-      @@signatures.delete struct_key
-      Struct.send :remove_const, struct_key
-    end
-  end
-end

data/spec/concerns/structured_spec.rb

@@ -1,210 +0,0 @@
-require 'spec_helper'
-
-describe Frenetic::Structured do
-  let(:my_temp_resource) do
-    Class.new do
-      def initialize(attrs = {})
-        @attrs = attrs
-      end
-    end
-  end
-
-  let(:signatures) do
-    described_class.class_variable_get('@@signatures')
-  end
-
-  let(:signature) do
-    { 'MyTempResourceFreneticResourceStruct' => 'barfoo' }
-  end
-
-  before do
-    stub_const 'MyTempResource', my_temp_resource
-    MyTempResource.send :include, described_class
-  end
-
-  after { instance.destroy_structure! }
-
-  subject(:instance) { MyTempResource.new(foo:'foo', bar:'bar') }
-
-  describe '#struct_key' do
-    subject { super().struct_key }
-
-    it 'returns a valid, unique Ruby constant name' do
-      expect(subject).to eq 'MyTempResourceFreneticResourceStruct'
-    end
-  end
-
-  describe '#signature' do
-    subject { super().signature }
-
-    it 'returns a unique and predictable key' do
-      expect(subject).to eq 'barfoo'
-    end
-  end
-
-  describe '#structure' do
-    subject { super().structure }
-
-    context 'with no previously defined signature' do
-      before do
-        allow(instance).to receive(:structure_expired?).and_return(true)
-      end
-
-      it 'rebuilds the structure' do
-        allow(instance).to receive(:rebuild_structure!).and_call_original
-        subject
-        expect(instance).to have_received(:rebuild_structure!)
-      end
-    end
-
-    context 'with a fresh signature' do
-      before do
-        instance.structure
-        allow(instance).to receive(:structure_expired?).and_return(false)
-      end
-
-      it 'does not rebuild the structure' do
-        allow(instance).to receive(:rebuild_structure!)
-        subject
-        expect(instance).to_not have_received(:rebuild_structure!)
-      end
-    end
-
-    context 'with an expired signature' do
-      before do
-        instance.structure
-        allow(instance).to receive(:structure_expired?).and_return(true)
-      end
-
-      it 'rebuilds the structure' do
-        allow(instance).to receive(:rebuild_structure!)
-        subject
-        expect(instance).to have_received(:rebuild_structure!)
-      end
-    end
-  end
-
-  describe '#fetch_structure' do
-    before { instance.structure }
-
-    subject { super().fetch_structure }
-
-    it 'returns the Struct class of the resource' do
-      expect(subject).to eq Struct::MyTempResourceFreneticResourceStruct
-    end
-  end
-
-  describe '#rebuild_structure!' do
-    before{ instance.structure }
-
-    subject { super().rebuild_structure! }
-
-    it 'destroys the previous Struct' do
-      allow(instance).to receive(:destroy_structure!).and_call_original
-      subject
-      expect(instance).to have_received(:destroy_structure!)
-    end
-
-    it 'caches the signature of the resource' do
-      subject
-      expect(signatures).to include signature
-    end
-
-    it 'builds the Struct resource' do
-      subject
-      expect(instance.fetch_structure.members).to eq [:foo, :bar]
-    end
-  end
-
-  describe '#structure_expired?' do
-    subject { super().structure_expired? }
-
-    before do
-      allow(instance).to receive(:signature).and_return(new_sig)
-      described_class.class_variable_set(
-        '@@signatures',
-        'MyTempResourceFreneticResourceStruct' => old_sig
-      )
-    end
-
-    context 'with a fresh signature' do
-      let(:old_sig) { 'fresh' }
-      let(:new_sig) { 'fresh' }
-
-      it 'return FALSE' do
-        expect(subject).to eq false
-      end
-    end
-
-    context 'with no predefined signature' do
-      let(:old_sig) { nil }
-      let(:new_sig) { 'new' }
-
-      it 'returns TRUE' do
-        expect(subject).to eq true
-      end
-    end
-
-    context 'with an expired signature' do
-      let(:old_sig) { 'old' }
-      let(:new_sig) { 'new' }
-
-      it 'returns TRUE' do
-        expect(subject).to eq true
-      end
-    end
-  end
-
-  describe '#structure_defined?' do
-    let(:consts) { Struct.constants || [] }
-
-    before do
-      allow(Struct).to receive(:constants).and_return(consts)
-    end
-
-    subject { super().structure_defined? }
-
-    it 'checks if the structure is defined' do
-      allow(instance).to receive(:struct_key).and_return('Foo')
-      allow(consts).to receive(:include?)
-      subject
-      expect(consts).to have_received(:include?).with(:Foo)
-    end
-  end
-
-  describe '#destroy_structure!' do
-    before { instance.structure }
-
-    subject { super().destroy_structure! }
-
-    context 'with an undefined structure' do
-      before { instance.destroy_structure! }
-
-      it 'does not attempt to remove the constant from the Struct' do
-        allow(Struct).to receive(:remove_const)
-        subject
-        expect(Struct).to_not have_received(:remove_const)
-      end
-
-      it 'does not remove the signature from the cache' do
-        allow(signatures).to receive(:delete)
-        subject
-        expect(signatures).to_not receive(:delete)
-      end
-    end
-
-    context 'with an predefined structure' do
-      it 'removes the constant' do
-        expect(Struct.constants).to include instance.struct_key.to_sym
-        subject
-        expect(Struct.constants).to_not include instance.struct_key.to_sym
-      end
-
-      it 'removes the signature from the cache' do
-        expect(signatures).to include signature
-        subject
-        expect(signatures).to_not include signature
-      end
-    end
-  end
-end