ctypes 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ec7b7f88b8d9103fce2b420944392299eb38d346757307cfa84c0f554f44799
+  data.tar.gz: da001e06c9e3569252953248b2dede7d1051f442329088cef30b8442ea4175ea
+SHA512:
+  metadata.gz: 952e0fc657ccbdf8bf4b92ee0efdd2c1023aa80a9cfd4aaf3597e32c6d36cd1ea4d2eb57926868561710ee06e8c1c7810d5ba641e1eac7d8f381681ea76fdcdc
+  data.tar.gz: 9150e84ef5ce4e50f265b13b10b0744f384038ad6b760f98321ec7833be882b3016f8c168e348414234b72a34caad7dfc0859afa3c2cfce74501b0ca981fa882

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 3.1

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
+`dlary[at]cisco<dot>com`. 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/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# How to Contribute
+
+Thanks for your interest in contributing to `ctypes`! Here are a few
+general guidelines on contributing and reporting bugs that we ask you to review.
+Following these guidelines helps to communicate that you respect the time of the
+contributors managing and developing this open source project. In return, they
+should reciprocate that respect in addressing your issue, assessing changes, and
+helping you finalize your pull requests. In that spirit of mutual respect, we
+endeavor to review incoming issues and pull requests within 10 days, and will
+close any lingering issues or pull requests after 60 days of inactivity.
+
+Please note that all of your interactions in the project are subject to our
+[Code of Conduct](/CODE_OF_CONDUCT.md). This includes creation of issues or pull
+requests, commenting on issues or pull requests, and extends to all interactions
+in any real-time space e.g., Slack, Discord, etc.
+
+## Reporting Issues
+
+Before reporting a new issue, please ensure that the issue was not already
+reported or fixed by searching through our
+[issues list](https://github.com/cisco-open/ctypes/issues).
+
+When creating a new issue, please be sure to include a **title and clear
+description**, as much relevant information as possible, and, if possible, a
+test case.
+
+**If you discover a security bug, please do not report it through GitHub.
+Instead, please see security procedures in [SECURITY.md](/SECURITY.md).**
+
+## Sending Pull Requests
+
+Before sending a new pull request, take a look at existing pull requests and
+issues to see if the proposed change or fix has been discussed in the past, or
+if the change was already implemented but not yet released.
+
+We expect new pull requests to include tests for any affected behavior, and,
+as we follow semantic versioning, we may reserve breaking changes until the
+next major version release.
+
+## Other Ways to Contribute
+
+We welcome anyone that wants to contribute to `ctypes` to triage and
+reply to open issues to help troubleshoot and fix existing bugs. Here is what
+you can do:
+
+- Help ensure that existing issues follows the recommendations from the
+  _[Reporting Issues](#reporting-issues)_ section, providing feedback to the
+  issue's author on what might be missing.
+- Review existing pull requests, and testing patches against real existing
+  applications that use `ctypes`.
+- Write a test, or add a missing test case to an existing test.
+
+Thanks again for your interest on contributing to `ctypes`!
+
+:heart:

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ctypes.gemspec
+gemspec
+
+gem "nokogiri", "~> 1.13", require: false
+gem "pry", "~> 0.14"
+gem "pry-rescue", "~> 1.5"
+gem "pry-stack_explorer", "~> 0.6"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "standard", "~> 1.3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Cisco
+
+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/MAINTAINERS.md

@@ -0,0 +1,3 @@
+# Maintainers
+
+- [dmlary](https://github.com/dmlary)

data/README.md

@@ -0,0 +1,390 @@
+# CTypes Ruby Gem
+
+[![Version](https://img.shields.io/gem/v/ctypes.svg)](https://rubygems.org/gems/ctypes)
+[![GitHub](https://img.shields.io/badge/github-elf__utils-blue.svg)](http://github.com/cisco-open/ruby-ctypes)
+[![Documentation](https://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://rubydoc.org/gems/ruby-ctypes/frames)
+
+[![Contributor-Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-fbab2c.svg)](CODE_OF_CONDUCT.md)
+[![Maintainer](https://img.shields.io/badge/Maintainer-Cisco-00bceb.svg)](https://opensource.cisco.com)
+
+Manipulate common C types in Ruby.
+
+- unpack complex binary data into ruby types, modify, and repack them as binary 
+- bounds checking on types (when packing)
+- complex types supported
+    - structs with flexible array members
+    - arrays terminated by specific values
+    - strings terminated by a specific byte sequence
+- flexible endian support
+    - default endian globally configurable; defaults to host endian
+    - individual types can have fixed-endian
+    - structs support per attribute endian
+- minimal reserved words for Union and Struct types
+    - want to avoid colliding with struct & union field names so you don't have
+      to rename fields like `len`
+- reloadable type definitions (pry `reload-code` friendly)
+    - useful for using REPL-based development
+
+## Comparisons
+- BinData gem:
+    - Tightly coupled with file I/O
+    - no support for non-blocking I/O (non-blocking network sockets)
+    - reserves common struct attribute names such as `len`
+    - does not support reloading of types (pry `reload-code`)
+- Fiddle gem:
+    - only supports native endian
+    - no support for dynamically sized & terminated types
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add ctypes
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install ctypes
+
+## Usage
+
+### Basic types
+```ruby
+require "ctypes"
+
+# load optional helpers for common types
+include CTypes::Helpers
+
+# common integer types all defined: uint64, int64, ..., uint8, int8
+# can be used to pack and unpack values
+uint32.pack(0xfeedface)                     # => "\xce\xfa\xed\xfe"
+uint32.pack(0xfeedface, endian: :big)       # => "\xfe\xed\xfa\xce"
+uint32.unpack("\xce\xfa\xed\xfe")           # => 0xfeedface
+uint32.unpack("\xfe\xed\xfa\xce", endian: :big)
+                                            # => 0xfeedface
+
+# `unpack_one` can be used to manually unpack sequential types from a string. # We recommend using `CTypes::Struct` for complex types, but this approach
+# can be useful when exploring binary data.
+buf = "\xaa\xbb\xcc\xdd\x11\x22"
+word, buf = uint32.unpack_one(buf)          # => [0xddccbbaa, "\x11\x22"]
+hword, buf = uint16.unpack_one(buf)         # => [0x2211, ""]
+
+# create fixed-endian types from existing types
+u32be = uint32.with_endian(:big)
+u32be.pack(0xfeedface)                      # => "\xfe\xed\xfa\xce"
+
+# c strings (char[], uint8[], int8[]) supported by string
+string.unpack("hello world\0\0\0\0")        # => "hello world"
+string.pack("hello world")                  # => "hello world"
+
+# note: by default strings are greedy; they will consume all bytes in the
+# input, but only return the bytes up to the first null byte
+string.unpack("first\0second\0")            # => ["first", ""]
+
+# to unpack null-terminated strings use string.terminated
+_, rest = string.terminated.unpack("first\0second\0")
+                                            # => ["first", "second\x00"]
+string.terminated.unpack(rest)              # => ["second", ""]
+string.terminated.pack("first")             # => "first\0"
+
+# other bytes can be used to terminate strings
+t = string.terminated("\xff")
+t.unpack("test\xff")                        # => "test"
+t.pack("hello\0world")                      # => "hello\x00world\xFF"
+
+# along with byte sequences
+t = string.terminated("STOP")
+t.unpack("this is the messageSTOPnext messageSTOP")
+                                            # => "this is the message"
+t.pack("this is a reply")                   # => "this is a replySTOP"
+
+# fixed-width string (char[16])
+string(16).pack("hello world")              # => "hello world\0\0\0\0\0"
+string(16).unpack("hello world\0\0\0\0\0")  # => "hello world\0\0\0\0\0"
+string(16).unpack("hello world")            # => Exception raised
+
+# fixed-width string, but preserve null bytes when unpacking
+char_16 = string(16, trim: false)
+char_16.unpack("hello world\0\0\0\0\0")     # => "hello world\0\0\0\0\0"
+char_16.pack("hello world")                 # => "hello world\0\0\0\0\0"
+
+```
+
+### Arrays
+```ruby
+require "ctypes"
+include CTypes::Helpers
+
+# fixed-length arrays
+pair = array(uint32, 2)
+pair.unpack("\x01\x02\x03\x04\x05\x06\x07\x08")
+                                            # => [0x04030201, 0x08070605]
+pair.unpack("\x01\x02\x03\x04\x05\x06\x07\x08\xff\xff\xff\xff")
+                                            # => [0x04030201, 0x08070605]
+
+# dynamic length (greedy) arrays
+bytes = array(uint8)
+bytes.unpack("hello")                       # => [104, 101, 108, 108, 111]
+bytes.unpack("\1\2\3")                      # => [1, 2, 3]
+bytes.pack([4,5,6])                         # => "\4\5\6"
+
+# any type can be converted to a fixed-endian type
+be_pair = pair.with_endian(:big)
+be_pair.unpack("\x01\x02\x03\x04\x05\x06\x07\x08")
+                                            # => [0x01020304, 0x05060708]
+
+# and it can be done for the inner type too
+be_pair_inner = array(uint8.with_endian(:big))
+be_pair_inner.unpack("\x01\x02\x03\x04\x05\x06\x07\x08")
+                                            # => [0x01020304, 0x05060708]
+
+# array of null-terminated strings, terminated by an empty string
+strings = array(string.terminated("\0"), terminator: "")
+strings.unpack("first\0second\0third\0\0")
+                                            # => ["first", "second", "third"]
+
+# array of integers, terminated by -1
+ints = array(int8, terminator: -1)
+ints.pack([1, 2, 3, 4])                     # => "\x01\x02\x03\x04\xFF"
+ints.unpack("\x01\x02\x03\x04\xFFtail")     # => [1, 2, 3, 4]
+ints.unpack_one("\x01\x02\x03\x04\xFFtail") # => [[1, 2, 3, 4], "tail"]
+
+# array of structs; terminated by the :end type
+type = struct do
+  attribute :type, enum(uint8, %i[record end])
+  attribute :value, uint32
+end
+records = array(type, terminator: {type: :end, value: 0})
+records.pack([{type: :record, value: 0xffff}])
+                            # => "\x00\xFF\xFF\x00\x00\x01\x00\x00\x00\x00"
+records.unpack("\x00\xFF\xFF\x00\x00\x01\x00\x00\x00\x00")
+                            # => struct {
+                            #       .type = :record,
+                            #       .value = 65535 (0xffff), }
+```
+
+### Enums
+```ruby
+require "ctypes"
+include CTypes::Helpers
+
+# default enum is uint32, start numbering at zero
+state = enum(%i[invalid running sleep blocked])
+state.pack(:running)                        # => "\1\0\0\0"
+
+# can use other integer types
+state = enum(uint8, %i[invalid running sleep blocked])
+state.pack(:running)                        # => "\1"
+
+# can be sparse
+state = enum(uint8, {invalid: 0, running: 5, sleep: 6, blocked: 0xff})
+state.pack(:blocked)                        # => "\xff"
+
+# same as above with block syntax
+state = enum(uint8) do |e|
+  e << :invalid
+  e << {running: 5}
+  e << :sleep # assigned value 6
+  e << {blocked: 0xff}
+end
+state.pack(:blocked)                        # => "\xff"
+```
+
+### Structures
+```ruby
+# Declare a TLV struct.  Size of each structure is determined by the `len`
+# field.
+class TLV < CTypes::Struct
+  layout do
+    endian :big     # all fields will use network-byte order
+    attribute :type, enum(uint8, %i[invalid hello read write goodbye])
+    attribute :len, uint32
+    attribute :value, string
+    # dynamically determine the size of the struct when unpacking
+    size { |struct| offsetof(:value) + struct[:len] }
+  end
+end
+
+# pack the tlv struct
+version = "v1.0"
+TLV.pack({type: :hello, len: version.size, value: version})
+                                    # => "\x01\x04\x00\x00\x00v1.0"
+
+# unpack a binary structure
+msg = TLV.unpack("\x01\x04\x00\x00\x00v1.0")
+msg.type                            # => :hello
+msg.value                           # => "v1.0"
+
+# modify the structure and repack into binary representation
+msg.type = :goodbye
+msg.len = 0
+msg.to_binstr                       # => "\x04\x00\x00\x00\x00"
+```
+
+### Unions
+Note: because the underlying memory for union values is not shared between each
+member, accessing multiple members in a union does have a performance penalty
+to pack the existing member and unpack the new member.  This penalty can be
+avoided for read-only unions by freezing the union instance.
+
+```ruby
+class Msg < CTypes::Union
+  layout do
+    endian :big # network byte-order
+
+    type = enum(uint8, {invalid: 0, hello: 1, read: 2})
+    member :hello, struct({type:, version: string})
+    member :read, struct({type:, offset: uint64, len: uint64})
+    member :type, type
+  end
+end
+
+# provide only one member when packing
+Msg.pack({hello: {type: :hello, version: "v1.0"}})    # => "\x01v1.0\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+Msg.pack({read: {type: :read, offset: 0xfeed, len: 0xdddd}}) # => "\x02\x00\x00\x00\x00\x00\x00\xFE\xED\x00\x00\x00\x00\x00\x00\xDD\xDD"
+
+# unpack a message and access member values
+msg = Msg.unpack("\x02" +
+                 "\xfe\xfe\xfe\xfe\xfe\xfe\xfe\xfe" +
+                 "\xab\xab\xab\xab\xab\xab\xab\xab")
+msg.type                      # => :read
+msg.read.offset               # => 18374403900871474942
+msg.read.len                  # => 12370169555311111083
+
+# modify and pack into binary
+msg.hello.type = :hello
+msg.hello.version = "v1.0"
+msg.to_binstr                 # => "\x01v1.0\xFE\xFE\xFE\xFE\xAB\xAB\xAB\xAB\xAB\xAB\xAB\xAB"
+```
+
+### Terminated
+Some greedy dynamic length types are terminated with byte sequences, or
+variable byte sequences.  To handle these types we use CTypes::Terminated.
+
+```ruby
+# string.terminated returns a CTypes::Terminated instance
+telegram = string.terminated("STOP")
+telegrams = array(telegram)
+telegrams.unpack("hello worldSTOPnext messageSTOP")
+                              # => ["hello world", "next message"]
+
+
+# record is an id along with an array of data bytes
+record = struct({id: uint8, data: array(uint8)})
+# each record is terminated with the byte sequence \xff\xee (for reasons?)
+term = "\xff\xee"
+# create a terminated type for the record (yea, it is ugly right now)
+terminated_record = CTypes::Terminated
+    .new(type: record,
+         locate: proc { |b,_| [b.index(term), term.size] },
+         terminate: term)
+# and then an array of terminated records type
+records = array(terminated_record)
+
+# now pack & unpack as needed
+records.pack([
+    {id: 1, data: [1, 2, 3, 4]},
+    {id: 2, data: [5, 5]},
+    {id: 3}
+])          # => "\x01\x01\x02\x03\x04\xFF\xEE\x02\x05\x05\xFF\xEE\x03\xFF\xEE"
+records.unpack("\x01\x01\x02\x03\x04\xFF\xEE\x02\x05\x05\xFF\xEE\x03\xFF\xEE")
+            # => [#<struct id=1, data=[1, 2, 3, 4]>,
+            #     #<struct id=2, data=[5, 5]>,
+            #     #<struct id=3, data=[]>]
+```
+
+### Custom Types
+Custom types can be created then used within other CTypes. The following is an
+custom CTypes implementation of the DWARF ULEB128 datatype.  It is a compressed
+representation of a 128-bit integer that uses 7 bits per byte for the encoded
+value, with the highest bit set on the last byte of the value. The bytes are
+stored in little endian order.
+
+```ruby
+module ULEB128
+  extend CTypes::Type
+
+  # declare the underlying DRY type; it must have a default value, and may
+  # have constraints set
+  @dry_type = Dry::Types["integer"].default(0)
+
+  # as this is a dynamically sized type, let's set size to be the minimum size
+  # for the type (1 byte), and ensure .fixed_size? returns false
+  @size = 1
+  def self.fixed_size?
+    false
+  end
+
+  # provide a method for packing the ruby value into the binary representation
+  def self.pack(value, endian: default_endian, validate: true)
+    return "\x80" if value == 0
+    buf = String.new
+    while value != 0
+      buf << (value & 0x7f)
+      value >>= 7
+    end
+    buf[-1] = (buf[-1].ord | 0x80).chr
+    buf
+  end
+
+  # provide a method for unpacking an instance of this type from a String, and
+  # returning both the unpacked value, and any unused input
+  def self.unpack_one(buf, endian: default_endian)
+    value = 0
+    shift = 0
+    len = 0
+    buf.each_byte do |b|
+      len += 1
+      value |= ((b & 0x7f) << shift)
+      return value, buf[len...] if (b & 0x80) != 0
+      shift += 7
+    end
+    raise TerminatorNotFoundError
+  end
+end
+
+# now the type can be used like any other type
+ULEB128.unpack_one("\x7f\x7f\x83XXX")       # => [0xffff, "XXX"]
+ULEB128.unpack("\x7f\x7f\x83")              # => 0xffff
+ULEB128.unpack("\x81XXX")                   # => 1
+ULEB128.pack(0)                             # => "\x80"
+ULEB128.pack(1)                             # => "\x81"
+ULEB128.pack(0xffff)                        # => "\x7F\x7F\x83"
+
+# use it in an array
+list = array(ULEB128)
+list.unpack("\x7f\x7f\x83\x81\x80")         # => [65535, 1, 0]
+
+# or a struct
+t = struct(id: uint32, value: ULEB128)
+t.unpack("\1\0\0\0\x7f\x7f\x83XXX")         # => #<struct id=1, value=65535>
+```
+
+## Roadmap
+
+See the [open issues](https://github.com/cisco-open/ruby-ctypes/issues) for a
+list of proposed features (and known issues).
+
+## Development
+
+After checking out the repo, run `bundle install` 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
+
+Contributions are what make the open source community such an amazing place to
+learn, inspire, and create. Any contributions you make are **greatly
+appreciated**. For detailed contributing guidelines, please see
+[CONTRIBUTING.md](CONTRIBUTING.md)
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+License. See [LICENSE.txt](LICENSE.txt) for more information.

data/Rakefile

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