sorbet-struct-comparable 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cdc3f402081351e1da4c84bc5dc767f59d288b781763ba64be2b1f4e6d77768
-  data.tar.gz: c336b74f657fb64e7b29e024ceb10c02e555a82f89283f758e9984aeb6c65b5e
+  metadata.gz: 250d183579edd0b3cec7a62398e1eb966c30d1cadf2bde41ea1f860680342d75
+  data.tar.gz: a7e47b96f4d5680bb3d099b47db1d55c2efca2f4fa7dfc6cf3670151367b3077
 SHA512:
-  metadata.gz: a505ab5eed81e5f80280e6c7f2ae68c619d561c2c4ef13ec0866249083e7092ada08d961502d4d7fdb7f289a07849fdf044eb58121e2bd8c2a802c12c8f14121
-  data.tar.gz: f3958b00820ff24401823af78c8b91d789fd2da090e117c15699a0a1bbb125f1770c1b1eaa32111650a8fae319ee1e3232052da12cbebf89c3cd136c754ae670
+  metadata.gz: 9bf7a867ac5245cdb856ab66a2254e12882f445bfb4ab08723b1289f2c40559b15e6a864bfe0811b74eccab0023703c36a19773d20c9a87f4767ab229efad115
+  data.tar.gz: c37da47bfddd23095bcc91f78564008038296cea1fcf439b84ce5e5592c2153c88c8da1177fed847f43b4abbc25cdc9afd20bbb7fc2b6aa52af4a677baaa2fb5

data/.github/workflows/ci.yml

@@ -1,52 +1,48 @@
 ---
-    name: Continuous Integration
-    on:
-      push:
-        branches-ignore:
-        - refs/tags/*_staging
-        - refs/tags/*_production
-    jobs:
-      build:
-        runs-on: ubuntu-18.04
-        steps:
-        - name: Checkout branch
-          uses: actions/checkout@v2
-        - name: Extract branch name
-          shell: bash
-          run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
-          id: extract_branch
-        - name: Set up Ruby
-          uses: actions/setup-ruby@v1.1.1
-          with:
-            ruby-version: 2.7.1
-        - name: Cache gems
-          uses: actions/cache@v1
-          with:
-            path: vendor/bundle
-            key: "${{ runner.OS }}-gem-cache-${{ hashFiles('**/sorbet-struct-comparable.gemspec')
-              }}"
-            restore-keys: "${{ runner.OS }}-gem-cache-\n"
-        - name: Install bundler
-          run: (bundler -v | grep "2.1.4") || gem install bundler:2.1.4
-        - name: Install gems
-          run: bundle install --jobs $(nproc) --retry 3 --without metrics --path vendor/bundle
-        - name: Create cache directory
-          run: mkdir -p tmp/cache
-        - name: Typecheck with Sorbet
-          run: bundle exec srb tc . --ignore=/vendor
-        - name: Run RSpec test suite
-          run: bundle exec rspec spec
-          env:
-            METRICS: '1'
-        - name: Post to Slack if build fails
-          if: failure() && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/stable')
-          uses: pullreminders/slack-action@master
-          env:
-            SLACK_BOT_TOKEN: "${{ secrets.SLACK_BOT_TOKEN }}"
-          with:
-            args: '{\"channel\":\"C33574SJJ\",\"text\":\"* ${{ github.repository }} BUILD
-              FAILURE*\", \"attachments\": [{ \"fallback\": \"Failure summary\", \"color\":
-              \"#ff0000\", \"fields\": [{\"title\": \"Branch\", \"value\":\"${{ steps.extract_branch.outputs.branch
-              }}\"}, {\"title\": \"Who broke it\", \"value\":\"${{ github.actor }}\"},
-              { \"title\": \"Build output\", \"value\": \"https://github.com/${{ github.repository
-              }}/commit/${{ github.sha }}/checks\", \"short\": false }]}]}'
+name: Continuous Integration
+on:
+  push:
+    branches-ignore:
+    - refs/tags/*_staging
+    - refs/tags/*_production
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+    steps:
+    - name: Checkout branch
+      uses: actions/checkout@v2
+    - name: Extract branch name
+      shell: bash
+      run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+      id: extract_branch
+    - name: Cache gems
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: "${{ runner.OS }}-gem-cache-${{ hashFiles('**/*.gemspec')
+          }}"
+        restore-keys: "${{ runner.OS }}-gem-cache-\n"
+    - uses: "cachix/install-nix-action@8d6d5e949675fbadb765c6b1a975047fa5f09b27"
+      with:
+        extra_nix_config: |
+          post-build-hook = /etc/nix/upload-to-cache.sh
+          substituters = https://cache.nixos.org/
+          trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=
+        nix_path: nixpkgs=channel:nixos-21.05
+    - name: Run CI through nix-shell
+      env:
+        GEMFURY_DEPLOY_TOKEN: ${{ secrets.GEMFURY_DEPLOY_TOKEN }}
+      run: nix-shell --run "chmod 755 ./run_ci.sh && ./run_ci.sh"
+    - name: Post to Slack if build fails
+      if: failure() && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'
+        || github.ref == 'refs/heads/stable')
+      uses: pullreminders/slack-action@a5a262c896a1cc80dcbae59ba95513e2dfb21439
+      env:
+        SLACK_BOT_TOKEN: "${{ secrets.SLACK_BOT_TOKEN }}"
+      with:
+        args: '{\"channel\":\"C33574SJJ\",\"text\":\"* ${{ github.repository }} BUILD
+          FAILURE*\", \"attachments\": [{ \"fallback\": \"Failure summary\", \"color\":
+          \"#ff0000\", \"fields\": [{\"title\": \"Branch\", \"value\":\"${{ steps.extract_branch.outputs.branch
+          }}\"}, {\"title\": \"Who broke it\", \"value\":\"${{ github.actor }}\"},
+          { \"title\": \"Build output\", \"value\": \"https://github.com/${{ github.repository
+          }}/commit/${{ github.sha }}/checks\", \"short\": false }]}]}'

