r0man 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3d625173dbf2878b775db385206b85b9f03f01b
+  data.tar.gz: 8bea85375e13253f610df0e60f31023f11cda892
+SHA512:
+  metadata.gz: 79369ace5caff10c9c8b50cc7183b49570bfa8ed995f6b3c029b8fe806548ab3fdd239c40bbe46ed4f8e3fa22515ff57d119738d074a4a69ee535cfc445f1e82
+  data.tar.gz: 867762df91fc7aecc7662c260dd1b03b82ed90c4598e1f365f8143524174e9a1ea4dd590dc37bcd9a8460b432490abd8afe1471a9d2bfece91d6b951207926b8

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chirantan Mitra
+
+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/lib/r0man.rb

@@ -0,0 +1,3 @@
+require "r0man/digit"
+require "r0man/maximum_consecutive_count"
+require "r0man/number"

data/lib/r0man/digit.rb

@@ -0,0 +1,68 @@
+module R0man
+  class Digit
+    attr_reader :value, :name, :max_consecutive_allowed, :allowed_next_digits
+
+    def initialize(options)
+      @value                   = options[:value]
+      @name                    = options[:name]
+      @max_consecutive_allowed = options[:max_consecutive_allowed]
+      @allowed_next_digits     = options[:allowed_next_digits]
+    end
+
+    def valid?
+      true
+    end
+
+    def to_s
+      "#{name}(#{value})"
+    end
+
+    def inspect
+      to_s
+    end
+
+    def greater_than?(other_digit)
+      value > other_digit.value
+    end
+
+    def value_compared_to(other_digit)
+      other_digit.greater_than?(self) ? -value : value
+    end
+
+    def allows_next_digit?(other_digit)
+      allowed_next_digits.include?(other_digit)
+    end
+
+    M = new(name: "M", value: 1000, max_consecutive_allowed: 3, allowed_next_digits: [])
+    D = new(name: "D", value: 500, max_consecutive_allowed: 1, allowed_next_digits: [])
+    C = new(name: "C", value: 100, max_consecutive_allowed: 3, allowed_next_digits: [M, D])
+    L = new(name: "L", value: 50, max_consecutive_allowed: 1, allowed_next_digits: [])
+    X = new(name: "X", value: 10, max_consecutive_allowed: 3, allowed_next_digits: [C, L])
+    V = new(name: "V", value: 5, max_consecutive_allowed: 1, allowed_next_digits: [])
+    I = new(name: "I", value: 1, max_consecutive_allowed: 3, allowed_next_digits: [X, V])
+
+    LOOKUP = {
+      "I" => I,
+      "V" => V,
+      "X" => X,
+      "L" => L,
+      "C" => C,
+      "D" => D,
+      "M" => M,
+    }
+
+    Invalid = Struct.new(:name) do
+      def valid?
+        false
+      end
+    end
+
+    class << self
+      protected :new
+
+      def parse(letter)
+        LOOKUP[letter.upcase] || Invalid.new(letter)
+      end
+    end
+  end
+end

data/lib/r0man/maximum_consecutive_count.rb

@@ -0,0 +1,25 @@
+module R0man
+  class MaximumConsecutiveCount
+    class << self
+      def for(array)
+        MaximumConsecutiveCount.new.for(array)
+      end
+    end
+
+    def for(array)
+      counts = Hash.new(0)
+      current_count = 1
+
+      (array + [Float::NAN]).each_cons(2) do |item, next_item|
+        if item == next_item
+          current_count += 1
+        else
+          current_count = 1
+        end
+        counts[item] = current_count if current_count > counts[item]
+      end
+
+      counts
+    end
+  end
+end

data/lib/r0man/number.rb

@@ -0,0 +1,52 @@
+require "simple_validation"
+
+module R0man
+  class Number
+    include SimpleValidation
+
+    validate :digits_are_valid
+    validate :maximum_consecutive_counts_are_inside_limits
+    validate :previous_digit_are_allowed
+    validate :same_digit_is_not_added_to_and_subtracted_from_a_larger_digit
+
+    class << self
+      def parse(str)
+        new(str)
+      end
+    end
+
+    def initialize(str)
+      digits = str.each_char.map { |d| Digit.parse(d) }
+      @valid, @invalid = digits.partition(&:valid?)
+    end
+
+    def value
+      @value ||= @valid.each_cons(2).reduce(0) { |result, (d1, d2)| result += d1.value_compared_to(d2) } + @valid.last.value
+    end
+
+    private
+
+    def digits_are_valid
+      add_error("Number contains invalid characters: #{@invalid.map(&:name).join(", ")}") unless @invalid.empty?
+    end
+
+    def maximum_consecutive_counts_are_inside_limits
+      MaximumConsecutiveCount.for(@valid).each do |digit, count|
+        tolerance = digit.max_consecutive_allowed
+        add_error("#{digit} occurs #{count} times whereas it is allowed only #{tolerance} times") if count > tolerance
+      end
+    end
+
+    def previous_digit_are_allowed
+      @valid.each_cons(2) do |d1, d2|
+        add_error("#{d1} cannot be subtracted from #{d2}") if (!d1.allows_next_digit?(d2) && d2.greater_than?(d1))
+      end
+    end
+
+    def same_digit_is_not_added_to_and_subtracted_from_a_larger_digit
+      @valid.each_cons(3) do |d1, d2, d3|
+        add_error("#{d1} cannot be added to and subtracted from #{d2}") if (d1 == d3 && d2.greater_than?(d1))
+      end
+    end
+  end
+end

