lexicoid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c5ba2e47db70f981a8b76ba0424726acab9b805b97daad96ae00aeac5201ad4
+  data.tar.gz: 7654c97ba2b93b91b4930768c4834b3e1127ff9ba793475cf3f683023f44da89
+SHA512:
+  metadata.gz: 9278e656eb7ae2506868f70d01920a88d17cfbde48218739bf6280b77ee721db1ae55f2f19ca4c08ce5eaac7c38c1e78c7447733c54aeb47a96c8f0556c2c55c
+  data.tar.gz: a49464b8626babea74781bc8cbfd864c565cb2b8a3939d49d86d497d9e06e5adf280de5ea9e0d112cc367ac7435f95651a5d1e654ed6b71c8e5bf2eedcced239

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0](https://github.com/michaelherold/lexicoid-ruby/tree/0.1.0) - 2023-03-19
+
+### Added
+
+- Converting timestamps in the form of `Integer`s, `Float`s, `Time`s, `DateTime`s, and anything responding to `#to_date`, including `ActiveSupport::TimeWithZone` via `Lexicoid.from`.
+- Generating the lexicoid for the current moment with `Lexicoid.now`.
+- Converting timestamps with the `Kernel#Lexicoid` method, with optional exception squelching via `Lexicoid(Time.now, exception: false)`.

data/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), we encourage **everyone** to help improve this project. Here are some ways _you_ can contribute:
+
+* Use alpha, beta, and pre-release versions.
+* Report bugs.
+* Suggest new features.
+* Write or edit documentation.
+* Write specifications.
+* Write code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace).
+* Refactor code.
+* Fix [issues].
+* Review patches.
+
+[issues]: https://github.com/michaelherold/lexicoid-ruby/issues
+
+## Submitting an Issue
+
+We use the [GitHub issue tracker][issues] to track bugs and features. Before submitting a bug report or feature request, check to make sure no one has already submitted it.
+
+When submitting a bug report, please include a `<details>` block that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. This looks like the following:
+
+```markdown
+<details>
+<summary>A description of the details block</summary>
+
+All of the content that you want in here, perhaps with code fences. Note that
+if you only have a code fence in here, you _must_ separate it from the <summary>
+tag and the closing </details> or it won't render correctly.
+
+Notice the empty line here ↓
+
+</details>
+```
+
+Ideally, a bug report should include a pull request with failing specs.
+
+## Submitting a Pull Request
+
+1. Fork the repository.
+2. Create a topic branch.
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake test`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake`. If your specs or any of the linters fail, return to step 5.
+7. Open `coverage/index.html`. If your changes are not fully covered by your tests, return to step 3.
+8. Add documentation for your feature or bug fix.
+9. Commit and push your changes.
+10. Submit a pull request.
+
+## Tools to Help You Succeed
+
+After checking out the repository, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Before committing code, run `bundle exec rake` to check that the code conforms to the style guidelines of the project, that all of the tests are green (if you're writing a feature; if you're only submitting a failing test, then it does not have to pass!), and that you sufficiently documented the changes.

