masterdata 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8c3b2f7f046f6f22bcf237ba1ac1543e2ca01348a2cc371001356e91f3b1551
-  data.tar.gz: 866ab593a137cec9ef77e63d05d0bf99a100d11b61e0e2e6674939d5f20ed6f8
+  metadata.gz: 9a0441dbc3071e81eff2d232ab04b5be53c3c1e5646776d498acecfff4403290
+  data.tar.gz: 31b6d927a439aebf36ef65e0ffca5da8599ef9b8ac40ce09dc6b0168a3f42801
 SHA512:
-  metadata.gz: e8e996d0166d6a6d17d9ca6a53a543ebd13c5aea4ae6ebd3b8b23ddbba8272cc1ebc717f6ab8f373909dea780479a05ebc909b981042a39a5b4ea9d17119dc55
-  data.tar.gz: 3a814e22590a8ed808cb681a0d9e42fc1b2c0181dc6be566cc63855cdb3732c218e5d4f339c3a631a1f5499b5caefd8479ff34b3aa4beb5740279e2a308cf56f
+  metadata.gz: b83c0cf178bff016ba477ca169b9540b617fd1ae4dde15f54f66b4aabd048e41ae450f173219fa70b87465fa871f7fb032a433b7cfef811256ba9dc529a3fc72
+  data.tar.gz: 1865f560581832c2c922a730e705de9e739b5f3e4c6e2fa888d60a96cadc81689adafe36496ee71484d080c34e08b5a4a252f6acecbb809d0ed128c415db1ef8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    masterdata (0.4.0)
+    masterdata (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,5 @@
-# Masterdata
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/masterdata`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+# MasterData
+masterdata  mostly used for validations of countrycodes, country, states, countrydailcode, contactnumbers, pincodes and emailaddress which can be helpful for data preprocessing. Along with this something special is that gaining the information from country/countrycodes/countrydailcodes.Lets look the more about the functions of how to master the data from a csv table.
 
 ## Installation
 
@@ -20,9 +17,117 @@ Or install it yourself as:
 
     $ gem install masterdata
 
-## Usage
+There are few functions which we can operate on table columns or symbolized hash data .the following are list of functions..
+
+* read_csv        
+* val_countrystate
+* val_dailcode
+* val_pincode
+* val_contactnumber
+* val_emailaddress
+* infogain_country
+* infogain_countrycode
+* infogain_countrydialcode
+* update_columns
+* validate_abbrevate_countrycodes
+
+## Note:
+*  Masterdata can deal with csv data or Symbolized hash data
+* "N" for null value
+* "I" for invalid
+
+
+### Read csv file :
+Read the csv file just by providing the link to the function and get the table in the form of symbol hash data. if columns have any null values it will be written as "N"(null value)
+
+csv file : foo.csv
+```
+------------------------------------------=-
+! Country      ! DailCode    ! CountryCode !
+!------------==!-------------!-------------!
+! India        ! +91         ! IN          !
+!--------------!-------------!-------------!
+! United States! +1          | US          !
+--------------------------------------------
+```
+```RUBY
+# provide link of csv file 
+Masterdata::read_csv("C:\\user\\foo.csv")
+# symbolized hash data
+{:country=>[India,United States],:dialcode=>["91","1"],:countrycode=>["IN","US"]}
+# if you observe above columns are converted to lowercase by default in ruby for symbolized hash
+```
+### validate country and state
+Assume you have two columns of country and state for validation one more argument is passed along  which is country code ["IN","US"].
+pass three arguments 
+* csv symbolized hash data
+* Array of country and state
+* countrycode column
+```ruby
+#country = ["India","United states"]
+#states = ["Delhi","Tokyo"]
+#countrycode = ["IN","US"]
+Masterdata::val_countrystate(csv_sym_hash_data,["country","states"],"countrycode")
+# => [["India","United states"],["Delhi","I"]] 
+# "I" for invalid
+```
+### validate country dailcode
+Validate countries dial codes of a csv column 
+```ruby
+# dialcode=["91","1","zz","0"]
+Masterdata::val_dialcode(csv_sym_hash_data,"dialcode")
+# => ["+91","+1","I","I"]
+# "I" for invalid
+```
+### validate country pincode
+To validate the pincode it require columns pincode and countrycode because to validate the pincode its depends on country
+```ruby
+# countrycode = ["IN","ZZ"]
+# dialcode = ["505325","505321"]
+Masterdata::val_dialcode(pincode,countrycode)
+# ["505325","I"]
+# "I" for invalid
+```
+
+### validate phone numbers
+validate contacts based on countries
+```ruby
+# contactnumber = ["+91779398005","+16505130514"] 
+# countrycode = ["IN","US"]
+Masterdata::val_contactnumber(contactnumber,countrycode)
+# => ["I","+16505130514"]
+# "I" for invalid
+```
+
+### validate email address
+
+```ruby
+emailaddress = ["chishu@gmail.com","john@yahoo.co.uk","steve@mail"]
+Masterdata::val_emailaddress(emailaddress)
+# => ["chishu@gmail.com","john@yahoo.co.uk","I"]
+# "I" for invalid 
+```
+### Gain the information 
+Gain the information just by proving any columns like countrycode or country or countrydialcode. In the (infogain_countrydialcode) function just provide dialcode without "+" symbol 
+
+```ruby 
+# give countrycode ["IN"] and get country & dialcode ["India", "+91"]  
+Masterdata::infogain_countrycode(csv_sym_hash_data,"countrycode") 
+# give ["India"] and get countrycode & dialcode ["IN", "+91"]
+Masterdata::infogain_country(csv_sym_hash_data,"country") 
+# give ["91"] and get country and countrycode ["India", "IN"]                  
+Masterdata::infogain_countrydialcode(csv_sym_hash_data,"countrydialcode")  
+```
+
+### Validate countrycodes and abrrevate
+validate countrycode column which return proper countrycodes and get bonus with abbrevated countrynames
+
+```ruby
+# countrycode = ["IN","US","z"]
+Masterdata::validate_abbrevate_countrycodes(csv_sym_hash_data,"countrycode")
+# => [["IN","US","I"] , ["India","United States","N"]]
+```
 
-TODO: Write usage instructions here
 
 ## Development
 
@@ -32,12 +137,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/masterdata. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/masterdata/blob/master/CODE_OF_CONDUCT.md).
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/sairam6267/masterdata. This project is intended to be a safe, welcoming space for collaboration.
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Masterdata project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/masterdata/blob/master/CODE_OF_CONDUCT.md).

data/lib/masterdata/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Masterdata
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/masterdata.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["sairam160305@gmail.com"]
 
   spec.summary       = "https://github.com/sairam6267/masterdata"
-  spec.description   = "This gem is under development"
+  spec.description   = "masterdata  mostly used for validations of countrycodes, country, states, countrydailcode, contactnumbers, pincodes and emailaddress which can be helpful for data preprocessing. Along with this something special is that gaining the information from country/countrycodes/countrydailcodes.Lets look the more about the functions of how to master the data from a csv table."
   spec.homepage      = "https://github.com/sairam6267/masterdata"
   spec.license       = "MIT"
   spec.required_ruby_version = ">= 2.4.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: masterdata
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - sairam6267
@@ -10,7 +10,11 @@ bindir: exe
 cert_chain: []
 date: 2022-01-16 00:00:00.000000000 Z
 dependencies: []
-description: This gem is under development
+description: masterdata  mostly used for validations of countrycodes, country, states,
+  countrydailcode, contactnumbers, pincodes and emailaddress which can be helpful
+  for data preprocessing. Along with this something special is that gaining the information
+  from country/countrycodes/countrydailcodes.Lets look the more about the functions
+  of how to master the data from a csv table.
 email:
 - sairam160305@gmail.com
 executables: []