data/lib/r0man/version.rb

@@ -0,0 +1,3 @@
+module R0man
+  VERSION = "0.1.0"
+end

data/spec/r0man/digit_spec.rb

@@ -0,0 +1,85 @@
+require_relative "../spec_helper"
+
+require_relative "../../lib/r0man/digit"
+
+describe "Roman digit" do
+  it "has a value" do
+    R0man::Digit::X.value.must_equal 10
+  end
+
+  it "has a name" do
+    R0man::Digit::X.name.must_equal 'X'
+  end
+
+  it "is valid" do
+    R0man::Digit::X.must_be :valid?
+  end
+
+  it "equals itself" do
+    R0man::Digit::X.must_equal R0man::Digit::X
+  end
+
+  it "has a string representation" do
+    R0man::Digit::X.to_s.must_equal "X(10)"
+  end
+
+  it "is inspectable" do
+    R0man::Digit::X.inspect.must_equal "X(10)"
+  end
+
+  describe "when compared to a smaller digit" do
+    it "has a positive value" do
+      R0man::Digit::X.value_compared_to(R0man::Digit::V).must_equal 10
+    end
+
+    it "knows that it is greater than the smaller digit" do
+      R0man::Digit::X.greater_than?(R0man::Digit::V).must_equal true
+    end
+  end
+
+  describe "when compared to itself" do
+    it "has a positive value" do
+      R0man::Digit::X.value_compared_to(R0man::Digit::X).must_equal 10
+    end
+
+    it "knows that it doesn't exceed itself" do
+      R0man::Digit::X.greater_than?(R0man::Digit::X).must_equal false
+    end
+  end
+
+  describe "when compared to a larger digit" do
+    it "has a positive value" do
+      R0man::Digit::X.value_compared_to(R0man::Digit::L).must_equal -10
+    end
+
+    it "knows that it not greater than the larger digit" do
+      R0man::Digit::X.greater_than?(R0man::Digit::L).must_equal false
+    end
+  end
+
+  describe ".parse" do
+    describe "for a known lower-case letter" do
+      it "converts it to the corresponding digit" do
+        R0man::Digit.parse("i").must_equal R0man::Digit::I
+      end
+    end
+
+    describe "for a known upper-case letter" do
+      it "converts it to the corresponding digit" do
+        R0man::Digit.parse("X").must_equal R0man::Digit::X
+      end
+    end
+
+    describe "for an unknown letter" do
+      let(:invalid) { R0man::Digit.parse("g") }
+
+      it "converts it to an unidentified digit with a name" do
+        invalid.name.must_equal "g"
+      end
+
+      it "is invalid" do
+        invalid.wont_be :valid?
+      end
+    end
+  end
+end

data/spec/r0man/maximum_consecutive_count_spec.rb

@@ -0,0 +1,35 @@
+require_relative "../spec_helper"
+
+require_relative "../../lib/r0man/maximum_consecutive_count"
+
+describe "Maximum consecutive count" do
+  describe "for an empty array" do
+    it "is nothing" do
+      R0man::MaximumConsecutiveCount.for([]).must_equal({})
+    end
+  end
+
+  describe "for a single non-repeated element" do
+    it "is one" do
+      R0man::MaximumConsecutiveCount.for([10]).must_equal({10 => 1})
+    end
+  end
+
+  describe "for a single repeated element" do
+    it "is the number of repeations" do
+      R0man::MaximumConsecutiveCount.for([10, 10, 10]).must_equal({10 => 3})
+    end
+  end
+
+  describe "for an array with kinds of items" do
+    it "is the number of repeations for each item" do
+      R0man::MaximumConsecutiveCount.for([10, 10, 5]).must_equal({10 => 2, 5 => 1})
+    end
+  end
+
+  describe "for an array with one type followed by another type followed by first type" do
+    it "is the count of maximum number of elements in a single stretch" do
+      R0man::MaximumConsecutiveCount.for([10, 5, 10, 10]).must_equal({10 => 2, 5 => 1})
+    end
+  end
+end

data/spec/r0man/number_spec.rb

@@ -0,0 +1,65 @@
+require_relative "../spec_helper"
+
+require_relative "../../lib/r0man/digit"
+require_relative "../../lib/r0man/number"
+require_relative "../../lib/r0man/maximum_consecutive_count"
+
+describe "Roman number" do
+  describe ".parse" do
+    describe "when all values are same" do
+      let(:number) { R0man::Number.parse("III") }
+
+      it "is the sum of the values" do
+        number.value.must_equal 3
+      end
+    end
+
+    describe "when a smaller digit follows a larger digit" do
+      let(:number) { R0man::Number.parse("VI") }
+
+      it "is the sum of the values" do
+        number.value.must_equal 6
+      end
+    end
+
+    describe "when a smaller digit preceeds a larger digit" do
+      let(:number) { R0man::Number.parse("IV") }
+
+      it "the value of the smaller digit is subtracted" do
+        number.value.must_equal 4
+      end
+    end
+
+    describe "when a smaller digit is between larger digits" do
+      let(:number) { R0man::Number.parse("VIV") }
+
+      it "the value of the smaller digit is subtracted from the sum of the larger digits" do
+        number.value.must_equal 9
+      end
+    end
+
+    describe "when all letters are known" do
+      let(:number) { R0man::Number.parse("IV") }
+
+      it "creates a roman number out of them" do
+        number.value.must_equal 4
+      end
+
+      it "has no errors" do
+        number.errors.must_be_empty
+      end
+    end
+
+    describe "when some letters are unknown" do
+      let(:number) { R0man::Number.parse("ISVG") }
+
+      it "creates a roman number out of the identified letters" do
+        number.value.must_equal 4
+      end
+
+      it "has errors" do
+        number.errors.must_equal ["Number contains invalid characters: S, G"]
+      end
+    end
+  end
+end

data/spec/r0man/number_validity_spec.rb

@@ -0,0 +1,79 @@
+require_relative "../spec_helper"
+
+require_relative "../../lib/r0man/digit"
+require_relative "../../lib/r0man/number"
+require_relative "../../lib/r0man/maximum_consecutive_count"
+
+describe "Roman number" do
+  describe "when a number has three consecutive I" do
+    let(:number) { R0man::Number.parse("III") }
+
+    it "has no errors" do
+      number.errors.must_be_empty
+    end
+  end
+
+  describe "when a number has one V" do
+    let(:number) { R0man::Number.parse("V") }
+
+    it "has no errors" do
+      number.errors.must_be_empty
+    end
+  end
+
+  describe "when in a number has four consecutive I" do
+    let(:number) { R0man::Number.parse("IIII") }
+
+    it "has errors" do
+      number.errors.must_equal ["I(1) occurs 4 times whereas it is allowed only 3 times"]
+    end
+  end
+
+  describe "when a number has two consecutive V" do
+    let(:number) { R0man::Number.parse("VV") }
+
+    it "has errors" do
+      number.errors.must_equal ["V(5) occurs 2 times whereas it is allowed only 1 times"]
+    end
+  end
+
+  describe "when I comes before V" do
+    let(:number) { R0man::Number.parse("IV") }
+
+    it "has no errors" do
+      number.errors.must_be_empty
+    end
+  end
+
+  describe "when I comes before X" do
+    let(:number) { R0man::Number.parse("IX") }
+
+    it "has no errors" do
+      number.errors.must_be_empty
+    end
+  end
+
+  describe "when L is between X and I" do
+    let(:number) { R0man::Number.parse("XLI") }
+
+    it "has no errors" do
+      number.errors.must_be_empty
+    end
+  end
+
+  describe "when I comes before L" do
+    let(:number) { R0man::Number.parse("IL") }
+
+    it "has errors" do
+      number.errors.must_equal ["I(1) cannot be subtracted from L(50)"]
+    end
+  end
+
+  describe "when same digit is added to and subtracted from a bigger digit" do
+    let(:number) { R0man::Number.parse("IXI") }
+
+    it "has errors" do
+      number.errors.must_equal ["I(1) cannot be added to and subtracted from X(10)"]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+begin
+  require 'simplecov'
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new [
+    SimpleCov::Formatter::HTMLFormatter
+  ]
+  SimpleCov.start do
+    add_filter '/spec|test|vendor/'
+  end
+rescue LoadError
+  puts "\nPlease install simplecov to generate coverage report!\n\n"
+end
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/reporters'
+
+MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: r0man
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chirantan Mitra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simple_validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: minitest
+  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: minitest-reporters
+  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: simplecov
+  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: rubocop
+  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: yard
+  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: Convert Roman numbers to Indian
+email:
+- chirantan.mitra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/r0man.rb
+- lib/r0man/digit.rb
+- lib/r0man/maximum_consecutive_count.rb
+- lib/r0man/number.rb
+- lib/r0man/version.rb
+- spec/r0man/digit_spec.rb
+- spec/r0man/maximum_consecutive_count_spec.rb
+- spec/r0man/number_spec.rb
+- spec/r0man/number_validity_spec.rb
+- spec/spec_helper.rb
+homepage: 
+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: roman
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Roman number conversions
+test_files:
+- spec/r0man/digit_spec.rb
+- spec/r0man/number_validity_spec.rb
+- spec/r0man/number_spec.rb
+- spec/r0man/maximum_consecutive_count_spec.rb
+- spec/spec_helper.rb
+has_rdoc: