better_seo 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96812d57f991f56ae85d042ed90d67cd804da41be917f557c9035b7103704fa0
-  data.tar.gz: ba04b33847262251dbce411840acee273e7f36c3f25e3b02a6fd2aaacf88bbe9
+  metadata.gz: 5c5febaa764505c7680d89bd6858600708fbd362d811818c7206b6e8f8768b32
+  data.tar.gz: 7a6928082bed979115b7411049182fbd6591ac0156fa5670a9cadb843d3b23d8
 SHA512:
-  metadata.gz: 587ba80330156dc5a305ea2d92831939fa9f80b6341bdb1052d639d371b8892d9827ddd0ce24b4b07c0c67714aec87151dcc31bc515031aee055a10703d3bf0f
-  data.tar.gz: 8dfe3c3526d621ee904535484e70529c68550d2388f289408a40f044651f154f6cb424f8715967d3d9dcaf8aa652f48bdb0ddda1e505c882c37f8fe01c9a1dbc
+  metadata.gz: 8a4c80163add6a90ddabb694ec95c6defddf0ef4a3357bc0e3defc2ea4cb3ace4556bec7f5303571dbc72caf860f0092f54c43e61a4f8a70f573b88d6d39b146
+  data.tar.gz: 9abc8a475e9380e85b0a410547f63eca11682f21b0271acbab83a6f855212c888c3a937d9db5358e0518697acb3af61d9e852060a0f871dd80b86c313eb43916

data/CHANGELOG.md

@@ -7,6 +7,73 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.7.0] - 2025-01-23
+
+### Added
+- Additional Structured Data types for e-commerce and navigation
+  - `StructuredData::Product` - E-commerce products with comprehensive schema
+  - `StructuredData::BreadcrumbList` - Navigation breadcrumbs for site structure
+- Product features
+  - Full product information (name, description, image, brand)
+  - SKU, GTIN, MPN identifiers support
+  - Offers with price, currency, availability (InStock, OutOfStock, PreOrder, etc.)
+  - Multiple offers support for variants
+  - Aggregate ratings with review count
+  - Individual reviews with author and rating
+  - Multiple reviews array support
+  - Availability URL mapping to Schema.org standards
+- BreadcrumbList features
+  - Add single items with `add_item`
+  - Add multiple items with `add_items`
+  - Automatic position numbering
+  - Manual position override support
+  - Clear all items with `clear`
+  - Fluent method chaining
+  - Generates proper ListItem structure
+- Generator helper methods
+  - `Generator.product` factory method with block support
+  - `Generator.breadcrumb_list` factory method
+- Rails integration examples
+  - Product page structured data helpers
+  - Breadcrumb integration with Rails routes
+  - E-commerce view helpers
+
+### Test Coverage
+- 530 tests passing (+39 from v0.6.0)
+- 98.89% code coverage (894/904 lines)
+- 39 new tests for Product and BreadcrumbList
+
+## [0.6.0] - 2025-01-23
+
+### Added
+- Structured Data (JSON-LD) support with comprehensive Schema.org implementation
+  - `StructuredData::Base` - Generic base class for all structured data types
+  - `StructuredData::Organization` - Company/organization information with full schema support
+  - `StructuredData::Article` - Blog posts, news articles with author/publisher metadata
+  - `StructuredData::Person` - Author profiles, team members with social links
+  - `StructuredData::Generator` - Helper class with factory methods
+- Structured data features
+  - Fluent API with method chaining for all types
+  - Automatic nested object handling (Person within Article, etc.)
+  - JSON-LD generation with `to_json` and `to_script_tag` methods
+  - Schema.org compliant output format
+  - Address handling with PostalAddress schema
+  - Social profile links with sameAs property
+- Rails integration patterns
+  - View helpers for structured data
+  - Layout integration examples
+  - Complete production examples
+- Comprehensive documentation
+  - 300+ lines of structured data documentation in README
+  - Complete examples for Organization, Article, Person
+  - Rails integration patterns and helper methods
+  - Nested data examples
+
+### Test Coverage
+- 491 tests passing (+107 from v0.5.0)
+- 99.64% code coverage (820/823 lines)
+- 117 new tests for structured data functionality
+
 ## [0.5.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-384%20passing-brightgreen)](https://github.com/yourusername/better_seo)
