seorel 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Andrea Dal Ponte
+
+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,139 @@
+# Seorel
+
+Ruby on Rails SEO Metatags plugins for ActiveRecord models
+
+## Rails Setup
+
+
+`Gemfile.rb`:
+
+```ruby
+gem 'seorel', github: 'dalpo/seorel'
+```
+
+`Console`:
+```bash
+% bundle install
+% bundle exec rake seorel:install:migrations
+% bundle exec rake db:migrate
+```
+
+## Default configuration options
+
+```bash
+% rails generate seorel:config
+```
+
+Will generate the `seorel_config.rb` initializer to customize the default values:
+
+```ruby
+Seorel.configure do |config|
+  # config.default_title = nil
+  # config.default_description = nil
+  # config.default_image = nil
+  # config.prepend_title = nil
+  # config.append_title  = nil
+end
+```
+
+
+## Usage
+
+### Extending model
+
+For instance generate a post model:
+```ruby
+rails generate model post title:string description:text, publish_date:date
+```
+
+Edit `app/models/post.rb`:
+```ruby
+class Post < ActiveRecord::Base
+
+  extend Seorelify
+  seorelify title: :customized_title, description: :description
+
+  def customized_title
+    "THE BLOG: #{self.title}"
+  end
+
+end
+```
+
+This will use the `customized_title` and the `description` methods as references to generate automatically the related metatags.
+Note that the title and description will be sanitized from HTML and truncated to 255 characters.
+
+
+### Controllers
+In your controllers you may add\_metatags either like a before\_filter or within a method.
+
+```ruby
+class PostsController < ApplicationController
+
+  def index
+    ###
+    # Custom meta tags
+    add_metatags({
+      title: 'My custom meta title',
+      description: 'My custom meta description'
+    })
+
+    ...
+  end
+
+  def show
+    @post = Post.find(params[:id])
+    ###
+    # Extract meta tags info from your Seorelified Model
+    add_metatags(@post)
+
+    ...
+  end
+
+end
+```
+
+### Views
+
+In your layout &lt;head&gt;&lt;/head&gt; section just call the `render_meta_tags` helper:
+
+```ruby
+<%=render_meta_tags %>
+```
+
+
+## Contributing
+Submitting a Pull Request:
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Implement your feature or bug fix.
+4. Add, commit, and push your changes.
+5. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/
+
+## This project rocks and uses MIT-LICENSE.
+
+Copyright 2013 Andrea Dal Ponte
+
+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/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Seorel'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_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/models/seorel/seorel.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+module Seorel
+  class Seorel < ActiveRecord::Base
+
+    belongs_to :seorelable, polymorphic: true
+
+    mount_uploader :image, Seorel::ImageUploader
+
+    before_save do
+      self.title = ::ActionController::Base.helpers.strip_tags(self.title).first(255) if self.title?
+      self.description = ::ActionController::Base.helpers.strip_tags(self.description).first(255) if self.description?
+    end
+
+    def title?
+      self.title.present?
+    end
+
+    def description?
+      self.description.present?
+    end
+
+    def admin_label
+      I18n.t("seorel.admin.label")
+    end
+
+  end
+end

data/app/uploaders/seorel/image_uploader.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+module Seorel
+  class ImageUploader < CarrierWave::Uploader::Base
+
+    # Include RMagick or MiniMagick support:
+    # include CarrierWave::RMagick
+    # include CarrierWave::Processing::RMagick
+    include CarrierWave::MiniMagick
+
+    # Include the Sprockets helpers for Rails 3.1+ asset pipeline compatibility:
+    include Sprockets::Helpers::RailsHelper
+    include Sprockets::Helpers::IsolatedHelper
+
+    # Choose what kind of storage to use for this uploader:
+    storage :file
+    # storage :fog
+
+    # Override the directory where uploaded files will be stored.
+    # This is a sensible default for uploaders that are meant to be mounted:
+    def store_dir
+      File.join('system', model.class.to_s.underscore.to_s, mounted_as.to_s, model.id.to_s)
+    end
+
+    # Provide a default URL as a default if there hasn't been a file uploaded:
+    def default_url
+      # For Rails 3.1+ asset pipeline compatibility:
+      asset_path('seorel/default.jpg')
+    end
+
+    process convert: 'jpeg'
+
+    version :thumbnail do
+      process resize_to_fill: [150, 150]
+    end
+
+    version :default do
+      process resize_and_pad: [300, 300, '#ffffff']
+    end
+
+    # Add a white list of extensions which are allowed to be uploaded.
+    # For images you might use something like this:
+    def extension_white_list
+      %w(jpg jpeg gif png bmp tif tiff)
+    end
+
+    # Override the filename of the uploaded files:
+    # Avoid using model.id or version_name here, see uploader/store.rb for details.
+    # def filename
+    #   "something.jpg" if original_filename
+    # end
+
+  end
+end

data/config/locales/en.seorel.yml

