hakuna-metatags 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86a12bcdd72d0cecfcdaae5b9630e23fec616268
+  data.tar.gz: fe34e8e1d46282511b47680c394fbfbded2c12b0
+SHA512:
+  metadata.gz: 50c5957dd1dc6f0debd89be10b4b453d32ace903f675bac2d2bf17666457b2d167e38b3ee80ea82115869410623b7ec5c87331ea9733b8b22106238086648980
+  data.tar.gz: be2748c7494c81242c2a6aa9ddc7d4a8a152bdfbac867fa1e4e7a641b926468ad0198037707c6c2700bb5e6f8185984a51210ce22ea411710701a76cdf37db1d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 niuage
+
+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

@@ -0,0 +1,3 @@
+= Metatags
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,34 @@
+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    = 'Metatags'
+  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/helpers/metatags_helper.rb

@@ -0,0 +1,5 @@
+module MetatagsHelper
+  def render_meta_tags
+    render meta_tags
+  end
+end

data/app/views/application/_title_and_meta_tags.html.erb

@@ -0,0 +1,32 @@
+<title><%= meta_tags.title %></title>
+<%= tag :meta, name: "description", content: meta_tags.description %>
+
+<%# OpenGraph %>
+<%= tag :meta, name: "og:title", content: meta_tags.title %>
+<%= tag :meta, name: "og:type", content: meta_tags.type %>
+<%= tag :meta, name: "og:description", content: meta_tags.description %>
+<%= tag :meta, name: "og:url", content: meta_tags.url %>
+<%= tag :meta, name: "og:image", content: meta_tags.image %>
+
+<%# Twitter %>
+<%= tag :meta, name: "twitter:card", content: meta_tags.twitter_card %>
+<%= tag :meta, name: "twitter:title", content: meta_tags.title %>
+<%= tag :meta, name: "twitter:description", content: meta_tags.description %>
+<%= tag :meta, name: "twitter:url", content: meta_tags.twitter_url %>
+<%= tag :meta, name: "twitter:site", content: meta_tags.twitter_site %>
+<%= tag :meta, name: "twitter:image", content: meta_tags.image %>
+<%= tag :meta, name: "twitter:creator", content: meta_tags.twitter_creator %>
+
+<%# Google+ tags %>
+<%= tag :meta, itemprop: "name", content: meta_tags.title %>
+<%= tag :meta, itemprop: "description", content: meta_tags.description %>
+<%= tag :meta, itemprop: "image", content: meta_tags.image %>
+
+<%# Facebook %>
+<% if meta_tags.facebook_app_id %>
+  <%= tag :meta, name: "fb:app_id", content: meta_tags.facebook_app_id %>
+<% end %>
+
+<%# Others %>
+<%= tag :meta, name: "robots", content: meta_tags.robots %>
+<%= tag :meta, name: "theme-color", content: meta_tags.theme_color %>

data/config/locales/metatags.yml

@@ -0,0 +1,5 @@
+en:
+  meta_tags:
+    base:
+      title: ""
+      description: ""

data/lib/metatags.rb

@@ -0,0 +1,9 @@
+require "metatags/engine"
+
+require "metatags/version"
+
+require "metatags/base_metatags"
+require "metatags/concerns/controller"
+
+module Metatags
+end

data/lib/metatags/base_metatags.rb

@@ -0,0 +1,92 @@
+#
+# BaseMetatags contains all the default values for the page title, page description,
+# and meta tags.
+#
+# This class, or one of its descendants, is instanciated on every page.
+#
+# If a new page requires different meta tags, create a new subclass, and override
+# the necessary methods.
+#
+
+module Metatags
+  class BaseMetatags
+    attr_accessor :object, :view_context
+
+    delegate :image_url, :request, to: :view_context
+
+    def initialize(object, view_context)
+      self.object = object
+      self.view_context = view_context
+    end
+
+    def title
+      I18n.translate("title", with_scope(i18n_title_data))
+    end
+
+    def description
+      I18n.translate("description", with_scope(i18n_description_data))
+    end
+
+    def url
+      request.original_url
+    end
+    alias_method :twitter_url, :url
+
+    def image
+      meta_tag_image_url("og-main.jpg")
+    end
+
+    def type
+      "devpost:website"
+    end
+
+    def to_partial_path
+      "title_and_meta_tags"
+    end
+
+    def twitter_card
+      "summary_large_image"
+    end
+
+    def twitter_site
+      "@devpost"
+    end
+
+    def twitter_creator
+    end
+
+    def facebook_app_id
+    end
+
+    def robots
+    end
+
+    def theme_color
+    end
+
+    def i18n_scope
+      "meta_tags.#{object_class_name.underscore}"
+    end
+
+    def with_scope(data)
+      (data || {}).merge({ scope: i18n_scope })
+    end
+
+    def i18n_title_data
+      {}
+    end
+
+    def i18n_description_data
+      {}
+    end
+
+    def meta_tag_image_url(image_name)
+      image_url("meta_tags/#{image_name}")
+    end
+
+    def object_class_name
+      return self.class.name.gsub(/Metatags(::)?/, "") if object.blank?
+      object.class.name.split("::").last
+    end
+  end
+end

