time_m 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1625e7f38895cbe0171813d220f22f43f9020a3bfc57ef73427fc2ba1be48bb8
+  data.tar.gz: 377a2a49b5419c047fc763fc39b2aa821eb2e32b71897595721170754273739a
+SHA512:
+  metadata.gz: 5343059d77c20b496b61d0962f18b1b37194ac74ed60527e22ee385bce269e1eb520b3dff3d5cfe57625d4240a50d89716e47770030d96947d1cd38fcb11905d
+  data.tar.gz: d2f8d1889ebc3b9541b310f8ee7fbb655cb7117b30c89ce55ba564b32d7b7662f23e9391c7bc769e62722587295f67d74575cb01fdefc5602858814a3707e2ae

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.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-29
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Igor Kasyanchuk
+
+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,84 @@
+# Time.measure
+
+The easiest way to measure execution time of your code. No more `puts` or `logger.info` with `Time.now - time`.
+
+Start measuring your code, and if you value your time, use this gem :)
+
+## Installation
+
+```ruby
+group :development, :test do
+  gem "time_m"
+end
+```
+
+## Usage
+
+To make is super easy to use, it extends `Time` class with `m` (or `measure`) method. There is also an advanced way to use it, see below.
+
+```ruby
+Time.m("test") do
+  sleep 0.1
+end
+
+# or
+
+def index
+  Time.m
+  some_method_1
+  Time.m
+  some_method_2
+  Time.m
+  some_method_3
+  Time.m
+end
+```
+
+## How it works
+
+Under the hood, it uses `Process.clock_gettime(Process::CLOCK_MONOTONIC)` to get the current time.
+
+After first call, it stores the time in a thread-local variable using `Thread.current`.
+
+With second call, it calculates the difference between the current time and the time stored in the thread-local variable.
+
+## Advanced usage
+
+Support of multiple timers. You can call any method (it's using `method_missing` under the hood) to start a new timer with it's name.
+
+It will print duration if the same method is called again.
+
+```ruby
+def index
+  TM.index
+  TM.some_method_1
+  some_method_1
+  TM.some_method_1
+  TM.some_method_2
+  some_method_2
+  TM.some_method_2
+  TM.index
+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).
+
+## TODO
+
+- config for colors
+- config to specify print of caller
+- config to enable extension for Time class
+- config for custom output
+- instrumentation support?
+
+## Contributing
+
+You are welcome to contribute to the project.
+
+## 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/time_m/timer.rb

@@ -0,0 +1,25 @@
+module TimeM
+  class Timer
+    attr_reader :timers
+
+    def initialize
+      @timers = {}
+    end
+
+    def init(name = nil)
+      @timers[name] ||= {}
+      now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      @timers[name][:time] = now
+      touch(name, now)
+    end
+
+    def touch(name, time)
+      @timers[name] ||= {}
+      @timers[name][:last_time] = time
+    end
+
+    def reset_all
+      @timers = {}
+    end
+  end
+end

data/lib/time_m/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TimeM
+  VERSION = "0.1.0"
+end

data/lib/time_m.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative "time_m/version"
+require_relative "time_m/timer"
+require "colorize"
+
+module TimeM
+  NAME = "| time_m |"
+  SKIP_FLAG = -1
+
+  def self.method_missing(method, *args, &block) # rubocop:disable Style/MissingRespondToMissing
+    name = method.to_s
+    label = args.first.to_s
+    label = (label == "") ? nil : label
+
+    m(name, label, &block)
+  end
+
+  def self.m(name = nil, label = nil, &block)
+    now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    if block_given?
+      yield.tap do |res|
+        output(name, label, Process.clock_gettime(Process::CLOCK_MONOTONIC) - now)
+      end
+    else
+      timer = tracker.timers[name]
+      if timer.nil?
+        tracker.init(name)
+        output(name, label)
+      else
+        diff = now - timer[:last_time] if timer[:last_time]
+        output(name, label, now - timer[:time], diff)
+        tracker.touch(name, now)
+      end
+    end
+  end
+
+  private_class_method
+
+  def self.output(name, label, time = SKIP_FLAG, last_time = nil)
+    display_name = label || name || caller[1..2].detect { |line| !line.include?("/lib/time_m") }
+    display_name = display_name.gsub(Rails.root.to_s + "/", "") if defined?(Rails)
+
+    if time == SKIP_FLAG
+      info NAME.on_light_yellow
+      info " #{display_name} ⏲", new_line: true
+      return
+    end
+
+    time = time.round(3)
+    last_time = last_time.round(3) if last_time
+    info NAME.on_light_yellow
+
+    if display_name
+      info " #{display_name} ∑"
+      warning sprintf("%0.3f", time)
+      info " seconds"
+
+      if last_time
+        info ", "
+        success "+#{sprintf("%0.3f", last_time)}"
+        info " seconds", new_line: true
+      else
+        info new_line: true
+      end
+    else
+      info " Elapsed time: #{sprintf("%0.3f", time)} seconds", new_line: true
+    end
+  end
+
+  def self.tracker
+    Thread.current[:time_m_timer] ||= Timer.new
+  end
+
+  # colors: https://github.com/fazibear/colorize/blob/master/lib/colorize/class_methods.rb
+
+  def self.info(str = "", new_line: false)
+    log(str.magenta.italic, new_line: new_line)
+  end
+
+  def self.success(str = "", new_line: false)
+    log(str.light_green.bold, new_line: new_line)
+  end
+
+  def self.warning(str = "", new_line: false)
+    log(str.light_yellow.bold, new_line: new_line)
+  end
+
+  def self.log(str = "", new_line: false)
+    new_line ? puts(str) : print(str)
+  end
+
+  module TimeExt
+    def m(name = nil, label = nil, &block)
+      TimeM.m(name, label, &block)
+    end
+
+    alias_method :measure, :m
+  end
+end
+
+TM = TimeM
+
+Time.extend(TimeM::TimeExt)

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: time_m
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Kasyanchuk
+bindir: exe
+cert_chain: []
+date: 2025-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Measure time in your code
+email:
+- igorkasyanchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/time_m.png
+- docs/time_m_code.png
+- lib/time_m.rb
+- lib/time_m/timer.rb
+- lib/time_m/version.rb
+homepage: https://github.com/igorkasyanchuk/time_m
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/igorkasyanchuk/time_m
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: Measure time in your code
+test_files: []