jpie 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8d19fff52264fdefbdba8d63bae64a532cbd2daddfdcfbfaa9ffd205d028822
-  data.tar.gz: c10827822e1638a8e0690a8432709a0cfc7d3fc5d82a845e276d74c66f8761c3
+  metadata.gz: ecbe7000fb7dd1053c155ec2f9de3866bd3eb3138e4509dc5e8d226bcdbb054a
+  data.tar.gz: 07e03b20414abbfe7fb849fd5dd99f5390633ff9498bad3d064b5ed3894973a2
 SHA512:
-  metadata.gz: 7693f48c7c20c4879478a72e233c092dd4e0a90e1ca038129b3c3d2821d2d07d0cfa50bd73b166c2c5235e2e580869b989fce91928916b2df671e397811002d7
-  data.tar.gz: 859af674c3a0eca429e86ed566df855141806b1d26d15f7dacfa2fad5ab93699957a9c30e218199bb04152b6ab865e690c0ed1cf54296ebc9fe58de0fd967dc2
+  metadata.gz: dc63cd8358e5a678bdd69e230f4a5842cf11ff0268006b615d0c5de7570d8da0ec9f83f7da40d2fc8d0758629fae95dfdde13eb34ef2ae384f1b764a6ac99857
+  data.tar.gz: ea527ed50fd384b5cd0e8f21a3cf1d5b23d7121f11b8ad712a5d44cf4adbdd1dfef56e8f2a50da3f34fe42698ef27ff538d59086c5575e70bc0ca9359b261a95

data/Gemfile

@@ -19,5 +19,6 @@ group :development, :test do
   gem "rubocop-performance", "~> 1.0"
   gem "rubocop-rails", "~> 2.0"
   gem "rubocop-rspec", "~> 3.0"
+  gem "simplecov", "~> 0.22", require: false
   gem "sqlite3", ">= 2.1"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jpie (1.0.1)
+    jpie (1.0.2)
       actionpack (~> 8.0, >= 8.0.0)
       rails (~> 8.0, >= 8.0.0)
 
@@ -95,6 +95,7 @@ GEM
     crass (1.0.6)
     date (3.5.0)
     diff-lcs (1.6.2)
+    docile (1.4.1)
     drb (2.2.3)
     erb (6.0.0)
     erubi (1.13.1)
@@ -266,6 +267,12 @@ GEM
       rubocop (~> 1.81)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
     simpleidn (0.2.3)
     sqlite3 (2.8.0-aarch64-linux-gnu)
     sqlite3 (2.8.0-aarch64-linux-musl)
@@ -315,6 +322,7 @@ DEPENDENCIES
   rubocop-performance (~> 1.0)
   rubocop-rails (~> 2.0)
   rubocop-rspec (~> 3.0)
+  simplecov (~> 0.22)
   sqlite3 (>= 2.1)
 
 BUNDLED WITH

data/Rakefile

@@ -6,3 +6,25 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+# Override release task to require OTP code
+# Usage: GEM_HOST_OTP_CODE=123456 rake release
+Rake::Task["release"].enhance do
+  # This runs after the original release task
+end
+
+Rake::Task["release"].prerequisites.unshift("release:require_otp")
+
+namespace :release do
+  task :require_otp do
+    unless ENV["GEM_HOST_OTP_CODE"]
+      abort <<~ERROR
+        ERROR: GEM_HOST_OTP_CODE environment variable is required for release.
+
+        Usage: GEM_HOST_OTP_CODE=123456 rake release
+
+        Get your OTP code from your authenticator app.
+      ERROR
+    end
+  end
+end

data/lib/json_api/resources/active_storage_blob_resource.rb

@@ -2,18 +2,10 @@
 
 module JSONAPI
   class ActiveStorageBlobResource < Resource
-    attributes :filename, :content_type, :byte_size, :checksum, :url
+    attributes :filename, :content_type, :byte_size, :checksum
 
     def self.model_class
       ::ActiveStorage::Blob
     end
-
-    def url
-      return nil unless resource.persisted?
-
-      Rails.application.routes.url_helpers.rails_blob_path(resource, only_path: true)
-    rescue StandardError
-      "/rails/active_storage/blobs/#{resource.signed_id}/#{resource.filename}"
-    end
   end
 end

data/lib/json_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JSONAPI
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jpie
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Emil Kampp
@@ -90,13 +90,6 @@ files:
 - lib/json_api/controllers/concerns/relationships/serialization.rb
 - lib/json_api/controllers/concerns/relationships/sorting.rb
 - lib/json_api/controllers/concerns/relationships/updating.rb
-- lib/json_api/controllers/concerns/relationships_controller/active_storage_removal.rb
-- lib/json_api/controllers/concerns/relationships_controller/events.rb
-- lib/json_api/controllers/concerns/relationships_controller/removal.rb
-- lib/json_api/controllers/concerns/relationships_controller/response_helpers.rb
-- lib/json_api/controllers/concerns/relationships_controller/serialization.rb
-- lib/json_api/controllers/concerns/relationships_controller/sorting.rb
-- lib/json_api/controllers/concerns/relationships_controller/updating.rb
 - lib/json_api/controllers/concerns/resource_actions.rb
 - lib/json_api/controllers/concerns/resource_actions/crud_helpers.rb
 - lib/json_api/controllers/concerns/resource_actions/field_validation.rb

data/lib/json_api/controllers/concerns/relationships_controller/active_storage_removal.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-module JSONAPI
-  module RelationshipsController
-    module ActiveStorageRemoval
-      extend ActiveSupport::Concern
-
-      private
-
-      def remove_active_storage_relationship(relationship_data)
-        reflection = @resource.class.reflect_on_attachment(@relationship_name)
-        if reflection&.macro == :has_many_attached
-          remove_many_active_storage_attachments(relationship_data)
-        else
-          remove_one_active_storage_attachment(relationship_data)
-        end
-      end
-
-      def remove_many_active_storage_attachments(relationship_data)
-        raise ArgumentError, "Expected array for to-many relationship removal" unless relationship_data.is_a?(Array)
-        return if relationship_data.empty?
-
-        attachment_proxy = @resource.public_send(@relationship_name)
-        return unless attachment_proxy.attached?
-
-        blob_ids = extract_blob_ids(relationship_data)
-        attachments = attachment_proxy.attachments.where(blob_id: blob_ids)
-        attachments.each(&:purge)
-      end
-
-      def remove_one_active_storage_attachment(relationship_data)
-        validate_single_removal_identifier!(relationship_data)
-        return if relationship_data.nil?
-
-        attachment_proxy = @resource.public_send(@relationship_name)
-        return unless attachment_proxy.attached?
-
-        blob_id = extract_single_blob_id(relationship_data)
-        attachment = attachment_proxy.attachments.find_by(blob_id:)
-        attachment&.purge
-      end
-
-      def extract_blob_ids(relationship_data)
-        relationship_data.map do |identifier|
-          extract_blob_id_from_identifier(identifier)
-        end
-      end
-
-      def extract_single_blob_id(relationship_data)
-        extract_blob_id_from_identifier(relationship_data)
-      end
-
-      def extract_blob_id_from_identifier(identifier)
-        type = RelationshipHelpers.extract_type_from_identifier(identifier)
-        id = RelationshipHelpers.extract_id_from_identifier(identifier)
-        validate_blob_type!(type)
-        id.to_i
-      end
-
-      def validate_blob_type!(type)
-        return if self.class.active_storage_blob_type?(type)
-
-        raise ArgumentError, "Expected active_storage_blobs type, got #{type}"
-      end
-    end
-  end
-end

data/lib/json_api/controllers/concerns/relationships_controller/events.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module JSONAPI
-  module RelationshipsController
-    module Events
-      extend ActiveSupport::Concern
-
-      private
-
-      def emit_relationship_event(action, relationship_data)
-        resource_type_name = params[:resource_type] || @resource_name.pluralize
-
-        JSONAPI::Instrumentation.relationship_event(
-          action:,
-          resource_type: resource_type_name,
-          resource_id: @resource.id,
-          relationship_name: @relationship_name.to_s,
-          related_ids: extract_related_ids(relationship_data),
-          related_type: extract_related_type(relationship_data),
-        )
-      end
-
-      def extract_related_ids(relationship_data)
-        return nil if relationship_data.nil?
-
-        if relationship_data.is_a?(Array)
-          relationship_data.filter_map { |item| item[:id] }
-        else
-          [relationship_data[:id]].compact
-        end
-      end
-
-      def extract_related_type(relationship_data)
-        return nil if relationship_data.nil?
-
-        if relationship_data.is_a?(Array)
-          relationship_data.first&.dig(:type)
-        else
-          relationship_data[:type]
-        end
-      end
-    end
-  end
-end

