alchemy-json_api 0.15.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 369f587874aab63134861d26c9b1babfc0d0ba7d25a981bd2a977bf00d847b48
-  data.tar.gz: 3e3e10d5862df03767a538fe785b17d67d88a1e02151fa0a6b67b45370876960
+  metadata.gz: 3935cd3e895377d3abf8138b854c6aa54148da1a77d7fd7c9942b59a467117d9
+  data.tar.gz: 9c2c96ba95625c68e186558a5316eedf087d375784026d50ef93a7e4f2e4edec
 SHA512:
-  metadata.gz: 7f7b3074e7c9e446e22c12f8f8fffe64a2548ede87af8a22515efe53edc9060e2446d8cf9e2bd4511941158920e55e9cce5478b876fe4e9438d2d63d60df8cb6
-  data.tar.gz: c68a930b025975095291d0cf53d8f7cbba2a65e309ac4a0d24ef2db5966b4bc157cc35f199c2f69c3c2e8503de20517f19594a6ef3afac12f82eb124373ee170
+  metadata.gz: fceba1d386c35489b4145a0becdffccdd4f00614546b15781038df613b5dea27d5dad7104ff00ad2920f52728ddb729f184d40b97542b36d96c2b05b0fb77216
+  data.tar.gz: f01bfc78e0d1911abf74666a4b8f19a6e0288d287125f0072364263c8450038b4bf6b8a808bdab65ed49c8265fdcdb9db2df883f60674707298e173144e11992

data/app/controllers/alchemy/json_api/pages_controller.rb

@@ -61,6 +61,7 @@ module Alchemy
                   elements: [
                     :nested_elements,
                     { contents: { essence: :ingredient_association } },
+                    { ingredients: :related_object },
                   ],
                 },
               },

data/app/serializers/alchemy/json_api/element_serializer.rb

@@ -20,6 +20,11 @@ module Alchemy
         element.contents.map(&:essence)
       end
 
+      has_many :ingredients,
+        serializer: ->(record) do
+          "Alchemy::JsonApi::Ingredient#{record.type.demodulize}Serializer".constantize
+        end
+
       has_many :nested_elements, record_type: :element, serializer: self
     end
   end

data/app/serializers/alchemy/json_api/essence_audio_serializer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/essence_serializer"
+
+module Alchemy
+  module JsonApi
+    class EssenceAudioSerializer
+      include EssenceSerializer
+
+      attributes(
+        :autoplay,
+        :controls,
+        :muted,
+        :loop,
+      )
+
+      attribute :ingredient do |essence|
+        essence.attachment&.url
+      end
+
+      with_options if: ->(essence) { essence.attachment } do
+        attribute :audio_name do |essence|
+          essence.attachment.name
+        end
+
+        attribute :audio_file_name do |essence|
+          essence.attachment.file_name
+        end
+
+        attribute :audio_mime_type do |essence|
+          essence.attachment.file_mime_type
+        end
+
+        attribute :audio_file_size do |essence|
+          essence.attachment.file_size
+        end
+      end
+    end
+  end
+end

data/app/serializers/alchemy/json_api/essence_headline_serializer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/essence_serializer"
+
+module Alchemy
+  module JsonApi
+    class EssenceHeadlineSerializer
+      include EssenceSerializer
+
+      attributes :level, :size
+    end
+  end
+end

data/app/serializers/alchemy/json_api/essence_video_serializer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/essence_serializer"
+
+module Alchemy
+  module JsonApi
+    class EssenceVideoSerializer
+      include EssenceSerializer
+
+      attributes(
+        :width,
+        :height,
+        :allow_fullscreen,
+        :autoplay,
+        :controls,
+        :preload,
+      )
+
+      attribute :ingredient do |essence|
+        essence.attachment&.url
+      end
+
+      with_options if: ->(essence) { essence.attachment } do
+        attribute :video_name do |essence|
+          essence.attachment.name
+        end
+
+        attribute :video_file_name do |essence|
+          essence.attachment.file_name
+        end
+
+        attribute :video_mime_type do |essence|
+          essence.attachment.file_mime_type
+        end
+
+        attribute :video_file_size do |essence|
+          essence.attachment.file_size
+        end
+      end
+    end
+  end
+end

