alchemy-json_api 0.9.1 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edb472c33e158bda23963966813783a459044d61d268a5ba57a45591584f7f2a
-  data.tar.gz: 73ebfd2b1fd491c217cfb577bc422fa558cad73f1c39c987aaac694766de6fee
+  metadata.gz: 50b6ab14e92599ee97e7e337688a6cc8ff36e7f82d0eccb589caa97a529e78ab
+  data.tar.gz: 4e031aef41f45e7733e1a07ff47dc058f8b083e53da25315e7c5eefa638c86f9
 SHA512:
-  metadata.gz: 8393412853b2a72ee6d997cd57d208cfaeab3b9c351aa6c7a4374f7bafd322cbfa9d45d4fb1c9326e7908f1799d741d2f8365e8a85e37412f2efb8b39d040dbb
-  data.tar.gz: 692729353563f43124fafc2d239d4fcf204f897509953211598e6e15f8a5c6d85b8468be874dc52570bb72c80cb7f4b595fc451cca399e3e8c26893ef645e720
+  metadata.gz: 29faa1ddb7bcf46660148824c14d8af8b59a89f41d93df308c26bf0eba08bb975d85906bf9438691aba39142353dfd1ce4a4d97bfca9f0933ee2a3cc738ddacd
+  data.tar.gz: d9bec282c23b43dcdc4ac24b001d2c862e60c6bff3d0c9b92e335fe1dc303803c3dcf4ffcdd2e0ee3b160c770e8a5c07f066b6e8e787057cdb3ec019bc5d1adf

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

@@ -5,7 +5,7 @@ module Alchemy
       private
 
       def base_page_scope
-        Page.all
+        ::Alchemy::JsonApi::Page.all
       end
 
       def page_scope

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, :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)
-          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.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,24 @@ 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) }
+
+      before do
+        expect(content).to receive(:definition).at_least(:once) do
+          {
+            name: "intro",
+            deprecated: true,
+          }
+        end
+      end
+
+      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.1"
+    VERSION = "0.12.1"
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-json_api
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.12.1
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2021-01-26 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