better_seo 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b1f457db06f6ed1a5654363c639448945eb0c8ee11f311203333edf3de5b499
-  data.tar.gz: bbb3f5e0f831a1f3437b1dd171b4e7c8cc953fc654b102670037da19cc96ae73
+  metadata.gz: 8e54a1f72d1782db6366637bd76336b7af2bf1d51dd3241dc7ba4be9f0deb75b
+  data.tar.gz: a2bc94c2c62edc86b3bf50db8f56424b11649d7aa4d3b53867b55d3561a69a5d
 SHA512:
-  metadata.gz: '0978f9a96df030f0b10c10e409c9938c7cca9d5b881212c10135de040f6e51cbd1631f5b6d76ffe9af9efad722336d4f522edb7abf6872d7abd86ae2e516f7ce'
-  data.tar.gz: e3fcdde3228d074d75f3a47abcfb81c5145c827191512642745254df0c93c8be1f7a2f82c0d9aaed783c64951dc1b753b436e928fd29d6fc22fce6091b97ea7b
+  metadata.gz: b53dd20aa929536a0de6f293bf2e1efe35437cb9431db5f86f0865bf4bdc8ec3575fd95dbc9843fdb4ebb3c259da65bf9f39ee636c199ec4818141019f71dcbb
+  data.tar.gz: 79f5dd0ae283b0a05af28c3f5372db36e9d618fffc4596a5c716b3c67ae4ea5751b2e697dc637837dcb6619d94801be79519364621b339b0df40a3701ed552c5

data/CHANGELOG.md

