timeoutable 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5260b27d155d50a7d7f7fcbe4da981ce32c8c952d9da1d418108613b524f55
-  data.tar.gz: 617888199e17a4fb1d36c9492233c62bdafa08b4545c19b043afb8434cafe2e7
+  metadata.gz: 7ad233d8b2d5a20876944168d646cb9a22155e957d80ec64bab75519a31a9045
+  data.tar.gz: 8aec57768ce5c97592abbbdd67b975d2c8c89e3c821a0fb2e4f82e3b199da763
 SHA512:
-  metadata.gz: 128cd789fc6cf75a3570f28a08208eb277b6a05f8b02770e0d0b7968a08535b2da2972edf3a56de75e0905448c0476754bd55efb15614a0477a5facf41325c39
-  data.tar.gz: 12dd063051af4a1b5f37e3dd8278232382baa57c7fb886b3160b733f2bc01b93dedc1e4109e5268a62a2f532f7f9ad20fad0f54dbf4d3c6bb67221e6f2b8ba29
+  metadata.gz: 07ba46ce4de024ac211a1fa6a2ff8f31bfe2e168ae17d24d81c6101ddb0f5aa3730b8fb99874271d60c9eaac5624ee9518315547c427446b6ff8f2541480b691
+  data.tar.gz: b6bf15103dcad57222df5bafd840d6dbbe61c7b82d9eb9e80e2a94da3b96f86bb2302e2308952316a7a52fd2a93a4daff7fa81290e7888e4178a1c9c52ef93c4

data/.circleci/config.yml

@@ -1,108 +1,28 @@
-version: 2.1 # Use 2.1 to enable using orbs and other features.
+version: 2.1
 
-# Declare the orbs that we'll use in our config.
-# read more about orbs: https://circleci.com/docs/2.0/using-orbs/
 orbs:
   ruby: circleci/ruby@1.0
-
-jobs:
-  build: # our first job, named "build"
-    docker:
-      - image: cimg/ruby:2.7-node # use a tailored CircleCI docker image.
-    steps:
-      - checkout # pull down our git code.
-      - ruby/install-deps # use the ruby orb to install dependencies
-    environment:
-
-  publish-gemfury:
-    docker:
-      - image: cimg/ruby:2.7-node # this is our primary docker image, where step commands run.
-    environment:
-      BUNDLE_JOBS: "3"
-      BUNDLE_RETRY: "3"
-      RAILS_ENV: test
-    steps:
-      - checkout
-      - ruby/install-deps
-      - run:
-          name: Publish Gemfury
-          command: |
-            bin/publish_gemfury
-  publish-github:
-    docker:
-      - image: cimg/ruby:2.7-node # this is our primary docker image, where step commands run.
-    environment:
-      BUNDLE_JOBS: "3"
-      BUNDLE_RETRY: "3"
-      RAILS_ENV: test
-    steps:
-      - checkout
-      - ruby/install-deps
-      - run:
-          name: 'Get Go'
-          command: |
-            sudo apt-get update -qq
-            sudo apt-get -y --no-install-recommends install golang-go
-      - run:
-          name: 'Set Git stats'
-          command: |
-            git config user.name $GITHUB_USER
-            git config user.email $GITHUB_EMAIL
-      - run:
-          name: 'Download GHR'
-          command: |
-            curl -sSL https://github.com/tcnksm/ghr/releases/download/v0.13.0/ghr_v0.13.0_linux_amd64.tar.gz | tar xz -f - -C . ghr_v0.13.0_linux_amd64/ghr
-            mv ghr_v0.13.0_linux_amd64/ghr .
-            rm -rf ghr_v0.13.0_linux_amd64
-            chmod 0755 ghr
-      - run:
-          name: Publish Git
-          command: |
-            export GHRLOCATION=ghr
-            bin/publish_git
-  test:
-    docker:
-      - image: cimg/ruby:2.7-node
-      - image: circleci/redis:latest
-    environment:
-      BUNDLE_JOBS: "3"
-      BUNDLE_RETRY: "3"
-      RAILS_ENV: test
-    # A series of steps to run, some are similar to those in "build".
-    steps:
-      - checkout
-      - ruby/install-deps
-      - run:
-          name: Setup Climate Control test-reporter
-          command: |
-            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-            chmod +x ./cc-test-reporter
-      - run:
-          name: Run le tests
-          command: |
-            ./cc-test-reporter before-build
-            SIMPLE_COV_RUN=true bundle exec rspec --format RspecJunitFormatter --out test-results/rspec/rspec.xml --format progress --color
-            ./cc-test-reporter after-build format-coverage -t simplecov
+  cst: cst/framework@1
 
 workflows:
   version: 2
   yeet-le-jobs:
     jobs:
-      - build
-      - test:
-          requires:
-            - build
-      - publish-github:
-          requires:
-            - test
-          filters:
-            branches:
-              only:
-                - main
-
-      - publish-gemfury:
+      - cst/enforce-gem-version-bump
+      - cst/rspec-ruby:
+          rspec-system-args: "SIMPLE_COV_RUN=true"
+          cc-report-collect-ruby: "2.7.5"
+          matrix:
+            parameters:
+              ruby-version: ["2.7.5" , "3.0.0", "3.0.3"]
+            alias: required-matrix-tests
+          name: test-ruby<< matrix.ruby-version >>
+      - cst/publish-gem:
+          publish-git: true
+          publish-default-gem: true
           requires:
