praxis-blueprints 3.0 → 3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fe3a8efadb5bf8bc0014eae372157bd62020363
-  data.tar.gz: df99c67d44c66bf7d99ab017a56c220b7ff01586
+  metadata.gz: 7d81b3ad8d99f25a09e875be8cde132edfda0825
+  data.tar.gz: 06ac06171a9662bdeaec163cb1919d9aac030c55
 SHA512:
-  metadata.gz: ba760805fbd070350e360638d781833bd9f66abc2dfb2f1a3f30cc5456ab8f6fbfbfdd3e0a1cb5088ba18d4c1299641f8f804e4123fcc453a91c40b4e6d49091
-  data.tar.gz: 2588dbe95bc05c824c8dfd7bffe1ddb7973839f8cbe0dca72ff5a37744add676535c09f27f733dd40f593e57aba95d9556cee183cad0e093c20c170e152c9cbc
+  metadata.gz: 37883fd914dc624b7771c2c54150f68361705ce87446abc1b60013eb36ac90775d1eeb71edb3e11a05e6226deedfbbe15b4d68af89b5ff8cad992004539963aa
+  data.tar.gz: 68504da7c58e07ea3f2950ec36638918fd0643954fff1ac70c27d9c2a210b79db68ee9ece1b736645520a22d9a45655f3ec86815b552572e00b906163bef2535

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  TargetRubyVersion: 2.3
+Style/Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/LineLength:
+  Max: 200
+Style/RedundantSelf:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Lint/Debugger:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Style/CaseEquality:
+  Enabled: false
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+Style/FileName:
+  Exclude:
+    - 'lib/praxis-blueprints.rb'
+Style/ClassVars:
+  Exclude:
+    - 'lib/praxis-blueprints/blueprint.rb'
+
+# Offense count: 5
+Metrics/CyclomaticComplexity:
+  Max: 8
+# Offense count: 5
+Metrics/PerceivedComplexity:
+  Max: 12

data/.travis.yml

@@ -1,7 +1,12 @@
-language: ruby
-cache: bundler
 sudo: false
+language: ruby
 rvm:
-  - 2.1.2
-  - 2.2.2
-script: bundle exec rspec spec
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+script:
+  - bundle exec rspec spec
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 ## next
 
+## 3.4
+
+* Upgrade to latest Attributor gem (which has JSON-schema support), and add json-schema methods for blueprints.
+
+## 3.3
+
+* Include Attributor::Dumpable in Blueprint, so it renders (semi) correctly if
+  rendered with just `true` specified for fields.
+* Fix bug rendering subobjects with nil values (manifested when `include_nil: true` there’s an explicit subsection of fields)
+
+## 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.
+  * 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/Gemfile

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 gemspec

data/Guardfile

@@ -1,11 +1,17 @@
+# frozen_string_literal: true
 # Config file for Guard
 # More info at https://github.com/guard/guard#readme
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec' do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/praxis-blueprints/(.+)\.rb$}) { |m| "spec/praxis-blueprints/#{m[1]}_spec.rb" }
+    watch('spec/*.rb') { 'spec' }
+    watch('lib/praxis-blueprints.rb') { 'spec' }
+    watch(%r{^spec/support/(.+)\.rb$}) { 'spec' }
+  end
 
-guard :rspec, cmd: 'bundle exec rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/praxis-blueprints/(.+)\.rb$}) { |m| "spec/praxis-blueprints/#{m[1]}_spec.rb" }
-  watch('spec/*.rb')  { 'spec' }
-  watch('lib/praxis-blueprints.rb') { 'spec' }
-  watch(%r{^spec/support/(.+)\.rb$}) { 'spec' }
+  guard :rubocop, cli: '--auto-correct --display-cop-names' do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
 end
-

data/README.md

@@ -1,8 +1,13 @@
-# 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] 
 
-[travis-img-url]:https://travis-ci.org/rightscale/praxis-blueprints.svg?branch=master
-[travis-ci-url]:https://travis-ci.org/rightscale/praxis-blueprints
+[//]: # ( COMMENTED OUT UNTIL GEMNASIUM CAN SEE THE REPOS: [![Dependency Status][gemnasium-img-url]][gemnasium-url])
 
+[travis-img-url]:https://travis-ci.org/praxis/praxis-blueprints.svg?branch=master
+[travis-ci-url]:https://travis-ci.org/praxis/praxis-blueprints
+[coveralls-img-url]:https://coveralls.io/repos/github/praxis/praxis-blueprints/badge.svg?branch=master
+[coveralls-url]:https://coveralls.io/github/praxis/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
 it results in a structured hash instead of an encoded string. Blueprints can automatically generate object structures that follow the attribute definitions.

data/Rakefile

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
 require 'bundler/setup'
 
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
 require 'bundler/gem_tasks'
 
-desc "Run RSpec code examples with simplecov"
+desc 'Run RSpec code examples with simplecov'
 RSpec::Core::RakeTask.new do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-task :default => :spec
+task default: :spec
 
 require 'yard'
 YARD::Rake::YardocTask.new

data/lib/praxis-blueprints.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 require 'json'
 require 'yaml'
 require 'logger'
 
 require 'attributor'
 
-require "praxis-blueprints/version"
+require 'praxis-blueprints/version'
 
 require 'praxis-blueprints/finalizable'
 require 'praxis-blueprints/config_hash'

data/lib/praxis-blueprints/blueprint.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ostruct'
 
 # Blueprint ==
@@ -7,6 +8,8 @@ require 'ostruct'
 module Praxis
   class Blueprint
     include Attributor::Type
+    include Attributor::Dumpable
+
     extend Finalizable
 
     if RUBY_ENGINE =~ /^jruby/
@@ -18,7 +21,6 @@ module Praxis
 
     @@caching_enabled = false
 
-
     attr_reader :validating
     attr_accessor :object
     attr_accessor :decorators
@@ -34,20 +36,20 @@ module Praxis
       super
 
       klass.instance_eval do
-        @views = Hash.new
-        @options = Hash.new
+        @views = {}
+        @options = {}
         @domain_model = Object
       end
     end
 
     # Override default new behavior to support memoized creation through an IdentityMap
-    def self.new(object, decorators=nil)
+    def self.new(object, decorators = nil)
       if @@caching_enabled && decorators.nil?
         cache = if object.respond_to?(:identity_map) && object.identity_map
-          object.identity_map.blueprint_cache[self]
-        else
-          self.cache
-        end
+                  object.identity_map.blueprint_cache[self]
+                else
+                  self.cache
+                end
 
         return cache[object] ||= begin
           blueprint = self.allocate
@@ -65,14 +67,14 @@ module Praxis
       'hash'
     end
 
-    def self.describe(shallow=false,example: nil, **opts)
+    def self.describe(shallow = false, example: nil, **opts)
       type_name = self.ancestors.find { |k| k.name && !k.name.empty? }.name
 
-      if example
-        example = example.object
-      end
+      example = example.object if example
 
-      description = self.attribute.type.describe(shallow,example: example, **opts).merge!(id: self.id, name: type_name)
+      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|
@@ -83,37 +85,30 @@ module Praxis
       description
     end
 
-
-    def self.attributes(opts={}, &block)
+    def self.attributes(opts = {}, &block)
       if block_given?
-        if self.const_defined?(:Struct, false)
-          raise "Redefining Blueprint attributes is not currently supported"
-        else
+        raise 'Redefining Blueprint attributes is not currently supported' if self.const_defined?(:Struct, false)
 
-          if opts.has_key?(:reference) && opts[:reference] != self.reference
-            raise "Reference mismatch in #{self.inspect}. Given :reference option #{opts[:reference].inspect}, while using #{self.reference.inspect}"
-          elsif self.reference
-            opts[:reference] = self.reference #pass the reference Class down
-          else
-            opts[:reference] = self
-          end
-
-          @options.merge!(opts)
-          @block = block
+        if opts.key?(:reference) && opts[:reference] != self.reference
+          raise "Reference mismatch in #{self.inspect}. Given :reference option #{opts[:reference].inspect}, while using #{self.reference.inspect}"
+        elsif self.reference
+          opts[:reference] = self.reference # pass the reference Class down
+        else
+          opts[:reference] = self
         end
 
+        @options.merge!(opts)
+        @block = block
+
         return @attribute
       end
 
-      unless @attribute
-        raise "@attribute not defined yet for #{self.name}"
-      end
+      raise "@attribute not defined yet for #{self.name}" unless @attribute
 
       @attribute.attributes
     end
 
-
-    def self.domain_model(klass=nil)
+    def self.domain_model(klass = nil)
       return @domain_model if klass.nil?
       @domain_model = klass
     end
@@ -121,26 +116,25 @@ module Praxis
     def self.check_option!(name, value)
       case name
       when :identity
-        raise Attributor::AttributorException, "Invalid identity type #{value.inspect}" unless value.kind_of?(::Symbol)
+        raise Attributor::AttributorException, "Invalid identity type #{value.inspect}" unless value.is_a?(::Symbol)
         return :ok
       else
         return Attributor::Struct.check_option!(name, value)
       end
     end
 
-
-    def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
+    def self.load(value, context = Attributor::DEFAULT_ROOT_CONTEXT, **options)
       case value
       when self
         value
       when nil, Hash, String
         # Need to parse/deserialize first
         # or apply default/recursive loading options if necessary
-        if (value = self.attribute.load(value,context, **options))
+        if (value = self.attribute.load(value, context, **options))
           self.new(value)
         end
       else
-        if value.kind_of?(self.domain_model) || value.kind_of?(self::Struct)
+        if value.is_a?(self.domain_model) || value.is_a?(self::Struct)
           # Wrap the value directly
           self.new(value)
         else
@@ -151,7 +145,7 @@ module Praxis
     end
 
     class << self
-      alias_method :from, :load
+      alias from load
     end
 
     def self.caching_enabled?
@@ -173,36 +167,33 @@ module Praxis
 
     def self.valid_type?(value)
       # FIXME: this should be more... ducklike
-      value.kind_of?(self) || value.kind_of?(self.attribute.type)
+      value.is_a?(self) || value.is_a?(self.attribute.type)
     end
 
-    def self.example(context=nil, **values)
+    def self.example(context = nil, **values)
       context = case context
-      when nil
-        ["#{self.name}-#{values.object_id.to_s}"]
-      when ::String
-        [context]
-      else
-        context
-      end
+                when nil
+                  ["#{self.name}-#{values.object_id}"]
+                when ::String
+                  [context]
+                else
+                  context
+                end
 
       self.new(self.attribute.example(context, values: values))
     end
 
-
-    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
+    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
 
-      unless value.kind_of?(self)
+      unless value.is_a?(self)
         raise ArgumentError, "Error validating #{Attributor.humanize_context(context)} as #{self.name} for an object of type #{value.class.name}."
       end
 
       value.validate(context)
     end
 
-
     def self.view(name, **options, &block)
       if block_given?
         return self.views[name] = View.new(name, self, **options, &block)
@@ -218,7 +209,7 @@ module Praxis
       object.render(view: view, context: context, **opts)
     end
     class << self
-      alias_method :render, :dump
+      alias render dump
     end
 
     # Internal finalize! logic
@@ -234,7 +225,7 @@ module Praxis
     end
 
     def self.resolve_domain_model!
-      return unless self.domain_model.kind_of?(String)
+      return unless self.domain_model.is_a?(String)
 
       @domain_model = self.domain_model.constantize
     end
@@ -242,11 +233,12 @@ 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
 
     def self.define_readers!
-      self.attributes.each do |name, attribute|
+      self.attributes.each do |name, _attribute|
         name = name.to_sym
 
         # Don't redefine existing methods
@@ -256,7 +248,6 @@ module Praxis
       end
     end
 
-
     def self.define_reader!(name)
       attribute = self.attributes[name]
       # TODO: profile and optimize
@@ -268,53 +259,52 @@ module Praxis
           @decorators.send(name)
         else
           value = @object.__send__(name)
-          return value if value.nil? || value.kind_of?(attribute.type)
+          return value if value.nil? || value.is_a?(attribute.type)
           attribute.load(value)
         end
       end
     end
 
-
-
     def self.generate_master_view!
       attributes = self.attributes
       view :master do
-        attributes.each do | name, attr |
+        attributes.each do |name, _attr|
           # Note: we can freely pass master view for attributes that aren't blueprint/containers because
           # their dump methods will ignore it (they always dump everything regardless)
           attribute name, view: :default
         end
       end
     end
-
-
-    def initialize(object, decorators=nil)
+    
+    def initialize(object, decorators = nil)
       # TODO: decide what sort of type checking (if any) we want to perform here.
       @object = object
 
-      @decorators = if decorators.kind_of?(Hash) && decorators.any?
-        OpenStruct.new(decorators)
-      else
-        decorators
-      end
+      @decorators = if decorators.is_a?(Hash) && decorators.any?
+                      OpenStruct.new(decorators)
+                    else
+                      decorators
+                    end
 
       @validating = false
     end
 
+    # By default we'll use the object identity, to avoid rendering the same object twice
+    # Override, if there is a better way cache things up
+    def _cache_key
+      self.object
+    end
 
     # Render the wrapped data with the given view
-    def render(view_name=nil, context: Attributor::DEFAULT_ROOT_CONTEXT,renderer: Renderer.new, **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."
+    def render(view_name = nil, context: Attributor::DEFAULT_ROOT_CONTEXT, renderer: Renderer.new, **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.'
       elsif opts.key?(:view)
         view_name = opts[:view]
       end
 
       fields = opts[:fields]
-      if view_name.nil? && fields.nil?
-        view_name = :default
-      end
-
+      view_name = :default if view_name.nil? && fields.nil?
 
       if view_name
         unless (view = self.class.views[view_name])
@@ -325,7 +315,7 @@ module Praxis
 
       # Accept a simple array of fields, and transform it to a 1-level hash with true values
       if fields.is_a? Array
-        fields = fields.each_with_object({}) {|field, hash| hash[field] = true }
+        fields = fields.each_with_object({}) { |field, hash| hash[field] = true }
       end
 
       # expand fields
@@ -333,25 +323,37 @@ module Praxis
 
       renderer.render(self, expanded_fields, context: context)
     end
-    alias_method :to_hash, :render
-    alias_method :dump, :render
 
-    def validate(context=Attributor::DEFAULT_ROOT_CONTEXT)
-      raise ArgumentError, "Invalid context received (nil) while validating value of type #{self.name}" if context == nil
+    alias dump render
+
+    def to_h
+      Attributor.recursive_to_h(@object)
+    end
+
+    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
+      raise 'validation conflict' if @validating
       @validating = true
 
-      self.class.attributes.each_with_object(Array.new) do |(sub_attribute_name, sub_attribute), errors|
-        sub_context = self.class.generate_subcontext(context,sub_attribute_name)
+      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)
+        keys_with_values << sub_attribute_name unless value.nil?
 
         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))
+        errors.concat(sub_attribute.validate(value, sub_context))
       end
+      self.class.attribute.type.requirements.each do |req|
+        validation_errors = req.validate(keys_with_values, context)
+        errors.concat(validation_errors) unless validation_errors.empty?
+      end
+      errors
     ensure
       @validating = false
     end
@@ -361,6 +363,13 @@ module Praxis
       self.send(name)
     end
 
+    # Delegates the json-schema methods to the underlying attribute/member_type
+    def self.as_json_schema(**args)
+      @attribute.type.as_json_schema(args)
+    end
+    
+    def self.json_schema_type
+      @attribute.type.json_schema_type
+    end
   end
-
 end