better_seo 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c5febaa764505c7680d89bd6858600708fbd362d811818c7206b6e8f8768b32
-  data.tar.gz: 7a6928082bed979115b7411049182fbd6591ac0156fa5670a9cadb843d3b23d8
+  metadata.gz: 02c10b033ffd80fd718852f24434af741e4804e8353b792dfa37bdb70ea1583c
+  data.tar.gz: cec2c0bd8391ec44eeffeedaf9f64c35c2070e575f9addb999e4f04034da561e
 SHA512:
-  metadata.gz: 8a4c80163add6a90ddabb694ec95c6defddf0ef4a3357bc0e3defc2ea4cb3ace4556bec7f5303571dbc72caf860f0092f54c43e61a4f8a70f573b88d6d39b146
-  data.tar.gz: 9abc8a475e9380e85b0a410547f63eca11682f21b0271acbab83a6f855212c888c3a937d9db5358e0518697acb3af61d9e852060a0f871dd80b86c313eb43916
+  metadata.gz: d03af8f52407d32434526df94a5b871dc797a28cb6352d52acf850b5b4626b30db22bb35641858801f7d25ae07614ac94913718558c1486d89a69caecc295966
+  data.tar.gz: 003afa3422b02cfb5f043b92799b67ab099304f95fe99e80469226dae9c67dfcfb1f1835692462a203b4c3b8fbf4db5ed092866c333d7ddf8abaaf2247e6b644

data/CHANGELOG.md

@@ -7,6 +7,94 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.9.0] - 2025-01-23
+
+### Added
+- Five additional Structured Data types for comprehensive SEO coverage
+  - `StructuredData::LocalBusiness` - Physical business locations
+    - Complete address with PostalAddress schema
+    - Geographic coordinates with GeoCoordinates
+    - Opening hours (string and structured specification)
+    - Price range and cuisine information
+    - Aggregate ratings for customer reviews
+  - `StructuredData::Event` - Conferences, webinars, and events
+    - Event dates with Date/Time/DateTime support
+    - Event status (EventScheduled, EventCancelled, EventPostponed, EventRescheduled)
+    - Event attendance mode (Offline, Online, Mixed)
+    - Physical and virtual locations with Place/VirtualLocation
+    - Organizer (Organization or Person)
+    - Multiple ticket offers with pricing and availability
+    - Performer support (single or multiple)
+  - `StructuredData::FAQPage` - Structured FAQ pages
+    - Add single or multiple questions
+    - Automatic Question/Answer schema formatting
+    - Clear method to reset questions
+    - Rich snippets support in search results
+  - `StructuredData::HowTo` - Step-by-step guides
+    - Named steps with descriptions
+    - Automatic position numbering
+    - Supply and tool lists
+    - Total time estimation
+    - Step images and URLs
+  - `StructuredData::Recipe` - Cooking recipes
+    - Ingredients list management
+    - Step-by-step instructions with HowToStep format
+    - Prep time, cook time, total time
+    - Recipe yield, category, cuisine
+    - Nutrition information with NutritionInformation schema
+    - Aggregate ratings
+    - Keywords support
+- Generator helper methods for all new types
+  - `Generator.local_business` with block support
+  - `Generator.event` with block support
+  - `Generator.faq_page` with block support
+  - `Generator.how_to` with block support
+  - `Generator.recipe` with block support
+- Rails view helpers for all new types
+  - `local_business_sd(**properties, &block)`
+  - `event_sd(**properties, &block)`
+  - `faq_page_sd(questions:, &block)` - with array support
+  - `how_to_sd(steps:, &block)` - with array support
+  - `recipe_sd(ingredients:, instructions:, &block)` - with array support
+- Enhanced TYPE_MAPPING in StructuredDataHelper with all 10 types
+
+### Test Coverage
+- 669 tests passing (+117 from v0.8.0)
+- 95.79% code coverage (1205/1258 lines)
+- 117 new tests across 5 structured data types:
+  - LocalBusiness: 25 tests
+  - Event: 36 tests
+  - FAQPage: 11 tests
+  - HowTo: 18 tests
+  - Recipe: 27 tests
+
+## [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

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-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)
+[![Tests](https://img.shields.io/badge/tests-669%20passing-brightgreen)](https://github.com/yourusername/better_seo)
+[![Coverage](https://img.shields.io/badge/coverage-95.79%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.7.0)
+### ✅ Implemented (v0.9.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`, `local_business_sd`, `event_sd`, `faq_page_sd`, `how_to_sd`, `recipe_sd`
   - Support for hash configuration and DSL blocks
   - Automatic HTML safety with `raw` helper
   - Integration with global configuration defaults
@@ -48,27 +49,25 @@ 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)**
+- **Structured Data (JSON-LD)** - 10 comprehensive types
   - **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
+  - **LocalBusiness**: Physical locations with address, hours, geo coordinates, ratings
+  - **Event**: Conferences, webinars with dates, location, tickets, performers
+  - **FAQPage**: Structured FAQ with questions/answers for rich snippets
+  - **HowTo**: Step-by-step guides with supplies, tools, and instructions
+  - **Recipe**: Cooking recipes with ingredients, nutrition, cooking time
+  - **Generator Helper**: Factory methods for all types with block support
   - **Nested Data**: Automatic handling of complex object relationships
   - **JSON-LD Output**: Valid Schema.org JSON-LD format
-  - **Rails Integration**: View helpers and layout integration
+  - **Rails Integration**: Complete view helpers for all types
 
 ### 🚧 Planned
 
-- **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
@@ -1312,6 +1311,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
@@ -1478,11 +1645,13 @@ bundle exec rspec --format documentation
 ```
 
 Current test statistics:
-- **286 tests** passing
-- **100% code coverage** (562/562 lines)
+- **669 tests** passing
+- **95.79% code coverage** (1205/1258 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
+- **10 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.7.0"
+  VERSION = "0.9.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"
@@ -23,7 +22,14 @@ 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/local_business"
+require_relative "better_seo/structured_data/event"
+require_relative "better_seo/structured_data/faq_page"
+require_relative "better_seo/structured_data/how_to"
+require_relative "better_seo/structured_data/recipe"
 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.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - alessiobussolari