page_meta 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89a7406728480d6a3eb785869d6cae90f32b3bfe2fd3e0f8a6a6ced5c03da4b3
-  data.tar.gz: e5db2e7b705299c0f736164fa5352242e2211a1c6bed9d12802263643cec2930
+  metadata.gz: 732b10b45a16c54c1d95e8f20440bc52cbac065e378e1eed2284c6d99c2f9d47
+  data.tar.gz: 0266ece7ba5fbd03f8e0c9f4b77ff3097192ef8999292342680149b77cd8577c
 SHA512:
-  metadata.gz: e3961943c7d5506baaa3ce0f28d06819dc430aa3c3f38e503324cb52277c1aa2163ef224e4be4f2cfd41fa2e322cc087e0fd6d3680674ccd036e3d9bb6a34c61
-  data.tar.gz: bf19f1d84e6fdcb8ad48b8d44a898d3682316680459c34d661f5844797912fa21f704cde143d6d079ac8d32895be2182c29f58d068df3fa2795e314beab5f11c
+  metadata.gz: a9eef3c915a3d762e53aef9d75ab95c11ccd76d5a2385d07f7159c69cae9e48488295100d36e349369c65cb4e8e255a7d8078c058cd40cbdc5bc0c704de07c05
+  data.tar.gz: a4e04ac623c1e2963b23c747008d7d2e84fac6d4bfda74bf7b516258a2b71e5032e215fce03c89d57f68532e1e336e5239dae9f432b233e4f800ed05ddd1bffe

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

@@ -19,17 +19,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0", "3.1"]
+        ruby: ["3.1", "3.2", "3.3"]
         gemfile:
           - Gemfile
+          - gemfiles/7_1.gemfile
           - gemfiles/7_0.gemfile
           - gemfiles/6_1.gemfile
-          - gemfiles/6_0.gemfile
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: vendor/bundle
           key: >

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
@@ -11,9 +11,6 @@ AllCops:
     - bin/**/*
     - gemfiles/vendor/**/*
 
-Layout/LineLength:
-  Enabled: false
-
 Metrics:
   Enabled: false
 
@@ -22,3 +19,6 @@ Minitest/MultipleAssertions:
 
 Gemspec/DevelopmentDependencies:
   Enabled: false
+
+Minitest/EmptyLineBeforeAssertionMethods:
+  Enabled: false

data/CHANGELOG.md

@@ -11,6 +11,18 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## 1.3.0
+
+- [Added] `page_meta.base` will now set the base url.
+- [Changed] Some tags will be enforced to show up first. It loosely follows 
+  https://rviscomi.github.io/capo.js/user/rules/.
+
+## 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">`

data/README.md

@@ -46,8 +46,8 @@ en:
         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.
+Previously, you could also use the `page_meta.{titles,description,keywords}`
+scopes, but this is now deprecated in favor of the above.
 
 ```yaml
 ---
@@ -112,6 +112,14 @@ en:
         keywords: "myapp, thing, other thing"
 ```
 
+### Defining base url
+
+You can define the base url.
+
+```ruby
+page_meta.base "https://example.com/"
+```
+
 ### Defining meta tags
 
 To define other meta tags, you have to use `PageMeta::Base#tag` like the
@@ -127,6 +135,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 → 7_1.gemfile}

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

data/lib/page_meta/base.rb

@@ -6,11 +6,29 @@ module PageMeta
       language
       charset
       title
+      viewport
       keywords
       description
-      viewport
     ].freeze
 
+    DEFAULT_ORDER = 99
+
+    META_TAG_ORDER = {
+      pragma: -1,
+      cache_control: -1,
+      expires: -1,
+      refresh: -1,
+      dns_prefetch_control: 4
+    }.freeze
+
+    LINK_ORDER = {
+      preconnect: 6,
+      preload: 7,
+      modulepreload: 8,
+      prefetch: 9,
+      dns_prefetch: 10
+    }.freeze
+
     attr_reader :controller, :store
 
     delegate :[], :[]=, to: :store
@@ -21,86 +39,119 @@ module PageMeta
       @store = {}
     end
 
-    def meta_tags
-      @meta_tags ||= {}
+    def items
+      @items ||= []
     end
 
-    def links
-      @links ||= []
+    # Add a new `<base>` tag.
+    def base(href)
+      items << {
+        type: :tag,
+        name: :base,
+        value: {href:},
+        order: 2,
+        open: true
+      }
     end
 
-    def tag(name, value)
-      meta_tags[name] = value
+    # Add a new meta tag.
+    def tag(name, value = nil, order: nil, **kwargs)
+      order = order || META_TAG_ORDER[name] || DEFAULT_ORDER
+      items << {type: :meta, name:, value: value || kwargs, order:}
     end
 
-    def link(rel, options)
-      links << {rel: rel, options: options}
+    # Add a new link tag.
+    def link(rel, order: nil, **options)
+      order = order || LINK_ORDER[rel] || DEFAULT_ORDER
+      items << {type: :link, rel:, options:, order:}
     end
 
+    # Add new html tag, like `<base>` or `<title>`.
+    def html(name, value, open: false, order: DEFAULT_ORDER)
+      items << {type: :tag, name:, order:, open:, value:}
+    end
+
+    # The title translation.
     def title
       @title ||= Translator.new(:titles, naming, store)
     end
 
+    # The description translation.
     def description(html: false)
-      @description[html] ||= Translator.new(:descriptions, naming, store.merge(html: html))
+      @description[html] ||= Translator.new(
+        :descriptions,
+        naming,
+        store.merge(html:)
+      )
     end
 
+    # The keywords translation.
     def keywords
       @keywords ||= Translator.new(:keywords, naming, store)
     end
 
     def render