data/.gitignore

@@ -10,3 +10,6 @@
 
 # rspec failure tracking
 .rspec_status
+.envrc
+.direnv
+vendor

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Releases
 
+1.3.0
+
+* Add support for eql? so that Array.uniq properly dedupes ([PR #6](https://github.com/bellroy/sorbet-struct-comparable/pull/6))
+
+1.2.0
+
+* Add `#hash` ([PR #5](https://github.com/bellroy/sorbet-struct-comparable/pull/5))
+
+1.1.0
+
+* Fixed `T::Struct`'s of different classes returning `-1`; now returning `nil` as is expected of incomparable objects
+* Fixed incomparable attributes of different returning `-1` instead of `nil`
+
 1.0.0
 
 * Initial release: Extracted from [https://bellroy.com/](Bellroy) projects.

data/Gemfile

@@ -4,19 +4,14 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.0'
-  gem 'rspec', '~> 3.0'
+  gem 'rake'
+  gem 'rspec'
   gem 'pry-byebug'
   gem 'sorbet'
   gem 'sorbet-runtime'
-end
-
-group :development do
-  gem 'spring'
-  gem 'spring-watcher-listen'
+  gem 'tapioca'
 end
 
 group :test do
   gem 'simplecov'
-  gem 'spring-commands-rspec'
 end

data/README.md

@@ -1,6 +1,6 @@
 ![Sorbet](https://user-images.githubusercontent.com/2643026/84757714-60be0600-afbc-11ea-8c0e-7da839ea1712.png)
 
-![Continuous Integration](https://github.com/tricycle/sorbet-struct-comparable/workflows/Continuous%20Integration/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/sorbet-struct-comparable.svg)](https://badge.fury.io/rb/sorbet-struct-comparable) ![Continuous Integration](https://github.com/bellroy/sorbet-struct-comparable/workflows/Continuous%20Integration/badge.svg)
 # Making T::Struct's comparable since 2020
 
 If you just want some simple equality checking on your `T::Struct`'s then you've come to the right place.
@@ -67,4 +67,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/tricycle/sorbet-struct-comparable.
+Bug reports and pull requests are welcome on GitHub at https://github.com/bellroy/sorbet-struct-comparable.

data/lib/sorbet-struct-comparable/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module SorbetStructComparable
-  VERSION = '1.0.0'
+  VERSION = '1.3.0'
 end

data/lib/t/struct/acts_as_comparable.rb

@@ -7,24 +7,29 @@ module T
       extend T::Sig
       include ::Comparable
 
-      LESS_THAN_OTHER = -1
       EQUAL = 0
+      NOT_COMPARABLE = nil
 
-      sig { params(other: Object).returns(Integer) }
+      sig { params(other: Object).returns(T.nilable(Integer)) }
       def <=>(other)
-        result = EQUAL
-        return LESS_THAN_OTHER if other.class != T.unsafe(self).class
+        return NOT_COMPARABLE if other.class != T.unsafe(self).class
 
-        T.unsafe(self).class.decorator.props.keys.map do |attribute_key|
+        T.unsafe(self).class.decorator.props.keys.each do |attribute_key|
           compare_result = T.unsafe(self).send(attribute_key) <=> other.send(attribute_key)
-          result = if compare_result.nil?
-                    LESS_THAN_OTHER
-                   else
-                     T.cast(compare_result, Integer)
-                   end
-          break if result != EQUAL
+          return T.cast(compare_result, T.nilable(Integer)) if compare_result != EQUAL
         end
-        result
+
+        return EQUAL
+      end
+
+      sig { params(other: Object).returns(T::Boolean) }
+      def eql?(other)
+        self == other
+      end
+
+      sig { returns(Integer) }
+      def hash
+        T.unsafe(self).class.decorator.props.keys.map { |attribute_key| T.unsafe(self).send(attribute_key).hash }.hash
       end
     end
   end

data/nix/sources.json

@@ -0,0 +1,14 @@
+{
+    "nixpkgs": {
+        "branch": "nixos-21.05",
+        "description": "Nix packages collection",
+        "homepage": "https://github.com/NixOS/nixpkgs",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "e85f0175e3effe9ba191d66c09e8f1b7d6362d5e",
+        "sha256": "1qr2hmymbzwj8jrz6smcgc04scgwp2v5070x22k4fvh261g1n4zw",
+        "type": "tarball",
+        "url": "https://github.com/NixOS/nixpkgs/archive/e85f0175e3effe9ba191d66c09e8f1b7d6362d5e.tar.gz",
+        "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
+    }
+}

data/nix/sources.nix

@@ -0,0 +1,174 @@
+# This file has been generated by Niv.
+
+let
+
+  #
+  # The fetchers. fetch_<type> fetches specs of type <type>.
+  #
+
+  fetch_file = pkgs: name: spec:
+    let
+      name' = sanitizeName name + "-src";
+    in
+      if spec.builtin or true then
+        builtins_fetchurl { inherit (spec) url sha256; name = name'; }
+      else
+        pkgs.fetchurl { inherit (spec) url sha256; name = name'; };
+
+  fetch_tarball = pkgs: name: spec:
+    let
+      name' = sanitizeName name + "-src";
+    in
+      if spec.builtin or true then
+        builtins_fetchTarball { name = name'; inherit (spec) url sha256; }
+      else
+        pkgs.fetchzip { name = name'; inherit (spec) url sha256; };
+
+  fetch_git = name: spec:
+    let
+      ref =
+        if spec ? ref then spec.ref else
+          if spec ? branch then "refs/heads/${spec.branch}" else
+            if spec ? tag then "refs/tags/${spec.tag}" else
+              abort "In git source '${name}': Please specify `ref`, `tag` or `branch`!";
+    in
+      builtins.fetchGit { url = spec.repo; inherit (spec) rev; inherit ref; };
+
+  fetch_local = spec: spec.path;
+
+  fetch_builtin-tarball = name: throw
+    ''[${name}] The niv type "builtin-tarball" is deprecated. You should instead use `builtin = true`.
+        $ niv modify ${name} -a type=tarball -a builtin=true'';
+
+  fetch_builtin-url = name: throw
+    ''[${name}] The niv type "builtin-url" will soon be deprecated. You should instead use `builtin = true`.
+        $ niv modify ${name} -a type=file -a builtin=true'';
+
+  #
+  # Various helpers
+  #
+
+  # https://github.com/NixOS/nixpkgs/pull/83241/files#diff-c6f540a4f3bfa4b0e8b6bafd4cd54e8bR695
+  sanitizeName = name:
+    (
+      concatMapStrings (s: if builtins.isList s then "-" else s)
+        (
+          builtins.split "[^[:alnum:]+._?=-]+"
+            ((x: builtins.elemAt (builtins.match "\\.*(.*)" x) 0) name)
+        )
+    );
+
+  # The set of packages used when specs are fetched using non-builtins.
+  mkPkgs = sources: system:
+    let
+      sourcesNixpkgs =
+        import (builtins_fetchTarball { inherit (sources.nixpkgs) url sha256; }) { inherit system; };
+      hasNixpkgsPath = builtins.any (x: x.prefix == "nixpkgs") builtins.nixPath;
+      hasThisAsNixpkgsPath = <nixpkgs> == ./.;
+    in
+      if builtins.hasAttr "nixpkgs" sources
+      then sourcesNixpkgs
+      else if hasNixpkgsPath && ! hasThisAsNixpkgsPath then
+        import <nixpkgs> {}
+      else
+        abort
+          ''
+            Please specify either <nixpkgs> (through -I or NIX_PATH=nixpkgs=...) or
+            add a package called "nixpkgs" to your sources.json.
+          '';
+
+  # The actual fetching function.
+  fetch = pkgs: name: spec:
+
+    if ! builtins.hasAttr "type" spec then
+      abort "ERROR: niv spec ${name} does not have a 'type' attribute"
+    else if spec.type == "file" then fetch_file pkgs name spec
+    else if spec.type == "tarball" then fetch_tarball pkgs name spec
+    else if spec.type == "git" then fetch_git name spec
+    else if spec.type == "local" then fetch_local spec
+    else if spec.type == "builtin-tarball" then fetch_builtin-tarball name
+    else if spec.type == "builtin-url" then fetch_builtin-url name
+    else
+      abort "ERROR: niv spec ${name} has unknown type ${builtins.toJSON spec.type}";
+
+  # If the environment variable NIV_OVERRIDE_${name} is set, then use
+  # the path directly as opposed to the fetched source.
+  replace = name: drv:
+    let
+      saneName = stringAsChars (c: if isNull (builtins.match "[a-zA-Z0-9]" c) then "_" else c) name;
+      ersatz = builtins.getEnv "NIV_OVERRIDE_${saneName}";
+    in
+      if ersatz == "" then drv else
+        # this turns the string into an actual Nix path (for both absolute and
+        # relative paths)
+        if builtins.substring 0 1 ersatz == "/" then /. + ersatz else /. + builtins.getEnv "PWD" + "/${ersatz}";
+
+  # Ports of functions for older nix versions
+
+  # a Nix version of mapAttrs if the built-in doesn't exist
+  mapAttrs = builtins.mapAttrs or (
+    f: set: with builtins;
+    listToAttrs (map (attr: { name = attr; value = f attr set.${attr}; }) (attrNames set))
+  );
+
+  # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/lists.nix#L295
+  range = first: last: if first > last then [] else builtins.genList (n: first + n) (last - first + 1);
+
+  # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L257
+  stringToCharacters = s: map (p: builtins.substring p 1 s) (range 0 (builtins.stringLength s - 1));
+
+  # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L269
+  stringAsChars = f: s: concatStrings (map f (stringToCharacters s));
+  concatMapStrings = f: list: concatStrings (map f list);
+  concatStrings = builtins.concatStringsSep "";
+
+  # https://github.com/NixOS/nixpkgs/blob/8a9f58a375c401b96da862d969f66429def1d118/lib/attrsets.nix#L331
+  optionalAttrs = cond: as: if cond then as else {};
+
+  # fetchTarball version that is compatible between all the versions of Nix
+  builtins_fetchTarball = { url, name ? null, sha256 }@attrs:
+    let
+      inherit (builtins) lessThan nixVersion fetchTarball;
+    in
+      if lessThan nixVersion "1.12" then
+        fetchTarball ({ inherit url; } // (optionalAttrs (!isNull name) { inherit name; }))
+      else
+        fetchTarball attrs;
+
+  # fetchurl version that is compatible between all the versions of Nix
+  builtins_fetchurl = { url, name ? null, sha256 }@attrs:
+    let
+      inherit (builtins) lessThan nixVersion fetchurl;
+    in
+      if lessThan nixVersion "1.12" then
+        fetchurl ({ inherit url; } // (optionalAttrs (!isNull name) { inherit name; }))
+      else
+        fetchurl attrs;
+
+  # Create the final "sources" from the config
+  mkSources = config:
+    mapAttrs (
+      name: spec:
+        if builtins.hasAttr "outPath" spec
+        then abort
+          "The values in sources.json should not have an 'outPath' attribute"
+        else
+          spec // { outPath = replace name (fetch config.pkgs name spec); }
+    ) config.sources;
+
+  # The "config" used by the fetchers
+  mkConfig =
+    { sourcesFile ? if builtins.pathExists ./sources.json then ./sources.json else null
+    , sources ? if isNull sourcesFile then {} else builtins.fromJSON (builtins.readFile sourcesFile)
+    , system ? builtins.currentSystem
+    , pkgs ? mkPkgs sources system
+    }: rec {
+      # The sources, i.e. the attribute set of spec name to spec
+      inherit sources;
+
+      # The "pkgs" (evaluated nixpkgs) to use for e.g. non-builtin fetchers
+      inherit pkgs;
+    };
+
+in
+mkSources (mkConfig {}) // { __functor = _: settings: mkSources (mkConfig settings); }

data/run_ci.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -e
+rm -f Gemfile.lock
+bundle install
+bundle exec srb tc
+METRICS=1 bundle exec rspec spec

data/shell.nix

@@ -0,0 +1,20 @@
+{ sources ? import ./nix/sources.nix }:
+let
+  nixpkgs = import sources.nixpkgs { };
+in
+nixpkgs.mkShell {
+  name = "bellroy-gem-env";
+  buildInputs = with nixpkgs; [
+    bundler
+    libnotify
+    niv
+    pkg-config
+    readline
+    ruby_2_7
+    zlib
+  ]
+  ++ (if stdenv.hostPlatform.isDarwin then [ libiconv darwin.apple_sdk.frameworks.CoreServices ] else [ ]);
+  shellHook = ''
+    bundle config --local path "$PWD/vendor/bundle"
+  '';
+}

data/sorbet/config

@@ -1,2 +1,4 @@
 --dir
 .
+--ignore
+vendor

data/sorbet/rbi/gems/ast@2.4.2.rbi

@@ -0,0 +1,54 @@
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for types exported from the `ast` gem.
+# Please instead update this file by running `bin/tapioca gem ast`.
+
+# typed: true
+
+module AST; end
+
+class AST::Node
+  def initialize(type, children = T.unsafe(nil), properties = T.unsafe(nil)); end
+
+  def +(array); end
+  def <<(element); end
+  def ==(other); end
+  def append(element); end
+  def children; end
+  def clone; end
+  def concat(array); end
+  def deconstruct; end
+  def dup; end
+  def eql?(other); end
+  def hash; end
+  def inspect(indent = T.unsafe(nil)); end
+  def to_a; end
+  def to_ast; end
+  def to_s(indent = T.unsafe(nil)); end
+  def to_sexp(indent = T.unsafe(nil)); end
+  def to_sexp_array; end
+  def type; end
+  def updated(type = T.unsafe(nil), children = T.unsafe(nil), properties = T.unsafe(nil)); end
+
+  protected
+
+  def assign_properties(properties); end
+  def fancy_type; end
+
+  private
+
+  def original_dup; end
+end
+
+class AST::Processor
+  include ::AST::Processor::Mixin
+end
+
+module AST::Processor::Mixin
+  def handler_missing(node); end
+  def process(node); end
+  def process_all(nodes); end
+end
+
+module AST::Sexp
+  def s(type, *children); end
+end