scrivito_rich_snippet_widget 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62a1bba5d0e9907415483dbcdc60a46153d9b3df
-  data.tar.gz: 39eb4a135c7ffe44829fec1f97435805a8c10cd2
+  metadata.gz: dba9f674fd4415f7e8ac8b397a1d4b06ced4d342
+  data.tar.gz: 37f6c7c82e7155d0ef3fa6a47f60c28c6d97e742
 SHA512:
-  metadata.gz: 24d1a8d5afe83af9fc74bdea3199fc3b2db2cbe81d5c9732f9e3e8726332b9a13bb7e2b2b2016acf6813a00b1651bd462f041afee2f8355a7149625899891d83
-  data.tar.gz: 1acfa7e12cd849d426b5dcb9f532d195b1dcc489185f4c5025587f885810a1fc559e7c7ea729e059636975f5d91f660767c4d84dcf87fec1e66c62be0a2b9c98
+  metadata.gz: cded57475b87265260c77e627a61c4712fc23fb6ba4fbf8978ee4817c0c2041e80de0b02fb3a717ee0556d4318460df83a6dd983f65de72b3435164c3aa4e90d
+  data.tar.gz: c993a9fab68c337f07342ac234a63c5606c2fccc847b9dff7bdb3a1d19d7a3ba925a6a9e112ba9d182326c492f9ef05916ace2b533ebb594b154091bfd4877d5

data/README.md

@@ -1,5 +1,5 @@
 # ScrivitoRichSnippetWidget
