ph_no_to_word 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac15e2fbf7b0aa75ff86a0b2ff3ac8f25b09faaaa51b5ea9acb40fcef1918c15
-  data.tar.gz: 8a5ad371a10bf4066df410bfbdc35282f7929c841a32ea1d209ac0e4b7818596
+  metadata.gz: 3d24e17ec78136038cda980d62bc4d43dbe6a2cdd0fa7748b2c900923d268ea3
+  data.tar.gz: 72df027cdfb2086cc5b9314842c839d46bb61d1adb4243eef2c0a8bc8513ca56
 SHA512:
-  metadata.gz: 835da6c62126dca333a994200b9b3e098d1586c2ede34d4e55174e9db92411672e4a0b94c7fac044f42bedc1813cd9d6992bcb209ad9e05ae5684c5ea39b1d96
-  data.tar.gz: 33f21a8f93c023bc9f9765f837b00507d8f44b3a92d403d3047e9f8ad883ccb66a003a83a1b36af41ef3350d582db6ef38cd7508022ff03d648580901bf91a29
+  metadata.gz: d0bdcfe74d4a0a5dc1a8a4cc25fe3e27135c8ad7dc4dd3483e7bbd80255163cc3bac186ed89a9d127d1c9873f3a9c45eb5cbeace7191627130fecf220496a6a7
+  data.tar.gz: 9d783c0316660b8c1ba50441bc0a49be063604605acf131f7a2f8e6845edbd96f0105b209b31d96c51da14d5acb1c4dee393480b124824d32345b2b1bad72f1a

data/.gitignore

@@ -0,0 +1,21 @@
+!.gitignore
+*.gem
+.Trashes
+/.bundle/
+/.yardoc
+/.vscode
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# rbenv config
+.ruby-gemset
+.ruby-version
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/CHANGELOG.md

@@ -32,7 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Moved the splitting code to separate namespace
 ### Removed
 
-## [2.0.0] - 2019-06-02
+## [2.0.0] - 2019-06-05
 ### Added
 - New methods and completely rewritten the logic for high performance improvements
 - Performance Improvements, now get the result in 1/10 of the previous version

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ph_no_to_word.gemspec
+gemspec
+
+group :test do
+  gem 'simplecov', '>= 0.16.1'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Abhilash A K
+
+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

@@ -27,7 +27,7 @@ After installing the gem goto
 ```ruby
 irb(main):001:0> require 'ph_no_to_word'
 => true
-irb(main):002:0> PhNoToWord::convert "2282668687"
+irb(main):002:0> PhNoToWord.convert "2282668687"
 => ["act, amounts", "act, boo, tots", "act, boo, tour", "act, boot, mus",
     ....... "cat, coot, mus", "cat, coot, nus", "cat, coot, our", "catamounts"]
 
@@ -54,7 +54,7 @@ Results:
 ```
 
 ```ruby
-irb(main):004:0> PhNoToWord::convert '6686787825'
+irb(main):004:0> PhNoToWord.convert '6686787825'
 => ["act, amounts", "act, boo, tots", "act, boo, tour", "act, boot, mus",
     ....."oot, orts, taj", "motor, truck", "motor, usual", "motortruck", "nouns, truck","nouns, usual"]
 

data/Rakefile

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

data/lib/ph_no_to_word/helpers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# TODO: for future use
+# Helper
 module PhNoToWord
   # helper module to expand functionalities
   module Helpers
@@ -110,15 +110,10 @@ module PhNoToWord
 
       # Level 1: 3 char words
       # Level 2: > 3 char words
-      # Level 3: 10 char words
       def filename_frm_lvl(str)
-        case str.length
-        when MIN_WD_LENGTH
+        if str.length == MIN_WD_LENGTH
           level    = 1
           filename = nil
-        when PH_LENGTH
-          level    = 3
-          filename = str[0..2] + FILE_EXT
         else
           level    = 2
           filename = str[0..3] + FILE_EXT

data/lib/ph_no_to_word/logger.rb

@@ -12,11 +12,12 @@
 #   end
 module PhNoToWord
   module Logger
+    # TODO
     # Log a PhNoToWord-specific line.
-    def log(level, message)
-      File.open('log.txt', 'a') do |f|
-        f.write "#{level}: #{message}"
-      end
-    end
+    # def log(level, message)
+    #   File.open('error.log', 'a') do |f|
+    #     f.write "#{level}: #{message}"
+    #   end
+    # end
   end
-end
+end

data/lib/ph_no_to_word/validator.rb

@@ -2,9 +2,9 @@
 
 require 'ph_no_to_word/error'
 
-# TODO: for future use
+# included the error module and validation
 module PhNoToWord
-  # helper module to expand functionalities
+  # helper module to validating the phone number
   module Validator
     # Module methods
     module ClassMethods

data/lib/ph_no_to_word/version.rb

@@ -1,3 +1,3 @@
 module PhNoToWord
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/ph_no_to_word.gemspec

@@ -1,48 +1,35 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ph_no_to_word/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'ph_no_to_word/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ph_no_to_word"
+  spec.name          = 'ph_no_to_word'
   spec.version       = PhNoToWord::VERSION
-  spec.authors       = ["Abhilash A K"]
-  spec.email         = ["abhilash.amballur@gmail.com"]
+  spec.authors       = ['Abhilash A K']
+  spec.email         = ['abhilash.amballur@gmail.com']
 
-  spec.summary       = %q{Converts the phone number into word characters}
-  spec.description   = %q{This gem allows given 10 character phone number to convert into a word contained in a dictionary}
-  spec.homepage      = "https://github.com/abhilashak/ph_no_to_word"
-  spec.license       = "MIT"
+  spec.summary       = 'Converts the phone number into word characters'
+  spec.description   = 'This gem allows given 10 character phone number to convert into a word contained in a dictionary'
+  spec.homepage      = 'https://github.com/abhilashak/ph_no_to_word'
+  spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = spec.homepage
-    spec.metadata["changelog_uri"] = spec.homepage + '/blob/master/CHANGELOG.md'
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = spec.homepage + '/blob/master/CHANGELOG.md'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.required_ruby_version = '>= 2.5.3'
+  spec.required_rubygems_version = '>= 2.7.6'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 
-  spec.files = %w[ph_no_to_word.gemspec] + Dir["*.md",
-                                               "bin/*",
-                                               "lib/**/*.rb",
-                                               "lib/**/**/*.txt",
-                                               "lib/**/**/**/*.txt"
-                                              ]
+  spec.require_paths = %w[lib]
+  spec.files         = `git ls-files`.split("\n")
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = %w[lib]
-
-  spec.required_ruby_version = '>= 2.5.3'
-  spec.required_rubygems_version = ">= 2.7.6"
-
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
 end

data/spec/ph_no_to_word_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+RSpec.describe PhNoToWord do
+  it 'has a version number' do
+    expect(PhNoToWord::VERSION).not_to be nil
+  end
+
+  it `convert the given 10 digit phone number (2282668687) to words
+      and return an array and expected result` do
+    result = PhNoToWord.convert '2282668687'
+
+    expect(result.is_a?(Array)).to be true
+    expect(result).to include('act, amounts', 'catamounts', 'acta, oot, mus')
+    expect(result.size).to eq(53)
+  end
+
+  it `convert the given 10 digit phone number (6686787825) to words
+      and return an array and expected result` do
+    result = PhNoToWord.convert '6686787825'
+
+    expect(result.is_a?(Array)).to be true
+    expect(result).to include('not, ort, suck', 'motortruck', 'motor, truck')
+    expect(result.size).to eq(44)
+  end
+
+  it `convert the given 10 digit phone number (8325783555) to words
+      and return an empty array` do
+    result = PhNoToWord.convert '8325783555'
+
+    expect(result).to be_empty
+    expect(result.is_a?(Array)).to be true
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+if RUBY_VERSION >= '2.5.3'
+  require 'simplecov'
+
+  SimpleCov.formatters = [SimpleCov::Formatter::HTMLFormatter]
+
+  SimpleCov.start do
+    add_filter '/spec'
+    minimum_coverage(90)
+  end
+end
+
+require 'bundler/setup'
+require 'ph_no_to_word'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/split_dictionary_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe PhNoToWord::SplitDictionary do
+  it 'should split the provided dictionary file' do
+    expect { PhNoToWord::SplitDictionary.split_files('fake/path/test.txt') }.to raise_error(PhNoToWord::Error::FileNotExists)
+  end
+end

data/spec/validator_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.describe PhNoToWord::Validator do
+  it 'should raise RequiredArgumentMissingError if phone number empty' do
+    err_msg = PhNoToWord::Constants::ERRORS[:missing_ph]
+    expect { PhNoToWord.convert '' }.to raise_error(PhNoToWord::Error::RequiredArgumentMissingError, err_msg)
+  end
+
+  it 'should raise MalformattedArgumentError if phone number length is less than 10' do
+    err_msg = PhNoToWord::Constants::ERRORS[:ph_length]
+    expect { PhNoToWord.convert '228266868' }.to raise_error(PhNoToWord::Error::MalformattedArgumentError, err_msg)
+    expect { PhNoToWord.convert '2' }.to raise_error(PhNoToWord::Error::MalformattedArgumentError, err_msg)
+  end
+
+  it 'should raise MalformattedArgumentError if phone number contains 0 or 1' do
+    err_msg = PhNoToWord::Constants::ERRORS[:malformed_ph_no]
+    expect { PhNoToWord.convert '2282668681' }.to raise_error(PhNoToWord::Error::MalformattedArgumentError, err_msg)
+    expect { PhNoToWord.convert '2282068687' }.to raise_error(PhNoToWord::Error::MalformattedArgumentError, err_msg)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ph_no_to_word
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Abhilash A K
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-04 00:00:00.000000000 Z
+date: 2019-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,9 +60,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
 - README.md
+- Rakefile
 - bin/console
 - bin/setup
 - lib/ph_no_to_word.rb
@@ -15349,6 +15355,10 @@ files:
 - lib/ph_no_to_word/word_files/level_3/zyg.txt
 - lib/ph_no_to_word/word_files/level_3/zym.txt
 - ph_no_to_word.gemspec
+- spec/ph_no_to_word_spec.rb
+- spec/spec_helper.rb
+- spec/split_dictionary_spec.rb
+- spec/validator_spec.rb
 homepage: https://github.com/abhilashak/ph_no_to_word
 licenses:
 - MIT