ph_no_to_word 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4d26bf8d62a359d9a46af672f0d0f9c9ad2ca25c2b8502dfb49fe74869884ac
-  data.tar.gz: 36955681699b9ca9193d3afa0363e560f79c84330deb22b01d7d6cf314848c2e
+  metadata.gz: 20f2ae407d619aaa35e1ff828c41176cf5da1b9558097633163f1fa9d5ca3708
+  data.tar.gz: 4b7eada9bf025db4eb22f4b53a0241826868b855b6834c4a1b25f566f88a27c1
 SHA512:
-  metadata.gz: ef6995282e1b71d59d1adaf20abae4ce84e1d0914754130ffa8fc45af0bba7aa0bba9c17911b014e307f7bdb372f2d2511c0dcc53a73d9140cae7fda5038988d
-  data.tar.gz: 93f86c9292012e6a87c2f77d52548bf57b6c413c386bd4659c0dbf070b0cecd08db89b9b12db3ebfc8662abd77dc8d43db6a1f3933ac1140d3713241d34e7b55
+  metadata.gz: 211c21a5530f534b323b6b90b1a2ea851d4a63742d31191339b5a16d2802d790424e03889f0e9307610ddc95c9498db941441a5f467cc43f1f8500996d43e0a5
+  data.tar.gz: 485d7c4b494dba3b3724ec529520b94b2b6562d60c1eea7a48bcc8366b6a84ed53ab5963e5d63161275eca5ca0e84c9fa186276d60627389de33f13fb8b40afb

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+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.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
+
+### Changed
+- Code optimizations
+- Modified readme file
+- Added the link to the dictionary file, keeping dictionary sample file
+
+### Removed
+- Printing of the results
+- Huge dictionary file as we have splitted files on live
+
+## [0.1.0] - 2019-05-24
+### Added
+- Added the functionailty of Phone number to word, tested and published to the world.
+
+### Changed
+- Moved the splitting code to separate namespace
+### Removed

data/README.md

@@ -2,6 +2,7 @@
 
   `ph_no_to_word` allows given 10 character phone number to convert into a word that is contained in a 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
 
 ## Installation
 
@@ -21,21 +22,51 @@ Or install it yourself as:
 
 
 ## Usage
+After installing the gem goto
 
 ```ruby
-PhNoToWord.convert '2282668687'
-
+irb(main):001:0> require 'ph_no_to_word'
+=> true
+irb(main):002:0> PhNoToWord::convert "2282668687"
 Results:
-* catamounts
-* acta, mounts
 * act, amounts
+* act, boo, tots
+* act, boo, tour
+* act, boot, mus
+* act, boot, nus
+* act, boot, our
+* act, con, tots
+* act, con, tour
 * act, contour
-* cat, boot, our
+.......
+.......
+* cat, con, tour
+* cat, contour
+* cat, coo, tots
+* cat, coo, tour
+* cat, coot, mus
+* cat, coot, nus
+* cat, coot, our
+* catamounts
+```
+
+```ruby
+irb(main):004:0> PhNoToWord::convert '6686787825'
+* motortruck
+* motor, truck
+* motor, usual
+* mot, opt, puck
+* mot, opt, ruck
+* mot, opt, suck
+* noun, struck
+* not, opt, puck
+.......
+.......
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on Bitbucket at https://bitbucket.org/abhilashak/ph_no_to_word. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on Github at https://github.com/abhilashak/ph_no_to_word. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/ph_no_to_word/constants.rb

@@ -5,6 +5,7 @@ module PhNoToWord
   module Constants
     ERRORS = {
       missing_ph: 'Please provide a phone number',
+      ph_length: 'Please provide 10 digit phone number',
       malformed_ph_no: 'Cannot contain 0 or 1 in the phone number'
     }.freeze
     NO_CHAR_MAP = {
@@ -27,6 +28,6 @@ module PhNoToWord
     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' + FILE_EXT
+    DEFAULT_DICTIONARY_FILE_PATH = DEFAULT_WORD_FILES_PATH + '/dictionary_sample' + FILE_EXT
   end
 end

data/lib/ph_no_to_word/helpers.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
+# TODO: for future use
 module PhNoToWord
+  # helper module to expand functionalities
   module Helpers
     def configure
       yield(self) if block_given?

data/lib/ph_no_to_word/logger.rb

@@ -1,8 +1,22 @@
+# frozen_string_literal: true
+
+# This modules helps to write into the log file
+# Usage:
+#   include PhNoToWord::Logger
+#   def do_something
+#     begin
+#       # do something
+#     rescue StandardError => e
+#       log :error, e.message
+#     end
+#   end
 module PhNoToWord
   module Logger
     # Log a PhNoToWord-specific line.
-    def log(message)
-      logger.info("[ph_no_to_word] #{message}") if logging?
+    def log(level, message)
+      File.open('log.txt', 'a') do |f|
+        f.write "#{level}: #{message}"
+      end
     end
   end
 end

data/lib/ph_no_to_word/version.rb

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

data/lib/ph_no_to_word.rb

@@ -40,49 +40,73 @@ module PhNoToWord
   # @return words [Array]
   # Ex: PhNoToWord::convert "2282668687"
   # Add 2nd parameter: file_path = nil
-  # And add `split_files(file_path)` for splitting the provided dictionary
+  # And add `split_files(file_path)` for splitting the provided dictionary file
   def self.convert(phone_no = '')
-    raise RequiredArgumentMissingError, ERRORS[:missing_ph] if phone_no.empty?
-
     ph_numbers = phone_no.split(//)
-    unless (ph_numbers & FORBIDDEN_NOS).empty?
-      raise MalformattedArgumentError, ERRORS[:malformed_ph_no]
-    end
+    validate phone_no, ph_numbers
 
     ph_to_word_mapping = ph_numbers.map { |ph_no| NO_CHAR_MAP[ph_no.to_sym] }
+
     result = find_word(ph_to_word_mapping)
     map_num_to_word(result, ph_numbers)
-    nil
+  end
+
+  # @param phone_no [String]
+  # Populate error if not a valid phone number given
+  def self.validate(phone_no, ph_numbers)
+    raise RequiredArgumentMissingError, ERRORS[:missing_ph] if phone_no.empty?
+
+    unless phone_no.length.eql?(PH_LENGTH)
+      raise MalformattedArgumentError, ERRORS[:ph_length]
+    end
+    return if (ph_numbers & FORBIDDEN_NOS).empty?
+
+    raise MalformattedArgumentError, ERRORS[:malformed_ph_no]
   end
 
   # Position the words matched to corresponding phone number
-  # @param wd_ary [Set] ph_ary [Array] parent_wd [String]
+  # @param wd_ary [Set] ph_ary [Array] parent_wd [String] level [Integer] wd_hash [Hash]
   # Ex: ph_ary ["2", "2", "8", "2", "6", "6", "8", "6", "8", "7"]
   # Ex: wd_ary #<Set: {"MOT", "OPT", "PUB", "PUCK", "QUA", "RUB", "RUCK"}>
+  # wd_hash is a tricky implementation that is using to add the commas in
+  #   between the words found in the result, should try to avoid in future
+  # Ex: level 1, 2, 3 because Maximum 3 words can only contain in the result
+  # Ex: wd_hash { :first => "asasa", :second => "dfdfdf", :third => "ddfdfdf"}
   def self.map_num_to_word(wd_ary, ph_ary, parent_wd = '', level = 1, wd_hash = {})
+    @matching_wd_ary ||= []
+
     wd_ary.each do |wd|
-      wd_hash = arrange_wds(wd_hash, level, wd)
+      wd_hash = arrange_result(wd_hash, level, wd)
       total_len = (parent_wd + wd).length
-      full_mapping_to_wd(parent_wd + wd, ph_ary, wd_hash) if total_len == PH_LENGTH
+
+      if total_len == PH_LENGTH
+        result = full_mapping_to_wd(parent_wd + wd, ph_ary, wd_hash)
+        @matching_wd_ary << result if result
+      end
+
       next if total_len > MAX_FST_WD_LEN
 
-      map_num_to_word(wd_ary, ph_ary, parent_wd + wd, level + 1, wd_hash) if level < MAXIMUM_WDS
+      if level < MAXIMUM_WDS
+        map_num_to_word(wd_ary, ph_ary, parent_wd + wd, level + 1, wd_hash)
+      end
     end
+
+    @matching_wd_ary
   end
 
   # Add first, second and third words in order to display
   # @param wd_hash [Hash] level [Integer] wd [String]
-  def self.arrange_wds(wd_hash, level, wd)
+  def self.arrange_result(wd_hash, level, word)
     case level
     when 1
-      wd_hash[:first] = wd
-      wd_hash[:third] = wd_hash[:second] = nil if wd.length > MAX_FST_WD_LEN
+      wd_hash[:first] = word
+      wd_hash[:third] = wd_hash[:second] = nil if word.length > MAX_FST_WD_LEN
     when 2
-      wd_hash[:second] = wd
-      wd_hash[:third] = nil if (wd_hash[:first] + wd).length > MAX_FST_WD_LEN
-    when 3
-      wd_hash[:third] = wd
+      wd_hash[:second] = word
+      wd_hash[:third] = nil if (wd_hash[:first] + word).length > MAX_FST_WD_LEN
+    when 3 then wd_hash[:third] = word
     end
+
     wd_hash
   end
 
@@ -91,25 +115,30 @@ module PhNoToWord
   # Ex: wd_ary     ["c", "a", "t", "a", "m", "o", "u", "n", "t", "s"]
   def self.full_mapping_to_wd(word, ph_numbers, disply_wrd)
     word_ary = word.split(//)
+
     ph_numbers.each_with_index do |number, index|
       return false unless NO_CHAR_MAP[number.to_sym].include?(word_ary[index].downcase)
     end
-    puts disply_wrd.values.compact.join(', ').downcase
+
+    disply_wrd.values.compact.join(', ').downcase
   end
 
   # finds the matching words and prints it
   # calls from 0 - 9 chars and finds the matching
   def self.find_word(char_ary = [], start = 0, str = '')
     @result ||= Set.new
+
     loop_phone = proc do |ary, pos, match|
       (ary[pos] || []).each do |char|
         result = print_result(match + char) if pos > 1
+
         @result.add(result) if result
         find_next_word(char_ary, result)
-        # call again until the last phone no reaches
+
         loop_phone.call(ary, pos + 1, match + char) if pos < (PH_LENGTH - 1)
       end
     end
+
     loop_phone.call(char_ary, start, str)
     @result
   end
@@ -131,31 +160,28 @@ module PhNoToWord
   # @param str [String]
   # Level 1: 3 char words
   # Level 2: > 3 char words
+  # Ex: str acfdrt in if condition
+  # Ex: str asde, act, aem in else condition
   def self.search_word(str)
     level = (str.length == MIN_WD_LENGTH ? 1 : 2)
-    # Ex: str acfdrt
     filename = if str.length > MAX_SPLIT_DEPTH
                  str[0..MAX_SPLIT_DEPTH - 1] + FILE_EXT
                else
-                 # Ex: str asde, act, aem
                  str + FILE_EXT
                end
+
     new_file_path = find_file_to_search(level, filename)
     return nil unless File.file?(new_file_path)
 
-    word_found = check_file_cnt_matches(new_file_path, str)
-    word_found
+    check_file_cnt_matches(new_file_path, str)
   end
 
   # if level is 1, search in file three_char_wrds
   # else search in file with name of first 4 char wrd
   def self.find_file_to_search(lvl, filename)
-    file_path = if lvl == 1
-                  word_file_folder_path(lvl) + '/' + THREE_CHAR_FILE
-                else
-                  word_file_folder_path(lvl) + '/' + filename
-                end
-    file_path
+    return (word_file_folder_path(lvl) + '/' + THREE_CHAR_FILE) if lvl == 1
+
+    word_file_folder_path(lvl) + '/' + filename
   end
 
   # @param file_path [String] str [String]
@@ -163,20 +189,21 @@ module PhNoToWord
   def self.check_file_cnt_matches(file_path, str)
     word_found = nil
     File.open(file_path, 'r') do |f|
-      f.each_line do |line|
-        # exit loop if finds the str from dictionary
-        if line.strip.casecmp(str).zero?
-          word_found = line.strip
-          break
-        end
-      end
+      f.each_line { |line| (word_found = line.strip) && break if cmp(line, str) }
     end
     word_found
   end
 
+  # Compare two strings irrespective of case
+  def self.cmp(line, str)
+    return false unless line && str
+
+    line.strip.casecmp(str.strip).zero?
+  end
+
   class << self
     private :find_word, :write_to_file, :search_word, :word_file_folder_path,
             :check_file_cnt_matches, :find_file_to_search, :print_result,
-            :arrange_wds, :find_next_word
+            :arrange_result, :find_next_word, :cmp
   end
 end

data/ph_no_to_word.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
     # 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
+    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."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ph_no_to_word
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Abhilash A K
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-24 00:00:00.000000000 Z
+date: 2019-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,6 +60,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - README.md
 - bin/console
@@ -71,7 +72,6 @@ files:
 - lib/ph_no_to_word/logger.rb
 - lib/ph_no_to_word/split_dictionary.rb
 - lib/ph_no_to_word/version.rb
-- lib/ph_no_to_word/word_files/dictionary.txt
 - lib/ph_no_to_word/word_files/dictionary_sample.txt
 - lib/ph_no_to_word/word_files/level_1/three_char_wrds.txt
 - lib/ph_no_to_word/word_files/level_2/aahe.txt
@@ -14350,7 +14350,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/abhilashak/ph_no_to_word
   source_code_uri: https://github.com/abhilashak/ph_no_to_word
-  changelog_uri: https://github.com/abhilashak/ph_no_to_word
+  changelog_uri: https://github.com/abhilashak/ph_no_to_word/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: