Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert removal of deprecated elements #29

Merged
merged 2 commits into from
Jan 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions app/serializers/alchemy/json_api/element_serializer.rb
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,10 @@ class ElementSerializer
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
has_many :nested_elements, record_type: :element, serializer: self

with_options if: ->(_, params) { params[:admin] == true } do
attribute :tag_list
Expand Down
11 changes: 3 additions & 8 deletions app/serializers/alchemy/json_api/page_serializer.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,11 @@ class PageSerializer

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
has_many :elements, record_type: :element, serializer: ::Alchemy::JsonApi::ElementSerializer
has_many :fixed_elements, record_type: :element, serializer: ::Alchemy::JsonApi::ElementSerializer

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?) }
page.all_elements.select { |e| e.public? && !e.trashed? }
end

with_options if: ->(_, params) { params[:admin] == true } do
Expand Down
4 changes: 0 additions & 4 deletions spec/dummy/config/alchemy/elements.yml
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,6 @@
- name: essence_html
type: EssenceHtml
hint: true
deprecated: true
- name: essence_link
type: EssenceLink
hint: true
Expand Down Expand Up @@ -161,6 +160,3 @@
fixed: true
unique: true
nestable_elements: [text]

- name: old
deprecated: true
25 changes: 1 addition & 24 deletions spec/requests/alchemy/json_api/pages_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -30,34 +30,11 @@
context "when including elements and essences" do
let(:page) { FactoryBot.create(:alchemy_page, :public, elements: [element]) }
let(:element) { FactoryBot.create(:alchemy_element, name: "article", autogenerate_contents: true) }
let(:included) { JSON.parse(response.body)["included"] }

it "includes the data" do
get alchemy_json_api.page_path(page, include: "all_elements.essences")
included = JSON.parse(response.body)["included"]
expect(included).to include(have_type("element").and(have_id(element.id.to_s)))
expect(included.length).to eq(5)
end

context "if deprecated elements are present" do
let!(:deprecated_element) do
FactoryBot.create(:alchemy_element, page: page, name: "old", autogenerate_contents: true)
end

it "returns only public elements" do
get alchemy_json_api.page_path(page, include: "all_elements.essences")
expect(included.length).to eq(Alchemy.gem_version >= Gem::Version.new("5.2.0.alpha") ? 5 : 6)
end
end

context "if deprecated contents in public elements are present" do
let!(:deprecated_element) do
FactoryBot.create(:alchemy_element, page: page, name: "all_you_can_eat", autogenerate_contents: true)
end

it "returns only public essences" do
get alchemy_json_api.page_path(page, include: "all_elements.essences")
expect(included.length).to eq(Alchemy.gem_version >= Gem::Version.new("5.2.0.alpha") ? 14 : 15)
end
end
end

Expand Down
15 changes: 2 additions & 13 deletions spec/serializers/alchemy/json_api/element_serializer_spec.rb
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
# frozen_string_literal: true
require "rails_helper"
require "alchemy/test_support/factories"
require "alchemy/version"

RSpec.describe Alchemy::JsonApi::ElementSerializer do
let(:element) do
FactoryBot.create(
:alchemy_element,
autogenerate_contents: true,
tag_list: "Tag1,Tag2",
nested_elements: [nested_element, deprecated_element],
nested_elements: [nested_element],
parent_element: parent_element,
)
end
let(:nested_element) { FactoryBot.create(:alchemy_element) }
let(:parent_element) { FactoryBot.create(:alchemy_element) }
let(:deprecated_element) { FactoryBot.create(:alchemy_element, name: "old") }
let(:options) { {} }

subject(:serializer) { described_class.new(element, options) }
Expand Down Expand Up @@ -48,16 +46,7 @@
it "has the right keys and values" do
expect(subject[:page]).to eq(data: { id: element.page_id.to_s, type: :page })
expect(subject[:essences]).to eq(data: element.contents.map { |c| { id: c.essence_id.to_s, type: c.essence.class.name.demodulize.underscore.to_sym } })
if Alchemy.gem_version >= Gem::Version.new("5.2.0.alpha")
expect(subject[:nested_elements]).to eq(data: [{ id: nested_element.id.to_s, type: :element }])
else
expect(subject[:nested_elements]).to eq(
data: [
{ id: nested_element.id.to_s, type: :element },
{ id: deprecated_element.id.to_s, type: :element },
],
)
end
expect(subject[:nested_elements]).to eq(data: [{ id: nested_element.id.to_s, type: :element }])
expect(subject[:parent_element]).to eq(data: { id: parent_element.id.to_s, type: :element })
end
end
Expand Down
26 changes: 3 additions & 23 deletions spec/serializers/alchemy/json_api/page_serializer_spec.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# frozen_string_literal: true
require "rails_helper"
require "alchemy/test_support/factories"
require "alchemy/version"

RSpec.describe Alchemy::JsonApi::PageSerializer do
let(:page) do
Expand Down Expand Up @@ -56,38 +55,19 @@
let(:element) { FactoryBot.create(:alchemy_element) }
let(:fixed_element) { FactoryBot.create(:alchemy_element, fixed: true) }
let(:trashed_element) { FactoryBot.create(:alchemy_element, :trashed) }
let(:deprecated_element) { FactoryBot.create(:alchemy_element, name: "old") }

subject { serializer.serializable_hash[:data][:relationships] }

before do
page.all_elements << element
page.all_elements << fixed_element
page.all_elements << trashed_element
page.all_elements << deprecated_element
trashed_element.trash!
end

it "has the right keys and values, and does not include trashed, hidden or deprecated elements" do
if Alchemy.gem_version >= Gem::Version.new("5.2.0.alpha")
expect(subject[:elements]).to eq(data: [{ id: element.id.to_s, type: :element }])
expect(subject[:all_elements]).to eq(data: [{ id: element.id.to_s, type: :element }, { id: fixed_element.id.to_s, type: :element }])
else
expect(subject[:elements]).to eq(
data: [
{ id: element.id.to_s, type: :element },
{ id: deprecated_element.id.to_s, type: :element },
],
)
expect(subject[:all_elements]).to eq(
data: [
{ id: element.id.to_s, type: :element },
{ id: fixed_element.id.to_s, type: :element },
{ id: deprecated_element.id.to_s, type: :element },
],
)
end
it "has the right keys and values, and does not include trashed elements" do
expect(subject[:elements]).to eq(data: [{ id: element.id.to_s, type: :element }])
expect(subject[:fixed_elements]).to eq(data: [{ id: fixed_element.id.to_s, type: :element }])
expect(subject[:all_elements]).to eq(data: [{ id: element.id.to_s, type: :element }, { id: fixed_element.id.to_s, type: :element }])
expect(subject[:language]).to eq(data: { id: page.language_id.to_s, type: :language })
end
end
Expand Down