ons-numbers 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bbbbb61c50526f46185a58cb58c3e8a496b15a3dd769de5e26b9f22ef225193
+  data.tar.gz: d6a5ca3b510c5a142549a7b37d16ff6ea9e2afa73b0966b7dfc118a7fdb83af9
+SHA512:
+  metadata.gz: c481ef0423bd833e09aee1c8bb84de5fa4bb7078211c82df9443ea47d79019222b5830e65c2a65b319e0f855f0af569a3d78fb56025e2da83266ef625272523b
+  data.tar.gz: a73d32bf1f28924607320255c9fc334255f0678d4167f55f8a31227c860ecac4c048572728923d5e1b121f391eff48efb6a94ef463497b563f24dcf6acc968f4

data/README.md

@@ -0,0 +1,30 @@
+# ONS Numbers RubyGem
+A utility class for formatting numbers in common ways. Note that this gem targets Ruby 3.0 and above.
+
+## Installation
+
+```
+gem install ons-numbers
+```
+
+## Examples
+
+```ruby
+require 'ons-numbers'
+
+Numbers.currency(1234.56) # => "£1,234.56"
+Numbers.grouped(1234567) # => "1,234,567"
+Numbers.percentage(75, 100) # => "75.0%"
+```
+
+## Testing
+
+```
+rake test
+```
+
+## Licence
+This library is licensed under the MIT licence. Full licence text is available in [LICENCE](LICENCE).
+
+## Copyright
+Copyright (C) 2022 Crown Copyright (Office for National Statistics)

data/lib/ons-numbers/numbers.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Class to format numbers in common ways.
+class Numbers
+  class << self
+    # Returns the passed number formatted as GBP currency e.g. £1,234.56.
+    #
+    # Params:
+    # - number: The number to format.
+    def currency(number)
+      return '£0' if number.nil?
+
+      "£#{grouped(format('%.2f', number))}"
+    end
+
+    # Returns the passed number formatted in groups of 1000 e.g 1,000,000. Note that any numbers
+    # after the decimal point are preserved unformatted.
+    #
+    # Params:
+    # - number: The number to format.
+    #
+    # An Argument error is raised if number is nil.
+    def grouped(number)
+      raise ArgumentError.new('number cannot be nil') if number.nil?
+
+      whole, decimal = number.to_s.split('.')
+      count_groups = whole.to_s.chars.to_a.reverse.each_slice(3)
+      whole_with_commas = count_groups.map(&:join).join(',').reverse
+      [whole_with_commas, decimal].compact.join('.')
+    end
+
+    # Returns the passed number formatted as a percentage of the passed total.
+    #
+    # Params:
+    # - number: The number which is a percentage of the total.
+    # - total: The total.
+    #
+    # An Argument error is raised if number or total are nil.
+    def percentage(number, total)
+      raise ArgumentError.new('number cannot be nil') if number.nil?
+      raise ArgumentError.new('total cannot be nil') if total.nil?
+
+      "#{((number.to_f / total.to_f) * 100).round(2)}%"
+    end
+  end
+end

data/lib/ons-numbers/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ONSNumbers
+  module Version
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+  end
+  VERSION = [Version::MAJOR, Version::MINOR, Version::TINY].compact * '.'
+end

data/lib/ons-numbers.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'ons-numbers/numbers'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: ons-numbers
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- John Topley
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+description: 'A utility class for formatting numbers in common ways.
+
+  '
+email:
+- john.topley@ons.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/ons-numbers.rb
+- lib/ons-numbers/numbers.rb
+- lib/ons-numbers/version.rb
+homepage: https://github.com/ONSdigital/ons-numbers
+licenses:
+- MIT
+metadata: {}
+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.3.3
+signing_key:
+specification_version: 4
+summary: A number formatting library.
+test_files: []