-      compute_default_meta_tags
-      render_meta_tags + render_links
+      compute_default_items
+
+      items
+        .sort_by { _1[:order] }
+        .map { send(:"build_#{_1[:type]}", _1).render }
+        .join
+        .html_safe
     end
     alias to_s render
 
-    def naming
-      @naming ||= Naming.new(controller)
+    private def build_tag(item)
+      klass = item[:open] ? OpenTag : Tag
+
+      klass.build(item[:name], item[:value])
     end
 
-    def render_meta_tags
-      meta_tags
-        .map {|name, value| MetaTag.build(name, value).render }
-        .join
-        .html_safe
+    private def build_meta(item)
+      MetaTag.build(item[:name], item[:value])
     end
 
-    def render_links
-      links
-        .map {|info| Link.build(info[:rel], info[:options]).render }
-        .join
-        .html_safe
+    private def build_link(item)
+      Link.build(item[:rel], item[:options])
     end
 
-    def compute_default_meta_tags
+    private def naming
+      @naming ||= Naming.new(controller)
+    end
+
+    private def compute_default_items
       DEFAULT_META_TAGS.each do |method_name|
-        public_send("compute_default_#{method_name}")
+        send(:"compute_default_#{method_name}")
       end
     end
 
-    def compute_default_language
+    private def compute_default_language
       tag(:language, I18n.locale)
     end
 
-    def compute_default_title
-      tag(:title, title) unless title.to_s.empty?
+    private def compute_default_title
+      return if title.to_s.blank?
+
+      html(:title, title.to_s, order: 3)
+      tag(:title, title)
     end
 
-    def compute_default_charset
-      tag(:charset, Rails.configuration.encoding)
+    private def compute_default_charset
+      tag(:charset, Rails.configuration.encoding, order: 0)
     end
 
-    def compute_default_keywords
-      tag(:keywords, keywords.to_s) unless keywords.to_s.empty?
+    private def compute_default_keywords
+      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?
+    private def compute_default_description
+      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]
+    private def compute_default_viewport
+      return if items.any? { _1[:name] == :viewport && _1[:type] == :tag }
+
+      tag(:viewport, "width=device-width,initial-scale=1", order: 1)
     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/dns_prefetch_control.rb

@@ -4,8 +4,15 @@ module PageMeta
   class MetaTag
     class DnsPrefetchControl < MetaTag
       def render
-        helpers.tag(:meta, "http-equiv" => "x-dns-prefetch-control", content: "on") +
-          helpers.tag(:link, rel: "dns-prefetch", href: content)
+        meta = helpers.tag(
+          :meta,
+          "http-equiv" => "x-dns-prefetch-control",
+          content: "on"
+        )
+
+        link = helpers.tag(:link, rel: "dns-prefetch", href: content)
+
+        meta + link
       end
     end
   end

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/title.rb

@@ -4,8 +4,7 @@ module PageMeta
   class MetaTag
     class Title < MetaTag
       def render
-        helpers.content_tag(:title, content.to_s) +
-          helpers.tag(:meta, name: "DC.title", content: content.simple) +
+        helpers.tag(:meta, name: "DC.title", content: content.simple) +
           helpers.tag(:meta, itemprop: "name", content: content.simple)
       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,19 @@ module PageMeta
 
     def initialize(name, content)
       @name = name.to_s.dasherize
-      @content = content
+      @raw_content = content
+    end
+
+    def content
+      @content ||= if @raw_content.respond_to?(:call)
+                     @raw_content.call
+                   else
+                     @raw_content
+                   end
     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 +37,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/open_tag.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PageMeta
+  class OpenTag
+    def self.build(tag, attrs)
+      new(tag, attrs)
+    end
+
+    attr_reader :tag, :attrs
+
+    def initialize(tag, attrs)
+      @tag = tag
+      @attrs = attrs
+    end
+
+    def render
+      helpers.tag(tag, attrs)
+    end
+
+    def helpers
+      ActionController::Base.helpers
+    end
+  end
+end

data/lib/page_meta/tag.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PageMeta
+  class Tag
+    def self.build(tag, content)
+      new(tag, content)
+    end
+
+    attr_reader :tag, :content
+
+    def initialize(tag, content)
+      @tag = tag
+      @content = content
+    end
+
+    def render
+      helpers.content_tag(tag, content) unless content.blank?
+    end
+
+    def helpers
+      ActionController::Base.helpers
+    end
+  end
+end

data/lib/page_meta/translator.rb

@@ -14,7 +14,11 @@ module PageMeta
     end
 
     def singular_scope
-      @singular_scope ||= scope == :keywords ? "keywords" : scope.to_s.singularize
+      @singular_scope ||= if scope == :keywords
+                            "keywords"
+                          else
+                            scope.to_s.singularize
+                          end
     end
 
     def to_s

data/lib/page_meta/version.rb

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

data/lib/page_meta.rb

@@ -16,6 +16,8 @@ module PageMeta
   require "page_meta/meta_tag/twitter"
   require "page_meta/link"
   require "page_meta/helpers"
+  require "page_meta/tag"
+  require "page_meta/open_tag"
   require "page_meta/action"
   require "page_meta/naming"
   require "page_meta/translator"

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.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2024-05-17 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: []
@@ -148,9 +148,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/6_0.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
@@ -165,7 +165,9 @@ files:
 - lib/page_meta/meta_tag/title.rb
 - lib/page_meta/meta_tag/twitter.rb
 - lib/page_meta/naming.rb
+- lib/page_meta/open_tag.rb
 - lib/page_meta/railtie.rb
+- lib/page_meta/tag.rb
 - lib/page_meta/translator.rb
 - lib/page_meta/version.rb
 - page_meta.gemspec
@@ -182,14 +184,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.4.5
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Easily define <meta> and <link> tags. I18n support for descriptions, keywords