english_number 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a053e2c56dfe0f64d6f63e9e60719e71293ea963
+  data.tar.gz: 556c5c36185fdc0132ebb64e1aa85f3810fb0223
+SHA512:
+  metadata.gz: e1f7feb9e523690330727b652475f90138805d1b2f4b10ec3a0af600a02f1856eb4ac6dfe92d6f59dcbdf23dd973e11780bb6292b7372ae8cccb82a372fb3ba8
+  data.tar.gz: 6ac17d9095c4df023d5348505e0d1d76abdd01d968c267d13d79b3f87a9a05fa7f78d4a393c76417b132a963e646e2ad6ca819b44b48d81d7653a2531231275b

data/.gitignore

@@ -0,0 +1,3 @@
+.byebug_history
+Gemfile.lock
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+gem 'activesupport'
+
+group :test do
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov', :require => false
+end
+

data/english_number.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = 'english_number'
+  s.version     = '0.0.1'
+  s.date        = '2016-05-13'
+  s.summary     = "Converting English numbers to strings"
+  s.description = "Example: EnglishNumber.new(63).in_english # => 'sixty-three'. 
+                   EnglishNumber objects can be added, subtracted, multiplied, divided."
+  
+  s.authors     = ["Piotr Brych"]
+  s.email       = 'pbrych@gmail.com'
+  s.files       = `git ls-files`.split($/)
+  s.homepage    = 'http://rubygems.org/gems/english-number.rb'
+  
+  s.add_dependency      'activesupport', '~> 4.2.6'
+  s.add_development_dependency      'rspec', '~> 3.4.0'
+  s.add_development_dependency      'simplecov', '~> 0.11.2'
+  
+  s.license       = 'MIT'
+end

data/lib/digits/two_digits.rb

@@ -0,0 +1,44 @@
+require 'modules/compute'
+require 'modules/translate'
+
+class TwoDigits
+  include Compute
+  include Translate
+
+  def self.run(num)
+    new(num).in_words
+  end
+  
+  def in_words
+    less_than_20? ? less_than_20 : more_than_19 
+  end
+  
+  private
+  
+  attr_reader :num
+  
+  def initialize(num)
+    @num = num
+  end
+  
+  def less_than_20?
+    num_abs < 20
+  end
+  
+  def less_than_20 
+    numbers_in_words['tenss'][num_mod]
+  end
+  
+  def more_than_19
+    num_mod.zero? ? simple_tens : complex_tens
+  end
+  
+  def simple_tens
+    numbers_in_words['tens'][num_abs/10]
+  end
+  
+  def complex_tens
+    simple_tens+'-'+numbers_in_words['ones'][num_mod]
+  end
+  
+end

data/lib/english_number.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+require 'active_support/inflector'
+
+require 'digits/two_digits'
+require 'modules/compute'
+require 'modules/translate'
+
+class EnglishNumber
+  include Compute
+  include Translate
+  attr_reader :num
+  
+  def initialize(num)
+    raise ArgumentError unless num.is_a?(Numeric)
+    @num = num.to_i
+  end
+  
+  # To get translation use #in_english method from ::Translate
+  
+end
+

data/lib/english_numbers.yml

@@ -0,0 +1,3 @@
+ones: [zero, one, two, three, four, five, six, seven, eight, nine]
+tenss: [ten, eleven, twelve, thirteen, fourteen, fifteen, sixteen, seventeen, eighteen, nineteen]
+tens: [zero, ten, twenty, thirty, forty, fifty, sixty, seventy, eighty, ninety]

data/lib/modules/compute.rb

@@ -0,0 +1,20 @@
+# Requires a class with num attribute(which is Numeric) and it's reader
+
+module Compute
+  OPERATIONS = [:+, :-, :*, :/]
+  
+  def method_missing(method, arg)
+    if OPERATIONS.include?(method)
+      self.class.new(num.send(method, arg.num))
+    end
+  end
+  
+  def num_mod
+    num_abs.modulo(10)
+  end
+
+  def num_abs
+    num.abs
+  end
+  
+end

data/lib/modules/translate.rb

