better_seo 0.14.0 → 1.0.0.2

data/lib/better_seo/structured_data/how_to.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module BetterSeo
+  module StructuredData
+    class HowTo < Base
+      attr_reader :steps
+
+      def initialize(**properties)
+        super("HowTo", **properties)
+        @steps = []
+      end
+
+      # Basic properties
+      def name(value)
+        set(:name, value)
+      end
+
+      def description(value)
+        set(:description, value)
+      end
+
+      def image(value)
+        set(:image, value)
+      end
+
+      def total_time(value)
+        set(:totalTime, value)
+      end
+
+      def supply(value)
+        set(:supply, value)
+      end
+
+      def tool(value)
+        set(:tool, value)
+      end
+
+      # Add a single step
+      def add_step(name:, text:, image: nil, url: nil, position: nil)
+        position ||= @steps.size + 1
+        @steps << {
+          name: name,
+          text: text,
+          image: image,
+          url: url,
+          position: position
+        }
+        self
+      end
+
+      # Add multiple steps from an array
+      def add_steps(steps_array)
+        steps_array.each do |step|
+          add_step(
+            name: step[:name],
+            text: step[:text],
+            image: step[:image],
+            url: step[:url],
+            position: step[:position]
+          )
+        end
+        self
+      end
+
+      # Clear all steps
+      def clear
+        @steps = []
+        @properties.delete(:step)
+        self
+      end
+
+      # Override to_h to include steps
+      def to_h
+        hash = super
+
+        if @steps.any?
+          hash["step"] = @steps.map do |step|
+            step_hash = {
+              "@type" => "HowToStep",
+              "name" => step[:name],
+              "text" => step[:text],
+              "position" => step[:position]
+            }
+
+            step_hash["image"] = step[:image] if step[:image]
+            step_hash["url"] = step[:url] if step[:url]
+
+            step_hash
+          end
+        end
+
+        hash
+      end
+    end
+  end
+end

data/lib/better_seo/structured_data/local_business.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module BetterSeo
+  module StructuredData
+    class LocalBusiness < Base
+      def initialize(**properties)
+        super("LocalBusiness", **properties)
+      end
+
+      # Basic properties
+      def name(value)
+        set(:name, value)
+      end
+
+      def description(value)
+        set(:description, value)
+      end
+
+      def url(value)
+        set(:url, value)
+      end
+
+      def telephone(value)
+        set(:telephone, value)
+      end
+
+      def email(value)
+        set(:email, value)
+      end
+
+      def image(value)
+        set(:image, value)
+      end
+
+      def price_range(value)
+        set(:priceRange, value)
+      end
+
+      # Address with PostalAddress schema
+      def address(street: nil, city: nil, region: nil, postal_code: nil, country: nil)
+        address_hash = {
+          "@type" => "PostalAddress"
+        }
+
+        address_hash["streetAddress"] = street if street
+        address_hash["addressLocality"] = city if city
+        address_hash["addressRegion"] = region if region
+        address_hash["postalCode"] = postal_code if postal_code
+        address_hash["addressCountry"] = country if country
+
+        set(:address, address_hash)
+      end
+
+      # Geographic coordinates
+      def geo(latitude:, longitude:)
+        geo_hash = {
+          "@type" => "GeoCoordinates",
+          "latitude" => latitude,
+          "longitude" => longitude
+        }
+
+        set(:geo, geo_hash)
+      end
+
+      # Opening hours - accepts string or array
+      def opening_hours(value)
+        set(:openingHours, value)
+      end
+
+      # Opening hours specification (structured format)
+      def opening_hours_specification(value)
+        set(:openingHoursSpecification, value)
+      end
+
+      # Aggregate rating
+      def aggregate_rating(rating_value:, review_count:, best_rating: 5, worst_rating: 1)
+        rating = {
+          "@type" => "AggregateRating",
+          "ratingValue" => rating_value,
+          "reviewCount" => review_count,
+          "bestRating" => best_rating,
+          "worstRating" => worst_rating
+        }
+
+        set(:aggregateRating, rating)
+      end
+
+      # Serves cuisine (for restaurants)
+      def serves_cuisine(value)
+        set(:servesCuisine, value)
+      end
+    end
+  end
+end

data/lib/better_seo/structured_data/organization.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module BetterSeo
+  module StructuredData
+    class Organization < Base
+      def initialize(**properties)
+        super("Organization", **properties)
+      end
+
+      def name(value)
+        set(:name, value)
+      end
+
+      def url(value)
+        set(:url, value)
+      end
+
+      def logo(value)
+        set(:logo, value)
+      end
+
+      def description(value)
+        set(:description, value)
+      end
+
+      def email(value)
+        set(:email, value)
+      end
+
+      def telephone(value)
+        set(:telephone, value)
+      end
+
+      def address(value)
+        if value.is_a?(Hash)
+          postal_address = {
+            "@type" => "PostalAddress",
+            "streetAddress" => value[:street],
+            "addressLocality" => value[:city],
+            "addressRegion" => value[:region],
+            "postalCode" => value[:postal_code],
+            "addressCountry" => value[:country]
+          }.compact
+          set(:address, postal_address)
+        else
+          set(:address, value)
+        end
+      end
+
+      def same_as(value)
+        set(:sameAs, value)
+      end
+
+      def founding_date(value)
+        set(:foundingDate, value)
+      end
+
+      def founder(value)
+        set(:founder, value)
+      end
+
+      def founders(value)
+        set(:founder, value)
+      end
+    end
+  end
+end

data/lib/better_seo/structured_data/person.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module BetterSeo
+  module StructuredData
+    class Person < Base
+      def initialize(**properties)
+        super("Person", **properties)
+      end
+
+      def name(value)
+        set(:name, value)
+      end
+
+      def given_name(value)
+        set(:givenName, value)
+      end
+
+      def family_name(value)
+        set(:familyName, value)
+      end
+
+      def email(value)
+        set(:email, value)
+      end
+
+      def url(value)
+        set(:url, value)
+      end
+
+      def image(value)
+        set(:image, value)
+      end
+
+      def job_title(value)
+        set(:jobTitle, value)
+      end
+
+      def works_for(value)
+        set(:worksFor, value)
+      end
+
+      def telephone(value)
+        set(:telephone, value)
+      end
+
+      def same_as(value)
+        set(:sameAs, value)
+      end
+    end
+  end
+end

data/lib/better_seo/structured_data/product.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module BetterSeo
+  module StructuredData
+    class Product < Base
+      AVAILABILITY_MAPPING = {
+        "InStock" => "https://schema.org/InStock",
+        "OutOfStock" => "https://schema.org/OutOfStock",
+        "PreOrder" => "https://schema.org/PreOrder",
+        "Discontinued" => "https://schema.org/Discontinued",
+        "LimitedAvailability" => "https://schema.org/LimitedAvailability"
+      }.freeze
+
+      def initialize(**properties)
+        super("Product", **properties)
+      end
+
+      def name(value)
+        set(:name, value)
+      end
+
+      def description(value)
+        set(:description, value)
+      end
+
+      def image(value)
+        set(:image, value)
+      end
+
+      def brand(value)
+        set(:brand, value)
+      end
+
+      def sku(value)
+        set(:sku, value)
+      end
+
+      def gtin(value)
+        set(:gtin, value)
+      end
+
+      def mpn(value)
+        set(:mpn, value)
+      end
+
+      def offers(value)
+        if value.is_a?(Array)
+          set(:offers, value.map { |v| build_offer(v) })
+        elsif value.is_a?(Hash)
+          set(:offers, build_offer(value))
+        else
+          set(:offers, value)
+        end
+      end
+
+      def aggregate_rating(rating_value:, review_count:, best_rating: 5, worst_rating: 1)
+        rating = {
+          "@type" => "AggregateRating",
+          "ratingValue" => rating_value,
+          "reviewCount" => review_count,
+          "bestRating" => best_rating,
+          "worstRating" => worst_rating
+        }
+        set(:aggregateRating, rating)
+      end
+
+      def review(author:, rating_value:, review_body: nil, date_published: nil)
+        review_data = build_review(
+          author: author,
+          rating_value: rating_value,
+          review_body: review_body,
+          date_published: date_published
+        )
+        set(:review, review_data)
+      end
+
+      def reviews(reviews_array)
+        reviews_data = reviews_array.map do |review_hash|
+          build_review(
+            author: review_hash[:author],
+            rating_value: review_hash[:rating_value],
+            review_body: review_hash[:review_body],
+            date_published: review_hash[:date_published]
+          )
+        end
+        set(:review, reviews_data)
+      end
+
+      private
+
+      def build_offer(offer_hash)
+        availability = offer_hash[:availability] || "InStock"
+        availability_url = AVAILABILITY_MAPPING[availability] || "https://schema.org/#{availability}"
+
+        offer = {
+          "@type" => "Offer",
+          "price" => offer_hash[:price],
+          "priceCurrency" => offer_hash[:price_currency],
+          "availability" => availability_url
+        }
+        offer["url"] = offer_hash[:url] if offer_hash[:url]
+        offer.compact
+      end
+
+      def build_review(author:, rating_value:, review_body: nil, date_published: nil)
+        review = {
+          "@type" => "Review",
+          "author" => {
+            "@type" => "Person",
+            "name" => author
+          },
+          "reviewRating" => {
+            "@type" => "Rating",
+            "ratingValue" => rating_value
+          }
+        }
+        review["reviewBody"] = review_body if review_body
+        review["datePublished"] = date_published if date_published
+        review
+      end
+    end
+  end
+end

