alchemy-json_api 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 566f8ea63b33d368120cc948fa2c61b4b0039957249e85718f650e8e7ca8d322
-  data.tar.gz: 6816b1a2b645b9711a77bd8916814cd245b319e8144c6de278ec3f780c03f36f
+  metadata.gz: 97db79acd9c6dfb19a865b855f4fe4849fda6ed306684aebc0006f6e8a0c491a
+  data.tar.gz: 3863316005bf0fa85f03a2605ef6f0e295e3115b7cb17f9dd4de9e866a2b50a6
 SHA512:
-  metadata.gz: 6041f03d5b9264d25312b7e4e1e50d9e5aae32154a47d8e8178bf7ab1dbd5362127e683d40ecba95f1fd05bb1d503afb6444286a97e99bcf5514fa4d48ade95c
-  data.tar.gz: 5355f10ab5dc5ae2ff7b2fb9412358467e4d351c23efbb37e8a9fbe6e300e6848d6e2b3a01c58fae8d1fbf8df00749835d55b65c43b2705dfcf2431281ef6a8a
+  metadata.gz: 8c52e8ec6c28505682e6469990e4b24c6eb365de7f8ddc05b5b8d0e1a4831e7852e7bb502e95c475ac19af4bafd4402148a0693cdacb7f0f1be715b891b686aa
+  data.tar.gz: 554481f252201637ce0daf5ca3429fd456c0ec82b34928dc9f0f959f4f4aaee7ee85923f5a9151548725130d6a5a21c03bc2a2e108163ad16e8a60c5a68b259c

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Alchemy
   module JsonApi
     class PagesController < JsonApi::BaseController
@@ -34,6 +35,7 @@ module Alchemy
       end
 
       def load_page_by_id
+        return unless params[:path] =~ /\A\d+\z/
         page_scope.find_by(id: params[:path])
       end
 
@@ -48,15 +50,15 @@ module Alchemy
       def page_scope_with_includes
         base_page_scope.
           with_language(Language.current).
-          preload(language: {nodes: [:parent, :page]}, all_elements: [:parent_element, :nested_elements, { contents: { essence: :ingredient_association } }])
+          preload(language: { nodes: [:parent, :page] }, all_elements: { contents: { essence: :ingredient_association } })
       end
 
       def base_page_scope
         # cancancan is not able to merge our complex AR scopes for logged in users
-        if can?(:edit_content, Page)
-          Page.all
+        if can?(:edit_content, ::Alchemy::Page)
+          ::Alchemy::JsonApi::Page.all
         else
-          Page.published
+          ::Alchemy::JsonApi::Page.published
         end
       end
 

data/app/models/alchemy/json_api/element.rb

@@ -0,0 +1,33 @@
+module Alchemy
+  module JsonApi
+    class Element < BaseRecord
+      include Alchemy::Element::Definitions
+      include Alchemy::Element::ElementContents
+
+      self.table_name = "alchemy_elements"
+
+      belongs_to :page, class_name: "Alchemy::JsonApi::Page", inverse_of: :all_elements
+      has_many :contents, class_name: "Alchemy::Content", inverse_of: :element
+
+      scope :available, -> { where(public: true).where.not(position: nil) }
+
+      def parent_element
+        page.elements.detect do |element|
+          element.id == parent_element_id
+        end
+      end
+
+      def nested_elements
+        @_nested_elements ||= begin
+          page.elements.select do |element|
+            element.parent_element_id == id
+          end
+        end
+      end
+
+      def nested_element_ids
+        nested_elements.map(&:id)
+      end
+    end
+  end
+end

data/app/models/alchemy/json_api/page.rb

@@ -0,0 +1,48 @@
+module Alchemy
+  module JsonApi
+    class Page < BaseRecord
+      self.table_name = "alchemy_pages"
+
+      belongs_to :language, class_name: "Alchemy::Language"
+
+      has_many :all_elements,
+        -> { available.order(:position) },
+        class_name: "Alchemy::JsonApi::Element",
+        inverse_of: :page
+
+      scope :published, -> {
+          where("#{table_name}.public_on <= :time AND " \
+                "(#{table_name}.public_until IS NULL " \
+                "OR #{table_name}.public_until >= :time)", time: Time.current)
+        }
+
+      scope :contentpages, -> { where(layoutpage: false) }
+      scope :layoutpages, -> { where(layoutpage: true) }
+      scope :with_language, ->(language_id) { where(language_id: language_id) }
+
+      # The top level public, non-fixed elements of this page that - if present -
+      # contains their nested_elements.
+      def elements
+        @_elements ||= all_elements.select do |element|
+          !element.fixed? || element.parent_element_id.nil?
+        end
+      end
+
+      # The top level public, fixed elements of this page that - if present -
+      # contains their nested_elements.
+      def fixed_elements
+        @_fixed_elements ||= all_elements.select do |element|
+          element.fixed? || element.parent_element_id.nil?
+        end
+      end
+
+      def element_ids
+        @_element_ids ||= elements.map(&:id)
+      end
+
+      def fixed_element_ids
+        @_fixed_element_ids ||= fixed_elements.map(&:id)
+      end
+    end
+  end
+end

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

@@ -11,22 +11,20 @@ module Alchemy
         :created_at,
         :updated_at,
       )
+
+      attribute :deprecated do |element|
+        !!element.definition[:deprecated]
+      end
+
       belongs_to :parent_element, record_type: :element, serializer: self
 
       belongs_to :page, record_type: :page, serializer: ::Alchemy::JsonApi::PageSerializer
 
       has_many :essences, polymorphic: true do |element|
-        element.contents.reject { |c| !!c.try(:deprecated?) }.map!(&:essence)
+        element.contents.map(&:essence)
       end
 
-      has_many :nested_elements, record_type: :element, serializer: self do |element|
-        element.nested_elements.reject { |c| !!c.try(:deprecated?) }
-      end
-
-      with_options if: ->(_, params) { params[:admin] == true } do
-        attribute :tag_list
-        attribute :display_name, &:display_name_with_preview_text
-      end
+      has_many :nested_elements, record_type: :element, serializer: self
     end
   end
 end

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

@@ -18,12 +18,6 @@ module Alchemy
       end
       has_many :pages
       has_one :root_page, record_type: :page, serializer: ::Alchemy::JsonApi::PageSerializer
-
-      with_options if: ->(_, params) { params[:admin] == true } do
-        attribute :created_at
-        attribute :updated_at
-        attribute :public
-      end
     end
   end
 end

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

@@ -4,6 +4,8 @@ module Alchemy
     class PageSerializer
       include JSONAPI::Serializer
 
+      ELEMENT_SERIALIZER = ::Alchemy::JsonApi::ElementSerializer
+
       attributes(
         :name,
         :urlname,
@@ -18,22 +20,17 @@ module Alchemy
 
       belongs_to :language, record_type: :language, serializer: ::Alchemy::JsonApi::LanguageSerializer
 
-      has_many :elements, record_type: :element, serializer: ::Alchemy::JsonApi::ElementSerializer do |page|
-        page.elements.reject { |e| !!e.try(:deprecated?) }
-      end
-
-      has_many :fixed_elements, record_type: :element, serializer: ::Alchemy::JsonApi::ElementSerializer do |page|
-        page.fixed_elements.reject { |c| !!c.try(:deprecated?) }
-      end
+      # All public elements of this page regardless of if they are fixed or nested.
+      # Used for eager loading and should be used as the +include+ parameter of your query
+      has_many :all_elements, record_type: :element, serializer: ELEMENT_SERIALIZER
 
-      has_many :all_elements, record_type: :element, serializer: ::Alchemy::JsonApi::ElementSerializer do |page|
-        page.all_elements.select { |e| e.public? && !e.trashed? && !e.try(:deprecated?) }
-      end
+      # The top level public, non-fixed elements of this page that - if present -
+      # contains their nested_elements.
+      has_many :elements, record_type: :element, serializer: ELEMENT_SERIALIZER
 
-      with_options if: ->(_, params) { params[:admin] == true } do
-        attribute :tag_list
-        attribute :status
-      end
+      # The top level public, fixed elements of this page that - if present -
+      # contains their nested_elements.
+      has_many :fixed_elements, record_type: :element, serializer: ELEMENT_SERIALIZER
     end
   end
 end

data/lib/alchemy/json_api/essence_serializer.rb

@@ -11,6 +11,9 @@ module Alchemy
         klass.attribute :role do |essence|
           essence.content.name
         end
+        klass.attribute :deprecated do |essence|
+          !!essence.content.definition[:deprecated]
+        end
       end
     end
   end

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

@@ -5,6 +5,15 @@ RSpec.shared_examples "an essence serializer" do
 
     it "has the right keys and values" do
       expect(subject).to have_key(:ingredient)
+      expect(subject[:deprecated]).to be(false)
+    end
+
+    context "a deprecated content" do
+      let(:content) { FactoryBot.create(:alchemy_content, name: "intro", element: element) }
+
+      it "has deprecated attribute set to true" do
+        expect(subject[:deprecated]).to eq(true)
+      end
     end
   end
 

data/lib/alchemy/json_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-json_api
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -100,6 +100,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A JSONAPI compliant API for AlchemyCMS
 email:
 - mamhoff@gmail.com
@@ -113,6 +127,8 @@ files:
 - app/controllers/alchemy/json_api/base_controller.rb
 - app/controllers/alchemy/json_api/layout_pages_controller.rb
 - app/controllers/alchemy/json_api/pages_controller.rb
+- app/models/alchemy/json_api/element.rb
+- app/models/alchemy/json_api/page.rb
 - app/serializers/alchemy/json_api/element_serializer.rb
 - app/serializers/alchemy/json_api/essence_boolean_serializer.rb
 - app/serializers/alchemy/json_api/essence_date_serializer.rb