izi_json_ld 1.0.1 → 1.0.6

data/spec/entities/aggregate_rating_entity_spec.rb

@@ -23,7 +23,8 @@ RSpec.describe AggregateRatingEntity do
 
   [
     ['bestRating', 5],
-    ['worstRating', 1]
+    ['worstRating', 1],
+    ['reviewCount', 1]
   ].each do |(field, value)|
     it "should have default #{field}" do
       expect(item.as_json).to have_key field

data/spec/entities/article_entity_spec.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+RSpec.describe ArticleEntity do
+  let(:item) do
+    described_class.new(
+      headline: 'Test Article Title',
+      mainEntityOfPage: {
+        web_page: 'https://exampla.com/blog/page'
+      }
+    )
+  end
+
+  it 'should be searializable as hash' do
+    expect(item.as_json).to be_present
+  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 'Article'
+  end
+
+  it 'should have @context at root entity' 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 'possible to set mainEntityOfPage as URL' do
+    custom = described_class.new(headline: 'Title', mainEntityOfPage: 'https://exampla.com/blog/page')
+    expect(custom.as_json.dig('mainEntityOfPage')).to be_present
+    expect(custom.as_json.dig('mainEntityOfPage')).to eq 'https://exampla.com/blog/page'
+  end
+
+  context 'filled Article' do
+    let(:item) do
+      described_class.new(
+        mainEntityOfPage: {
+          web_page: 'https://exampla.com/blog/page'
+        },
+        headline: 'Test Article Title',
+        description: 'Test Article Description',
+        image: 'https://exampla.com/blog/page.png',
+        author: { name: 'TestUser' },
+        publisher: {
+          name: 'TestInc',
+          logo: { url: 'https://exampla.com/logo.png' }
+        },
+        datePublished: 1.week.ago,
+        dateModified: 2.days.ago
+      )
+    end
+
+    it 'should not fail' do
+      expect do
+        item.dump
+        item.as_json
+        item.to_json
+      end.not_to raise_exception
+    end
+
+    [
+      ['Publisher name', %w[publisher name], 'TestInc'],
+      ['Main Entity id', %w[mainEntityOfPage @id], 'https://exampla.com/blog/page'],
+      ['Publisher type', %w[publisher @type], 'Organization'],
+      ['Publisher logo type', %w[publisher logo @type], 'ImageObject'],
+      ['Publisher logo', %w[publisher logo url], 'https://exampla.com/logo.png'],
+      ['Post image', %w[image], 'https://exampla.com/blog/page.png'],
+      ['Author as org', %w[author @type], 'Organization'],
+      ['Author name', %w[author name], 'TestUser']
+    ].each do |(desc, path, val)|
+      it "should render #{desc}[#{path.join('.')}]" do
+        expect(item.as_json.dig(*path)).to be_present
+        expect(item.as_json.dig(*path)).to eq val
+      end
+    end
+  end
+
+  context 'with author as a Person' do
+    let(:item) do
+      described_class.new(
+        mainEntityOfPage: {
+          web_page: 'https://exampla.com/blog/page'
+        },
+        headline: 'Test Article Title',
+        publisher: {
+          person_name: 'SiteOwner',
+          email: 'site.owner@example.com',
+          image: 'owner.png'
+        },
+        author: {
+          person_name: 'TestBlogger',
+          image: 'blogger.png'
+        }
+      )
+    end
+
+    [
+      ['Publisher as person', %w[publisher @type], 'Person'],
+      ['Publisher name', %w[publisher name], 'SiteOwner'],
+      ['Publisher email', %w[publisher email], 'site.owner@example.com'],
+      ['Publisher image', %w[publisher image], 'owner.png'],
+      ['Author as person', %w[author @type], 'Person'],
+      ['Author name', %w[author name], 'TestBlogger'],
+      ['Author image', %w[author image], 'blogger.png']
+    ].each do |(desc, path, val)|
+      it "should render #{desc}[#{path.join('.')}]" do
+        expect(item.as_json.dig(*path)).to be_present
+        expect(item.as_json.dig(*path)).to eq val
+      end
+    end
+  end
+end

