ms-rb 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffe1320c11560d697c6e1aa26a894216d56b1d91108baad876199cea9bed541f
-  data.tar.gz: 2738fdca6efb992e16f28b6f224c5ce51778ccf2b357b30f6288e852e762004f
+  metadata.gz: f6d761b6b9a5ff849e3c44d81391ad5e1eeb00c1c6acf0799c9204fc0bfae982
+  data.tar.gz: a3b9380fd07100958cfeb2a2a4923426c9a26abddd15a4968345526ca325b20c
 SHA512:
-  metadata.gz: 59922299e4267e9c62b32674e617d78bf088ebcca40a41e5c7d809228de1c01a1a1bacc4fd52f0b392f461909d7956e6dade28b1614cd6e7e39bb78af7700983
-  data.tar.gz: dea00fa6c4271b7da95c1472ecaa4729c399847fa4022ec450a140f97b43bcf21b50e98ac6be2365397b12da5f64d02bb1d9de4fcbeb9b440764b10351ed7bee
+  metadata.gz: b53326c6b08843126fb30ea50a429e13751ecde1e87f7e20bb06125b82965f73f725d9a2c4a2681b9b17f5669886915941b46bf2d37d642087d9ca19063b6bbc
+  data.tar.gz: c1d4085bcaee66e094febb257aa246c3fc5163d91f38866d690f3fc5d30c7a3219e750793cf1267c757fbd5b6f2da6ca1ec5176b4ca5230c7afd11a8cf1a8c33

data/README.md

@@ -1,39 +1,154 @@
 # ms-rb
 
-Ruby port of the popular [JavaScript library **ms** (by Vercel)](https://github.com/vercel/ms).  
-Convert human-readable durations like `"2h"`, `"1.5d"`, `"3w"`, `"500ms"`  
-**into milliseconds and back.**
+[![Gem Version](https://badge.fury.io/rb/ms-rb.svg)](https://badge.fury.io/rb/ms-rb)
+![Build Status](https://github.com/armiiller/ms-rb/actions/workflows/ci.yml/badge.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+A Ruby port of the popular [`ms`](https://github.com/vercel/ms) library from Vercel.
+
+Convert human-friendly time strings like `"1h"`, `"2 days"`, `"3w"`, `"1.5mo"` into milliseconds — and convert milliseconds back into strings.
+
+This gem aims to match the behavior of Vercel/ms, including:
+
+- `ms("1h") -> 3600000`
+- `ms(3600000) -> "1h"`
+- Strict and non-strict parsing
+- Long and short formatting
+- Floating-point and negative values
+- Full unit support (ms, s, m, h, d, w, mo, y)
+
+---
 
 ## Installation
 
+Add to your Gemfile:
+
+```ruby
+gem "ms-rb"
+```
+
+Or install directly:
+
 ```bash
 gem install ms-rb
 ```
-Or add this line to your application's Gemfile:
+
+Then require it:
 
 ```ruby
-gem 'ms-rb'
+require "ms"
 ```
 
+---
+
 ## Usage
 
+The main entrypoint is:
+
 ```ruby
-require "ms/rb"
+Ms.ms(value, long: false)
+```
+
+### Parse a duration string → milliseconds
 
-Ms::Rb.ms("2h")            # => 7200000
-Ms::Rb.parse("3d")         # => 259200000
-Ms::Rb.format(1500)        # => "2s"
-Ms::Rb.format(1500, long: true)
+```ruby
+Ms.ms("2h")          # => 7200000
+Ms.ms("1.5d")        # => 129600000
+Ms.ms("3 weeks")     # => 1814400000
+Ms.ms("-10ms")       # => -10
+Ms.ms("1   s")       # => 1000
+```
+
+### Format milliseconds → duration string
+
+Short form:
+
+```ruby
+Ms.ms(3600000)                 # => "1h"
+Ms.ms(5400000)                 # => "2h"
+```
+
+Long form:
+
+```ruby
+Ms.ms(3600000, long: true)     # => "1 hour"
+Ms.ms(5400000, long: true)     # => "2 hours"
+```
+
+### Strict parsing
+
+```ruby
+Ms.parse_strict("1h")   # => 3600000
+Ms.parse_strict("foo")  # => NaN
 ```
 
-Supports:
-- years (y)
-- months (mo)
-- weeks (w)
-- days (d)
-- hours (h)
-- minutes (m)
-- seconds (s)
-- milliseconds (ms)
+---
+
+## Supported Units
+
+| Unit(s)                                | Meaning      |
+|----------------------------------------|--------------|
+| `ms`, `msec`, `millisecond`, `milliseconds` | Milliseconds |
+| `s`, `sec`, `second`, `seconds`             | Seconds      |
+| `m`, `min`, `minute`, `minutes`             | Minutes      |
+| `h`, `hr`, `hour`, `hours`                  | Hours        |
+| `d`, `day`, `days`                          | Days         |
+| `w`, `week`, `weeks`                        | Weeks        |
+| `mo`, `month`, `months`                     | Months       |
+| `y`, `yr`, `year`, `years`                  | Years        |
+
+Supports floats, negative values, and mixed case:
+
+```ruby
+Ms.ms("1.5H")      # => 5400000
+Ms.ms("-.5h")      # => -1800000
+Ms.ms("53 YeArS")  # => 1672552800000
+```
+
+---
+
+## API
+
+### `Ms.ms(value, long: false)`
+
+Main entrypoint. Accepts:
+
+- `String` → returns milliseconds (`Integer` or `Float`)
+- `Numeric` → returns formatted string (`"1h"` or `"1 hour"`)
+
+Example:
+
+```ruby
+Ms.ms("2h")                 # => 7200000
+Ms.ms(7200000)              # => "2h"
+Ms.ms(7200000, long: true)  # => "2 hours"
+```
+
+### `Ms.parse(string)`
+
+Non-strict parser.  
+Returns `NaN` for invalid input.
+
+### `Ms.parse_strict(string)`
+
+Strict parser.  
+Raises on invalid input types, returns `NaN` for malformed strings.
+
+### `Ms.format(ms, long: false)`
+
+Formats milliseconds directly.
+
+---
+
+## Testing
+
+```bash
+bundle install
+bundle exec rake test
+```
+
+---
+
+## License
 
-Follows the same parsing and formatting rules as the JavaScript library.
+MIT © Austin Miller

data/lib/ms/rb/version.rb

@@ -2,6 +2,6 @@
 
 module Ms
   module Rb
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/ms.rb

@@ -6,8 +6,8 @@ require_relative "ms/rb"
 module Ms
   module_function
 
-  def ms(value, options = {})
-    Rb.ms(value, options)
+  def ms(value, **options)
+    Rb.ms(value, **options)
   end
 
   def parse(str)
@@ -18,7 +18,7 @@ module Ms
     Rb.parse_strict(str)
   end
 
-  def format(ms, options = {})
-    Rb.format(ms, options)
+  def format(ms, **options)
+    Rb.format(ms, **options)
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ms-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Austin Miller
 bindir: exe
 cert_chain: []
-date: 2025-11-30 00:00:00.000000000 Z
+date: 2025-12-01 00:00:00.000000000 Z
 dependencies: []
 description: Parse and format durations like '2h', '1.5d', '3w', '500ms' into milliseconds
   and back.