praxis-blueprints 3.1 → 3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87521372774c1c5885e1524ba24c931b6c37cdf2
-  data.tar.gz: edcd9ea3c1ea8ca0a874bc8d13f5caa6c050e10d
+  metadata.gz: e3679f890d11a1474437b9018c7030a909e050ca
+  data.tar.gz: 61094297c27f94f4add6227d637654fae03ed662
 SHA512:
-  metadata.gz: 4133d88711c6b0d46055c61b483525047463e16e2dc17baa12cd5ac99494e9966e46c828c125826f90afaf4933c4c6d0c12a83dad1036c597741ae8b67da0545
-  data.tar.gz: a4478e4777276bd98aab92494cf7f38b249451d88047457ad90afafaf7c5f704ab7c2a45858f140158817705a14c57e66018adc47d9577fa32ea1baaaa8fe560
+  metadata.gz: aa633b4772c07f859fd4024044a618c2243b5b6d95678dd7c0757486811dc1a315eafde12319c4c4215b72571d0d38f7ccdae7d91903183aa14c1baaaa86ae58
+  data.tar.gz: 47e3c62fd5bdfa05c142083e7053687d57d25fd2b08b3a5b2dd913050cbaf94a9ccfb699707e1c1e43f6384ce25e4688beaed9cb81a39038080eff2155e9c979

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## next
 
+## 3.2
+
+* Ensure we call `object.dump` in Renderer when fully dumping an instance (or array of instances) that have the Attributor::Dumpable module (i.e., when no subfields were selected)
+  * In other words, attributor types (custom or not) will need to include the Attributor::Dumpable module and properly implement the dump instance method to produce the right output with native ruby objects.
+* Ensure `Blueprint` validates advanced requirements.
+
 ## 3.1
 
 * Reworked FieldExpander's behavior with circular references.

data/lib/praxis-blueprints/blueprint.rb

@@ -193,7 +193,6 @@ module Praxis
 
 
     def self.validate(value, context=Attributor::DEFAULT_ROOT_CONTEXT, _attribute=nil)
-
       raise ArgumentError, "Invalid context received (nil) while validating value of type #{self.name}" if context == nil
       context = [context] if context.is_a? ::String
 
@@ -341,19 +340,29 @@ module Praxis
     def validate(context=Attributor::DEFAULT_ROOT_CONTEXT)
       raise ArgumentError, "Invalid context received (nil) while validating value of type #{self.name}" if context == nil
       context = [context] if context.is_a? ::String
+      keys_with_values = []
 
       raise "validation conflict" if @validating
       @validating = true
 
-      self.class.attributes.each_with_object(Array.new) do |(sub_attribute_name, sub_attribute), errors|
+      errors = []
+      self.class.attributes.each do |sub_attribute_name, sub_attribute|
         sub_context = self.class.generate_subcontext(context,sub_attribute_name)
         value = self.send(sub_attribute_name)
+        unless value.nil?
+          keys_with_values << sub_attribute_name
+        end
 
         if value.respond_to?(:validating) # really, it's a thing with sub-attributes
           next if value.validating
         end
         errors.push(*sub_attribute.validate(value, sub_context))
       end
+      self.class.attribute.type.requirements.each do |req|
+        validation_errors = req.validate(keys_with_values, context)
+        errors.push(*validation_errors) unless validation_errors.empty?
+      end
+      errors
     ensure
       @validating = false
     end

data/lib/praxis-blueprints/collection_view.rb

@@ -5,10 +5,18 @@ module Praxis
       super(name,schema)
 
       if member_view
-        @contents = member_view.contents.clone
+        @_lazy_view = member_view
       end
     end
 
+    def contents
+      if @_lazy_view
+        @contents = @_lazy_view.contents.clone
+        @_lazy_view = nil
+      end
+      super
+    end
+
     def example(context=Attributor::DEFAULT_ROOT_CONTEXT)
       collection = 3.times.collect do |i|
         subcontext = context + ["at(#{i})"]

data/lib/praxis-blueprints/renderer.rb

@@ -55,7 +55,14 @@ module Praxis
     end
 
     def _render(object, fields, view=nil, context: Attributor::DEFAULT_ROOT_CONTEXT)