-[![Coverage](https://img.shields.io/badge/coverage-99.71%25-brightgreen)](https://github.com/yourusername/better_seo)
+[![Tests](https://img.shields.io/badge/tests-530%20passing-brightgreen)](https://github.com/yourusername/better_seo)
+[![Coverage](https://img.shields.io/badge/coverage-98.89%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.5.0)
+### ✅ Implemented (v0.7.0)
 
 - **Core Configuration System**
   - Singleton configuration with block-style setup
@@ -48,19 +48,39 @@ A comprehensive SEO gem for Ruby and Rails applications. BetterSeo provides a cl
   - **Validation**: Automatic URL validation (format, protocol)
   - **Method Chaining**: Fluent interface for adding multiple URLs
 
+- **Structured Data (JSON-LD)**
+  - **Base Class**: Generic structured data with full Schema.org support
+  - **Organization**: Company/organization information with address, social profiles
+  - **Article**: Blog posts, news articles with author, publisher, metadata
+  - **Person**: Author profiles, team members with job title, social links
+  - **Product**: E-commerce products with price, availability, ratings, reviews
+  - **BreadcrumbList**: Navigation breadcrumbs for improved site structure
+  - **Generator Helper**: Factory methods and batch script tag generation
+  - **Nested Data**: Automatic handling of complex object relationships
+  - **JSON-LD Output**: Valid Schema.org JSON-LD format
+  - **Rails Integration**: View helpers and layout integration
+
 ### 🚧 Planned
 
-- **Advanced Generators** (v0.6.0)
-  - Schema.org JSON-LD generator
-  - Breadcrumbs generator
+- **Additional Structured Data Types** (v0.8.0)
+  - LocalBusiness (physical locations with hours, geo)
+  - Event (conferences, webinars with dates, location)
+  - FAQPage (structured FAQ with questions/answers)
+  - HowTo (step-by-step guides)
+  - Recipe (cooking recipes with ingredients)
+
+- **Advanced Generators** (v0.7.0)
+  - Breadcrumbs HTML generator
   - AMP HTML generator
+  - Canonical URL management
 
-- **Advanced Rails Integration** (v0.6.0)
+- **Advanced Rails Integration** (v0.7.0)
   - Controller helpers for setting page SEO
   - Railtie for automatic initialization
   - Generator for initializer file
+  - Automatic meta tags from model attributes
 
-- **Advanced Sitemap Features** (v0.6.0)
+- **Advanced Sitemap Features** (v0.7.0)
   - Multi-language sitemap support (hreflang)
   - Sitemap index for large sites (50,000+ URLs)
   - Image/video sitemap extensions
@@ -79,7 +99,7 @@ A comprehensive SEO gem for Ruby and Rails applications. BetterSeo provides a cl
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'better_seo', '~> 0.5.0'
+gem 'better_seo', '~> 0.7.0'
 ```
 
 And then execute:
@@ -99,7 +119,7 @@ gem install better_seo
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'better_seo', git: 'https://github.com/alessiobussolari/better_seo.git', tag: 'v0.5.0'
+gem 'better_seo', git: 'https://github.com/alessiobussolari/better_seo.git', tag: 'v0.7.0'
 ```
 
 Or clone and build locally:
@@ -108,7 +128,7 @@ Or clone and build locally:
 git clone https://github.com/alessiobussolari/better_seo.git
 cd better_seo
 gem build better_seo.gemspec
-gem install better_seo-0.5.0.gem
+gem install better_seo-0.7.0.gem
 ```
 
 ## Quick Start
@@ -1020,6 +1040,335 @@ end
 # SitemapGeneratorService.generate
 ```
 
+### 7. Structured Data (JSON-LD)
+
+BetterSeo provides comprehensive support for Schema.org structured data using JSON-LD format, helping search engines better understand your content.
+
+#### Basic Usage
+
+Create structured data objects and generate JSON-LD script tags:
+
+```ruby
+# Create an Organization
+org = BetterSeo::StructuredData::Organization.new
+org.name("Acme Corporation")
+org.url("https://www.acme.com")
+org.logo("https://www.acme.com/logo.png")
+org.description("Leading provider of innovative solutions")
+
+# Generate JSON-LD script tag
+org.to_script_tag
+# <script type="application/ld+json">
+# {
+#   "@context": "https://schema.org",
+#   "@type": "Organization",
+#   "name": "Acme Corporation",
+#   ...
+# }
+# </script>
+```
+
+#### Available Types
+
+**Organization** - Company/organization information:
+
+```ruby
+org = BetterSeo::StructuredData::Organization.new
+org.name("Tech Innovations Inc")
+org.url("https://techinnovations.com")
+org.logo("https://techinnovations.com/logo.png")
+org.description("Innovative technology solutions")
+org.email("contact@techinnovations.com")
+org.telephone("+1-555-0100")
+org.address(
+  street: "123 Tech Boulevard",
+  city: "San Francisco",
+  region: "CA",
+  postal_code: "94105",
+  country: "US"
+)
+org.same_as([
+  "https://twitter.com/techinnovations",
+  "https://linkedin.com/company/techinnovations"
+])
+org.founding_date("2015-03-20")
+```
+
+**Article** - Blog posts, news articles, content:
+
+```ruby
+article = BetterSeo::StructuredData::Article.new
+article.headline("The Future of Web Development")
+article.description("An in-depth analysis of emerging trends")
+article.image("https://example.com/article-image.jpg")
+article.author("Jane Smith")  # Or use Person object
+article.date_published("2024-01-15T09:00:00Z")
+article.date_modified("2024-01-20T14:30:00Z")
+article.url("https://example.com/articles/future-of-web-dev")
+article.word_count(2500)
+article.keywords(["Web Development", "Technology", "Trends"])
+article.article_section("Technology")
+```
+
+**Person** - Author profiles, team members:
+
+```ruby
+person = BetterSeo::StructuredData::Person.new
+person.name("Dr. Jane Smith")
+person.given_name("Jane")
+person.family_name("Smith")
+person.email("jane@example.com")
+person.url("https://janesmith.dev")
+person.image("https://janesmith.dev/profile.jpg")
+person.job_title("Chief Technology Officer")
+person.telephone("+1-555-0199")
+person.same_as([
+  "https://twitter.com/janesmith",
+  "https://linkedin.com/in/janesmith"
+])
+```
+
+**Product** - E-commerce products:
+
+```ruby
+product = BetterSeo::StructuredData::Product.new
+product.name("Premium Wireless Headphones")
+product.description("High-quality wireless headphones with noise cancellation")
+product.image("https://example.com/headphones.jpg")
+product.brand("AudioTech")
+product.sku("HEADPHONES-WL-NC-2024")
+product.offers(
+  price: 299.99,
+  price_currency: "USD",
+  availability: "InStock",
+  url: "https://example.com/products/headphones"
+)
+product.aggregate_rating(
+  rating_value: 4.7,
+  review_count: 342
+)
+```
+
+**BreadcrumbList** - Navigation breadcrumbs:
+
+```ruby
+breadcrumb = BetterSeo::StructuredData::BreadcrumbList.new
+breadcrumb
+  .add_item(name: "Home", url: "https://example.com")
+  .add_item(name: "Electronics", url: "https://example.com/electronics")
+  .add_item(name: "Headphones", url: "https://example.com/electronics/headphones")
+```
+
+#### Method Chaining
+
+All structured data classes support fluent method chaining:
+
+```ruby
+org = BetterSeo::StructuredData::Organization.new
+  .name("Acme Corp")
+  .url("https://acme.com")
+  .logo("https://acme.com/logo.png")
+  .description("Innovation at its finest")
+```
+
+#### Nested Structured Data
+
+Combine multiple structured data objects:
+
+```ruby
+# Create publisher organization
+publisher = BetterSeo::StructuredData::Organization.new
+publisher.name("Tech Publishing Co")
+publisher.logo("https://techpub.com/logo.png")
+
+# Create author person
+author = BetterSeo::StructuredData::Person.new
+author.name("Jane Smith")
+author.email("jane@techpub.com")
+author.url("https://janesmith.dev")
+
+# Create article with nested data
+article = BetterSeo::StructuredData::Article.new
+article.headline("Introduction to Ruby on Rails")
+article.description("A comprehensive guide for beginners")
+article.image("https://example.com/rails-guide.jpg")
+article.author(author)  # Nested Person
+article.publisher(publisher)  # Nested Organization
+article.date_published("2024-01-15")
+
+# Generates nested JSON-LD automatically
+article.to_script_tag
+```
+
+#### Using the Generator Helper
+
+The Generator class provides convenient factory methods:
+
+```ruby
+# Create with block
+org = BetterSeo::StructuredData::Generator.organization do |o|
+  o.name("Acme Corp")
+  o.url("https://acme.com")
+  o.logo("https://acme.com/logo.png")
+end
+
+article = BetterSeo::StructuredData::Generator.article do |a|
+  a.headline("Amazing Article")
+  a.author("John Doe")
+  a.date_published("2024-01-15")
+end
+
+person = BetterSeo::StructuredData::Generator.person do |p|
+  p.name("John Doe")
+  p.email("john@example.com")
+end
+
+# Generate multiple script tags at once
+tags = BetterSeo::StructuredData::Generator.generate_script_tags([org, article, person])
+# Returns all three script tags joined with newlines
+```
+
+#### Rails Integration
+
+Add structured data to your Rails views:
+
+```erb
+<%# app/views/articles/show.html.erb %>
+<%
+  author = BetterSeo::StructuredData::Generator.person do |p|
+    p.name(@article.author.name)
+    p.email(@article.author.email)
+    p.url(@article.author.website)
+  end
+
+  article_sd = BetterSeo::StructuredData::Generator.article do |a|
+    a.headline(@article.title)
+    a.description(@article.excerpt)
+    a.image(url_for(@article.cover_image))
+    a.author(author)
+    a.date_published(@article.published_at.iso8601)
+    a.date_modified(@article.updated_at.iso8601)
+    a.url(article_url(@article))
+    a.word_count(@article.word_count)
+    a.keywords(@article.tags.pluck(:name))
+  end
+%>
+
+<%== article_sd.to_script_tag %>
+```
+
+Or in a helper:
+
+```ruby
+# app/helpers/structured_data_helper.rb
+module StructuredDataHelper
+  def article_structured_data(article)
+    author = BetterSeo::StructuredData::Generator.person do |p|
+      p.name(article.author.name)
+      p.url(author_url(article.author))
+    end
+
+    article_sd = BetterSeo::StructuredData::Generator.article do |a|
+      a.headline(article.title)
+      a.description(article.excerpt)
+      a.author(author)
+      a.date_published(article.published_at.iso8601)
+      a.url(article_url(article))
+    end
+
+    article_sd.to_script_tag.html_safe
+  end
+
+  def organization_structured_data
+    org = BetterSeo::StructuredData::Generator.organization do |o|
+      o.name(Rails.application.config.site_name)
+      o.url(root_url)
+      o.logo(image_url('logo.png'))
+      o.same_as([
+        "https://twitter.com/yourcompany",
+        "https://facebook.com/yourcompany"
+      ])
+    end
+
+    org.to_script_tag.html_safe
+  end
+end
+```
+
+Then in your layout:
+
+```erb
+<%# app/views/layouts/application.html.erb %>
+<head>
+  ...
+  <%= organization_structured_data %>
+</head>
+```
+
+And in article views:
+
+```erb
+<%# app/views/articles/show.html.erb %>
+<%= article_structured_data(@article) %>
+```
+
+#### Complete Example
+
+```ruby
+# Create complete structured data for a blog article
+publisher = BetterSeo::StructuredData::Generator.organization do |o|
+  o.name("Tech Blog Publishing")
+  o.url("https://techblog.com")
+  o.logo("https://techblog.com/logo.png")
+end
+
+author = BetterSeo::StructuredData::Generator.person do |p|
+  p.name("Dr. Sarah Johnson")
+  p.email("sarah@techblog.com")
+  p.url("https://sarahjohnson.dev")
+  p.job_title("Senior Technology Writer")
+end
+
+article = BetterSeo::StructuredData::Generator.article do |a|
+  a.headline("The Complete Guide to Ruby on Rails in 2024")
+  a.description("Everything you need to know about Rails")
+  a.image([
+    "https://techblog.com/images/rails-2024-1.jpg",
+    "https://techblog.com/images/rails-2024-2.jpg"
+  ])
+  a.author(author)
+  a.publisher(publisher)
+  a.date_published("2024-01-15T09:00:00Z")
+  a.date_modified("2024-01-20T15:30:00Z")
+  a.url("https://techblog.com/rails-complete-guide-2024")
+  a.word_count(3500)
+  a.keywords(["Ruby on Rails", "Web Development", "2024"])
+  a.article_section("Programming")
+end
+
+# Get JSON-LD
+json_ld = article.to_json
+
+# Get script tag for HTML
+script_tag = article.to_script_tag
+
+# Or generate all at once
+all_tags = BetterSeo::StructuredData::Generator.generate_script_tags([
+  publisher,
+  author,
+  article
+])
+```
+
+#### Benefits
+
+- **SEO Enhancement**: Help search engines understand your content better
+- **Rich Snippets**: Enable rich results in search results (ratings, images, etc.)
+- **Type Safety**: Fluent API with method chaining
+- **Nested Data**: Automatic handling of complex relationships
+- **Standards Compliant**: Follows Schema.org specifications
+- **Easy Integration**: Works seamlessly with Rails views and helpers
+
 ## Configuration Reference
 
 ### Global Configuration

data/lib/better_seo/version.rb

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

data/lib/better_seo.rb

@@ -17,6 +17,13 @@ require_relative "better_seo/rails/helpers/seo_helper"
 require_relative "better_seo/sitemap/url_entry"
 require_relative "better_seo/sitemap/builder"
 require_relative "better_seo/sitemap/generator"
+require_relative "better_seo/structured_data/base"
+require_relative "better_seo/structured_data/organization"
+require_relative "better_seo/structured_data/article"
+require_relative "better_seo/structured_data/person"
+require_relative "better_seo/structured_data/product"
+require_relative "better_seo/structured_data/breadcrumb_list"
+require_relative "better_seo/structured_data/generator"
 
 module BetterSeo
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_seo
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - alessiobussolari
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-22 00:00:00.000000000 Z
+date: 2025-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport