izi_json_ld 1.0.5 → 1.0.9

data/spec/entities/faq_page_entity_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+RSpec.describe FaqPageEntity do
+  let(:item) { described_class.new(mainEntity: []) }
+
+  it 'should be searializable as hash' do
+    expect(item.as_json).to be_present
+  end
+
+  it 'should be searializable as string' do
+    expect(item.to_json).to be_present
+  end
+
+  it 'should return html_safe string' do
+    expect(item.to_json).to be_html_safe
+  end
+
+  it 'should have @type' do
+    expect(item.as_json).to have_key '@type'
+    expect(item.as_json['@type']).to be_present
+    expect(item.as_json['@type']).to eq 'FAQPage'
+  end
+
+  context 'filled' do
+    let(:item) do
+      described_class.new(
+        mainEntity: [
+          { name: 'Question 1', acceptedAnswer: { text: 'Test answer 1' } },
+          { name: 'Question 2', acceptedAnswer: { text: 'Test answer 2' } },
+          { name: 'Question 3', acceptedAnswer: { text: 'Test answer 3' } }
+        ]
+      )
+    end
+    let(:singular) do
+      described_class.new(
+        mainEntity: {
+          name: 'Sing-Question', acceptedAnswer: { text: 'Sing-Answer' }
+        }
+      )
+    end
+    let(:shortland) do
+      described_class.new(
+        mainEntity: [
+          { name: 'ShortQuestion', answer: 'ShortAnswer' }
+        ]
+      )
+    end
+
+    it 'should render items' do
+      expect(item.as_json).to have_key 'mainEntity'
+      expect(item.as_json['mainEntity']).to be_present
+      expect(item.as_json['mainEntity'].size).to eq 3
+    end
+
+    it 'should render answer properly' do
+      answer = item.as_json.dig('mainEntity', 0)
+      expect(answer['name']).to eq 'Question 1'
+      expect(answer.dig('acceptedAnswer', 'text')).to eq 'Test answer 1'
+    end
+
+    it 'should render singular' do
+      answer = singular.as_json['mainEntity']
+      expect(answer['name']).to eq 'Sing-Question'
+      expect(answer.dig('acceptedAnswer', 'text')).to eq 'Sing-Answer'
+    end
+
+    it 'should accept name/answer shortland items' do
+      answer = shortland.as_json.dig('mainEntity', 0)
+
+      expect(answer).to be_present
+      expect(answer['name']).to eq 'ShortQuestion'
+      expect(answer.dig('acceptedAnswer', 'text')).to eq 'ShortAnswer'
+    end
+
+    it 'should not render useless @context' do
+      parsed = JSON.parse(item.to_json)
+
+      expect(parsed['@context']).to be_present
+      expect(parsed['@context']).to eq 'https://schema.org'
+
+      expect(parsed.dig('mainEntity', 0)).to be_present
+      expect(parsed.dig('mainEntity', 0)).not_to have_key '@context'
+
+      expect(parsed.dig('mainEntity', 0, 'acceptedAnswer')).to be_present
+      expect(parsed.dig('mainEntity', 0, 'acceptedAnswer')).not_to have_key '@context'
+    end
+  end
+end

data/spec/entities/person_entity_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+RSpec.describe PersonEntity do
+  let(:item) { described_class.new(person_name: 'Johan') }
+
+  it 'should be searializable as string' do
+    expect(item.to_json).to be_present
+  end
+
+  it 'should have @context' do
+    expect(item.as_json).to have_key '@context'
+    expect(item.as_json['@context']).to be_present
+    expect(item.as_json['@context']).to include 'schema.org'
+  end
+
+  it 'should have @type' do
+    expect(item.as_json).to have_key '@type'
+    expect(item.as_json['@type']).to be_present
+    expect(item.as_json['@type']).to eq 'Person'
+  end
+
+  it 'allow to pass single sameAs item' do
+    item2 = nil
+    expect do
+      item2 = described_class.new(person_name: 'Johan', sameAs: 'http://example.com')
+    end.not_to raise_error
+    expect(item2).to be_present
+    expect(item2.as_json).to be_present
+    expect(item2.as_json['sameAs']).to eq 'http://example.com'
+  end
+
+  it 'allow to pass multiple sameAs links' do
+    item2 = nil
+    expect do
+      item2 = described_class.new(person_name: 'Johan', sameAs: ['http://example.com', 'http://example.com/extra'])
+    end.not_to raise_error
+    expect(item2).to be_present
+    expect(item2.as_json).to be_present
+    expect(item2.as_json['sameAs']).to include 'http://example.com'
+    expect(item2.as_json['sameAs']).to include 'http://example.com/extra'
+  end
+end

data/spec/entities/review_entity_spec.rb

@@ -2,13 +2,14 @@
 
 RSpec.describe ReviewEntity do
   let(:time) { 1.week.ago }
-  let(:item) do
-    described_class.new(
+  let(:item_data) do
+    {
       author: 'John',
       description: 'TODO',
       reviewRating: { ratingValue: 3 }
-    )
+    }
   end
+  let(:item) { described_class.new(item_data) }
 
   it 'should be searializable as hash' do
     expect(item.as_json).to be_present
@@ -28,17 +29,46 @@ RSpec.describe ReviewEntity do
     expect(item.as_json['@type']).to eq 'Review'
   end
 
