better_seo 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbb87756b71cdc491faaba16bd349149051ef870ac1eea6dab55c31db3e09bd9
-  data.tar.gz: b34bc18d112710290991d430ff5525b920dadc25938aed97a6e20a3309118d45
+  metadata.gz: 42834acb5d5dca21a12b20288b28544bd5112aac2fe8a05dbf3123707f1f21fe
+  data.tar.gz: 8efa2fd4287fbf0078d57691148c2cdc78e2f03a18c5af2eb96fc6819d32c5d6
 SHA512:
-  metadata.gz: ca7e8d51f6c035725975a2326908156c0e6c5281d4ded7a10fd709775e4aa44208a5a609589fbbaf66c62ef0f54ab4f024b5a685001ab472cb2d1e0bb24097a2
-  data.tar.gz: b353b67665a36f045d2db900d3285996d021ec19db9b5ac7c1fd697ecfa5c4082fc895a3517190f70c79ae7f4f78d9290ab0f79034c3ecdc2da6ad490df20436
+  metadata.gz: 934a6db489cbda29d885011c889d268b66858b9d202d5c561907543365a639547c7e9bc39cd2dc0acc529e4fba4c9f9eb21de10fb76cdb7211c15c4622249073
+  data.tar.gz: d5ceb959972b3e687140a87c87c649525d0844abaffb1ddd316259eaa4cd82b7b5780152a92e06120c8ab7ff46fdce33f1c2449f8f225321a92958f87d8895bc

data/CHANGELOG.md

@@ -7,6 +7,45 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.13.0] - 2025-01-23
+
+### Added
+- Advanced SEO Tools for validation and content management
+  - **Robots.txt Generator** (`BetterSeo::Generators::RobotsTxtGenerator`)
+    - `add_rule(user_agent, allow:, disallow:)` - Add robot directives
+    - `set_crawl_delay(user_agent, seconds)` - Set crawl delay for bots
+    - `add_sitemap(url)` - Add sitemap references
+    - `clear` - Remove all rules and sitemaps
+    - `to_text` - Generate robots.txt content
+    - `write_to_file(path)` - Write robots.txt to file
+    - Support for multiple user agents (*, Googlebot, Bingbot, etc.)
+    - Allow/Disallow path directives
+    - Automatic directory creation
+    - Method chaining for fluent API
+  - **SEO Validator** (`BetterSeo::Validators::SeoValidator`)
+    - `check_title(text)` - Validate title length (30-60 chars optimal)
+    - `check_description(text)` - Validate description length (120-160 chars optimal)
+    - `check_headings(html)` - Validate H1-H6 structure
+    - `check_images(html)` - Validate image alt text presence
+    - `validate_page(html)` - Complete page validation
+    - `generate_report(validation)` - Human-readable SEO report
+    - Overall SEO score (0-100) with weighted components
+    - Detailed issue tracking and recommendations
+    - Warning levels for sub-optimal content
+    - HTML parsing for meta tags extraction
+
+### Enhanced
+- Validators module introduced for SEO quality checks
+- Comprehensive validation rules following SEO best practices
+- Detailed error messages with actionable recommendations
+
+### Test Coverage
+- 858 tests passing (+47 from v0.12.0)
+- 96.7% code coverage (1668/1725 lines)
+- 47 new tests across SEO tools:
+  - Robots.txt Generator: 25 tests
+  - SEO Validator: 22 tests
+
 ## [0.12.0] - 2025-01-23
 
 ### Added

data/README.md

@@ -2,14 +2,14 @@
 
 A comprehensive SEO gem for Ruby and Rails applications. BetterSeo provides a clean, fluent DSL for managing meta tags, Open Graph, Twitter Cards, structured data, sitemaps, and more.
 
