to_decimal 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 536d4add05473007155d6508a38be3c2edc844c8b2ca055c284d66b610156218
-  data.tar.gz: 99c02b0b97440add3b06f8b3e81e4c3695bb3dff8725cce9e89ebed2caf1cc3c
+SHA1:
+  metadata.gz: 7cd86aa616511538aaaaee26a042ed3682234c60
+  data.tar.gz: d42d619ea1b91d3db07b1149ee0347915590ab31
 SHA512:
-  metadata.gz: 9d3c17dd84adcdfd27018bf9c39a57f716e67a925ba92af4520b7872d816dea34075258bee82478ee1e28ef63e1ad941629640bda53cde12d176568cb7eb6014
-  data.tar.gz: 8ee66486d089201851a3dcd2502cdd2ffc26685a6bccbc69e7dcff294c150615dbe561306a82225f56fbdc369233ab6a19eb3b2a40278230e0da1b2e69796bd6
+  metadata.gz: 0fa9c5ec9e5f10c990f66736e6e554412fe1e9d56ecff0a2e6983075a7ad017666222aaf8fcb50b6811913887b9ed6738fef730fc71068031b3b556cf27d1b61
+  data.tar.gz: 62318b811a0ad64d97db076e273599d62742ebd300047851a0c0515462b9bea58d6782cadea72b12858b184f23b35456ea7708c32248b859d9796e81f3471d0f

data/CHANGELOG.md

@@ -1,7 +1,19 @@
-# to_decimal 0.0.3 (2018-11-27)
+# to_decimal 1.0.1 (2019-03-16)
 ---
 
-**Breaking changes !!!** 
+- update required ruby version to 2.4.5 due to security fix
+- update the required versions of:
+  - rake (12.3.2)
+- add development dependencies:
+  - rubocop (0.65.0)
+  - pry (0.12.2)
+  - minitest (5.11)
+  - minitest-reporters (1.3.6)
+- Fix some style issues in the code
+
+# to_decimal 1.0.0 (2018-11-27)
+---
+**Breaking changes !** 
 
 - Provides a namespace `ToDecimal` to the gem
 - Renames the main class from `ToDecimal` to `Convertor`

data/Gemfile

@@ -1,7 +1,15 @@
 source 'https://rubygems.org'
 
-ruby '~> 2.4.1'
+ruby '~> 2.4.5'
 
-gem 'minitest'
-gem 'minitest-reporters', '~> 1.1'
-gem 'rake'
+source 'https://rubygems.org'
+
+gem 'bundler', '~> 2.0', '>= 2.0.1'
+gem 'rake', '~> 12.3', '>= 12.3.2'
+
+group :development do
+  gem 'minitest', '~> 5.11', '>= 5.11.3'
+  gem 'minitest-reporters', '~> 1.3', '>= 1.3.6'
+  gem 'pry', '~> 0.12.2'
+  gem 'rubocop', '~> 0.65.0'
+end

data/Gemfile.lock

@@ -2,26 +2,52 @@ GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
+    ast (2.4.0)
     builder (3.2.3)
+    coderay (1.1.2)
+    jaro_winkler (1.5.2)
+    method_source (0.9.2)
     minitest (5.11.3)