@@ -0,0 +1,16 @@
+en:
+  activerecord:
+    model:
+      seorel: SEO
+
+    attributes:
+      seorel:
+        title: Meta title
+        desciption: Meta description
+
+  attributes:
+    seorel: SEO
+
+  seorel:
+    admin:
+      label: "Advanced options"

data/config/locales/it.seorel.yml

@@ -0,0 +1,17 @@
+it:
+  activerecord:
+    model:
+      seorel/seorel: SEO
+
+    attributes:
+      seorel/seorel:
+        title: Meta title
+        description: Meta description
+        image: Immagine share
+
+  attributes:
+    seorel: SEO
+
+  seorel:
+    admin:
+      label: Meta tags

data/config/routes.rb

@@ -0,0 +1,2 @@
+# Seorel::Engine.routes.draw do
+# end

data/db/migrate/20120822091543_create_seorel_seorels.rb

@@ -0,0 +1,16 @@
+class CreateSeorelSeorels < ActiveRecord::Migration
+  def change
+    create_table :seorel_seorels do |t|
+      t.string :title
+      t.string :description
+      t.string :image
+      t.references :seorelable, polymorphic: true
+
+      t.timestamps
+    end
+
+    add_index :seorel_seorels, :seorelable_id
+    add_index :seorel_seorels, :seorelable_type
+    add_index :seorel_seorels, [:seorelable_id, :seorelable_type]
+  end
+end

data/lib/generators/seorel/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Copies Seorel configuration file to your application's initializer directory.
+
+Example:
+    rails generate seorel:config
+
+    This will create:
+        config/initializers/seorel_config.rb

data/lib/generators/seorel/config_generator.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+module Seorel
+  class ConfigGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_config_file
+      template 'seorel_config.rb', 'config/initializers/seorel_config.rb'
+    end
+
+  end
+end

data/lib/generators/seorel/templates/seorel_config.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+Seorel.configure do |config|
+  # config.default_title = nil
+  # config.default_description = nil
+  # config.default_image = nil
+  # config.prepend_title = nil
+  # config.append_title  = nil
+end

data/lib/seorel/config.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+require 'active_support/configurable'
+
+module Seorel
+  # Configures global settings for Seorel
+  #   Seorel.configure do |config|
+  #     config.default_default_title = 10
+  #   end
+  def self.configure(&block)
+    yield @config ||= Seorel::Configuration.new
+  end
+
+  # Global settings for Seorel
+  def self.config
+    @config
+  end
+
+  # need a Class for 3.0
+  class Configuration #:nodoc:
+    include ActiveSupport::Configurable
+
+    config_accessor :default_title
+    config_accessor :default_description
+    config_accessor :default_image
+    config_accessor :prepend_title
+    config_accessor :append_title
+
+    def param_name
+      config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name
+    end
+
+    # define param_name writer (copied from AS::Configurable)
+    writer, line = 'def param_name=(value); config.param_name = value; end', __LINE__
+    singleton_class.class_eval writer, __FILE__, line
+    class_eval writer, __FILE__, line
+  end
+
+  # this is ugly. why can't we pass the default value to config_accessor...?
+  configure do |config|
+    config.default_title = nil
+    config.default_description = nil
+    config.default_image = nil
+    config.prepend_title = nil
+    config.append_title  = nil
+  end
+end

data/lib/seorel/controller/class_methods.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+module Seorel
+  module Controller
+    module ClassMethods
+
+      def add_seorel_meta(values = {})
+        class_name = self.name
+
+        before_filter options do |controller|
+          controller.send :add_meta, values
+        end
+      end
+
+    end
+  end
+end

data/lib/seorel/controller/instance_methods.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+module Seorel
+  module Controller
+    module InstanceMethods
+
+      def add_seorel_meta(obj = {})
+        if obj.class.name == 'Hash'
+          add_seorel_hash obj
+        elsif obj.respond_to? :seorel
+          add_seorel_model obj
+        else
+          raise "Seorel `add_seorel_meta` invalid argument"
+        end
+      end
+
+      def add_seorel_hash(values = {})
+        seorel_params.title = values[:title] if values[:title].present?
+        seorel_params.description = values[:description] if values[:description].present?
+        seorel_params.image = values[:image] if values[:image].present?
+        seorel_params
+      end
+
+      def add_seorel_model(model)
+        seorel_params.title = model.seo_title
+        seorel_params.description = model.seo_description
+        seorel_params.image = model.seo_image.default.url if model.seo_image?
+        seorel_params
+      end
+
+      def seorel_params
+        @seosel_metatags ||= ::Seorel::Controller::Params.new
+      end
+
+      def self.included(klass)
+        return if klass.respond_to? :add_metatags
+        alias_method :add_metatags, :add_seorel_meta
+        protected :add_seorel_meta, :add_seorel_hash, :add_seorel_model, :seorel_params
+      end
+
+    end
+  end
+end

data/lib/seorel/controller/params.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+require 'active_support/configurable'
+
+module Seorel
+  module Controller
+    class Params
+
+      include ActiveSupport::Configurable
+
+      config_accessor :title
+      config_accessor :description
+      config_accessor :image
+
+      def full_title
+        [default_options.prepend_title, self.title, default_options.append_title].compact.join
+      end
+
+      def title
+        config.title || default_options.default_title
+      end
+
+      def description
+        config.description || default_options.default_description
+      end
+
+      def image
+        config.image || default_options.default_image
+      end
+
+      def default_options
+        ::Seorel.config
+      end
+
+    end
+  end
+end