data/app/serializers/alchemy/json_api/ingredient_audio_serializer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/ingredient_serializer"
+
+module Alchemy
+  module JsonApi
+    class IngredientAudioSerializer
+      include IngredientSerializer
+
+      attributes(
+        :autoplay,
+        :controls,
+        :muted,
+        :loop,
+      )
+
+      attribute :value do |ingredient|
+        ingredient.attachment&.url
+      end
+
+      with_options if: ->(ingredient) { ingredient.attachment } do
+        attribute :audio_name do |ingredient|
+          ingredient.attachment.name
+        end
+
+        attribute :audio_file_name do |ingredient|
+          ingredient.attachment.file_name
+        end
+
+        attribute :audio_mime_type do |ingredient|
+          ingredient.attachment.file_mime_type
+        end
+
+        attribute :audio_file_size do |ingredient|
+          ingredient.attachment.file_size
+        end
+      end
+    end
+  end
+end

data/app/serializers/alchemy/json_api/ingredient_boolean_serializer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/ingredient_serializer"
+
+module Alchemy
+  module JsonApi
+    class IngredientBooleanSerializer
+      include IngredientSerializer
+    end
+  end
+end

data/app/serializers/alchemy/json_api/ingredient_datetime_serializer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/ingredient_serializer"
+
+module Alchemy
+  module JsonApi
+    class IngredientDatetimeSerializer
+      include IngredientSerializer
+    end
+  end
+end

data/app/serializers/alchemy/json_api/ingredient_file_serializer.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/ingredient_serializer"
+
+module Alchemy
+  module JsonApi
+    class IngredientFileSerializer
+      include IngredientSerializer
+
+      attribute :link_title, &:title
+
+      attribute :value do |ingredient|
+        ingredient.attachment&.url
+      end
+
+      with_options if: proc { |ingredient| ingredient.attachment } do
+        attribute :attachment_name do |ingredient|
+          ingredient.attachment.name
+        end
+
+        attribute :attachment_file_name do |ingredient|
+          ingredient.attachment.file_name
+        end
+
+        attribute :attachment_mime_type do |ingredient|
+          ingredient.attachment.file_mime_type
+        end
+
+        attribute :attachment_file_size do |ingredient|
+          ingredient.attachment.file_size
+        end
+      end
+    end
+  end
+end

data/app/serializers/alchemy/json_api/ingredient_headline_serializer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/ingredient_serializer"
+
+module Alchemy
+  module JsonApi
+    class IngredientHeadlineSerializer
+      include IngredientSerializer
+
+      attributes :level, :size
+    end
+  end
+end

data/app/serializers/alchemy/json_api/ingredient_html_serializer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/ingredient_serializer"
+
+module Alchemy
+  module JsonApi
+    class IngredientHtmlSerializer
+      include IngredientSerializer
+    end
+  end
+end

data/app/serializers/alchemy/json_api/ingredient_link_serializer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/ingredient_serializer"
+
+module Alchemy
+  module JsonApi
+    class IngredientLinkSerializer
+      include IngredientSerializer
+
+      attributes(
+        :link_class_name,
+        :link_target,
+        :link_title
+      )
+    end
+  end
+end

data/app/serializers/alchemy/json_api/ingredient_node_serializer.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/ingredient_serializer"
+
+module Alchemy
+  module JsonApi
+    class IngredientNodeSerializer
+      include IngredientSerializer
+
+      attribute :value do |ingredient|
+        ingredient.node&.name
+      end
+
+      belongs_to :node, record_type: :node, serializer: ::Alchemy::JsonApi::NodeSerializer
+
+      with_options if: proc { |ingredient| ingredient.node } do
+        attribute :name do |ingredient|
+          ingredient.node.name
+        end
+
+        attribute :link_url do |ingredient|
+          ingredient.node.url
+        end
+
+        attribute :link_title do |ingredient|
+          ingredient.node.title
+        end
+
+        attribute :link_nofollow do |ingredient|
+          ingredient.node.nofollow
+        end
+      end
+    end
+  end
+end

data/app/serializers/alchemy/json_api/ingredient_page_serializer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/ingredient_serializer"
+
+module Alchemy
+  module JsonApi
+    class IngredientPageSerializer
+      include IngredientSerializer
+
+      attribute :value do |ingredient|
+        ingredient.page&.url_path
+      end
+
+      attribute :page_name do |ingredient|
+        ingredient.page&.name
+      end
+
+      attribute :page_url do |ingredient|
+        ingredient.page&.url_path
+      end
+
+      has_one :page, record_type: :page, serializer: ::Alchemy::JsonApi::PageSerializer
+    end
+  end
+end

