praxis-blueprints 1.3.1 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 079b25ca3c8c34b56fb2e2a30d29396d032d857b
-  data.tar.gz: 4755ff61ad4d35f1643917f42900b01f9e7cb428
+  metadata.gz: 7c736a4636406c8778b15c49639322310a4d27d7
+  data.tar.gz: 58ffdbb7c7b247dc6db88506c7fd22991f99585b
 SHA512:
-  metadata.gz: 691cb0f8e2807fd0fbe3e1d1fe8401db44c4b86d29dc3aaf355243168c607c453512978aeb754463e64b10a5c5e2f00b7ac9fedbd7b38563594c61c9edf4b714
-  data.tar.gz: 657db7c0f1599274db19443aa37968b56b2cb346ef83c2b56b5ab272c9a923ba2be480241b46de03b243ab25daebfd94e048f98de4a85b8ac151ac7513006832
+  metadata.gz: cc6e31dcdca27eda3345a5dc9c0d01b7f02263e10512e3141a7ce7b728581ee2d4323d913ae7618228a2ee809591c0952ce3ab4993d43745a4b4af451e053ab9
+  data.tar.gz: b62ec6a3ac621567d1a52e9dde4b44a6a686bca2fca02eda414a753e4e3e7674b6875a02569aebe72241bf7384e10a8c6891f1e08a5a1eac621862f48afd814f

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,7 +1,15 @@
 # praxis-blueprints changelog
 
-## next
-
+## 2.0
+
+* Fix `Blueprint.new` handling of caching when the wrapped object responds to `identity_map`, but does not have one set.
+* Undefine JRuby package helper methods in `Model` (org, java...)
+* Added support for rendering custom views
+  * Internally, a `View` object can now be dumped passing a `:fields` option (which is a hash, that can recursively will define which sub-attributes to render along the way). See [this spec](https://github.com/rightscale/praxis-blueprints/blob/master/spec/praxis-blueprints/blueprint_spec.rb) for an example.
+  * `Blueprints` will also accept the `:fields` option (with the same hash syntax), but it will also accept an array to imply the list of top-level attributes to render (when recursion is not necessary)
+  * Caching of rendered blueprints will continue to work if the view is re-rendered with equivalent `:fields`
+* Deprecate `Blueprint.render(view_name,...) positional param
+  * Please use :view named parameter instead. I.e., `render(:default, context: ...)`  => `render(view: :default, context: ...)`
 
 ## 1.3.1
 

data/lib/praxis-blueprints/blueprint.rb

@@ -9,6 +9,13 @@ module Praxis
     include Attributor::Type
     extend Finalizable
 
+    if RUBY_ENGINE =~ /^jruby/
+      # We are "forced" to require it here (in case hasn't been yet) to make sure the added methods have been applied
+      require 'java'
+      # Only to then delete them, to make sure we don't have them clashing with any attributes
+      undef java, javax, org, com
+    end
+
     @@caching_enabled = false
 
     CIRCULAR_REFERENCE_MARKER = '...'.freeze
@@ -35,7 +42,7 @@ module Praxis
       if @@caching_enabled && decorators.nil?
         key = object
 
-        cache = if object.respond_to?(:identity_map)
+        cache = if object.respond_to?(:identity_map) && object.identity_map
           object.identity_map.blueprint_cache[self]
         else
           self.cache
@@ -57,10 +64,10 @@ module Praxis
       'hash'
     end
 
-    def self.describe(shallow=false)
+    def self.describe(shallow=false,**opts)
       type_name = self.ancestors.find { |k| k.name && !k.name.empty? }.name
 
-      description = self.attribute.type.describe(shallow).merge!(id: self.id, name: type_name)
+      description = self.attribute.type.describe(shallow,**opts).merge!(id: self.id, name: type_name)
 
       unless shallow
         description[:views] = self.views.each_with_object({}) do |(view_name, view), hash|
@@ -190,7 +197,12 @@ module Praxis
       object = self.load(object, context, **opts)
       return nil if object.nil?
 
-      object.render(view, context: context)
+      object.render(view: view, context: context, **opts)
+    end
+
+    # Allow render on the class too, for completeness and consistency
+    def self.render(object, **opts)
+      self.dump(object, **opts)
     end
 
     # Internal finalize! logic
@@ -271,24 +283,43 @@ module Praxis
 
 
     # Render the wrapped data with the given view
-    def render(view_name=:default, context: Attributor::DEFAULT_ROOT_CONTEXT)
+    def render(view_name=nil, context: Attributor::DEFAULT_ROOT_CONTEXT,**opts)
+      if view_name != nil
+        warn "DEPRECATED: please do not pass the view name as the first parameter in Blueprint.render, pass through the view: named param instead."
+      else
+        view_name = :default # Backwards compatibility with the default param value
+      end
+
+      # Allow the opts to specify the view name for consistency with dump (overriding the deprecated named param)
+      view_name = opts[:view] if opts[:view]
       unless (view = self.class.views[view_name])
         raise "view with name '#{view_name.inspect}' is not defined in #{self.class}"
       end
 
-      return @rendered_views[view_name] if @rendered_views.has_key? view_name
-      return CIRCULAR_REFERENCE_MARKER if @active_renders.include?(view_name)
-      @active_renders << view_name
+      rendered_key = if fields = opts[:fields]
+        if fields.is_a? Array
+          # Accept a simple array of fields, and transform it to a 1-level hash with nil values
+          opts[:fields] = opts[:fields].each_with_object({}) {|field, hash| hash[field] = nil }
+        end
+        # Rendered key needs to be different if only some fields were output
+        "%s:#%s" % [view_name, opts[:fields].hash.to_s]
+      else
+        view_name
+      end
+
+      return @rendered_views[rendered_key] if @rendered_views.has_key? rendered_key
+      return CIRCULAR_REFERENCE_MARKER if @active_renders.include?(rendered_key)
+      @active_renders << rendered_key
 
-      @rendered_views[view_name] = view.dump(self, context: context)
+      @rendered_views[rendered_key] = view.dump(self, context: context,**opts)
     ensure
-      @active_renders.delete view_name
+      @active_renders.delete rendered_key
     end
     alias_method :to_hash, :render
 
 
     def dump(view: :default, context: Attributor::DEFAULT_ROOT_CONTEXT)
-      self.render(view, context: context)
+      self.render(view: view, context: context)
     end
 
 

data/lib/praxis-blueprints/version.rb

@@ -1,3 +1,3 @@
 module Praxis
-  BLUEPRINTS_VERSION = "1.3.1"
+  BLUEPRINTS_VERSION = "2.0"
 end

data/lib/praxis-blueprints/view.rb

@@ -31,8 +31,14 @@ module Praxis
 
 
     def dump(object, context: Attributor::DEFAULT_ROOT_CONTEXT,**opts)
-
-      self.contents.each_with_object({}) do |(name, (dumpable, dumpable_opts)), hash|
+      fields = opts[:fields]
+      # Restrict which attributes to output if we receive a fields parameter
+      # Note: should we complain if any of the names in "fields" do not match an existing attribute name?
+      attributes_to_render = self.contents.keys
+      attributes_to_render &= fields.keys if fields
+
+      attributes_to_render.each_with_object({}) do |name, hash|
+        dumpable, dumpable_opts = self.contents[name]
         unless object.respond_to?(name)
           warn "#{object} does not respond to #{name} during rendering???"
           next
@@ -51,12 +57,16 @@ module Praxis
         # FIXME: this is such an ugly way to do this. Need attributor#67.
         if dumpable.kind_of?(View) || dumpable.kind_of?(CollectionView)
           new_context = context + [name]
-          hash[name] = dumpable.dump(value, context: new_context ,**(dumpable_opts||{}))
+
+          sub_opts = add_subfield_options( fields, name, dumpable_opts )
+          hash[name] = dumpable.dump(value, context: new_context ,**sub_opts)
         else
+
           type = dumpable.type
           if type.respond_to?(:attributes) || type.respond_to?(:member_attribute)
             new_context = context + [name]
-            hash[name] = dumpable.dump(value, context: new_context ,**(dumpable_opts||{}))
+            sub_opts = add_subfield_options( fields, name, dumpable_opts )
+            hash[name] = dumpable.dump(value, context: new_context ,**sub_opts)
           else
             hash[name] = value
           end
@@ -65,7 +75,6 @@ module Praxis
     end
     alias_method :to_hash, :dump
 
-
     def attribute(name, opts={}, &block)
       raise AttributorException, "Attribute names must be symbols, got: #{name.inspect}" unless name.kind_of? ::Symbol
 
@@ -104,5 +113,13 @@ module Praxis
       { attributes: view_attributes, type: :standard }
     end
 
+    private
+    def add_subfield_options( fields, name, existing_options)
+      sub_opts = if fields && fields[name]
+        {fields: fields[name] }
+      else
+        {}
+      end.merge(existing_options || {})
+    end
   end
 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>, ["~> 2.6"])
+  spec.add_runtime_dependency(%q<attributor>, ["~> 3.0"])
   spec.add_runtime_dependency(%q<activesupport>, [">= 3"])
 
   spec.add_development_dependency "bundler", "~> 1.6"

data/spec/praxis-blueprints/blueprint_spec.rb

@@ -95,7 +95,7 @@ describe Praxis::Blueprint do
 
       context '#render' do
         let(:view) { :default }
-        subject(:output) { blueprint_instance.render(view) }
+        subject(:output) { blueprint_instance.render(view: view) }
 
         it { should have_key(:name) }
         it 'has the right values' do
@@ -318,10 +318,61 @@ describe Praxis::Blueprint do
     end
   end
 
+  context '.render' do
+    let(:person) { Person.example }
+    it 'is an alias to dump' do
+      rendered = Person.render(person, view: :default)
+      dumped = Person.dump(person, view: :default)
+      expect(rendered).to eq(dumped)
+    end
+  end
+
   context '#render' do
     let(:person) { Person.example }
     let(:view_name) { :default }
-    subject(:output) { person.render(view_name) }
+    let(:render_opts) { {} }
+    subject(:output) { person.render(view: view_name, **render_opts) }
+
+    context 'caches rendered views' do
+      it 'in the instance, by view name'  do
+        person.instance_variable_get(:@rendered_views)[view_name].should be_nil
+        person.render(view: view_name)
+        cached = person.instance_variable_get(:@rendered_views)[view_name]
+        cached.should_not be_nil
+      end
+
+      it 'and does not re-render a view if one is already cached'  do
+        rendered1 = person.render(view: view_name)
+        rendered2 = person.render(view: view_name)
+        rendered1.should be(rendered2)
+      end
+
+      context 'even when :fields are specified' do
+        let(:render_opts) { {fields: {email: nil, age: nil, address: {street: nil, state: nil}}} }
+
+        it 'caches the output in a different key than just the view_name' do
+          plain_view_render = person.render(view: view_name)
+          fields_render = person.render(view: view_name, **render_opts)
+          plain_view_render.should_not be(fields_render)
+        end
+
+        it 'it still caches the object if rendered for the same fields'  do
+          rendered1 = person.render(view: view_name, **render_opts)
+          rendered2 = person.render(view: view_name, **render_opts)
+          rendered1.should be(rendered2)
+        end
+
+        it 'it still caches the object if rendered for the same fields (even from an "equivalent" hash)'  do
+          rendered1 = person.render(view: view_name, **render_opts)
+
+          equivalent_render_opts = { fields: {age: nil, address: {state: nil, street: nil}, email: nil} }
+          rendered2 = person.render(view: view_name, **equivalent_render_opts)
+
+          rendered1.should be(rendered2)
+        end
+      end
+
+    end
 
     context 'with a sub-attribute that is a blueprint' do
 
@@ -335,7 +386,7 @@ describe Praxis::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'])
+          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
     end
@@ -350,6 +401,23 @@ describe Praxis::Blueprint do
       end
     end
 
+    context 'using the `fields` option' do
+      context 'as a hash' do
+        subject(:output) { person.render(view: view_name, fields: {address: { state: nil} } ) }
+        it 'should only have the address rendered' do
+          output.keys.should == [:address]
+        end
+        it 'address should only have state' do
+          output[:address].keys.should == [:state]
+        end
+      end
+      context 'as a simple array' do
+        subject(:output) { person.render(view: view_name, fields: [:address] ) }
+        it 'accepts it as the list of top-level attributes to be rendered' do
+          output.keys.should == [:address]
+        end
+      end
+    end
   end
 
 end

data/spec/praxis-blueprints/view_spec.rb

@@ -12,8 +12,8 @@ describe Praxis::View do
       attribute :address, view: :state
     end
   end
-
-  subject(:output) { view.to_hash(person) }
+  let(:dumping_options){ {} }
+  subject(:output) { view.to_hash(person, dumping_options ) }
 
 
   it 'can generate examples' do
@@ -53,8 +53,23 @@ describe Praxis::View do
         output.key?(:age).should_not be(true)
         output.key?(:address).should_not be(true)
       end
+
+      context 'and custom field rendering' do
+        let(:data) { {name: 'Bob', email: 'bob@acme.org', age: 50 } }
+
+        context 'renders only the specified fields that have values' do
+          let(:dumping_options){ { fields: {name: nil, email: nil} } }
+          its(:keys){ should == [:name, :email] }
+        end
+
+        context 'renders only the specified fields excluding nil valued ones' do
+          let(:dumping_options){ { fields: {name: nil, address: nil} } }
+          its(:keys){ should == [:name] }
+        end
+      end
     end
 
+
     context 'with include_nil: true' do
       let(:view) do
         Praxis::View.new(:info, Person, include_nil: true) do
@@ -65,8 +80,6 @@ describe Praxis::View do
         end
       end
 
-      subject(:output) { view.to_hash(person) }
-
       it 'includes attributes with nil values' do
         output.key?(:email).should be(true)
         output[:email].should be(nil)
@@ -78,9 +91,16 @@ describe Praxis::View do
         output[:age].should be(nil)
       end
 
+      context 'and custom field rendering' do
+        let(:data) { {name: 'Bob', email: 'bob@acme.org', age: 50 } }
+
+        context 'renders only the specified fields including nil valued' do
+          let(:dumping_options){ { fields: {name: nil, address: nil}} }
+          its(:keys){ should == [:name,:address] }
+        end
+      end
     end
 
-  
   end
 
 
@@ -200,6 +220,21 @@ describe Praxis::View do
 
       it { should eq expected_output }
 
+      context 'using the fields option' do
+        let(:dumping_options){ { fields: {name: nil, address: {state: nil} } } }
+
+        let(:expected_output) do
+          {
+            :name => person.name,
+            :address => {
+              :state => address.state
+            }
+          }
+        end
+
+        it { should eq expected_output }
+      end
+
     end
 
 
@@ -283,7 +318,7 @@ describe Praxis::View do
       let(:expected_output) do
         {
           :name => person.name,
-          :prior_addresses => person.prior_addresses.collect { |a| a.to_hash(:default)}
+          :prior_addresses => person.prior_addresses.collect { |a| a.to_hash(view: :default)}
         }
       end
 
@@ -302,7 +337,7 @@ describe Praxis::View do
       let(:expected_output) do
         {
           :name => person.name,
-          :prior_addresses => person.prior_addresses.collect { |a| a.to_hash(:state)}
+          :prior_addresses => person.prior_addresses.collect { |a| a.to_hash(view: :state)}
         }
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis-blueprints
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: '2.0'
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement