arosa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 810cb0bb6cbdd8aa9d5a2a465d99275e4830189fd432110f73984c4840bb3b6c
+  data.tar.gz: 8c3bd9ece1d575d04151c7d383c000d757050f1784d513335ff0fdc568c2ebe1
+SHA512:
+  metadata.gz: 24b4b2ef43dfdc9d01f79bf2d7119998f22372a3e80ce9aa9c348f1346db12916f231dcb2657c6266dc5a985db6a132440818d70bffc68e455c87540c71084a5
+  data.tar.gz: 9fcb61eb463aab857ad40b6123447ef3cd5908f76266546fa9dcc62123b3b266abfb4801b15a5f5af2dfa5dc2a6d4626f06b64f6013a5ead8128955b11650586

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Samuenti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,214 @@
+# Arosa
+
+Generate [schema.org](https://schema.org) structured data as JSON-LD. Drop it into your pages and let search engines understand your content.
+
+## Installation
+
+```ruby
+gem 'arosa'
+```
+
+Then `bundle install`.
+
+## Usage
+
+Arosa works anywhere in your Ruby code. Build the schema, then output it in your view.
+
+Here's an example of an Organization schema:
+
+```ruby
+@org = Arosa::Schemas::Organization.new(
+  name: "Acme Corp",
+  url: "https://acme.com",
+  logo: "https://acme.com/logo.png",
+  email: "hello@acme.com",
+  founding_date: Date.new(2020, 1, 1),
+  address: Arosa::Schemas::PostalAddress.new(
+    street_address: "123 Main St",
+    address_locality: "Zug",
+    address_country: "CH",
+    postal_code: "6300"
+  )
+)
+```
+
+In your view:
+
+```erb
+<%= @org %>
+```
+
+Which will output:
+
+```html
+<script type="application/ld+json">
+{
+  "@context": "https://schema.org",
+  "@type": "Organization",
+  "name": "Acme Corp",
+  "url": "https://acme.com",
+  "logo": "https://acme.com/logo.png",
+  "email": "hello@acme.com",
+  "foundingDate": "2020-01-01",
+  "address": {
+    "@type": "PostalAddress",
+    "streetAddress": "123 Main St",
+    "addressLocality": "Zug",
+    "addressCountry": "CH",
+    "postalCode": "6300"
+  }
+}
+</script>
+```
+
+## Validation
+
+Wrong types and unknown properties raise errors immediately:
+
+```ruby
+Arosa::Schemas::Organization.new(name: 123)
+# => ArgumentError: name must be a String, got Integer
+
+Arosa::Schemas::Organization.new(made_up: "value")
+# => NoMethodError: undefined method `made_up='
+```
+
+No silent failures. If it builds, the markup is valid.
+
+## Supported Types
+
+| Type | Schema.org |
+|------|------------|
+| [Organization](#organization) | [schema.org/Organization](https://schema.org/Organization) |
+| [PostalAddress](#postaladdress) | [schema.org/PostalAddress](https://schema.org/PostalAddress) |
+| [ContactPoint](#contactpoint) | [schema.org/ContactPoint](https://schema.org/ContactPoint) |
+| [BreadcrumbList](#breadcrumblist) | [schema.org/BreadcrumbList](https://schema.org/BreadcrumbList) |
+| [ListItem](#listitem) | [schema.org/ListItem](https://schema.org/ListItem) |
+
+More types coming.
+
+---
+
+### Organization
+
+| Property | Type |
+|----------|------|
+| name | String |
+| alternate_name | String |
+| description | String |
+| url | String |
+| logo | String |
+| email | String |
+| telephone | String |
+| address | [PostalAddress](#postaladdress) |
+| contact_point | [ContactPoint](#contactpoint) |
+| legal_name | String |
+| tax_id | String |
+| vat_id | String |
+| duns | String |
+| lei_code | String |
+| iso6523_code | String |
+| global_location_number | String |
+| naics | String |
+| founding_date | Date |
+| number_of_employees | Integer |
+| same_as | Array of String |
+
+```ruby
+Arosa::Schemas::Organization.new(
+  name: "Acme Corp",
+  url: "https://acme.com",
+  logo: "https://acme.com/logo.png",
+  email: "hello@acme.com",
+  founding_date: Date.new(2020, 1, 1),
+  same_as: [
+    "https://linkedin.com/company/acme",
+    "https://en.wikipedia.org/wiki/Acme"
+  ],
+  address: Arosa::Schemas::PostalAddress.new(
+    street_address: "123 Main St",
+    address_locality: "Zug",
+    address_country: "CH",
+    postal_code: "6300"
+  ),
+  contact_point: Arosa::Schemas::ContactPoint.new(
+    contact_type: "customer service",
+    telephone: "+1-800-555-1234",
+    email: "support@acme.com"
+  )
+)
+```
+
+### PostalAddress
+
+| Property | Type |
+|----------|------|
+| street_address | String |
+| address_locality | String |
+| address_region | String |
+| postal_code | String |
+| address_country | String |
+
+```ruby
+Arosa::Schemas::PostalAddress.new(
+  street_address: "123 Main St",
+  address_locality: "Zug",
+  address_region: "ZG",
+  address_country: "CH",
+  postal_code: "6300"
+)
+```
+
+### ContactPoint
+
+| Property | Type |
+|----------|------|
+| contact_type | String |
+| telephone | String |
+| email | String |
+
+```ruby
+Arosa::Schemas::ContactPoint.new(
+  contact_type: "customer service",
+  telephone: "+1-800-555-1234",
+  email: "support@example.com"
+)
+```
+
+### BreadcrumbList
+
+| Property | Type |
+|----------|------|
+| item_list_element | Array of [ListItem](#listitem) |
+
+```ruby
+Arosa::Schemas::BreadcrumbList.new(
+  item_list_element: [
+    Arosa::Schemas::ListItem.new(position: 1, name: "Home", item: "https://example.com"),
+    Arosa::Schemas::ListItem.new(position: 2, name: "Books", item: "https://example.com/books"),
+    Arosa::Schemas::ListItem.new(position: 3, name: "Science Fiction")
+  ]
+)
+```
+
+### ListItem
+
+| Property | Type |
+|----------|------|
+| position | Integer |
+| name | String |
+| item | String |
+
+```ruby
+Arosa::Schemas::ListItem.new(
+  position: 1,
+  name: "Books",
+  item: "https://example.com/books"
+)
+```
+
+Note: `item` is optional on the last breadcrumb (the current page).
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/arosa/schema.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Arosa
+  class Schema
+    class << self
+      def properties
+        @properties ||= {}
+      end
+
+      def property(name, required: false, type: nil)
+        properties[name] = { required: required, type: type }
+
+        define_method(name) do
+          @values[name]
+        end
+
+        define_method("#{name}=") do |value|
+          validate_type!(name, value, type) if type && !value.nil?
+          @values[name] = value
+        end
+      end
+
+      def schema_type(type = nil)
+        if type
+          @schema_type = type
+        else
+          @schema_type || name.split("::").last
+        end
+      end
+
+      def inherited(subclass)
+        super
+        subclass.instance_variable_set(:@properties, properties.dup)
+      end
+    end
+
+    def initialize(**attrs)
+      @values = {}
+      attrs.each { |key, value| send("#{key}=", value) }
+      raise ArgumentError, "Missing required: #{missing_required.join(", ")}" if missing_required.any?
+    end
+
+    def valid?
+      missing_required.empty?
+    end
+
+    def missing_required
+      self.class.properties.select { |_, opts| opts[:required] }.keys.reject { |name| @values[name] }
+    end
+
+    def to_h(nested: false)
+      data = nested ? {} : { "@context" => "https://schema.org" }
+      data["@type"] = self.class.schema_type
+
+      @values.each do |key, value|
+        data[camelize(key)] = serialize_value(value)
+      end
+
+      data.compact
+    end
+
+    def to_json(*_args)
+      JSON.generate(to_h)
+    end
+
+    def to_html
+      html = %(<script type="application/ld+json">#{to_json}</script>)
+      html.respond_to?(:html_safe) ? html.html_safe : html
+    end
+
+    alias to_s to_html
+
+    private
+
+    def validate_type!(name, value, type)
+      if type.is_a?(Array)
+        inner = type.first
+        return if value.is_a?(inner)
+        return if value.is_a?(Array) && value.all? { |v| v.is_a?(inner) }
+      else
+        return if value.is_a?(type)
+      end
+
+      raise ArgumentError, "#{name} must be a #{type}, got #{value.class}"
+    end
+
+    def camelize(key)
+      str = key.to_s
+      str.gsub(/_([a-z])/) { ::Regexp.last_match(1).upcase }
+    end
+
+    def serialize_value(value)
+      case value
+      when Schema then value.to_h(nested: true)
+      when Array then value.map { |v| serialize_value(v) }
+      when Date, Time, DateTime then value.iso8601
+      else value
+      end
+    end
+  end
+end

data/lib/arosa/schemas/breadcrumb_list.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Arosa
+  module Schemas
+    # Schema.org BreadcrumbList type
+    #
+    # https://schema.org/BreadcrumbList
+    class BreadcrumbList < Schema
+      schema_type "BreadcrumbList"
+
+      property :item_list_element, type: [ListItem]
+    end
+  end
+end

data/lib/arosa/schemas/contact_point.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Arosa
+  module Schemas
+    # Schema.org ContactPoint type
+    #
+    # https://schema.org/ContactPoint
+    class ContactPoint < Schema
+      schema_type "ContactPoint"
+
+      property :contact_type, type: String
+      property :telephone, type: String
+      property :email, type: String
+    end
+  end
+end

data/lib/arosa/schemas/list_item.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Arosa
+  module Schemas
+    # Schema.org ListItem type
+    #
+    # https://schema.org/ListItem
+    class ListItem < Schema
+      schema_type "ListItem"
+
+      property :position, type: Integer
+      property :name, type: String
+      property :item, type: String
+    end
+  end
+end

data/lib/arosa/schemas/organization.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Arosa
+  module Schemas
+    # Schema.org Organization type
+    #
+    # https://schema.org/Organization
+    class Organization < Schema
+      schema_type "Organization"
+
+      property :name, type: String
+      property :alternate_name, type: String
+      property :description, type: String
+      property :url, type: String
+      property :logo, type: String
+      property :email, type: String
+      property :telephone, type: String
+      property :address, type: PostalAddress
+      property :contact_point, type: ContactPoint
+      property :legal_name, type: String
+      property :tax_id, type: String
+      property :vat_id, type: String
+      property :duns, type: String
+      property :lei_code, type: String
+      property :iso6523_code, type: String
+      property :global_location_number, type: String
+      property :naics, type: String
+      property :founding_date, type: Date
+      property :number_of_employees
+      property :same_as, type: [String]
+    end
+  end
+end

data/lib/arosa/schemas/postal_address.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Arosa
+  module Schemas
+    # Schema.org PostalAddress type
+    #
+    # https://schema.org/PostalAddress
+    class PostalAddress < Schema
+      schema_type "PostalAddress"
+
+      property :street_address, type: String
+      property :address_locality, type: String
+      property :address_region, type: String
+      property :postal_code, type: String
+      property :address_country, type: String
+    end
+  end
+end

data/lib/arosa/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Arosa
+  VERSION = "0.1.0"
+end

data/lib/arosa.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "date"
+require "json"
+require_relative "arosa/version"
+require_relative "arosa/schema"
+
+# Schemas
+require_relative "arosa/schemas/postal_address"
+require_relative "arosa/schemas/contact_point"
+require_relative "arosa/schemas/organization"
+require_relative "arosa/schemas/list_item"
+require_relative "arosa/schemas/breadcrumb_list"
+
+module Arosa
+  class Error < StandardError; end
+end

data/sig/arosa.rbs

@@ -0,0 +1,4 @@
+module Arosa
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: arosa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuenti
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-01-03 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby gem for generating schema.org structured data for rich results.
+email:
+- contact@samuenti.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/arosa.rb
+- lib/arosa/schema.rb
+- lib/arosa/schemas/breadcrumb_list.rb
+- lib/arosa/schemas/contact_point.rb
+- lib/arosa/schemas/list_item.rb
+- lib/arosa/schemas/organization.rb
+- lib/arosa/schemas/postal_address.rb
+- lib/arosa/version.rb
+- sig/arosa.rbs
+homepage: https://github.com/samuenti/arosa
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/samuenti/arosa
+  source_code_uri: https://github.com/samuenti/arosa
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Generate schema.org structured data as JSON-LD
+test_files: []