cousin_roman 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e08d7223e1f6cbac0596e6d4c353926caa690a8
+  data.tar.gz: 101f30339215263b1532cfb542224bd3d9870bf1
+SHA512:
+  metadata.gz: 4913128c893097b9eb09af1dea51b9816412f3680153168836c90a28600ea9db28bc7caf321a13ba7fe9f806c5978a2473f0168b5b049948c3bd2c80f424de95
+  data.tar.gz: 375f6152b384cafae84d4ae299fff46f9b895c40ad59559981922e64f15e5073c0679a10572d71be784d1883879febc7bcdea22e3674e885da6493ff7604cfb7

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+*.swo

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Artem Pyanykh
+
+MIT License
+
+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,48 @@
+# CousinRoman
+
+`CousinRoman` is a `String` extension that allows you to convert
+string representation of Roman numbers
+(following modern subtractive notation)
+to Arabic numbers (i.e. Integers).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cousin_roman'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cousin_roman
+
+## Usage
+
+Just use `#to_arabic` or `#to_arabic!` method.
+
+For example:
+
+```ruby
+'MMXIII'.to_arabic # => 2013
+'MMYUOX'.to_arabic # => nil
+'MMYOUX'.to_arabic! # => TypeError: not a valid roman number
+```
+
+## Testing
+
+Just run
+
+    $ rake
+
+under gem folder.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/cousin_roman.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cousin_roman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cousin_roman"
+  spec.version       = CousinRoman::VERSION
+  spec.authors       = ["Artem Pyanykh"]
+  spec.email         = ["artem.pyanykh@gmail.com"]
+  spec.description   = %q{String extension adding capaibility to convert Roman number to Integers.}
+  spec.summary       = %q{Conversion from Roman numbers to Arabic ones.}
+  spec.homepage      = "https://github.com/ArtemPyanykh/cousin_roman"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/cousin_roman.rb

@@ -0,0 +1,3 @@
+require "cousin_roman/version"
+require "cousin_roman/conversion"
+require "cousin_roman/string_extension"

data/lib/cousin_roman/conversion.rb

@@ -0,0 +1,83 @@
+module CousinRoman
+  LITERALS = [
+    'i', 'I',
+    'v', 'V',
+    'x', 'X',
+    'l', 'L',
+    'c', 'C',
+    'd', 'D',
+    'm', 'M'
+  ]
+
+  ONES = {
+    'i' => 1,
+    'x' => 10,
+    'c' => 100,
+    'm' => 1000
+  }
+
+  FIVES = {
+    'v' => 5,
+    'l' => 50,
+    'd' => 500,
+  }
+
+  SUBTRACTIVE = {
+    'iv' => 4,
+    'ix' => 9,
+    'xl' => 40,
+    'xc' => 90,
+    'cd' => 400,
+    'cm' => 900,
+  }
+
+  FACTORS = ONES.merge(FIVES).merge(SUBTRACTIVE)
+
+  class << self
+    def valid?(number)
+      matches = number.match roman_regex
+      matches and !matches[0].empty?
+    end
+
+    # Convert Roman +number+ represented as a string to an Integer.
+    #
+    # It is essential that +numer+ is a valid Roman numeral.
+    #
+    # The steps are:
+    #
+    # 1. Replace factors with their numeric values
+    # starting from subtractive factors (cause they are compound).
+    # 2. Sum this numeric values to get the final answer
+    def convert(number)
+      intermediate = number.dup.downcase
+      SUBTRACTIVE.each do |factor, value|
+        intermediate.gsub!(factor, "(#{value})")
+      end
+      ONES.merge(FIVES).each do |factor, value|
+        intermediate.gsub!(factor, "(#{value})")
+      end
+
+      intermediate.scan(/\((\d*)\)/).reduce(0) do |sum, term|
+        sum + term.first.to_i
+      end
+    end
+
+    def to_arabic(number)
+      clean = number.strip
+      convert clean if valid? clean
+    end
+
+    def to_arabic!(number)
+      clean = number.strip
+      if valid? clean
+        convert clean
+      else
+        raise TypeError, 'not a valid roman number'
+      end
+    end
+
+    def roman_regex
+      /^(M{0,3})(D?C{0,3}|C[DM])(L?X{0,3}|X[LC])(V?I{0,3}|I[VX])$/i
+    end
+  end
+end

data/lib/cousin_roman/string_extension.rb

@@ -0,0 +1,11 @@
+require "cousin_roman/conversion"
+
+class String
+  def to_arabic
+    CousinRoman.to_arabic(self)
+  end
+
+  def to_arabic!
+    CousinRoman.to_arabic!(self)
+  end
+end

data/lib/cousin_roman/version.rb

@@ -0,0 +1,3 @@
+module CousinRoman
+  VERSION = "0.0.1"
+end

data/spec/cousin_roman_spec.rb

@@ -0,0 +1,198 @@
+require 'spec_helper'
+
+describe CousinRoman do
+  it 'should have a version number' do
+    CousinRoman::VERSION.should_not be_nil
+  end
+
+  describe 'valid?' do
+    describe 'literals validation' do
+      ASCII = 0.upto(127).map(&:chr)
+      NON_ROMAN_LITERALS = ASCII - CousinRoman::LITERALS
+
+      CousinRoman::LITERALS.each do |l|
+        it "should allow #{l}" do
+          CousinRoman.valid?(l).should be_true
+        end
+      end
+
+      NON_ROMAN_LITERALS.each do |l|
+        it "should not allow #{l}" do
+          CousinRoman.valid?(l).should be_false
+        end
+      end
+
+      it 'should not allow mix of allowed and disallowed literals' do
+        CousinRoman.valid?('MYCXI').should be_false
+      end
+
+      it 'should not allow empty string' do
+        CousinRoman.valid?('').should be_false
+      end
+    end
+
+    describe 'factors validation' do
+      CousinRoman::ONES.keys.each do |factor|
+        1.upto(3).each do |reps|
+          it "should allow #{reps} repetitions of #{factor}" do
+            CousinRoman.valid?(factor*reps).should be_true
+          end
+        end
+
+        it "should not allow more than 3 repetitions of #{factor}" do
+          CousinRoman.valid?(factor*4).should be_false
+        end
+      end
+
+      CousinRoman::FIVES.merge(CousinRoman::SUBTRACTIVE).keys.each do |factor|
+        it "should not allow repetition of #{factor}" do
+          CousinRoman.valid?(factor*2).should be_false
+        end
+      end
+
+      it 'should allow ones and fives of the same power' do
+        CousinRoman::FIVES.keys.each_with_index do |five, index|
+          1.upto(3).each do |reps|
+            corresponding_one = CousinRoman::ONES.keys[index]
+            CousinRoman.valid?(five + (corresponding_one * reps)).should be_true
+          end
+        end
+      end
+
+      it 'should not allow subtractives and ones or fives of the same power' do
+        CousinRoman.valid?('ivi').should be_false
+        CousinRoman.valid?('ixi').should be_false
+        CousinRoman.valid?('xlx').should be_false
+        CousinRoman.valid?('xcx').should be_false
+        CousinRoman.valid?('cdc').should be_false
+        CousinRoman.valid?('cmc').should be_false
+
+        CousinRoman.valid?('ivv').should be_false
+        CousinRoman.valid?('ixv').should be_false
+        CousinRoman.valid?('xll').should be_false
+        CousinRoman.valid?('xcl').should be_false
+        CousinRoman.valid?('cdd').should be_false
+        CousinRoman.valid?('cmd').should be_false
+      end
+    end
+
+    describe 'ordering validation' do
+      context 'when validating that factors are ordered by descreasing of power' do
+        ORDERINGS_RIGHT = [
+          'md', 'mc',
+          'cl', 'cx',
+          'xv', 'xi',
+          'mcm', 'mcd',
+          'cxc', 'cxl',
+          'xix', 'xiv'
+        ]
+        ORDERINGS_WRONG = [
+          'dm', 'lc', 'vx',
+          'cmm', 'cdm',
+          'xcc', 'xlc',
+          'ixx', 'ivx'
+        ]
+
+        ORDERINGS_RIGHT.each do |pair|
+          high, low = pair.split('', 2)
+          it "should allow #{high}#{low}" do
+            CousinRoman.valid?(high + low).should be_true
+          end
+        end
+
+        ORDERINGS_WRONG.each do |pair|
+          low, high = pair.split('', 2)
+          it "should not allow #{low}#{high}" do
+            CousinRoman.valid?(low + high).should be_false
+          end
+        end
+      end
+    end
+  end
+
+  describe 'convert' do
+    context 'singular factors' do
+      CousinRoman::FACTORS.each do |factor, number|
+        it "should convert #{factor} to #{number}" do
+          CousinRoman.convert(factor).should == number
+        end
+      end
+    end
+
+    context 'repetitive factors' do
+      CousinRoman::ONES.each do |factor, number|
+        1.upto(3).each do |reps|
+          it "should convert #{factor*reps} to #{number*reps}" do
+            CousinRoman.convert(factor*reps).should == (number*reps)
+          end
+        end
+      end
+    end
+
+    context 'different power factors' do
+      it 'should honor ones' do
+        CousinRoman.convert('mcxi').should == 1111
+      end
+
+      it 'should honor fives' do
+        CousinRoman.convert('dlv').should == 555
+      end
+
+      it 'should honor ones and fives together' do
+        CousinRoman.convert('mdclxvi').should == 1666
+      end
+
+      it 'should honor subtractives ones and fives together' do
+        CousinRoman.convert('mcmlxxxix').should == 1989
+      end
+
+      it 'should honor max number' do
+        CousinRoman.convert('mmmcmxcix').should == 3999
+      end
+
+      it 'should honor the longest number' do
+        CousinRoman.convert('dccclxxxviii').should == 888
+      end
+
+      it 'should be case insensitive' do
+        number = 'MCXI'
+        CousinRoman.convert(number).should == CousinRoman.convert(number.downcase)
+      end
+    end
+  end
+
+  describe 'to_arabic' do
+    it 'should call convert on valid number' do
+      CousinRoman.should_receive(:convert).and_call_original
+      CousinRoman.to_arabic('MMM').should == 3000
+    end
+
+    it 'should return nil on invalid number' do
+      CousinRoman.to_arabic('YRU?!').should be_nil
+    end
+  end
+
+  describe 'to_arabic!' do
+    it 'should call convert on valid number' do
+      CousinRoman.should_receive(:convert).and_call_original
+      CousinRoman.to_arabic!('MMM').should == 3000
+    end
+
+    it 'should throw TypeError on invalid number' do
+      expect { CousinRoman.to_arabic!('YRU?!') }.to raise_error(TypeError)
+    end
+  end
+
+end
+
+describe String do
+  [:to_arabic, :to_arabic!].each do |meth|
+    it { should respond_to(meth) }
+
+    it "should call CousinRoman.#{meth} on String##{meth}" do
+      roman = 'i'
+      CousinRoman.should_receive(meth).with(roman).and_call_original
+      roman.send(meth).should == 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'cousin_roman'

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: cousin_roman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Artem Pyanykh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: String extension adding capaibility to convert Roman number to Integers.
+email:
+- artem.pyanykh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cousin_roman.gemspec
+- lib/cousin_roman.rb
+- lib/cousin_roman/conversion.rb
+- lib/cousin_roman/string_extension.rb
+- lib/cousin_roman/version.rb
+- spec/cousin_roman_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ArtemPyanykh/cousin_roman
+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.1.8
+signing_key: 
+specification_version: 4
+summary: Conversion from Roman numbers to Arabic ones.
+test_files:
+- spec/cousin_roman_spec.rb
+- spec/spec_helper.rb