data/lib/seorel/engine.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module Seorel
+  class Engine < ::Rails::Engine
+
+    isolate_namespace Seorel
+
+    initializer 'Seorel Setup' do |app|
+      app.config.to_prepare do
+        ActionController::Base.send :extend,  ::Seorel::Controller::ClassMethods
+        ActionController::Base.send :include, ::Seorel::Controller::InstanceMethods
+
+        ActionController::Base.send :helper_method, :seorel_params
+
+        ActionView::Base.send :include, ::Seorel::Helper
+      end
+    end
+
+  end
+end

data/lib/seorel/helper.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+module Seorel
+  module Helper
+
+    def render_meta_tags
+      metas = ''
+      metas+= render_title
+      metas+= render_description
+      metas+= render_open_graph
+      metas+= render_twitter_cards
+      metas.html_safe
+    end
+
+    def render_title
+      content_tag :title, seorel_params.full_title
+    end
+
+    def render_description
+      content_tag :meta, nil, name: 'description', content: seorel_params.description
+    end
+
+    def render_open_graph
+      metas = ''
+      metas+= content_tag :meta, nil, name: 'og:type', content: 'website'
+      metas+= content_tag :meta, nil, name: 'og:title', content: seorel_params.full_title
+      metas+= content_tag :meta, nil, name: 'og:description', content: seorel_params.description
+      metas+= content_tag :meta, nil, name: 'og:image', content: seorel_params.image
+      metas+= content_tag :meta, nil, name: 'og:locale', content: I18n.locale.to_s
+      metas.html_safe
+    end
+
+    def render_twitter_cards
+      metas = ''
+      metas+= content_tag :meta, nil, name: 'twitter:card', content: 'summary'
+      metas+= content_tag :meta, nil, name: 'twitter:url', content: url_for
+      metas+= content_tag :meta, nil, name: 'twitter:title', content: seorel_params.full_title
+      metas+= content_tag :meta, nil, name: 'twitter:description', content: seorel_params.description
+      metas+= content_tag :meta, nil, name: 'twitter:image', content: seorel_params.image
+      metas.html_safe
+    end
+
+  end
+end

data/lib/seorel/model/base.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Seorel
+  module Model
+    module Base
+
+      def seorelify(*args)
+        include InstanceMethods
+        extend  ClassMethods
+
+        cattr_accessor :seorel_title_field, :seorel_description_field, :seorel_image_field
+
+        if args[0].class.name == 'Hash'
+          class_variable_set '@@seorel_title_field',       args[0][:title]
+          class_variable_set '@@seorel_description_field', args[0][:description] || args[0][:title]
+          class_variable_set '@@seorel_image_field',       args[0][:image]
+        else
+          class_variable_set '@@seorel_title_field',       args[0]
+          class_variable_set '@@seorel_description_field', args[1] || args[0]
+          class_variable_set '@@seorel_image_field',       args[2]
+        end
+
+        has_one :seorel, as: :seorelable, dependent: :destroy, class_name: 'Seorel::Seorel'
+        accepts_nested_attributes_for :seorel, allow_destroy: false
+
+        before_save :set_seorel_default_values
+
+        delegate :title, :title?, :description, :description?, :image, :image?, to: :seorel, prefix: :seo, allow_nil: true
+      end
+
+    end
+  end
+end

data/lib/seorel/model/class_methods.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+module Seorel
+  module Model
+    module ClassMethods
+
+      def seorel?
+        true
+      end
+
+    end
+  end
+end

data/lib/seorel/model/instance_methods.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+module Seorel
+  module Model
+    module InstanceMethods
+
+      def seorel?
+        self.try(:seorel).present?
+      end
+
+      def set_seorel_default_values
+        self.build_seorel unless self.seorel?
+
+        self.seorel.title       = self.seorel_title_value       if self.seorel_title_value.present?
+        self.seorel.description = self.seorel_description_value if self.seorel_description_value.present?
+      end
+
+      def seorel_title_value
+        self.class.seorel_title_field && self.send(self.class.seorel_title_field)
+      end
+
+      def seorel_description_value
+        self.class.seorel_description_field && self.send(self.class.seorel_description_field)
+      end
+
+      def seorel_default_value?
+        self.class.seorel_base_field.present?
+      end
+
+    end
+  end
+end

data/lib/seorel/seorelify.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module Seorelify
+
+  def self.extended(model_class)
+    return if model_class.respond_to? :seorel
+
+    model_class.instance_eval do
+      extend ::Seorel::Model::Base
+    end
+  end
+
+  def self.included(model_class)
+    return if model_class.respond_to? :seorel
+
+    model_class.instance_eval do
+      extend ::Seorel::Model::Base
+    end
+  end
+
+end

data/lib/seorel/version.rb

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