praxis-blueprints 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5352b37878c8f506236cce34e6d90b9bc079329
-  data.tar.gz: 6d02549269a82673793858e741f847c9519ea401
+  metadata.gz: 54c80c09733228cb18f5fdc35ae05054bd0727a4
+  data.tar.gz: 90eba917e0f3d2651d840333fe5d81b94a13428b
 SHA512:
-  metadata.gz: 585e2c0318453b71e023ad11cc427e657ce4c09320ce78e1081790267c6b2289a635ccdc853a9c30dcc1f9aec78bbdd0b27616e551ab26ba373f1a9451ba5745
-  data.tar.gz: 036eaaf49beda62497ec5cb3a34cf115224ce856741a9f8bd1fa8e9db0ac66f2b5e5ee80d741b04765da87a58ec9d32ec10bde392b50322f142853f112e8e450
+  metadata.gz: 5f307971333a02b445884d4e3a514b4a20c4bca46fa9fe38aed65e7fec34b717f0a02afbd520ef0ac3d601a396b7554f6af73cfe1a7cc23bb56ef76b0b2ba814
+  data.tar.gz: 1d375284f3af2b1d32ea79b06c0677b3588696d377840297ebfa71a473f79286bbed6ce7d5a4ef85b3c92988f1b4062df108be8cff48b5141aebf8f3d605d5f3

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+cache: bundler
 rvm:
   - "2.1.2"
 script: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,10 +1,19 @@
 # praxis-blueprints changelog
 
+## next
+
+* next thing here
+
+## 1.1.0
+
+* Added CollectionView, a special type of view that renders an array of objects with another view.
+
 
 ## 1.0.1
 
 * Relaxed ActiveSupport version dependency (from 4 to >=3)
 
+
 ## 1.0
 
 Initial release!

data/lib/praxis-blueprints.rb

@@ -11,4 +11,4 @@ require 'praxis-blueprints/config_hash'
 
 require 'praxis-blueprints/blueprint'
 require 'praxis-blueprints/view'
-
+require 'praxis-blueprints/collection_view'

data/lib/praxis-blueprints/blueprint.rb

@@ -231,7 +231,8 @@ module Praxis
       if @block
         self.define_attribute!
         self.define_readers!
-        self.generate_master_view!
+        # Don't blindly override a master view if the MediaType wants to define it on its own
+        self.generate_master_view! unless self.view(:master)
       end
       super
     end

data/lib/praxis-blueprints/collection_view.rb

@@ -0,0 +1,31 @@
+module Praxis
+
+  class CollectionView
+    attr_reader :name, :schema, :using
+
+    def initialize(name, schema, using)
+      @name = name
+      @schema = schema
+      @using = using
+    end
+
+    def dump(collection, context: Attributor::DEFAULT_ROOT_CONTEXT,**opts)
+      collection.collect.with_index do |object, i|
+        subcontext = context + ["at(#{i})"]
+        using.dump(object, context: subcontext, **opts)
+      end
+    end
+
+    def example(context=Attributor::DEFAULT_ROOT_CONTEXT)
+      collection = self.schema.example(context)
+      opts = {}
+      opts[:context] = context if context
+      self.dump(collection, opts)
+    end
+
+    def describe
+      using.describe.merge(type: :collection)
+    end
+
+  end
+end

data/lib/praxis-blueprints/version.rb

@@ -1,3 +1,3 @@
 module Praxis
-  BLUEPRINTS_VERSION = "1.0.1"
+  BLUEPRINTS_VERSION = "1.1.0"
 end

data/lib/praxis-blueprints/view.rb

@@ -34,7 +34,7 @@ module Praxis
         next if value.nil?
         
         # FIXME: this is such an ugly way to do this. Need attributor#67.
-        if dumpable.kind_of?(View)
+        if dumpable.kind_of?(View) || dumpable.kind_of?(CollectionView)
           new_context = context + [name]
           hash[name] = dumpable.dump(value, context: new_context ,**(dumpable_opts||{}))
         else
@@ -86,7 +86,7 @@ module Praxis
         view_attributes[k] = inner_desc
       end
 
-      { attributes: view_attributes }
+      { attributes: view_attributes, type: :standard }
     end
 
   end

data/spec/praxis-blueprints/blueprint_spec.rb

@@ -4,7 +4,6 @@ describe Praxis::Blueprint do
 
   subject(:blueprint_class) { Person }
 
-
   context 'deterministic examples' do
     it 'works' do
       person_1 = Person.example('person 1')
@@ -293,61 +292,37 @@ describe Praxis::Blueprint do
  end
 
  context '#render' do
-   let(:person) { Person.example }
-   let(:view_name) { :default }
-   subject(:output) { person.render(view_name) }
-
-   context 'with a sub-attribute that is a blueprint' do
+  let(:person) { Person.example }
+  let(:view_name) { :default }
+  subject(:output) { person.render(view_name) }
 
-     it { should have_key(:name) }
-     it { should have_key(:address) }
-     it 'renders the sub-attribute correctly' do
-       output[:address].should have_key(:street)
-       output[:address].should have_key(:state)
-     end
+  context 'with a sub-attribute that is a blueprint' do
 
-     it 'reports a dump error with the appropriate context' do
-       person.address.should_receive(:state).and_raise("Kaboom")
-       expect {
-         person.render(view_name, context: ['special_root'])
-       }.to raise_error(/Error while dumping attribute state of type Address for context special_root.address .*. Reason: .*Kaboom/)
-     end
-   end
-
-
-   context 'with sub-attribute that is an Attributor::Model' do
-     it { should have_key(:full_name) }
-     it 'renders the model correctly' do
-       output[:full_name].should be_kind_of(Hash)
-       output[:full_name].should have_key(:first)
-       output[:full_name].should have_key(:last)
-     end
-   end
-
-
-   # context 'with circular references' do
-   #   let(:view_name) { :master }
+    it { should have_key(:name) }
+    it { should have_key(:address) }
+    it 'renders the sub-attribute correctly' do
+      output[:address].should have_key(:street)
+      output[:address].should have_key(:state)
+    end
 
-   #   # TODO: think about circular references without caching
-   #   around do |example|
-   #     Praxis::Blueprint.caching_enabled = true
-   #     example.run
-   #     Praxis::Blueprint.caching_enabled = false
-   #   end
+    it 'reports a dump error with the appropriate context' do
+      person.address.should_receive(:state).and_raise("Kaboom")
+      expect {
+        person.render(view_name, context: ['special_root'])
+      }.to raise_error(/Error while dumping attribute state of type Address for context special_root.address .*. Reason: .*Kaboom/)
+    end
+  end
 
-   #   it 'terminates' do
-   #     expect {
-   #       Person.example.render(:master)
-   #     }.to_not raise_error
-   #   end
 
-   #   it 'renders Praxis::Blueprint::CIRCULAR_REFERENCE_MARKER for circular references' do
-   #     person.address.resident.should be(person)
-   #     output[:address][:resident].should eq(Praxis::Blueprint::CIRCULAR_REFERENCE_MARKER)
-   #   end
+  context 'with sub-attribute that is an Attributor::Model' do
+    it { should have_key(:full_name) }
+    it 'renders the model correctly' do
+      output[:full_name].should be_kind_of(Hash)
+      output[:full_name].should have_key(:first)
+      output[:full_name].should have_key(:last)
+    end
+  end
 
-   # end
-   
  end
 
 end

data/spec/praxis-blueprints/collection_view_spec.rb

@@ -0,0 +1,59 @@
+require_relative '../spec_helper'
+
+describe Praxis::CollectionView do
+
+  let(:collection_schema) { double(:collection_schema) }
+
+  let(:people) { [Person.example('p-1'), Person.example('p-2')] }
+
+
+  let(:member_view) do
+    Praxis::View.new(:tiny, Person) do
+      attribute :name
+      attribute :address, view: :state
+    end
+  end
+
+  let(:collection_view) do
+    Praxis::CollectionView.new(:collection_view, collection_schema, member_view)
+  end
+
+  let(:root_context) { ['people'] }
+
+  context '#dump' do
+    before do
+      people.each_with_index do |person, i|
+        subcontext = root_context + ["at(#{i})"]
+        expect(member_view).to(
+          receive(:dump).
+          with(person, context: subcontext).
+        and_call_original)
+      end
+    end
+
+    subject(:output) { collection_view.dump(people, context: root_context) }
+
+    it { should be_kind_of(Array) }
+  end
+
+  context '#example' do
+    it 'generates an example from the schema and renders it' do
+      expect(collection_schema).to(
+        receive(:example).
+        with(root_context).
+        and_return(people)
+      )
+      expect(collection_view).to receive(:dump).and_call_original
+
+      collection_view.example(root_context)
+    end
+  end
+
+  context '#describe' do
+    subject(:description) { collection_view.describe }
+
+    its([:attributes]) { should eq(member_view.describe[:attributes]) }
+    its([:type]) { should eq(:collection) }
+  end
+
+end

data/spec/praxis-blueprints/view_spec.rb

@@ -220,10 +220,9 @@ describe Praxis::View do
       end
 
       it { should eq expected_output }
-
-
     end
 
+
     context 'with a specified view' do
       let(:view) do
         Praxis::View.new(:default, Person) do
@@ -243,59 +242,12 @@ describe Praxis::View do
     end
 
   end
-  # context 'with embedded related objects' do
-  #   context '#embed' do
-  #     let(:view) do
-  #       Praxis::View.new(:default, Person) do
-  #         attribute :name
-  #         embed :address
-  #       end
-  #     end
-
-  #     let(:expected_output) do
-  #       {
-  #         :name => person.name,
-  #         :address => {
-  #           :street => address.street,
-  #           :state => address.state
-  #       }}
-  #     end
-
-
-  #     before do
-  #       address.should_receive(:to_hash).with(:default).and_call_original
-  #     end
-
-  #     it { should == expected_output }
-
-  #   end
-
-  #   context '#embed_collection' do
-  #     let(:view) do
-  #       Praxis::View.new(:aka, Person) do
-  #         attribute :name
-  #         embed_collection :aliases
-  #       end
-  #     end
-
-  #     subject(:output) { view.to_hash(person) }
-
-
-  #     let(:expected_output) do
-  #       {
-  #         :name => person.name,
-  #         :aliases => person.aliases.collect { |a| a.to_hash(:default)}
-  #       }
-  #     end
-
-  #     it { should == expected_output }
-  #   end
-  # end
+ 
 
   context '#describe' do
     subject(:description) { view.describe}
-    its(:keys){ should == [:attributes] }
-
+    its(:keys){ should =~ [:attributes, :type] }
+    its([:type]) { should eq(:standard) }
     context 'returns attributes' do
       subject { description[:attributes] }
       
@@ -311,6 +263,4 @@ describe Praxis::View do
     end
   end
 
-
-  #it 'has a spec for validating attribute names'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis-blueprints
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -228,12 +228,14 @@ files:
 - Rakefile
 - lib/praxis-blueprints.rb
 - lib/praxis-blueprints/blueprint.rb
+- lib/praxis-blueprints/collection_view.rb
 - lib/praxis-blueprints/config_hash.rb
 - lib/praxis-blueprints/finalizable.rb
 - lib/praxis-blueprints/version.rb
 - lib/praxis-blueprints/view.rb
 - praxis-blueprints.gemspec
 - spec/praxis-blueprints/blueprint_spec.rb
+- spec/praxis-blueprints/collection_view_spec.rb
 - spec/praxis-blueprints/view_spec.rb
 - spec/spec_helper.rb
 - spec/support/spec_blueprints.rb
@@ -264,6 +266,7 @@ summary: Attributes, views, rendering and example generation for common Blueprin
   Structures.
 test_files:
 - spec/praxis-blueprints/blueprint_spec.rb
+- spec/praxis-blueprints/collection_view_spec.rb
 - spec/praxis-blueprints/view_spec.rb
 - spec/spec_helper.rb
 - spec/support/spec_blueprints.rb