data/lib/better_seo/structured_data/recipe.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module BetterSeo
+  module StructuredData
+    class Recipe < Base
+      attr_reader :ingredients, :instructions
+
+      def initialize(**properties)
+        super("Recipe", **properties)
+        @ingredients = []
+        @instructions = []
+      end
+
+      # Basic properties
+      def name(value)
+        set(:name, value)
+      end
+
+      def description(value)
+        set(:description, value)
+      end
+
+      def image(value)
+        set(:image, value)
+      end
+
+      def author(value)
+        set(:author, value)
+      end
+
+      def prep_time(value)
+        set(:prepTime, value)
+      end
+
+      def cook_time(value)
+        set(:cookTime, value)
+      end
+
+      def total_time(value)
+        set(:totalTime, value)
+      end
+
+      def recipe_yield(value)
+        set(:recipeYield, value)
+      end
+
+      def recipe_category(value)
+        set(:recipeCategory, value)
+      end
+
+      def recipe_cuisine(value)
+        set(:recipeCuisine, value)
+      end
+
+      def keywords(value)
+        set(:keywords, value)
+      end
+
+      # Ingredients
+      def add_ingredient(ingredient)
+        @ingredients << ingredient
+        self
+      end
+
+      def add_ingredients(ingredients_array)
+        @ingredients.concat(ingredients_array)
+        self
+      end
+
+      # Instructions
+      def add_instruction(instruction)
+        @instructions << instruction
+        self
+      end
+
+      def add_instructions(instructions_array)
+        @instructions.concat(instructions_array)
+        self
+      end
+
+      # Nutrition information
+      def nutrition(calories: nil, fat_content: nil, carbohydrate_content: nil, protein_content: nil,
+                    sugar_content: nil, **other)
+        nutrition_hash = {
+          "@type" => "NutritionInformation"
+        }
+
+        nutrition_hash["calories"] = calories if calories
+        nutrition_hash["fatContent"] = fat_content if fat_content
+        nutrition_hash["carbohydrateContent"] = carbohydrate_content if carbohydrate_content
+        nutrition_hash["proteinContent"] = protein_content if protein_content
+        nutrition_hash["sugarContent"] = sugar_content if sugar_content
+
+        other.each do |key, value|
+          nutrition_hash[key.to_s.camelize(:lower)] = value if value
+        end
+
+        set(:nutrition, nutrition_hash)
+      end
+
+      # Aggregate rating
+      def aggregate_rating(rating_value:, review_count:, best_rating: 5, worst_rating: 1)
+        rating = {
+          "@type" => "AggregateRating",
+          "ratingValue" => rating_value,
+          "reviewCount" => review_count,
+          "bestRating" => best_rating,
+          "worstRating" => worst_rating
+        }
+
+        set(:aggregateRating, rating)
+      end
+
+      # Override to_h to include ingredients and instructions
+      def to_h
+        hash = super
+
+        hash["recipeIngredient"] = @ingredients if @ingredients.any?
+
+        if @instructions.any?
+          hash["recipeInstructions"] = @instructions.map.with_index(1) do |instruction, index|
+            {
+              "@type" => "HowToStep",
+              "position" => index,
+              "text" => instruction
+            }
+          end
+        end
+
+        hash
+      end
+    end
+  end
+end