data/lib/metatags/concerns/controller.rb

@@ -0,0 +1,138 @@
+# Example:
+#
+# class ApplicationController < ActionController::Base
+#   include Metatags::Concerns::Controller
+# end
+#
+# class ArticlesController < ApplicationController
+#   before_action :find_article, only: [:show]
+#
+#   # Simplest option.
+#   # Will use Metatags::ArticleMetatags by default.
+#   build_meta_tags instance: :article
+#   # OR
+#   # if you need to be specific about which class to use
+#   build_meta_tags with: Metatags::CustomArticleMetatags, instance: :article
+#   # OR
+#   # if you need logic to determine which Metatags class to use, and want to build
+#   # the meta tags in the action itself.
+#   skip_building_metatags only: [:index]
+#
+#   def index
+#     @articles = Article.all
+#   end
+#
+#   def show
+#   end
+#
+#   protected
+#
+#   def find_article
+#     @article = Article.find(params[:id])
+#   end
+# end
+
+module Metatags
+  module Concerns
+    module Controller
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :metatags_class, :metatags_instance_sym
+        initialize_metatags_class
+
+        before_action :build_default_meta_tags
+
+        attr_accessor :meta_tags
+        helper_method :meta_tags
+      end
+
+      module ClassMethods
+
+        ## Example:
+        #
+        # class TeamsController
+        #   build_meta_tags with: Metatags::TeamMetatags, instance: :team
+        # end
+        #
+        ## The code above will build an instance of the Metatags::TeamMetatags class
+        ## with `@team` if present.
+        #
+        def build_meta_tags(options = {})
+          self.metatags_class = options.delete(:with)
+          self.metatags_instance_sym = options.delete(:instance)
+
+          skip_before_action :build_default_meta_tags, options
+          before_action :build_meta_tags_with_instance, options
+        end
+
+        def skip_building_meta_tags(options = {})
+          skip_before_action :build_default_meta_tags, options
+        end
+
+        def initialize_metatags_class
+          self.metatags_class = "Metatags::AppMetatags".safe_constantize || Metatas::BaseMetatags
+        end
+      end
+
+      protected
+
+      # Builds the meta_tags using either the class passed by the user with the `with`
+      # option or a class which name is inferred from the controller name.
+      #
+      def build_default_meta_tags
+        klass = metatags_class || default_metatags_class
+        build_meta_tags(with: klass, instance: metatags_instance)
+      end
+      alias_method :build_meta_tags_with_instance, :build_default_meta_tags
+
+      def metatags_instance
+        return nil unless metatags_instance_sym
+        instance_variable_get("@#{metatags_instance_sym}")
+      end
+
+      # Infers the metatags class name from the controller name by default.
+      #
+      # The default class can be overriden with the `with` option of `build_meta_tags`
+      #
+      def default_metatags_class
+        inferred_name = self.class.name.gsub("Controller", "").singularize
+
+        [
+          # Metatags::Manage::TeamMetatags::Index
+          "Metatags::#{inferred_name}Metatags::#{action_name.classify}",
+          # Metatags::Manage::TeamMetatags
+          "Metatags::#{inferred_name}Metatags",
+          # Metatags::TeamMetatags::Index
+          "Metatags::#{inferred_name.split("::").last}Metatags::#{action_name.classify}",
+          # Metatags::TeamMetatags
+          "Metatags::#{inferred_name.split("::").last}Metatags",
+          # Metatags::AppMetatags
+          "Metatags::AppMetatags",
+          # Metatags::BaseMetatags
+          "Metatags::BaseMetatags"
+        ].detect do |class_name|
+          klass = class_name.safe_constantize
+          break klass if klass
+        end
+      end
+
+      # This method is useful when the class name of the Metatags class cannot
+      # be inferred by the gem.
+      #
+      # Ex:
+      #
+      # class TeamsController
+      #   def show
+      #     if special_case?
+      #       build_meta_tags with: Metatags::SpecialMetatags, instance: :team
+      #     end
+      #   end
+      # end
+      #
+      def build_meta_tags(with: Metatags::BaseMetatags, instance: nil)
+        self.meta_tags = with.new(instance, view_context)
+      end
+    end
+  end
+end

data/lib/metatags/engine.rb

@@ -0,0 +1,4 @@
+module Metatags
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/metatags/version.rb

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

data/lib/tasks/metatags_tasks.rake

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

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# 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__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/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/test/dummy/app/assets/stylesheets/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/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end