go-duration 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae1bf552d2be8eba1d80e8f4a1b8fe0f3a3438e6
+  data.tar.gz: f2d4b5986aba2578496e8beb0756a0d5db18f651
+SHA512:
+  metadata.gz: 957897604363254f46829038ddb0592cf64d3c420bd4bef9509ce518ecfd072ea70d500f3c9974ab6f8d8e9213796860fe34eeb537b8466cfdd13c34e655d6d4
+  data.tar.gz: cb45a0f85333bf80c0476cbd57318b28b972e94516cde13ff0d3303922a913cc5508bad5bd62aa8b1d3429bd1674d981ba50798d39304272e708c329e9bfa655

data/lib/go-duration.rb

@@ -0,0 +1,3 @@
+require 'go-duration/version'
+require 'go-duration/errors'
+require 'go-duration/duration'

data/lib/go-duration/duration.rb

@@ -0,0 +1,131 @@
+module GoDuration
+  # The base unit, a single nanosecond.
+  NANOSECOND = 1.freeze
+
+  # One microsecond in nanoseconds.
+  MICROSECOND = NANOSECOND << 10.freeze
+
+  # One millisecond in nanoseconds.
+  MILLISECOND = MICROSECOND << 1.freeze
+
+  # One second in nanoseconds.
+  SECOND = MILLISECOND << 1.freeze
+
+  # One minute in nanoseconds.
+  MINUTE = 60 * SECOND.freeze
+
+  # One hour in nanoseconds.
+  HOUR = 60 * MINUTE.freeze
+
+  # A mapping of Go's unit notations to their nanosecond values. Order is
+  # important, it defines how to_s works.
+  UNITS = {
+    h: HOUR,
+    m: MINUTE,
+    s: SECOND,
+    ms: MILLISECOND,
+    µs: MICROSECOND,
+    us: MICROSECOND,
+    ns: NANOSECOND,
+  }.freeze
+
+  # Duration deals with Golang's time.Duration. This type is commonly used
+  # in API's and/or CLI's, and is defined in the language itself (there is no
+  # formal specifcation or RFC for it). This class can be used to both parse
+  # and format duration strings.
+  class Duration
+    attr_reader :nanoseconds
+
+    # Initializes a new duration instance.
+    #
+    # @param number [Fixnum]
+    # @param unit [Symbol, :s]
+    #
+    # @return [Duration]
+    def initialize(number, unit: :s)
+      raise InvalidUnitError, unit unless UNITS[unit]
+      @nanoseconds = number * UNITS[unit]
+    end
+
+    # Returns the number of microseconds in the duration.
+    #
+    # @return [Fixnum]
+    def microseconds
+      nanoseconds / UNITS[:µs]
+    end
+
+    # Returns the number of milliseconds in the duration.
+    #
+    # @return [Fixnum]
+    def milliseconds
+      nanoseconds / UNITS[:ms]
+    end
+
+    # Returns the number of seconds in the duration.
+    #
+    # @return [Fixnum]
+    def seconds
+      nanoseconds / UNITS[:s]
+    end
+
+    # Returns the number of minutes in the duration.
+    #
+    # @return [Fixnum]
+    def minutes
+      nanoseconds / UNITS[:m]
+    end
+
+    # Returns the number of hours in the duration.
+    #
+    # @return [Fixnum]
+    def hours
+      nanoseconds / UNITS[:h]
+    end
+
+    # Returns the exact duration in nanoseconds.
+    #
+    # @return [Fixnum]
+    def to_i
+      nanoseconds
+    end
+
+    # Formats the duration into a Go duration string.
+    #
+    # @return [String]
+    def to_s
+      ns = nanoseconds
+      fmt = ""
+
+      UNITS.each do |unit, value|
+        number, ns = ns.divmod(value)
+        fmt << "#{number}#{unit}" if number > 0
+      end
+
+      fmt
+    end
+  end
+
+  module_function
+
+  # Parses a Go time.Duration string.
+  #
+  # @param duration [String] A Go duration string.
+  #
+  # @return [Duration]
+  def parse(duration)
+    ns = 0
+
+    until duration.empty?
+      number = duration.slice!(/^[[:digit:]]+/).to_i
+      unit = duration.slice!(/^[[:alpha:]]+/).to_sym
+
+      # Check that the units are recognized.
+      raise InvalidUnitError, unit unless UNITS[unit]
+
+      # Convert to nanoseconds and add to the total.
+      ns += (number * UNITS[unit])
+    end
+
+    Duration.new(ns, unit: :ns)
+  end
+end

data/lib/go-duration/errors.rb

@@ -0,0 +1,11 @@
+module GoDuration
+  class GoDurationError < RuntimeError; end
+
+  class InvalidUnitError < GoDurationError
+    def initialize(unit)
+      super <<-EOF.gsub(/^\s*/, "")
+      Invalid unit `#{unit}'. Must be one of: #{UNITS.keys.join(", ")}
+      EOF
+    end
+  end
+end

data/lib/go-duration/version.rb

@@ -0,0 +1,3 @@
+module GoDuration
+  VERSION = "0.1.3".freeze
+end

data/spec/go-duration/duration_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+module GoDuration
+  all_duration = "1h1m1s1ms1µs1ns"
+  all_nano = HOUR + MINUTE + SECOND + MILLISECOND + MICROSECOND + NANOSECOND
+
+  describe Duration do
+    describe "#new" do
+      it "creates from seconds by default" do
+        d = Duration.new(13)
+        expect(d.nanoseconds).to eq(13 * GoDuration::SECOND)
+      end
+
+      it "creates with the provided unit" do
+        d = Duration.new(13, unit: :ms)
+        expect(d.nanoseconds).to eq(13 * GoDuration::MILLISECOND)
+      end
+
+      it "raises an error on invalid unit" do
+        expect { Duration.new(1, unit: :nope) }
+          .to raise_error(GoDuration::InvalidUnitError)
+      end
+    end
+
+    describe "#to_s" do
+      context "when all units are present" do
+        it "renders all of the units" do
+          expect(Duration.new(all_nano, unit: :ns).to_s)
+            .to eq(all_duration)
+        end
+      end
+
+      context "when a unit overflows" do
+        it "reduces into a larger unit" do
+          expect(Duration.new(63, unit: :s).to_s).to eq("1m3s")
+        end
+      end
+    end
+  end
+
+  describe "#parse" do
+    it "parses a time.Duration string" do
+      d = GoDuration.parse("1h")
+      expect(d.nanoseconds).to eq(HOUR)
+    end
+
+    it "recognizes either form of microseconds" do
+      a = GoDuration.parse("99us").microseconds
+      b = GoDuration.parse("99µs").microseconds
+      expect(a).to eq(b)
+    end
+
+    context "when multiple units are present" do
+      it "converts and adds them up" do
+        d = GoDuration.parse("1h43m")
+        expect(d.nanoseconds).to eq(HOUR + (43 * MINUTE))
+      end
+
+      it "recognizes all of the units" do
+        d = GoDuration.parse(all_duration)
+        expect(d.nanoseconds).to eq(all_nano)
+      end
+
+      it "raises an error if an invalid unit is found" do
+        expect { GoDuration.parse("1h2x") }.to raise_error(InvalidUnitError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'go-duration'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: go-duration
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Ryan Uber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: A parser and formatter for Golang's time.Duration
+email:
+- ru@ryanuber.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/go-duration.rb
+- lib/go-duration/duration.rb
+- lib/go-duration/errors.rb
+- lib/go-duration/version.rb
+- spec/go-duration/duration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ryanuber/go-duration-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A parser and formatter for Golang's time.Duration
+test_files:
+- spec/spec_helper.rb
+- spec/go-duration/duration_spec.rb