data/lib/json_api/controllers/concerns/relationships_controller/removal.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "active_storage_removal"
-
-module JSONAPI
-  module RelationshipsController
-    module Removal
-      extend ActiveSupport::Concern
-      include ActiveStorageRemoval
-
-      private
-
-      def remove_relationship(relationship_data)
-        if active_storage_attachment?(@relationship_name, @resource.class)
-          return remove_active_storage_relationship(relationship_data)
-        end
-
-        remove_association_relationship(relationship_data)
-      rescue ActiveRecord::NotNullViolation, ActiveRecord::RecordInvalid => e
-        raise ArgumentError, "Cannot remove relationship: #{e.message}"
-      end
-
-      def remove_association_relationship(relationship_data)
-        association = @resource.class.reflect_on_association(@relationship_name)
-        raise ArgumentError, "Association not found: #{@relationship_name}" unless association
-
-        ensure_relationship_writable!(association)
-        dispatch_relationship_removal(association, relationship_data)
-      end
-
-      def dispatch_relationship_removal(association, relationship_data)
-        if association.collection?
-          remove_from_many_relationship(association, relationship_data)
-        else
-          remove_from_one_relationship(association, relationship_data)
-        end
-      end
-
-      def remove_from_many_relationship(association, relationship_data)
-        raise ArgumentError, "Expected array for to-many relationship removal" unless relationship_data.is_a?(Array)
-        return if relationship_data.empty?
-
-        remove_from_collection(association, relationship_data)
-      end
-
-      def remove_from_collection(association, relationship_data)
-        collection_ids = @resource.public_send(@relationship_name).pluck(:id)
-        foreign_key = association.foreign_key
-
-        ActiveRecord::Base.transaction do
-          relationship_data.each do |identifier|
-            remove_resource_from_collection(identifier, association, collection_ids, foreign_key)
-          end
-        end
-      end
-
-      def remove_resource_from_collection(identifier, association, collection_ids, foreign_key)
-        resource = RelationshipHelpers.resolve_and_find_related_resource(
-          identifier,
-          association:,
-          resource_class: @resource_class,
-          relationship_name: @relationship_name,
-        )
-        return unless collection_ids.include?(resource.id)
-
-        resource.update!(foreign_key => nil)
-      end
-
-      def remove_from_one_relationship(association, relationship_data)
-        validate_single_removal_identifier!(relationship_data)
-        return if relationship_data.nil?
-
-        remove_single_association(association, relationship_data)
-      end
-
-      def validate_single_removal_identifier!(relationship_data)
-        return unless relationship_data.is_a?(Array)
-
-        raise ArgumentError, "Expected single resource identifier for to-one relationship"
-      end
-
-      def remove_single_association(association, relationship_data)
-        related_resource = find_related_resource(relationship_data, association)
-        current_resource = @resource.public_send(@relationship_name)
-        return unless current_resource == related_resource
-
-        @resource.public_send("#{@relationship_name}=", nil)
-        @resource.save!
-      end
-    end
-  end
-end

data/lib/json_api/controllers/concerns/relationships_controller/response_helpers.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module JSONAPI
-  module RelationshipsController
-    module ResponseHelpers
-      extend ActiveSupport::Concern
-
-      private
-
-      def build_show_response
-        response_data = { data: serialize_relationship_data, links: serialize_relationship_links }
-        meta = serialize_relationship_meta
-        response_data[:meta] = meta if meta.present?
-        response_data
-      end
-
-      def save_and_render_relationship(relationship_data)
-        if @resource.save
-          emit_relationship_event(:updated, relationship_data)
-          render_relationship_response
-        else
-          render_validation_errors(@resource)
-        end
-      end
-
-      def render_relationship_response
-        render json: {
-          data: serialize_relationship_data,
-          links: serialize_relationship_links,
-          meta: serialize_relationship_meta,
-        }.compact, status: :ok
-      end
-
-      def finalize_relationship_removal(relationship_data)
-        association = @resource.class.reflect_on_association(@relationship_name)
-        return emit_and_respond_no_content(relationship_data) unless association && !association.collection?
-
-        save_to_one_removal(relationship_data)
-      end
-
-      def save_to_one_removal(relationship_data)
-        if @resource.save
-          emit_and_respond_no_content(relationship_data)
-        else
-          render_validation_errors(@resource)
-        end
-      end
-
-      def emit_and_respond_no_content(relationship_data)
-        emit_relationship_event(:removed, relationship_data)
-        head :no_content
-      end
-    end
-  end
-end

