sleeping_king_studios-ext 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a577560ebfa76eda2fb92e99731fd660d46ef67c
-  data.tar.gz: 08f133c3c52f49a36b977e42da1fd293d24dbaec
+  metadata.gz: fc326e56033ad5f5c95eb5b7a7ff96d7ad6ec487
+  data.tar.gz: 1f533dac8c8088c63a786dcf2f9c1fc8c5531c4c
 SHA512:
-  metadata.gz: 1abefaf6b82006133c1820a32f38939ca43836fa9a06aa3804ccae2f9f001a37f98f63f8e1292d256512007d7bbec32f3cf21e6b9a447d907bed914d068e1a03
-  data.tar.gz: 77753ec2b8bea81cc240e45d5c011f2f62e3a396925acd5c8b4e1ef4bba3a5f58318e37f1537e67ee430a1c6bbd6050bf83c5a3be80db17e539166d667364f75
+  metadata.gz: aebc561b0ec814631dc6c70206bde62a7c3505c8663053d48979ae06072c1c4dc0bacd7fb4d7962035703aeeb5f3485e8828b23bce27899558243327c0d9d912
+  data.tar.gz: 2ec1bbe818e887f7741d1ebadf296c045a834f05292189c55059944f1e76e81de7e4d9a9d76d4adc649935c699235a491d8dcd539cde99b542c4bb710425df9e

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.2.0
+
+### Integer
+
+- Added Integer#digits method.
+- Added Integer#romanize method.
+
 ## 0.1.0
 
 Initial release version.

data/README.md

@@ -2,6 +2,9 @@
 
 A collection of extensions to core classes.
 
+YARD documentation is available at
+[RubyDoc.info](http://rubydoc.info/github/sleepingkingstudios/sleeping_king_studios-ext).
+
 ## The Extensions
 
 ### Array\#fold
@@ -14,7 +17,7 @@ result of yielding the block is counted instead.
 
 _Example:_ Find the number of times each item appears in the array.
 
-    items  = %w(foo foo foo bar bar baz wibble wobble)
+    items = %w(foo foo foo bar bar baz wibble wobble)
     items.fold
     #=> { 'foo' => 3, 'bar' => 2, 'baz' => 1, 'wibble' => 1, 'wobble' => 1 }
 
@@ -33,6 +36,59 @@ _Example:_ Count the items in the array with each status value.
     items.fold { |item| item.status }
     #=> { :approved => 3, :rejected => 2, :error => 1, nil => 1 }
 
+### Integer\#digits
+
+    require 'sleeping_king_studios/ext/integer/digits'
+
+Breaks the number into its component digits in the specified base.
+
+_Example:_ Get the digits of a number in base 10.
+
+    23154.digits
+    #=> ['2', '3', '1', '5', '4']
+
+_Example:_ Get the digits of a number in base 2.
+
+    80.digits(2)
+    #=> ['1', '0', '1', '0', '0', '0', '0']
+
+_Example:_ Get digits of a number in base 16.
+
+    3894.digits(16)
+    #=> ['f', '3', '6']
+
+### Integer\#romanize
+
+    require 'sleeping_king_studios/ext/integer/romanize'
+
+Returns the value as a string of Roman numerals, i.e. the number 7 becomes the
+string "VII". The number must be greater than 0 and less than 5000.
+
+_Example:_ Get the number's representation in Roman numerals.
+
+    7.romanize
+    #=> 'VII'
+
+    18.romanize
+    #=> 'XVIII'
+
+    49.romanize
+    #=> 'XLIX'
+
+    3894.romanize
+    #=> 'MMMDCCCXCIV'
+
+#### Additive
+
+If the additive flag is set to true, uses the form 'IIII' for 4 and 'VIIII'
+for 9, as well instead of 'IV' and 'IX', respectively. Also applies to the tens
+and hundreds places, e.g. 40, 90, 400, and 900.
+
+_Example:_ Get the number's representation in additive Roman numerals.
+
+    499.romanize :additive => true
+    #=> 'CCCCLXXXXVIIII'
+
 ### Object\#metaclass
 
     require 'sleeping_king_studios/ext/object/metaclass'

data/lib/sleeping_king_studios/ext/integer/digits.rb

@@ -0,0 +1,12 @@
+# lib/sleeping_king_studios/ext/integer/digits.rb
+
+class Integer
+  # Breaks the number into its component digits in the specified base.
+  # 
+  # @param [Integer] base The base to use when breaking down the number.
+  #
+  # @return [Array<String>]
+  def digits base = 10
+    to_s(base).split ''
+  end # method digits
+end # class

data/lib/sleeping_king_studios/ext/integer/romanize.rb

@@ -0,0 +1,64 @@
+# lib/sleeping_king_studios/ext/integer/romanize.rb
+
+require 'sleeping_king_studios/ext/integer/digits'
+
+class Integer
+  # Minimum allowed value for the #romanize method.
+  ROMANIZE_MIN = 1
+
+  # Maximum allowed value for the #romanize method.
+  ROMANIZE_MAX = 4999
+
+  # Returns the value as a string of Roman numerals. The number must be greater
+  # than 0 and less than 5000 (numbers between 4000 and 4999 are represented by
+  # the string MMMM in the thousands place).
+  #
+  # @param [Hash] options The romanization options.
+  # @option options [Boolean] additive If true, uses the structure IIII for 4
+  #   and the VIIII structure for 9 instead of IV and IX, respectively. Also
+  #   applies to the tens and hundreds places, e.g. 40, 90, 400, etc (the
+  #   thousands place is always additive).
+  #
+  # @return [String] The Roman numerals.
+  # 
+  # @raise [RangeError] If the number is too large or too small to represent
+  #   using Roman numerals.
+  def romanize options = {}
+    unless (ROMANIZE_MIN..ROMANIZE_MAX).include? self
+      raise RangeError.new "integer to romanize must be within range #{ROMANIZE_MIN} to #{ROMANIZE_MAX}"
+    end # unless
+
+    rules = [
+      '',
+      '%one',
+      '%one%one',
+      '%one%one%one',
+      '%one%five',
+      '%five',
+      '%five%one',
+      '%five%one%one',
+      '%five%one%one%one',
+      '%one%ten',
+      '%ten'
+    ] # end array rules
+
+    if Hash === options && options.fetch(:additive, false)
+      rules[4] = '%one%one%one%one'
+      rules[9] = '%five%one%one%one%one'
+    end # if
+
+    numerals = [
+      %w(I V X),
+      %w(X L C),
+      %w(C D M),
+      ['M', 'MMM', '']
+    ] # end array numerals
+
+    digits.reverse.map.with_index do |digit, index|
+      rules[digit.to_i]
+        .gsub('%one',  numerals[index][0])
+        .gsub('%five', numerals[index][1])
+        .gsub('%ten',  numerals[index][2])
+    end.reverse.join ''
+  end # method romanize
+end # class

data/lib/sleeping_king_studios/ext/version.rb

@@ -2,6 +2,6 @@
 
 module SleepingKingStudios
   module Ext
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end # module
 end # module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sleeping_king_studios-ext
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: rspec-sleeping_king_studios
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc.3
 description: |2
       A collection of extensions to core classes, gemified to prevent a
       maintenance nightmare if multiple library or application projects require
@@ -63,6 +77,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/sleeping_king_studios/ext/array/fold.rb
+- lib/sleeping_king_studios/ext/integer/digits.rb
+- lib/sleeping_king_studios/ext/integer/romanize.rb
 - lib/sleeping_king_studios/ext/object/metaclass.rb
 - lib/sleeping_king_studios/ext/version.rb
 - LICENSE