data/app/serializers/alchemy/json_api/ingredient_picture_serializer.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/ingredient_serializer"
+
+module Alchemy
+  module JsonApi
+    class IngredientPictureSerializer
+      include IngredientSerializer
+
+      attributes(
+        :title,
+        :caption,
+        :link_class_name,
+        :link_title,
+        :link_target,
+      )
+
+      attribute :value do |ingredient|
+        ingredient.picture&.url
+      end
+
+      attribute :alt_text, &:alt_tag
+      attribute :link_url, &:link
+
+      with_options if: proc { |ingredient| ingredient.picture.present? } do
+        attribute :image_dimensions do |ingredient|
+          sizes = ingredient.settings[:size]&.split("x", 2)&.map(&:to_i) || [
+            ingredient.image_file_width,
+            ingredient.image_file_height,
+          ]
+
+          ratio = ingredient.image_file_width.to_f / ingredient.image_file_height
+          width = sizes[0].zero? ? sizes[1] * ratio : sizes[0]
+          height = sizes[1].zero? ? sizes[0] / ratio : sizes[1]
+
+          {
+            width: width,
+            height: height,
+          }
+        end
+
+        attribute :image_name do |ingredient|
+          ingredient.picture.name
+        end
+
+        attribute :image_file_name do |ingredient|
+          ingredient.picture.image_file_name
+        end
+
+        attribute :image_mime_type do |ingredient|
+          "image/#{ingredient.picture.image_file_format}"
+        end
+
+        attribute :image_file_size do |ingredient|
+          ingredient.picture.image_file_size
+        end
+      end
+    end
+  end
+end

data/app/serializers/alchemy/json_api/ingredient_richtext_serializer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/ingredient_serializer"
+
+module Alchemy
+  module JsonApi
+    class IngredientRichtextSerializer
+      include IngredientSerializer
+
+      attributes(
+        :sanitized_body,
+        :stripped_body,
+      )
+
+      attribute :body, &:value
+    end
+  end
+end

data/app/serializers/alchemy/json_api/ingredient_select_serializer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/ingredient_serializer"
+
+module Alchemy
+  module JsonApi
+    class IngredientSelectSerializer
+      include IngredientSerializer
+    end
+  end
+end

data/app/serializers/alchemy/json_api/ingredient_text_serializer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/ingredient_serializer"
+
+module Alchemy
+  module JsonApi
+    class IngredientTextSerializer
+      include IngredientSerializer
+
+      attributes(
+        :link,
+        :link_class_name,
+        :link_target,
+        :link_title,
+      )
+
+      # maintain compatibility with EssenceText
+      attribute :body, &:value
+      attribute :link_url, &:link
+    end
+  end
+end

data/app/serializers/alchemy/json_api/ingredient_video_serializer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "alchemy/json_api/ingredient_serializer"
+
+module Alchemy
+  module JsonApi
+    class IngredientVideoSerializer
+      include IngredientSerializer
+
+      attributes(
+        :width,
+        :height,
+        :allow_fullscreen,
+        :autoplay,
+        :controls,
+        :preload,
+      )
+
+      attribute :value do |ingredient|
+        ingredient.attachment&.url
+      end
+
+      with_options if: ->(ingredient) { ingredient.attachment } do
+        attribute :video_name do |ingredient|
+          ingredient.attachment.name
+        end
+
+        attribute :video_file_name do |ingredient|
+          ingredient.attachment.file_name
+        end
+
+        attribute :video_mime_type do |ingredient|
+          ingredient.attachment.file_mime_type
+        end
+
+        attribute :video_file_size do |ingredient|
+          ingredient.attachment.file_size
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/json_api/ingredient_serializer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module JsonApi
+    module IngredientSerializer
+      def self.included(klass)
+        klass.include JSONAPI::Serializer
+
+        klass.has_one :element, record_type: :element, serializer: ::Alchemy::JsonApi::ElementSerializer
+
+        klass.attributes(
+          :role,
+          :value,
+          :created_at,
+          :updated_at
+        )
+
+        klass.attribute :deprecated, &:deprecated?
+      end
+    end
+  end
+end