data/lib/json_api/controllers/concerns/relationships_controller/serialization.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module JSONAPI
-  module RelationshipsController
-    module Serialization
-      extend ActiveSupport::Concern
-
-      private
-
-      def serialize_relationship_data
-        association = @resource.class.reflect_on_association(@relationship_name)
-        return nil unless association
-
-        related = fetch_related_data(association)
-        serialize_related(related, association)
-      end
-
-      def fetch_related_data(association)
-        related = @resource.public_send(@relationship_name)
-        return related unless association.collection? && related.respond_to?(:order)
-
-        apply_sorting_to_relationship(related, association)
-      end
-
-      def serialize_related(related, association)
-        return serialize_collection_relationship(related, association) if association.collection?
-
-        serialize_single_relationship(related, association) if related
-      end
-
-      def serialize_collection_relationship(related, association)
-        return [] if related.nil?
-
-        related.map { |r| serialize_resource_identifier(r, association) }
-      end
-
-      def serialize_single_relationship(related, association)
-        serialize_resource_identifier(related, association)
-      end
-
-      def serialize_resource_identifier(resource_instance, association)
-        RelationshipHelpers.serialize_resource_identifier(
-          resource_instance,
-          association:,
-          resource_class: @resource_class,
-        )
-      end
-
-      def serialize_relationship_links
-        {
-          self: relationship_self_url,
-          related: relationship_related_url,
-        }
-      end
-
-      def relationship_self_url
-        "/#{params[:resource_type]}/#{params[:id]}/relationships/#{params[:relationship_name]}"
-      end
-
-      def relationship_related_url
-        "/#{params[:resource_type]}/#{params[:id]}/#{params[:relationship_name]}"
-      end
-
-      def serialize_relationship_meta
-        relationship_def = find_relationship_definition
-        return nil unless relationship_def
-
-        relationship_def[:meta]
-      end
-    end
-  end
-end

data/lib/json_api/controllers/concerns/relationships_controller/sorting.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-module JSONAPI
-  module RelationshipsController
-    module Sorting
-      extend ActiveSupport::Concern
-
-      private
-
-      def apply_sorting_to_relationship(related, association)
-        sorts = parse_sort_param
-        return related if sorts.empty?
-
-        related_model = association.klass
-        db_sorts, virtual_sorts = partition_sorts_by_type(sorts, related_model)
-
-        related = apply_db_sorts(related, db_sorts)
-        apply_virtual_sorts_if_needed(related, virtual_sorts, related_model)
-      end
-
-      def partition_sorts_by_type(sorts, related_model)
-        sorts.partition do |sort_field|
-          field = RelationshipHelpers.extract_sort_field_name(sort_field)
-          related_model.column_names.include?(field.to_s)
-        end
-      end
-
-      def apply_db_sorts(related, db_sorts)
-        db_sorts.each do |sort_field|
-          direction = RelationshipHelpers.extract_sort_direction(sort_field)
-          field = RelationshipHelpers.extract_sort_field_name(sort_field)
-          related = related.order(field => direction)
-        end
-        related
-      end
-
-      def apply_virtual_sorts_if_needed(related, virtual_sorts, related_model)
-        return related unless virtual_sorts.any?
-
-        resource_class = ResourceLoader.find_for_model(related_model)
-        sort_records_by_virtual_attributes(related.to_a, virtual_sorts, resource_class)
-      end
-
-      def sort_records_by_virtual_attributes(records, virtual_sorts, resource_class)
-        records.sort do |a, b|
-          compare_records(a, b, virtual_sorts, resource_class)
-        end
-      end
-
-      def compare_records(record_a, record_b, virtual_sorts, resource_class)
-        virtual_sorts.each do |sort_field|
-          comparison = compare_by_field(record_a, record_b, sort_field, resource_class)
-          return comparison unless comparison.zero?
-        end
-        0
-      end
-
-      def compare_by_field(record_a, record_b, sort_field, resource_class)
-        direction = RelationshipHelpers.extract_sort_direction(sort_field)
-        field = RelationshipHelpers.extract_sort_field_name(sort_field)
-
-        value_a = get_virtual_value(record_a, field, resource_class)
-        value_b = get_virtual_value(record_b, field, resource_class)
-
-        comparison = compare_values(value_a, value_b)
-        direction == :desc ? -comparison : comparison
-      end
-
-      def get_virtual_value(record, field, resource_class)
-        resource_instance = resource_class.new(record, {})
-        field_sym = field.to_sym
-        return resource_instance.public_send(field_sym) if resource_instance.respond_to?(field_sym, false)
-
-        nil
-      end
-
-      def compare_values(value_a, value_b)
-        return 0 if value_a.nil? && value_b.nil?
-        return -1 if value_a.nil?
-        return 1 if value_b.nil?
-
-        value_a <=> value_b
-      end
-
-      def validate_sort_param
-        sorts = parse_sort_param
-        return if sorts.empty?
-
-        association = @resource.class.reflect_on_association(@relationship_name)
-        return unless association&.collection?
-
-        validate_sort_fields_for_association(sorts, association)
-      end
-
-      def validate_sort_fields_for_association(sorts, association)
-        resource_class = ResourceLoader.find_for_model(association.klass)
-        valid_fields = valid_sort_fields_for_resource(resource_class, association.klass)
-        invalid_fields = invalid_sort_fields_for_columns(sorts, valid_fields)
-        return if invalid_fields.empty?
-
-        render_invalid_sort_fields(invalid_fields)
-      end
-
-      def render_invalid_sort_fields(invalid_fields)
-        render_parameter_errors(
-          invalid_fields,
-          title: "Invalid Sort Field",
-          detail_proc: ->(field) { "Invalid sort field requested: #{field}" },
-          source_proc: ->(_field) { { parameter: "sort" } },
-        )
-      end
-    end
-  end
-end

data/lib/json_api/controllers/concerns/relationships_controller/updating.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-module JSONAPI
-  module RelationshipsController
-    module Updating
-      extend ActiveSupport::Concern
-
-      private
-
-      def update_relationship(relationship_data)
-        association = @resource.class.reflect_on_association(@relationship_name)
-        raise ArgumentError, "Association not found: #{@relationship_name}" unless association
-
-        ensure_relationship_writable!(association)
-        apply_relationship_update(association, relationship_data)
-      end
-
-      def apply_relationship_update(association, relationship_data)
-        if association.collection?
-          update_to_many_relationship(association, relationship_data)
-        else
-          update_to_one_relationship(association, relationship_data)
-        end
-      end
-
-      def update_to_many_relationship(association, relationship_data)
-        if relationship_data.nil? || empty_array?(relationship_data)
-          @resource.public_send("#{@relationship_name}=", [])
-          return
-        end
-
-        raise ArgumentError, "Expected array for to-many relationship" unless relationship_data.is_a?(Array)
-
-        related_resources = resolve_related_resources(relationship_data, association)
-        @resource.public_send("#{@relationship_name}=", related_resources)
-      end
-
-      def empty_array?(data)
-        data.is_a?(Array) && data.empty?
-      end
-
-      def resolve_related_resources(relationship_data, association)
-        relationship_data.map { |identifier| find_related_resource(identifier, association) }
-      end
-
-      def update_to_one_relationship(association, relationship_data)
-        if relationship_data.nil?
-          @resource.public_send("#{@relationship_name}=", nil)
-          return
-        end
-
-        validate_single_identifier!(relationship_data)
-        related_resource = find_related_resource(relationship_data, association)
-        @resource.public_send("#{@relationship_name}=", related_resource)
-      end
-
-      def validate_single_identifier!(relationship_data)
-        return unless relationship_data.is_a?(Array)
-
-        raise ArgumentError, "Expected single resource identifier for to-one relationship"
-      end
-
-      def find_related_resource(identifier, association)
-        RelationshipHelpers.resolve_and_find_related_resource(
-          identifier,
-          association:,
-          resource_class: @resource_class,
-          relationship_name: @relationship_name,
-        )
-      end
-    end
-  end
-end