@@ -0,0 +1,28 @@
+module Translate
+
+  def in_english
+    # Limit of digits - ready for further extensions
+    return nil if digits_count > 2
+    
+    num < 0 ? "minus-#{in_words}" : in_words
+  end
+
+  private
+
+  def numbers_in_words
+    return YAML.load_file('./lib/english_numbers.yml')
+  end
+  
+  def in_words
+    return single_digits(num_abs) unless digits_count > 1
+    "#{single_digits(digits_count).capitalize}Digits".constantize.send(:run, num)
+  end
+  
+  def digits_count
+    num.to_s.delete('-').split(//).count
+  end
+  
+  def single_digits(number)
+    numbers_in_words['ones'][number]
+  end
+end

data/spec/integrations/english_number_int_spec.rb

@@ -0,0 +1,76 @@
+require './lib/english_number.rb'
+
+RSpec.describe EnglishNumber do
+  subject(:eng_num) { described_class }
+  
+  # Integration tests
+  it 'includes Compute module' do
+    expect(eng_num.included_modules).to include(Compute)
+  end
+  
+  describe '::Translate module' do
+  
+    it 'translates one digit numbers to English words' do
+      expect(eng_num.new(6).in_english).to eq('six')
+    end
+    
+    it 'translates two digit numbers < 20 to English words' do
+      expect(eng_num.new(11).in_english).to eq('eleven')
+    end
+    
+    it 'translates two digit numbers >= 20 to English words' do
+      expect(eng_num.new(22).in_english).to eq('twenty-two')
+    end
+    
+    it 'translates float numbers to English words rounded down' do
+      expect(eng_num.new(24.5).in_english).to eq('twenty-four')
+    end
+    
+    it 'doesn\'t translate numbers greater than 99' do
+      expect(eng_num.new(99).in_english).to eq('ninety-nine')
+      expect(eng_num.new(100).in_english).to eq(nil)
+    end
+    
+    it 'translates negative one digit numbers' do
+      expect(eng_num.new(-7).in_english).to eq('minus-seven')
+    end
+    
+    it 'translates negative two digit numbers < 20' do
+      expect(eng_num.new(-15).in_english).to eq('minus-fifteen')
+    end
+    
+    it 'translates negative two digit numbers >= 20' do
+      expect(eng_num.new(-43).in_english).to eq('minus-forty-three')
+    end
+    
+    it 'doesn\'t translate numbers lower than -99' do
+      expect(eng_num.new(-99).in_english).to eq('minus-ninety-nine')
+      expect(eng_num.new(-100).in_english).to eq(nil)
+    end 
+    
+  end
+  
+  it 'includes Translate module' do
+    expect(eng_num.included_modules).to include(Translate)
+  end
+  
+  describe '::Compute module' do
+    
+    it 'adds numbers and returns new object' do
+      expect((eng_num.new(12) + eng_num.new(86)).in_english).to eq('ninety-eight')
+    end
+    
+    it 'subtracts numbers and returns new object' do
+      expect((eng_num.new(10) - eng_num.new(17)).in_english).to eq('minus-seven')
+    end
+    
+    it 'multiplies numbers and returns new object' do
+      expect((eng_num.new(2) * eng_num.new(2)).in_english).to eq('four')
+    end
+    
+    it 'divides numbers and returns new object' do
+      expect((eng_num.new(55) / eng_num.new(2)).in_english).to eq('twenty-seven')
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,99 @@
+require 'simplecov'
+SimpleCov.start
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  # config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+end

data/spec/unit_tests/compute_spec.rb

@@ -0,0 +1,76 @@
+require './lib/modules/compute.rb'
+
+RSpec.describe 'Compute module' do
+  let(:dummy_class) { Class.new { 
+      include Compute
+      attr_reader :num
+      def initialize(num)
+        @num = num
+      end } }
+
+  context 'having two objects with num attributes' do
+    let(:first_arg) { dummy_class.new(25) }
+    let(:second_arg) { dummy_class.new(5) }
+
+    context 'adding two objects with +' do
+
+      it 'returns new object' do
+        expect(first_arg.send(:+,second_arg)).to be_a(dummy_class)
+      end
+      
+      it 'stores sum in new object\'s num attribute' do
+        expect((first_arg.send(:+,second_arg)).num).to eq(30)
+      end
+      
+    end
+    
+    context 'subtracting two objects with -' do
+
+      it 'returns new object' do
+        expect(first_arg.send(:-,second_arg)).to be_a(dummy_class)
+      end
+      
+      it 'stores difference in new object\'s num attribute' do
+        expect((first_arg.send(:-,second_arg)).num).to eq(20)
+      end
+      
+    end
+    
+    context 'multiplying two objects with *' do
+
+      it 'returns new object' do
+        expect(first_arg.send(:*,second_arg)).to be_a(dummy_class)
+      end
+      
+      it 'stores product in new object\'s num attribute' do
+        expect((first_arg.send(:*,second_arg)).num).to eq(125)
+      end
+      
+    end
+    
+    context 'dividing two objects with /' do
+
+      it 'returns new object' do
+        expect(first_arg.send(:/,second_arg)).to be_a(dummy_class)
+      end
+      
+      it 'stores quotien in new object\'s num attribute' do
+        expect((first_arg.send(:/,second_arg)).num).to eq(5)
+      end
+    end
+  end
+  
+  context 'having any object with num attribute' do
+    let(:object) { dummy_class.new(-68) }
+    
+    it '#num_abs returns absolute from the num attribute' do
+      expect(object.num_abs).to eq(68)
+    end
+    
+    it '#num_mod returns modulo from dividing num attribute absolute by 10' do
+      expect(object.num_mod).to eq(8)
+    end
+    
+  end
+  
+end

data/spec/unit_tests/english_number_unit_spec.rb

@@ -0,0 +1,62 @@
+require './lib/english_number.rb'
+
+RSpec.describe EnglishNumber do
+  subject(:eng_num) { described_class }
+  
+  context 'has one instance variable' do
+    
+    it 'throws error for no arguments given' do
+      expect { eng_num.new }.to raise_error(ArgumentError)
+    end
+    
+    it 'runs with one number argument given' do
+      expect { eng_num.new(6) }.not_to raise_error
+    end
+    
+    it 'throws error for two arguments given' do
+      expect { eng_num.new(2,4) }.to raise_error(ArgumentError)
+    end
+    
+  end
+  
+  context 'accepts only numeric arguments' do
+  
+    it 'throws error for string argument' do
+      expect { eng_num.new('') }.to raise_error(ArgumentError)
+    end
+  
+    it 'throws error for array argument' do
+      expect { eng_num.new(Array.new) }.to raise_error(ArgumentError)
+    end
+    
+    it 'accepts float argument' do
+      expect { eng_num.new(4.5) }.not_to raise_error
+    end
+    
+    it 'accepts integer argument' do
+      expect { eng_num.new(56) }.not_to raise_error
+    end
+    
+    it 'handles integer argument greater than gem\'s limit' do
+      expect { eng_num.new(523123) }.not_to raise_error
+    end
+    
+  end
+  
+  context 'allows to read the number instance variable' do
+    
+    it 'doesn\'t throw error when the number is read' do
+      expect { eng_num.new(43).num }.not_to raise_error
+    end
+    
+    it 'reads the right number' do
+      expect(eng_num.new(33).num).to eq(33)
+    end
+    
+  end
+  
+  it 'transforms floating numbers to integers' do
+    expect(eng_num.new(78.543).num).to eq(78)
+  end
+  
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: english_number
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Piotr Brych
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+description: "Example: EnglishNumber.new(63).in_english # => 'sixty-three'. \n                   EnglishNumber
+  objects can be added, subtracted, multiplied, divided."
+email: pbrych@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- english_number.gemspec
+- lib/digits/two_digits.rb
+- lib/english_number.rb
+- lib/english_numbers.yml
+- lib/modules/compute.rb
+- lib/modules/translate.rb
+- spec/integrations/english_number_int_spec.rb
+- spec/spec_helper.rb
+- spec/unit_tests/compute_spec.rb
+- spec/unit_tests/english_number_unit_spec.rb
+homepage: http://rubygems.org/gems/english-number.rb
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Converting English numbers to strings
+test_files: []