ph_no_to_word 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20f2ae407d619aaa35e1ff828c41176cf5da1b9558097633163f1fa9d5ca3708
-  data.tar.gz: 4b7eada9bf025db4eb22f4b53a0241826868b855b6834c4a1b25f566f88a27c1
+  metadata.gz: ac15e2fbf7b0aa75ff86a0b2ff3ac8f25b09faaaa51b5ea9acb40fcef1918c15
+  data.tar.gz: 8a5ad371a10bf4066df410bfbdc35282f7929c841a32ea1d209ac0e4b7818596
 SHA512:
-  metadata.gz: 211c21a5530f534b323b6b90b1a2ea851d4a63742d31191339b5a16d2802d790424e03889f0e9307610ddc95c9498db941441a5f467cc43f1f8500996d43e0a5
-  data.tar.gz: 485d7c4b494dba3b3724ec529520b94b2b6562d60c1eea7a48bcc8366b6a84ed53ab5963e5d63161275eca5ca0e84c9fa186276d60627389de33f13fb8b40afb
+  metadata.gz: 835da6c62126dca333a994200b9b3e098d1586c2ede34d4e55174e9db92411672e4a0b94c7fac044f42bedc1813cd9d6992bcb209ad9e05ae5684c5ea39b1d96
+  data.tar.gz: 33f21a8f93c023bc9f9765f837b00507d8f44b3a92d403d3047e9f8ad883ccb66a003a83a1b36af41ef3350d582db6ef38cd7508022ff03d648580901bf91a29

data/CHANGELOG.md

@@ -5,17 +5,20 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [1.1.0]
 
 ## [1.0.0] - 2019-05-25
 ### Added
 - New visual identity by [@abhilashak](https://github.com/abhilashak).
 - ChangeLog file added
-- Return value of `convert` method now provided with an Array for better use of output for developers
+- Return value of `convert` method now provided with an Array for better use of output
+- Validations to length of the phone number
 
 ### Changed
-- Code optimizations
+- Code optimizations, structuring
 - Modified readme file
 - Added the link to the dictionary file, keeping dictionary sample file
+- Validations code
 
 ### Removed
 - Printing of the results
@@ -28,3 +31,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Moved the splitting code to separate namespace
 ### Removed
+
+## [2.0.0] - 2019-06-02
+### 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
+  performance
+
+### Changed
+- Rewritten the methods to make the processing of words faster and finding the
+  result
+### Removed
+- Some methods that is no loanger needed for new code

data/README.md

@@ -1,8 +1,8 @@
 # Phone number to word
 
-  `ph_no_to_word` allows given 10 character phone number to convert into a word that is contained in a dictionary.
+  `ph_no_to_word` allows given 10 character phone number to convert into a word that is contained in the dictionary.
   The phone number should not contain 0 or 1. The matching words contain atleast 3 characters.
-  You can find the dictionary file here: https://gist.github.com/abhilashak/fde080091463ca0f03b12b41e8b66108
+  You can find the dictionary file here: https://github.com/abhilashak/dictionary_file/blob/master/dictionary.txt
 
 ## Installation
 
@@ -28,6 +28,9 @@ After installing the gem goto
 irb(main):001:0> require 'ph_no_to_word'
 => true
 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"]
+
 Results:
 * act, amounts
 * act, boo, tots
@@ -52,6 +55,19 @@ Results:
 
 ```ruby
 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"]
+
+Results:
+* act, amounts
+* act, boo, tots
+* act, boo, tour
+* act, boot, mus
+* act, boot, nus
+* act, boot, our
+* act, con, tots
+.......
+.......
 * motortruck
 * motor, truck
 * motor, usual
@@ -60,8 +76,6 @@ irb(main):004:0> PhNoToWord::convert '6686787825'
 * mot, opt, suck
 * noun, struck
 * not, opt, puck
-.......
-.......
 ```
 
 ## Contributing

data/lib/ph_no_to_word/constants.rb

@@ -19,15 +19,19 @@ module PhNoToWord
       '9': %w[w x y z]
     }.freeze
     FORBIDDEN_NOS = %w[0 1].freeze
+    FORBN_WD_LENS = %w[7 8].freeze
     MAX_SPLIT_DEPTH = 4
     MIN_WD_LENGTH = MAXIMUM_WDS = 3
+    WD_STARTS_AT_INDEX = 2
     FILE_EXT = '.txt'
     THREE_CHAR_FILE = 'three_char_wrds' + FILE_EXT
     PH_LENGTH = 10
-    MAX_FST_WD_LEN = 7
+    MAX_WD_LEN = 7
+    MAX_WD_LEN_INDEX = 6
     DEFAULT_WORD_FILES_PATH = '/word_files'
     DEFAULT_WORD_FILE_DIR = DEFAULT_WORD_FILES_PATH + '/level_1'
     DEFAULT_WD_FILE_DIR_LVL_2 = DEFAULT_WORD_FILES_PATH + '/level_2'
-    DEFAULT_DICTIONARY_FILE_PATH = DEFAULT_WORD_FILES_PATH + '/dictionary_sample' + FILE_EXT
+    DEFAULT_WD_FILE_DIR_LVL_3 = DEFAULT_WORD_FILES_PATH + '/level_3'
+    DEFAULT_DICTIONARY_FILE_PATH = DEFAULT_WORD_FILES_PATH + '/dictionary' + FILE_EXT
   end
 end

data/lib/ph_no_to_word/error.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
+# PhNoToWord::Error is raised when it's caused by wrong usage of PhNoToWord.
+# Those errors have their backtrace suppressed and are nicely shown to the user.
 module PhNoToWord
-  # PhNoToWord::Error is raised when it's caused by wrong usage of PhNoToWord classes. Those
-  # errors have their backtrace suppressed and are nicely shown to the user.
-  #
   # Errors that are caused by the developer, like declaring a method which
-  # overwrites a PhNoToWord keyword, SHOULD NOT raise a PhNoToWord::Error. This way, we
-  # ensure that developer errors are shown with full backtrace.
+  # overwrites a PhNoToWord keyword, SHOULD NOT raise a PhNoToWord::Error.
+  # This way, we ensure that developer errors are shown with full backtrace.
   module Error
     class Error < StandardError
     end

data/lib/ph_no_to_word/helpers.rb

@@ -4,8 +4,133 @@
 module PhNoToWord
   # helper module to expand functionalities
   module Helpers
-    def configure
-      yield(self) if block_given?
+    # Module methods
+    module ClassMethods
+      include Constants
+
+      def self.extended(base)
+        base.send(:include, Constants)
+      end
+
+      def first_wd?(word_no)
+        word_no.zero?
+      end
+
+      def second_wd?(word_no)
+        word_no == 1
+      end
+
+      def third_wd?(word_no)
+        word_no == 2
+      end
+
+      def first_or_sec_wd?(word_no)
+        first_wd?(word_no) || second_wd?(word_no)
+      end
+
+      # Compare two strings irrespective of case
+      def cmp(line, str)
+        return false unless line && str
+
+        line.strip.casecmp(str.strip).zero?
+      end
+
+      # Checks the position is within the given array
+      def inside_last_pos?(ary, pos)
+        pos < ary.length
+      end
+
+      # Provides the filename to search for 10 charcter word
+      def ten_chr_wd_filename(word)
+        word[0..2] + FILE_EXT
+      end
+
+      # For word to search it should have minimum word length
+      # and length of the words are not in forbidden list
+      def valid_word?(word, pos)
+        word.length >= MIN_WD_LENGTH && !FORBN_WD_LENS.include?(pos)
+      end
+
+      # Checks there is a room for another word within 10 character
+      def can_accomdte_another_wd?(result)
+        result.length <= MAX_WD_LEN
+      end
+
+      # Search for first word until position 6
+      # Words with 7, 8 first wds will not counts
+      # Checks for 10 character words are done at last separately
+      def search_again_for_first_wd?(word_no, pos)
+        first_wd?(word_no) && pos <= MAX_WD_LEN_INDEX
+      end
+
+      # Search for second and thrid word until all remaining positions
+      def search_again_for_second_thrid_wd?(word_no, pos, ary)
+        second_wd?(word_no) || third_wd?(word_no) && inside_last_pos?(ary, pos)
+      end
+
+      # if not scanned earlier for next word and word ary
+      # must have min word length for searching the word,
+      # then gives permission for searching the next word
+      def search_for_nxt_wd?(scanned, wd_ary_len)
+        !scanned && wd_ary_len >= MIN_WD_LENGTH
+      end
+
+      # If second word and length is less then to accomodate an another word,
+      # then search for third word
+      def stop_mth_with_nxt_wrd?(pos, wds)
+        pos != :second || wds.length > MAX_WD_LEN
+      end
+
+      # sets the variables that stores the data within loops
+      def set_data_stores
+        @result           ||= Set.new
+        @matching_wd_hash ||= { first: [], second: [], third: [] }
+        @scanned_pos      ||= []
+        nil
+      end
+
+      # reset the stored results data
+      def reset_data_stores
+        @result           = nil
+        @matching_wd_hash = nil
+        @scanned_pos      = nil
+      end
+
+      # provide the key according to first, second or third word
+      def key_frm_word_no(word_no)
+        case word_no
+        when 0
+          :first
+        when 1
+          :second
+        when 2
+          :third
+        end
+      end
+
+      # 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
+          level    = 1
+          filename = nil
+        when PH_LENGTH
+          level    = 3
+          filename = str[0..2] + FILE_EXT
+        else
+          level    = 2
+          filename = str[0..3] + FILE_EXT
+        end
+        [level, filename]
+      end
+    end
+
+    extend ClassMethods
+
+    def self.included(base)
+      base.extend(ClassMethods)
     end
   end
-end
+end

data/lib/ph_no_to_word/split_dictionary.rb

@@ -18,19 +18,23 @@ module PhNoToWord
 
       # @param file_path [String]
       # Ex: file_path: /path/to/dictionary.txt
+      # if condition Create a file based on first 4 characters
+      # else condition Create a file based on first 3 characters
       def split_files(file_path)
         remove_all_files
+
         file_path ||= __dir__ + DEFAULT_DICTIONARY_FILE_PATH
         raise FileNotExists unless File.file?(file_path)
 
         File.open(file_path, 'r').each_line do |word|
           word.strip!
-          # Create a file based on first 4 characters
-          if word.length > MIN_WD_LENGTH
-            write_to_file(word[0..3], word)
-          # Create a file based on first 3 characters
-          elsif word.length == MIN_WD_LENGTH
-            write_to_file(word, word, 1)
+
+          if word.length == MIN_WD_LENGTH
+            write_to_file(nil, word, 1)
+          elsif word.length == PH_LENGTH
+            write_to_file(word[0..2], word, 3)
+          elsif word.length > MIN_WD_LENGTH && ![8, 9].include?(word.length)
+            write_to_file(word[0..3], word, 2)
           end
         end
       end
@@ -38,7 +42,8 @@ module PhNoToWord
       # Removes all the files that created by splitting the dictionary
       def remove_all_files
         [DEFAULT_WORD_FILE_DIR,
-         DEFAULT_WD_FILE_DIR_LVL_2].each do |folder|
+         DEFAULT_WD_FILE_DIR_LVL_2,
+         DEFAULT_WD_FILE_DIR_LVL_3].each do |folder|
           directory_name = "#{__dir__}#{folder}"
 
           if File.file?(directory_name)
@@ -55,18 +60,24 @@ module PhNoToWord
       #  if file not exists creates a new file with the filename
       # Level 1: text files with 3 char length filename
       # Level 2: text files with 4 char length filename
+      # Level 3: 10 charcter words
       def write_to_file(filename, word, level = 2)
         folder_path = word_file_folder_path(level)
+
         new_file_path = if level == 1
                           folder_path + '/' + THREE_CHAR_FILE
                         else
                           folder_path + "/#{filename.strip.downcase}" + FILE_EXT
+                        # elsif level == 3
+                        #   folder_path + "/#{filename.strip.downcase}" + FILE_EXT
                         end
+
         new_file = if File.file?(new_file_path)
                      File.open(new_file_path, 'a')
                    else
                      File.new(new_file_path, 'w')
                    end
+
         new_file.puts word
         new_file.close
       end
@@ -75,13 +86,15 @@ module PhNoToWord
       # Level 1: text files with 3 char length filename
       # Level 2: text files with 4 char length filename
       def word_file_folder_path(level = 2)
-        return (__dir__ + DEFAULT_WORD_FILE_DIR) if level == 1
+        return (__dir__ + DEFAULT_WORD_FILE_DIR)     if level == 1
+        return (__dir__ + DEFAULT_WD_FILE_DIR_LVL_3) if level == 3
 
         __dir__ + DEFAULT_WD_FILE_DIR_LVL_2
       end
     end
 
     extend ClassMethods
