cbor.rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: babab2260657b25d829208f3b2cc42735d5ba37c4fb30b7f71caf8b00b5647e9
+  data.tar.gz: bac1c179a33eece6df26d23a0459b3983dbd9f651ffe575bdbeff786c0888443
+SHA512:
+  metadata.gz: e35e51ffa2061a2dc702182ff998ac3f7e57adee916bae74431865732ac800d23124f7da79b26033128b17f33f1de22b793eb495bef975e9a81a9df32a14f2bd
+  data.tar.gz: 950492dd006dd68c56aea9aed828d9a027497090a5053570735b8a33f82cfa808da9df90de055147e44f0b107eb6070cbcb062e31b971649c1a142dcffb8bad5

data/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.{rb,yml,yaml,jbuilder}]
+charset = utf-8
+indent_style = space
+indent_size = 2

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,42 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - spec/*
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/CaseIndentation:
+  EnforcedStyle: end

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/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Vito Sartori
+
+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,29 @@
+# CBOR.rb
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add cbor.rb
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install cbor.rb
+
+## Usage
+
+TBD
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/heyvito/cbor.rb. 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/heyvito/cbor.rb/blob/master/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Cbor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/heyvito/cbor.rb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/cbor/version.rb

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

data/lib/cbor.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require_relative "cbor/version"
+
+class CBOR
+  class Error < StandardError; end
+  class InvalidCBORError < Error; end
+
+  NULL = 0x00
+  MAJOR_TYPE_MASK = 0x1F
+  DECODERS = {
+    0 => :decode_unsigned_int,
+    1 => :decode_negative_int,
+    2 => :decode_byte_string,
+    3 => :decode_text_string,
+    4 => :decode_array,
+    5 => :decode_map,
+    6 => :decode_tagged_value,
+    7 => :decode_misc_value
+  }.freeze
+
+  def self.decode(data) = new(data).decode
+
+  def self.decode2(data)
+    inst = new(data)
+    ret = inst.decode
+    [ret, inst.cursor]
+  end
+
+  HEX_STRING = /^[a-fA-F0-9]*$/
+
+  def initialize(data)
+    @data = case data
+    when String
+      if HEX_STRING.match? data
+        [data].pack("H*").unpack("C*")
+      else
+        data.unpack("C*")
+      end
+    when Array
+      data
+    end
+    @cur = 0
+    @len = @data.length
+  end
+
+  def cursor = @cur
+
+  def decode
+    decoder = DECODERS[peek_major_type]
+    raise InvalidCBORError, "Invalid CBOR: Unknown major type #{peek_major_type}" if decoder.nil?
+
+    send(decoder)
+  end
+
+  private
+
+  def peek
+    return NULL if @cur >= @len
+
+    @data[@cur]
+  end
+
+  def advance
+    return NULL if @cur >= @len
+
+    @data[@cur].tap { @cur += 1 }
+  end
+
+  def take(n) = @data[@cur...@cur + n].tap { @cur += n }
+
+  def peek_major_type = peek >> 5
+
+  def decode_unsigned_int
+    v = advance & MAJOR_TYPE_MASK
+    return v if v < 24
+
+    case v
+    when 24
+      advance
+    when 25
+      take(2).pack("C*").unpack1("S>")
+    when 26
+      take(4).pack("C*").unpack1("L>")
+    when 27
+      take(8).pack("C*").unpack1("Q>")
+    else
+      raise InvalidCBORError, "Invalid CBOR: Unknown unsigned int type #{v}"
+    end
+  end
+
+  def decode_negative_int
+    v = advance & MAJOR_TYPE_MASK
+    return -1 - v if v < 24
+
+    case v
+    when 24
+      -1 - advance
+    when 25
+      -1 - take(2).pack("C*").unpack1("S>")
+    when 26
+      -1 - take(4).pack("C*").unpack1("L>")
+    when 27
+      -1 - take(8).pack("C*").unpack1("Q>")
+    else
+      raise InvalidCBORError, "Invalid CBOR: Unknown unsigned int type #{v}"
+    end
+  end
+
+  def decode_object_length
+    len = advance & MAJOR_TYPE_MASK
+    if len >= 24
+      len = case len
+      when 24
+        advance
+      when 25
+        take(2).pack("C*").unpack1("S>")
+      when 26
+        take(4).pack("C*").unpack1("L>")
+      when 27
+        take(8).pack("C*").unpack1("Q>")
+      else
+        raise InvalidCBORError, "Invalid CBOR: Unknown unsigned int type for string length #{v}"
+      end
+    end
+
+    len
+  end
+
+  def decode_byte_string
+    len = decode_object_length
+    take(len).pack("C*")
+  end
+
+  def decode_text_string = decode_byte_string
+
+  def decode_array
+    len = decode_object_length
+
+    # TODO: Support float (tagged)
+    len.times.to_a.map { decode }
+  end
+
+  def decode_map
+    len = decode_object_length
+    {}.tap do |r|
+      len.times { r[decode] = decode }
+    end
+  end
+
+  def decode_misc_value
+    value = peek & MAJOR_TYPE_MASK
+    if value <= 23
+      case value
+      when 20
+        false
+      when 21
+        true
+      when 22, 23
+        nil
+      end
+
+    elsif value == 24
+      advance
+
+    else
+      raise NotImplementedError, "Decoder for misc type #{value} is not implemented"
+    end
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: cbor.rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vito Sartori
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-16 00:00:00.000000000 Z
+dependencies: []
+description: Pure-Ruby implementation of CBOR
+email:
+- hey@vito.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/cbor.rb
+- lib/cbor/version.rb
+homepage: https://github.com/heyvito/cbor.rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/heyvito/cbor.rb
+  source_code_uri: https://github.com/heyvito/cbor.rb
+  changelog_uri: https://github.com/heyvito/cbor.rb
+  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.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Pure-Ruby implementation of CBOR
+test_files: []