data/spec/entities/breadcrumb_list_entity_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+RSpec.describe BreadcrumbListEntity do
+  let(:item) { described_class.new(itemListElement: []) }
+
+  it 'should be searializable as hash' do
+    expect(item.as_json).to be_present
+  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 'BreadcrumbList'
+  end
+
+  it 'should have @context at root entity' 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
+
+  context 'with simple item' do
+    let(:item) do
+      described_class.new(itemListElement: { name: 'Home', position: 0, item: 'https://example.com' })
+    end
+
+    it 'should not fail' do
+      expect do
+        item.dump
+        item.as_json
+        item.to_json
+      end.not_to raise_exception
+    end
+  end
+
+  context 'with multiple items' do
+    let(:item) do
+      described_class.new(
+        itemListElement: [
+          { name: 'Home', position: 0, item: 'https://example.com' },
+          { name: 'Blog', position: 1, item: 'https://example.com/blog' },
+          { name: 'Post', position: 2, item: 'https://example.com/blog/post' },
+        ]
+      )
+    end
+
+    it 'should not fail' do
+      expect do
+        item.dump
+        item.as_json
+        item.to_json
+      end.not_to raise_exception
+    end
+  end
+end

data/spec/entities/faq_page_entity_spec.rb

@@ -0,0 +1,75 @@
+# 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
+  end
+end

data/spec/entities/product_entity_spec.rb

@@ -35,6 +35,12 @@ RSpec.describe ProductEntity do
       expect(item.as_json['aggregateRating']).to be_present
       expect(item.as_json.dig('aggregateRating', 'ratingValue')).to eq 4
     end
+
+    it 'should have aggregateRating @type' do
+      expect(item.as_json).to have_key 'aggregateRating'
+      expect(item.as_json['aggregateRating']).to be_present
+      expect(item.as_json.dig('aggregateRating', '@type')).to eq 'AggregateRating'
+    end
   end
 
   context 'with offers' do
@@ -45,5 +51,51 @@ RSpec.describe ProductEntity do
       expect(item.as_json['offers']).to be_present
       expect(item.as_json.dig('offers', 'url')).to eq 'test'
     end
+
+    it 'offers should have right @type' do
+      expect(item.as_json).to have_key 'offers'
+      expect(item.as_json['offers']).to be_present
+      expect(item.as_json.dig('offers', '@type')).to eq 'Offer'
+    end
+  end
+
+  context 'with review' do
+    let(:review) { { author: 'test', reviewRating: { ratingValue: 2 } } }
+    let(:reviews) do
+      [
+        { author: 'test', reviewRating: { ratingValue: 2 } },
+        { author: 'test2', reviewRating: { ratingValue: 3 } },
+        { author: 'test3', reviewRating: { ratingValue: 4 } }
+      ]
+    end
+
+    it 'should allow create product with single review' do
+      data = described_class.new(name: 'Test', review: review)
+      expect(data.to_json).to be_present
+      expect(data.as_json['review']).to be_present
+      expect(data.as_json['review'].class.name).to eq 'Hash'
+    end
+
+    it 'should allow create product with single review' do
+      data = described_class.new(name: 'Test', review: reviews)
+      expect(data.to_json).to be_present
+      expect(data.as_json['review']).to be_present
+      expect(data.as_json['review'].class.name).to eq 'Array'
+    end
+
+    it 'review & reviewRating should contain right @type' do
+      data = described_class.new(name: 'Test', review: reviews)
+      expect(data.as_json.dig('review', 0, '@type')).to eq 'Review'
+      expect(data.as_json.dig('review', 0, 'reviewRating', '@type')).to eq 'Rating'
+    end
+
+    it 'ensure proper serialization' do
+      data = described_class.new(name: 'Test', review: reviews)
+      raw = data.to_json
+      parsed = JSON.parse(raw)
+      expect(parsed).to be_present
+      expect(parsed.dig('review', 0, '@type')).to eq 'Review'
+      expect(parsed.dig('review', 0, 'reviewRating', '@type')).to eq 'Rating'
+    end
   end
 end

