page_meta 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6325d31942f9536c2a062706f746f49693cce7328d1c362009e822e80fa89a98
-  data.tar.gz: 942c213fc64a1324345f6ec08eb09c6ca40aabb1331d6960f6e4fa4261a10a80
+  metadata.gz: 732b10b45a16c54c1d95e8f20440bc52cbac065e378e1eed2284c6d99c2f9d47
+  data.tar.gz: 0266ece7ba5fbd03f8e0c9f4b77ff3097192ef8999292342680149b77cd8577c
 SHA512:
-  metadata.gz: a7fd41a5e0f3639a91f70afd26936ad740ecdcabdceb604b4fb5750f973f3879a76dbe3326d6124c0e786cb09936c8a29cb95245c1c9c161132d7b54a2914144
-  data.tar.gz: d7612bd88688c8ec272e3b2931e6b9d998458f0ef659a3f8697afd8ab0c380d0a2fe8269c8cea1fafafcb2df67c7e8e57e15e79c82a5a3f8a030b820131707bf
+  metadata.gz: a9eef3c915a3d762e53aef9d75ab95c11ccd76d5a2385d07f7159c69cae9e48488295100d36e349369c65cb4e8e255a7d8078c058cd40cbdc5bc0c704de07c05
+  data.tar.gz: a4e04ac623c1e2963b23c747008d7d2e84fac6d4bfda74bf7b516258a2b71e5032e215fce03c89d57f68532e1e336e5239dae9f432b233e4f800ed05ddd1bffe

data/.rubocop.yml

@@ -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,12 @@ 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

data/README.md

@@ -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

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:, 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:))
+      @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.blank?
+    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
+    private def compute_default_keywords
       tag(:keywords, keywords.to_s) unless keywords.to_s.blank?
     end
 
-    def compute_default_description
+    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/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/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

@@ -20,8 +20,11 @@ module PageMeta
     end
 
     def content
-      @content ||=
-        @raw_content.respond_to?(:call) ? @raw_content.call : @raw_content
+      @content ||= if @raw_content.respond_to?(:call)
+                     @raw_content.call
+                   else
+                     @raw_content
+                   end
     end
 
     def render

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.2.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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: page_meta
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-16 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -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