page_meta 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0727fb1af7a2848d3cd1e6f2d44efd3c106c44588cd604d9738c0d1b90bdb67d
-  data.tar.gz: fd339b23e757843cab438e5078d17253bcbaca18bf4351082706a2ec81da065d
+  metadata.gz: 6325d31942f9536c2a062706f746f49693cce7328d1c362009e822e80fa89a98
+  data.tar.gz: 942c213fc64a1324345f6ec08eb09c6ca40aabb1331d6960f6e4fa4261a10a80
 SHA512:
-  metadata.gz: 790616651e1425832a679050c2d6c9b1805d4236f88fedcf3b622a0176cf7020be0f78672094b1660417c06c8283dc123a143ae1f666393f0afc4bcee26013d7
-  data.tar.gz: 0c6981527e16056706a51088ad995a70167e8e55c47bd86c7c1613a394aea0835f4b047f642186a883c98c78f903dff905b7e804b63067a4bd838d4416509105
+  metadata.gz: a7fd41a5e0f3639a91f70afd26936ad740ecdcabdceb604b4fb5750f973f3879a76dbe3326d6124c0e786cb09936c8a29cb95245c1c9c161132d7b54a2914144
+  data.tar.gz: d7612bd88688c8ec272e3b2931e6b9d998458f0ef659a3f8697afd8ab0c380d0a2fe8269c8cea1fafafcb2df67c7e8e57e15e79c82a5a3f8a030b820131707bf

data/.github/workflows/ruby-tests.yml

@@ -2,44 +2,42 @@
 name: ruby-tests
 
 on:
-  pull_request:
-    branches:
-      - main
+  pull_request_target:
   push:
     branches:
       - main
-
-  schedule:
-    - cron: "0 10 * * *"
+  workflow_dispatch:
+    inputs: {}
 
 jobs:
   build:
     name: Tests with Ruby ${{ matrix.ruby }} and ${{ matrix.gemfile }}
     runs-on: "ubuntu-latest"
+    if: |
+      github.actor == 'dependabot[bot]' && github.event_name == 'pull_request_target' ||
+      github.actor != 'dependabot[bot]'
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.7.x, 3.0.x]
+        ruby: ["3.1", "3.2", "3.3"]
         gemfile:
           - Gemfile
-          - gemfiles/6.1.gemfile
-          - gemfiles/6.0.gemfile
+          - gemfiles/7_1.gemfile
+          - gemfiles/7_0.gemfile
+          - gemfiles/6_1.gemfile
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: vendor/bundle
           key: >
             ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
             hashFiles(matrix.gemfile) }}
-          restore-keys: >
-            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
-            hashFiles(matrix.gemfile) }}
 
       - name: Set up Ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
 
@@ -53,9 +51,6 @@ jobs:
 
       - name: Run Tests
         env:
-          PGHOST: localhost
-          PGUSER: postgres
           BUNDLE_GEMFILE: ${{ matrix.gemfile }}
         run: |
           bundle exec rake
