immutable-struct 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0ef4c872306eeb408eaaee1d514de56f0917cbb5ab32a721279feb6e4ed1971
-  data.tar.gz: 5c1afb5b32cb4edf20ec71ad760927ac376c582826eb4a96d276860cf4710efa
+  metadata.gz: c06154021767382ddac96df4c5f0291ef6fe0b4492b835fc36295b700fed19b7
+  data.tar.gz: d05c85009279d86f545e9b0d07645a4680e88b45d149feb196419cdab3f7b6a2
 SHA512:
-  metadata.gz: f4c5c9f24d9650b8c42bd57d9266973540ffce2990aae6b7407e95a3fd2dc9e533d943fe4eaf357c40dc9bb2c1598bd59d054571a0a42de0a70bc9b791e0ac03
-  data.tar.gz: 8512b6b471c543b5379224ca029c529ee0550f889d27b0986e3bc26e6ea45ec03932cc1d41bc2178e288d53baafdcc1e1e8f7a732e5cd6c035c59863c408b0ea
+  metadata.gz: 1f636be7f8e287d9573a7d1df9ca1af2dee7cdc3aae4f5ec6295541e68b30d7e99efac0b9b6dd870f29888baf4f45515148e422f3617c8668b3ef18515253190
+  data.tar.gz: c35f53b3f63f6f3b493223041a986f37c7050b5f1eff441172d974a7bb026db42581b8131424c5458067562774bb2db768018698bc89afb922b9d226fd700be6

data/.circleci/config.yml

@@ -1,15 +1,81 @@
-# DO NOT MODIFY - this is managed by Git Reduce in goro
+# DO NOT MODIFY - this is managed by Git Reduce in goro and generated from build-matrix.json
 #
 ---
-version: 2
+version: 2.1
+
+############
+## Github Actions Pipeline Params
+############
+
+parameters:
+  GHA_Event:
+    type: string
+    default: ""
+  GHA_Actor:
+    type: string
+    default: ""
+  GHA_Action:
+    type: string
+    default: ""
+  GHA_Meta:
+    type: string
+    default: ""
+
 jobs:
-  ruby-2.6.1:
+  generate-and-push-docs:
     docker:
-    - image: circleci/ruby:2.6.1
+    - image: cimg/ruby:3.3.7
+      auth:
+        username: "$DOCKERHUB_USERNAME"
+        password: "$DOCKERHUB_PASSWORD"
+    steps:
+    - checkout
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
+    - run: bundle install
+    - run:
+        name: Generate documentation
+        command: ' if [[ $(bundle exec rake -T docs:generate:custom) ]]; then echo
+          "Generating docs using rake task docs:generate:custom" ; bundle exec rake
+          docs:generate:custom ; elif [[ $(bundle exec rake -T docs:generate) ]];
+          then echo "Generating docs using rake task docs:generate" ; bundle exec
+          rake docs:generate ; else echo "Skipping doc generation" ; exit 0 ; fi '
+    - run:
+        name: Push documentation to Unwritten
+        command: if [[ $(bundle exec rake -T docs:push) ]]; then bundle exec rake
+          docs:push; fi
+  release:
+    docker:
+    - image: cimg/ruby:3.3.7
+      auth:
+        username: "$DOCKERHUB_USERNAME"
+        password: "$DOCKERHUB_PASSWORD"
+    steps:
+    - checkout
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
+    - run: bundle install
+    - run:
+        name: Artifactory login
+        command: mkdir -p ~/.gem && curl -u$ARTIFACTORY_USER:$ARTIFACTORY_TOKEN https://stitchfix01.jfrog.io/stitchfix01/api/gems/eng-gems/api/v1/api_key.yaml
+          > ~/.gem/credentials && chmod 0600 ~/.gem/credentials
+    - run:
+        name: Build/release gem to artifactory
+        command: bundle exec rake push_artifactory
+  ruby-3_3_7:
+    docker:
+    - image: cimg/ruby:3.3.7
+      auth:
+        username: "$DOCKERHUB_USERNAME"
+        password: "$DOCKERHUB_PASSWORD"
     working_directory: "~/immutable-struct"
     steps:
     - checkout
-    - run: bundle install --full-index
+    - run:
+        name: Check for Gemfile.lock presence
+        command: ' if (test -f Gemfile.lock) then echo "Dont commit Gemfile.lock (see
+          https://github.com/stitchfix/eng-wiki/blob/main/architecture-decisions/0009-rubygem-dependencies-will-be-managed-more-explicitly.md)"
+          1>&2 ; exit 1 ; else exit 0 ; fi '
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
+    - run: bundle install
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
         --format=doc
     - run:
@@ -18,17 +84,26 @@ jobs:
           fi
     - run:
         name: Notify Pager Duty
-        command: 'bundle exec y-notify #eng-platform'
+        command: bundle exec y-notify "#app-platform-ops"
         when: on_fail
     - store_test_results:
         path: "/tmp/test-results"
-  ruby-2.5.3:
+  ruby-3_2_7:
     docker:
-    - image: circleci/ruby:2.5.3
+    - image: cimg/ruby:3.2.7
+      auth:
+        username: "$DOCKERHUB_USERNAME"
+        password: "$DOCKERHUB_PASSWORD"
     working_directory: "~/immutable-struct"
     steps:
     - checkout
-    - run: bundle install --full-index
+    - run:
+        name: Check for Gemfile.lock presence
+        command: ' if (test -f Gemfile.lock) then echo "Dont commit Gemfile.lock (see
+          https://github.com/stitchfix/eng-wiki/blob/main/architecture-decisions/0009-rubygem-dependencies-will-be-managed-more-explicitly.md)"
+          1>&2 ; exit 1 ; else exit 0 ; fi '
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
+    - run: bundle install
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
         --format=doc
     - run:
@@ -37,28 +112,50 @@ jobs:
           fi
     - run:
         name: Notify Pager Duty
-        command: 'bundle exec y-notify #eng-platform'
+        command: bundle exec y-notify "#app-platform-ops"
         when: on_fail
     - store_test_results:
         path: "/tmp/test-results"
 workflows:
   version: 2
   on-commit:
+    unless:
+       equal: [ "schedule", << pipeline.parameters.GHA_Event >> ]
     jobs:
-    - ruby-2.6.1:
+    - release:
         context: org-global
-    - ruby-2.5.3:
+        requires:
+        - ruby-3_3_7
+        - ruby-3_2_7
+        filters:
+          tags:
+            only: "/^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:(-|\\.)(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$/"
+          branches:
+            ignore: /.*/
+    - generate-and-push-docs:
         context: org-global
-  scheduled:
-    triggers:
-    - schedule:
-        cron: 4 21 * * 1,2,3,4,5
+        requires:
+        - release
         filters:
+          tags:
+            only: "/^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:(-|\\.)(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$/"
           branches:
-            only:
-            - master
+            ignore: /.*/
+    - ruby-3_3_7:
+        context: org-global
+        filters:
+          tags:
+            only: &1 /.*/
+    - ruby-3_2_7:
+        context: org-global
+        filters:
+          tags:
+            only: *1
+  scheduled:
+    when:
+       equal: [ "schedule", << pipeline.parameters.GHA_Event >> ]
     jobs:
-    - ruby-2.6.1:
+    - ruby-3_3_7:
         context: org-global
-    - ruby-2.5.3:
+    - ruby-3_2_7:
         context: org-global

data/.github/CODEOWNERS

@@ -0,0 +1,11 @@
+# THIS FILE IS NOT THE SOURCE OF TRUTH for app ownership. If this app
+# is transferred to another team, the app ownership should be changed
+# in fixops.
+#
+# View current canonical app ownership on Unwritten:
+# https://unwritten.stitchfix.com/docs/applications-and-services
+#
+# This file uses the GitHub CODEOWNERS convention to assign PR reviewers:
+# https://help.github.com/articles/about-codeowners/
+
+* @stitchfix/app-platform

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+## Problem
+
+«Brief overview of the problem»
+
+## Solution
+
+«Brief description of how you solved the problem»

data/.github/workflows/scheduled_cci.yml

@@ -0,0 +1,14 @@
+on:
+  schedule:
+    - cron: '4 21 * * 1,2,3,4,5'
+  workflow_dispatch:
+
+jobs:
+  trigger-circleci:
+    runs-on: ubuntu-latest
+    steps:
+      - name: CircleCI trigger on schedule
+        id: step1
+        uses: CircleCI-Public/trigger-circleci-pipeline-action@v1.0.5
+        env:
+          CCI_TOKEN: ${{ secrets.CCI_TOKEN || secrets.CCI_TOKEN_FOR_PUBLIC_REPOS }}

data/.gitignore

@@ -11,6 +11,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/examples.txt
 test/tmp
 test/version_tmp
 tmp

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+ruby-3.2.7

data/.travis.yml

@@ -1,8 +1,10 @@
 language: ruby
-before_install:
-  - gem install bundler
 rvm:
-  - 2.5.0
-  - 2.4.3
-  - 2.3.6
+  - 2.6
+  - 2.7
   - ruby-head
+before_install:
+  - gem install bundler
+jobs:
+  allow_failures:
+    - rvm: ruby-head

data/build-matrix.json

@@ -1,4 +1,3 @@
 {
-  "build_matrix": {
-  }
+  "build_matrix": {}
 }

data/lib/immutable-struct.rb

@@ -6,7 +6,7 @@
 # will be evaluated as if it were inside a class definition, allowing you
 # to add methods, include or extend modules, or do whatever else you want.
 class ImmutableStruct
-  VERSION='2.4.1' #:nodoc:
+  VERSION='2.5.0' #:nodoc:
   # Create a new class with the given read-only attributes.
   #
   # attributes:: list of symbols or strings that can be used to create attributes.
@@ -121,6 +121,14 @@ class ImmutableStruct
         end
         (attribute_values + [self.class]).hash
       end
+
+      def deconstruct_keys(keys)
+        if keys
+          to_h.slice(*keys)
+        else
+          to_h
+        end
+      end
     end
     klass.class_exec(&block) unless block.nil?
 

data/owners.json

@@ -1,7 +1,7 @@
 {
   "owners": [
     {
-      "team": "platform"
+      "team": "dev-platform"
     }
   ]
 }

data/spec/immutable_struct_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper.rb'
 require 'json'
+require 'set'
 
 module TestModule
   def hello; "hello"; end
@@ -189,6 +190,46 @@ describe ImmutableStruct do
     end
   end
 
+  describe "#deconstruct_keys" do
+    it "returns a hash with the specified keys" do
+      klass = ImmutableStruct.new(:a, :b, :c)
+      instance = klass.new(a: 1, b: 2, c: 3)
+      expect(instance.deconstruct_keys([:a, :c])).to eq({ a: 1, c: 3 })
+    end
+
+    context "when keys are specified that do not exist in the struct" do
+      it 'returns only the keys that do exist' do
+        klass = ImmutableStruct.new(:a, :b, :c)
+        instance = klass.new(a: 1, b: 2, c: 3)
+        expect(instance.deconstruct_keys([:a, :foo])).to eq({ a: 1 })
+      end
+    end
+
+    it "allows an instance to be used with pattern matching" do
+      klass = ImmutableStruct.new(:a, :b, :c)
+      instance = klass.new(a: 1, b: 2, c: 3)
+      expect {
+        case instance
+        in { a: 1 }
+          # good!
+        end
+        # a NoMatchingPatternError would be raised if the pattern didn't match
+      }.not_to raise_error
+    end
+
+    context "pattern matching against 'any key'" do
+      it 'returns all properties' do
+        klass = ImmutableStruct.new(:a, :b, :c)
+        instance = klass.new(a: 1, b: 2, c: 3)
+        case instance
+        in **rest
+          expect(rest).to eq({ a: 1, b: 2, c: 3 })
+        end
+        # a NoMatchingPatternError would be raised if the pattern didn't match
+      end
+    end
+  end
+
   describe "merge" do
     it "returns a new object as a result of merging attributes" do
       klass = ImmutableStruct.new(:food, :snacks, :butter)

data/spec/spec_helper.rb

@@ -7,5 +7,13 @@ RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = [:expect]
   end
-  config.order = "random"
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.example_status_persistence_file_path = "spec/examples.txt"
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: immutable-struct
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Stitch Fix Engineering
 - Dave Copeland
 - Simeon Willbanks
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-18 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,6 +79,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/CODEOWNERS"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/scheduled_cci.yml"
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
@@ -99,7 +102,7 @@ homepage: https://github.com/stitchfix/immutable-struct
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,8 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Easily create value objects without the pain of Ruby's Struct (or its setters)
 test_files: