swhid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36bebc03a91e8eecaa94a9dacb8496ab76fd8b2f2d4858b6088288a3b1195cbd
+  data.tar.gz: 71f64f03c285c8f445b5e5e74938d7d08141e91bc0cc914506fcdfb6dd970448
+SHA512:
+  metadata.gz: 1aa17852be20170334a2d45cc7affc4d133e08eba03289a1e2269d0d0faec60b5367ed81396336ac4f26ea8d781bbb2bdf2cb60fac0db8f2ee0ff6f494ab30ed
+  data.tar.gz: 9fed39916ba99f2c3fa44c26fb266b7e465138c80aa200f368c6c89cc57c00b91c9753975688ff292ad47c30f2fa9c13c395526f439fb87c388253e2bd7c65a5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-11-09
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/README.md

@@ -0,0 +1,241 @@
+# Swhid
+
+A Ruby library and CLI for generating and parsing SoftWare Hash IDentifiers (SWHIDs).
+
+SWHIDs are persistent, intrinsic identifiers for software artifacts such as files, directories, commits, releases, and snapshots. They are content-based identifiers that use Merkle DAGs for tamper-proof identification with built-in integrity verification.
+
+This implementation follows the official [SWHID specification v1.2](https://www.swhid.org/specification) (ISO/IEC 18670:2025).
+
+## Features
+
+- Generate SWHIDs for all object types:
+  - Content (cnt) - files and blobs
+  - Directory (dir) - directory trees
+  - Revision (rev) - commits
+  - Release (rel) - tags and releases
+  - Snapshot (snp) - repository snapshots
+- Parse and validate SWHID strings
+- Support for qualifiers (origin, visit, anchor, path, lines, bytes)
+- Command-line interface for easy integration
+- Git-compatible hash computation
+- Comprehensive test suite
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swhid'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install swhid
+```
+
+## Usage
+
+### Library Usage
+
+#### Parsing SWHIDs
+
+```ruby
+require 'swhid'
+
+# Parse a SWHID string
+swhid = Swhid.parse("swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2")
+
+puts swhid.scheme       # => "swh"
+puts swhid.version      # => 1
+puts swhid.object_type  # => "cnt"
+puts swhid.object_hash  # => "94a9ed024d3859793618152ea559a168bbcbb5e2"
+puts swhid.to_s         # => "swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2"
+
+# Parse SWHID with qualifiers
+swhid = Swhid.parse("swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2;origin=https://github.com/example/repo;lines=5-10")
+puts swhid.qualifiers[:origin] # => "https://github.com/example/repo"
+puts swhid.qualifiers[:lines]  # => "5-10"
+```
+
+#### Generating SWHIDs
+
+**Content (Files)**
+
+```ruby
+# From a file
+content = File.read("example.txt")
+swhid = Swhid.from_content(content)
+puts swhid.to_s # => "swh:1:cnt:..."
+
+# Empty file
+swhid = Swhid.from_content("")
+puts swhid.to_s # => "swh:1:cnt:e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
+```
+
+**Directory**
+
+```ruby
+entries = [
+  { name: "README.md", type: :file, target: "94a9ed024d3859793618152ea559a168bbcbb5e2" },
+  { name: "src", type: :dir, target: "4b825dc642cb6eb9a060e54bf8d69288fbee4904" },
+  { name: "script.sh", type: :exec, target: "84a9ed024d3859793618152ea559a168bbcbb5e1" }
+]
+
+swhid = Swhid.from_directory(entries)
+puts swhid.to_s
+```
+
+**Revision (Commit)**
+
+```ruby
+metadata = {
+  directory: "4b825dc642cb6eb9a060e54bf8d69288fbee4904",
+  author: "John Doe <john@example.com>",
+  author_timestamp: 1234567890,
+  author_timezone: "+0000",
+  committer: "Jane Smith <jane@example.com>",
+  committer_timestamp: 1234567890,
+  committer_timezone: "+0000",
+  message: "Initial commit",
+  parents: [] # Optional
+}
+
+swhid = Swhid.from_revision(metadata)
+puts swhid.to_s
+```
+
+**Release (Tag)**
+
+```ruby
+metadata = {
+  name: "v1.0.0",
+  target: { hash: "94a9ed024d3859793618152ea559a168bbcbb5e2", type: "rev" },
+  author: "John Doe <john@example.com>",
+  author_timestamp: 1234567890,
+  message: "Release version 1.0.0"
+}
+
+swhid = Swhid.from_release(metadata)
+puts swhid.to_s
+```
+
+**Snapshot**
+
+```ruby
+branches = [
+  { name: "refs/heads/main", target_type: "revision", target: "94a9ed024d3859793618152ea559a168bbcbb5e2" },
+  { name: "refs/tags/v1.0", target_type: "release", target: "84a9ed024d3859793618152ea559a168bbcbb5e1" },
+  { name: "HEAD", target_type: "alias", target: "refs/heads/main" }
+]
+
+swhid = Swhid.from_snapshot(branches)
+puts swhid.to_s
+```
+
+**Working with Qualifiers**
+
+```ruby
+# Create SWHID with qualifiers
+swhid = Swhid::Identifier.new(
+  object_type: "cnt",
+  object_hash: "94a9ed024d3859793618152ea559a168bbcbb5e2",
+  qualifiers: {
+    origin: "https://github.com/example/repo",
+    visit: "swh:1:snp:d7f1b9eb7ccb596c2622c4780febaa02549830f9",
+    anchor: "swh:1:rev:2db189928c94d62a3b4757b3eec68f0a4d4113f0",
+    path: "/src/main.rb",
+    lines: "10-20"
+  }
+)
+
+puts swhid.to_s
+# => "swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2;origin=https://github.com/example/repo;visit=swh:1:snp:...;anchor=swh:1:rev:...;path=/src/main.rb;lines=10-20"
+```
+
+### CLI Usage
+
+The gem includes a command-line tool for working with SWHIDs:
+
+**Parse a SWHID**
+
+```bash
+$ swhid parse "swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2"
+SWHID: swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2
+Core:  swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2
+Type:  cnt
+Hash:  94a9ed024d3859793618152ea559a168bbcbb5e2
+```
+
+**Generate SWHID from file content**
+
+```bash
+$ cat file.txt | swhid content
+swh:1:cnt:9daeafb9864cf43055ae93beb0afd6c7d144bfa4
+
+$ echo "Hello, World!" | swhid content
+swh:1:cnt:96898574d1b88e619be24fd90bb4cd399acbc5ca
+```
+
+**Add qualifiers**
+
+```bash
+$ cat file.txt | swhid content -q origin=https://github.com/example/repo -q lines=1-10
+swh:1:cnt:9daeafb9864cf43055ae93beb0afd6c7d144bfa4;origin=https://github.com/example/repo;lines=1-10
+```
+
+**JSON output**
+
+```bash
+$ swhid parse "swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2" -f json
+{
+  "swhid": "swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2",
+  "core": "swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2",
+  "object_type": "cnt",
+  "object_hash": "94a9ed024d3859793618152ea559a168bbcbb5e2",
+  "qualifiers": {}
+}
+```
+
+## Object Types
+
+- **cnt** (content): Individual files or blobs
+- **dir** (directory): Directory trees with entries
+- **rev** (revision): Git commits or equivalent
+- **rel** (release): Tags or releases
+- **snp** (snapshot): Repository snapshots at a point in time
+
+## Qualifiers
+
+SWHIDs can include optional qualifiers to provide context:
+
+- **origin**: URL of the software origin
+- **visit**: Core SWHID of the snapshot when visited
+- **anchor**: Core SWHID of the anchor node (directory, revision, release, or snapshot)
+- **path**: Absolute file path from the root directory
+- **lines**: Line range (e.g., "10-20")
+- **bytes**: Byte range (e.g., "100-500")
+
+## Git Compatibility
+
+The hash computation for content, directory, revision, and release objects is compatible with Git's object hashing. This means you can use this gem to compute the same hashes that Git would produce for the same objects.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swhid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/swhid/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Swhid project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/swhid/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/exe/swhid

@@ -0,0 +1,163 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "swhid"
+require "optparse"
+require "json"
+
+class SwhidCLI
+  def initialize(args)
+    @args = args
+    @options = {
+      type: nil,
+      format: "text",
+      qualifiers: {}
+    }
+  end
+
+  def run
+    parse_options!
+
+    case @command
+    when "parse"
+      parse_swhid
+    when "content"
+      compute_content_swhid
+    when "help"
+      show_help
+    else
+      show_help
+    end
+  rescue => e
+    puts "Error: #{e.message}"
+    exit 1
+  end
+
+  private
+
+  def parse_options!
+    parser = OptionParser.new do |opts|
+      opts.banner = "Usage: swhid [command] [options]"
+      opts.separator ""
+      opts.separator "Commands:"
+      opts.separator "  parse <swhid>     Parse and validate a SWHID"
+      opts.separator "  content           Generate SWHID for content from stdin"
+      opts.separator "  help              Show this help message"
+      opts.separator ""
+      opts.separator "Options:"
+
+      opts.on("-f", "--format FORMAT", "Output format (text, json)") do |format|
+        @options[:format] = format
+      end
+
+      opts.on("-q", "--qualifier KEY=VALUE", "Add qualifier") do |qual|
+        key, value = qual.split("=", 2)
+        @options[:qualifiers][key.to_sym] = value
+      end
+
+      opts.on("-h", "--help", "Show this help") do
+        puts opts
+        exit
+      end
+    end
+
+    parser.parse!(@args)
+    @command = @args.shift || "help"
+  end
+
+  def parse_swhid
+    swhid_string = @args.shift
+    unless swhid_string
+      puts "Error: SWHID string required"
+      exit 1
+    end
+
+    swhid = Swhid.parse(swhid_string)
+
+    case @options[:format]
+    when "json"
+      output_json(swhid)
+    else
+      output_text(swhid)
+    end
+  end
+
+  def compute_content_swhid
+    content = $stdin.read
+
+    swhid = Swhid.from_content(content)
+
+    unless @options[:qualifiers].empty?
+      swhid = Swhid::Identifier.new(
+        object_type: swhid.object_type,
+        object_hash: swhid.object_hash,
+        qualifiers: @options[:qualifiers]
+      )
+    end
+
+    case @options[:format]
+    when "json"
+      output_json(swhid)
+    else
+      puts swhid.to_s
+    end
+  end
+
+  def output_text(swhid)
+    puts "SWHID: #{swhid.to_s}"
+    puts "Core:  #{swhid.core_swhid}"
+    puts "Type:  #{swhid.object_type}"
+    puts "Hash:  #{swhid.object_hash}"
+
+    unless swhid.qualifiers.empty?
+      puts "Qualifiers:"
+      swhid.qualifiers.each do |key, value|
+        puts "  #{key}: #{value}"
+      end
+    end
+  end
+
+  def output_json(swhid)
+    data = {
+      swhid: swhid.to_s,
+      core: swhid.core_swhid,
+      object_type: swhid.object_type,
+      object_hash: swhid.object_hash,
+      qualifiers: swhid.qualifiers
+    }
+    puts JSON.pretty_generate(data)
+  end
+
+  def show_help
+    puts <<~HELP
+      swhid - Generate and parse SoftWare Hash IDentifiers
+
+      Usage:
+        swhid parse <swhid>              Parse and validate a SWHID
+        swhid content [options]          Generate SWHID for content from stdin
+
+      Options:
+        -f, --format FORMAT              Output format (text, json)
+        -q, --qualifier KEY=VALUE        Add qualifier to generated SWHID
+        -h, --help                       Show this help
+
+      Examples:
+        # Parse a SWHID
+        swhid parse swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2
+
+        # Generate SWHID from file content
+        cat file.txt | swhid content
+
+        # Generate SWHID with qualifiers
+        cat file.txt | swhid content -q origin=https://github.com/example/repo
+
+        # Output as JSON
+        swhid parse swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2 -f json
+
+      For more information, visit: https://www.swhid.org/
+    HELP
+  end
+end
+
+SwhidCLI.new(ARGV).run

data/lib/swhid/identifier.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module Swhid
+  class Identifier
+    attr_reader :scheme, :version, :object_type, :object_hash, :qualifiers
+
+    def initialize(object_type:, object_hash:, qualifiers: {})
+      @scheme = SCHEME
+      @version = SCHEME_VERSION
+      @object_type = validate_object_type!(object_type)
+      @object_hash = validate_object_hash!(object_hash)
+      @qualifiers = qualifiers
+    end
+
+    def self.parse(swhid_string)
+      raise ParseError, "SWHID string cannot be nil or empty" if swhid_string.nil? || swhid_string.empty?
+
+      core_part, *qualifier_parts = swhid_string.split(";")
+
+      parts = core_part.split(":")
+      raise ParseError, "Invalid SWHID format" unless parts.length == 4
+
+      scheme, version, object_type, object_hash = parts
+
+      raise ParseError, "Invalid scheme: #{scheme}" unless scheme == SCHEME
+      raise ParseError, "Invalid version: #{version}" unless version == SCHEME_VERSION.to_s
+
+      qualifiers = parse_qualifiers(qualifier_parts)
+
+      new(object_type: object_type, object_hash: object_hash, qualifiers: qualifiers)
+    end
+
+    def to_s
+      core = "#{scheme}:#{version}:#{object_type}:#{object_hash}"
+      return core if qualifiers.empty?
+
+      qualifier_string = format_qualifiers(qualifiers)
+      "#{core};#{qualifier_string}"
+    end
+
+    def core_swhid
+      "#{scheme}:#{version}:#{object_type}:#{object_hash}"
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Identifier)
+
+      core_swhid == other.core_swhid && qualifiers == other.qualifiers
+    end
+
+    def hash
+      [core_swhid, qualifiers].hash
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    private
+
+    def validate_object_type!(type)
+      unless VALID_OBJECT_TYPES.include?(type)
+        raise ValidationError, "Invalid object type: #{type}. Must be one of: #{VALID_OBJECT_TYPES.join(", ")}"
+      end
+      type
+    end
+
+    def validate_object_hash!(hash)
+      unless hash =~ /\A[0-9a-f]{#{OBJECT_ID_LENGTH}}\z/
+        raise ValidationError, "Invalid object hash: #{hash}. Must be #{OBJECT_ID_LENGTH} hex digits"
+      end
+      hash
+    end
+
+    def self.parse_qualifiers(qualifier_parts)
+      qualifiers = {}
+
+      qualifier_parts.each do |part|
+        key, value = part.split("=", 2)
+        next if key.nil? || value.nil?
+
+        qualifiers[key.to_sym] = decode_qualifier_value(value)
+      end
+
+      qualifiers
+    end
+
+    def self.decode_qualifier_value(value)
+      URI.decode_www_form_component(value)
+    end
+
+    def format_qualifiers(quals)
+      canonical_order = [:origin, :visit, :anchor, :path, :lines, :bytes]
+
+      ordered_quals = canonical_order.map do |key|
+        next unless quals.key?(key)
+
+        "#{key}=#{encode_qualifier_value(quals[key])}"
+      end.compact
+
+      other_quals = quals.reject { |key, _| canonical_order.include?(key) }.map do |key, value|
+        "#{key}=#{encode_qualifier_value(value)}"
+      end
+
+      (ordered_quals + other_quals).join(";")
+    end
+
+    def encode_qualifier_value(value)
+      value.to_s.gsub(";", "%3B").gsub("%", "%25")
+    end
+  end
+end

data/lib/swhid/objects/content.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "digest/sha1"
+
+module Swhid
+  module Objects
+    class Content
+      def self.compute(data)
+        data = data.to_s if data.is_a?(Symbol)
+        data = data.b if data.respond_to?(:b)
+
+        header = "blob #{data.bytesize}\0"
+        hash = Digest::SHA1.hexdigest(header + data)
+
+        Identifier.new(object_type: "cnt", object_hash: hash)
+      end
+
+      def self.compute_hash(data)
+        compute(data).object_hash
+      end
+    end
+  end
+end

data/lib/swhid/objects/directory.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "digest/sha1"
+
+module Swhid
+  module Objects
+    class Directory
+      class Entry
+        attr_reader :name, :type, :target, :perms
+
+        def initialize(name:, type:, target:, perms: nil)
+          @name = name
+          @type = type
+          @target = target
+          @perms = perms || default_perms
+        end
+
+        def default_perms
+          case type
+          when :dir
+            "040000"
+          when :file
+            "100644"
+          when :exec
+            "100755"
+          when :symlink
+            "120000"
+          else
+            raise ValidationError, "Unknown entry type: #{type}"
+          end
+        end
+
+        def sort_key
+          type == :dir ? "#{name}/" : name
+        end
+
+        def target_hash
+          case target
+          when String
+            raise ValidationError, "Invalid hash length" unless target.length == 40
+            [target].pack("H*")
+          when Identifier
+            [target.object_id].pack("H*")
+          else
+            raise ValidationError, "Invalid target type"
+          end
+        end
+      end
+
+      def self.compute(entries)
+        serialized = serialize_entries(entries)
+        header = "tree #{serialized.bytesize}\0"
+        hash = Digest::SHA1.hexdigest(header + serialized)
+
+        Identifier.new(object_type: "dir", object_hash: hash)
+      end
+
+      def self.serialize_entries(entries)
+        entries = entries.map do |entry_data|
+          if entry_data.is_a?(Entry)
+            entry_data
+          else
+            Entry.new(**entry_data)
+          end
+        end
+
+        sorted_entries = entries.sort_by(&:sort_key)
+
+        sorted_entries.map do |entry|
+          "#{entry.perms} #{entry.name}\0#{entry.target_hash}"
+        end.join
+      end
+
+      def self.compute_hash(entries)
+        compute(entries).object_hash
+      end
+    end
+  end
+end

data/lib/swhid/objects/release.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "digest/sha1"
+
+module Swhid
+  module Objects
+    class Release
+      OBJECT_TYPE_MAPPING = {
+        "cnt" => "blob",
+        "dir" => "tree",
+        "rev" => "commit",
+        "rel" => "tag",
+        "snp" => "snapshot"
+      }.freeze
+
+      def self.compute(metadata)
+        serialized = serialize_metadata(metadata)
+        header = "tag #{serialized.bytesize}\0"
+        hash = Digest::SHA1.hexdigest(header + serialized)
+
+        Identifier.new(object_type: "rel", object_hash: hash)
+      end
+
+      def self.serialize_metadata(metadata)
+        lines = []
+
+        raise ValidationError, "Name is required" unless metadata[:name]
+        raise ValidationError, "Target is required" unless metadata[:target]
+
+        target_hash, target_type = extract_target(metadata[:target])
+        lines << "object #{target_hash}"
+        lines << "type #{target_type}"
+        lines << "tag #{metadata[:name].gsub("\n", "\n ")}"
+
+        if metadata[:author]
+          raise ValidationError, "Author timestamp is required when author is present" unless metadata[:author_timestamp]
+
+          author_line = format_person_line("tagger", metadata[:author], metadata[:author_timestamp], metadata[:author_timezone])
+          lines << author_line
+        end
+
+        result = lines.join("\n") + "\n"
+
+        if metadata[:message]
+          result += "\n#{metadata[:message]}"
+        end
+
+        result
+      end
+
+      def self.format_person_line(prefix, person, timestamp, timezone)
+        tz = timezone || "+0000"
+        person_escaped = person.gsub("\n", "\n ")
+        "#{prefix} #{person_escaped} #{timestamp} #{tz}"
+      end
+
+      def self.extract_target(target)
+        case target
+        when Hash
+          hash = target[:hash] || target[:id]
+          type = target[:type]
+          raise ValidationError, "Target hash and type required" unless hash && type
+          [hash, OBJECT_TYPE_MAPPING[type] || type]
+        when Identifier
+          [target.object_hash, OBJECT_TYPE_MAPPING[target.object_type] || target.object_type]
+        else
+          raise ValidationError, "Invalid target format"
+        end
+      end
+
+      def self.compute_hash(metadata)
+        compute(metadata).object_hash
+      end
+    end
+  end
+end

data/lib/swhid/objects/revision.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "digest/sha1"
+
+module Swhid
+  module Objects
+    class Revision
+      def self.compute(metadata)
+        serialized = serialize_metadata(metadata)
+        header = "commit #{serialized.bytesize}\0"
+        hash = Digest::SHA1.hexdigest(header + serialized)
+
+        Identifier.new(object_type: "rev", object_hash: hash)
+      end
+
+      def self.serialize_metadata(metadata)
+        lines = []
+
+        directory = extract_hash(metadata[:directory])
+        raise ValidationError, "Directory is required" unless directory
+        lines << "tree #{directory}"
+
+        parents = Array(metadata[:parents] || [])
+        parents.each do |parent|
+          parent_hash = extract_hash(parent)
+          lines << "parent #{parent_hash}"
+        end
+
+        raise ValidationError, "Author is required" unless metadata[:author]
+        raise ValidationError, "Author timestamp is required" unless metadata[:author_timestamp]
+
+        author_line = format_person_line("author", metadata[:author], metadata[:author_timestamp], metadata[:author_timezone])
+        lines << author_line
+
+        raise ValidationError, "Committer is required" unless metadata[:committer]
+        raise ValidationError, "Committer timestamp is required" unless metadata[:committer_timestamp]
+
+        committer_line = format_person_line("committer", metadata[:committer], metadata[:committer_timestamp], metadata[:committer_timezone])
+        lines << committer_line
+
+        extra_headers = metadata[:extra_headers] || []
+        extra_headers.each do |key, value|
+          lines << format_header_line(key, value)
+        end
+
+        result = lines.join("\n") + "\n"
+
+        if metadata[:message]
+          result += "\n#{metadata[:message]}"
+        end
+
+        result
+      end
+
+      def self.format_person_line(prefix, person, timestamp, timezone)
+        tz = timezone || "+0000"
+        person_escaped = person.gsub("\n", "\n ")
+        "#{prefix} #{person_escaped} #{timestamp} #{tz}"
+      end
+
+      def self.format_header_line(key, value)
+        value_escaped = value.gsub("\n", "\n ")
+        "#{key} #{value_escaped}"
+      end
+
+      def self.extract_hash(value)
+        case value
+        when String
+          value.length == 40 ? value : nil
+        when Identifier
+          value.object_hash
+        else
+          nil
+        end
+      end
+
+      def self.compute_hash(metadata)
+        compute(metadata).object_hash
+      end
+    end
+  end
+end

data/lib/swhid/objects/snapshot.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "digest/sha1"
+
+module Swhid
+  module Objects
+    class Snapshot
+      class Branch
+        attr_reader :name, :target_type, :target
+
+        def initialize(name:, target_type:, target: nil)
+          @name = name
+          @target_type = target_type
+          @target = target
+        end
+
+        def serialize
+          target_identifier = compute_target_identifier
+          target_length = target_identifier.bytesize
+
+          "#{target_type} #{name}\0#{target_length}:#{target_identifier}"
+        end
+
+        private
+
+        def compute_target_identifier
+          case target_type
+          when "content", "directory", "revision", "release", "snapshot"
+            extract_hash_bytes(target)
+          when "alias"
+            target.to_s.b
+          when "dangling"
+            "".b
+          else
+            raise ValidationError, "Invalid target type: #{target_type}"
+          end
+        end
+
+        def extract_hash_bytes(value)
+          hash_string = case value
+                       when String
+                         value.length == 40 ? value : nil
+                       when Identifier
+                         value.object_hash
+                       else
+                         nil
+                       end
+
+          raise ValidationError, "Invalid target hash" unless hash_string
+
+          [hash_string].pack("H*")
+        end
+      end
+
+      def self.compute(branches)
+        serialized = serialize_branches(branches)
+        header = "snapshot #{serialized.bytesize}\0"
+        hash = Digest::SHA1.hexdigest(header + serialized)
+
+        Identifier.new(object_type: "snp", object_hash: hash)
+      end
+
+      def self.serialize_branches(branches)
+        branch_objects = branches.map do |branch_data|
+          if branch_data.is_a?(Branch)
+            branch_data
+          else
+            Branch.new(**branch_data)
+          end
+        end
+
+        sorted_branches = branch_objects.sort_by(&:name)
+
+        sorted_branches.map(&:serialize).join
+      end
+
+      def self.compute_hash(branches)
+        compute(branches).object_hash
+      end
+    end
+  end
+end

data/lib/swhid/version.rb

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

data/lib/swhid.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "swhid/version"
+require_relative "swhid/identifier"
+require_relative "swhid/objects/content"
+require_relative "swhid/objects/directory"
+require_relative "swhid/objects/revision"
+require_relative "swhid/objects/release"
+require_relative "swhid/objects/snapshot"
+
+module Swhid
+  class Error < StandardError; end
+  class ParseError < Error; end
+  class ValidationError < Error; end
+
+  SCHEME = "swh"
+  SCHEME_VERSION = 1
+  VALID_OBJECT_TYPES = %w[cnt dir rev rel snp].freeze
+  OBJECT_ID_LENGTH = 40
+
+  def self.parse(swhid_string)
+    Identifier.parse(swhid_string)
+  end
+
+  def self.from_content(content)
+    Objects::Content.compute(content)
+  end
+
+  def self.from_directory(entries)
+    Objects::Directory.compute(entries)
+  end
+
+  def self.from_revision(metadata)
+    Objects::Revision.compute(metadata)
+  end
+
+  def self.from_release(metadata)
+    Objects::Release.compute(metadata)
+  end
+
+  def self.from_snapshot(branches)
+    Objects::Snapshot.compute(branches)
+  end
+end

data/sig/swhid.rbs

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

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: swhid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Nesbitt
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby library and CLI for generating and parsing SoftWare Hash IDentifiers
+  (SWHIDs). Supports all object types (content, directory, revision, release, snapshot)
+  and qualifiers. Compatible with Git object hashing.
+email:
+- andrewnez@gmail.com
+executables:
+- swhid
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- Rakefile
+- exe/swhid
+- lib/swhid.rb
+- lib/swhid/identifier.rb
+- lib/swhid/objects/content.rb
+- lib/swhid/objects/directory.rb
+- lib/swhid/objects/release.rb
+- lib/swhid/objects/revision.rb
+- lib/swhid/objects/snapshot.rb
+- lib/swhid/version.rb
+- sig/swhid.rbs
+homepage: https://github.com/andrew/swhid
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andrew/swhid
+  source_code_uri: https://github.com/andrew/swhid
+  changelog_uri: https://github.com/andrew/swhid/blob/main/CHANGELOG.md
+  documentation_uri: https://www.swhid.org/specification
+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.6.9
+specification_version: 4
+summary: Generate and parse SoftWare Hash IDentifiers (SWHIDs)
+test_files: []