-            - test
+            - required-matrix-tests
+            - cst/enforce-gem-version-bump
           filters:
             branches:
               only:

data/.gitignore

@@ -10,3 +10,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+*.gem
+*.DS_STORE

data/README.md

@@ -1,15 +1,11 @@
 # Timeoutable
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/timeoutable`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'timeoutable'
+gem 'timeoutable', source: 'https://github.com/matt-taylor/timeoutable'
 ```
 
 And then execute:
@@ -22,17 +18,32 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Take a looke at the [TestableKlass](https://github.com/matt-taylor/timeoutable/blob/main/lib/timeoutable/testable_klass.rb) for complete example.
 
-## 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.
+```ruby
+params = {
+  warn: 10, # this can be a float
+  timeout: 15, # this can be a float
+  proc: ->(thread, seconds_elapsed) { thread[BIT_NAME] = 1 }, # proc to call after ${warn} seconds -- passes the original thread and the seconds that have elapsed
+  message: "Error message",
+}
+
+Timeoutable.timeout(**params) do
+    # code wrapped in a timeout
+end
+```
+
+### How this works
+After `warn` seconds have elapsed, `Timoutable` will call the `proc`. In the example, the `proc` will set a bit in the thread. However, you can choose any method of communication to gracefully shutdown.
+
+## Development
 
-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).
+After checking out the repo, run `make bash` to install dependencies and build a container. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/timeoutable. 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/[USERNAME]/timeoutable/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/matt-taylor/timeoutable. 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/matt-taylor/timeoutable/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +51,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Timeoutable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/timeoutable/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Timeoutable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/matt-taylor/timeoutable/blob/main/CODE_OF_CONDUCT.md).

data/lib/timeoutable/version.rb

@@ -2,8 +2,8 @@
 
 module Timeoutable
   MAJOR = 1  # With backwards incompatability. Requires annoucment and update documentation
-  MINOR = 0  # With feature launch. Documentation of upgrade is useful via a changelog
-  PATCH = 0  # With minor upgrades or patcing a small bug. No changelog necessary
+  MINOR = 1  # With feature launch. Documentation of upgrade is useful via a changelog
+  PATCH = 1  # With minor upgrades or patcing a small bug. No changelog necessary
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.get_version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timeoutable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: timeout
@@ -45,10 +45,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/publish_gemfury
-- bin/publish_git
 - bin/setup
-- bin/version
 - docker-compose.yml
 - lib/timeoutable.rb
 - lib/timeoutable/testable_klass.rb
@@ -74,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Extension of Ruby's Timeout::timeout method

data/bin/publish_gemfury

@@ -1,27 +0,0 @@
-#!/bin/bash -e
-
-if [ -z "$GEMFURY_TOKEN" ]; then
-  echo 'Environment variable GEMFURY_TOKEN is not present'
-  exit 1
-fi
-
-VERSION=$(bin/version)
-PACKAGE=timeoutable-${VERSION}.gem
-
-# if [ $(git tag -l "$VERSION") ]; then
-#   echo "Pre existing version $VERSION, not tagging."
-#   echo "Pre existing version $VERSION, not pushing to gemfury."
-#   exit 0
-# fi
-
-# Build and publish to Gemfury
-gem build timeoutable.gemspec
-FILE=$(pwd)/${PACKAGE}
-echo "Finished building $FILE"
-
-# push to gemfury
-curl --fail -F package=@${FILE} https://${GEMFURY_TOKEN}@push.fury.io/${GEMFURY_USER}/
-echo "Finished Pushing to Gemfury"
-
-# start fresh
-rm timeoutable.gemspec

data/bin/publish_git

@@ -1,38 +0,0 @@
-#!/bin/bash -e
-
-if [ -z "$GITHUB_TOKEN" ]; then
-  echo 'Environment variable GITHUB_TOKEN is not present'
-  exit 1
-fi
-
-if [ -z "$GITHUB_USER" ]; then
-  echo 'Environment variable GITHUB_USER is not present'
-  exit 1
-fi
-
-
-VERSION=$(bin/version)
-PACKAGE=timeoutable-${VERSION}.gem
-
-# if [ $(git tag -l "$VERSION") ]; then
-#   echo "Pre existing version $VERSION, not tagging."
-#   exit 0
-# fi
-
-gem build timeoutable.gemspec
-FILE=$(pwd)/${PACKAGE}
-echo "Finished building $FILE"
-
-# create tag in repo
-git tag -a $VERSION -m "$VERSION"
-git push https://${GITHUB_TOKEN}@github.com/${GITHUB_USER}/timeoutable.git $VERSION
-echo "Finished Tagging to git"
-
-
-# send artifacts to git
-SHA=$(git rev-parse HEAD)
-./$GHRLOCATION -soft -t ${GITHUB_TOKEN} -u ${GITHUB_USER} -r timeoutable -c ${SHA} ${VERSION} *.gem
-echo "Finished Pushing artificat to Git"
-
-# start fresh
-rm timeoutable.gemspec

data/bin/version

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "timeoutable"
-
-Timeoutable.get_version