-          bundle exec rubocop

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /log
+/bin/*

data/.rubocop.yml

@@ -3,7 +3,7 @@ inherit_gem:
   rubocop-fnando: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
   NewCops: enable
   Exclude:
     - test/support/dummy.rb
@@ -16,3 +16,9 @@ Layout/LineLength:
 
 Metrics:
   Enabled: false
+
+Minitest/MultipleAssertions:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false

data/CHANGELOG.md

@@ -11,6 +11,19 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## 1.2.0
+
+- [Added] The meta tag's content can also be any object that responds to the
+  method `call`, like procs.
+- [Fixed] Fixed case where meta tags were being rendered with blank content.
+
+## 1.1.0
+
+- [Added] `<meta name="viewport" content="width=device-width,initial-scale=1">`
+  is now added by default.
+- [Changed] You can now group all translations under
+  `page_meta.controller.action.{title,description,keywords}`.
+
 ## 1.0.0
 
 - Initial release.

data/README.md

@@ -1,7 +1,6 @@
 # page_meta
 
 [![Tests](https://github.com/fnando/page_meta/workflows/ruby-tests/badge.svg)](https://github.com/fnando/page_meta)
-[![Code Climate](https://codeclimate.com/github/fnando/page_meta/badges/gpa.svg)](https://codeclimate.com/github/fnando/page_meta)
 [![Gem](https://img.shields.io/gem/v/page_meta.svg)](https://rubygems.org/gems/page_meta)
 [![Gem](https://img.shields.io/gem/dt/page_meta.svg)](https://rubygems.org/gems/page_meta)
 
@@ -23,13 +22,14 @@ gem "page_meta"
 ## Usage
 
 Your controller and views have an object called `page_meta`. You can use it to
-define meta tags and links. By default, it will include the encoding and
-language meta tags.
+define meta tags and links. By default, it will include the encoding, language
+and viewport meta tags.
 
 ```html
 <meta charset="utf-8" />
 <meta name="language" content="en" />
 <meta itemprop="language" content="en" />
+<meta name="viewport" content="width=device-width,initial-scale=1" />
 ```
 
 You can use I18n to define titles, descriptions and keywords. These values will
@@ -37,15 +37,29 @@ be inferred from the controller and action names. For an action
 `SiteController#index` you'll need the following translation scope:
 
 ```yaml
----
-page_meta:
-  titles:
-    base: "%{value} • MyApp"
+en:
+  page_meta:
+    title_base: "%{value} • MyApp"
+
     site:
-      index: "Welcome to MyApp"
+      index:
+        title: "Welcome to MyApp"
+```
+
+Previously, you could also use the `page_meta.{titles,description,keywords}`
+scopes, but this is now deprecated in favor of the above.
+
+```yaml
+---
+en:
+  page_meta:
+    titles:
+      base: "%{value} • MyApp"
+      site:
+        index: "Welcome to MyApp"
 ```
 
-The title can without the `base` context can be accessed through
+The title without the `base` context can be accessed through
 `page_meta.title.simple`.
 
 ```erb
@@ -60,10 +74,11 @@ I18n placeholders.
 ---
 en:
   page_meta:
-    titles:
-      base: "%{title} • MyCompany"
-      workshops:
-        show: "%{name}"
+    title_base: "%{title} • MyCompany"
+
+    workshops:
+      show:
+        title: "%{name}"
 ```
 
 You can then set dynamic values using the `PageMeta::Base#[]=`.
@@ -89,13 +104,12 @@ The same concept is applied to descriptions and keywords.
 ---
 en:
   page_meta:
-    descriptions:
-      site:
-        home: MyApp is the best way of doing something.
-
-    keywords:
-      site:
-        home: "myapp, thing, other thing"
+    base_title: "%{value} • MyApp"
+    site:
+      show:
+        title: "Show"
+        description: MyApp is the best way of doing something.
+        keywords: "myapp, thing, other thing"
 ```
 
 ### Defining meta tags
@@ -113,6 +127,11 @@ class Workshops Controller < ApplicationController
 end
 ```
 
+> [!TIP]
+>
+> The meta tag's content can also be any object that responds to the method
+> `call`. This way you can lazy evaluate the content.
+
 You can define default meta/link tags in a `before_action`:
 
 ```ruby

data/gemfiles/{6.0.gemfile → 6_1.gemfile}

@@ -3,4 +3,4 @@
 source "https://rubygems.org"
 gemspec path: ".."
 
-gem "rails", "~> 6.0"
+gem "rails", "~> 6.1.0"

data/gemfiles/{6.1.gemfile → 7_0.gemfile}

@@ -3,4 +3,4 @@
 source "https://rubygems.org"
 gemspec path: ".."
 
-gem "rails", "~> 6.1"
+gem "rails", "~> 7.0.0"

data/gemfiles/7_1.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec path: ".."
+
+gem "rails", "~> 7.1.0"

data/lib/page_meta/base.rb

@@ -2,7 +2,14 @@
 
 module PageMeta
   class Base
-    DEFAULT_META_TAGS = %i[language charset title keywords description].freeze
+    DEFAULT_META_TAGS = %i[
+      language
+      charset
+      title
+      keywords
+      description
+      viewport
+    ].freeze
 
     attr_reader :controller, :store
 
@@ -27,7 +34,7 @@ module PageMeta
     end
 
     def link(rel, options)
-      links << {rel: rel, options: options}
+      links << {rel:, options:}
     end
 
     def title
@@ -35,7 +42,7 @@ module PageMeta
     end
 
     def description(html: false)
-      @description[html] ||= Translator.new(:descriptions, naming, store.merge(html: html))
+      @description[html] ||= Translator.new(:descriptions, naming, store.merge(html:))
     end
 
     def keywords
@@ -68,7 +75,7 @@ module PageMeta
 
     def compute_default_meta_tags
       DEFAULT_META_TAGS.each do |method_name|
-        public_send("compute_default_#{method_name}")
+        public_send(:"compute_default_#{method_name}")
       end
     end
 
@@ -77,7 +84,7 @@ module PageMeta
     end
 
     def compute_default_title
-      tag(:title, title) unless title.to_s.empty?
+      tag(:title, title) unless title.to_s.blank?
     end
 
     def compute_default_charset
@@ -85,11 +92,15 @@ module PageMeta
     end
 
     def compute_default_keywords
-      tag(:keywords, keywords.to_s) unless keywords.to_s.empty?
+      tag(:keywords, keywords.to_s) unless keywords.to_s.blank?
     end
 
     def compute_default_description
-      tag(:description, description.to_s) unless description.to_s.empty?
+      tag(:description, description.to_s) unless description.to_s.blank?
+    end
+
+    def compute_default_viewport
+      tag(:viewport, "width=device-width,initial-scale=1") unless meta_tags[:viewport]
     end
   end
 end

data/lib/page_meta/hash_meta_tag.rb

@@ -6,10 +6,18 @@ module PageMeta
       return if content.empty?
 
       content.each_with_object([]) do |(attr, value), buffer|
+        value = value.call if value.respond_to?(:call)
+        value = value.to_s
+
         next if value.blank?
 
         attr = attr.to_s.tr("_", ":")
-        buffer << helpers.tag(:meta, property: "#{base_name}:#{attr}", content: value)
+
+        buffer << helpers.tag(
+          :meta,
+          property: "#{base_name}:#{attr}",
+          content: value
+        )
       end.join
     end
   end

data/lib/page_meta/link.rb

@@ -20,7 +20,7 @@ module PageMeta
     end
 
     def render
-      helpers.tag(:link, options.merge(rel: rel)) unless options.empty?
+      helpers.tag(:link, options.merge(rel:)) unless options.empty?
     end
 
     def helpers

data/lib/page_meta/meta_tag/language.rb

@@ -4,8 +4,8 @@ module PageMeta
   class MetaTag
     class Language < MetaTag
       def render
-        helpers.tag(:meta, name: name, content: content) +
-          helpers.tag(:meta, itemprop: name, content: content)
+        helpers.tag(:meta, name:, content:) +
+          helpers.tag(:meta, itemprop: name, content:)
       end
     end
   end

data/lib/page_meta/meta_tag.rb

@@ -2,7 +2,7 @@
 
 module PageMeta
   class MetaTag
-    attr_reader :name, :content
+    attr_reader :name
 
     def self.build(name, content)
       klass_name = "::PageMeta::MetaTag::#{name.to_s.camelize}"
@@ -16,11 +16,16 @@ module PageMeta
 
     def initialize(name, content)
       @name = name.to_s.dasherize
-      @content = content
+      @raw_content = content
+    end
+
+    def content
+      @content ||=
+        @raw_content.respond_to?(:call) ? @raw_content.call : @raw_content
     end
 
     def render
-      helpers.tag(:meta, name: name, content: content) unless content.empty?
+      helpers.tag(:meta, name:, content:) unless content.blank?
     end
 
     def helpers
@@ -29,18 +34,18 @@ module PageMeta
 
     class MultipleMetaTag < MetaTag
       def render
-        return if content.empty?
+        return if content.blank?
 
-        helpers.tag(:meta, name: name, content: content) +
-          helpers.tag(:meta, itemprop: name, content: content)
+        helpers.tag(:meta, name:, content:) +
+          helpers.tag(:meta, itemprop: name, content:)
       end
     end
 
     class HttpEquiv < MetaTag
       def render
-        return if content.empty?
+        return if content.blank?
 
-        helpers.tag(:meta, "http-equiv" => name, content: content)
+        helpers.tag(:meta, "http-equiv" => name, content:)
       end
     end
 

data/lib/page_meta/naming.rb

@@ -18,7 +18,7 @@ module PageMeta
                       .class
                       .name
                       .underscore
-                      .gsub(/_controller/, "")
+                      .gsub("_controller", "")
                       .tr("/", ".")
     end
   end

data/lib/page_meta/translator.rb

@@ -13,21 +13,38 @@ module PageMeta
       @options = options
     end
 
+    def singular_scope
+      @singular_scope ||= scope == :keywords ? "keywords" : scope.to_s.singularize
+    end
+
     def to_s
       return "" if simple.blank?
 
-      t("page_meta.#{scope}.base", value: simple, default: simple)
+      [
+        t("page_meta.#{scope}.base", value: simple, default: ""),
+        t("page_meta.#{singular_scope}_base", value: simple, default: simple)
+      ].reject(&:blank?).first || ""
     end
 
     def translation_scope
-      "page_meta.#{scope}.#{naming.controller}.#{naming.action}"
+      [
+        "page_meta.#{scope}.#{naming.controller}.#{naming.action}",
+        "page_meta.#{naming.controller}.#{naming.action}.#{singular_scope}"
+      ]
     end
 
     def simple
       override_options = options.merge(default: "")
 
-      translation = t("#{translation_scope}_html", **override_options) if html
-      translation = t(translation_scope, **override_options) if translation.blank?
+      translation = ""
+
+      translation_scope.each do |scope|
+        translation = t("#{scope}_html", **override_options) if html
+        translation = t(scope, **override_options) if translation.blank?
+
+        break if translation.present?
+      end
+
       translation
     end
   end

data/lib/page_meta/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PageMeta
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

data/page_meta.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |spec|
   spec.name          = "page_meta"
   spec.version       = PageMeta::VERSION
   spec.authors       = ["Nando Vieira"]
-  spec.email         = ["fnando.vieira@gmail.com"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.email         = ["me@fnando.com"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
   spec.metadata = {
     "rubygems_mfa_required" => "true"
   }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: page_meta
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-25 00:00:00.000000000 Z
+date: 2024-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -125,7 +125,7 @@ dependencies:
 description: Easily define <meta> and <link> tags. I18n support for descriptions,
   keywords and titles.
 email:
-- fnando.vieira@gmail.com
+- me@fnando.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -139,7 +139,6 @@ files:
 - ".github/workflows/ruby-tests.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -149,8 +148,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/6.0.gemfile
-- gemfiles/6.1.gemfile
+- gemfiles/6_1.gemfile
+- gemfiles/7_0.gemfile
+- gemfiles/7_1.gemfile
 - lib/page_meta.rb
 - lib/page_meta/action.rb
 - lib/page_meta/base.rb
@@ -182,14 +182,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Easily define <meta> and <link> tags. I18n support for descriptions, keywords

data/.travis.yml

@@ -1,20 +0,0 @@
-language: ruby
-cache: bundler
-sudo: false
-rvm:
-  - 2.7.1
-  - 2.6.5
-before_install: gem install bundler --pre
-before_script:
-  - "curl -L
-    https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
-    > ./cc-test-reporter"
-  - chmod +x ./cc-test-reporter
-  - "./cc-test-reporter before-build"
-after_script:
-  - "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
-notifications:
-  email: false
-env:
-  global:
-    secure: pN+1uDJEgbIfpvSmk9owADeqXcQAXzMYMkM6XHR3IgfjbRZ39sBL11EkYziF90boEJPoMkVYmwYuTfGePPN7uWxkDBQJXTEaAXGeuAlQc1Fhzsj0WQZlOcQn1JHYmLtzBVe/B8J4z5ZuQMDFTMe+f2i1qIk00P/R1ozcbz9+g3Pi/5Esf7+6NY2rxQYeEw21/D7WM4UGAOJ+uX6rHdEUo/ej18bUZC8GBxZZy6jVeVqbBE8PPdzNcLkkUu+soPbZVBZiVF2bXn+N3AqXQqA4oL4t7zorG7xU4+2mUldbHRr3HaJBPSwnWzw6mjnSEq6OO77nTOrpwdrkb/Qz/slgL5cuqjlO0MRNq6THdBZT29vCqErxAFs9w4AUoFgwkzMe1mR8ZB8QuUct3xFpAMtE2q35efCuHFb5h682Ske8v0COnzsIRjN1NgSX3nx1oKIh7V9c9O84oDx+W/h0oL2RH/OjW4DcLaVBDS5MhaMZ1ySuBktmqDJD2OqsfbO4Gn+LrWbQAM2RFp2TTROyfDJJU3ITgE7DMqn0QiOcZIoCWzastamGJJs99WzmliouO87ZDSG5Kct2JXml0syyY/jBuR5nnJ9x6TyJpDD9jNMz6LOW9LZ31aOttGbAOQbYVgUgtPkITEuo8xhLCBc6ae+GVA4t8NcJx/rAn1U9E/CXiPs=