praxis-blueprints 3.0 → 3.5

data/praxis-blueprints.gemspec

@@ -1,38 +1,51 @@
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'praxis-blueprints/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "praxis-blueprints"
+  spec.name          = 'praxis-blueprints'
   spec.version       = Praxis::BLUEPRINTS_VERSION
-  spec.authors = ["Josep M. Blanquer","Dane Jensen"]
-  spec.summary = %q{Attributes, views, rendering and example generation for common Blueprint Structures.}
-  spec.description = "Praxis Blueprints is a library that allows for defining a reusable class structures that has a set of typed attributes and a set of views with which to render them. Instantiations of Blueprints resemble ruby Structs which respond to methods of the attribute names. Rendering is format-agnostic in that
-it results in a structured hash instead of an encoded string. Blueprints can automatically generate object structures that follow the attribute definitions."
-  spec.email = ["blanquer@gmail.com","dane.jensen@gmail.com"]
+  spec.authors = ['Josep M. Blanquer', 'Dane Jensen']
+  spec.summary = 'Attributes, views, rendering and example generation for common Blueprint Structures.'
+  spec.description = <<-EOF
+    Praxis Blueprints is a library that allows for defining a reusable class
+    structures that has a set of typed attributes and a set of views with which
+    to render them. Instantiations of Blueprints resemble ruby Structs which
+    respond to methods of the attribute names. Rendering is format-agnostic in
+    that it results in a structured hash instead of an encoded string.
+    Blueprints can automatically generate object structures that follow the
+    attribute definitions.
+  EOF
+  spec.email = ['blanquer@gmail.com', 'dane.jensen@gmail.com']
 
-  spec.homepage = "https://github.com/rightscale/praxis-blueprints"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">=2.1"
+  spec.homepage = 'https://github.com/rightscale/praxis-blueprints'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>=2.1'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency(%q<randexp>, ["~> 0"])
-  spec.add_runtime_dependency(%q<attributor>, [">= 4.1"])
-  spec.add_runtime_dependency(%q<activesupport>, [">= 3"])
+  spec.add_runtime_dependency('randexp', ['~> 0'])
+  spec.add_runtime_dependency('attributor', ['>= 5.5'])
+  spec.add_runtime_dependency('activesupport', ['>= 3'])
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
 
-  spec.add_development_dependency(%q<redcarpet>, ["< 3.0"])
-  spec.add_development_dependency(%q<yard>, ["~> 0.8.7"])
-  spec.add_development_dependency(%q<guard>, ["~> 2"])
-  spec.add_development_dependency(%q<guard-rspec>, [">= 0"])
-  spec.add_development_dependency(%q<rspec>, ["< 2.99"])
-  spec.add_development_dependency(%q<pry>, ["~> 0"])
-  spec.add_development_dependency(%q<pry-byebug>, ["~> 1"])
-  spec.add_development_dependency(%q<pry-stack_explorer>, ["~> 0"])
-  spec.add_development_dependency(%q<fuubar>, ["~> 1"])
+  spec.add_development_dependency('redcarpet', ['< 3.0'])
+  spec.add_development_dependency('yard')
+  spec.add_development_dependency('guard', ['~> 2'])
+  spec.add_development_dependency('guard-rspec', ['>= 0'])
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('rspec-its')
+  spec.add_development_dependency('rspec-collection_matchers')
+  spec.add_development_dependency('pry')
+  spec.add_development_dependency('pry-byebug')
+  spec.add_development_dependency('pry-stack_explorer')
+  spec.add_development_dependency('fuubar')
+  spec.add_development_dependency('coveralls')
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'guard-rubocop'
 end

data/spec/praxis-blueprints/blueprint_spec.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Praxis::Blueprint do
-
   subject(:blueprint_class) { Person }
 
-  its(:family){ should eq('hash') }
+  its(:family) { should eq('hash') }
 
   context 'deterministic examples' do
     it 'works' do
@@ -52,7 +52,6 @@ describe Praxis::Blueprint do
       its(:finalized?) { should be(true) }
     end
 
-
     context '.finalize on that subclass' do
       before do
         blueprint_class.should_receive(:_finalize!).and_call_original
@@ -60,9 +59,7 @@ describe Praxis::Blueprint do
       end
 
       its(:finalized?) { should be(true) }
-
     end
-
   end
 
   context 'creating a base abstract Blueprint class without attributes' do
@@ -76,7 +73,6 @@ describe Praxis::Blueprint do
       blueprint_class.finalize!
       blueprint_class.finalized?.should be(true)
     end
-
   end
 
   it 'has an inner Struct class for the attributes' do
@@ -88,7 +84,6 @@ describe Praxis::Blueprint do
     it 'sorta has view objects' do
       blueprint_class.views.should have_key(:default)
     end
-
   end
 
   context 'an instance' do
@@ -107,30 +102,34 @@ describe Praxis::Blueprint do
 
       context 'validation' do
         subject(:errors) { blueprint_class.validate(blueprint_instance) }
-        pending do
-          it { should be_empty }
-        end
+        it { should be_empty }
       end
     end
 
-
     context 'from Blueprint.example' do
-      subject(:blueprint_instance) { blueprint_class.example }
+      subject(:blueprint_instance) do
+        blueprint_class.example('ExamplePerson', 
+          address: nil,
+          prior_addresses: [],
+          work_address: nil,
+          myself: nil,
+          friends: []
+        )
+      end
       it_behaves_like 'a blueprint instance'
     end
 
     context 'wrapping an object' do
-
       let(:data) do
         {
           name: 'Bob',
           full_name: FullName.example,
-          address: Address.example,
-          email: "bob@example.com",
+          address: nil,
+          email: 'bob@example.com',
           aliases: [],
           prior_addresses: [],
-          parents: { father: Randgen.first_name, mother: Randgen.first_name},
-          href: "www.example.com",
+          parents: { father: Randgen.first_name, mother: Randgen.first_name },
+          href: 'www.example.com',
           alive: true
         }
       end
@@ -139,7 +138,6 @@ describe Praxis::Blueprint do
 
       subject(:blueprint_instance) { blueprint_class.new(resource) }
 
-
       it_behaves_like 'a blueprint instance'
 
       context 'creating additional blueprint instances from that object' do
@@ -148,7 +146,7 @@ describe Praxis::Blueprint do
         context 'with caching enabled' do
           around do |example|
             Praxis::Blueprint.caching_enabled = true
-            Praxis::Blueprint.cache = Hash.new { |h,k| h[k] = Hash.new }
+            Praxis::Blueprint.cache = Hash.new { |h, k| h[k] = {} }
             example.run
 
             Praxis::Blueprint.caching_enabled = false
@@ -165,27 +163,31 @@ describe Praxis::Blueprint do
         context 'with caching disabled' do
           it { should_not be blueprint_instance }
         end
-
       end
-
     end
-
   end
 
   context '.describe' do
-    let(:shallow ) { false }
+    let(:shallow) { false }
     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
-      subject(:output){ blueprint_class.describe }
+      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)}
-      its([:id]){ should eq(blueprint_class.id)}
-      its([:views]){ should be_kind_of(Hash)}
+      its([:name]) { should eq(blueprint_class.name) }
+      its([:id]) { should eq(blueprint_class.id) }
+      its([:views]) { should be_kind_of(Hash) }
+      its(:keys) { should_not include(:anonymous) }
       it 'should contain the an entry for each view' do
         subject[:views].keys.should include(:default, :current, :extended, :master)
       end
@@ -197,6 +199,23 @@ describe Praxis::Blueprint do
       it 'should not include views' do
         blueprint_class.describe(true).key?(:views).should be(false)
       end
+      context 'for anonymous blueprints' do
+        let(:blueprint_class) do
+          klass = Class.new(Praxis::Blueprint) do
+            anonymous_type
+            attributes do
+              attribute :name, String
+            end
+          end
+          klass.finalize!
+          klass
+        end
+        it 'reports their anonymous-ness' do
+          description = blueprint_class.describe(true)
+          expect(description).to have_key(:anonymous)
+          expect(description[:anonymous]).to be(true)
+        end
+      end
     end
 
     context 'with an example' do
@@ -205,13 +224,21 @@ 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
         output[:attributes][:age][:example].should eq example.age
 
+        output[:attributes][:aliases].should have_key(:example)
+        output[:attributes][:aliases][:example].should eq example.aliases.dump
+
         output[:attributes][:full_name].should_not have_key(:example)
-        output[:attributes][:aliases].should_not have_key(:example)
 
         parents_attributes = output[:attributes][:parents][:type][:attributes]
         parents_attributes[:father][:example].should eq example.parents.father
@@ -221,7 +248,7 @@ describe Praxis::Blueprint do
   end
 
   context '.validate' do
-    let(:hash) { {name: 'bob'} }
+    let(:hash) { { name: 'bob' } }
     let(:person) { Person.load(hash) }
     subject(:errors) { person.validate }
 
@@ -230,7 +257,7 @@ describe Praxis::Blueprint do
     end
 
     context 'with invalid sub-attribute' do
-      let(:hash) { {name: 'bob', address: {state: "ME"}} }
+      let(:hash) { { name: 'bob', address: { state: 'ME' } } }
 
       it { should have(1).item }
       its(:first) { should =~ /Attribute \$.address.state/ }
@@ -238,9 +265,9 @@ describe Praxis::Blueprint do
 
     context 'for objects of the wrong type' do
       it 'raises an error' do
-        expect {
+        expect do
           Person.validate(Object.new)
-        }.to raise_error(ArgumentError, /Error validating .* as Person for an object of type Object/)
+        end.to raise_error(ArgumentError, /Error validating .* as Person for an object of type Object/)
       end
     end
   end
@@ -248,9 +275,9 @@ describe Praxis::Blueprint do
   context '.load' do
     let(:hash) do
       {
-        :name => 'Bob',
-        :full_name => {:first => 'Robert', :last => 'Robertson'},
-        :address => {:street => 'main', :state => 'OR'}
+        name: 'Bob',
+        full_name: { first: 'Robert', last: 'Robertson' },
+        address: { street: 'main', state: 'OR' }
       }
     end
     subject(:person) { Person.load(hash) }