-      return object if fields == true
+      if fields == true
+        return case object
+        when Attributor::Dumpable
+          object.dump
+        else
+          object
+        end
+      end
 
       notification_payload = {
         blueprint: object,
@@ -74,7 +81,12 @@ module Praxis
           next if value.nil? && !self.include_nil
 
           if subfields == true
-            hash[key] = value
+            hash[key] = case value
+            when Attributor::Dumpable
+              value.dump
+            else
+              value
+            end
           else
             new_context = context + [key]
             hash[key] = self.render(value, subfields, context: new_context)

data/lib/praxis-blueprints/version.rb

@@ -1,3 +1,3 @@
 module Praxis
-  BLUEPRINTS_VERSION = "3.1"
+  BLUEPRINTS_VERSION = "3.2"
 end

data/praxis-blueprints.gemspec

@@ -20,7 +20,7 @@ it results in a structured hash instead of an encoded string. Blueprints can aut
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency(%q<randexp>, ["~> 0"])
-  spec.add_runtime_dependency(%q<attributor>, [">= 4.2"])
+  spec.add_runtime_dependency(%q<attributor>, [">= 5.0.2"])
   spec.add_runtime_dependency(%q<activesupport>, [">= 3"])
 
   spec.add_development_dependency "bundler", "~> 1.6"

data/spec/praxis-blueprints/blueprint_spec.rb

@@ -177,10 +177,16 @@ describe Praxis::Blueprint do
     let(:example_object) { nil }
 
     before do
-      expect(blueprint_class.attribute.type).to receive(:describe).with(shallow, example: example_object).and_call_original #.and_return(type_describe)
+      expect(blueprint_class.attribute.type).to receive(:describe).with(shallow, example: example_object).ordered.and_call_original
     end
 
     context 'for non-shallow descriptions' do
+      before do
+        # Describing a Person also describes the :myself and :friends attributes. They are both a Person and a Coll of Person.
+        # This means that Person type `describe` is called two more times, thes times with shallow=true
+        expect(blueprint_class.attribute.type).to receive(:describe).with(true, example: example_object).twice.and_call_original
+      end
+
       subject(:output){ blueprint_class.describe }
 
       its([:name]){ should eq(blueprint_class.name)}
@@ -224,6 +230,12 @@ describe Praxis::Blueprint do
       let(:shallow) { false }
 
       subject(:output) { blueprint_class.describe(false, example: example) }
+      before do
+        # Describing a Person also describes the :myself and :friends attributes. They are both a Person and a Coll of Person.
+        # This means that Person type `describe` is called two more times, thes times with shallow=true
+        expect(blueprint_class.attribute.type).to receive(:describe)
+          .with(true, example: an_instance_of(blueprint_class.attribute.type)).twice.and_call_original
+      end
 
       it 'outputs examples for leaf values using the provided example' do
         output[:attributes][:name][:example].should eq example.name

data/spec/praxis-blueprints/collection_view_spec.rb

@@ -32,6 +32,19 @@ describe Praxis::CollectionView do
     it 'gets the proper contents' do
       collection_view.contents.should eq member_view.contents
     end
+
+    context 'lazy initializes its contents' do
+
+      it 'so it will not call contents until it is first needed' do
+        member_view.stub(:contents){ raise 'No!' }
+        expect{ collection_view.name }.to_not raise_error
+      end
+      it 'when contents is needed, it will clone it from the member_view' do
+        # Twice is because we're callong member_view.contents for the right side of the equality
+        expect(member_view).to receive(:contents).twice.and_call_original
+        collection_view.contents.should eq member_view.contents
+      end
+    end
   end
 
   context 'creating with a set of attributes defined in a block' do

data/spec/praxis-blueprints/renderer_spec.rb

@@ -4,13 +4,21 @@ describe Praxis::Renderer do
 
   let(:address) { Address.example }
   let(:prior_addresses) { 2.times.collect { Address.example } }
+  let(:alias_one) { FullName.example }
+  let(:alias_two) { FullName.example }
+  let(:aliases) { [alias_one, alias_two] }
+  let(:metadata_hash) { { something: 'here' } }
+  let(:metadata) { Attributor::Hash.load( metadata_hash ) }
+
   let(:person) do
      Person.example(
       address: address,
       email: nil,
       prior_addresses: prior_addresses,
       alive: false,
-      work_address: nil
+      work_address: nil,
+      aliases: aliases,
+      metadata: metadata
     )
   end
 
@@ -27,7 +35,9 @@ describe Praxis::Renderer do
       },
       prior_addresses: [{name: true}],
       work_address: true,
-      alive: true
+      alive: true,
+      metadata: true,
+      aliases: [true]
     }
   end
 
@@ -36,7 +46,7 @@ describe Praxis::Renderer do
   subject(:output) { renderer.render(person, fields) }
 
   it 'renders existing attributes' do
-    output.keys.should match_array([:name, :full_name, :alive, :address, :prior_addresses])
+    output.keys.should match_array([:name, :full_name, :alive, :address, :prior_addresses, :metadata, :aliases])
 
     output[:name].should eq person.name
     output[:full_name].should eq({first: person.full_name.first, last: person.full_name.last})
