praxis 2.0.pre.2 → 2.0.pre.7

data/lib/praxis/handlers/json.rb

@@ -17,6 +17,8 @@ module Praxis
       # @param [String] document
       # @return [Hash,Array] the structured-data representation of the document
       def parse(document)
+        # Try to be nice and accept an empty string as an empty payload (seems nice to do for dumb http clients)
+        return nil if (document.nil? || document == '')
         ::JSON.parse(document)
       end
 

data/lib/praxis/handlers/www_form.rb

@@ -1,3 +1,8 @@
+# This is an example of a handler that can load and generate www-url-encoded payloads.
+# Note that if you use your API to pass nil values for attributes as a way to unset their 
+# values, this handler will not work (as there isn't necessarily a defined "null" value in 
+# this encoding (although you can probably define how to encode/decode it and use it as such)
+# Use at your own risk.
 module Praxis
   module Handlers
     class WWWForm

data/lib/praxis/handlers/{xml.rb → xml-sample.rb}

@@ -1,3 +1,9 @@
+# This is an example of a handler that can load and generate 'activesupport-style' xml payloads.
+# Note that if you use your API to pass nil values for attributes as a way to unset their values, 
+# this handler will not work (as there isn't necessarily a defined "null"  value in this encoding 
+# (although you can probably define how to encode/decode it and use it as such)
+# Use at your own risk
+
 module Praxis
   module Handlers
     class XML

data/lib/praxis/links.rb

@@ -54,6 +54,10 @@ module Praxis
       super(false,**opts) # Links must always describe attributes
     end
 
+    def self.json_schema_type
+      @attribute.type.json_schema_type
+    end
+
     def self._finalize!
       super
       if @attribute

data/lib/praxis/mapper/active_model_compat.rb

@@ -3,6 +3,7 @@
 require 'active_support/concern'
 
 require 'praxis/extensions/field_selection/active_record_query_selector'
+require 'praxis/extensions/attribute_filtering/active_record_filter_query_builder'
 
 module Praxis
   module Mapper
@@ -15,7 +16,7 @@ module Praxis
 
       module ClassMethods
         def _filter_query_builder_class
-          Praxis::Extensions::ActiveRecordFilterQueryBuilder
+          Praxis::Extensions::AttributeFiltering::ActiveRecordFilterQueryBuilder
         end
 
         def _field_selector_query_builder_class
@@ -46,18 +47,70 @@ module Praxis
               else
                 raise "Unknown association type: #{v.class.name} on #{v.klass.name} for #{v.name}"
               end
+            # Call out any local (i.e., of this model) columns that participate in the association 
+            info[:local_key_columns] = local_columns_used_for_the_association(info[:type], v)
+            info[:remote_key_columns] = remote_columns_used_for_the_association(info[:type], v)
 
             if v.is_a?(ActiveRecord::Reflection::ThroughReflection)
               info[:through] = v.through_reflection.name # TODO: is this correct?
             end
-
-            # TODO: add more keys for the association to make true praxis mapper functions happy
             hash[k.to_sym] = info
           end
         end
 
+        def _join_foreign_key_for(assoc_reflection)
+          maj, min, _ = ActiveRecord.gem_version.segments
+          if maj >= 6 && min >=1
+            assoc_reflection.join_foreign_key.to_sym
+          else
+            assoc_reflection.join_keys.foreign_key.to_sym
+          end
+        end
+
+        def _join_primary_key_for(assoc_reflection)
+          maj, min, _ = ActiveRecord.gem_version.segments
+          if maj >= 6 && min >=1
+            assoc_reflection.join_primary_key.to_sym
+          else
+            assoc_reflection.join_keys.key.to_sym
+          end
+        end
+        private
+        def local_columns_used_for_the_association(type, assoc_reflection)
+          case type
+          when :one_to_many
+            # The associated table  will point to us by key (usually the PK, but not always)
+            [_join_foreign_key_for(assoc_reflection)]
+          when :many_to_one
+            # We have the FKs to the associated model
+            [_join_foreign_key_for(assoc_reflection)]
+          when :many_to_many
+            ref = resolve_closest_through_reflection(assoc_reflection)
+            # The associated middle table will point to us by key (usually the PK, but not always)
+            [_join_foreign_key_for(ref)] # The foreign key that the last through table points to
+          else 
+            raise "association type #{type} not supported"
+          end
+        end
+
+        def remote_columns_used_for_the_association(type, assoc_reflection)
+          # It seems that since the reflection is the target of the association, using the join_keys.key
+          # will always get us the right column
+          case type
+          when :one_to_many, :many_to_one, :many_to_many
+            [_join_primary_key_for(assoc_reflection)]
+          else 
+            raise "association type #{type} not supported"
+          end
+        end
+  
+        # Keep following the association reflections as long as there are middle ones (i.e., through)
+        # until we come to the one next to the source
+        def resolve_closest_through_reflection(ref)
+          return ref unless ref.through_reflection?
+          resolve_closest_through_reflection( ref.through_reflection )
+        end
       end
-    
     end
   end
 end

data/lib/praxis/mapper/resource.rb

@@ -196,26 +196,33 @@ module Praxis::Mapper
     end
 
     # TODO: this shouldn't be needed if we incorporate it with the properties of the mapper...
-    def self.filters_mapping(hash)
-      @_filter_query_builder_class = model._filter_query_builder_class.for(**hash)
-    end
-    
-    def self._filter_query_builder_class
-      @_filter_query_builder_class
+    # ...maybe what this means is that we can change it for a better DSL in the resource?
+    def self.filters_mapping(definition)
+      @_filters_map = \
+        case definition
+        when Hash
+          definition
+        when Array
+          definition.each_with_object({}) { |item, hash| hash[item.to_sym] = item }
+        else
+          raise "Resource.filters_mapping only allows a hash or an array"
+        end
     end
 
     def self.craft_filter_query(base_query, filters:) # rubocop:disable Metrics/AbcSize
-      if filters && _filter_query_builder_class
-        base_query = _filter_query_builder_class.new(query: base_query, model: model).build_clause(filters)
+      if filters 
+        raise "Must define the mapping of filters if want to use Filtering for resource: #{self}" unless @_filters_map
+        debug = Praxis::Application.instance.config.mapper.debug_queries
+        base_query = model._filter_query_builder_class.new(query: base_query, model: model, filters_map: @_filters_map, debug: debug).generate(filters)
       end
       
       base_query
     end
 
-    def self.craft_field_selection_query(base_query, selectors:, resolved:) # rubocop:disable Metrics/AbcSize
+    def self.craft_field_selection_query(base_query, selectors:) # rubocop:disable Metrics/AbcSize
       if selectors && model._field_selector_query_builder_class
-        base_query = model._field_selector_query_builder_class.new(query: base_query, model: self.model,
-                                          selectors: selectors, resolved: resolved).generate
+        debug = Praxis::Application.instance.config.mapper.debug_queries
+        base_query = model._field_selector_query_builder_class.new(query: base_query, selectors: selectors, debug: debug).generate
       end
       
       base_query

data/lib/praxis/mapper/selector_generator.rb

@@ -1,101 +1,84 @@
 module Praxis::Mapper
-  # Generates a set of selectors given a resource and
-  # list of resource attributes.
-  class SelectorGenerator
-    attr_reader :selectors
 
-    def initialize
-      @selectors = Hash.new do |hash, key|
-        hash[key] = {select: Set.new, track: Set.new}
-      end
-      @seen = Hash.new do |hash, resource|
-        hash[resource] = Set.new
-      end
-    end
+  class SelectorGeneratorNode
+    attr_reader :select, :model, :resource, :tracks
 
-    def add(resource, fields)
-      return if @seen[resource].include? fields
-      @seen[resource] << fields
+    def initialize(resource)
+      @resource = resource
 
-      fields.each do |name, field|
-        map_property(resource, name, field)
-      end
+      @select = Set.new
+      @select_star = false
+      @tracks = Hash.new 
     end
 
-    def select_all(resource)
-      selectors[resource.model][:select] = true
+    def add(fields)
+      fields.each do |name, field|
+        map_property(name, field)
+      end
+      self
     end
 
-    def map_property(resource, name, fields)
+    def map_property(name, fields)
+      praxis_compat_model = resource.model && resource.model.respond_to?(:_praxis_associations)
       if resource.properties.key?(name)
-        add_property(resource, name, fields)
-      elsif resource.model._praxis_associations.key?(name)
-        add_association(resource, name, fields)
+        add_property(name, fields)
+      elsif praxis_compat_model && resource.model._praxis_associations.key?(name)
+        add_association(name, fields)
       else
-        add_select(resource, name)
+        add_select(name)
       end
     end
 
-    def add_select(resource, name)
-      return select_all(resource) if name == :*
-      return if selectors[resource.model][:select] == true
-
-      selectors[resource.model][:select] << name
-    end
-
-    def add_track(resource, name)
-      selectors[resource.model][:track] << name
-    end
-
-    def add_association(resource, name, fields)
+    def add_association(name, fields)
+      
       association = resource.model._praxis_associations.fetch(name) do
         raise "missing association for #{resource} with name #{name}"
       end
       associated_resource = resource.model_map[association[:model]]
-
-      case association[:type]
-      when :many_to_one
-        add_track(resource, name)
-        Array(association[:key]).each do |akey|
-          add_select(resource, akey)
-        end
-      when :one_to_many
-        add_track(resource, name)
-        Array(association[:key]).each do |akey|
-          add_select(associated_resource, akey)
-        end
-      when :many_to_many
-        # If we haven't explicitly added the "through" option in the association
-        # then we'll assume the underlying ORM is able to fill in the gap. We will
-        # simply add the fields for the associated resource below
-        if association.key? :through
-          head, *tail = association[:through]
-          new_fields = tail.reverse.inject(fields) do |thing, step|
-            {step => thing}
-          end
-          return add_association(resource, head, new_fields)
-        else
-          add_track(resource, name)
+      unless associated_resource
+        raise "Whoops! could not find a resource associated with model #{association[:model]} (root resource #{resource})"
+      end
+      # Add the required columns in this model to make sure the association can be loaded
+      association[:local_key_columns].each {|col| add_select(col) }
+      
+      node = SelectorGeneratorNode.new(associated_resource)
+      unless association[:remote_key_columns].empty?
+        # Make sure we add the required columns for this association to the remote model query
+        fields = {} if fields == true
+        new_fields_as_hash = association[:remote_key_columns].each_with_object({}) do|name, hash|
+          hash[name] = true
         end
-      else
-        raise "no select applicable for #{association[:type].inspect}"
+        fields.merge!(new_fields_as_hash) 
       end
 
-      unless fields == true
-        # recurse into the field
-        add(associated_resource,fields)
-      end
+      node.add(fields) unless fields == true
+
+      self.merge_track(name, node)
+    end
+
+    def add_select(name)
+      return @select_star = true if name == :*
+      return if @select_star
+      @select.add name
     end
 
-    def add_property(resource, name, fields)
+    def add_property(name, fields)
       dependencies = resource.properties[name][:dependencies]
+      # Always add the underlying association if we're overriding the name...
+      praxis_compat_model = resource.model && resource.model.respond_to?(:_praxis_associations)
+      if praxis_compat_model && resource.model._praxis_associations.key?(name)
+        add_association(name, fields)
+      end
       if dependencies
         dependencies.each do |dependency|
-          # if dependency includes the name, then map it directly as the field
+          # To detect recursion, let's allow mapping depending fields to the same name of the property
+          # but properly detecting if it's a real association...in which case we've already added it above
           if dependency == name
-            add_select(resource, name)
+            unless praxis_compat_model && resource.model._praxis_associations.key?(name)
+              add_select(name)
+            end
           else
-            apply_dependency(resource, dependency)
+            apply_dependency(dependency)
           end
         end
       end
@@ -107,20 +90,61 @@ module Praxis::Mapper
         {step => thing}
       end
 
-      add_association(resource, head, new_fields)
+      add_association(head, new_fields)
     end
 
-    def apply_dependency(resource, dependency)
+    def apply_dependency(dependency)
       case dependency
       when Symbol
-        map_property(resource, dependency, {})
+        map_property(dependency, true)
       when String
         head, tail = dependency.split('.').collect(&:to_sym)
         raise "String dependencies can not be singular" if tail.nil?
 
-        add_association(resource, head, {tail => true})
+        add_association(head, {tail => true})
+      end
+    end
+
+    def merge_track( track_name, node )
+      raise "Cannot merge another node for association #{track_name}: incompatible model" unless node.model == self.model
+
+      existing = self.tracks[track_name]
+      if existing
+        node.select.each do|col_name|
+          existing.add_select(col_name)
+        end
+        node.tracks.each do |name, n|
+          existing.merge_track(name, n)
+        end
+      else
+        self.tracks[track_name] = node
       end
     end
 
+    def dump
+      hash = {}
+      hash[:model] = resource.model
+      if !@select.empty? || @select_star
+        hash[:columns] = @select_star ? [ :* ] : @select.to_a 
+      end
+      unless @tracks.empty?
+        hash[:tracks] = @tracks.each_with_object({}) {|(name, node), hash|  hash[name] = node.dump }
+      end
+      hash
+    end
+  end
+
+  # Generates a set of selectors given a resource and
+  # list of resource attributes.
+  class SelectorGenerator
+    # Entry point
+    def add(resource, fields)
+      @root = SelectorGeneratorNode.new(resource)
+      @root.add(fields)
+    end
+
+    def selectors
+      @root
+    end
   end
 end

data/lib/praxis/mapper/sequel_compat.rb

@@ -1,23 +1,30 @@
 require 'active_support/concern'
 
+
 module Praxis::Mapper
   module SequelCompat
     extend ActiveSupport::Concern
 
-``    included do
+    included do
       attr_accessor :_resource
     end
 
     module ClassMethods
       def _filter_query_builder_class
+        # TODO: refactor the query builder, and add the explicit require in this file
         Praxis::Extensions::SequelFilterQueryBuilder
       end
 
+      def _field_selector_query_builder_class
+        Praxis::Extensions::FieldSelection::SequelQuerySelector
+      end
+
       def _praxis_associations
         orig = self.association_reflections.clone
-
         orig.each do |k,v|
           v[:model] = v.associated_class
+          v[:local_key_columns] = local_columns_used_for_the_association(v[:type], v)
+          v[:remote_key_columns] = remote_columns_used_for_the_association(v[:type], v)
           if v.respond_to?(:primary_key)
             v[:primary_key] = v.primary_key
           else
@@ -31,7 +38,40 @@ module Praxis::Mapper
         orig
       end
 
+      private
+      def local_columns_used_for_the_association(type, assoc_reflection)
+        case type
+        when :one_to_many
+          # The associated table (or middle table if many to many) will point to us by PK
+          assoc_reflection[:primary_key_columns]
+        when :many_to_one
+          # We have the FKs to the associated model
+          assoc_reflection[:keys]
+        when :many_to_many
+          # The middle table if many to many) will point to us by key (usually the PK, but not always)
+          assoc_reflection[:left_primary_keys]
+        else 
+          raise "association type #{type} not supported"
+        end
+      end
+
+      def remote_columns_used_for_the_association(type, assoc_reflection)
+        case type
+        when :one_to_many
+          # The columns in the associated table that will point back to the original association
+          assoc_reflection[:keys]
+        when :many_to_one
+          # The columns in the associated table that the children will point to (usually the PK, but not always) ??
+          [assoc_reflection.associated_class.primary_key]
+        when :many_to_many
+          # The middle table if many to many will point to us by key (usually the PK, but not always) ??
+          [assoc_reflection.associated_class.primary_key]
+        else 
+          raise "association type #{type} not supported"
+        end
+      end
+
     end
 
   end
-end
+end