RubyGems - meta_manager - Versions diffs - 0.0.1 - Mend

meta_manager 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (54) hide show

data/MIT-LICENSE +20 -0
data/README.rdoc +93 -0
data/Rakefile +34 -0
data/app/models/meta_tag.rb +23 -0
data/db/migrate/20111228124815_create_meta_tags.rb +21 -0
data/lib/meta_manager.rb +7 -0
data/lib/meta_manager/engine.rb +12 -0
data/lib/meta_manager/helper.rb +62 -0
data/lib/meta_manager/taggable.rb +52 -0
data/lib/meta_manager/version.rb +3 -0
data/lib/tasks/meta_manager_tasks.rake +4 -0
data/test/controllers/posts_controller_test.rb +72 -0
data/test/dummy/Rakefile +7 -0
data/test/dummy/app/assets/javascripts/application.js +9 -0
data/test/dummy/app/assets/stylesheets/application.css +7 -0
data/test/dummy/app/controllers/application_controller.rb +5 -0
data/test/dummy/app/controllers/posts_controller.rb +25 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/models/category.rb +7 -0
data/test/dummy/app/models/post.rb +5 -0
data/test/dummy/app/views/layouts/application.html.erb +15 -0
data/test/dummy/app/views/posts/index.html.erb +0 -0
data/test/dummy/app/views/posts/show.html.erb +0 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/config/application.rb +45 -0
data/test/dummy/config/boot.rb +10 -0
data/test/dummy/config/database.yml +11 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +30 -0
data/test/dummy/config/environments/production.rb +60 -0
data/test/dummy/config/environments/test.rb +39 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/inflections.rb +10 -0
data/test/dummy/config/initializers/mime_types.rb +5 -0
data/test/dummy/config/initializers/secret_token.rb +7 -0
data/test/dummy/config/initializers/session_store.rb +8 -0
data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
data/test/dummy/config/locales/en.yml +5 -0
data/test/dummy/config/routes.rb +60 -0
data/test/dummy/db/migrate/20111226131910_create_categories.rb +9 -0
data/test/dummy/db/migrate/20111226131911_create_posts.rb +11 -0
data/test/dummy/db/test.sqlite.db +0 -0
data/test/dummy/log/development.log +1 -0
data/test/dummy/log/test.log +8598 -0
data/test/dummy/public/404.html +26 -0
data/test/dummy/public/422.html +26 -0
data/test/dummy/public/500.html +26 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/dummy/script/rails +6 -0
data/test/meta_manager_test.rb +11 -0
data/test/models/category_test.rb +41 -0
data/test/models/meta_tag_test.rb +67 -0
data/test/test_helper.rb +14 -0
metadata +162 -0

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+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.rdoc ADDED Viewed

@@ -0,0 +1,93 @@
+= MetaManager
+Enable meta tags in your model
+== Install
+  gem "meta_manager"
+  rake meta_manager_engine:install:migrations
+== Usage
+  class Category < ActiveRecord::Base
+    include MetaManager::Taggable
+  end
+  @category = Category.new
+  @category.tag_title = 'category test title'
+  @category.tag_keywords = "Some keywords"
+  @category.tag_description = "Some description"
+  @category.meta_tags.build(:name => "og:title", :content => 'category og:title')
+  # create dynamic meta tags, who will be overwrited the same category tag names
+  # only with @meta_dynamic=true in controller
+  @category.meta_tags.build(:name => "og:title", :content => 'dynamic og:title - %{post.title}', :is_dynamic => true)
+  @category.meta_tags.build(:name => "title", :content => '%{post.title} - %{post.notes}', :is_dynamic => true)
+  @category.save
+  # create post for dynamic example
+  @post = Post.create(:title => 'post test title', :notes => 'post test notes')
+== Rendering example
+At layouts/application.html.erb
+  <head>
+  <%= raw(render_meta_tags(@category)) %>
+  <title><%= render_page_title(@category) %></title>
+At controllers/posts_controller.rb
+  before_filter :find_category
+  before_filter :prepare_dynamic_page, :only => [:show]
+  def index
+    @posts = Post.order('id')
+    respond_with(@posts)
+  end
+  def show
+    @post = Post.find(params[:id])
+    respond_with(@post)
+  end
+  protected
+    def find_category
+      @category = Category.first
+    end
+    # set @meta_dynamic true to turn on dymanic meta tags.
+    def prepare_dynamic_page
+      @meta_dynamic = true
+    end
+It will be generate meta tags and title for @category.
+In action show we wont to generate dynamic meta tags from instance @post.
+It means that meta tag 'og:title' and tag 'title' will be overwrited with attributes from instance @post.
+=== Results
+Action index:
+  <meta content='Some keywords' name='keywords' />
+  <meta content='Some description' name='description' />
+  <meta content='category og:title' property='og:title' />
+  <title>category test title</title>
+Action show:
+  <meta content='Some keywords' name='keywords' />
+  <meta content='Some description' name='description' />
+  <meta content='dynamic og:title - post test title' property='og:title' />
+  <title>post test title - post test notes</title>
+== Test
+  rake test
+Copyright (c) 2011 Aimbulance, released under the MIT license

data/Rakefile ADDED Viewed

@@ -0,0 +1,34 @@
+#!/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    = 'MetaManager'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+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/meta_tag.rb ADDED Viewed

@@ -0,0 +1,23 @@
+class MetaTag < ::ActiveRecord::Base
+  belongs_to :taggable, :polymorphic => true
+  validates_presence_of :name, :taggable_type
+  validates_uniqueness_of :name, :scope => [:taggable_type, :taggable_id, :is_dynamic]
+  attr_accessible :name, :content, :is_dynamic
+  def get_content(controller=nil)
+    self.is_dynamic ? dynamic_content(controller) : self.content
+  end
+  def dynamic_content(controller)
+    self.content.gsub /%{([\w\.]+)}/ do
+      items = $1.split('.')
+      instance_name = items.shift
+      method_name = items.join('.')
+      record = controller.instance_variable_get("@#{instance_name}")
+      record.try(:"#{method_name}")
+    end
+  end
+end

data/db/migrate/20111228124815_create_meta_tags.rb ADDED Viewed

@@ -0,0 +1,21 @@
+class CreateMetaTags < ActiveRecord::Migration
+  def self.up
+    create_table :meta_tags do |t|
+      t.string :name, :limit => 50, :null => false
+      t.text :content
+      t.boolean :is_dynamic, :default => false
+      t.integer :taggable_id, :null => false
+      t.string :taggable_type, :limit => 50, :null => false
+      t.timestamps
+    end
+    add_index :meta_tags, :name
+    add_index :meta_tags, [:taggable_type, :taggable_id]
+  end
+  def self.down
+    drop_table :meta_tags
+  end
+end

data/lib/meta_manager.rb ADDED Viewed

@@ -0,0 +1,7 @@
+require 'meta_manager/taggable'
+require 'meta_manager/helper'
+module MetaManager
+end
+require 'meta_manager/engine'

data/lib/meta_manager/engine.rb ADDED Viewed

@@ -0,0 +1,12 @@
+require 'rails'
+require 'meta_manager'
+module MetaManager #:nodoc:
+  class Engine < ::Rails::Engine #:nodoc:
+    initializer "meta_manager.setup" do
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.send :include, MetaManager::Helper
+      end
+    end
+  end
+end

data/lib/meta_manager/helper.rb ADDED Viewed

@@ -0,0 +1,62 @@
+module MetaManager
+  module Helper
+    #extend ::ActionView::Helpers::TagHelper
+    def self.included(base)
+      base.send :helper_method, :render_meta_tags, :render_page_title
+    end
+    def render_meta_tags(record)
+      return if record.nil?
+      dynamic = self.instance_variable_get("@meta_dynamic")
+      tags = []
+      get_actual_meta_tags(record, dynamic).each do |meta_tag|
+        unless meta_tag.name == 'title'
+          type = meta_tag.name =~ /og:/ ? 'property' : 'name'
+          tags << "<meta content='#{meta_tag.get_content(self)}' #{type}='#{meta_tag.name}' />"
+        end
+      end
+      tags.join("\n\s\s")
+    end
+    def render_page_title(record=nil, options = {})
+      dynamic = self.instance_variable_get("@meta_dynamic")
+      meta_tags = get_actual_meta_tags(record, dynamic)
+      meta_tags.detect{|t| t.name == 'title'}.try(:get_content, self) || get_page_title(record, options)
+    end
+    private
+      def get_page_title(record, options)
+        options = { :spliter => ' - ', :append_title => true }.merge(options)
+        view_title = if record.respond_to?(:title)
+          record.title
+        elsif record.respond_to(:name)
+          record.name
+        end
+        page_title = []
+        page_title << options[:title] if options.key?(:title)
+        page_title << view_title
+        page_title << I18n.t("page.title") if options[:append_title]
+        page_title.flatten.compact.uniq.join(options[:spliter])
+      end
+      def get_actual_meta_tags(record, dynamic)
+        meta_tags = []
+        _meta_tags = record.respond_to?(:meta_tags) ? record.meta_tags : []
+        _meta_tags.group_by(&:name).each do |name, items|
+          meta_tags << (items.detect{|r| r.is_dynamic && dynamic} || items.detect{|r| !r.is_dynamic})
+        end
+        meta_tags.compact
+      end
+  end
+end

data/lib/meta_manager/taggable.rb ADDED Viewed

@@ -0,0 +1,52 @@
+module MetaManager
+  module Taggable
+    extend ::ActiveSupport::Concern
+    included do
+      has_many :meta_tags, :as => :taggable, :dependent => :destroy, :autosave => true
+      accepts_nested_attributes_for :meta_tags, :reject_if => :all_blank, :allow_destroy => true
+    end
+    module InstanceMethods
+      # Find meta tag by name or build new record
+      def find_or_build_meta_tag(attr_name)
+        key = normalize_meta_tag_name(attr_name)
+        self.meta_tags.where(:name => key).first || self.meta_tags.build(:name => key)
+      end
+      # Save meta tags records into one hash
+      def meta_tag(attr_name)
+        key = normalize_meta_tag_name(attr_name)
+        @meta_tag ||= {}
+        @meta_tag[key] ||= find_or_build_meta_tag(key)
+      end
+      protected
+        def normalize_meta_tag_name(value)
+          key = value.to_s.downcase.strip
+          key
+        end
+        def method_missing(method, *args, &block)
+          key = method.to_s
+          if key =~ /^tag_/
+            attr_name = key.gsub(/^tag_/, '')
+            if key =~ /=$/
+              record = meta_tag(attr_name.chop)
+              record.content = args.first
+            else
+              meta_tag(attr_name).try(:content)
+            end
+          else
+            super
+          end
+        end
+    end
+  end
+end

data/lib/meta_manager/version.rb ADDED Viewed

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

data/lib/tasks/meta_manager_tasks.rake ADDED Viewed

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

data/test/controllers/posts_controller_test.rb ADDED Viewed

@@ -0,0 +1,72 @@
+require 'test_helper'
+class PostsControllerTest < ActionController::TestCase
+  setup do
+    @category = Category.new :title => 'Test category'
+    @category.tag_title = 'test title'
+    @category.tag_keywords = 'test, keywords'
+    @category.tag_description = 'test description'
+    @category.meta_tags.build(:name => "og:title", :content => 'category og:title')
+    @category.meta_tags.build(:name => "title", :content => 'title %{post.title}, content %{post.content}, notes %{post.notes}', :is_dynamic => true)
+    @category.meta_tags.build(:name => "og:title", :content => 'dynamic og:title - %{post.title}', :is_dynamic => true)
+    @category.save
+    @post = Post.create(:title => 'test_title', :content => 'test_content', :notes => 'test_notes')
+  end
+  test "should get index" do
+    get :index
+    assert_response :success
+    assert_not_nil assigns(:posts)
+  end
+  test "should get show" do
+    get :show, :id => 1
+    assert_response :success
+    assert_not_nil assigns(:post)
+  end
+  test "should have meta tags at index action" do
+    get :index
+    assert_select 'title', {:count => 1, :text => "test title"}
+    assert_select "meta[name=keywords]", {:count => 1} do
+      assert_select "[content=?]", 'test, keywords'
+    end
+    assert_select "meta[name=description]", {:count => 1} do
+      assert_select "[content=?]", 'test description'
+    end
+    assert_select "meta[property=og:title]", {:count => 1} do
+      assert_select "[content=?]", 'category og:title'
+    end
+  end
+  test "should have dynamic meta tags at show action" do
+    get :show, :id => 1
+    assert_select 'title', {:count => 1, :text => "title test_title, content test_content, notes test_notes"}
+    assert_select "meta[name=keywords]", {:count => 1} do
+      assert_select "[content=?]", 'test, keywords'
+    end
+    assert_select "meta[name=description]", {:count => 1} do
+      assert_select "[content=?]", 'test description'
+    end
+    assert_select "meta[property=og:title]", {:count => 1} do
+      assert_select "[content=?]", 'dynamic og:title - test_title'
+    end
+  end
+end

data/test/dummy/Rakefile ADDED Viewed

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+require File.expand_path('../config/application', __FILE__)
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js ADDED Viewed

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css ADDED Viewed

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree .
+*/