data/lib/alchemy/json_api/test_support/ingredient_serializer_behaviour.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples "an ingredient serializer" do
+  describe "attributes" do
+    subject { serializer.serializable_hash[:data][:attributes] }
+
+    it "has the right keys and values" do
+      expect(subject).to have_key(:role)
+      expect(subject).to have_key(:value)
+      expect(subject).to have_key(:created_at)
+      expect(subject).to have_key(:updated_at)
+      expect(subject[:deprecated]).to be(false)
+    end
+
+    context "a deprecated ingredient" do
+      before do
+        expect(ingredient).to receive(:deprecated?) { true }
+      end
+
+      it "has deprecated attribute set to true" do
+        expect(subject[:deprecated]).to eq(true)
+      end
+    end
+  end
+
+  describe "relationships" do
+    subject { serializer.serializable_hash[:data][:relationships] }
+
+    it "has one element" do
+      expect(subject[:element]).to eq(data: { id: ingredient.element_id.to_s, type: :element })
+    end
+  end
+end

data/lib/alchemy/json_api/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Alchemy
   module JsonApi
-    VERSION = "0.15.0"
+    VERSION = "0.20.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-json_api
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-19 00:00:00.000000000 Z
+date: 2021-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -131,9 +131,11 @@ files:
 - app/controllers/alchemy/json_api/pages_controller.rb
 - app/models/alchemy/json_api/page.rb
 - app/serializers/alchemy/json_api/element_serializer.rb
+- app/serializers/alchemy/json_api/essence_audio_serializer.rb
 - app/serializers/alchemy/json_api/essence_boolean_serializer.rb
 - app/serializers/alchemy/json_api/essence_date_serializer.rb
 - app/serializers/alchemy/json_api/essence_file_serializer.rb
+- app/serializers/alchemy/json_api/essence_headline_serializer.rb
 - app/serializers/alchemy/json_api/essence_html_serializer.rb
 - app/serializers/alchemy/json_api/essence_link_serializer.rb
 - app/serializers/alchemy/json_api/essence_node_serializer.rb
@@ -142,6 +144,21 @@ files:
 - app/serializers/alchemy/json_api/essence_richtext_serializer.rb
 - app/serializers/alchemy/json_api/essence_select_serializer.rb
 - app/serializers/alchemy/json_api/essence_text_serializer.rb
+- app/serializers/alchemy/json_api/essence_video_serializer.rb
+- app/serializers/alchemy/json_api/ingredient_audio_serializer.rb
+- app/serializers/alchemy/json_api/ingredient_boolean_serializer.rb
+- app/serializers/alchemy/json_api/ingredient_datetime_serializer.rb
+- app/serializers/alchemy/json_api/ingredient_file_serializer.rb
+- app/serializers/alchemy/json_api/ingredient_headline_serializer.rb
+- app/serializers/alchemy/json_api/ingredient_html_serializer.rb
+- app/serializers/alchemy/json_api/ingredient_link_serializer.rb
+- app/serializers/alchemy/json_api/ingredient_node_serializer.rb
+- app/serializers/alchemy/json_api/ingredient_page_serializer.rb
+- app/serializers/alchemy/json_api/ingredient_picture_serializer.rb
+- app/serializers/alchemy/json_api/ingredient_richtext_serializer.rb
+- app/serializers/alchemy/json_api/ingredient_select_serializer.rb
+- app/serializers/alchemy/json_api/ingredient_text_serializer.rb
+- app/serializers/alchemy/json_api/ingredient_video_serializer.rb
 - app/serializers/alchemy/json_api/language_serializer.rb
 - app/serializers/alchemy/json_api/node_serializer.rb
 - app/serializers/alchemy/json_api/page_serializer.rb
@@ -149,7 +166,9 @@ files:
 - lib/alchemy/json_api.rb
 - lib/alchemy/json_api/engine.rb
 - lib/alchemy/json_api/essence_serializer.rb
+- lib/alchemy/json_api/ingredient_serializer.rb
 - lib/alchemy/json_api/test_support/essence_serializer_behaviour.rb
+- lib/alchemy/json_api/test_support/ingredient_serializer_behaviour.rb
 - lib/alchemy/json_api/version.rb
 - lib/tasks/alchemy/json_api_tasks.rake
 homepage: https://github.com/AlchemyCMS/alchemy-json_api