hancock_cms_seo 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47fa9a50126db8a16d614a5fb6e72a3d68e98969
+  data.tar.gz: af8810345cbfa83152832e19901c021879e93371
+SHA512:
+  metadata.gz: b6c127efdf5eefb6bf31a66b29ccc8c0dd2b8499d0a03e872ced719d3f7f318aa5816a0bfe4a5baffaecf22c497d02a731830410fbbbb83d9991090e87c41125
+  data.tar.gz: 3ccd0bd7b5d4533f31a940996daf7a3a43dafff892ba4df36862fc242780bb9d9e24061bc5eea875c2890334d34332fcd5d894a4d99df6407d6e0a265c50aa82

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+hancock_seo

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hancock_cms_seo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alexander Kiseliev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# HancockCmsSeo
+
+### Remaded from [EnjoyCMSSeo](https://github.com/enjoycreative/enjoy_cms_seo)
+
+SEO and sitemap fields for [HancockCMS](https://github.com/red-rocks/hancock_cms).
+Add Seo support to HancockCMS plugins by default and other objects in two lines.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hancock_cms_seo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hancock_cms_seo
+
+## Usage
+
+### Mongoid
+
+Add this in your model for attributes
+```ruby
+include Hancock::Seo::Seoable
+include Hancock::Seo::SitemapDataField
+```
+
+and this for rails_admin config
+```ruby
+group :seo do
+  active false
+  field :seo
+end
+group :sitemap_data do
+  active false
+  field :sitemap_data
+end
+```
+
+Also you can generate and then edit config/initializers/hancock_seo.rb
+
+    $ rails g hancock:seo:config
+
+SEO fields (h1, title, keywords, description, og_title, og_image, robots) and sitemap_data fields(sitemap_show, sitemap_lastmod, sitemap_changefreq, sitemap_priority) are delegated to your model.
+
+#### Sitemap
+
+Also you can use [SitemapGenerator](https://github.com/kjvarga/sitemap_generator) for sitemap.
+
+#### Google Analitics and Yandex Metrika
+
+We have helper methods for this. Usage
+```ruby
+hancock_ym_counter_tag('counter_id')
+```
+or
+```ruby
+hancock_ga_counter_tag('counter_id')
+```
+or
+```ruby
+render_hancock_counters(ym_counter_id: 'counter_id1', ga_counter_id: 'counter_id2')
+```
+[More](https://github.com/red-rocks/hancock_cms_seo/blob/master/app/helpers/hancock/seo/seo_helper.rb)
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/red-rocks/hancock_cms_seo.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/assets/javascripts/hancock/rails_admin/plugins/seo.coffee

@@ -0,0 +1,4 @@
+#= require_self
+#= require "hancock/rails_admin/plugins/seo/custom/ui"
+
+window.hancock.plugins.seo ||= {}

data/app/assets/stylesheets/hancock/rails_admin/plugins/seo.sass

@@ -0,0 +1,3 @@
+@import "hancock/rails_admin/plugins/seo/footer_nav_links"
+
+@import "hancock/rails_admin/plugins/seo/custom/theming"

data/app/assets/stylesheets/hancock/rails_admin/plugins/seo/footer_nav_links.sass

@@ -0,0 +1,16 @@
+.footer-nav-link.sitemap, .footer-nav-link.robots_txt
+  a
+    font-size: 0
+    &:before
+      display: inline-block
+      font-family: FontAwesome
+      font-size: 18px
+      text-rendering: auto
+      -webkit-font-smoothing: antialiased
+      -moz-osx-font-smoothing: grayscale
+      content: "\f0e8"
+      box-sizing: border-box
+
+.footer-nav-link.robots_txt a:before
+  content: "\f0f6"
+  font-size: 18px

data/app/controllers/concerns/hancock/seo/x_frame_options.rb

@@ -0,0 +1,42 @@
+module Hancock::Seo::XFrameOptions
+  extend ActiveSupport::Concern
+
+  included do
+    def clear_x_frame_options
+      begin
+        if x_frame_options_referer_regexp and request.referer =~ x_frame_options_referer_regexp
+          response.headers.delete('X-Frame-Options')
+        else
+          if defined?(Addressable)
+            _domain = Addressable::URI.parse(request.referer).domain
+          else
+            _domain = URI.parse(request.referer).host
+          end
+
+          if base_site_host.is_a?(Regexp)
+            response.headers.delete('X-Frame-Options') if _domain =~ base_site_host
+          else
+            response.headers.delete('X-Frame-Options') if _domain == base_site_host
+          end
+        end
+      rescue
+      end
+    end
+  end
+
+  class_methods do
+    def clear_x_frame_options
+      after_action :clear_x_frame_options
+    end
+  end
+
+  protected
+  def x_frame_options_referer_regexp
+    # /^https?:\/\/([^\/]+metrika.*yandex.(ru|ua|com|com.tr|by|kz)|([^\/]+.)?webvisor.com)\//
+    /^https?\:\/\/([^\/]*metrika.*yandex\.(ru|ua|com|com\.tr|by|kz)|([^\/]+\.)?webvisor\.com)\//i
+  end
+  def base_site_host
+    request.domain
+  end
+
+end

data/app/helpers/hancock/seo/seo_helper.rb

@@ -0,0 +1,60 @@
+module Hancock::Seo::SeoHelper
+
+  def hancock_ym_counter_tag(counter_id)
+    return nil if counter_id.blank?
+    render partial: "hancock/seo/blocks/ym", locals: {counter_id: counter_id}
+  end
+  def hancock_ga_counter_tag(counter_id)
+    return nil if counter_id.blank?
+    render partial: "hancock/seo/blocks/ga", locals: {counter_id: counter_id}
+  end
+  def render_hancock_counters(opts = {})
+    ret = []
+
+    _cache_key = "ym_counter".freeze
+    ym_counter = Rails.cache.fetch(_cache_key) do
+      if Hancock::Seo.config.cache_support
+        Hancock::Cache::Fragment.create_unless_exists(name: _cache_key, parents: hancock_cache_views_keys)
+        _cache_key = [_cache_key]
+        _cache_key += hancock_cache_views_keys
+      else
+        _cache_key = [_cache_key]
+      end
+      _add_cache_key = opts.delete(:cache_key)
+      _cache_key = [_cache_key, _add_cache_key].flatten if _add_cache_key
+
+      _html = Settings.ym_counter_html(default: '', kind: :code, label: 'Yandex Метрика HTML-код'.freeze, cache_keys: _cache_key).strip
+      unless _html.blank?
+        _html
+      else
+        ym_counter_id = opts[:ym_counter_id] || Settings.ym_counter_id(default: '', kind: :string, label: 'Yandex Метрика ID'.freeze, cache_keys: _cache_key).strip
+        ym_counter_id.blank? ? nil : hancock_ym_counter_tag(ym_counter_id)
+      end
+    end
+    ret << ym_counter unless ym_counter.blank?
+
+    _cache_key = "ga_counter".freeze
+    ga_counter = Rails.cache.fetch(_cache_key) do
+      if Hancock::Seo.config.cache_support
+        Hancock::Cache::Fragment.create_unless_exists(name: _cache_key, parents: hancock_cache_views_keys)
+        _cache_key = [_cache_key]
+        _cache_key += hancock_cache_views_keys
+      else
+        _cache_key = [_cache_key]
+      end
+      _add_cache_key = opts.delete(:cache_key)
+      _cache_key = [_cache_key, _add_cache_key].flatten if _add_cache_key
+
+      _html = Settings.ga_counter_html(default: '', kind: :code, label: 'Google Analitics HTML-код'.freeze, cache_keys: _cache_key).strip
+      unless _html.blank?
+        _html
+      else
+        ga_counter_id = opts[:ga_counter_id] || Settings.ga_counter_id(default: '', kind: :string, label: 'Google Analitics ID'.freeze, cache_keys: _cache_key).strip
+        ga_counter_id.blank? ? nil : hancock_ga_counter_tag(ga_counter_id)
+      end
+    end
+    ret << ga_counter unless ga_counter.blank?
+
+    ret.join.html_safe
+  end
+end

data/app/models/concerns/hancock/seo/decorators/seo.rb

@@ -0,0 +1,60 @@
+module Hancock::Seo::Decorators
+  module Seo
+    extend ActiveSupport::Concern
+
+    included do
+      # # after_save :og_image_auto_rails_admin_jcrop
+      # def og_image_auto_rails_admin_jcrop
+      #   auto_rails_admin_jcrop(:og_image) # or nil for cancel autocrop
+      # end
+
+      # hancock_cms_attached_file(:og_image)
+      # def og_image_styles
+      #   {thumb: "800x600>"}
+      # end
+      #
+      # def og_image_jcrop_options
+      #   {}
+      # end
+      #
+      #
+      # def set_default_seo
+      #   _obj = self.seoable
+      #   if _obj and _obj.set_default_seo?
+      #     self.h1           = _obj.default_seo_h1           if self.h1.blank?
+      #     self.title        = _obj.default_seo_title        if self.title.blank?
+      #     self.keywords     = _obj.default_seo_keywords     if self.keywords.blank?
+      #     self.description  = _obj.default_seo_description  if self.description.blank?
+      #     self.title        = _obj.default_seo_og_title     if self.title.blank?
+      #   end
+      # end
+      #
+      # ############ rails_admin ##############
+      # def self.rails_admin_add_fields
+      #   [] #super
+      # end
+      #
+      # def self.rails_admin_add_config(config)
+      #   #super(config)
+      # end
+      #
+      # def self.admin_can_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.admin_cannot_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.manager_can_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.manager_cannot_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.rails_admin_user_defined_visible_actions
+      #   [].freeze
+      # end
+
+    end
+
+  end
+end

data/app/models/concerns/hancock/seo/decorators/sitemap_data.rb

@@ -0,0 +1,35 @@
+module Hancock::Seo::Decorators
+  module SitemapData
+    extend ActiveSupport::Concern
+
+    included do
+
+      ############# rails_admin ##############
+      # def self.rails_admin_add_fields
+      #   [] #super
+      # end
+      #
+      # def self.rails_admin_add_config(config)
+      #   #super(config)
+      # end
+      #
+      # def self.admin_can_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.admin_cannot_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.manager_can_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.manager_cannot_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.rails_admin_user_defined_visible_actions
+      #   [].freeze
+      # end
+
+    end
+
+  end
+end

data/app/models/concerns/hancock/seo/seoable.rb

@@ -0,0 +1,71 @@
+module Hancock::Seo::Seoable
+  extend ActiveSupport::Concern
+  LOCALIZED_FIELDS = [:h1, :title, :keywords, :description, :og_title, :author]
+  FIELDS = LOCALIZED_FIELDS + [:og_image, :robots]
+
+  included do
+    has_one :seo, as: :seoable, autosave: true, class_name: "Hancock::Seo::Seo"
+    accepts_nested_attributes_for :seo
+
+    delegate(*FIELDS, to: :seo)
+    delegate(*(FIELDS.map {|f| "#{f}=".to_sym }), to: :seo)
+
+    if Hancock::Seo.config.localize
+      delegate(*(LOCALIZED_FIELDS.map {|f| "#{f}_translations".to_sym }), to: :seo)
+      delegate(*(LOCALIZED_FIELDS.map {|f| "#{f}_translations=".to_sym }), to: :seo)
+    end
+
+    alias seo_without_build seo
+    def seo
+      seo_without_build || build_seo
+    end
+
+
+    def default_seo_h1
+      if self.respond_to?(:name)
+        self.name
+      elsif self.respond_to?(:title)
+        self.title
+      end
+    end
+    def default_seo_title
+      if self.respond_to?(:name)
+        self.name
+      elsif self.respond_to?(:title)
+        self.title
+      end
+    end
+    def default_seo_keywords
+      ""
+    end
+    def default_seo_description
+      ""
+    end
+    def default_seo_og_title
+      if self.respond_to?(:name)
+        self.name
+      elsif self.respond_to?(:title)
+        self.title
+      end
+    end
+
+    def set_default_seo?
+      true
+    end
+  end
+
+  def page_title
+    return self.title unless self.title.blank?
+    self.name if self.respond_to?(:name)
+  end
+
+  def get_og_title
+    return self.og_title unless self.og_title.blank?
+    self.name if self.respond_to?(:name)
+  end
+
+  def og_image_jcrop_options
+    {aspectRation: 800.0/600.0}
+  end
+
+end