-    minitest-reporters (1.1.19)
+    minitest-reporters (1.3.6)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    rake (12.3.0)
-    ruby-progressbar (1.9.0)
+    parallel (1.14.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rubocop (0.65.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  minitest
-  minitest-reporters (~> 1.1)
-  rake
+  bundler (~> 2.0.1)
+  minitest (~> 5.11, >= 5.11.3)
+  minitest-reporters (~> 1.3, >= 1.3.6)
+  pry (~> 0.12.2)
+  rake (~> 12.3, >= 12.3.2)
+  rubocop (~> 0.65.0)
 
 RUBY VERSION
-   ruby 2.5.1p57
+   ruby 2.4.5p335
 
 BUNDLED WITH
-   1.16.1
+   2.0.1

data/README.md

@@ -66,12 +66,10 @@ This project is tested under minitest.
 
 # Usage
 
-### Instance methods
-
 The gem gives you access to 9 objects under the namespace `ToDecimal` called :
 `Base2`, `Base3`,... `Base10`.
 
-Each object has a `[]` instance method, which takes as parameter an integer OR a string
+Each object has a `[]` method, which takes as parameter an integer OR a string
 representation of the corresponding base and returns this integer expressed
 in base 10 :
 

data/lib/to_decimal.rb

@@ -1,3 +1,7 @@
+require 'bundler'
+require 'bundler/setup'
+Bundler.require(:default, :development)
+
 require_relative 'to_decimal/validator_class'
 require_relative 'to_decimal/convertor_class'
 require_relative 'to_decimal/wrong_base_input_error'
@@ -13,6 +17,7 @@ module ToDecimal
   Base9 = Convertor.new(9)
   Base10 = Convertor.new(10)
 
+  # Ensure no other convertor object will be created
   class Convertor
     class << self
       private :new

data/lib/to_decimal/convertor_class.rb

@@ -1,17 +1,18 @@
 module ToDecimal
+  # The main class that performs the actual conversion
   class Convertor
     attr_reader :base
 
     def initialize(base)
       validate_base(base)
       @base = base
-      self.freeze
+      freeze
     end
 
     def [](input)
       input = remove_leading_zeros_of(input)
       Validator.new(input, base).validate
-      
+
       input_as_integer = integerize(input)
       convert(input_as_integer)
     end
@@ -31,8 +32,9 @@ module ToDecimal
     end
 
     def validate_base(base)
-      raise ArgumentError, "Base must be an Integer" unless base.is_a?(Integer)
-      raise ArgumentError, "Base must be 1..10" unless base > 0 && base <= 10
+      raise ArgumentError, 'Base must be an Integer' unless base.is_a?(Integer)
+      raise ArgumentError, 'Base must be 1..10' unless \
+        base.positive? && base <= 10
     end
   end
 end

data/lib/to_decimal/validator_class.rb

@@ -1,4 +1,5 @@
 module ToDecimal
+  # Class to validate arguments
   class Validator
     def initialize(input, base)
       @input = input
@@ -6,17 +7,27 @@ module ToDecimal
     end
 
     def validate
-      raise ArgumentError, "Argument must be an integer or a valid string\
- representation of an integer. You input : #{@input}" unless valid_integer_string_or_integer?
-      
-      raise WrongBaseInputError, "A number of base #{@base} cannot have a digit\
- greater or equal to #{@base}. Check your argument: #{@input}" unless valid_input_base?
+      err_value = "Argument must be an integer or a valid string\
+ representation of an integer. You input : #{@input}, of class #{@input.class}."
+      raise ArgumentError,  err_value unless valid_integer_string_or_integer?
+
+      err_base = "A number of base #{@base} cannot have a\
+  digit greater or equal to #{@base}. Check your argument: #{@input}."
+      raise WrongBaseInputError, err_base unless valid_input_base?
     end
 
     private
 
     def valid_integer_string_or_integer?
-       @input.is_a?(Integer) || (@input.is_a?(String) && @input.to_i.to_s == @input)
+      valid_integer_string? || valid_integer?
+    end
+
+    def valid_integer?
+      @input.is_a?(Integer)
+    end
+
+    def valid_integer_string?
+      (@input.is_a?(String) && @input.to_i.to_s == @input)
     end
 
     def valid_input_base?
@@ -24,4 +35,4 @@ module ToDecimal
       digitized_input.none? { |digit| digit >= @base }
     end
   end
-end
+end

data/test/to_decimal_test.rb

@@ -4,18 +4,10 @@ Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
 
 require_relative '../lib/to_decimal'
 
-# ========== Test helper method ================================================
-
-def execute_test_with(test_values, base_convertor)
-  test_values.each do |data_set|
-    assert_equal data_set[1], base_convertor[data_set[0]] 
-  end
-end
-
 class ToDecimalBaseValidationTest < Minitest::Test
 
-# ======== Testing error is raises if input is not of the correct base =========
-  
+  # ======== Testing error is raised if input is not of the correct base =======
+
   def test_raises_error_if_input_is_not_from_base_2
     base2 = ToDecimal::Base2
     assert_raises(ToDecimal::WrongBaseInputError) { base2[2] }
@@ -64,20 +56,30 @@ class ToDecimalBaseValidationTest < Minitest::Test
   end
 end
 
-# ========= Testing return values of [] instance method ========================
+# ========= Testing return values of [] method =================================
+
+# ========= Test helper method
+
+def execute_test_with(test_values, base_convertor)
+  test_values.each do |data_set|
+    assert_equal data_set[1], base_convertor[data_set[0]]
+  end
+end
+
+# ========= Test class
 
 class ToDecimalConvserionFromIntegerTest < Minitest::Test
 
   # Test data
-  TEST_VALUES_BASE_2 = [[101, 5], [100_000_000, 256]]
-  TEST_VALUES_BASE_3 = [[1122111, 1201], [12, 5]]
-  TEST_VALUES_BASE_4 = [[11001, 321], [322, 58]]
-  TEST_VALUES_BASE_5 = [[14, 9], [10011302, 78952]]
-  TEST_VALUES_BASE_6 = [[13, 9], [1405304, 78952]]
-  TEST_VALUES_BASE_7 = [[12, 9], [446116, 78952]]
-  TEST_VALUES_BASE_8 = [[11, 9], [232150, 78952]]
-  TEST_VALUES_BASE_9 = [[10, 9], [130264, 78952]]
-  TEST_VALUES_BASE_10 = [[9, 9], [78952, 78952]]
+  TEST_VALUES_BASE_2 = [[101, 5], [100_000_000, 256]].freeze
+  TEST_VALUES_BASE_3 = [[1_122_111, 1201], [12, 5]].freeze
+  TEST_VALUES_BASE_4 = [[11_001, 321], [322, 58]].freeze
+  TEST_VALUES_BASE_5 = [[14, 9], [10_011_302, 78_952]].freeze
+  TEST_VALUES_BASE_6 = [[13, 9], [1_405_304, 78_952]].freeze
+  TEST_VALUES_BASE_7 = [[12, 9], [446_116, 78_952]].freeze
+  TEST_VALUES_BASE_8 = [[11, 9], [232_150, 78_952]].freeze
+  TEST_VALUES_BASE_9 = [[10, 9], [130_264, 78_952]].freeze
+  TEST_VALUES_BASE_10 = [[9, 9], [78_952, 78_952]].freeze
 
   def test_returns_decimal_value_of_integer_of_base_2
     execute_test_with(TEST_VALUES_BASE_2, ToDecimal::Base2)
@@ -117,15 +119,15 @@ class ToDecimalConvserionFromIntegerTest < Minitest::Test
 end
 
 class ToDecimalConvserionFromStringTest < Minitest::Test
-  TEST_VALUES_BASE_2 = [['101', 5], ['100000000', 256]]
-  TEST_VALUES_BASE_3 = [['1122111', 1201], ['12', 5]]
-  TEST_VALUES_BASE_4 = [['11001', 321], ['322', 58]]
-  TEST_VALUES_BASE_5 = [['14', 9], ['10011302', 78952]]
-  TEST_VALUES_BASE_6 = [['13', 9], ['1405304', 78952]]
-  TEST_VALUES_BASE_7 = [['12', 9], ['446116', 78952]]
-  TEST_VALUES_BASE_8 = [['11', 9], ['232150', 78952]]
-  TEST_VALUES_BASE_9 = [['10', 9], ['130264', 78952]]
-  TEST_VALUES_BASE_10 = [['9', 9], ['78952', 78952]]
+  TEST_VALUES_BASE_2 = [['101', 5], ['100000000', 256]].freeze
+  TEST_VALUES_BASE_3 = [['1122111', 1_201], ['12', 5]].freeze
+  TEST_VALUES_BASE_4 = [['11001', 321], ['322', 58]].freeze
+  TEST_VALUES_BASE_5 = [['14', 9], ['10011302', 78_952]].freeze
+  TEST_VALUES_BASE_6 = [['13', 9], ['1405304', 78_952]].freeze
+  TEST_VALUES_BASE_7 = [['12', 9], ['446116', 78_952]].freeze
+  TEST_VALUES_BASE_8 = [['11', 9], ['232150', 78_952]].freeze
+  TEST_VALUES_BASE_9 = [['10', 9], ['130264', 78_952]].freeze
+  TEST_VALUES_BASE_10 = [['9', 9], ['78952', 78_952]].freeze
 
   def test_returns_decimal_value_of_string_of_base_2
     execute_test_with(TEST_VALUES_BASE_2, ToDecimal::Base2)
@@ -165,15 +167,15 @@ class ToDecimalConvserionFromStringTest < Minitest::Test
 end
 
 class RemoveLeadingZeroesFromStringsTest < Minitest::Test
-  TEST_VALUES_BASE_2 = [['00101', 5], ['0100000000', 256]]
-  TEST_VALUES_BASE_3 = [['001122111', 1201], ['012', 5]]
-  TEST_VALUES_BASE_4 = [['0011001', 321], ['322', 58]]
-  TEST_VALUES_BASE_5 = [['0014', 9], ['010011302', 78952]]
-  TEST_VALUES_BASE_6 = [['0013', 9], ['01405304', 78952]]
-  TEST_VALUES_BASE_7 = [['0012', 9], ['0446116', 78952]]
-  TEST_VALUES_BASE_8 = [['0011', 9], ['0232150', 78952]]
-  TEST_VALUES_BASE_9 = [['0010', 9], ['0130264', 78952]]
-  TEST_VALUES_BASE_10 = [['009', 9], ['078952', 78952]]
+  TEST_VALUES_BASE_2 = [['00101', 5], ['0100000000', 256]].freeze
+  TEST_VALUES_BASE_3 = [['001122111', 1_201], ['012', 5]].freeze
+  TEST_VALUES_BASE_4 = [['0011001', 321], ['322', 58]].freeze
+  TEST_VALUES_BASE_5 = [['0014', 9], ['010011302', 78_952]].freeze
+  TEST_VALUES_BASE_6 = [['0013', 9], ['01405304', 78_952]].freeze
+  TEST_VALUES_BASE_7 = [['0012', 9], ['0446116', 78_952]].freeze
+  TEST_VALUES_BASE_8 = [['0011', 9], ['0232150', 78_952]].freeze
+  TEST_VALUES_BASE_9 = [['0010', 9], ['0130264', 78_952]].freeze
+  TEST_VALUES_BASE_10 = [['009', 9], ['078952', 78_952]].freeze
 
   def test_removes_leading_zeros_from_string_with_base2
     execute_test_with(TEST_VALUES_BASE_2, ToDecimal::Base2)
@@ -216,4 +218,4 @@ class ConvertorCannotBeInstantiatedTest < Minitest::Test
   def test_raises_error_if_user_tries_to_instantiate_new_convertor
     assert_raises(NoMethodError) { ToDecimal::Convertor.new }
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: to_decimal
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Laurent Guinotte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2019-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +72,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.65.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.65.0
 description: |
   Provides a simple way to convert an integer expressed in bases
   2 up to 10 to a decimal integer
@@ -99,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.1
+      version: 2.4.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -107,8 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
-summary: A simple integer converter from bases 2..10 to decimal integers
+summary: A small gem to convert integers from bases 2..10 to decimal integers
 test_files: []