better_seo 0.14.0 → 1.0.0.1

data/lib/better_seo/dsl/open_graph.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module BetterSeo
+  module DSL
+    class OpenGraph < Base
+      def title(value = nil)
+        value ? set(:title, value) : get(:title)
+      end
+
+      def description(value = nil)
+        value ? set(:description, value) : get(:description)
+      end
+
+      def type(value = nil)
+        value ? set(:type, value) : get(:type)
+      end
+
+      def url(value = nil)
+        value ? set(:url, value) : get(:url)
+      end
+
+      def image(value = nil)
+        return get(:image) if value.nil?
+
+        if value.is_a?(Hash)
+          set(:image, value)
+        else
+          set(:image, value)
+        end
+      end
+
+      def site_name(value = nil)
+        value ? set(:site_name, value) : get(:site_name)
+      end
+
+      def locale(value = nil)
+        value ? set(:locale, value) : get(:locale)
+      end
+
+      def locale_alternate(*values)
+        values.any? ? set(:locale_alternate, values.flatten) : get(:locale_alternate)
+      end
+
+      def article(&block)
+        if block_given?
+          article_builder = ArticleBuilder.new
+          article_builder.evaluate(&block)
+          set(:article, article_builder.build)
+        else
+          get(:article)
+        end
+      end
+
+      def video(value = nil)
+        return get(:video) if value.nil?
+
+        if value.is_a?(Hash)
+          set(:video, value)
+        else
+          set(:video, value)
+        end
+      end
+
+      def audio(value = nil)
+        value ? set(:audio, value) : get(:audio)
+      end
+
+      protected
+
+      def validate!
+        errors = []
+
+        errors << "og:title is required" unless config[:title]
+        errors << "og:type is required" unless config[:type]
+        errors << "og:image is required" unless config[:image]
+        errors << "og:url is required" unless config[:url]
+
+        raise ValidationError, errors.join(", ") if errors.any?
+      end
+
+      # Article builder for og:article properties
+      class ArticleBuilder < Base
+        def author(value = nil)
+          value ? set(:author, value) : get(:author)
+        end
+
+        def published_time(value = nil)
+          value ? set(:published_time, value) : get(:published_time)
+        end
+
+        def modified_time(value = nil)
+          value ? set(:modified_time, value) : get(:modified_time)
+        end
+
+        def expiration_time(value = nil)
+          value ? set(:expiration_time, value) : get(:expiration_time)
+        end
+
+        def section(value = nil)
+          value ? set(:section, value) : get(:section)
+        end
+
+        def tag(*values)
+          values.any? ? set(:tag, values.flatten) : get(:tag)
+        end
+      end
+    end
+  end
+end

data/lib/better_seo/dsl/twitter_cards.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module BetterSeo
+  module DSL
+    class TwitterCards < Base
+      VALID_CARD_TYPES = %w[summary summary_large_image app player].freeze
+
+      def card(value = nil)
+        value ? set(:card, value) : get(:card)
+      end
+
+      def site(value = nil)
+        return get(:site) if value.nil?
+
+        # Ensure @ prefix
+        value = "@#{value}" unless value.to_s.start_with?("@")
+        set(:site, value)
+      end
+
+      def creator(value = nil)
+        return get(:creator) if value.nil?
+
+        # Ensure @ prefix
+        value = "@#{value}" unless value.to_s.start_with?("@")
+        set(:creator, value)
+      end
+
+      def title(value = nil)
+        value ? set(:title, value) : get(:title)
+      end
+
+      def description(value = nil)
+        value ? set(:description, value) : get(:description)
+      end
+
+      def image(value = nil)
+        return get(:image) if value.nil?
+
+        if value.is_a?(Hash)
+          set(:image, value)
+        else
+          set(:image, value)
+        end
+      end
+
+      def image_alt(value = nil)
+        value ? set(:image_alt, value) : get(:image_alt)
+      end
+
+      # Player card properties
+      def player(value = nil)
+        value ? set(:player, value) : get(:player)
+      end
+
+      def player_width(value = nil)
+        value ? set(:player_width, value) : get(:player_width)
+      end
+
+      def player_height(value = nil)
+        value ? set(:player_height, value) : get(:player_height)
+      end
+
+      def player_stream(value = nil)
+        value ? set(:player_stream, value) : get(:player_stream)
+      end
+
+      # App card properties
+      def app_name(value = nil, platform: nil)
+        return get(:app_name) if value.nil?
+
+        if platform
+          current = get(:app_name) || {}
+          set(:app_name, current.merge(platform => value))
+        else
+          # Set for all platforms
+          set(:app_name, {
+            iphone: value,
+            ipad: value,
+            googleplay: value
+          })
+        end
+      end
+
+      def app_id(value = nil, platform: nil)
+        return get(:app_id) if value.nil?
+
+        current = get(:app_id) || {}
+        set(:app_id, current.merge(platform => value))
+      end
+
+      def app_url(value = nil, platform: nil)
+        return get(:app_url) if value.nil?
+
+        current = get(:app_url) || {}
+        set(:app_url, current.merge(platform => value))
+      end
+
+      protected
+
+      def validate!
+        errors = []
+
+        # Validate card type
+        card_type = config[:card]
+        if card_type && !VALID_CARD_TYPES.include?(card_type)
+          errors << "Invalid card type: #{card_type}. Valid types: #{VALID_CARD_TYPES.join(", ")}"
+        end
+
+        # Validate required fields
+        errors << "twitter:title is required" unless config[:title]
+        errors << "twitter:description is required" unless config[:description]
+
+        # Validate image for summary_large_image
+        if card_type == "summary_large_image" && !config[:image]
+          errors << "twitter:image is required for summary_large_image card"
+        end
+
+        # Validate lengths
+        if config[:title] && config[:title].length > 70
+          errors << "Title too long (#{config[:title].length} chars, max 70 recommended)"
+        end
+
+        if config[:description] && config[:description].length > 200
+          errors << "Description too long (#{config[:description].length} chars, max 200 recommended)"
+        end
+
+        raise ValidationError, errors.join(", ") if errors.any?
+      end
+    end
+  end
+end

data/lib/better_seo/errors.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module BetterSeo
+  # Base error class
+  class Error < StandardError; end
+
+  # Configuration errors
+  class ConfigurationError < Error; end
+  class ValidationError < Error; end
+
+  # DSL errors
+  class DSLError < Error; end
+  class InvalidBuilderError < DSLError; end
+
+  # Generator errors
+  class GeneratorError < Error; end
+  class TemplateNotFoundError < GeneratorError; end
+
+  # Validator errors
+  class ValidatorError < Error; end
+  class InvalidDataError < ValidatorError; end
+
+  # Image errors
+  class ImageError < Error; end
+  class ImageConversionError < ImageError; end
+  class ImageValidationError < ImageError; end
+
+  # I18n errors
+  class I18nError < Error; end
+  class MissingTranslationError < I18nError; end
+end

data/lib/better_seo/generators/amp_generator.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "json"
+
+module BetterSeo
+  module Generators
+    class AmpGenerator
+      attr_accessor :canonical_url, :title, :description, :image, :structured_data
+
+      def initialize(canonical_url: nil, title: nil, description: nil, image: nil, structured_data: nil)
+        @canonical_url = canonical_url
+        @title = title
+        @description = description
+        @image = image
+        @structured_data = structured_data
+      end
+
+      # Generate AMP boilerplate CSS
+      def to_boilerplate
+        boilerplate = <<~HTML
+          <style amp-boilerplate>body{-webkit-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-moz-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-ms-animation:-amp-start 8s steps(1,end) 0s 1 normal both;animation:-amp-start 8s steps(1,end) 0s 1 normal both}@-webkit-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-moz-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-ms-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-o-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}</style><noscript><style amp-boilerplate>body{-webkit-animation:none;-moz-animation:none;-ms-animation:none;animation:none}</style></noscript>
+        HTML
+        boilerplate.strip
+      end
+
+      # Generate AMP runtime script tag
+      def to_amp_script_tag
+        '<script async src="https://cdn.ampproject.org/v0.js"></script>'
+      end
+
+      # Generate meta tags for AMP page
+      def to_meta_tags
+        tags = []
+
+        if @canonical_url
+          tags << %(<link rel="canonical" href="#{escape_html(@canonical_url)}">)
+        end
+
+        if @title
+          tags << %(<meta property="og:title" content="#{escape_html(@title)}">)
+        end
+
+        if @description
+          tags << %(<meta name="description" content="#{escape_html(@description)}">)
+          tags << %(<meta property="og:description" content="#{escape_html(@description)}">)
+        end
+
+        if @image
+          tags << %(<meta property="og:image" content="#{escape_html(@image)}">)
+        end
+
+        tags.join("\n")
+      end
+
+      # Generate structured data script tag
+      def to_structured_data
+        return "" unless @structured_data
+
+        %(<script type="application/ld+json">\n#{JSON.generate(@structured_data)}\n</script>)
+      end
+
+      # Wrap custom CSS in amp-custom style tag
+      def to_custom_css(css)
+        return "" if css.nil? || css.empty?
+
+        %(<style amp-custom>\n#{css}\n</style>)
+      end
+
+      private
+
+      def escape_html(text)
+        return "" if text.nil?
+
+        text.to_s
+          .gsub("&", "&amp;")
+          .gsub("<", "&lt;")
+          .gsub(">", "&gt;")
+          .gsub('"', "&quot;")
+          .gsub("'", "&#39;")
+      end
+    end
+  end
+end

data/lib/better_seo/generators/breadcrumbs_generator.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require "json"
+
+module BetterSeo
+  module Generators
+    class BreadcrumbsGenerator
+      attr_reader :items
+
+      def initialize
+        @items = []
+      end
+
+      # Add single breadcrumb item
+      def add_item(name, url)
+        @items << { name: name, url: url }
+        self
+      end
+
+      # Add multiple items from array
+      def add_items(items_array)
+        items_array.each do |item|
+          add_item(item[:name], item[:url])
+        end
+        self
+      end
+
+      # Clear all items
+      def clear
+        @items = []
+        self
+      end
+
+      # Generate HTML breadcrumbs
+      def to_html(schema: false, nav_class: "breadcrumb", list_class: "breadcrumb")
+        return "" if @items.empty?
+
+        html = []
+
+        if schema
+          html << %(<nav class="#{escape_html(nav_class)}" aria-label="breadcrumb" itemscope itemtype="https://schema.org/BreadcrumbList">)
+        else
+          html << %(<nav class="#{escape_html(nav_class)}" aria-label="breadcrumb">)
+        end
+
+        html << %(  <ol class="#{escape_html(list_class)}">)
+
+        @items.each_with_index do |item, index|
+          if schema
+            html << %(    <li class="breadcrumb-item#{item[:url].nil? ? " active" : ""}" itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem"#{item[:url].nil? ? ' aria-current="page"' : ""}>)
+          else
+            html << %(    <li class="breadcrumb-item#{item[:url].nil? ? " active" : ""}"#{item[:url].nil? ? ' aria-current="page"' : ""}>)
+          end
+
+          if item[:url]
+            if schema
+              html << %(      <a href="#{escape_html(item[:url])}" itemprop="item">)
+              html << %(        <span itemprop="name">#{escape_html(item[:name])}</span>)
+              html << %(      </a>)
+              html << %(      <meta itemprop="position" content="#{index + 1}" />)
+            else
+              html << %(      <a href="#{escape_html(item[:url])}">#{escape_html(item[:name])}</a>)
+            end
+          else
+            if schema
+              html << %(      <span itemprop="name">#{escape_html(item[:name])}</span>)
+              html << %(      <meta itemprop="position" content="#{index + 1}" />)
+            else
+              html << %(      #{escape_html(item[:name])})
+            end
+          end
+
+          html << %(    </li>)
+        end
+
+        html << %(  </ol>)
+        html << %(</nav>)
+
+        html.join("\n")
+      end
+
+      # Generate JSON-LD structured data
+      def to_json_ld
+        return "" if @items.empty?
+
+        data = {
+          "@context" => "https://schema.org",
+          "@type" => "BreadcrumbList",
+          "itemListElement" => []
+        }
+
+        @items.each_with_index do |item, index|
+          list_item = {
+            "@type" => "ListItem",
+            "position" => index + 1,
+            "name" => item[:name]
+          }
+          list_item["item"] = item[:url] if item[:url]
+          data["itemListElement"] << list_item
+        end
+
+        JSON.generate(data)
+      end
+
+      # Generate script tag with JSON-LD
+      def to_script_tag
+        return "" if @items.empty?
+
+        %(<script type="application/ld+json">\n#{to_json_ld}\n</script>)
+      end
+
+      private
+
+      def escape_html(text)
+        return "" if text.nil?
+
+        text.to_s
+          .gsub("&", "&amp;")
+          .gsub("<", "&lt;")
+          .gsub(">", "&gt;")
+          .gsub('"', "&quot;")
+          .gsub("'", "&#39;")
+      end
+    end
+  end
+end

data/lib/better_seo/generators/canonical_url_manager.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module BetterSeo
+  module Generators
+    class CanonicalUrlManager
+      attr_reader :url
+      attr_accessor :remove_query_params, :lowercase
+
+      def initialize(url = nil)
+        @remove_query_params = false
+        @lowercase = false
+        self.url = url if url
+      end
+
+      def url=(value)
+        return @url = nil if value.nil?
+
+        @url = normalize_url(value)
+      end
+
+      # Generate canonical link HTML tag
+      def to_html
+        return "" unless @url
+
+        %(<link rel="canonical" href="#{escape_html(@url)}">)
+      end
+
+      # Generate Link HTTP header
+      def to_http_header
+        return "" unless @url
+
+        %(<#{@url}>; rel="canonical")
+      end
+
+      # Validate the canonical URL
+      def validate!
+        raise ValidationError, "URL is required" if @url.nil? || @url.empty?
+
+        begin
+          uri = URI.parse(@url)
+
+          # Check if it's a relative URL
+          unless uri.absolute?
+            raise ValidationError, "Canonical URL must be absolute: #{@url}"
+          end
+
+          # Check if it's HTTP or HTTPS
+          unless uri.is_a?(URI::HTTP) || uri.is_a?(URI::HTTPS)
+            raise ValidationError, "Invalid URL format: #{@url}"
+          end
+        rescue URI::InvalidURIError
+          raise ValidationError, "Invalid URL format: #{@url}"
+        end
+
+        true
+      end
+
+      private
+
+      def normalize_url(url)
+        return url if url.empty?
+
+        normalized = url.dup
+
+        # Parse URL
+        begin
+          uri = URI.parse(normalized)
+        rescue URI::InvalidURIError
+          return normalized
+        end
+
+        # Remove fragment identifier
+        uri.fragment = nil
+
+        # Remove query parameters if configured
+        uri.query = nil if @remove_query_params
+
+        # Rebuild URL
+        normalized = uri.to_s
+
+        # Remove trailing slash (except for root URL)
+        if normalized.end_with?("/") && normalized.count("/") > 3
+          normalized = normalized[0...-1]
+        end
+
+        # Lowercase if configured
+        normalized = normalized.downcase if @lowercase
+
+        normalized
+      end
+
+      def escape_html(text)
+        return "" if text.nil?
+
+        text.to_s
+          .gsub("&", "&amp;")
+          .gsub("<", "&lt;")
+          .gsub(">", "&gt;")
+          .gsub('"', "&quot;")
+          .gsub("'", "&#39;")
+      end
+    end
+  end
+end

data/lib/better_seo/generators/meta_tags_generator.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module BetterSeo
+  module Generators
+    class MetaTagsGenerator
+      def initialize(config)
+        @config = config
+      end
+
+      def generate
+        tags = []
+        tags << charset_tag
+        tags << viewport_tag
+        tags << title_tag
+        tags << description_tag
+        tags << keywords_tag
+        tags << author_tag
+        tags << robots_tag
+        tags << canonical_tag
+
+        tags.compact.join("\n")
+      end
+
+      def charset_tag
+        return nil unless @config[:charset]
+
+        %(<meta charset="#{escape(@config[:charset])}">)
+      end
+
+      def viewport_tag
+        return nil unless @config[:viewport]
+
+        %(<meta name="viewport" content="#{escape(@config[:viewport])}">)
+      end
+
+      def title_tag
+        return nil unless @config[:title]
+
+        %(<title>#{escape(@config[:title])}</title>)
+      end
+
+      def description_tag
+        return nil unless @config[:description]
+
+        %(<meta name="description" content="#{escape(@config[:description])}">)
+      end
+
+      def keywords_tag
+        keywords = @config[:keywords]
+        return nil unless keywords && keywords.any?
+
+        keywords_str = Array(keywords).join(", ")
+        %(<meta name="keywords" content="#{escape(keywords_str)}">)
+      end
+
+      def author_tag
+        return nil unless @config[:author]
+
+        %(<meta name="author" content="#{escape(@config[:author])}">)
+      end
+
+      def canonical_tag
+        return nil unless @config[:canonical]
+
+        %(<link rel="canonical" href="#{escape(@config[:canonical])}">)
+      end
+
+      def robots_tag
+        robots = @config[:robots]
+        return nil unless robots
+
+        directives = []
+
+        # Index/noindex
+        directives << (robots[:index] ? "index" : "noindex")
+
+        # Follow/nofollow
+        directives << (robots[:follow] ? "follow" : "nofollow")
+
+        # Additional directives
+        robots.each do |key, value|
+          next if [:index, :follow].include?(key)
+          directives << key.to_s if value
+        end
+
+        %(<meta name="robots" content="#{directives.join(", ")}">)
+      end
+
+      private
+
+      def escape(text)
+        text.to_s
+          .gsub("&", "&amp;")
+          .gsub('"', "&quot;")
+          .gsub("<", "&lt;")
+          .gsub(">", "&gt;")
+      end
+    end
+  end
+end