-Add structured data to you page. Definitions are from https://schema.org
+Add structured data to you page. Definitions can be found at https://schema.org
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -13,28 +13,31 @@ And then execute:
 $ 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
 ```
 
+Add this to your filters:
+
 ```js
 scrivito.content_browser.filters(filter) {
   if(filter.rich_snippet_filter) {
-    rich_snippet_filter(filter.rich_snippet_filter)
+    _obj_class: {
+      field: '_obj_class'
+      options: { rich_snippet_filter(filter.rich_snippet_filter) }
+    }
   } else if (your filters) {
-    // ... add your filters here
+    // ... add your special filters here
   } else {
     '_obj_class': {
       options: {
-        // ... add your type defs here
+        // ... add your standard filters here
         rich_snippets: {
           title: 'Rich Snippets',
           options: {
-            rich_snippet_filter()
+            rich_snippet_filter('all')
           }
         }
       }
@@ -45,21 +48,27 @@ scrivito.content_browser.filters(filter) {
 
 ## Add your own types
 
-Create a modle at `/model/rich_snippet/new_type.rb` and add your attribute in this scheme:
+Create a modle at `/model/rich_snippet/new_type.rb` and add the attributes for this type:
 
 ```ruby
-module RichSnippets
+module RichSnippet
   class NewType < RichSnippet::Thing
     attribute my_attribute, :string
     attribute person, :refernce
     attribute children, :referencelist
     # ... more attributes
 
-    def to_json
+    def to_json(render_childs=false)
       {
+        "@context": "http://schema.org",
+        "@type": "NewType",
+        name: name,
+        description: description,
+        image: image ? image.binary_url : '',
+        url: url
         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
+        person: person ? person.to_json : nil, # render the json for another rich snippet by calling its to_json method
+        children: array_json(children), # render an array of other rich snippets with this helper method
         # ... definition for more attributes
       }
     end
@@ -74,15 +83,17 @@ module RichSnippets
 end
 ```
 
-The create the details view. You need to files:
+The `render_childs` attribute in the `to_json` method can be used to prevent circles in the snippet definitions.
+
+Then create the details view. You need two files:
 
 ```ruby
-# add rich_snippet/new_type/details.html.erb
+# rich_snippet/new_type/details.html.erb
 <%= render 'rich_snippet/new_type/details', obj: @obj %>
 ```
 
 ```ruby
-# add rich_snippet/new_type/_details.html.erb
+# rich_snippet/new_type/_details.html.erb
 <%= render 'rich_snippet/thing/details', obj: obj, url_is_mandatory: false %>
 
 <%= scrivito_details_for "Event attributes" do %>
@@ -109,7 +120,7 @@ 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'])
+    rich_snippet_filter(filter.rich_snippet_filter, ['NewType'])
   } else if (your filters) {
     // ... add your filters here
   } else {
@@ -119,7 +130,7 @@ scrivito.content_browser.filters(filter) {
         rich_snippets: {
           title: 'Rich Snippets',
           options: {
-            rich_snippet_filter(undefined, ['NewType','AnotherType'])
+            rich_snippet_filter(undefined, ['NewType'])
           }
         }
       }

data/app/assets/javascripts/scrivito_rich_snippet_widget.js

@@ -12,17 +12,7 @@ Array.prototype.unique = function() {
 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())
-      }
-    }
-  }
+  return rich_snippet_all_options(filter == 'all' ? types : filter);
 }
 
 function rich_snippet_all_options(types) {

data/app/models/rich_snippet/creative_work.rb

@@ -1,6 +1,6 @@
 module RichSnippet
   class CreativeWork < Thing
-    attribute :work_type, :enum, values: ['Book','Game','Movie','Photograph','Painting','Serie','WebPage','MusicComposition']
+    attribute :work_type, :enum, values: ['Book','Game','Movie','Photograph','Painting','Serie','WebPage','MusicComposition','SoftwareSourceCode']
     attribute :about, :string
     attribute :author, :reference
     attribute :contributor, :reference
@@ -19,6 +19,9 @@ module RichSnippet
     attribute :publisher, :reference
     attribute :thumbnail_url, :string
     attribute :typical_age_range, :string
+    attribute :code_repository, :string
+    attribute :programming_language, :string
+    attribute :runtime_platform, :string
 
     #Book
     attribute :illustrator, :reference
@@ -41,7 +44,7 @@ module RichSnippet
     def to_json(render_childs = false)
       json = {
         "@context": "http://schema.org",
-        "@type": "CreativeWork",
+        "@type": work_type.presence || "CreativeWork",
         name: name,
         description: description,
         image: image ? image.binary_url : nil,
@@ -63,7 +66,7 @@ module RichSnippet
         position: position,
         publisher: publisher ? publisher.to_json : nil,
         thumbnailUrl: thumbnail_url,
-        typicalAgeRange: typical_age_range,
+        typicalAgeRange: typical_age_range
       }
 
       if work_type == 'Book'
@@ -80,6 +83,10 @@ module RichSnippet
         json[:composer] = composer ? composer.to_json : nil
         json[:lyricist] = lyricist ? lyricist.to_json : nil
         json[:lyrics] = lyrics
+      elsif work_type == 'SoftwareSourceCode'
+        json[:codeRepository]= code_repository
+        json[:programmingLanguage]= programming_language
+        json[:runtimePlatform]= runtime_platform
       end
 
       return json.delete_if { |k, v| !v.present? }

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

@@ -1,116 +1,116 @@
 <%= render 'rich_snippet/thing/details', obj: obj, url_is_mandatory: false %>
 
-<%= scrivito_details_for "Event attributes" do %>
+<%= scrivito_details_for "Creative work 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_details_for 'About' do %>
     <%= scrivito_tag :div, obj, :about %>
   <% end %>
 
-  <%= scrivito_details_for 'author' do %>
+  <%= 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_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_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_details_for 'Copyright year' do %>
     <%= scrivito_tag :div, obj, :copyright_year %>
   <% end %>
 
-  <%= scrivito_details_for 'date_created' do %>
+  <%= scrivito_details_for 'Date created' do %>
     <%= scrivito_tag :div, obj, :date_created %>
   <% end %>
 
-  <%= scrivito_details_for 'date_published' do %>
+  <%= scrivito_details_for 'Date published' do %>
     <%= scrivito_tag :div, obj, :date_published %>
   <% end %>
 
-  <%= scrivito_details_for 'genre' do %>
+  <%= scrivito_details_for 'Genre' do %>
     <%= scrivito_tag :div, obj, :genre %>
   <% end %>
 
-  <%= scrivito_details_for 'in_language' do %>
+  <%= scrivito_details_for 'In language' do %>
     <%= scrivito_tag :div, obj, :in_language %>
   <% end %>
 
-  <%= scrivito_details_for 'is_accessible_for_free' do %>
+  <%= 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_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_details_for 'Is family friendly' do %>
     <%= scrivito_tag :div, obj, :is_family_friendly %>
   <% end %>
 
-  <%= scrivito_details_for 'license' do %>
+  <%= scrivito_details_for 'License' do %>
     <%= scrivito_tag :div, obj, :license %>
   <% end %>
 
-  <%= scrivito_details_for 'offers' do %>
+  <%= 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_details_for 'Position' do %>
     <%= scrivito_tag :div, obj, :position %>
   <% end %>
 
-  <%= scrivito_details_for 'publisher' do %>
+  <%= 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_details_for 'Thumbnail url' do %>
     <%= scrivito_tag :div, obj, :thumbnail_url %>
   <% end %>
 
-  <%= scrivito_details_for 'typical_age_range' do %>
+  <%= 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_details_for "Book 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_details_for 'Isbn' do %>
         <%= scrivito_tag :div, obj, :isbn %>
       <% end %>
 
-      <%= scrivito_details_for 'number_of_page' do %>
+      <%= scrivito_details_for 'Number of pages' 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_details_for "Movie 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_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_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 "Web page attributes" do %>
       <%= scrivito_details_for 'breadcrumb' do %>
         <%= scrivito_tag :div, obj, :breadcrumb %>
       <% end %>
@@ -118,19 +118,35 @@
   <% end %>
 
   <% if obj.work_type == 'MusicComposition' %>
-    <%= scrivito_details_for "Event attributes" do %>
-      <%= scrivito_details_for 'composer' do %>
+    <%= scrivito_details_for "Musci composition 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_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_details_for 'Lyrics' do %>
         <%= scrivito_tag :div, obj, :lyrics %>
       <% end %>
     <% end %>
   <% end %>
 
+  <% if obj.work_type == 'SoftwareSourceCode' %>
+    <%= scrivito_details_for "Software source code attributes" do %>
+      <%= scrivito_details_for 'Programming language' do %>
+        <%= scrivito_tag :div, obj, :programming_language %>
+      <% end %>
+
+      <%= scrivito_details_for 'Code repository' do %>
+        <%= scrivito_tag :div, obj, :code_repository %>
+      <% end %>
+
+      <%= scrivito_details_for 'Runtime platform' do %>
+        <%= scrivito_tag :div, obj, :runtime_platform %>
+      <% end %>
+    <% end %>
+  <% end %>
+
 <% end %>

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

@@ -26,10 +26,10 @@
   <% end %>
 
   <%= scrivito_details_for 'Inventory level' do %>
-    <%= scrivito_tag :div, obj, :inventory_level, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Organization']}} %>
+    <%= scrivito_tag :div, obj, :inventory_level %>
   <% end %>
 
   <%= scrivito_details_for 'Seller' do %>
-    <%= scrivito_tag :div, obj, :seller, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Organization']}} %>
+    <%= scrivito_tag :div, obj, :seller, data: {scrivito_editors_filter_context: {rich_snippet_filter: ['Person', 'Organization']}} %>
   <% end %>
 <% end %>

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

@@ -8,7 +8,7 @@
   <% end %>
 
   <%= scrivito_details_for 'Image' do %>
-    <%= scrivito_tag :div, obj, :image, data: {scrivito_editors_filter_context: {image: true}} %>
+    <%= scrivito_tag :div, obj, :image, data: {scrivito_editors_filter_context: {_image: true}} %>
   <% end %>
 
   <%= scrivito_details_for "Url #{url_is_mandatory ? '*' : ''}" do %>

data/lib/scrivito_rich_snippet_widget/version.rb

@@ -1,3 +1,3 @@
 module ScrivitoRichSnippetWidget
-  VERSION = '0.1.1'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrivito_rich_snippet_widget
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Gert Geidel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scrivito