-  it 'should allow set datePublished as datetime' do
-    i2 = described_class.new(datePublished: time)
-    obj = JSON.parse(i2.to_json)
-    newTime = Time.zone.parse(obj['datePublished'])
-    expect(newTime).to be_within(1.second).of(time)
+  context 'datePublished' do
+    it 'should allow set datePublished as datetime' do
+      i2 = described_class.new(datePublished: time)
+      obj = JSON.parse(i2.to_json)
+
+      new_time = Time.zone.parse(obj['datePublished'])
+      expect(new_time).to be_within(1.second).of(time)
+    end
+
+    it 'should allow set datePublished as iso8601' do
+      i2 = described_class.new(datePublished: time.iso8601)
+      obj = JSON.parse(i2.to_json)
+
+      new_time = Time.zone.parse(obj['datePublished'])
+      expect(new_time).to be_within(1.second).of(time)
+    end
   end
 
-  it 'should allow set datePublished as iso8601' do
-    i2 = described_class.new(datePublished: time.iso8601)
-    obj = JSON.parse(i2.to_json)
-    newTime = Time.zone.parse(obj['datePublished'])
-    expect(newTime).to be_within(1.second).of(time)
+  context 'author' do
+    it 'should parse author name as person' do
+      author = item.as_json['author']
+      expect(author).to be_a Hash
+      expect(author['@type']).to eq 'Person'
+      expect(author['name']).to eq item.author
+    end
+
+    it 'should allow to pass author hash' do
+      raw = described_class.new(item_data.merge(author: { person_name: 'Kenny' }))
+      author = raw.as_json['author']
+      expect(author).to be_a Hash
+      expect(author['@type']).to eq 'Person'
+      expect(author['name']).to eq raw.author.name
+    end
+
+    it 'should allow to pass author hash (Organization)' do
+      raw = described_class.new(item_data.merge(author: { name: 'Kenny' }))
+      author = raw.as_json['author']
+      expect(author).to be_a Hash
+      expect(author['@type']).to eq 'Organization'
+      expect(author['name']).to eq raw.author.name
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: izi_json_ld
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.9
 platform: ruby
 authors:
 - IzikAJ
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -48,15 +48,18 @@ extra_rdoc_files: []
 files:
 - README.rdoc
 - app/entities/aggregate_rating_entity.rb
+- app/entities/answer_entity.rb
 - app/entities/application_entity.rb
 - app/entities/article_entity.rb
 - app/entities/breadcrumb_list_entity.rb
+- app/entities/faq_page_entity.rb
 - app/entities/image_object_entity.rb
 - app/entities/list_item_entity.rb
 - app/entities/offer_entity.rb
 - app/entities/organization_entity.rb
 - app/entities/person_entity.rb
 - app/entities/product_entity.rb
+- app/entities/question_entity.rb
 - app/entities/rating_entity.rb
 - app/entities/review_entity.rb
 - app/entities/web_page_entity.rb
@@ -90,13 +93,14 @@ files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/development.sqlite3
 - spec/dummy/db/test.sqlite3
-- spec/dummy/log/development.log
 - spec/dummy/log/test.log
 - spec/dummy/tmp/development_secret.txt
 - spec/entities/aggregate_rating_entity_spec.rb
 - spec/entities/article_entity_spec.rb
 - spec/entities/breadcrumb_list_entity_spec.rb
+- spec/entities/faq_page_entity_spec.rb
 - spec/entities/offer_entity_spec.rb
+- spec/entities/person_entity_spec.rb
 - spec/entities/product_entity_spec.rb
 - spec/entities/rating_entity_spec.rb
 - spec/entities/review_entity_spec.rb
@@ -121,7 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project: 
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Izi Lightup
@@ -150,12 +155,13 @@ test_files:
 - spec/dummy/db/test.sqlite3
 - spec/dummy/db/development.sqlite3
 - spec/dummy/log/test.log
-- spec/dummy/log/development.log
 - spec/dummy/tmp/development_secret.txt
 - spec/rails_helper.rb
 - spec/entities/aggregate_rating_entity_spec.rb
 - spec/entities/review_entity_spec.rb
 - spec/entities/breadcrumb_list_entity_spec.rb
+- spec/entities/faq_page_entity_spec.rb
+- spec/entities/person_entity_spec.rb
 - spec/entities/rating_entity_spec.rb
 - spec/entities/offer_entity_spec.rb
 - spec/entities/article_entity_spec.rb

data/spec/dummy/log/development.log

@@ -1,16 +0,0 @@
-   (0.1ms)  SELECT sqlite_version(*)
-  ↳ bin/rails:4
-   (1.2ms)  CREATE TABLE "schema_migrations" ("version" varchar NOT NULL PRIMARY KEY)
-  ↳ bin/rails:4
-   (1.2ms)  CREATE TABLE "ar_internal_metadata" ("key" varchar NOT NULL PRIMARY KEY, "value" varchar, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL)
-  ↳ bin/rails:4
-  ActiveRecord::InternalMetadata Load (0.2ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ? LIMIT ?  [["key", "environment"], ["LIMIT", 1]]
-  ↳ bin/rails:4
-   (0.1ms)  begin transaction
-  ↳ bin/rails:4
-  ActiveRecord::InternalMetadata Create (0.4ms)  INSERT INTO "ar_internal_metadata" ("key", "value", "created_at", "updated_at") VALUES (?, ?, ?, ?)  [["key", "environment"], ["value", "development"], ["created_at", "2021-03-17 08:43:32.839496"], ["updated_at", "2021-03-17 08:43:32.839496"]]
-  ↳ bin/rails:4
-   (0.7ms)  commit transaction
-  ↳ bin/rails:4
-   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
-  ↳ bin/rails:4