data/spec/rails_helper.rb

@@ -22,25 +22,9 @@ require 'rspec/rails'
 #
 # Dir[Rails.root.join('spec', 'support', '**', '*.rb')].sort.each { |f| require f }
 
-# Checks for pending migrations and applies them before tests are run.
-# If you are not using ActiveRecord, you can remove these lines.
-begin
-  ActiveRecord::Migration.maintain_test_schema!
-rescue ActiveRecord::PendingMigrationError => e
-  puts e.to_s.strip
-  exit 1
-end
 RSpec.configure do |config|
-  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  config.fixture_path = "#{::Rails.root}/spec/fixtures"
-
-  # If you're not using ActiveRecord, or you'd prefer not to run each of your
-  # examples within a transaction, remove the following line or assign false
-  # instead of true.
-  config.use_transactional_fixtures = true
-
   # You can uncomment this line to turn off ActiveRecord support entirely.
-  # config.use_active_record = false
+  config.use_active_record = false
 
   # RSpec Rails can automatically mix in different behaviours to your tests
   # based on their file location, for example enabling you to call `get` and

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: izi_json_ld
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.6
 platform: ruby
 authors:
 - IzikAJ
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-15 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -48,32 +48,34 @@ 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/service_entity.rb
+- app/entities/web_page_entity.rb
 - app/helpers/json_ld_helper.rb
 - lib/izi_json_ld.rb
 - lib/izi_json_ld/engine.rb
 - lib/izi_json_ld/extentions/autoload_paths.rb
 - lib/izi_json_ld/types.rb
+- lib/izi_json_ld/types/date_time.rb
+- lib/izi_json_ld/types/one_or_more.rb
 - lib/izi_json_ld/version.rb
-- spec/dummy/Gemfile
-- spec/dummy/Gemfile.lock
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/models/application_record.rb
 - spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/bin/_guard-core
-- spec/dummy/bin/guard
-- spec/dummy/bin/rails
-- spec/dummy/bin/rake
-- spec/dummy/bin/rspec
-- spec/dummy/bin/setup
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
@@ -89,16 +91,19 @@ files:
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/puma.rb
 - 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/product_entity_spec.rb
 - spec/entities/rating_entity_spec.rb
 - spec/entities/review_entity_spec.rb
-- spec/entities/service_entity_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 homepage: https://bitbucket.org/netfixllc/izi_json_ld
@@ -120,23 +125,17 @@ 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
 test_files:
 - spec/spec_helper.rb
-- spec/dummy/app/models/application_record.rb
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/bin/rake
-- spec/dummy/bin/setup
-- spec/dummy/bin/_guard-core
-- spec/dummy/bin/guard
-- spec/dummy/bin/rspec
-- spec/dummy/bin/rails
 - spec/dummy/config/routes.rb
 - spec/dummy/config/environments/production.rb
 - spec/dummy/config/environments/development.rb
@@ -154,15 +153,16 @@ test_files:
 - spec/dummy/config.ru
 - spec/dummy/Rakefile
 - spec/dummy/db/test.sqlite3
-- spec/dummy/Gemfile
+- spec/dummy/db/development.sqlite3
 - spec/dummy/log/test.log
 - spec/dummy/log/development.log
-- spec/dummy/Gemfile.lock
 - spec/dummy/tmp/development_secret.txt
 - spec/rails_helper.rb
 - spec/entities/aggregate_rating_entity_spec.rb
-- spec/entities/service_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/rating_entity_spec.rb
 - spec/entities/offer_entity_spec.rb
+- spec/entities/article_entity_spec.rb
 - spec/entities/product_entity_spec.rb