pragma 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474ef14673089ce28a581b260a0c8913b3e1afe462eeb7cb840c406a29195316
-  data.tar.gz: 15174e9df88e96007f15475464d023eab01c92e3b791f8c0289382f65a01c279
+  metadata.gz: bd39da8a90334eb2afe3aeffae4bf1b83b1f2847f7a501065bcea8f0df15e9d0
+  data.tar.gz: e4bd66a3c01463012edc6502eb636473338eeaae434d1b1544bd7d5166e40f08
 SHA512:
-  metadata.gz: b1a710dd54c3a2aff7fa789293d160e0061c61e9d3fd86d3b00c8360efa6171de79719803c89a352ac6059895d3e1b4fdfe5d6c54e5e73e6ea0cbcdf68e0bc8c
-  data.tar.gz: 62440fa3450e7e40314e92d6a771c072657130cfd785b05cabf2becf736fb2429be7f012882308572791c2e6e113f52a206f199b5b549cc7385ac91d8d79748d
+  metadata.gz: 36d424c34488a97c82b80974e558e7cd317ca9c2b1f1eb8f5961ea1b07e3b8a9d33696e8f2aca48059315fb17b6bff3dd5ee5f3eea30f802328f00f5f76f7096
+  data.tar.gz: 7f9832ae44752caf106f08ea0acdf0a5e24b1aa0b10850987e5461f2c4dc83c027f4ece5e3c365dc10fe1743d0b105b5424141ca87c09b363acbd4b7b05934e2

data/.rubocop.yml

@@ -33,16 +33,16 @@ Metrics/LineLength:
   Max: 100
   AllowURI: true
 
-Layout/FirstParameterIndentation:
+Layout/IndentFirstArgument:
   Enabled: false
 
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
-Layout/IndentArray:
+Layout/IndentFirstArrayElement:
   EnforcedStyle: consistent
 
-Layout/IndentHash:
+Layout/IndentFirstHashElement:
   EnforcedStyle: consistent
 
 Style/SignalException:

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [2.5.0]
+
+### Added
+
+- Expose `type` property for API errors
+- Expanded associations are now eager-loaded automatically
+- Calling macros whose support classes are undefined will now raise a `MissingSkillError`
+
+### Fixed
+
+- Fixed computation of classes for nested operations
+
 ## [2.4.0]
 
 ### Added
@@ -76,7 +88,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 First Pragma 2 release.
 
-[Unreleased]: https://github.com/pragmarb/pragma/compare/v2.4.0...HEAD
+[Unreleased]: https://github.com/pragmarb/pragma/compare/v2.5.0...HEAD
+[2.5.0]: https://github.com/pragmarb/pragma/compare/v2.4.0...v2.5.0
 [2.4.0]: https://github.com/pragmarb/pragma/compare/v2.3.0...v2.4.0
 [2.3.0]: https://github.com/pragmarb/pragma/compare/v2.2.0...v2.3.0
 [2.2.0]: https://github.com/pragmarb/pragma/compare/v2.1.1...v2.2.0

data/lib/pragma.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'adaptor'
+
 require 'pragma/operation'
 require 'pragma/policy'
 require 'pragma/contract'
@@ -19,6 +21,7 @@ require 'pragma/filter/boolean'
 
 require 'pragma/operation/filter'
 
+require 'pragma/macro'
 require 'pragma/macro/classes'
 require 'pragma/macro/decorator'
 require 'pragma/macro/filtering'
@@ -32,6 +35,11 @@ require 'pragma/macro/contract/persist'
 
 require 'pragma/operation/macro'
 
+require 'pragma/association_includer/base'
+require 'pragma/association_includer/active_record'
+require 'pragma/association_includer/poro'
+require 'pragma/association_includer'
+
 require 'pragma/operation/index'
 require 'pragma/operation/show'
 require 'pragma/operation/create'

data/lib/pragma/association_includer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Pragma
+  module AssociationIncluder
+    include Adaptor::Loader
+    register ActiveRecord, Poro
+  end
+end

data/lib/pragma/association_includer/active_record.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Pragma
+  module AssociationIncluder
+    class ActiveRecord < Base
+      class << self
+        def supports?(relation)
+          defined?(::ActiveRecord::Relation) && relation.is_a?(::ActiveRecord::Relation)
+        end
+      end
+
+      def include_associations(expands)
+        relation.includes(validate_associations(
+          relation.model,
+          destruct_associations(expands)
+        ))
+      end
+
+      private
+
+      def destruct_associations(expands)
+        associations = {}
+
+        expands.each do |expand|
+          expand.split('.').inject(associations) do |accumulator, association|
+            accumulator[association] ||= {}
+          end
+        end
+
+        associations
+      end
+
+      def validate_associations(model, associations)
+        Hash[associations.map do |(key, value)|
+          reflection = model.reflect_on_association(key.to_sym)
+          reflection ? [key, validate_associations(reflection.klass, value)] : [false, false]
+        end.select { |_, v| v }]
+      end
+    end
+  end
+end

