romanic 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 profh
+
+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,47 @@
+# Romanic
+==========
+This is a simple gem written as a class demonstration that converts integers to roman numerals and roman numerals to integers.  It adds methods to the Integer and String classes that allow a user to send a 'roman' message to either of these types of objects and get an appropriate response. More details on how to use the gem can be found below.
+
+
+Installation
+------------
+Installing this gem is pretty simple -- just type on the command line:
+
+```  
+$ gem install romanic 
+```
+
+And add this gem into any other code with:
+
+```  
+require 'rubygems'
+require 'romanic' 
+```
+
+
+Usage
+------------
+There are basically two methods to this gem:
+
+* to_roman
+* from_roman
+
+**to_roman** -- This method simply allows an integer to be converted to its equivalent roman numeral.  Because of limitations in the roman numeral system, the integer must be positive (i.e., greater than zero) and less than 5,000. If the integer is not within these bounds, then the method will return nil.
+
+**from_roman** -- This method looks at a string and if it is a reasonably valid roman numeral (i.e., limited to the 7 upper-case characters used in roman numerals and follows general rules) then it will convert it to its integer equivalent.  If the string is considered non-romanic, it will return nil.
+
+
+### Note on usage ###
+
+This gem has a set of basic unit tests associated with it.  The tests provide other examples of what is possible using this methods and may help the user further understand how this gem can be applied.  The testing suite requires the minitest gem to run properly.
+
+Also note that this gem does not allow for lower-case roman numerals. Such lower-case numerals are used in outlines and publishing, but as far as I can tell (not professing expertise here) actual roman numerals are all upper-case.
+
+
+Contributing
+------------
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/romanic.rb

@@ -0,0 +1,7 @@
+# Provided by bundler to track the version
+require "romanic/version"
+
+# Our code broken into submodules
+require "romanic/base"
+require "romanic/romanic_integers"
+require "romanic/romanic_strings"

data/lib/romanic/base.rb

@@ -0,0 +1,13 @@
+module Romanic
+  extend self
+  
+  # some initial setup is necessary...
+  IS_ROMAN = /^(?=.)M*(D?C{0,3}|C[DM])(L?X{0,3}|X[LC])(V?I{0,3}|I[VX])$/
+
+  NUMERAL_ARABIC = [  1000, 900, 500, 400, 100, 90, 50, 40, 10, 9, 5, 4, 1]
+  NUMERAL_ROMANS = %w(M     CM   D    CD   C    XC  L   XL   X IX  V IV  I)
+
+  # Create my lookup array from previous two with zip()
+  ROMAN_LOOKUP = NUMERAL_ROMANS.zip(NUMERAL_ARABIC)
+  
+end

data/lib/romanic/romanic_integers.rb

@@ -0,0 +1,19 @@
+module Romanic
+  module RomanicIntegers
+    # Convert integers to roman numerals
+    def to_roman
+      number = self
+      return nil unless number.class == Fixnum
+      return nil unless number > 0 and number < 5000
+      ROMAN_LOOKUP.inject("") do |result, (roman, arabic)|
+        # divmod() returns array of quotient and modulus
+        count, number = number.divmod(arabic)
+        result << (roman * count)
+        result
+      end
+    end
+  end
+end
+
+# Add methods to the Integer class
+Integer.send :include, Romanic::RomanicIntegers

data/lib/romanic/romanic_strings.rb

@@ -0,0 +1,19 @@
+module Romanic
+  module RomanicStrings
+    # Convert roman numerals to integers
+    def from_roman
+      string = self
+      return nil unless string.to_s.match(IS_ROMAN)
+      ROMAN_LOOKUP.inject(0) do |result, (roman, arabic)|
+        while string.index(roman) == 0
+          result += arabic
+          string.slice!(roman)
+        end
+        result
+      end
+    end
+  end
+end
+
+# Add methods to the String class
+String.send :include, Romanic::RomanicStrings

data/lib/romanic/version.rb

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

data/romanic.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/romanic/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Klingon Code Warrior"]
+  gem.email         = ["profh@cmu.edu"]
+  gem.description   = %q{Converts strings and integers to and from roman numerals}
+  gem.summary       = %q{This gem adds a method to the Integer class called to_roman, which converts an integer between 1 and 5000 to roman numerals. It also adds a method to String called from_roman which converts roman numerals to integers.}
+  gem.homepage      = "https://github.com/profh/romanic"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "romanic"
+  gem.require_paths = ["lib"]
+  gem.version       = Romanic::VERSION
+end

data/tests/romanic_tests.rb

@@ -0,0 +1,45 @@
+require "romanic"
+require "minitest/autorun"
+
+class TestRoman < MiniTest::Unit::TestCase
+
+  def test_conversion_to_roman_numerals_works
+    assert_equal('I', 1.to_roman)
+    assert_equal('II', 2.to_roman)
+    assert_equal('IV', 4.to_roman)
+    assert_equal('XIV', 14.to_roman)
+    assert_equal('XLIX', 49.to_roman)
+    assert_equal('C', 100.to_roman)
+    assert_equal('MCMXCIX', 1999.to_roman)
+    assert_equal('MMMMCMXCIX', 4999.to_roman)
+  end
+  
+  def test_out_of_bounds_conversions_to_roman_fail
+    assert_equal(nil, 10001.to_roman)
+    assert_equal(nil, 5000.to_roman)
+    assert_equal(nil, 0.to_roman)
+    assert_equal(nil, -3.to_roman)
+  end
+
+  def test_string_conversions_from_roman_works
+    assert_equal(1, 'I'.from_roman)
+    assert_equal(2, 'II'.from_roman)
+    assert_equal(4, 'IV'.from_roman)
+    assert_equal(14, 'XIV'.from_roman)
+    assert_equal(49, 'XLIX'.from_roman)
+    assert_equal(100, 'C'.from_roman)
+    assert_equal(1999, 'MCMXCIX'.from_roman)
+    assert_equal(4999, 'MMMMCMXCIX'.from_roman)
+  end
+  
+  def test_non_roman_strings_fail
+    assert_equal(nil, 'ii'.from_roman)
+    assert_equal(nil, 'LKD'.from_roman)
+    assert_equal(nil, '2010'.from_roman)
+    assert_equal(nil, 'XX!'.from_roman)
+    assert_equal(nil, 'IIII'.from_roman)
+    assert_equal(nil, 'IIIII'.from_roman)
+    assert_equal(nil, 'XIIII'.from_roman)
+  end
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: romanic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Klingon Code Warrior
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-01 00:00:00.000000000 Z
+dependencies: []
+description: Converts strings and integers to and from roman numerals
+email:
+- profh@cmu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/romanic.rb
+- lib/romanic/base.rb
+- lib/romanic/romanic_integers.rb
+- lib/romanic/romanic_strings.rb
+- lib/romanic/version.rb
+- romanic.gemspec
+- tests/romanic_tests.rb
+homepage: https://github.com/profh/romanic
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem adds a method to the Integer class called to_roman, which converts
+  an integer between 1 and 5000 to roman numerals. It also adds a method to String
+  called from_roman which converts roman numerals to integers.
+test_files: []