+
     def self.included(base)
       base.extend(ClassMethods)
     end

data/lib/ph_no_to_word/validator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'ph_no_to_word/error'
+
+# TODO: for future use
+module PhNoToWord
+  # helper module to expand functionalities
+  module Validator
+    # Module methods
+    module ClassMethods
+      include Constants
+      include Error
+
+      def self.extended(base)
+        base.send(:include, Constants)
+      end
+
+      # @param ph_no [String] ph_ary [Array]
+      # Populate error if not a valid phone number given
+      # Ex: ph_ary ["2", "2", "8", "2", "6", "6", "8", "6", "8", "7"]
+      def validate(ph_no, ph_ary)
+        raise RequiredArgumentMissingError, ERRORS[:missing_ph] if ph_no.empty?
+
+        unless ph_no.length.eql?(PH_LENGTH)
+          raise MalformattedArgumentError, ERRORS[:ph_length]
+        end
+        return if (ph_ary & FORBIDDEN_NOS).empty?
+
+        raise MalformattedArgumentError, ERRORS[:malformed_ph_no]
+      end
+    end
+
+    extend ClassMethods
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/ph_no_to_word/version.rb

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

data/lib/ph_no_to_word/word_files/level_1/three_char_wrds.txt

@@ -1,15 +1,3 @@
-CAS
-ACT
-CAS
-ACT
-CAS
-ACT
-CAS
-ACT
-CAS
-ACT
-CAS
-ACT
 AAH
 AAL
 AAS

data/lib/ph_no_to_word/word_files/level_2/aarr.txt

@@ -1,7 +1,2 @@
-AARRGHH
-AARRGHH
-AARRGHH
-AARRGHH
-AARRGHH
 AARRGH
 AARRGHH

data/lib/ph_no_to_word/word_files/level_2/abac.txt

@@ -2,6 +2,4 @@ ABACA
 ABACAS
 ABACI
 ABACK
-ABACTERIAL
 ABACUS
-ABACUSES

data/lib/ph_no_to_word/word_files/level_2/abal.txt

@@ -1,2 +1 @@
 ABALONE
-ABALONES

data/lib/ph_no_to_word/word_files/level_2/abam.txt

@@ -1,4 +1,2 @@
 ABAMP
-ABAMPERE
-ABAMPERES
 ABAMPS

data/lib/ph_no_to_word/word_files/level_2/aban.txt

@@ -1,8 +1,3 @@
 ABANDON
-ABANDONED
-ABANDONER
-ABANDONERS
-ABANDONING
 ABANDONMENT
 ABANDONMENTS
-ABANDONS

data/lib/ph_no_to_word/word_files/level_2/abas.txt

@@ -1,19 +1,12 @@
 ABAS
 ABASE
 ABASED
-ABASEDLY
-ABASEMENT
-ABASEMENTS
 ABASER
 ABASERS
 ABASES
 ABASH
 ABASHED
-ABASHEDLY
 ABASHES
-ABASHING
-ABASHMENT
-ABASHMENTS
 ABASIA
 ABASIAS
 ABASING

data/lib/ph_no_to_word/word_files/level_2/abat.txt

@@ -1,17 +1,10 @@
-ABATABLE
 ABATE
 ABATED
-ABATEMENT
-ABATEMENTS
 ABATER
 ABATERS
 ABATES
 ABATING
 ABATIS
-ABATISES
 ABATOR
 ABATORS
 ABATTIS
-ABATTISES
-ABATTOIR
-ABATTOIRS

data/lib/ph_no_to_word/word_files/level_2/abba.txt

@@ -1,5 +1,3 @@
 ABBA
-ABBACIES
 ABBACY
 ABBAS
-ABBATIAL

data/lib/ph_no_to_word/word_files/level_2/abbe.txt

@@ -1,6 +1,5 @@
 ABBE
 ABBES
 ABBESS
-ABBESSES
 ABBEY
 ABBEYS

data/lib/ph_no_to_word/word_files/level_2/abbo.txt

@@ -1,6 +1,3 @@
 ABBOT
-ABBOTCIES
 ABBOTCY
 ABBOTS
-ABBOTSHIP
-ABBOTSHIPS

data/lib/ph_no_to_word/word_files/level_2/abbr.txt

@@ -1,4 +1,3 @@
-ABBREVIATE
 ABBREVIATED
 ABBREVIATES
 ABBREVIATING

data/lib/ph_no_to_word/word_files/level_2/abdi.txt

@@ -1,9 +1 @@
-ABDICABLE
-ABDICATE
-ABDICATED
-ABDICATES
-ABDICATING
-ABDICATION
 ABDICATIONS
-ABDICATOR
-ABDICATORS

data/lib/ph_no_to_word/word_files/level_2/abdo.txt

@@ -1,6 +1,2 @@
 ABDOMEN
-ABDOMENS
-ABDOMINA
-ABDOMINAL
 ABDOMINALLY
-ABDOMINALS

data/lib/ph_no_to_word/word_files/level_2/abdu.txt

@@ -1,18 +1,5 @@
 ABDUCE
 ABDUCED
-ABDUCENS
-ABDUCENT
-ABDUCENTES
 ABDUCES
-ABDUCING
 ABDUCT
-ABDUCTED
-ABDUCTEE
-ABDUCTEES
-ABDUCTING
-ABDUCTION
-ABDUCTIONS
-ABDUCTOR
-ABDUCTORES
-ABDUCTORS
 ABDUCTS

data/lib/ph_no_to_word/word_files/level_2/abel.txt

@@ -3,5 +3,3 @@ ABELES
 ABELIA
 ABELIAN
 ABELIAS
-ABELMOSK
-ABELMOSKS

data/lib/ph_no_to_word/word_files/level_2/aber.txt

@@ -1,11 +1,3 @@
-ABERRANCE
-ABERRANCES
 ABERRANCIES
-ABERRANCY
-ABERRANT
-ABERRANTLY
-ABERRANTS
-ABERRATED
-ABERRATION
 ABERRATIONAL
 ABERRATIONS

data/lib/ph_no_to_word/word_files/level_2/abet.txt

@@ -1,12 +1,6 @@
 ABET
-ABETMENT
-ABETMENTS
 ABETS
 ABETTAL
-ABETTALS
 ABETTED
 ABETTER
-ABETTERS
-ABETTING
 ABETTOR
-ABETTORS

data/lib/ph_no_to_word/word_files/level_2/abey.txt

@@ -1,5 +1 @@
-ABEYANCE
-ABEYANCES
-ABEYANCIES
-ABEYANCY
 ABEYANT

data/lib/ph_no_to_word/word_files/level_2/abfa.txt

@@ -1,2 +1 @@
 ABFARAD
-ABFARADS

data/lib/ph_no_to_word/word_files/level_2/abhe.txt

@@ -1,3 +1 @@
-ABHENRIES
 ABHENRY
-ABHENRYS

data/lib/ph_no_to_word/word_files/level_2/abho.txt

@@ -1,10 +1,4 @@
 ABHOR
-ABHORRED
-ABHORRENCE
 ABHORRENCES
-ABHORRENT
 ABHORRENTLY
-ABHORRER
-ABHORRERS
-ABHORRING
 ABHORS

data/lib/ph_no_to_word/word_files/level_2/abid.txt

@@ -1,9 +1,6 @@
-ABIDANCE
-ABIDANCES
 ABIDE
 ABIDED
 ABIDER
 ABIDERS
 ABIDES
 ABIDING
-ABIDINGLY

data/lib/ph_no_to_word/word_files/level_2/abig.txt

@@ -1,2 +1 @@
 ABIGAIL
-ABIGAILS

data/lib/ph_no_to_word/word_files/level_2/abil.txt

@@ -1,2 +1 @@
-ABILITIES
 ABILITY

data/lib/ph_no_to_word/word_files/level_2/abio.txt

@@ -1,8 +1,6 @@
 ABIOGENESES
 ABIOGENESIS
-ABIOGENIC
 ABIOGENICALLY
-ABIOGENIST
 ABIOGENISTS
 ABIOLOGICAL
 ABIOSES

data/lib/ph_no_to_word/word_files/level_2/abje.txt

@@ -1,6 +1,2 @@
 ABJECT
-ABJECTION
-ABJECTIONS
-ABJECTLY
-ABJECTNESS
 ABJECTNESSES

data/lib/ph_no_to_word/word_files/level_2/abju.txt

@@ -1,8 +1,5 @@
-ABJURATION
 ABJURATIONS
 ABJURE
 ABJURED
 ABJURER
-ABJURERS
 ABJURES
-ABJURING