data/lib/pragma/association_includer/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pragma
+  module AssociationIncluder
+    class Base
+      attr_reader :relation
+
+      class << self
+        def supports?(_relation)
+          fail NotImplementedError
+        end
+      end
+
+      def initialize(relation)
+        @relation = relation
+      end
+
+      def include_associations(_expands)
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/pragma/association_includer/poro.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pragma
+  module AssociationIncluder
+    class Poro < Base
+      class << self
+        def supports?(_relation)
+          true
+        end
+      end
+
+      def include_associations(_expands)
+        relation
+      end
+    end
+  end
+end

data/lib/pragma/decorator/error.rb

@@ -3,9 +3,15 @@
 module Pragma
   module Decorator
     class Error < Pragma::Decorator::Base
+      include Pragma::Decorator::Type
+
       property :error_type
       property :error_message
       property :meta
+
+      def type
+        :error
+      end
     end
   end
 end

data/lib/pragma/macro.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Pragma
+  module Macro
+    class << self
+      # Returns a skill or raises a {#MissingSkillError}.
+      #
+      # @param macro [String] the name of the macro requiring the skill
+      # @param skill [String] the name of the string
+      # @param options [Hash] the +options+ hash of the operation
+      #
+      # @return [Object] the value of the skill
+      #
+      # @raise [MissingSkillError] if the skill is undefined or +nil+
+      #
+      # @private
+      def require_skill(macro, skill, options)
+        options[skill] || fail(MissingSkillError.new(macro, skill))
+      end
+    end
+
+    # Error raised when a skill is required but not present.
+    #
+    # @private
+    class MissingSkillError < StandardError
+      # Initializes the error.
+      #
+      # @param macro [String] the macro requiring the skill
+      # @param skill [String] the name of the missing skill
+      def initialize(macro, skill)
+        message = <<~ERROR
+          You are attempting to use the #{macro} macro, but no `#{skill}' skill is defined.
+
+          You can define the skill by adding the following to your operation:
+
+            self['#{skill}'] = MyCustomClass
+
+          If the skill holds a class, this can happen when the required class (e.g. the contract
+          class) is not in the expected location. If that's the case, you can just move the class to
+          the expected location and avoid defining the skill manually.
+        ERROR
+
+        super message
+      end
+    end
+  end
+end

data/lib/pragma/macro/classes.rb

@@ -42,13 +42,15 @@ module Pragma
         private
 
         def resource_namespace(input, _options)
-          input.class.name.split('::')[0..-3]
+          parts = input.class.name.split('::')
+          parts[0..(parts.index('Operation') - 1)]
         end
 
         def root_namespace(input, options)
           resource_namespace = resource_namespace(input, options)
-          return [] if %w[API Api].include?(resource_namespace.first)
-          api_index = (resource_namespace.index('API') || resource_namespace.index('Api') || 1)
+          return [] if resource_namespace.first.casecmp('API').zero?
+
+          api_index = (resource_namespace.map(&:upcase).index('API') || 1)
           resource_namespace[0..(api_index - 1)]
         end
 
@@ -87,10 +89,12 @@ module Pragma
         end
 
         def expected_contract_class(input, options)
+          parts = input.class.name.split('::')
+
           [
             resource_namespace(input, options),
             'Contract',
-            input.class.name.split('::').last
+            parts[(parts.index('Operation') + 1)..-1]
           ].join('::')
         end
       end

data/lib/pragma/macro/contract/build.rb

@@ -7,6 +7,8 @@ module Pragma
     module Contract
       def self.Build(name: 'default', constant: nil, builder: nil)
         step = lambda do |input, options|
