alchemy-json_api 0.9.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60e3517753943623b96dc3b70e5f6fe1ae0d9ffceaeeac3045935e4f49ac0c3f
-  data.tar.gz: 2988b73369eff64ce7c99e09ca4ff0bdc2a0fb3789965d761c9264ff96b9ba48
+  metadata.gz: ec8c154e4f6ac5ba72d6d96b39a60475acf9b0d411d3a4e2d34c81fc271d1489
+  data.tar.gz: c0cc273e02b2038e5462428fa1f7d0960be37ccf8225abd76af7343ca4f76ec0
 SHA512:
-  metadata.gz: a71f11fc71138caa5a2d2337e8545a602f9ed6fd96ab7cad65b6768ecb1f321e445a16ffab7d1fbfe99cca71270286e86f38d64f4d2cbaaec31472de32a86f81
-  data.tar.gz: d5d3e534e20c9ec196050873d7c0331f16a4a86c8a173f9f8e37ca9c1b3782e2a56740bdbcf1eb846529b37a67f81889f7b8a246f0aa4a8046d42fcd039f4d18
+  metadata.gz: 2f0ebd08816a2d97347555eaf114735b429ec7c1e2592f9c1ff0b652be9f0799c782489987eac5d3142d5f5246ac6f02375460d62931ef4cfcca4f8a3e9ad809
+  data.tar.gz: '08c7a5e5570c995b3495844bcceb9a145173cb3e224fce0051a5b672eae408aee58850e1b612fb25051c0896c571365481daabe28d7e4766b62742e1b0363e34'

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

@@ -4,8 +4,12 @@ module Alchemy
     class LayoutPagesController < JsonApi::PagesController
       private
 
+      def base_page_scope
+        ::Alchemy::JsonApi::Page.all
+      end
+
       def page_scope
-        base_page_scope.layoutpages
+        page_scope_with_includes.layoutpages
       end
     end
   end

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
 
@@ -42,19 +44,22 @@ module Alchemy
       end
 
       def page_scope
-        base_page_scope.contentpages
+        page_scope_with_includes.contentpages
+      end
+
+      def page_scope_with_includes
+        base_page_scope.
+          with_language(Language.current).
+          preload(language: { nodes: [:parent, :page, :children] }, 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)
-          pages = Page.all
+        if can?(:edit_content, ::Alchemy::Page)
+          ::Alchemy::JsonApi::Page.all
         else
-          pages = Page.published
+          ::Alchemy::JsonApi::Page.published
         end
-        pages.
-          with_language(Language.current).
-          preload(language: {nodes: [:parent, :page]}, all_elements: [:parent_element, :nested_elements, { contents: { essence: :ingredient_association } }])
       end
 
       def jsonapi_serializer_class(_resource, _is_collection)

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.all_elements.detect do |element|
+          element.id == parent_element_id
+        end
+      end
+
+      def nested_elements
+        @_nested_elements ||= begin
+          page.all_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,50 @@
+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 ||= first_level_elements.reject(&:fixed?)
+      end
+
+      # The top level public, fixed elements of this page that - if present -
+      # contains their nested_elements.
+      def fixed_elements
+        @_fixed_elements ||= first_level_elements.select(&:fixed?)
+      end
+
+      def element_ids
+        @_element_ids ||= elements.map(&:id)
+      end
+
+      def fixed_element_ids
+        @_fixed_element_ids ||= fixed_elements.map(&:id)
+      end
+
+      private
+
+      def first_level_elements
+        @_first_level_elements ||= all_elements.reject(&:parent_element_id)
+      end
+    end
+  end
+end

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

@@ -11,6 +11,11 @@ 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
@@ -20,11 +25,6 @@ module Alchemy
       end
 
       has_many :nested_elements, record_type: :element, serializer: self
-
-      with_options if: ->(_, params) { params[:admin] == true } do
-        attribute :tag_list
-        attribute :display_name, &:display_name_with_preview_text
-      end
     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,17 +20,17 @@ module Alchemy
 
       belongs_to :language, record_type: :language, serializer: ::Alchemy::JsonApi::LanguageSerializer
 
-      has_many :elements, record_type: :element, serializer: ::Alchemy::JsonApi::ElementSerializer
-      has_many :fixed_elements, record_type: :element, serializer: ::Alchemy::JsonApi::ElementSerializer
+      # 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? }
-      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.9.0"
+    VERSION = "0.12.0"
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-json_api
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: jsonapi.rb
   requirement: !ruby/object:Gem::Requirement
@@ -94,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
@@ -107,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