scrivito_rich_snippet_widget 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f51102a6c203e57414807e885c092fb2bc404b9e
+  data.tar.gz: f693bec6f0c865338ea4bc65ec1a3b463e4dec3e
+SHA512:
+  metadata.gz: f78542fe3ae6372ae6f7ac9808f3d0b9c786d52ca9be3b5a5e77e69bd911130ca0bd1fd8b7f77f87a1c7dac27f0dcd3c2b59cc17c85e7f513c7b0ecb47c157f1
+  data.tar.gz: 6933e82d5906f753a829e4b0a9c34831d18426a4154d16a5f005ae5290f879a04c77a4373459ce0b5aa903a7c6eb3157ab8bc1535e0a0880ece4886188893fc7

data/README.md

@@ -0,0 +1,129 @@
+# ScrivitoRichSnippetWidget
+Add structured data to you page. Definitions are from https://schema.org
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scrivito_rich_snippet_widget'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+To make the content browser filter available add this to your content browser filter js:
+
+Add this line to your JavaScript manifest **before** you load your content browser filter:
+
+```js
+//= require scrivito_rich_snippet_widget
+```
+
+```js
+scrivito.content_browser.filters(filter) {
+  if(filter.rich_snippet_filter) {
+    rich_snippet_filter(filter.rich_snippet_filter)
+  } else if (your filters) {
+    // ... add your filters here
+  } else {
+    '_obj_class': {
+      options: {
+        // ... add your type defs here
+        rich_snippets: {
+          title: 'Rich Snippets',
+          options: {
+            rich_snippet_filter()
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+## Add your own types
+
+Create a modle at `/model/rich_snippet/new_type.rb` and add your attribute in this scheme:
+
+```ruby
+module RichSnippets
+  class NewType < RichSnippet::Thing
+    attribute my_attribute, :string
+    attribute person, :refernce
+    attribute children, :referencelist
+    # ... more attributes
+
+    def to_json
+      {
+        myAttribute: my_attribute,
+        person: person ? person.to_json : nil, # render the json for another rich snippet
+        children: array_json(children), # render an array of other rich snippets
+        # ... definition for more attributes
+      }
+    end
+
+    # optional method to add warnings rendered by the widget
+    def warnings
+      warns = []
+      warns << "this attribute should be set!" if my_attribute.blank?
+      return warns
+    end
+  end
+end
+```
+
+The create the details view. You need to files:
+
+```ruby
+# add rich_snippet/new_type/details.html.erb
+<%= render 'rich_snippet/new_type/details', obj: @obj %>
+```
+
+```ruby
+# add rich_snippet/new_type/_details.html.erb
+<%= render 'rich_snippet/thing/details', obj: obj, url_is_mandatory: false %>
+
+<%= scrivito_details_for "Event attributes" do %>
+  <%= scrivito_details_for 'My attribute' do %>
+    <%= scrivito_tag :div, obj, :my_attribute %>
+  <% end %>
+
+  <%= scrivito_details_for 'Person do %>
+    <%= scrivito_tag :div, obj, :person, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Person', 'Organizazion']}} %>
+  <% end %>
+
+  <%= scrivito_details_for 'Children' do %>
+    <%= scrivito_tag :div, obj, :children, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Person']}} %>
+  <% end %>
+
+  ... More attributes ...
+<% end %>
+```
+
+The filter definition like `data_scrivito_editors_filter_context={rich_snippet_filter: ['Person']}` can be used to show only the defined filters e.g. Person in this example.
+
+In your contentbrowser filters, add the new types by using:
+
+```js
+scrivito.content_browser.filters(filter) {
+  if(filter.rich_snippet_filter) {
+    rich_snippet_filter(filter.rich_snippet_filter, ['NewType','AnotherType'])
+  } else if (your filters) {
+    // ... add your filters here
+  } else {
+    '_obj_class': {
+      options: {
+        // ... add your type defs here
+        rich_snippets: {
+          title: 'Rich Snippets',
+          options: {
+            rich_snippet_filter(undefined, ['NewType','AnotherType'])
+          }
+        }
+      }
+    }
+  }
+}
+```

data/Rakefile

@@ -0,0 +1,35 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ScrivitoRichSnippetWidget'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/scrivito_rich_snippet_widget.js

@@ -0,0 +1,41 @@
+Array.prototype.unique = function() {
+    var a = this.concat();
+    for(var i=0; i<a.length; ++i) {
+        for(var j=i+1; j<a.length; ++j) {
+            if(a[i] === a[j])
+                a.splice(j--, 1);
+        }
+    }
+    return a;
+};
+
+function rich_snippet_filter(filter, app_types=[]) {
+  var types = ['Event', 'Offer', 'PostalAddress', 'Person', 'Organization', 'Product', 'Recipe', 'CreativeWork', 'JobPosting'].concat(app_types).unique();
+
+  if(filter == undefined) {
+    return rich_snippet_all_options(types);
+  }
+  else {
+    return {
+      '_obj_class': {
+        'field': '_obj_class',
+        'options': rich_snippet_all_options(filter == 'all' ? types : filter.concat(app_types).unique())
+      }
+    }
+  }
+}
+
+function rich_snippet_all_options(types) {
+  var h = {}
+  types.forEach(function(e) {
+    h[e] = {
+      'value': "RichSnippet::" + e,
+      'enable_create': true,
+      'title': e,
+      'preset': {
+        '_obj_class': "RichSnippet::" + e
+      }
+    }
+  });
+  return h;
+}

data/app/models/rich_snippet/creative_work.rb

@@ -0,0 +1,88 @@
+module RichSnippet
+  class CreativeWork < Thing
+    attribute :work_type, :enum, values: ['Book','Game','Movie','Photograph','Painting','Serie','WebPage','MusicComposition']
+    attribute :about, :string
+    attribute :author, :reference
+    attribute :contributor, :reference
+    attribute :copyright_holder, :reference
+    attribute :copyright_year, :integer
+    attribute :date_created, :date
+    attribute :date_published, :date
+    attribute :genre, :string
+    attribute :in_language, :string
+    attribute :is_accessible_for_free, :enum, values: ['Yes', 'No'], default: 'No'
+    attribute :is_based_on, :reference
+    attribute :is_family_friendly, :enum, values: ['Yes', 'No'], default: 'Yes'
+    attribute :license, :string
+    attribute :offers, :referencelist
+    attribute :position, :integer
+    attribute :publisher, :reference
+    attribute :thumbnail_url, :string
+    attribute :typical_age_range, :string
+
+    #Book
+    attribute :illustrator, :reference
+    attribute :isbn, :string
+    attribute :number_of_page, :integer
+
+    #Movie
+    attribute :actors, :referencelist
+    attribute :director, :reference
+    attribute :duration, :integer
+
+    #WebPage
+    attribute :breadcrumb, :string
+
+    #MusicComposition
+    attribute :composer, :reference
+    attribute :lyricist, :reference
+    attribute :lyrics, :string
+
+    def to_json(render_childs = false)
+      json = {
+        "@context": "http://schema.org",
+        "@type": "CreativeWork",
+        name: name,
+        description: description,
+        image: image ? image.binary_url : nil,
+        url: url,
+        about: about,
+        author: author ? author.to_json : nil,
+        contributor: contributor ? contributor.to_json : nil,
+        copyrightHolder: copyright_holder ? copyright_holder.to_json : nil,
+        copyrightYear: copyright_year,
+        dateCreated: date_created,
+        datePublished: date_published,
+        genre: genre,
+        inLanguage: in_language,
+        isAccessibleForFree: is_accessible_for_free == 'Yes',
+        isBasedOn: is_based_on ? is_based_on.to_json: nil,
+        isFamilyFriendly: is_family_friendly == 'Yes',
+        license: license,
+        offers: array_json(offers),
+        position: position,
+        publisher: publisher ? publisher.to_json : nil,
+        thumbnailUrl: thumbnail_url,
+        typicalAgeRange: typical_age_range,
+      }
+
+      if work_type == 'Book'
+        json[:illustrator] = illustrator ? illustrator.to_json : nil
+        json[:isbn] = isbn
+        json[:numberOfPage] = number_of_page
+      elsif work_type == 'Movie'
+        json[:actors] = array_json(actors)
+        json[:director] = director ? director.to_json : nil
+        json[:duration] = duration
+      elsif work_type == 'WebPage'
+        json[:breadcrumb] = Obj.repson_to?('page_breadcrumb') ? obj.page_breadcrumb : breadcrumb
+      elsif work_type == 'MusicComposition'
+        json[:composer] = composer ? composer.to_json : nil
+        json[:lyricist] = lyricist ? lyricist.to_json : nil
+        json[:lyrics] = lyrics
+      end
+
+      return json.delete_if { |k, v| !v.present? }
+    end
+  end
+end

data/app/models/rich_snippet/event.rb

@@ -0,0 +1,70 @@
+module RichSnippet
+  class Event < Thing
+    attribute :start_date, :date
+    attribute :end_date, :date
+    attribute :organizer, :reference
+    attribute :in_language, :string
+    attribute :offers, :referencelist, only: Offer
+    attribute :location, :reference
+    attribute :performers, :referencelist
+    attribute :sub_events, :referencelist
+    attribute :super_event, :reference
+    attribute :event_status, :enum, values: ['auto','cancelled','rescheduled'], default: 'auto'
+
+    def event_status_type
+      return 'moron' if end_date < start_date
+      if (event_status == 'auto') || (event_status == '')
+        if Time.now < start_date
+          'not started'
+        elsif Time.now > end_date
+          'completed'
+        else
+          'in process'
+        end
+      else
+        event_status
+      end
+    end
+
+    def warnings
+      warns = []
+      warns << 'End date is before start date!' if end_date < start_date
+      warns << 'Start date is mandatory' if start_date.blank?
+      warns << 'End date is recommendet' if end_date.blank?
+      warns << 'Location is mandatory' if location.nil?
+      warns << 'Event status is recommendet' if event_status.blank?
+      warns << 'Offers are recommendet' if offers.empty?
+      return warns
+    end
+
+    def to_json(render_childs = false)
+      json = {
+        "@context": "http://schema.org",
+        "@type": "Event",
+        name: name,
+        description: description,
+        image: image ? image.binary_url : nil,
+        startDate: start_date,
+        endDate: end_date,
+        organizer: organizer ? organizer.to_json : nil,
+        inLanguage: in_language,
+        offers: array_json(offers),
+        location: location ? location.to_json : nil,
+        performers: array_json(performers),
+        url: url,
+        EventStatus: {
+          "@context": "http://schema.org",
+          "@type": "EventStatusType",
+          description: event_status_type
+        }
+      }
+
+      if render_childs
+        json[:subEvents] = array_json(sub_events)
+        json[:superEvent] = super_event ? super_event.to_json : nil
+      end
+
+      return json.delete_if { |k, v| !v.present? }
+    end
+  end
+end

data/app/models/rich_snippet/job_posting.rb

@@ -0,0 +1,47 @@
+module RichSnippet
+  class JobPosting < Thing
+    attribute :base_salary, :integer
+    attribute :date_posted, :date
+    attribute :education_requirements, :string
+    attribute :employment_type, :enum, values: %w(full-time part-time contract temporary seasonal internship)
+    attribute :experience_requirements, :string
+    attribute :hiring_organization, :reference
+    attribute :job_benefits, :string
+    attribute :job_location, :reference
+    attribute :qualifications, :string
+    attribute :salary_currency, :string
+    attribute :skills, :string
+    attribute :job_title, :string
+    attribute :valid_through, :date
+    attribute :work_hours, :string
+
+    def to_json(render_childs = false)
+      {
+        "@context": "http://schema.org",
+        "@type": "JobPosting",
+        name: name,
+        description: description,
+        image: image ? image.binary_url : nil,
+        url: url,
+        baseSalary: base_salary,
+        datePosted: date_posted,
+        educationRequirements: education_requirements,
+        employmentType: employment_type,
+        experienceRequirements: experience_requirements,
+        hiringOrganization: hiring_organization ? hiring_organization.to_json : nil,
+        jobBenefits: job_benefits,
+        jobLocation: {
+          "@context": "http://schema.org",
+          "@type": "Place",
+          address: job_location ? job_location.to_json : nil,
+        },
+        qualifications: qualifications,
+        salaryCurrency: salary_currency,
+        skills: skills,
+        title: job_title,
+        validThrough: valid_through,
+        workHours: work_hours
+      }.delete_if { |k, v| !v.present? }
+    end
+  end
+end

data/app/models/rich_snippet/offer.rb

@@ -0,0 +1,41 @@
+module RichSnippet
+  class Offer < Thing
+    attribute :availability_starts, :date
+    attribute :availability_ends, :date
+    attribute :availability, :string
+    attribute :price, :string
+    attribute :price_currency, :string
+    attribute :item_condition, :enum, values: ['Damaged','New','Refurbished','Used']
+    attribute :inventory_level, :integer
+    attribute :seller, :reference
+
+    def to_json(render_childs = false)
+      {
+        "@context": "http://schema.org",
+        "@type": "Offer",
+        name: name,
+        image: image ? image.binary_url : '',
+        description: description,
+        url: url,
+        availability: {
+          '@context': "http://schema.org",
+          '@type': "ItemAvailability",
+          description: availability
+        },
+        inventoryLevel: inventory_level,
+        availabilityStarts: availability_starts,
+        availabilityEnds: availability_ends,
+        price: price,
+        priceCurrency: price_currency,
+        itemCondition: "https://schema.org/#{item_condition}Condition",
+        seller: seller ? seller.to_json : nil
+      }.delete_if { |k, v| !v.present? }
+    end
+
+    def warnings
+      warns = []
+      warns << "Price in the form xx.yy" if price.contains(',')
+      return warns
+    end
+  end
+end