@@ -50,6 +60,23 @@ describe Praxis::Renderer do
 
     expected_prior_addresses = prior_addresses.collect { |addr| {name: addr.name} }
     output[:prior_addresses].should match_array(expected_prior_addresses)
+
+    expected_aliases = aliases.collect { |the_alias| the_alias.dump }
+    output[:aliases].should match_array( expected_aliases )
+
+    output[:metadata].should eq( metadata.dump )
+  end
+
+  context 'calls dump for non-Blueprint, but still Dumpable instances' do
+    it 'when rendering them in full as array members' do
+      alias_one.should_receive(:dump).and_call_original
+      output[:aliases].first.should eq( first: alias_one.first, last: alias_one.last )
+    end
+    it 'when rendering them in full as leaf object' do
+      metadata.should_receive(:dump).and_call_original
+      output[:metadata].should eq( metadata_hash )
+    end
+
   end
 
   it 'does not render attributes with nil values' do
@@ -150,4 +177,47 @@ describe Praxis::Renderer do
     end
 
   end
+
+  context 'rendering hashes' do
+    let(:fields) do
+      {
+        id: true,
+        hash: true
+      }
+    end
+
+    let(:data) { {id: 10, hash: {foo: 'bar'}} }
+    let(:object) { SimpleHash.load(data)}
+    let(:renderer) { Praxis::Renderer.new }
+
+    subject(:output) { renderer.render(object, fields) }
+
+    its([:id]) { should eq data[:id] }
+    its([:hash]) { should eq data[:hash] }
+    its([:hash]) { should be_kind_of(Hash) }
+  end
+
+  context 'rendering collections of hashes' do
+    let(:fields) do
+      {
+        id: true,
+        hash_collection: [true]
+      }
+    end
+
+    let(:data) { {id: 10, hash_collection: [{foo: 'bar'}]} }
+    let(:object) { SimpleHashCollection.load(data)}
+    let(:renderer) { Praxis::Renderer.new }
+
+    subject(:output) { renderer.render(object, fields) }
+
+    its([:id]) { should eq data[:id] }
+    its([:hash_collection]) { should eq data[:hash_collection] }
+    its([:hash_collection]) { should be_kind_of(Array) }
+
+    it 'renders the hashes' do
+      expect(output[:hash_collection].first).to be_kind_of(Hash)
+    end
+  end
+
 end

data/spec/praxis-blueprints/view_spec.rb

@@ -72,6 +72,24 @@ describe Praxis::View do
         end
       end
 
+      context 'that reference the enclosing view' do
+        let(:view) { Person.views.fetch(:self_referencing) }
+        context 'for non-collection attributes' do
+          it 'the view points exactly to parent view' do
+            contents[:myself].should be_kind_of(Praxis::View)
+            contents[:myself].should be(view)
+            contents[:myself].contents.should eq(view.contents)
+          end
+        end
+        context 'for collection attributes' do
+          it 'creates the sub-CollectionViews with a member view with the same contents of the parent' do
+            contents[:friends].should be_kind_of(Praxis::CollectionView)
+            contents[:friends].contents.should eq(view.contents)
+            contents[:friends].contents.keys.should match_array([:myself,:friends])
+          end
+        end
+
+      end
     end
 
   end

data/spec/support/spec_blueprints.rb

@@ -20,6 +20,9 @@ class Person < Praxis::Blueprint
     attribute :tags, Attributor::Collection.of(String)
     attribute :href, String
     attribute :alive, Attributor::Boolean, default: true
+    attribute :myself, Person
+    attribute :friends, Attributor::Collection.of(Person)
+    attribute :metadata, Attributor::Hash
   end
 
   view :default do
@@ -33,6 +36,11 @@ class Person < Praxis::Blueprint
     attribute :address, view: :circular
   end
 
+  view :self_referencing do
+    attribute :myself, view: :self_referencing
+    attribute :friends, view: :self_referencing
+  end
+
   view :current do
     attribute :name
     attribute :full_name
@@ -94,3 +102,19 @@ class FullName < Attributor::Model
   end
 
 end
+
+
+class SimpleHash  < Attributor::Model
+  attributes do
+    attribute :id, Integer
+    attribute :hash,  Hash
+  end
+end
+
+
+class SimpleHashCollection < Attributor::Model
+  attributes do
+    attribute :id, Integer
+    attribute :hash_collection, Attributor::Collection.of(Hash)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis-blueprints
 version: !ruby/object:Gem::Version
-  version: '3.1'
+  version: '3.2'
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-29 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 5.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement