caprese 0.3.19.3 → 0.3.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52dc5d95f51d80297a0e75ced5e685de0596c360
-  data.tar.gz: dd5682687744ecf3c6effa11ca8e3474c53d0f8e
+  metadata.gz: f20459249bd9aa768296fff0603eacaec3d53c99
+  data.tar.gz: 667f7a0cd853d8f69099a78ecfaa76c48d15f5de
 SHA512:
-  metadata.gz: f5ab75ad8385ba8bb431d2de68e13cb7c324975bf5a7c4f9f32bc88d52ce831f4ef15be010d573217995ff9cf9be876a7381e2ffbc40a9ee6a60ccbbe7a798ae
-  data.tar.gz: e4dc0068ec675cd58827d1f8222fc75a624fc38922befbf979859aea1bae472868a797577712d347438e8f525d1ec33bf868068ac866746989a42e3da803ed7e
+  metadata.gz: 17f2e85ce1abeddd71ee15ce76c68e425b7f6cc8a4e2f71732cdebcd37df424dd8927716a6927cdb05ed861bd09cc3b1fdddb0ad8f8f39ba18b7cf1b905e6a17
+  data.tar.gz: f936557de63859192d37419ba50df905949835df4359e0ccfde5ea058b7093f4a7b4f538a5e76496accc17e8dfc55ff1f169a56950685fe47bddb7254cd76b79

data/CHANGELOG.md

@@ -111,3 +111,9 @@
 ## 0.3.19.3
 
 * Fix use of `ActiveRecord::Validations::AssociatedValidator` in `Caprese::AssociatedValidator`
+
+## 0.3.20
+
+* Add `Caprese::Controller#resource_type_aliases` method that returns object mapping type aliases to actual types for the application
+* Add `Caprese::Record.caprese_field_aliases` method that returns object mapping field aliases to actual fields for the record
+* Add `Caprese::Record.caprese_type` method that returns singular symbol indicating the type to use when serializing the record. (`Caprese::Serializer.json_api_key` now uses this.)

data/lib/caprese/adapter/json_api.rb

@@ -425,7 +425,8 @@ module Caprese
           allow_wildcard: true
         )
         serializer.associations(include_directive).each_with_object({}) do |association, hash|
