interactor-stopwatch 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0066ea7dfe76c12206c8cfb51984f1c9f549088dca5ea805df7eb38b1fdcb402
+  data.tar.gz: e602daea36cc17f228e66b8344fb380dbbd171e09c27b9245be30ff719739086
+SHA512:
+  metadata.gz: ea8c351d71c8a86ea70f1bd483e4cc31776fa37894c8dfdacb5a9c1491e2dd87b2088ef6a7372c3dc3f0c03b8c9590392c55ef7bfde1aed580b7364bd49f63ab
+  data.tar.gz: eab38a763fe8e74bde6254e0cef6c82636226e884df61ddfbbd400b211ed4eb0672d4dce050d1c7cdb8d4b5c17e3840044ac227bac2b35d60669505e08e073e6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-09
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+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,47 @@
+# Interactor::Stopwatch
+
+Stopwatch is a miniature Interactor extension that is watching the clock.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add interactor-stopwatch
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install interactor-stopwatch
+
+## Usage
+
+A sample Interactor could look a little like this, the `stopwatch` block yields in the context of our interactor instance with a single block parameter  (ActiveSupport::Duration) of the interactor's lifecycle.
+
+```ruby
+class TakeTime
+  include Interactor
+  include Interactor::Stopwatch
+
+  stopwatch do |duration|
+    puts "TakeTime took #{duration}s"
+  end
+
+  def call
+    sleep 0.1
+    context.message = 'I measured how long this took'
+  end
+end
+```
+
+## 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.
+
+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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/braindeaf/interactor-stopwatch.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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]

data/lib/interactor/stopwatch/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Interactor
+  module Stopwatch
+    VERSION = "0.1.1"
+  end
+end

data/lib/interactor/stopwatch.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "interactor"
+require "active_support/deprecator"
+require "active_support/deprecation"
+require "active_support/core_ext/numeric/time"
+
+require_relative "stopwatch/version"
+
+module Interactor
+  module Stopwatch
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def stopwatch(&block)
+        around do |interactor|
+          starts_at = Time.now
+          interactor.call
+          instance_exec((Time.now - starts_at).seconds, &block)
+        end
+      end
+    end
+  end
+end

data/sig/interactor/stopwatch.rbs

@@ -0,0 +1,6 @@
+module Interactor
+  module Stopwatch
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: interactor-stopwatch
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- RobL
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: interactor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Stopwatch is a miniature Interactor extension that is watching the clock.
+  It is a simple way to measure how long an interactor takes to run.
+email:
+- contact@robl.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/interactor/stopwatch.rb
+- lib/interactor/stopwatch/version.rb
+- sig/interactor/stopwatch.rbs
+homepage: https://github.com/braindeaf/interactor-stopwatch
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/braindeaf/interactor-stopwatch
+  source_code_uri: https://github.com/braindeaf/interactor-stopwatch
+  changelog_uri: https://github.com/braindeaf/interactor-stopwatch/CHANGELOG.md
+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.5.3
+signing_key:
+specification_version: 4
+summary: Stopwatch is a miniature Interactor extension that is watching the clock.
+test_files: []