@@ -267,19 +294,16 @@ describe Praxis::Blueprint do
         it { should be_kind_of(FullName) }
       end
     end
-
   end
 
-
   context 'decorators' do
     let(:name) { 'Soren II' }
 
     let(:object) { Person.example.object }
     subject(:person) { Person.new(object, decorators) }
 
-
     context 'as a hash' do
-      let(:decorators) { {name: name} }
+      let(:decorators) { { name: name } }
       it do
         person.name.should eq('Soren II')
       end
@@ -287,7 +311,7 @@ describe Praxis::Blueprint do
       its(:name) { should be(name) }
 
       context 'an additional instance with the equivalent hash' do
-        subject(:additional_person) { Person.new(object, {name: name}) }
+        subject(:additional_person) { Person.new(object, name: name) }
         it { should_not be person }
       end
 
@@ -303,7 +327,7 @@ describe Praxis::Blueprint do
     end
 
     context 'as an object' do
-      let(:decorators) { double("decorators", name: name) }
+      let(:decorators) { double('decorators', name: name) }
       its(:name) { should be(name) }
 
       context 'an additional instance with the same object' do
@@ -311,13 +335,10 @@ describe Praxis::Blueprint do
         it { should_not be person }
       end
     end
-
   end
 
-
   context 'with a provided :reference option on attributes' do
     context 'that does not match the value set on the class' do
-
       subject(:mismatched_reference) do
         Class.new(Praxis::Blueprint) do
           self.reference = Class.new(Praxis::Blueprint)
@@ -326,15 +347,13 @@ describe Praxis::Blueprint do
       end
 
       it 'should raise an error' do
-        expect {
+        expect do
           mismatched_reference.attributes
-        }.to raise_error
+        end.to raise_error
       end
-
     end
   end
 
-
   context '.example' do
     context 'with some attribute values provided' do
       let(:name) { 'Sir Bobbert' }
@@ -346,7 +365,6 @@ describe Praxis::Blueprint do
   context '.render' do
     let(:person) { Person.example('1') }
     it 'is an alias to dump' do
-
       person.object.contents
       rendered = Person.render(person, view: :default)
       dumped = Person.dump(person, view: :default)
@@ -360,10 +378,7 @@ describe Praxis::Blueprint do
     let(:render_opts) { {} }
     subject(:output) { person.render(view: view_name, **render_opts) }
 
-
-
     context 'with a sub-attribute that is a blueprint' do
-
       it { should have_key(:name) }
       it { should have_key(:address) }
       it 'renders the sub-attribute correctly' do
@@ -372,14 +387,13 @@ describe Praxis::Blueprint do
       end
 
       it 'reports a dump error with the appropriate context' do
-        person.address.should_receive(:state).and_raise("Kaboom")
-        expect {
+        person.address.should_receive(:state).and_raise('Kaboom')
+        expect do
           person.render(view: view_name, context: ['special_root'])
-        }.to raise_error(/Error while dumping attribute state of type Address for context special_root.address. Reason: .*Kaboom/)
+        end.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
@@ -391,7 +405,7 @@ describe Praxis::Blueprint do
 
     context 'using the `fields` option' do
       context 'as a hash' do
-        subject(:output) { person.render(fields: {address: {state: true}}) }
+        subject(:output) { person.render(fields: { address: { state: true } }) }
         it 'should only have the address rendered' do
           output.keys.should eq [:address]
         end
@@ -408,4 +422,16 @@ describe Praxis::Blueprint do
     end
   end
 
+  context '.as_json_schema' do
+    it 'delegates to the attribute type' do
+      Person.attribute.type.should receive(:as_json_schema)
+      Person.as_json_schema
+    end
+  end
+  context '.json_schema_type' do
+    it 'delegates to the attribute type' do
+      Person.attribute.type.should receive(:json_schema_type)
+      Person.json_schema_type
+    end
+  end
 end

data/spec/praxis-blueprints/collection_view_spec.rb

@@ -1,17 +1,16 @@
+# frozen_string_literal: true
 require_relative '../spec_helper'
 
 describe Praxis::CollectionView do
-
   let(:root_context) { ['people'] }
 
   let(:people) do
-    3.times.collect do |i|
-      context = ["people", "at(#{i})"]
+    Array.new(3) do |i|
+      context = ['people', "at(#{i})"]
       Person.example(context)
     end
   end
 
-
   let(:contents_definition) do
     proc do
       attribute :name
@@ -28,10 +27,21 @@ describe Praxis::CollectionView do
   end
 
   context 'creating from a member view' 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
@@ -48,7 +58,7 @@ describe Praxis::CollectionView do
     subject(:output) { collection_view.render(people, context: root_context) }
 
     it { should be_kind_of(Array) }
-    it { should eq people.collect {|person| member_view.render(person)} }
+    it { should eq people.collect { |person| member_view.render(person) } }
   end
 
   context '#example' do
@@ -69,5 +79,4 @@ describe Praxis::CollectionView do
     its([:attributes]) { should eq(member_view.describe[:attributes]) }
     its([:type]) { should eq(:collection) }
   end
-
 end