sanger-jsonapi-resources 0.1.1 → 0.2.0

data/lib/jsonapi/resource_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class ResourceController < ActionController::Base
     include JSONAPI::ActsAsResourceController

data/lib/jsonapi/resource_controller_metal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class ResourceControllerMetal < ActionController::Metal
     MODULES = [
@@ -5,10 +7,14 @@ module JSONAPI
       ActionController::Rendering,
       ActionController::Renderers::All,
       ActionController::StrongParameters,
+      Gem::Requirement.new('< 6.1').satisfied_by?(ActionPack.gem_version) ? ActionController::ForceSSL : nil,
       ActionController::Instrumentation,
       JSONAPI::ActsAsResourceController
-    ].freeze
+    ].compact.freeze
 
+    # Note, the url_helpers are not loaded. This will prevent links from being generated for resources, and warnings
+    # will be emitted. Link support can be added by including `Rails.application.routes.url_helpers`, and links
+    # can be disabled, and warning suppressed, for a resource with `exclude_links :default`
     MODULES.each do |mod|
       include mod
     end

data/lib/jsonapi/resource_fragment.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module JSONAPI
+
+  # A ResourceFragment holds a ResourceIdentity and associated partial resource data.
+  #
+  # The following partial resource data may be stored
+  # cache - the value of the cache field for the resource instance
+  # related - a hash of arrays of related resource identities, grouped by relationship name
+  # related_from - a set of related resource identities that loaded the fragment
+  # resource - a resource instance
+  #
+  # Todo: optionally use these for faster responses by bypassing model instantiation)
+  # attributes - resource attributes
+
+  class ResourceFragment
+    attr_reader :identity, :attributes, :related_from, :related, :resource
+
+    attr_accessor :primary, :cache
+
+    alias :cache_field :cache #ToDo: Rename one or the other
+
+    def initialize(identity, resource: nil, cache: nil, primary: false)
+      @identity = identity
+      @cache = cache
+      @resource = resource
+      @primary = primary
+
+      @attributes = {}
+      @related = {}
+      @related_from = Set.new
+    end
+
+    def initialize_related(relationship_name)
+      @related[relationship_name.to_sym] ||= Set.new
+    end
+
+    def add_related_identity(relationship_name, identity)
+      initialize_related(relationship_name)
+      @related[relationship_name.to_sym] << identity if identity
+    end
+
+    def merge_related_identities(relationship_name, identities)
+      initialize_related(relationship_name)
+      @related[relationship_name.to_sym].merge(identities) if identities
+    end
+
+    def add_related_from(identity)
+      @related_from << identity
+    end
+
+    def add_attribute(name, value)
+      @attributes[name] = value
+    end
+  end
+end

data/lib/jsonapi/resource_identity.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module JSONAPI
+
+  # ResourceIdentity describes a unique identity of a resource in the system.
+  # This consists of a Resource class and an identifier that is unique within
+  # that Resource class. ResourceIdentities are intended to be used as hash
+  # keys to provide ordered mixing of resource types in result sets.
+  #
+  #
+  # == Creating a ResourceIdentity
+  #
+  # rid = ResourceIdentity.new(PostResource, 12)
+  #
+  class ResourceIdentity
+    attr_reader :resource_klass, :id
+
+    def initialize(resource_klass, id)
+      @resource_klass = resource_klass
+      @id = id
+    end
+
+    def ==(other)
+      # :nocov:
+      eql?(other)
+      # :nocov:
+    end
+
+    def eql?(other)
+      other.is_a?(ResourceIdentity) && other.resource_klass == @resource_klass && other.id == @id
+    end
+
+    def hash
+      [@resource_klass, @id].hash
+    end
+
+    # Creates a string representation of the identifier.
+    def to_s
+      # :nocov:
+      "#{resource_klass}:#{id}"
+      # :nocov:
+    end
+  end
+end