-[![Tests](https://img.shields.io/badge/tests-811%20passing-brightgreen)](https://github.com/yourusername/better_seo)
-[![Coverage](https://img.shields.io/badge/coverage-96.41%25-brightgreen)](https://github.com/yourusername/better_seo)
+[![Tests](https://img.shields.io/badge/tests-858%20passing-brightgreen)](https://github.com/yourusername/better_seo)
+[![Coverage](https://img.shields.io/badge/coverage-96.7%25-brightgreen)](https://github.com/yourusername/better_seo)
 [![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.0.0-red)](https://www.ruby-lang.org)
 [![Rails](https://img.shields.io/badge/rails-%3E%3D%206.1-red)](https://rubyonrails.org)
 
 ## Features
 
-### ✅ Implemented (v0.12.0)
+### ✅ Implemented (v0.13.0)
 
 - **Core Configuration System**
   - Singleton configuration with block-style setup
@@ -1793,6 +1793,199 @@ manager.validate! # Raises: "URL is required"
 
 ---
 
+## SEO Tools
+
+### Robots.txt Generator
+
+Generate robots.txt files to control search engine crawler access.
+
+#### Basic Usage
+
+```ruby
+robots = BetterSeo::Generators::RobotsTxtGenerator.new
+
+# Allow all bots except specific paths
+robots.add_rule("*", disallow: ["/admin", "/api/private", "/tmp"])
+
+# Add sitemap
+robots.add_sitemap("https://example.com/sitemap.xml")
+
+# Generate robots.txt content
+text = robots.to_text
+# User-agent: *
+# Disallow: /admin
+# Disallow: /api/private
+# Disallow: /tmp
+#
+# Sitemap: https://example.com/sitemap.xml
+```
+
+#### Multiple User Agents
+
+```ruby
+robots = BetterSeo::Generators::RobotsTxtGenerator.new
+
+# Rules for all bots
+robots.add_rule("*", allow: "/", disallow: "/admin")
+
+# Specific rules for Googlebot
+robots.add_rule("Googlebot", allow: "/api/public", disallow: "/temp")
+
+# Crawl delay for aggressive bots
+robots.add_rule("Bingbot", disallow: "/admin")
+robots.set_crawl_delay("Bingbot", 2)
+
+text = robots.to_text
+```
+
+#### Write to File
+
+```ruby
+robots = BetterSeo::Generators::RobotsTxtGenerator.new
+robots.add_rule("*", disallow: ["/admin", "/private"])
+robots.add_sitemap("https://example.com/sitemap.xml")
+
+# Write to public directory
+robots.write_to_file(Rails.root.join('public', 'robots.txt'))
+```
+
+#### Rails Controller Integration
+
+```ruby
+# app/controllers/robots_controller.rb
+class RobotsController < ApplicationController
+  def index
+    robots = BetterSeo::Generators::RobotsTxtGenerator.new
+
+    if Rails.env.production?
+      robots.add_rule("*", disallow: ["/admin", "/api/private"])
+      robots.add_sitemap("#{request.base_url}/sitemap.xml")
+    else
+      # Block all bots in non-production
+      robots.add_rule("*", disallow: "/")
+    end
+
+    render plain: robots.to_text, content_type: "text/plain"
+  end
+end
+
+# config/routes.rb
+get '/robots.txt', to: 'robots#index'
+```
+
+---
+
+### SEO Validator
+
+Validate and score your pages for SEO best practices.
+
+#### Basic Usage
+
+```ruby
+validator = BetterSeo::Validators::SeoValidator.new
+
+# Check individual elements
+title_result = validator.check_title("My Awesome SEO-Friendly Page Title")
+# => { valid: true, score: 100, message: "Title length is optimal", length: 35 }
+
+desc_result = validator.check_description("This is a comprehensive meta description...")
+# => { valid: true, score: 100, message: "Description length is optimal", length: 145 }
+```
+
+#### Validate Complete Page
+
+```ruby
+validator = BetterSeo::Validators::SeoValidator.new
+
+html = <<~HTML
+  <!DOCTYPE html>
+  <html>
+  <head>
+    <title>Best Ruby SEO Gem for Rails Applications</title>
+    <meta name="description" content="BetterSeo provides comprehensive SEO tools for Ruby on Rails including meta tags, structured data, sitemaps, and validators.">
+  </head>
+  <body>
+    <h1>BetterSeo: Complete SEO Solution</h1>
+    <img src="logo.png" alt="BetterSeo Logo">
+    <h2>Features</h2>
+    <h2>Getting Started</h2>
+  </body>
+  </html>
+HTML
+
+result = validator.validate_page(html)
+# => {
+#   overall_score: 95,
+#   title: { valid: true, score: 100, ... },
+#   description: { valid: true, score: 100, ... },
+#   headings: { valid: true, score: 100, h1_count: 1, ... },
+#   images: { valid: true, score: 100, ... },
+#   issues: []
+# }
+```
+
+#### Generate SEO Report
+
+```ruby
+validator = BetterSeo::Validators::SeoValidator.new
+result = validator.validate_page(html)
+
+report = validator.generate_report(result)
+puts report
+# ============================================================
+# SEO Validation Report
+# ============================================================
+#
+# Overall Score: 95/100
+#
+# Title:
+#   Status: ✓
+#   Score: 100/100
+#   Length: 45 chars
+#   Message: Title length is optimal
+#
+# Description:
+#   Status: ✓
+#   Score: 100/100
+#   ...
+```
+
+#### Rails Integration
+
+```ruby
+# app/services/seo_validator_service.rb
+class SeoValidatorService
+  def self.validate_page_seo(url)
+    html = fetch_page_html(url)
+    validator = BetterSeo::Validators::SeoValidator.new
+    validator.validate_page(html)
+  end
+
+  def self.audit_site
+    pages = Page.published.pluck(:url)
+    validator = BetterSeo::Validators::SeoValidator.new
+
+    results = pages.map do |url|
+      html = fetch_page_html(url)
+      validation = validator.validate_page(html)
+      { url: url, score: validation[:overall_score], issues: validation[:issues] }
+    end
+
+    results.sort_by { |r| r[:score] }
+  end
+end
+```
+
+#### Validation Rules
+
+- **Title**: 30-60 characters optimal
+- **Description**: 120-160 characters optimal
+- **Headings**: Exactly one H1 tag required
+- **Images**: All images must have alt text
+- **Overall Score**: Weighted average (Title: 30%, Description: 30%, Headings: 20%, Images: 20%)
+
+---
+
 ## Configuration Reference
 
 ### Global Configuration

data/lib/better_seo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BetterSeo
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

data/lib/better_seo.rb

@@ -16,6 +16,8 @@ require_relative "better_seo/generators/twitter_cards_generator"
 require_relative "better_seo/generators/breadcrumbs_generator"
 require_relative "better_seo/generators/amp_generator"
 require_relative "better_seo/generators/canonical_url_manager"
+require_relative "better_seo/generators/robots_txt_generator"
+require_relative "better_seo/validators/seo_validator"
 require_relative "better_seo/sitemap/url_entry"
 require_relative "better_seo/sitemap/builder"
 require_relative "better_seo/sitemap/generator"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: better_seo
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - alessiobussolari