-          hash[association.key] = Relationship.new(
+          aliased_key = serializer.object.class.caprese_alias_field(association.key)
+          hash[aliased_key] = Relationship.new(
             serializer,
             instance_options,
             association,

data/lib/caprese/controller/concerns/aliasing.rb

@@ -0,0 +1,65 @@
+require 'active_support/concern'
+require 'caprese/errors'
+
+module Caprese
+  module Aliasing
+    extend ActiveSupport::Concern
+
+    # Specifies specific resource models that have types that are aliased.
+    # @note The `caprese_type` class variable of the model should also be set to the new type
+    # @example
+    #   {
+    #     questions: attributes
+    #   }
+    def resource_type_aliases
+      {}
+    end
+
+    # Checks resource_type_aliases for a type alias, or returns the type already stated
+    #
+    # @param [Symbol] type the type to search for an alias for
+    # @return [Symbol] the actual type for the type alias
+    def actual_type(type)
+      resource_type_aliases[type] || type
+    end
+
+    # Gets the actual field name for the controller_record_class for any given field requested
+    #
+    # @param [Symbol,String] field the field that was requested
+    # @param [Class] klass the klass to get field aliases for
+    # @return [Symbol] the actual field name for the field requested
+    def actual_field(field, klass = controller_record_class)
+      klass.caprese_unalias_field(field.to_sym)
+    end
+
+    # Takes in a set of possibly aliased includes and converts them to their actual names
+    #
+    # @param [String] the CSV string of possibly aliased includes
+    # @return [Array<String>] the actual includes
+    def actual_includes(includes)
+      includes.split(',').map do |i|
+        if(i = i.split('.')).size > 1
+          klass = nil
+          i.map do |i2|
+            actual = actual_field(i2, klass)
+            klass = klass.reflections[actual].klass
+            actual
+          end.join('.')
+        else
+          actual_field(i)
+        end
+      end
+    end
+
+    # Takes in a set of possibly aliased fields with types and converts them to their actual
+    # types and fields
+    #
+    # @param [Hash<Array>] the hash of possibly aliased resource types with their possibly aliased field specifier arrays
+    # @return [Hash<Array>] the actual resource type and fields
+    def actual_fields(fields)
+      Hash[*fields.each do |type, fields|
+        [actual_type(type), fields.map { |f| actual_field(f, record_class(type)) }]
+      end]
+    end
+  end
+end

data/lib/caprese/controller/concerns/persistence.rb

@@ -220,12 +220,20 @@ module Caprese
     # @param [Array] permitted_params the permitted params for the action
     # @param [Parameters] data the data sent to the server to construct and assign to the record
     def assign_record_attributes(record, permitted_params, data)
-      attributes = data[:attributes].try(:permit, *permitted_params) || {}
+      attributes = data[:attributes].try(:permit, *permitted_params).try(:inject, {}) do |out, (attr, val)|
+        out[actual_field(attr, record.class)] = val
+        out
+      end || {}
 
       data[:relationships]
       .try(:slice, *flattened_keys_for(permitted_params))
       .try(:each) do |relationship_name, relationship_data|
-        attributes[relationship_name] = records_for_relationship(
+        actual_relationship_name = actual_field(relationship_name, record.class)
+
+        # TODO: Add checkme for relationship_name to ensure that format is correct (not Array when actually Record, vice versa)
+        #   No relationship exists as well
+
+        attributes[actual_relationship_name] = records_for_relationship(
           record,
           nested_params_for(relationship_name, permitted_params),
           relationship_name,

data/lib/caprese/controller/concerns/query.rb

@@ -134,9 +134,9 @@ module Caprese
         query_params[:sort].each do |sort_field|
           ordering = ordering.merge(
             if sort_field[0] == '-' # EX: -created_at, sort by created_at descending
-              { sort_field[1..-1] => :desc }
+              { actual_field(sort_field[1..-1]) => :desc }
             else
-              { sort_field => :asc }
+              { actual_field(sort_field) => :asc }
             end
           )
         end
@@ -172,9 +172,9 @@ module Caprese
         scope = record_scope(unversion(params[:controller]).to_sym)
 
         if scope.any? && query_params[:filter].try(:any?)
-          if (valid_filters = query_params[:filter].select { |k, _| scope.column_names.include? k }).present?
+          if (valid_filters = query_params[:filter].select { |k, _| scope.column_names.include? actual_field(k).to_s }).present?
             valid_filters.each do |k, v|
-              scope = scope.where(k => v)
+              scope = scope.where(actual_field(k) => v)
             end
           end
         end

data/lib/caprese/controller/concerns/relationships.rb

@@ -207,24 +207,26 @@ module Caprese
             )
           end
 
+        relationship_name = queried_association.reflection.name
+
         successful =
           case queried_association.reflection.macro
           when :has_many
             if request.patch?
-              queried_record.send("#{params[:relationship]}=", relationship_resources)
+              queried_record.send("#{relationship_name}=", relationship_resources)
             elsif request.post?
-              queried_record.send(params[:relationship]).push relationship_resources
+              queried_record.send(relationship_name).push relationship_resources
             elsif request.delete?
-              queried_record.send(params[:relationship]).delete relationship_resources
+              queried_record.send(relationship_name).delete relationship_resources
             end
           when :has_one
             if request.patch?
-              queried_record.send("#{params[:relationship]}=", relationship_resources[0])
+              queried_record.send("#{relationship_name}=", relationship_resources[0])
               objects[0].save
             end
           when :belongs_to
             if request.patch?
-              queried_record.send("#{params[:relationship]}=", relationship_resources[0])
+              queried_record.send("#{relationship_name}=", relationship_resources[0])
               queried_record.save
             end
           end
@@ -247,7 +249,7 @@ module Caprese
     def queried_association
       unless @queried_association
         begin
-          @queried_association = queried_record.association(params[:relationship])
+          @queried_association = queried_record.association(actual_field(params[:relationship]))
         rescue ActiveRecord::AssociationNotFoundError => e
           fail AssociationNotFoundError.new(params[:relationship])
         end

data/lib/caprese/controller/concerns/typing.rb

@@ -16,7 +16,15 @@ module Caprese
     # @param [Symbol] type the record type to get the class for
     # @return [Class] the class for a given record type
     def record_class(type)
-      type.to_s.classify.constantize
+      begin
+        type.to_s.classify.constantize
+      rescue NameError => e
+        if resource_type_aliases[type.to_sym]
+          record_class(resource_type_aliases[type.to_sym].to_sym)
+        else
+          raise e
+        end
+      end
     end
 
     # Gets the record class for the current controller

data/lib/caprese/controller.rb

@@ -1,6 +1,7 @@
 require 'action_controller'
 require 'active_support/configurable'
 require 'caprese/concerns/versioning'
+require 'caprese/controller/concerns/aliasing'
 require 'caprese/controller/concerns/callbacks'
 require 'caprese/controller/concerns/errors'
 require 'caprese/controller/concerns/persistence'
@@ -13,7 +14,10 @@ module Caprese
   # TODO: Convert to ActionController::API with Rails 5
   class Controller < ActionController::Base
     include ActiveSupport::Configurable
+    include Aliasing
     include Callbacks
+    # FIXME: Be careful about including `Errors` in certain order, because it has `rescue_from Exception` and this affects
+    #   control flow with other rescue handlers if included after their modules
     include Errors
     include Persistence
     include Query

data/lib/caprese/record/aliasing.rb

@@ -0,0 +1,59 @@
+require 'active_support/concern'
+
+module Caprese
+  module Record
+    module Aliasing
+      extend ActiveSupport::Concern
+
+      # Provides an intermediary helper method on records that defines non-column attributes for records
+      # @note This exists so there is a method by which to state that a non-column attribute should
+      #   have an error source pointer like `/data/attributes/[name]` instead of `/data/relationships/[name]`
+      def caprese_is_attribute?(attribute_name)
+        false
+      end
+
+      # Checks that any field provided is either an attribute on the record, or an aliased field, or none
+      #
+      # @param [String,Symbol] field the field to check for on this record
+      # @return [Boolean] whether or not the field is on the record
+      def caprese_is_field?(field)
+        respond_to?(field = field.to_sym) || caprese_is_attribute?(field) || self.class.caprese_field_aliases[field]
+      end
+
+      module ClassMethods
+        # Given an actual field, convert to its appropriate field alias for the class
+        # @note The reason this is useful is because ActiveRecord validations must validate the actual field name of a
+        #   model, but when we add errors they should always have aliased fields
+        #
+        # @param [String,Symbol] field the actual field name to alias
+        # @return [Symbol] the aliased field name, or the original name symbolized
+        def caprese_alias_field(field)
+          caprese_field_aliases.invert[field = field.to_sym] || field
+        end
+
+        # Given an aliased field, convert to its actual field for the class
+        #
+        # @param [String,Symbol] field the actual field name to alias
+        # @return [Symbol] the aliased field name, or the original name symbolized
+        def caprese_unalias_field(field)
+          caprese_field_aliases[field = field.to_sym] || field
+        end
+
+        # Provides the ability to display an aliased field name to the consumer of the API, and then map that name
+        # to its real name on the server
+        # @example
+        #   {
+        #     alias: :actual
+        #   }
+        def caprese_field_aliases
+          {}
+        end
+
+        # The type that is serialized and responded with for this class
+        def caprese_type
+          self.name.underscore
+        end
+      end
+    end
+  end
+end

data/lib/caprese/record/errors.rb

@@ -24,7 +24,7 @@ module Caprese
 
         e = Error.new(
           model: @base.class.name.underscore.downcase,
-          field: attribute == :base ? nil : attribute,
+          field: attribute == :base ? nil : @base.class.caprese_alias_field(attribute),
           code: code,
           t: options[:t]
         )

data/lib/caprese/record.rb

@@ -3,13 +3,13 @@ require 'active_support/concern'
 require 'active_support/dependencies'
 require 'caprese/errors'
 require 'caprese/record/associated_validator'
-require 'caprese/record/attribute_aliasing'
+require 'caprese/record/aliasing'
 require 'caprese/record/errors'
 
 module Caprese
   module Record
     extend ActiveSupport::Concern
-    include AttributeAliasing
+    include Aliasing
 
     mattr_accessor :caprese_style_errors
     @@caprese_style_errors = true

data/lib/caprese/serializer/concerns/aliasing.rb

@@ -0,0 +1,17 @@
+require 'active_support/concern'
+
+module Caprese
+  class Serializer < ActiveModel::Serializer
+    module Aliasing
+      extend ActiveSupport::Concern
+
+      # Override so we can get the values for serialization of aliased attributes just like unaliased
+      #
+      # @param [String,Symbol] attribute the attribute (aliased or not) to read for serialization
+      # @return [Value] the value of the attribute
+      def read_attribute_for_serialization(attribute)
+        super(self.object.class.caprese_unalias_field(attribute))
+      end
+    end
+  end
+end

data/lib/caprese/serializer/concerns/links.rb

@@ -80,6 +80,8 @@ module Caprese
         def build_association_block(reflection_name)
           primary_key = Caprese.config.resource_primary_key
 
+          reflection_name = reflection_name.to_sym
+
           Proc.new do |serializer|
             link :self do
               url = "relationship_definition_#{serializer.version_name("#{object.class.name.underscore}_url")}"

data/lib/caprese/serializer.rb

@@ -1,5 +1,6 @@
 require 'active_model_serializers'
 require 'caprese/concerns/versioning'
+require 'caprese/serializer/concerns/aliasing'
 require 'caprese/serializer/concerns/links'
 require 'caprese/serializer/concerns/lookup'
 require 'caprese/serializer/concerns/relationships'
@@ -8,12 +9,13 @@ module Caprese
   class Serializer < ActiveModel::Serializer
     extend Versioning
     include Versioning
+    include Aliasing
     include Links
     include Lookup
     include Relationships
 
     def json_key
-      unversion(self.class.name).gsub('Serializer', '').underscore
+      object.class.caprese_type
     end
   end
 end

data/lib/caprese/version.rb

@@ -1,3 +1,3 @@
 module Caprese
-  VERSION = '0.3.19.3'
+  VERSION = '0.3.20'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caprese
 version: !ruby/object:Gem::Version
-  version: 0.3.19.3
+  version: 0.3.20
 platform: ruby
 authors:
 - Nick Landgrebe
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-05 00:00:00.000000000 Z
+date: 2017-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -224,6 +224,7 @@ files:
 - lib/caprese/adapter/json_api/resource_identifier.rb
 - lib/caprese/concerns/versioning.rb
 - lib/caprese/controller.rb
+- lib/caprese/controller/concerns/aliasing.rb
 - lib/caprese/controller/concerns/callbacks.rb
 - lib/caprese/controller/concerns/errors.rb
 - lib/caprese/controller/concerns/persistence.rb
@@ -234,11 +235,12 @@ files:
 - lib/caprese/error.rb
 - lib/caprese/errors.rb
 - lib/caprese/record.rb
+- lib/caprese/record/aliasing.rb
 - lib/caprese/record/associated_validator.rb
-- lib/caprese/record/attribute_aliasing.rb
 - lib/caprese/record/errors.rb
 - lib/caprese/routing/caprese_resources.rb
 - lib/caprese/serializer.rb
+- lib/caprese/serializer/concerns/aliasing.rb
 - lib/caprese/serializer/concerns/links.rb
 - lib/caprese/serializer/concerns/lookup.rb
 - lib/caprese/serializer/concerns/relationships.rb

data/lib/caprese/record/attribute_aliasing.rb

@@ -1,12 +0,0 @@
-module Caprese
-  module Record
-    module AttributeAliasing
-      # Provides an intermediary helper method on records that defines non-column attributes for records
-      # @note This exists so there is a method by which to state that a non-column attribute should
-      #   have an error source pointer like `/data/attributes/[name]` instead of `/data/relationships/[name]`
-      def caprese_is_attribute?(attribute_name)
-        false
-      end
-    end
-  end
-end