praxis-blueprints 3.0 → 3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fe3a8efadb5bf8bc0014eae372157bd62020363
-  data.tar.gz: df99c67d44c66bf7d99ab017a56c220b7ff01586
+  metadata.gz: 87521372774c1c5885e1524ba24c931b6c37cdf2
+  data.tar.gz: edcd9ea3c1ea8ca0a874bc8d13f5caa6c050e10d
 SHA512:
-  metadata.gz: ba760805fbd070350e360638d781833bd9f66abc2dfb2f1a3f30cc5456ab8f6fbfbfdd3e0a1cb5088ba18d4c1299641f8f804e4123fcc453a91c40b4e6d49091
-  data.tar.gz: 2588dbe95bc05c824c8dfd7bffe1ddb7973839f8cbe0dca72ff5a37744add676535c09f27f733dd40f593e57aba95d9556cee183cad0e093c20c170e152c9cbc
+  metadata.gz: 4133d88711c6b0d46055c61b483525047463e16e2dc17baa12cd5ac99494e9966e46c828c125826f90afaf4933c4c6d0c12a83dad1036c597741ae8b67da0545
+  data.tar.gz: a4478e4777276bd98aab92494cf7f38b249451d88047457ad90afafaf7c5f704ab7c2a45858f140158817705a14c57e66018adc47d9577fa32ea1baaaa8fe560

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## next
 
+## 3.1
+
+* Reworked FieldExpander's behavior with circular references.
+  * Removed `Praxis::FieldExpander::CircularExpansionError`
+  * `FieldExpander#expand` now returns self-referential hashes for circular
+    expansions
+* `Renderer#render` catches stack overflows and returns a
+  `Praxis::Rendering::CircularRenderingError`, which includes a portions
+  from the start and end of the context at the time of the exception.
+* Report `anonymous` in Blueprints following `Attributor` semantics.
+
 ## 3.0
 
 * Added `FieldExpander`, a new class that recursively expands a tree of

data/README.md

@@ -1,7 +1,11 @@
-# Praxis Blueprints [![TravisCI][travis-img-url]][travis-ci-url] 
+# Praxis Blueprints [![TravisCI][travis-img-url]][travis-ci-url] [![Coverage Status][coveralls-img-url]][coveralls-url] [![Dependency Status][gemnasium-img-url]][gemnasium-url]
 
 [travis-img-url]:https://travis-ci.org/rightscale/praxis-blueprints.svg?branch=master
 [travis-ci-url]:https://travis-ci.org/rightscale/praxis-blueprints
+[coveralls-img-url]:https://coveralls.io/repos/rightscale/praxis-blueprints/badge.svg?branch=master&service=github
+[coveralls-url]:https://coveralls.io/github/rightscale/praxis-blueprints?branch=master
+[gemnasium-img-url]:https://gemnasium.com/rightscale/praxis-blueprints.svg
+[gemnasium-url]:https://gemnasium.com/rightscale/praxis-blueprints
 
 
 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

data/lib/praxis-blueprints/blueprint.rb

@@ -73,6 +73,8 @@ module Praxis
       end
 
       description = self.attribute.type.describe(shallow,example: example, **opts).merge!(id: self.id, name: type_name)
+      description.delete :anonymous # discard the Struct's view of anonymity, and use the Blueprint's one
+      description[:anonymous] = @_anonymous unless @_anonymous.nil?
 
       unless shallow
         description[:views] = self.views.each_with_object({}) do |(view_name, view), hash|
@@ -242,6 +244,7 @@ module Praxis
     def self.define_attribute!
       @attribute = Attributor::Attribute.new(Attributor::Struct, @options, &@block)
       @block = nil
+      @attribute.type.anonymous_type true
       self.const_set(:Struct, @attribute.type)
     end
 
@@ -315,7 +318,6 @@ module Praxis
         view_name = :default
       end
 
-
       if view_name
         unless (view = self.class.views[view_name])
           raise "view with name '#{view_name.inspect}' is not defined in #{self.class}"

data/lib/praxis-blueprints/field_expander.rb

@@ -1,13 +1,5 @@
 module Praxis
   class FieldExpander
-    class CircularExpansionError < StandardError
-      attr_reader :stack
-      def initialize(message, stack=[])
-        super(message)
-        @stack = stack
-      end
-    end
-
     def self.expand(object, fields=true)
       self.new.expand(object,fields)
     end
@@ -26,21 +18,26 @@ module Praxis
 
     def expand(object, fields=true)
       if stack[object].include? fields
-        raise CircularExpansionError, "Circular expansion detected for object #{object.inspect} with fields #{fields.inspect}"
+        if history[object].include? fields
+          return history[object][fields]
+        end
+        # We should probably never get here, since we should have a record
+        # of the history of an expansion if we're trying to redo it,
+        # but we should also be conservative and raise here just in case.
+        raise "Circular expansion detected for object #{object.inspect} with fields #{fields.inspect}"
       else
         stack[object] << fields
       end
 
-      if object.kind_of?(Praxis::View)
+      result = if object.kind_of?(Praxis::View)
         self.expand_view(object, fields)
       elsif object.kind_of? Attributor::Attribute
         self.expand_type(object.type, fields)
       else
         self.expand_type(object,fields)
       end
-    rescue CircularExpansionError => e
-      e.stack.unshift [object,fields]
-      raise
+
+      result
     ensure
       stack[object].delete fields
     end
@@ -67,20 +64,39 @@ module Praxis
 
 
     def expand_view(object,fields=true)
+      history[object][fields] = if object.kind_of?(Praxis::CollectionView)
+        []
+      else
+        {}
+      end
+
       result = expand_fields(object.contents, fields) do |dumpable, sub_fields|
         self.expand(dumpable, sub_fields)
       end
 
-      return [result] if object.kind_of?(Praxis::CollectionView)
-      result
+      if object.kind_of?(Praxis::CollectionView)
+        history[object][fields] << result
+      else
+        history[object][fields].merge!(result)
+      end
+      history[object][fields]
     end
 
 
     def expand_type(object,fields=true)
       unless object.respond_to?(:attributes)
         if object.respond_to?(:member_attribute)
-          fields = fields[0] if fields.kind_of? Array
-          return [self.expand(object.member_attribute.type, fields)]
+          if history[object].include? fields
+            return history[object][fields]
+          end
+          history[object][fields] = []
+
+          new_fields = fields.kind_of?(Array) ? fields[0] : fields
+
+          result = [self.expand(object.member_attribute.type, new_fields)]
+          history[object][fields].push(*result)
+
+          return result
         else
           return true
         end
@@ -95,9 +111,11 @@ module Praxis
         return history[object][fields]
       end
 
-      history[object][fields] = expand_fields(object.attributes, fields) do |dumpable, sub_fields|
+      history[object][fields] = {}
+      result = expand_fields(object.attributes, fields) do |dumpable, sub_fields|
         self.expand(dumpable.type, sub_fields)
       end
+      history[object][fields].merge!(result)
     end
 
   end

data/lib/praxis-blueprints/renderer.rb

@@ -3,6 +3,21 @@ module Praxis
     attr_reader :include_nil
     attr_reader :cache
 
+    class CircularRenderingError < StandardError
+      attr_reader :object
+      attr_reader :context
+
+      def initialize(object,context)
+        @object = object
+        @context = context
+
+        first = Attributor.humanize_context(context[0..10])
+        last = Attributor.humanize_context(context[-5..-1])
+        pretty_context = "#{first}...#{last}"
+        super("SystemStackError in rendering #{object.class} with context: #{pretty_context}")
+      end
+    end
+
     def initialize(include_nil: false)
       @cache = Hash.new do |hash,key|
         hash[key] = Hash.new
@@ -35,6 +50,8 @@ module Praxis
       else
         _render(object,fields, view, context: context)
       end
+    rescue SystemStackError
+      raise CircularRenderingError.new(object, context)
     end
 
     def _render(object, fields, view=nil, context: Attributor::DEFAULT_ROOT_CONTEXT)

data/lib/praxis-blueprints/version.rb

@@ -1,3 +1,3 @@
 module Praxis
-  BLUEPRINTS_VERSION = "3.0"
+  BLUEPRINTS_VERSION = "3.1"
 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.1"])
+  spec.add_runtime_dependency(%q<attributor>, [">= 4.2"])
   spec.add_runtime_dependency(%q<activesupport>, [">= 3"])
 
   spec.add_development_dependency "bundler", "~> 1.6"
@@ -35,4 +35,5 @@ it results in a structured hash instead of an encoded string. Blueprints can aut
   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(%q<coveralls>)
 end

data/spec/praxis-blueprints/blueprint_spec.rb

@@ -186,17 +186,36 @@ describe Praxis::Blueprint do
       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
     end
 
+
     context 'for shallow descriptions' do
       let(:shallow) { true }
 
       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

data/spec/praxis-blueprints/field_expander_spec.rb

@@ -125,9 +125,25 @@ describe Praxis::FieldExpander do
   end
 
   context 'circular expansions' do
-    it 'throws a CircularExpansionError' do
-      expect { field_expander.expand(Address,true) }.to raise_error(Praxis::FieldExpander::CircularExpansionError)
+    it 'preserve field object identity for circular references' do
+      result = field_expander.expand(Address,true)
+      result.should be result[:resident][:address]
     end
+
+    context 'with collections of Blueprints' do
+      it 'still preserves object identity' do
+        result = field_expander.expand(Person, prior_addresses: true)[:prior_addresses][0]
+        result.should be result[:resident][:prior_addresses][0]
+      end
+    end
+
+    context 'for views' do
+      it 'still preserves object identity' do
+        result = field_expander.expand(Person.views[:circular], true)
+        result[:address][:resident].should be result
+      end
+    end
+
   end
 
   it 'optimizes duplicate field expansions' do

data/spec/praxis-blueprints/renderer_spec.rb

@@ -139,4 +139,15 @@ describe Praxis::Renderer do
     end
 
   end
+
+  context 'circular rendering' do
+    it do
+      field_expander = Praxis::FieldExpander.new
+      fields = field_expander.expand(Person,true)
+
+      person.object.address.object.resident = person
+      expect { renderer.render(person, fields) }.to raise_error(Praxis::Renderer::CircularRenderingError)
+    end
+
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 Encoding.default_external = Encoding::UTF_8
 
 require 'rubygems'

data/spec/support/spec_blueprints.rb

@@ -29,6 +29,10 @@ class Person < Praxis::Blueprint
     attribute :prior_addresses
   end
 
+  view :circular do
+    attribute :address, view: :circular
+  end
+
   view :current do
     attribute :name
     attribute :full_name
@@ -63,8 +67,12 @@ class Address  < Praxis::Blueprint
   view :default do
     attribute :street
     attribute :state
+
   end
 
+  view :circular do
+    attribute :resident, view: :circular
+  end
   view :state do
     attribute :state
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis-blueprints
 version: !ruby/object:Gem::Version
-  version: '3.0'
+  version: '3.1'
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +207,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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.