roman_monkey 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+*.gem
+doc/
+tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in roman_monkey.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Bardi Einarsson
+
+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,89 @@
+roman\_monkey
+================
+
+## Summary
+
+simple roman numerals from 1 to 3999
+
+## Description
+
+roman\_monkey is a set of simple tools for formatting the numbers from 1 to 3999 as roman numerals, as well as, converting and validating the roman numerals themselves.
+
+## Usage
+
+Object instance methods
+
+    require 'roman_monkey'
+    # or require 'fast_roman_monkey'
+    #   for pre calculated roman numerals
+
+    :i_to_roman
+    :roman_to_i
+    :roman? # is it a roman numeral?, :roman_to_i equivalent
+
+    irb prompt> require 'roman_monkey'
+     => true
+    irb prompt> 1999.i_to_roman
+     => "MCMXCIX"
+    irb prompt> '1999 was a good year'.i_to_roman
+     => "MCMXCIX"
+    irb prompt> "MCMXCIX".roman_to_i
+     => 1999
+    irb prompt> :MCMXCIX.roman_to_i
+     => 1999
+    irb prompt> 'LD'.roman?
+     => nil 
+    irb prompt> 'CDL'.roman?
+     => 450 
+    irb prompt> 4000.i_to_roman
+     => nil 
+    irb prompt> 0.i_to_roman
+     => nil 
+
+Simplest usage
+
+    require 'roman_numeral'
+    # for :i_to_roman module method
+
+    irb prompt> require 'roman_numeral'
+     => true
+    irb prompt> RomanNumeral.i_to_roman 3888
+     => "MMMDCCCLXXXVIII"
+
+To add roman numeral validation
+
+    require 'slow_roman'
+    # for :roman_to_i module method
+    # or require 'fast_roman'
+    #   for pre calculated roman numerals
+
+    irb prompt> require 'slow_roman'
+     => true
+    irb prompt> RomanNumeral.i_to_roman 3888
+     => "MMMDCCCLXXXVIII"
+    irb prompt> RomanNumeral.roman_to_i "MMMDCCCLXXXVIII"
+     => 3888
+
+## Requirements
+
+Most likely any recent version of 1.9 ruby works.
+
+## Test with rspec ~> 2.11, rspec -fd
+
+Try the software in irb:
+
+    irb prompt> load 'spec/support/roman_test.rb'
+
+Note, to find the gem installation directory:
+
+    irb prompt> require 'roman_monkey'
+    irb prompt> $".grep(/roman_monkey/)[0]
+    irb prompt> Object.new.method(:i_to_roman).source_location
+    irb prompt> exit
+
+## License
+
+Copyright (c) 2013 Bardi Einarsson. Released under the MIT License.  See the [LICENSE][license] file for further details.
+
+[license]: https://github.com/bardibardi/roman_monkey/blob/master/LICENSE.md
+

data/lib/fast_roman.rb

@@ -0,0 +1,20 @@
+require_relative 'roman_numeral'
+
+module RomanNumeral
+
+  ROMANS = (1...4000).reduce([nil],&->(a,i){a<<slow_i_to_roman(i).to_sym})
+  INTS = ROMANS.each_with_index.reduce({},&->(h,p){h[p[0]]=p[1];h})
+
+  def self.i_to_roman i
+    sym = ROMANS[i.to_i]
+    return nil unless sym
+    sym.to_s
+  end
+
+  def self.roman_to_i r
+    r = r.to_s.to_sym unless Symbol == r.class
+    INTS[r]
+  end
+
+end
+

data/lib/fast_roman_monkey.rb

@@ -0,0 +1,18 @@
+require_relative 'fast_roman'
+
+class Object
+
+  def i_to_roman
+    RomanNumeral::i_to_roman self
+  end
+
+  def roman_to_i
+    RomanNumeral::roman_to_i self
+  end
+
+  def roman?
+    roman_to_i
+  end
+
+end
+

data/lib/roman_monkey.rb

@@ -0,0 +1,18 @@
+require_relative 'slow_roman'
+
+class Object
+
+  def i_to_roman
+    RomanNumeral::i_to_roman self
+  end
+
+  def roman_to_i
+    RomanNumeral::roman_to_i self
+  end
+
+  def roman?
+    roman_to_i
+  end
+
+end
+

data/lib/roman_numeral.rb

@@ -0,0 +1,69 @@
+module RomanNumeral
+
+  I_TO_DIGIT = {
+    1 => :I,
+    2 => :II,
+    3 => :III,
+    4 => :IV,
+    5 => :V,
+    6 => :VI,
+    7 => :VII,
+    8 => :VIII,
+    9 => :IX,
+    10 => :X,
+    20 => :XX,
+    30 => :XXX,
+    40 => :XL,
+    50 => :L,
+    60 => :LX,
+    70 => :LXX,
+    80 => :LXXX,
+    90 => :XC,
+    100 => :C,
+    200 => :CC,
+    300 => :CCC,
+    400 => :CD,
+    500 => :D,
+    600 => :DC,
+    700 => :DCC,
+    800 => :DCCC,
+    900 => :CM,
+    1000 => :M,
+    2000 => :MM,
+    3000 => :MMM
+  }
+
+  def self.high_digit_value i
+    return nil unless -1 < i
+    return [0, 0] if 0 == i
+    shift = 0
+    v = i
+    while v > 9
+      v = v/10
+      shift += 1
+    end
+    while shift > 0
+      v *= 10
+      shift -= 1
+    end
+    [v, i - v]
+  end
+
+  def self.i_to_roman i
+    r = []
+    rest = i.to_i
+    while (digit_value, rest = high_digit_value(rest); digit_value > 0)
+      roman_digit = I_TO_DIGIT[digit_value]
+      return nil unless roman_digit
+      r << roman_digit.to_s
+    end
+    return nil if 0 == r.length
+    r.join ''
+  end
+
+  class << self
+    alias :slow_i_to_roman :i_to_roman
+  end
+
+end # RomanNumeral
+

data/lib/slow_roman.rb

@@ -0,0 +1,49 @@
+require_relative 'roman_numeral'
+
+module RomanNumeral
+
+  DIGIT_TO_I = I_TO_DIGIT.invert
+
+  def self.next_roman_digit_of_size r, size
+    len = r.length
+    rn = r.slice(0, size)
+    v = DIGIT_TO_I[rn.to_sym]
+    return nil unless v
+    tail = r.slice(size, len - size)
+    tail = nil if '' == tail
+    [v, tail]
+  end
+
+  def self.next_roman_digit r
+    result = next_roman_digit_of_size r, 4
+    return result if result
+    result = next_roman_digit_of_size r, 3
+    return result if result
+    result = next_roman_digit_of_size r, 2
+    return result if result
+    next_roman_digit_of_size r, 1
+  end
+
+  def self.roman_to_i r
+    return nil unless r
+    rest = r.to_s
+    return nil if 0 == rest.length
+    lastv = 10000
+    acc = 0
+    while rest
+      v, rest = next_roman_digit(rest)
+      return nil unless v
+      return nil unless lastv.to_s.length > v.to_s.length
+      acc += v
+      lastv = v
+    end
+    return nil if 0 == acc
+    acc
+  end
+
+  class << self
+    alias :slow_roman_to_i :roman_to_i
+  end
+
+end # RomanNumeral
+

data/roman_monkey.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name = 'roman_monkey'
+  s.version = '1.0.0'
+  s.date = '2013-04-07'
+  s.summary = "simple roman numerals from 1 to 3999"
+  s.description = "roman_monkey is a set of simple tools for formatting the numbers from 1 to 3999 as roman numerals, as well as, converting and validating the roman numerals themselves."
+
+  s.authors = ['Bardi Einarsson']
+  s.email = ['bardi@hotmail.com']
+  s.homepage = 'https://github.com/bardibardi/roman_monkey'
+  s.required_ruby_version = '>= 1.9.2'
+  s.add_development_dependency('rspec', '~> 2.11')
+
+  s.files = %w(
+.gitignore
+Gemfile
+LICENSE.md
+README.md
+roman_monkey.gemspec
+lib/roman_numeral.rb
+lib/slow_roman.rb
+lib/fast_roman.rb
+lib/roman_monkey.rb
+lib/fast_roman_monkey.rb
+spec/roman_monkey_spec.rb
+spec/support/no_should_rspec.rb
+spec/support/roman_test.rb
+)
+end
+

data/spec/roman_monkey_spec.rb

@@ -0,0 +1,50 @@
+require 'support/no_should_rspec'
+require 'support/roman_test'
+
+describe RomanNumeral do
+
+  it "should, for all roman numerals, convert integers to roman numerals and back" do
+    expect(RomanNumeral.reversible?).to be_true
+  end
+
+  it "should, for all roman numerals, slowly convert integers to roman numerals and back" do
+    expect(RomanNumeral.slow_reversible?).to be_true
+  end
+
+end
+
+describe Object do
+
+  it "should accept i_to_roman for number compatible types" do
+    expect(1.i_to_roman).to eq('I')
+    expect(1.9999.i_to_roman).to eq('I')
+    expect('1 potatoes'.i_to_roman).to eq('I')
+    expect(3999.i_to_roman).to eq('MMMCMXCIX')
+    expect('3999 marbles'.i_to_roman).to eq('MMMCMXCIX')
+  end
+
+  it "should accept roman_to_i for roman numeral compatible types" do
+    expect(:I.roman_to_i).to eq(1)
+    expect('I'.roman_to_i).to eq(1)
+    expect(:MMMCMXCIX.roman_to_i).to eq(3999)
+    expect('MMMCMXCIX'.roman_to_i).to eq(3999)
+  end
+
+  it "should have i_to_roman return null for instances not in (1...4000)" do
+    expect(0.i_to_roman).to be_nil
+    expect('no potatoes'.i_to_roman).to be_nil
+    expect(4000.0.i_to_roman).to be_nil
+    expect(4000.i_to_roman).to be_nil
+    expect('4000 marbles'.i_to_roman).to be_nil
+  end
+
+  it "should have roman_to_i return null for instances not in (:I..:MMMCDXCIX)" do
+    expect(''.roman_to_i).to be_nil
+    expect(nil.roman_to_i).to be_nil
+    expect(:MMMM.roman_to_i).to be_nil
+    expect(:CCD.roman_to_i).to be_nil
+    expect(:LM.roman_to_i).to be_nil
+  end
+
+end
+

data/spec/support/no_should_rspec.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+
+  # rspec 2.11 turn off should monkey patching
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+end
+

data/spec/support/roman_test.rb

@@ -0,0 +1,54 @@
+require_relative '../../lib/roman_monkey'
+require_relative '../../lib/fast_roman'
+
+module RomanNumeral
+
+  def self.reversible?
+    (1...4000).each do |i|
+      s = i_to_roman i
+      return nil unless s
+      i2 = roman_to_i s
+      return nil unless i2
+      return nil unless i == i2
+    end
+    true
+  end
+
+  def self.slow_reversible?
+    (1...4000).each do |i|
+      s = slow_i_to_roman i
+      return nil unless s
+      i2 = slow_roman_to_i s
+      return nil unless i2
+      return nil unless i == i2
+    end
+    true
+  end
+
+  def self.reversible2?
+    (1...4000).each do |i|
+      s = i_to_roman i
+      unless s
+        p 'i'
+        p i
+        return nil unless s
+      end
+      i2 = roman_to_i s
+      unless i2
+        p 's'
+        p s
+        return nil unless i2
+      end
+      unless i == i2
+        p 'i'
+        p i
+        p 'i2'
+        p i2
+        return nil unless i == i2
+      end
+    end
+    true
+  end
+
+end # RomanNumeral
+

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: roman_monkey
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Bardi Einarsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: roman_monkey is a set of simple tools for formatting the numbers from
+  1 to 3999 as roman numerals, as well as, converting and validating the roman numerals
+  themselves.
+email:
+- bardi@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- roman_monkey.gemspec
+- lib/roman_numeral.rb
+- lib/slow_roman.rb
+- lib/fast_roman.rb
+- lib/roman_monkey.rb
+- lib/fast_roman_monkey.rb
+- spec/roman_monkey_spec.rb
+- spec/support/no_should_rspec.rb
+- spec/support/roman_test.rb
+homepage: https://github.com/bardibardi/roman_monkey
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: simple roman numerals from 1 to 3999
+test_files: []