scrivito_rich_snippet_widget 0.1.0

data/app/models/rich_snippet/organization.rb

@@ -0,0 +1,33 @@
+module RichSnippet
+  class Organization < Thing
+    attribute :address, :reference
+    attribute :founder, :reference
+    attribute :founding_date, :date
+    attribute :legal_name, :string
+    attribute :logo, :reference
+    attribute :number_of_employees, :integer
+    attribute :parent_organization, :reference
+    attribute :sub_organizations, :referencelist
+    attribute :telephone, :string
+
+    def to_json(render_childs = false)
+      {
+        "@context": "http://schema.org",
+        "@type": "Organization",
+        name: name,
+        description: description,
+        image: image ? image.binary_url : '',
+        url: url,
+        address: address ? address.to_json : nil,
+        founder: founder ? founder.to_json : nil,
+        foundingDate: founding_date,
+        legalName: legal_name,
+        logo: logo ? logo.binary_url : nil,
+        numberOfEmployees: number_of_employees,
+        parentOrganization: parent_organization ? parent_organization.to_json : nil,
+        subOrganizations: array_json(sub_organizations),
+        telephone: telephone
+      }.delete_if { |k, v| !v.present? }
+    end
+  end
+end

data/app/models/rich_snippet/person.rb

@@ -0,0 +1,70 @@
+module RichSnippet
+  class Person < Thing
+    attribute :given_name, :string
+    attribute :additional_name, :string
+    attribute :family_name, :string
+    attribute :address, :reference
+    attribute :birth_date, :date
+    attribute :birth_place, :reference
+    attribute :death_date, :date
+    attribute :death_place, :reference
+    attribute :childs, :referencelist
+    attribute :email, :string
+    attribute :gender, :string
+    attribute :height, :float
+    attribute :nationality, :string
+    attribute :mother, :reference
+    attribute :father, :reference
+    attribute :siblings, :referencelist
+    attribute :telephone, :string
+    attribute :weight, :float
+    attribute :work_location, :reference
+    attribute :works_for, :reference
+
+    def to_json(render_childs = false)
+      json = {
+        "@context": "http://schema.org",
+        "@type": "Person",
+        name: name,
+        description: description,
+        image: image ? image.binary_url : nil,
+        url: url,
+        givenName: given_name,
+        additionalName: additional_name,
+        familyName: family_name,
+        address: address ? address.to_json : nil,
+        birthDate: birth_date,
+        birthPlace: {
+          "@context": "http://schema.org",
+          "@type": "Place",
+          address: birth_place ? birth_place.to_json : nil
+        },
+        deathDate: death_date,
+        "deathPlace": {
+          "@context": "http://schema.org",
+          "@type": "Place",
+          address: death_place ? death_place.to_json : nil
+        },
+        email: email,
+        gender: gender,
+        height: height,
+        nationality: nationality,
+        workLocation: work_location ? work_location.to_json : nil,
+        worksFor: works_for ? works_for.to_json : nil,
+        telephone: telephone,
+        weight: weight
+      }
+
+      if(render_childs)
+        json[:children] = array_json(children)
+        json[:siblings] = array_json(siblings)
+        json[:parents] = [
+          mother.to_json,
+          father.to_json
+        ]
+      end
+
+      return json.delete_if { |k, v| !v.present? }
+    end
+  end
+end

data/app/models/rich_snippet/postal_address.rb

@@ -0,0 +1,33 @@
+module RichSnippet
+  class PostalAddress < Thing
+    attribute :address_country, :string
+    attribute :address_locality, :string
+    attribute :address_region, :string
+    attribute :post_office_box_number, :string
+    attribute :postal_code, :string
+    attribute :street_address, :string
+    attribute :email, :string
+    attribute :telephone, :string
+    attribute :fax_number, :string
+
+    def to_json(render_childs = false)
+      {
+        "@context": "http://schema.org",
+        "@type": "PostalAddress",
+        name: name,
+        description: description,
+        image: image ? image.binary_url : '',
+        url: url,
+        addressCountry: address_country,
+        addressLocality: address_locality,
+        addressRegion: address_region,
+        postOfficeBoxNumber: post_office_box_number,
+        postalCode: postal_code,
+        streetAddress: street_address,
+        email: email,
+        telephone: telephone,
+        faxNumber: fax_number
+      }.delete_if { |k, v| !v.present? }
+    end
+  end
+end

data/app/models/rich_snippet/product.rb

@@ -0,0 +1,40 @@
+module RichSnippet
+  class Product < Thing
+    attribute :mpn, :string
+    attribute :brand, :reference
+    attribute :offers, :referencelist
+    attribute :awards, :stringlist
+    attribute :category, :string
+    attribute :color, :string
+    attribute :height, :float
+    attribute :width, :float
+    attribute :depth, :float
+    attribute :weight, :float
+    attribute :item_condition, :enum, values: ['Damaged','New','Refurbished','Used']
+    attribute :manufacturer, :reference
+    attribute :release_date, :date
+
+    def to_json(render_childs = false)
+      {
+        "@context": "http://schema.org/",
+        "@type": "Product",
+        name: name,
+        image: image,
+        description: description,
+        mpn: mpn,
+        award: awards,
+        brand: brand ? brand.to_json : nil,
+        offers: array_json(offers),
+        itemCondition: "https://schema.org/#{item_condition}Condition",
+        category: category,
+        color: color,
+        height: height,
+        width: width,
+        depth: depth,
+        weight: weight,
+        manufacturer: manufacturer ? manufacturer.to_json : nil,
+        releaseDate: release_date
+      }.delete_if { |k, v| !v.present? }
+    end
+  end
+end