+          Macro.require_skill('Contract::Build', "contract.#{name}.class", options)
+
           Trailblazer::Operation::Contract::Build.for(
             input,
             options,

data/lib/pragma/macro/contract/persist.rb

@@ -7,6 +7,8 @@ module Pragma
     module Contract
       def self.Persist(method: :save, name: 'default')
         step = lambda do |input, options|
+          Macro.require_skill('Contract::Persist', "contract.#{name}.class", options)
+
           Trailblazer::Operation::Pipetree::Step.new(
             Trailblazer::Operation::Contract::Persist(method: method, name: name).first
           ).call(input, options).tap do |result|

data/lib/pragma/macro/contract/validate.rb

@@ -7,6 +7,8 @@ module Pragma
     module Contract
       def self.Validate(name: 'default', **args)
         step = lambda do |input, options|
+          Macro.require_skill('Contract::Validate', "contract.#{name}.class", options)
+
           Trailblazer::Operation::Pipetree::Step.new(
             Trailblazer::Operation::Contract::Validate(**args).first
           ).call(input, options).tap do |result|

data/lib/pragma/macro/decorator.rb

@@ -10,13 +10,13 @@ module Pragma
     module Decorator
       class << self
         def for(_input, name, options)
+          klass = Macro.require_skill('Decorator', "decorator.#{name}.class", options)
+
           set_defaults(options)
 
           return false unless validate_params(options)
 
-          options["result.decorator.#{name}"] = options["decorator.#{name}.class"].new(
-            options['model']
-          )
+          options["result.decorator.#{name}"] = klass.new(options['model'])
 
           validate_expansion(options, name)
         end
@@ -63,6 +63,7 @@ module Pragma
 
         def validate_expansion(options, name)
           return true unless options["result.decorator.#{name}"].respond_to?(:validate_expansion)
+
           options["result.decorator.#{name}"].validate_expansion(options['params'][:expand])
           true
         rescue Pragma::Decorator::Association::ExpansionError => e

data/lib/pragma/macro/model.rb

@@ -6,9 +6,11 @@ module Pragma
   module Macro
     def self.Model(action = nil)
       step = lambda do |input, options|
+        klass = Macro.require_skill('Model', 'model.class', options)
+
         Trailblazer::Operation::Pipetree::Step.new(
-          Trailblazer::Operation::Model.for(options['model.class'], action),
-          'model.class' => options['model.class'],
+          Trailblazer::Operation::Model.for(klass, action),
+          'model.class' => klass,
           'model.action' => action
         ).call(input, options).tap do |result|
           unless result

data/lib/pragma/macro/policy.rb

@@ -10,7 +10,9 @@ module Pragma
     module Policy
       class << self
         def for(input, name, options, action = nil)
-          policy = options["policy.#{name}.class"].new(
+          klass = Macro.require_skill('Policy', "policy.#{name}.class", options)
+
+          policy = klass.new(
             options['policy.context'] || options['current_user'],
             options['model']
           )

data/lib/pragma/operation/index.rb

@@ -4,8 +4,6 @@ module Pragma
   module Operation
     # Finds all records of the requested resource, authorizes them, paginates them and decorates
     # them.
-    #
-    # @author Alessandro Desantis
     class Index < Pragma::Operation::Base
       step Macro::Classes()
       step :retrieve!, name: 'retrieve'
@@ -14,12 +12,19 @@ module Pragma
       step Macro::Ordering()
       step Macro::Pagination()
       step Macro::Decorator(name: :collection)
+      step :include!, name: 'include'
       step :respond!, name: 'respond'
 
       def retrieve!(options)
         options['model'] = options['model.class'].all
       end
 
+      def include!(options)
+        options['model'] = AssociationIncluder
+          .load_adaptor(options['model'])
+          .include_associations(options['params'][:expand] || [])
+      end
+
       # TODO: Turn this into a macro.
       def scope!(options, model:, **)
         options['model'] = options['policy.default.scope.class'].new(

data/lib/pragma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pragma
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 end

data/pragma.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'adaptor', '~> 0.2'
   spec.add_dependency 'pragma-contract', '~> 2.0'
   spec.add_dependency 'pragma-decorator', '~> 2.0'
   spec.add_dependency 'pragma-operation', '~> 2.0'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pragma
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-09 00:00:00.000000000 Z
+date: 2019-06-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: adaptor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: pragma-contract
   requirement: !ruby/object:Gem::Requirement
@@ -197,6 +211,10 @@ files:
 - bin/console
 - bin/setup
 - lib/pragma.rb
+- lib/pragma/association_includer.rb
+- lib/pragma/association_includer/active_record.rb
+- lib/pragma/association_includer/base.rb
+- lib/pragma/association_includer/poro.rb
 - lib/pragma/decorator/error.rb
 - lib/pragma/filter/base.rb
 - lib/pragma/filter/boolean.rb
@@ -205,6 +223,7 @@ files:
 - lib/pragma/filter/like.rb
 - lib/pragma/filter/scope.rb
 - lib/pragma/filter/where.rb
+- lib/pragma/macro.rb
 - lib/pragma/macro/classes.rb
 - lib/pragma/macro/contract/build.rb
 - lib/pragma/macro/contract/persist.rb
@@ -243,8 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: A pragmatic architecture for building JSON APIs with Ruby.