scrivito_seo_page_extender 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ed2ecbfe3ee81169a8f1cdee0ff37630732abcc
+  data.tar.gz: 38e29d9d6c202cd896814e596345cf806099b68e
+SHA512:
+  metadata.gz: 3fe5c7ccd6e19be9b8ea1e160819c2f366ffeb2dafd80019a1d349e44620581f1153c72b111d2121ede50eb599b93c47aef9809bb8d9e3f6b8860235ea38df58
+  data.tar.gz: befb2f0a6964c1a0fd52ca662044d2f7c0a6abfeacd1c7b0201678c3d4bdde5a07d5908d8b596ecbcdef6d59c9b36c27be9935e7a7476209ad4a356ac06bed98

data/LICENSE

@@ -0,0 +1,4 @@
+Copyright (c) 2009 - 2014 Infopark AG (http://www.infopark.com)
+
+This software can be used and modified under the LGPL-3.0. Please refer to
+http://www.gnu.org/licenses/lgpl-3.0.html for the license text.

data/Rakefile

@@ -0,0 +1,24 @@
+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    = 'ScrivitoSeoPageExtender'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/scrivito_seo_page_extender/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/scrivito_seo_page_extender/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/concerns/meta_data_extender.rb

@@ -0,0 +1,15 @@
+module MetaDataExtender
+  def self.included(base)
+    base.attribute :meta_description, :string
+    base.attribute :meta_keywords, :string
+    base.attribute :meta_author, :string
+    base.attribute :meta_keywords, :string
+    base.attribute :meta_publisher, :string
+    base.attribute :meta_copyright, :string
+
+    base.attribute :meta_page_topic, :string
+    base.attribute :meta_page_type, :string
+    base.attribute :meta_audience, :string
+    base.attribute :meta_robots, :enum, values: ["index", "noindex", "nofollow", "all"]
+  end
+end

data/app/concerns/open_graph_extender.rb

@@ -0,0 +1,15 @@
+module OpenGraphExtender
+  def self.included(base)
+    base.attribute :og_author, :string
+    base.attribute :og_creator, :string
+    base.attribute :og_description, :string
+    base.attribute :og_director, :string
+    base.attribute :og_duration, :string
+    base.attribute :og_image, :reference
+    base.attribute :og_obj_type, :enum, values: ["website", "article", "profile", "video", "book", "other"]
+    base.attribute :og_release_date, :date
+    base.attribute :og_section, :string
+    base.attribute :og_title, :string
+    base.attribute :og_url, :string
+  end
+end

data/app/concerns/sitemap_extender.rb

@@ -0,0 +1,6 @@
+module SitemapExtender
+  def self.included(base)
+    base.attribute :sitemap_frequency, :enum, values: ["always", "hourly", "daily", "weekly", "monthly", "yearly", "never"]
+    base.attribute :sitemap_priority, :enum, values: ["0.1", "0.2", "0.3", "0.4", "0.5", "0.6", "0.7", "0.8", "0.9", "1.0"]
+  end
+end

data/app/helper/seo_page_extender_helper.rb

@@ -0,0 +1,41 @@
+module SeoPageExtenderHelper
+  def words_density(obj, attribute)
+    words = get_words_from_page(obj, attribute).map { |e| e.downcase.gsub(/[^a-z0-9\s]/i, '') }
+    without_stop_words = remove_stop_words(words)
+    return { 
+      count: without_stop_words.count,
+      density_for_one: density_with_one_word(without_stop_words),
+      density_for_two: density_with_n_word(2,without_stop_words),
+      density_for_three: density_with_n_word(3,without_stop_words)
+    }
+  end
+
+  private
+  def get_words_from_page(obj, attribute)
+    strip_tags(scrivito_tag(:span, obj, attribute).to_s).split(" ")
+  end
+
+  def calulate_count_of_all_words(words)
+    words.each_with_object(Hash.new(0)) {|word,counts| counts[word] += 1 }
+  end
+
+  def remove_stop_words(density)
+    density.select {|e| !stop_words_fallback.include? e}
+  end
+
+  def density_with_one_word(words)
+    calulate_count_of_all_words(words).sort_by {|word,count| count}.reverse
+  end
+
+  def density_with_n_word(n, words)
+    two_words = []
+    words[0..-(n+1)].each_with_index do |word, index|
+      two_words << words[index..index+n-1].join(" ")
+    end
+    return calulate_count_of_all_words(two_words).sort_by {|word,count| count}.reverse
+  end
+
+  def stop_words_fallback
+    "a,able,about,across,after,all,almost,also,am,among,an,and,any,are,as,at,be,because,been,but,by,can,cannot,could,dear,did,do,does,either,else,ever,every,for,from,get,got,had,has,have,he,her,hers,him,his,how,however,i,if,in,into,is,it,its,just,least,let,like,likely,may,me,might,most,must,my,neither,no,nor,not,of,off,often,on,only,or,other,our,own,rather,said,say,says,she,should,since,so,some,than,that,the,their,them,then,there,these,they,this,tis,to,too,twas,us,wants,was,we,were,what,when,where,which,while,who,whom,why,will,with,would,yet,you,your".split(",")
+  end
+end

data/app/views/seo_page_extender/_meta_attribute.html.erb

@@ -0,0 +1,7 @@
+<% if @obj.respond_to?(attribute) && !@obj.send(attribute).blank? %>
+  <% if name.include? 'image' %>
+    <meta content="<%= @obj.send(attribute).try(:binary_url) %>" name="<%= name %>"/>
+  <% else %>
+    <meta content="<%= @obj.send(attribute) %>" name="<%= name %>"/>
+  <% end %>
+<% end %>

data/app/views/seo_page_extender/_meta_data.html.erb

@@ -0,0 +1,7 @@
+<%= render "seo_page_extender/meta_attribute", attribute: "meta_keywords", name: "keywords" %>
+<%= render "seo_page_extender/meta_attribute", attribute: "meta_description", name: "description" %>
+<%= render "seo_page_extender/meta_attribute", attribute: "meta_robots", name: "robots" %>
+<%= render "seo_page_extender/meta_attribute", attribute: "meta_author", name: "author" %>
+
+<meta content="width=device-width, initial-scale=1.0" name="viewport"/>
+<meta content="<%= 'https://#{request.raw_host_with_port + scrivito_path(@obj)}' %>" name="canonical"/>

data/app/views/seo_page_extender/_meta_data_details.html.erb

@@ -0,0 +1,19 @@
+<%= scrivito_details_for 'Keywords' do %>
+  <%= scrivito_tag(:div, obj, :meta_keywords, data: {editor: 'scrivito-list-editor', delimiter: ','}) %>
+<% end %>
+
+<%= scrivito_details_for 'Description' do %>
+  <%= scrivito_tag(:textarea, obj, :meta_description, data: {editor: 'scrivito-textarea-editor'}, style: 'width: 100%; height: 150px' ) %>
+<% end %>
+
+<%= scrivito_details_for 'Author' do %>
+  <%= scrivito_tag(:div, obj, :meta_author) %>
+<% end %>
+
+<%= scrivito_details_for 'Indexing for search engines' do %>
+  <%= scrivito_toggle_button_editor(obj, :meta_robots) %>
+<% end %>
+
+<%= scrivito_details_for 'Permalink' do %>
+  <%= scrivito_tag(:div, obj, :_permalink, data: {autosave: "false"}) %>
+<% end %>

data/app/views/seo_page_extender/_open_graph.html.erb

@@ -0,0 +1,11 @@
+<%= render "seo_page_extender/meta_attribute", attribute: "og_title", name: "og:title" %>
+<%= render "seo_page_extender/meta_attribute", attribute: "og_image", name: "og:image" %>
+<%= render "seo_page_extender/meta_attribute", attribute: "og_url", name: "og:url" %>
+<%= render "seo_page_extender/meta_attribute", attribute: "og_description", name: "og:description" %>
+<%= render "seo_page_extender/meta_attribute", attribute: "og_creator", name: "og:creator" %>
+<%= render "seo_page_extender/meta_attribute", attribute: "og_obj_type", name: "og:type" %>
+<%= render "seo_page_extender/meta_attribute", attribute: "og_director", name: "og:dircetor" %>
+<%= render "seo_page_extender/meta_attribute", attribute: "og_duration", name: "og:duration" %>
+<%= render "seo_page_extender/meta_attribute", attribute: "og_release_date", name: "og:release_date" %>
+<%= render "seo_page_extender/meta_attribute", attribute: "og_author", name: "og:author" %>
+<%= render "seo_page_extender/meta_attribute", attribute: "og_section", name: "og:section" %>

data/app/views/seo_page_extender/_open_graph_details.html.erb

@@ -0,0 +1,43 @@
+<%= scrivito_details_for 'Title of page (Meta title as fallback)' do %>
+  <%= scrivito_tag(:div, obj, :og_title) %>
+<% end %>
+
+<%= scrivito_details_for 'Type' do %>
+  <%= scrivito_toggle_button_editor(obj, :og_obj_type) %>
+<% end %>
+
+<%= scrivito_details_for 'Image' do %>
+  <%= scrivito_tag(:div, obj, :og_image) %>
+<% end %>
+
+<%= scrivito_details_for 'Url' do %>
+  <%= scrivito_tag(:div, obj, :og_url) %>
+<% end %>
+
+<%= scrivito_details_for 'Description' do %>
+  <%= scrivito_tag(:div, obj, :og_description) %>
+<% end %>
+
+<%= scrivito_details_for 'Creator' do %>
+  <%= scrivito_tag(:div, obj, :og_creator) %>
+<% end %>
+
+<%= scrivito_details_for 'Director (For video)' do %>
+  <%= scrivito_tag(:div, obj, :og_director) %>
+<% end %>
+
+<%= scrivito_details_for 'Duration (For video)' do %>
+  <%= scrivito_tag(:div, obj, :og_duration) %>
+<% end %>
+
+<%= scrivito_details_for 'Release Date' do %>
+  <%= scrivito_tag(:div, obj, :og_release_date) %>
+<% end %>
+
+<%= scrivito_details_for 'Author (For book)' do %>
+  <%= scrivito_tag(:div, obj, :og_author) %>
+<% end %>
+
+<%= scrivito_details_for 'Section' do %>
+  <%= scrivito_tag(:div, obj, :og_section) %>
+<% end %>

data/app/views/seo_page_extender/_sitemap_details.html.erb

@@ -0,0 +1,7 @@
+<%= scrivito_details_for 'Priority for Sitemap' do %>
+  <%= scrivito_toggle_button_editor(obj, :sitemap_priority) %>
+<% end %>
+
+<%= scrivito_details_for 'Frequency of visits for bots' do %>
+  <%= scrivito_toggle_button_editor(obj, :sitemap_frequency) %>
+<% end %>

data/app/views/seo_page_extender/_word_density.html.erb

@@ -0,0 +1,26 @@
+<% words = words_density(obj, attribute) %>
+<h4>
+  <%= words[:count] %>good words on this page (words not in stop word list)
+</h4>
+<ul class='tab-list'>
+  <li class='active' data-panel-target='#one-word'>
+    Single Words
+  </li>
+  <li data-panel-target='#two-words'>
+    Two word phrases
+  </li>
+  <li data-panel-target='#three-words'>
+    Three word phrases
+  </li>
+</ul>
+<div class='tab-panels'>
+  <div class='tab-panel active' id='one-word'>
+    <%= render 'seo_page_extender/word_density_part', list: words[:density_for_one][0..20], words: words %>
+  </div>
+  <div class='tab-panel' id='two-words'>
+    <%= render 'seo_page_extender/word_density_part', list: words[:density_for_two][0..20], words: words %>
+  </div>
+  <div class='tab-panel' id='three-words'>
+    <%= render 'seo_page_extender/word_density_part', list: words[:density_for_three][0..20], words: words %>
+  </div>
+</div>

data/app/views/seo_page_extender/_word_density_part.html.erb

@@ -0,0 +1,22 @@
+<table class="table table-bordered table-striped">
+  <thead>
+    <tr>
+      <th>Word</th>
+      <th>Count</th>
+      <th>Density</th>
+    </tr>
+  </thead>
+  <% list.each do |word, count| %>
+    <tr>
+      <td>
+        <%= word %>
+      </td>
+      <td>
+        <%= count %>
+      </td>
+      <td>
+        <%= (words[:count] > 0 ? count.to_f * 100 / words[:count].to_f : 0).round(2) %>
+      </td>
+    </tr>
+  <% end %>
+</table>

data/lib/scrivito_seo_page_extender.rb

@@ -0,0 +1,4 @@
+require "scrivito_seo_page_extender/engine"
+
+module ScrivitoSeoPageExtender
+end

data/lib/scrivito_seo_page_extender/engine.rb

@@ -0,0 +1,11 @@
+require 'scrivito_advanced_editors'
+
+module ScrivitoSeoPageExtender
+  class Engine < ::Rails::Engine
+    isolate_namespace ScrivitoSeoPageExtender
+
+    initializer "seo_page_extender:seo_page_extender_helper" do
+      ActionView::Base.send :include, SeoPageExtenderHelper
+    end
+  end
+end

data/lib/scrivito_seo_page_extender/version.rb

@@ -0,0 +1,3 @@
+module ScrivitoSeoPageExtender
+  VERSION = "0.0.1"
+end

data/lib/tasks/scrivito_seo_page_extender_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :scrivito_seo_page_extender do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: scrivito_seo_page_extender
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Scrivito
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: scrivito_sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: scrivito_advanced_editors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Scrivito Widget to extend your Page with some useful SEO Features,
+  Metadata or Open Graph.
+email:
+- support@scrivito.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- Rakefile
+- app/assets/javascripts/scrivito_seo_page_extender/application.js
+- app/assets/stylesheets/scrivito_seo_page_extender/application.css
+- app/concerns/meta_data_extender.rb
+- app/concerns/open_graph_extender.rb
+- app/concerns/sitemap_extender.rb
+- app/helper/seo_page_extender_helper.rb
+- app/views/seo_page_extender/_meta_attribute.html.erb
+- app/views/seo_page_extender/_meta_data.html.erb
+- app/views/seo_page_extender/_meta_data_details.html.erb
+- app/views/seo_page_extender/_open_graph.html.erb
+- app/views/seo_page_extender/_open_graph_details.html.erb
+- app/views/seo_page_extender/_sitemap_details.html.erb
+- app/views/seo_page_extender/_word_density.html.erb
+- app/views/seo_page_extender/_word_density_part.html.erb
+- lib/scrivito_seo_page_extender.rb
+- lib/scrivito_seo_page_extender/engine.rb
+- lib/scrivito_seo_page_extender/version.rb
+- lib/tasks/scrivito_seo_page_extender_tasks.rake
+homepage: https://www.scrivito.com
+licenses:
+- LGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Scrivito Widget to extend your Page with some useful SEO Features, Metadata
+  or Open Graph.
+test_files: []