html_meta_tags 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c22711e9645bc635fb03223c58171ea5e3ac0f8
+  data.tar.gz: d2467942f05ee00e8b5cfadf5ed2fa6765f79de5
+SHA512:
+  metadata.gz: 22da8b542d298cb2dbae0dca8d6ba7c66c6a6ae1419eb3c50f80e2b02f6b0b8a2b82b80eb8e1e34b765f2806ee87db5307f305de6a2be751192f7676e11c6b21
+  data.tar.gz: 0311597dc5fc10ebab5350820e167a297b6b894495281c47dd3cb1e541c4dd489b0f4076e61b49df89d61ba1cd68b80dd9fa0eb7e48358ef8c80a4917bff78e5

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Joaquin Rivera Padron
+
+MIT License
+
+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,132 @@
+# SEO Landing Pages
+
+Create and manage your SEO landing pages easily.
+
+SEO gives great importance to 3 html elements in the html head: title, meta
+description and meta keywords (to a lesser extent).
+
+This gem lets you easily:
+
+- create landing pages identified by their path
+- edit their title, description and keywords
+- render them easily in your views with provided helpers
+- have your SEO guru love you :-)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'seo_landing_pages'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seo_landing_pages
+
+## Usage
+
+### The landing pages data
+
+Use the generator provided to create the landing pages table
+
+    $ rails g seo_landing_pages migration
+
+run the migration and you should be ready to create landing pages, an example
+in the rails console would be:
+
+    > SeoLandingPages::Model.create! slug: '/', title: 'SEO landing pages FTW'
+
+*Note* the `slug` must be given and be unique.
+
+It's your work now to determine which pages you want to create, e.g. for your
+blog, listings page, etc.
+
+### Configure the controller
+
+Configure your `ApplicationController` by running:
+
+    $ rails g seo_landing_pages controller
+
+That will include the module `SeoLandingPages::Controllers::Helpers` in your controller,
+the module provides a method `seo_current_landing_page` which finds a Landing Page
+matching the request path (`/` in the example), and also will make view helpers
+available for your views.
+
+For advanced options of how to match Landing Pages check the module mentioned.
+
+### Landing pages in the views
+
+To show the SEO data in your views there are handy view helpers available, add
+to your views layout in the head section:
+
+```ruby
+= seo_landing_page_title_tag
+= seo_landing_page_description_tag
+= seo_landing_page_keywords_tag
+```
+
+these add the proper HTML tags, visit your home page and the title
+`SEO Landing Pages FTW` should be showing in your HTML.
+
+There are also helpers to access the landing pages attributes without the HTML
+tag for you to concatenate them or so.
+
+```ruby
+= seo_landing_page_title
+= seo_landing_page_description
+= seo_landing_page_keywords
+```
+
+### Internationalization support
+
+For internationalization, instead of writing plain text in the title, description
+and keywords write i18n keys, e.g. a landing page for your home page:
+
+    > SeoLandingPages::Model.create! slug: '/', title:       'title_home_page',
+                                                description: 'description_home_page',
+                                                keywords:    'keywords_home_page'
+
+Create the translations in your locale files. Then use the view helpers like this:
+
+```ruby
+= seo_landing_page_title_tag i18n: true
+= seo_landing_page_description_tag i18n: true
+= seo_landing_page_keywords_tag i18n: true
+```
+
+Now your pages have the HTML elements localized.
+
+### Admin section
+
+There's an Active Admin view provided, to get it run:
+
+    $ rails g seo_landing_pages active_admin
+
+    $ rails g seo_landing_pages i18n
+
+and let your SEO guru float in love waves editing all the Landing Pages and seeing
+traffic increasing for your website.
+
+## TODO
+
+- write another CRUD admin section for those not using Active Admin, or accept
+a Pull Request having it ;-)
+- fix the TODOs in the code
+- write tests
+
+## Contributing
+
+1. Fork it ( https://github.com/joahking/seo_landing_pages/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Credits
+
+This gem was developed in the [Hack Week at XING Barcelona](https://twitter.com/hashtag/hackweekxing),
+Big thanks to XING for providing the time to see ideas being realized.
+

data/Rakefile

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

data/lib/generators/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Generates migration and boilerplate code for the landing pages
+
+Example:
+    rails generate seo_landing_pages migration
+
+      This will create:
+        the migration to create the landing pages table
+
+    rails generate seo_landing_pages active_admin
+
+      This will create:
+        the boilerplate code to administer your landing pages with Active Admin
+

data/lib/generators/seo_landing_pages_generator.rb

@@ -0,0 +1,42 @@
+require 'rails/generators/active_record'
+
+class SeoLandingPagesGenerator < ActiveRecord::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  #TODO all the methods run now, turn them into options, as Thor intended :-)
+
+  # Public: copies the migration.
+  def migration
+    migration_template 'migration.rb', 'db/migrate/create_seo_landing_pages.rb'
+  end
+
+  # Public: configures the application controller to include the Helpers module.
+  def controller
+    inject_into_class 'app/controllers/application_controller.rb', ApplicationController do
+      "  include SeoLandingPages::Controllers::Helpers\n\n"
+    end
+  end
+
+  # Public: copies the active admin boilerplate code.
+  def active_admin
+    copy_file 'active_admin.rb', 'app/admin/seo_landing_pages.rb'
+  end
+
+  # Public: copies the i18n files.
+  def i18n
+    %w(en es).each do |locale|
+      copy_file "i18n.#{ locale }.yml", "config/locales/seo_landing_pages.#{ locale }.yml"
+    end
+  end
+
+  # Public: adds an admin route to the router.
+  def route
+    #TODO
+  end
+
+  # Public: copies the CRUD admin code.
+  def admin
+    #TODO
+  end
+end
+

data/lib/generators/templates/active_admin.rb

@@ -0,0 +1,41 @@
+ActiveAdmin.register SeoLandingPages::Model do
+
+  permit_params :slug, :title, :description, :keywords
+
+  index do
+    column :slug do |landing_page|
+      link_to landing_page.slug, landing_page.slug, target: :blank
+    end
+    column :title
+    column :description
+    column :keywords
+    default_actions
+  end
+
+  filter :slug
+
+  form do |f|
+    f.inputs "SEO Landing Page" do
+      f.input :slug
+      f.input :title
+      f.input :description, as: :text
+      f.input :keywords, as: :text
+    end
+    f.actions
+  end
+
+  show do |landing_page|
+    attributes_table do
+      row :slug do
+        link_to landing_page.slug, landing_page.slug, target: :blank
+      end
+      row :title
+      row :description
+      row :keywords
+      row :created_at
+      row :updated_at
+    end
+  end
+
+end
+

data/lib/generators/templates/i18n.en.yml

@@ -0,0 +1,7 @@
+en:
+  activerecord:
+    models:
+      seo_landing_pages/model:
+        one: 'SEO Landing Page'
+        other: 'SEO Landing Pages'
+

data/lib/generators/templates/i18n.es.yml

@@ -0,0 +1,10 @@
+es:
+  activerecord:
+    models:
+      seo_landing_pages/model:
+        one: 'Página SEO'
+        other: 'Páginas SEO'
+    attributes:
+      seo_landing_pages/model:
+        slug: 'URL'
+

data/lib/generators/templates/migration.rb

@@ -0,0 +1,14 @@
+class CreateSeoLandingPages < ActiveRecord::Migration
+  def change
+    create_table :seo_landing_pages do |t|
+      t.string :slug
+      t.string :title
+      t.string :description
+      t.string :keywords
+
+      t.timestamps null: false
+    end
+    add_index :seo_landing_pages, :slug
+  end
+end
+

data/lib/seo_landing_pages.rb

@@ -0,0 +1,12 @@
+require 'seo_landing_pages/version'
+
+module SeoLandingPages
+  autoload :Model, 'seo_landing_pages/model'
+
+  module Controllers
+    autoload :Helpers, 'seo_landing_pages/controllers/helpers'
+  end
+
+  autoload :Helper, 'seo_landing_pages/helper'
+end
+

data/lib/seo_landing_pages/controllers/helpers.rb

@@ -0,0 +1,41 @@
+# Public: helper methods for ApplicationController.
+#
+# Include this module in your controllers to gain access to the landing page
+# in your views.
+#
+module SeoLandingPages
+  module Controllers
+    module Helpers
+      extend ActiveSupport::Concern
+
+      included do
+        helper SeoLandingPages::Helper
+        helper_method :seo_current_landing_page
+      end
+
+      # Public: returns the current landing page.
+      # The landing page is matched by the request path, check the method
+      # seo_request_path for details on how to change the matching.
+      def seo_current_landing_page
+        @seo_current_landing_page ||= SeoLandingPages::Model.where(slug: seo_request_path).first
+      end
+
+      protected
+
+      # Internal: the request path is used to match landing pages.
+      #
+      # Override this method in your controllers to change the way the landing
+      # pages are matched.
+      #
+      # Example: the request path is '/blog?search=XYZ', to handle all blog pages
+      # as the same landing page (e.g. '/blog') change this method in your
+      # blogs_controller to remove everything after the '?'
+      #
+      def seo_request_path
+        request.path
+      end
+
+    end
+  end
+end
+

data/lib/seo_landing_pages/helper.rb

@@ -0,0 +1,78 @@
+# Public: helpers for your views.
+module SeoLandingPages
+  module Helper
+
+    # Public: html title tag with the landing page title.
+    # - i18n: false = render plain text title. This is the default.
+    #         true  = title is an i18n key, so translate it.
+    # If the landing page title is empty it returns nothing.
+    def seo_landing_page_title_tag(i18n: false)
+      title = seo_landing_page_title i18n: i18n
+      if title.present?
+        "<title>#{ title }</title>".html_safe
+      end
+    end
+
+    # Public: landing page title.
+    # - i18n: false = render plain text title. This is the default.
+    #         true  = title is an i18n key, so translate it.
+    def seo_landing_page_title(i18n: false)
+      if seo_current_landing_page
+        title = seo_current_landing_page.title
+        if title.present?
+          i18n ? t(title) : title
+        end
+      end
+    end
+
+    # Public: html description meta tag with the landing page description.
+    # - i18n: false = render plain text description. This is the default.
+    #         true  = description is an i18n key, so translate it.
+    # If the landing page description is empty it returns nothing.
+    def seo_landing_page_description_tag(i18n: false)
+      description = seo_landing_page_description i18n: i18n
+      if description.present?
+        "<meta name='description' content='#{ description }'/>".html_safe
+      end
+    end
+
+    # Public: landing page description.
+    # - i18n: false = render plain text description. This is the default.
+    #         true  = description is an i18n key, so translate it.
+    # If the landing page description is empty it returns nothing.
+    def seo_landing_page_description(i18n: false)
+      if seo_current_landing_page
+        description = seo_current_landing_page.description
+        if description.present?
+          i18n ? t(description) : description
+        end
+      end
+    end
+
+    # Public: html keywords meta tag with the landing page keywords.
+    # - i18n: false = render plain text keywords. This is the default.
+    #         true  = keywords is an i18n key, so translate it.
+    # If the landing page keywords is empty it returns nothing.
+    def seo_landing_page_keywords_tag(i18n: false)
+      keywords = seo_landing_page_keywords i18n: i18n
+      if keywords.present?
+        "<meta name='keywords' content='#{ keywords }'/>".html_safe
+      end
+    end
+
+    # Public: landing page keywords.
+    # - i18n: false = render plain text keywords. This is the default.
+    #         true  = keywords is an i18n key, so translate it.
+    # If the landing page keywords is empty it returns nothing.
+    def seo_landing_page_keywords(i18n: false)
+      if seo_current_landing_page
+        keywords = seo_current_landing_page.keywords
+        if keywords.present?
+          i18n ? t(keywords) : keywords
+        end
+      end
+    end
+
+  end
+end
+

data/lib/seo_landing_pages/model.rb

@@ -0,0 +1,10 @@
+module SeoLandingPages
+  class Model < ActiveRecord::Base
+    # TODO make table_name configurable and use it
+    self.table_name = 'seo_landing_pages'
+
+    # TODO test this
+    validates :slug, presence: true, uniqueness: true
+  end
+end
+

data/lib/seo_landing_pages/version.rb

@@ -0,0 +1,4 @@
+module SeoLandingPages
+  VERSION = '0.2.2'
+end
+

data/seo_landing_pages.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seo_landing_pages/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'html_meta_tags'
+  spec.version       = SeoLandingPages::VERSION
+  spec.authors       = ['Joaquin Rivera Padron']
+  spec.email         = ['joahking@gmail.com']
+  spec.summary       = %q{Manage HTML meta tags in rails admin area to improve SEO.}
+  spec.description   = %q{Manage HTML meta tags in rails admin area to improve SEO, manage their i18n title, description and keywords in Rails easily.}
+  spec.homepage      = 'https://github.com/joahking/html-meta-tags'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '~> 2'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10'
+
+  spec.add_dependency 'railties', '>= 3.2.6', '< 5'
+end
+

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: html_meta_tags
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Joaquin Rivera Padron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Manage HTML meta tags in rails admin area to improve SEO, manage their
+  i18n title, description and keywords in Rails easily.
+email:
+- joahking@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/USAGE
+- lib/generators/seo_landing_pages_generator.rb
+- lib/generators/templates/active_admin.rb
+- lib/generators/templates/i18n.en.yml
+- lib/generators/templates/i18n.es.yml
+- lib/generators/templates/migration.rb
+- lib/seo_landing_pages.rb
+- lib/seo_landing_pages/controllers/helpers.rb
+- lib/seo_landing_pages/helper.rb
+- lib/seo_landing_pages/model.rb
+- lib/seo_landing_pages/version.rb
+- seo_landing_pages.gemspec
+homepage: https://github.com/joahking/html-meta-tags
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2'
+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: Manage HTML meta tags in rails admin area to improve SEO.
+test_files: []