data/app/models/rich_snippet/recipe.rb

@@ -0,0 +1,69 @@
+module RichSnippet
+  class Recipe < Thing
+    attribute :prep_time, :integer
+    attribute :total_time, :integer
+    attribute :cook_time, :integer
+    attribute :cooking_method, :string
+    attribute :recipe_yield, :integer
+    attribute :recipe_ingredients, :stringlist
+    attribute :recipe_cuisine, :string
+    attribute :recipe_category, :string
+    attribute :suitable_for_diet, :string
+    attribute :recipe_instructions, :stringlist
+    attribute :author, :reference
+
+    attribute :calories, :integer
+    attribute :fat_content, :integer
+    attribute :carbohydrate_content, :integer
+    attribute :cholesterol_content, :integer
+    attribute :fiber_content, :integer
+    attribute :protein_content, :integer
+    attribute :saturated_fat_content, :integer
+    attribute :serving_size, :integer
+    attribute :sodium_content, :integer
+    attribute :sugar_content, :integer
+    attribute :trans_fat_content, :integer
+
+
+    def to_json(render_childs = false)
+      {
+        "@context": "http://schema.org",
+        "@type": "Recipe",
+        name: name,
+        description: description,
+        image: image ? image.binary_url : '',
+        url: url,
+        author: author ? author.to_json : nil,
+        prepTime: "PT#{prep_time}M",
+        totalTime: "PT#{total_time}M",
+        cookTime: "PT#{cook_time}M",
+        cookingMethod: cooking_method,
+        recipeYield: recipe_yield,
+        recipeIngredient: recipe_ingredients.split(','),
+        recipeCuisine: recipe_cuisine,
+        recipeCategory: recipe_category,
+        recipeInstructions: recipe_instructions,
+        nutrition: {
+          "@context": "http://schema.org",
+          "@type": "NutritionInformation",
+          calories: "#{calories} calories",
+          fatContent: "#{fat_content} g",
+          carbohydrateContent: "#{carbohydrate_content} g",
+          cholesterolContent: "#{cholesterol_content} mg",
+          fiberContent: "#{fiber_content} g",
+          proteinContent: "#{protein_content} g",
+          saturatedFatContent: "#{saturated_fat_content} g",
+          servingSize: "#{serving_size} #{serving_size == 1 ? 'Serving' : 'Servings'}",
+          sodiumContent: "#{sodium_content} g",
+          sugarContent: "#{sugar_content} g",
+          transFatContent: "#{trans_fat_content} g"
+        },
+        suitableForDiet: {
+          "@context": "http://schema.org",
+          "@type": "RestrictedDiet",
+          description: suitable_for_diet
+        }
+      }.delete_if { |k, v| !v.present? }
+    end
+  end
+end

data/app/models/rich_snippet/thing.rb

@@ -0,0 +1,43 @@
+module RichSnippet
+  class Thing < Obj
+    attribute :description, :string
+    attribute :image, :reference
+    attribute :title, :string
+    attribute :url, :string
+
+    def name
+      self.title
+    end
+
+    def module
+      self.class.name.demodulize.downcase
+    end
+
+    def type
+      self.class.name.underscore
+    end
+
+    def array_json(attribute)
+      o = []
+      attribute.each do |elem|
+        o << elem.to_json
+      end
+      return o
+    end
+
+    def to_json(render_childs = false)
+      {
+        "@context": "http://schema.org",
+        "@type": "Thing",
+        name: name,
+        description: description,
+        image: image ? image.binary_url : '',
+        url: url
+      }.delete_if { |k, v| !v.present? }
+    end
+
+    def warnings
+      []
+    end
+  end
+end

data/app/models/rich_snippet_widget.rb

@@ -0,0 +1,20 @@
+class RichSnippetWidget < Widget
+  attribute :snippet, :reference
+
+  def type
+    self.snippet.type
+  end
+
+  def module
+    self.snippet.module
+  end
+
+  def warnings
+    return ['No snippet selected'] if snippet.blank?
+    snippet.warnings
+  end
+
+  def to_json
+    snippet.to_json(true).to_json
+  end
+end

data/app/views/rich_snippet/creative_work/_details.html.erb

@@ -0,0 +1,136 @@
+<%= render 'rich_snippet/thing/details', obj: obj, url_is_mandatory: false %>
+
+<%= scrivito_details_for "Event attributes" do %>
+  <%= scrivito_details_for 'Type' do %>
+    <%= scrivito_tag :div, obj, :work_type, data: {scrivito_editors_reload: true} %>
+  <% end %>
+
+  <%= scrivito_details_for 'about' do %>
+    <%= scrivito_tag :div, obj, :about %>
+  <% end %>
+
+  <%= scrivito_details_for 'author' do %>
+    <%= scrivito_tag :div, obj, :author, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Person', 'Organizazion']}} %>
+  <% end %>
+
+  <%= scrivito_details_for 'contributor' do %>
+    <%= scrivito_tag :div, obj, :contributor, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Person', 'Organization']}} %>
+  <% end %>
+
+  <%= scrivito_details_for 'copyright_holder' do %>
+    <%= scrivito_tag :div, obj, :copyright_holder, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Person', 'Organization']}} %>
+  <% end %>
+
+  <%= scrivito_details_for 'copyright_year' do %>
+    <%= scrivito_tag :div, obj, :copyright_year %>
+  <% end %>
+
+  <%= scrivito_details_for 'date_created' do %>
+    <%= scrivito_tag :div, obj, :date_created %>
+  <% end %>
+
+  <%= scrivito_details_for 'date_published' do %>
+    <%= scrivito_tag :div, obj, :date_published %>
+  <% end %>
+
+  <%= scrivito_details_for 'genre' do %>
+    <%= scrivito_tag :div, obj, :genre %>
+  <% end %>
+
+  <%= scrivito_details_for 'in_language' do %>
+    <%= scrivito_tag :div, obj, :in_language %>
+  <% end %>
+
+  <%= scrivito_details_for 'is_accessible_for_free' do %>
+    <%= scrivito_tag :div, obj, :is_accessible_for_free %>
+  <% end %>
+
+  <%= scrivito_details_for 'is_based_on' do %>
+    <%= scrivito_tag :div, obj, :is_based_on, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['CreativeWork']}} %>
+  <% end %>
+
+  <%= scrivito_details_for 'is_family_friendly' do %>
+    <%= scrivito_tag :div, obj, :is_family_friendly %>
+  <% end %>
+
+  <%= scrivito_details_for 'license' do %>
+    <%= scrivito_tag :div, obj, :license %>
+  <% end %>
+
+  <%= scrivito_details_for 'offers' do %>
+    <%= scrivito_tag :div, obj, :offers, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Offer']}} %>
+  <% end %>
+
+  <%= scrivito_details_for 'position' do %>
+    <%= scrivito_tag :div, obj, :position %>
+  <% end %>
+
+  <%= scrivito_details_for 'publisher' do %>
+    <%= scrivito_tag :div, obj, :publisher, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Person', 'Organization']}} %>
+  <% end %>
+
+  <%= scrivito_details_for 'thumbnail_url' do %>
+    <%= scrivito_tag :div, obj, :thumbnail_url %>
+  <% end %>
+
+  <%= scrivito_details_for 'typical_age_range' do %>
+    <%= scrivito_tag :div, obj, :typical_age_range %>
+  <% end %>
+
+  <% if obj.work_type == 'Book' %>
+    <%= scrivito_details_for "Event attributes" do %>
+      <%= scrivito_details_for 'illustrator' do %>
+        <%= scrivito_tag :div, obj, :illustrator, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Person', 'Organization']}} %>
+      <% end %>
+
+      <%= scrivito_details_for 'isbn' do %>
+        <%= scrivito_tag :div, obj, :isbn %>
+      <% end %>
+
+      <%= scrivito_details_for 'number_of_page' do %>
+        <%= scrivito_tag :div, obj, :number_of_page %>
+      <% end %>
+    <% end %>
+  <% end %>
+
+  <% if obj.work_type == 'Movie' %>
+    <%= scrivito_details_for "Event attributes" do %>
+      <%= scrivito_details_for 'actors' do %>
+        <%= scrivito_tag :div, obj, :actors, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Person']}} %>
+      <% end %>
+
+      <%= scrivito_details_for 'director' do %>
+        <%= scrivito_tag :div, obj, :director, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Person']}} %>
+      <% end %>
+
+      <%= scrivito_details_for 'duration' do %>
+        <%= scrivito_tag :div, obj, :duration %>
+      <% end %>
+    <% end %>
+  <% end %>
+
+  <% if obj.work_type == 'WebPage' %>
+    <%= scrivito_details_for "Event attributes" do %>
+      <%= scrivito_details_for 'breadcrumb' do %>
+        <%= scrivito_tag :div, obj, :breadcrumb %>
+      <% end %>
+    <% end %>
+  <% end %>
+
+  <% if obj.work_type == 'MusicComposition' %>
+    <%= scrivito_details_for "Event attributes" do %>
+      <%= scrivito_details_for 'composer' do %>
+        <%= scrivito_tag :div, obj, :composer, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Person', 'Organization']}} %>
+      <% end %>
+
+      <%= scrivito_details_for 'lyricist' do %>
+        <%= scrivito_tag :div, obj, :lyricist, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Person']}} %>
+      <% end %>
+
+      <%= scrivito_details_for 'lyrics' do %>
+        <%= scrivito_tag :div, obj, :lyrics %>
+      <% end %>
+    <% end %>
+  <% end %>
+
+<% end %>