@@ -7,6 +7,69 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.8.0] - 2025-01-23
+
+### Added
+- Rails Structured Data View Helpers for easy integration
+  - `structured_data_tag(type, **properties, &block)` - Generic helper with type symbol or object
+  - `organization_sd(**properties, &block)` - Organization structured data helper
+  - `article_sd(**properties, &block)` - Article structured data helper
+  - `person_sd(**properties, &block)` - Person structured data helper
+  - `product_sd(**properties, &block)` - Product structured data helper
+  - `breadcrumb_list_sd(items:, &block)` - Breadcrumb list structured data helper
+  - `structured_data_tags(array)` - Multiple structured data tags generation
+- Helper features
+  - Support for both hash configuration and block-based DSL
+  - Type mapping with symbol-based factory methods
+  - Automatic HTML safety with `raw` method
+  - Pass existing structured data objects or create on-the-fly
+  - Seamless integration with Rails views and layouts
+- Complete Rails integration examples
+  - Product page with breadcrumbs and structured data
+  - Helper method reference table
+  - Type-specific helper examples
+
+### Test Coverage
+- 552 tests passing (+22 from v0.7.0)
+- 98.83% code coverage (931/942 lines)
+- 22 new tests for StructuredDataHelper
+
+## [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

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-491%20passing-brightgreen)](https://github.com/yourusername/better_seo)
-[![Coverage](https://img.shields.io/badge/coverage-99.64%25-brightgreen)](https://github.com/yourusername/better_seo)
+[![Tests](https://img.shields.io/badge/tests-552%20passing-brightgreen)](https://github.com/yourusername/better_seo)
+[![Coverage](https://img.shields.io/badge/coverage-98.83%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.6.0)
+### ✅ Implemented (v0.8.0)
 
 - **Core Configuration System**
   - Singleton configuration with block-style setup
@@ -33,7 +33,8 @@ A comprehensive SEO gem for Ruby and Rails applications. BetterSeo provides a cl
   - Integration with DSL builders
 
 - **Rails Integration**
-  - **View Helpers**: `seo_meta_tags`, `seo_open_graph_tags`, `seo_twitter_tags`, `seo_tags`
+  - **SEO View Helpers**: `seo_meta_tags`, `seo_open_graph_tags`, `seo_twitter_tags`, `seo_tags`
+  - **Structured Data Helpers**: `structured_data_tag`, `organization_sd`, `article_sd`, `person_sd`, `product_sd`, `breadcrumb_list_sd`
   - Support for hash configuration and DSL blocks
   - Automatic HTML safety with `raw` helper
   - Integration with global configuration defaults
@@ -53,6 +54,8 @@ A comprehensive SEO gem for Ruby and Rails applications. BetterSeo provides a cl
   - **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
@@ -60,12 +63,12 @@ A comprehensive SEO gem for Ruby and Rails applications. BetterSeo provides a cl
 
 ### 🚧 Planned
 
-- **Additional Structured Data Types** (v0.7.0)
-  - Product (e-commerce with price, availability)
-  - BreadcrumbList (navigation breadcrumbs)
-  - LocalBusiness (physical locations)
-  - Event (conferences, webinars)
-  - FAQPage, HowTo, Recipe
+- **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
@@ -97,7 +100,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.6.0'
+gem 'better_seo', '~> 0.7.0'
 ```
 
 And then execute:
@@ -117,7 +120,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.6.0'
+gem 'better_seo', git: 'https://github.com/alessiobussolari/better_seo.git', tag: 'v0.7.0'
 ```
 
 Or clone and build locally:
@@ -126,7 +129,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.6.0.gem
+gem install better_seo-0.7.0.gem
 ```
 
 ## Quick Start
@@ -1126,6 +1129,37 @@ person.same_as([
 ])
 ```
 
+**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:
@@ -1279,6 +1313,174 @@ And in article views:
 <%= article_structured_data(@article) %>
 ```
 
+#### Rails View Helpers (v0.8.0)
+
+BetterSeo includes built-in Rails view helpers for easy structured data integration:
+
+**Generic Helper - `structured_data_tag`**
+
+```erb
+<%# Create from type symbol with hash %>
+<%= structured_data_tag(:organization,
+  name: "Acme Corp",
+  url: "https://acme.com",
+  logo: "https://acme.com/logo.png"
+) %>
+
+<%# Create from type symbol with block %>
+<%= structured_data_tag(:article) do |article|
+  article.headline("My Article")
+  article.author("John Doe")
+  article.date_published("2024-01-15")
+end %>
+
+<%# Pass an existing object %>
+<% org = BetterSeo::StructuredData::Organization.new(name: "Acme") %>
+<%= structured_data_tag(org) %>
+```
+
+**Type-Specific Helpers**
+
+Convenience methods for each structured data type:
+
+```erb
+<%# Organization %>
+<%= organization_sd(
+  name: "Acme Corp",
+  url: "https://acme.com"
+) %>
+
+<%# Or with block %>
+<%= organization_sd do |org|
+  org.name("Acme Corp")
+  org.url("https://acme.com")
+  org.logo("https://acme.com/logo.png")
+end %>
+
+<%# Article %>
+<%= article_sd(
+  headline: @article.title,
+  author: @article.author.name,
+  date_published: @article.published_at.iso8601
+) %>
+
+<%# Person %>
+<%= person_sd do |person|
+  person.name("John Doe")
+  person.email("john@example.com")
+  person.job_title("Software Engineer")
+end %>
+
+<%# Product %>
+<%= product_sd do |product|
+  product.name(@product.name)
+  product.brand(@product.brand)
+  product.offers(
+    price: @product.price,
+    price_currency: "USD",
+    availability: "InStock"
+  )
+  product.aggregate_rating(
+    rating_value: @product.average_rating,
+    review_count: @product.reviews_count
+  )
+end %>
+
+<%# Breadcrumb List %>
+<%= breadcrumb_list_sd do |breadcrumb|
+  breadcrumb.add_item(name: "Home", url: root_url)
+  breadcrumb.add_item(name: "Products", url: products_url)
+  breadcrumb.add_item(name: @product.name, url: product_url(@product))
+end %>
+
+<%# Or from array %>
+<% items = [
+  { name: "Home", url: root_url },
+  { name: "Products", url: products_url }
+] %>
+<%= breadcrumb_list_sd(items: items) %>
+```
+
+**Multiple Tags Helper - `structured_data_tags`**
+
+Generate multiple script tags at once:
+
+```erb
+<% org = BetterSeo::StructuredData::Organization.new(name: "Acme") %>
+<% person = BetterSeo::StructuredData::Person.new(name: "John") %>
+<% article = BetterSeo::StructuredData::Article.new(headline: "Title") %>
+
+<%= structured_data_tags([org, person, article]) %>
+```
+
+**Complete Rails Example**
+
+```erb
+<%# app/views/products/show.html.erb %>
+<head>
+  <%# Page SEO tags %>
+  <%= seo_tags do |seo|
+    seo.meta do |meta|
+      meta.title @product.name
+      meta.description @product.description
+    end
+    seo.og do |og|
+      og.type "product"
+      og.title @product.name
+      og.image @product.image_url
+    end
+  end %>
+
+  <%# Structured data %>
+  <%= organization_sd do |org|
+    org.name("My Shop")
+    org.url(root_url)
+  end %>
+
+  <%= breadcrumb_list_sd do |bc|
+    bc.add_item(name: "Home", url: root_url)
+    bc.add_item(name: "Products", url: products_url)
+    bc.add_item(name: @product.category, url: category_url(@product.category))
+    bc.add_item(name: @product.name, url: product_url(@product))
+  end %>
+
+  <%= product_sd do |product|
+    product.name(@product.name)
+    product.description(@product.description)
+    product.image(@product.image_url)
+    product.brand(@product.brand)
+    product.sku(@product.sku)
+    product.offers(
+      price: @product.price,
+      price_currency: "USD",
+      availability: @product.in_stock? ? "InStock" : "OutOfStock",
+      url: product_url(@product)
+    )
+    if @product.reviews.any?
+      product.aggregate_rating(
+        rating_value: @product.average_rating,
+        review_count: @product.reviews_count,
+        best_rating: 5
+      )
+    end
+  end %>
+</head>
+```
+
+**Helper Method Reference**
+
+| Helper | Description |
+|--------|-------------|
+| `structured_data_tag(type, **props, &block)` | Generic helper for any type |
+| `organization_sd(**props, &block)` | Organization structured data |
+| `article_sd(**props, &block)` | Article structured data |
+| `person_sd(**props, &block)` | Person structured data |
+| `product_sd(**props, &block)` | Product structured data |
+| `breadcrumb_list_sd(items:, &block)` | Breadcrumb list structured data |
+| `structured_data_tags(array)` | Multiple structured data tags |
+
+All helpers support both hash configuration and block-based DSL for maximum flexibility.
+
 #### Complete Example
 
 ```ruby
@@ -1445,11 +1647,13 @@ bundle exec rspec --format documentation
 ```
 
 Current test statistics:
-- **286 tests** passing
-- **100% code coverage** (562/562 lines)
+- **552 tests** passing
+- **98.83% code coverage** (931/942 lines)
 - **3 DSL builders** fully tested
 - **3 HTML generators** fully tested
-- **1 Rails view helper module** fully tested
+- **2 Rails view helper modules** fully tested
+- **5 Structured data types** fully tested
+- **1 Sitemap generation system** fully tested
 - **1 core configuration system** fully tested
 
 ## Architecture

data/lib/better_seo/version.rb

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

data/lib/better_seo.rb

@@ -13,7 +13,6 @@ require_relative "better_seo/dsl/twitter_cards"
 require_relative "better_seo/generators/meta_tags_generator"
 require_relative "better_seo/generators/open_graph_generator"
 require_relative "better_seo/generators/twitter_cards_generator"
-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"
@@ -21,7 +20,11 @@ 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"
+require_relative "better_seo/rails/helpers/seo_helper"
+require_relative "better_seo/rails/helpers/structured_data_helper"
 
 module BetterSeo
   class << self

metadata

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