data/LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright © 2023 Michael Herold
+
+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,92 @@
+# Lexicoid for Ruby
+
+Have you ever needed to convert a timestamp into something short, memorable, easy to look at, and easy to type? Look no further! You want a "lexicoid."
+
+Inspired by [Brandur Leach](https://brandur.org/fragments/base32-slugs), Lexicoid for Ruby gives you lexicographically sortable, time-based identifiers that are easy to read and easy to type; perfect for using in URLs and other places that take human input.
+
+Use lexicoids for anywhere that you have a timestamp that operates on "human scale" … think microblog status identifiers or URL-encoded timestamps. Avoid them for distributed systems; instead, consider something like [KSUID](https://github.com/michaelherold/ksuid-ruby) for that use case.
+
+## Installation
+
+Install the gem and add it to the application's Gemfile by executing:
+
+    $ bundle add lexicoid
+
+If you are not using Bundler to manage dependencies, install the gem by executing:
+
+    $ gem install lexicoid
+
+## Usage
+
+Generate a lexical identifier for the current moment:
+
+```ruby
+Lexicoid.now
+```
+
+Convert any time-related object to a lexical identifier:
+
+```ruby
+# Integer
+Lexicoid.from(1_678_767_177)
+
+# Float
+Lexicoid.from(1_678_767_285.293477)
+
+# Time
+Lexicoid.from(Time.now)
+
+# DateTime
+Lexicoid.from(DateTime.now)
+
+# ActiveSupport::TimeWithZone
+Lexicoid.from(2.weeks.ago)
+```
+
+There is also a `Kernel` method available for converting objects to lexicoids:
+
+```ruby
+Lexicoid(Time.now)
+
+Lexicoid("oops") #=> raises ArgumentError
+
+Lexicoid("oops", exception: false) #=> ""
+```
+
+## Contributing
+
+So you're interested in contributing to Lexicoid? Check out our [contributing guidelines](CONTRIBUTING.md) for more information on how to do that.
+
+## Supported Ruby Versions
+
+This library aims to support and is [tested against](https://github.com/michaelherold/lexicoid-ruby/actions) the following Ruby versions:
+
+* Ruby 3.0
+* Ruby 3.1
+* Ruby 3.2
+
+If something doesn't work on one of these versions, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby versions, however we will only provide support for the versions listed above.
+
+If you would like this library to support another Ruby version or implementation, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, we may drop support for that Ruby version.
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html). Report violations of this scheme should as bugs. Specifically, if a minor or patch version breaks backward compatibility, that version should be immediately yanked and/or a new version should be immediately released that restores compatibility. Only new major versions will introduce breaking changes to the public API. As a result of this policy, you can (and should) specify a dependency on this gem using the [pessimistic version constraint](http://guides.rubygems.org/patterns/#pessimistic-version-constraint) with two digits of precision. For example:
+
+    spec.add_dependency "lexicoid", "~> 0.1"
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+We expect everyone interacting in the Lexicoid for Ruby project's codebases, issue trackers, chat rooms and mailing lists to follow the [code of conduct](https://github.com/michaelherold/lexicoid/blob/main/CODE_OF_CONDUCT.md).
+
+## Acknowledgments
+
+[Brandur Leach](https://brandur.org/fragments/base32-slugs) wrote about the concept behind this gem and inspired its creation.
+
+[Luciano Mammino](https://loige.co/) took the first step, created a [Rust crate](https://crates.io/crates/lexicoid) and came up with the [excellent name](https://github.com/lmammino/lexicoid) for these identifiers.

data/lexicoid.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/lexicoid/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "lexicoid"
+  spec.version = Lexicoid::VERSION
+  spec.authors = ["Michael Herold"]
+  spec.email = ["opensource@michaeljherold.com"]
+
+  spec.summary = "Short and stable IDs from timestamps"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/michaelherold/lexicoid-ruby"
+  spec.license = "MIT"
+
+  spec.files = %w[CHANGELOG.md CONTRIBUTING.md LICENSE.md README.md]
+  spec.files += %w[lexicoid.gemspec]
+  spec.files += Dir["lib/**/*.rb"]
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.add_development_dependency "bundler", ">= 2"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/michaelherold/lexicoid-ruby/issues",
+    "changelog_uri" => "https://github.com/michaelherold/lexicoid-ruby/blob/main/CHANGELOG.md",
+    "documentation_uri" => "https://rubydoc.info/gems/lexicoid-ruby/#{Lexicoid::VERSION}",
+    "homepage_uri" => "https://github.com/michaelherold/lexicoid-ruby",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/michaelherold/lexicoid-ruby"
+  }
+end

data/lib/core_ext/kernel.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# The `Kernel` module is included by class `Object`, so its methods are available in every Ruby object.
+#
+# @see https://ruby-doc.org/current/Kernel.html
+module Kernel
+  private
+
+  # Returns a lexicographically sortable friendly ID for a timestamp
+  #
+  # @api public
+  # @since 0.1.0
+  # @!visibility public
+  #
+  # @example Converts a post's created-at timestamp to a friendly ID
+  #   Post = Struct.new(:created_at, keyword_init: true)
+  #   post = Post.new(created_at: Time.parse("2023-03-19 14:33:01.80251 -0500"))
+  #
+  #   Lexicoid(post.created_at) #=> "gkfqavc"
+  #
+  # @param object [ActiveSupport::TimeWithZone, DateTime, Float, Integer, Time, #to_time]
+  #   the object to convert into a lexicographically sorting friendly ID
+  # @param exception [Boolean] raises an ArgumentError when the argument is
+  #   improper and this is true, otherwise an improper argument leads to an empty string
+  # @return [String] the friendly ID
+  # @raise [ArgumentError] when the object is not a timestamp-like one
+  def Lexicoid(object, exception: true)
+    Lexicoid.from(object)
+  rescue ArgumentError
+    raise if exception
+    ""
+  end
+end

data/lib/lexicoid/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Lexicoid
+  # The version of the library
+  #
+  # @private
+  VERSION = "0.1.0"
+end

data/lib/lexicoid.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require_relative "lexicoid/version"
+
+# Generates lexicographically sortable, friendly IDs from timestamps
+#
+# A "lexicoid" is a short identifier derived from a timestamp for use in single
+# source streaming systems. They are based on an [approach for giving friendly
+# URLs to microblog posts, by Brandur Leach][1].
+#
+# In order to make them easy to use, lexicoids have the following properties:
+#
+# 1. They are lexicographically, i.e. alphabetically, sortable by time to the
+#    second.
+# 2. They encode to lower case letters for easier typing into a URL.
+# 3. Their alphabet eliminates easily-confused letter combinations like `1`,
+#    `l`, and `I`, or `0` and `O`.
+#
+# At their heart, lexicoids are a special case of [Base 32 encoding][2] for
+# integers.
+#
+# Their properties makes them ideally suitable to human-scale use cases, like
+# microblog post slugs or URL-encoded timestamps. They are poorly suited for
+# distributed systems with multiple clocks or systems that generate items at a
+# rate of more than one per second, regardless of the number of clocks.
+#
+# [1]: https://brandur.org/fragments/base32-slugs
+# [2]: https://datatracker.ietf.org/doc/html/rfc4648
+module Lexicoid
+  # The Time instance representing the time at the beginning of the Unix epoch
+  #
+  # @api private
+  # @private
+  EPOCH = Time.at(0).utc.freeze
+
+  # The alphabet for encoding lexicographic base32 IDs
+  #
+  # @api private
+  # @private
+  LEXICOGRAPHIC_BASE32 = "234567abcdefghijklmnopqrstuvwxyz"
+
+  # Converts a timestamp into a lexicographically sortable, friendly ID
+  #
+  # @api public
+  # @since 0.1.0
+  #
+  # @example Generate a lexicoid from a DateTime
+  #   Lexicoid.from DateTime.parse("2023-03-19T21:19:50-05:00")
+  #
+  # @example Generate a lexicoid from a Float timestamp
+  #   Lexicoid.from 2_147_483_647.0
+  #
+  # @example Generate a lexicoid from an Integer timestamp
+  #   Lexicoid.from 946_684_799
+  #
+  # @example Generate a lexicoid from a Time
+  #   Lexicoid.from Time.parse("2023-03-19 15:06:14.48414 -0500")
+  #
+  # @example Generate a lexicoid in a Rails application
+  #   Lexicoid.from 2.weeks.ago
+  #
+  # @param number_or_time [ActiveSupport::TimeWithZone, DateTime, Float, Integer, Time, #to_time]
+  #   the object to convert into a lexicographically sorting friendly ID
+  # @return [String] the friendly ID
+  # @raise [ArgumentError] when the object is unsuitable for conversion
+  def self.from(number_or_time)
+    number = maybe_coerce_time(number_or_time)
+    bytes = bytes_from_number(number)
+    buffer = encode(bytes)
+
+    buffer.join
+  end
+
+  # Generates a lexicographically sortable, friendly ID from the current time
+  #
+  # @api public
+  # @since 0.1.0
+  #
+  # @example Generate a friendly ID for the current moment
+  #   Lexicoid.now
+  #
+  # @return [String] the friendly ID
+  def self.now
+    from Time.now
+  end
+
+  # Extracts the bytes from a number in big endian order
+  #
+  # @api private
+  # @private
+  #
+  # @param number [Integer] the number to extract bytes from
+  # @return [Array<Integer>] the bytes from the number as integers in big endian
+  #   order
+  private_class_method def self.bytes_from_number(number)
+    [].tap do |bytes|
+      bytes.unshift(0) and next if number.zero?
+
+      while number.positive?
+        bytes.unshift(number & 0xFF)
+        number >>= 8
+      end
+    end
+  end
+
+  # Encodes a byte array into a lexicographically sortable array of characters
+  #
+  # @api private
+  # @private
+  #
+  # @param bytes [Array<Integer>] the bytes to encode, in big endian order
+  # @return [Array<String>] the bytes encoded to the lexicographic base32 alphabet
+  private_class_method def self.encode(bytes)
+    result = Array.new((bytes.length * 8 + 4) / 5, 0)
+    offset = 0
+
+    while bytes.length.positive?
+      length = bytes.length
+      buffer =
+        case length
+        when 1, 2 then Array.new(bytes.length * 2, 0)
+        when 3, 4 then Array.new(bytes.length * 2 - 1, 0)
+        else Array.new(8, 0)
+        end
+
+      if length > 4
+        buffer[7] = bytes[4] & 0x1F
+        buffer[6] = bytes[4] >> 5
+      end
+
+      if length >= 4
+        buffer[6] |= (bytes[3] << 3) & 0x1F
+        buffer[5] = (bytes[3] >> 2) & 0x1F
+        buffer[4] = bytes[3] >> 7
+      end
+
+      if length >= 3
+        buffer[4] |= (bytes[2] << 1) & 0x1F
+        buffer[3] = (bytes[2] >> 4) & 0x1F
+      end
+
+      if length >= 2
+        buffer[3] |= (bytes[1] << 4) & 0x1F
+        buffer[2] = (bytes[1] >> 1) & 0x1F
+        buffer[1] = (bytes[1] >> 6) & 0x1F
+      end
+
+      if length >= 1
+        buffer[1] |= (bytes[0] << 2) & 0x1F
+        buffer[0] = bytes[0] >> 3
+      end
+
+      buffer.each_with_index do |byte, i|
+        result[i + offset] = LEXICOGRAPHIC_BASE32[byte & 31]
+      end
+
+      break if bytes.length < 5
+
+      bytes = bytes[5..]
+      offset += 8
+    end
+
+    result
+  end
+
+  # Validates and coerces an argument for suitability for conversion
+  #
+  # @api private
+  # @private
+  #
+  # @param object [Object] the object to validate and coerce
+  # @return [Integer] the object converted into an integer timestamp
+  # @raise [ArgumentError] when the object is unsuitable for conversion
+  private_class_method def self.maybe_coerce_time(object)
+    if object.is_a?(Integer) || object.is_a?(Float)
+      raise ArgumentError, "#{object} must be non-negative" if object.negative?
+      object.to_i
+    elsif object.is_a?(Time)
+      raise ArgumentError, "#{object.iso8601} must be after #{EPOCH.iso8601}" unless EPOCH <= object
+      object.to_i
+    elsif object.respond_to?(:to_time)
+      maybe_coerce_time object.to_time
+    else
+      raise(
+        ArgumentError,
+        "#{object.inspect} must be one of Integer, Float, Time, or respond to `#to_time'"
+      )
+    end
+  end
+end
+
+require_relative "core_ext/kernel"

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: lexicoid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Herold
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Short and stable IDs from timestamps
+email:
+- opensource@michaeljherold.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.md
+- README.md
+- lexicoid.gemspec
+- lib/core_ext/kernel.rb
+- lib/lexicoid.rb
+- lib/lexicoid/version.rb
+homepage: https://github.com/michaelherold/lexicoid-ruby
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/michaelherold/lexicoid-ruby/issues
+  changelog_uri: https://github.com/michaelherold/lexicoid-ruby/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/lexicoid-ruby/0.1.0
+  homepage_uri: https://github.com/michaelherold/lexicoid-ruby
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/michaelherold/lexicoid-ruby
+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.3.7
+signing_key:
+specification_version: 4
+summary: Short and stable IDs from timestamps
+test_files: []