izi_json_ld 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 829963d96abb460e0ea484d424bfe2d1c788bb73817f43f71c3c272a1dd8fe8e
+  data.tar.gz: 310de3da62be69677e36359a3aa8aa625e5ba2ea4c5208f616ad6821d53b9402
+SHA512:
+  metadata.gz: 2c00cd328bb712e104d28644f6f10340cfd15e2c35493f40330d78df20e6004ef481c7e9eb3b9fd10b32b24c3abee9893941c065585411f8ffdc512fe76b23c0
+  data.tar.gz: ea23f754afc1bf8ac65f3bdbba4754569fd803a7846689ff38840738322292c97727e222ebbc4d6d62b96e73d3981993c56f665b0c685b4dca819cdfe606cd3b

data/README.rdoc

@@ -0,0 +1,3 @@
+# Izi JSON-ld
+
+Utils to add json-ld schema more easily

data/app/entities/aggregate_rating_entity.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class AggregateRatingEntity < RatingEntity
+  extra '@type', 'AggregateRating'
+end

data/app/entities/application_entity.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class ApplicationEntity < Dry::Struct
+  transform_keys(&:to_sym)
+  delegate :extras, to: :class
+  delegate :as_json, to: :to_h
+
+  def to_h
+    extras.merge(super)
+  end
+
+  def to_json(*args)
+    super.html_safe
+  end
+
+  class << self
+    def extras
+      @extras ||= {}
+    end
+
+    def extra(key, value)
+      extras[key] = value
+    end
+  end
+end

data/app/entities/offer_entity.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class OfferEntity < ApplicationEntity
+  extra '@type', 'Offer'
+
+  attribute :url, ::IziJsonLd::Types::Coercible::String
+  attribute :price, ::IziJsonLd::Types::Coercible::Float
+  attribute :priceCurrency, ::IziJsonLd::Types::String.optional.default('USD')
+  attribute :availability, ::IziJsonLd::Types::String.optional.default('https://schema.org/OnlineOnly')
+end

data/app/entities/product_entity.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class ProductEntity < ApplicationEntity
+  extra '@context', 'http://www.schema.org'
+  extra '@type', 'Product'
+
+  attribute :name, ::IziJsonLd::Types::String
+  attribute? :brand, ::IziJsonLd::Types::String.optional
+  attribute? :image, ::IziJsonLd::Types::String.optional
+  attribute? :description, ::IziJsonLd::Types::String.optional
+
+  attribute? :offers, OfferEntity.optional
+  attribute? :aggregateRating, AggregateRatingEntity.optional
+end

data/app/entities/rating_entity.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class RatingEntity < ApplicationEntity
+  extra '@type', 'Rating'
+
+  attribute :bestRating, ::IziJsonLd::Types::Coercible::Float.optional.default(5)
+  attribute :worstRating, ::IziJsonLd::Types::Coercible::Float.optional.default(1)
+  attribute :ratingValue, ::IziJsonLd::Types::Coercible::Float
+end

data/app/entities/review_entity.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ReviewEntity < ApplicationEntity
+  extra '@type', 'Review'
+
+  attribute? :author, ::IziJsonLd::Types::String.optional
+  attribute? :description, ::IziJsonLd::Types::String.optional
+  attribute? :reviewRating, RatingEntity.optional
+
+  attribute? :datePublished, (::IziJsonLd::Types::Nominal::Date | ::IziJsonLd::Types::JSON::Date).optional
+end

data/app/entities/service_entity.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class ServiceEntity < ApplicationEntity
+  extra '@context', 'http://www.schema.org'
+  extra '@type', 'Service'
+
+  attribute :name, ::IziJsonLd::Types::String
+  attribute? :review, ::ReviewEntity.optional
+  attribute? :reviews, ::IziJsonLd::Types::Array.of(::ReviewEntity).optional
+end

data/app/helpers/critical_helper.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module CriticalHelper
+  def css_preload(names)
+    return '' if names.blank?
+    names = Array.wrap(names)
+
+    link = stylesheet_link_tag(*names, rel: 'preload', as: 'style', onload: 'this.rel="stylesheet"')
+    noscript = content_tag :noscript do
+      stylesheet_link_tag(*names)
+    end
+
+    link + noscript
+  end
+
+  def inline_js(name)
+    IziJsonLd::InlineAsset.inline_js(name).html_safe
+  end
+
+  def inline_css(name)
+    raw = IziJsonLd::InlineAsset.inline_css(name).html_safe
+    raw = "<!-- CRIT CSS: #{name} -->".html_safe + raw if Rails.env.development?
+    raw
+  end
+
+  def critical_js
+    inline_js('crit-utils/bundle.js').presence || '<!-- CRIT JS NOT FOUND! -->'.html_safe
+  end
+
+  def critical_css(params = {})
+    scope = params.fetch(:scope, 'critical')
+    name = find_scoped_css(scope)
+    stylesheets = Array.wrap(params.fetch(:stylesheets, []))
+    data = StringIO.new
+
+    if name.blank?
+      # insert stylesheets directly if not crit css
+      data << '<!-- CRIT CSS NOT FOUND! -->'
+      data << stylesheet_link_tag(*stylesheets) if stylesheets.present?
+    else
+      data << inline_css(name)
+      data << css_preload(stylesheets) if stylesheets.present?
+      data << inline_js('crit-utils/measure.js') if Rails.env.development?
+    end
+
+    data.string.html_safe
+  end
+
+  def smart_picture(object, *args, **xargs, &block)
+    return '' if object.blank?
+
+    IziJsonLd::SmartPicture.render(object, *args, **xargs, &block)
+  end
+
+  def debug_critical_css(scope_name = 'critical')
+    {
+      lookup: scoped_css_files(scope_name),
+      found: find_scoped_css(scope_name)
+    }.to_json.html_safe
+  end
+
+  private
+
+  def scoped_css_files(scope_name)
+    [
+      "#{controller_path}_#{action_name}",
+      controller_path,
+      *scoped_namespace_file(scope_name),
+      "#{controller_name}_#{action_name}",
+      controller_name,
+      scope_name
+    ].compact.uniq.map { |l| File.join(scope_name, "#{l}.css") }
+  end
+
+  def scoped_namespace_file(scope_name)
+    scopes = []
+    return scopes if controller_path == controller_name
+
+    parts = controller_path.gsub(/\/#{controller_name}$/, '').split('/').reject(&:blank?)
+    parts.each { |p| scopes.unshift(File.join([scopes.first, p].compact)) }
+
+    scopes.uniq
+  end
+
+  def find_scoped_css(scope_name)
+    scoped_css_files(scope_name).detect { |n| asset_exist?(n) }
+  end
+
+  def fetch_items(object, fields)
+    Array.wrap(fields).map do |name|
+      object.respond_to?(name) ? object.public_send(name) : nil
+    end.compact
+  end
+
+  def asset_exist?(name)
+    return find_asset_source(name)&.present? if Rails.env.development?
+
+    manifest.assets.key?(name)
+  end
+
+  def find_asset_source(name)
+    return find_sources_fallback(name) if old_manifest?
+
+    manifest.find_sources(name)&.first
+  end
+
+  def find_sources_fallback(asset_path)
+    Rails.application.assets.find_asset(asset_path)
+  end
+
+  def old_manifest?
+    !manifest.respond_to?(:find_sources)
+  end
+
+  def manifest
+    @manifest ||= Rails.application.assets_manifest
+  end
+end

data/lib/izi_json_ld.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'izi_json_ld/version'
+require 'pathname'
+
+# core setup
+module IziJsonLd
+  class << self
+    def configure
+      yield self
+    end
+  end
+
+  autoload :Types, 'izi_json_ld/types'
+
+  class << self
+    def root_path
+      @root_path ||= Pathname.new(File.dirname(File.expand_path(__dir__)))
+    end
+  end
+end
+
+require 'izi_json_ld/engine'

data/lib/izi_json_ld/engine.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+
+module IziJsonLd
+  class Engine < ::Rails::Engine
+    engine_name 'izi_json_ld'
+
+    require_relative 'extentions/autoload_paths'
+  end
+end

data/lib/izi_json_ld/extentions/autoload_paths.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# isolate_namespace IziJsonLd
+::IziJsonLd::Engine.config.autoload_paths += %W[
+  #{IziJsonLd.root_path}/app/helpers
+]

data/lib/izi_json_ld/types.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module IziJsonLd
+  module Types
+    include Dry.Types()
+  end
+end

data/lib/izi_json_ld/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IziJsonLd
+  VERSION = '1.0.0'
+end

data/spec/dummy/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'byebug'
+gem 'dry-struct'
+gem 'faker'
+gem 'rails'
+gem 'sqlite3'
+
+group :test do
+  gem 'guard', require: false
+  gem 'guard-rspec', require: false
+  gem 'rspec'
+  gem 'rspec-rails'
+end

data/spec/dummy/Gemfile.lock

@@ -0,0 +1,229 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.3)
+      actionpack (= 6.1.3)
+      activesupport (= 6.1.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.3)
+      actionpack (= 6.1.3)
+      activejob (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3)
+      actionpack (= 6.1.3)
+      actionview (= 6.1.3)
+      activejob (= 6.1.3)
+      activesupport (= 6.1.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.3)
+      actionview (= 6.1.3)
+      activesupport (= 6.1.3)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.3)
+      actionpack (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3)
+      activesupport (= 6.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.3)
+      activesupport (= 6.1.3)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3)
+      activesupport (= 6.1.3)
+    activerecord (6.1.3)
+      activemodel (= 6.1.3)
+      activesupport (= 6.1.3)
+    activestorage (6.1.3)
+      actionpack (= 6.1.3)
+      activejob (= 6.1.3)
+      activerecord (= 6.1.3)
+      activesupport (= 6.1.3)
+      marcel (~> 0.3.1)
+      mimemagic (~> 0.3.2)
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    dry-configurable (0.12.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.5.0)
+      concurrent-ruby (~> 1.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.1.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-struct (1.4.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-types (~> 1.5)
+      ice_nine (~> 0.11)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    erubi (1.10.0)
+    faker (2.17.0)
+      i18n (>= 1.6, < 2)
+    ffi (1.15.0)
+    formatador (0.2.5)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    listen (3.4.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.2.8)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    nenv (0.3.0)
+    nio4r (2.5.7)
+    nokogiri (1.11.2)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.3)
+      actioncable (= 6.1.3)
+      actionmailbox (= 6.1.3)
+      actionmailer (= 6.1.3)
+      actionpack (= 6.1.3)
+      actiontext (= 6.1.3)
+      actionview (= 6.1.3)
+      activejob (= 6.1.3)
+      activemodel (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3)
+      actionpack (= 6.1.3)
+      activesupport (= 6.1.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rake (13.0.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.0)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    shellany (0.0.1)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  dry-struct
+  faker
+  guard
+  guard-rspec
+  rails
+  rspec
+  rspec-rails
+  sqlite3
+
+BUNDLED WITH
+   2.1.4