data_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da6f8c4bcc0af5d44982a6d6296ad8fa65be1f04b1d6e0a9460b98bb433d8fbe
+  data.tar.gz: 9b99db6d45fe9b88ae7b1e9bd3a98df4f02b3a9ffdbc2292eb667f998359a74d
+SHA512:
+  metadata.gz: 56fd04bc708e7e2cbb3537b31b951a5ced133a4489b9b7ac95a242722ec144313ba94f8508ffb4e29dda4d27014f9026e2b2d9eea1c21712d92455d807d20f3a
+  data.tar.gz: f3733eb3bc8a50c87e1f76c553d7119006c7a5e480f25c6492703be00e7f4f5c7a39afbdc16a5a135d218092971f55bd04194a815d86067bc38fbddf2c832d0e

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+.DS_Store
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source('https://rubygems.org')
+gemspec
+gem('rake')
+gem('rspec')

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2023 Rolando Alvarado
+
+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

@@ -0,0 +1,59 @@
+# DataParser
+
+DataParser is a simple code for parsing a json file with search capabilty for partial or full name and displaying of duplicate email if there is.
+
+NOTE: Later on it can extend to process other file type like csv, pdf, text file.
+
+## Prerequisites
+
+## Installation
+
+Install from source:
+```
+gem "data_parser", :git => "git://github.com/rolandoalvarado/data_parser.git"
+```
+
+Clone and Download the files and use it in your ruby file.
+
+NOTE: Once this is publish as gem you can install by:
+```
+gem install data_parser
+```
+
+## Usage
+
+Searching for Partial or Full Name:
+```
+path = '<json file path>'
+full_name = 'Mich'
+result = DataParser.parse(path:).process(params: { full_name: }).names
+```
+
+Showing for duplicate email:
+```
+path = '<json file path>'
+result = DataParser.parse(path:).process.emails
+```
+
+Using in a Ruby File:
+1. Add this to your code:
+  ```
+  require_relative 'lib/data_parser.rb'
+  ```
+2. Make ruby file executable
+  ```
+  chmod +x bin/data_parser_runner.rb
+  ```
+3. Execute the file:
+```
+./bin/data_parser_runner.rb
+```
+
+Running the test:
+```
+rake test
+```
+
+## License
+
+See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run the specs'
+RSpec::Core::RakeTask.new
+
+task :test => :spec

data/bin/data_parser_runner.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'json'
+require_relative '../lib/data_parser.rb'
+
+print 'Enter JSON File path: '
+
+path = gets.chomp
+extension = File.extname(path)
+
+raise "File is invalid! (#{extension.inspect})" unless extension == '.json'
+
+puts 'Enter Partial or Full Name : '
+
+full_name = gets.chomp
+
+result = DataParser.parse(path:).process(params: { full_name: }).names
+
+puts "Result : #{JSON.pretty_generate(result)}"
+
+puts 'Do you want to show duplicate email(s)? '
+
+answer = gets.chomp
+if answer&.downcase != 'yes'
+  puts 'You have not answered: `Yes`. Application is terminated! Thanks!'
+  exit
+end
+
+emails = DataParser.parse(path:).process.emails
+puts "Email that has duplicate : #{JSON.pretty_generate(emails)}"

data/data_parser.gemspec

@@ -0,0 +1,19 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'data_parser/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'data_parser'
+  s.version     = DataParser::VERSION
+  s.authors     = ['Rolando Alvarado']
+  s.email       = ['rorroland@gmail.com']
+  s.homepage    = 'https://github.com/rolandoalvarado/data_parser'
+  s.summary     = %q{Process data from a json file.}
+  s.description = %q{DataParser is a simple code for parsing a json file with search capabilty for partial or full name and showing of duplicate email if there is.}
+
+  s.rubyforge_project = 'data_parser'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/lib/data_parser/json.rb

@@ -0,0 +1,58 @@
+require 'json'
+require 'ostruct'
+
+module DataParser
+  class Json
+    attr_reader :path
+
+    def initialize(path:)
+      raise DataParser::PathMissing if path.nil?
+      raise DataParser::FileNotFound unless File.exists?(path)
+
+      @path = path
+    end
+
+    def process(params: {})
+      raise DataParser::EmptyString if params.empty? && params.is_a?(String)
+
+      names = []
+      emails = []
+      file = File.read(path)
+      search_string = params[params.keys.first.to_sym] if params && params.keys.any?
+
+      json_data(file:).each do |data|
+        data.map do |key, value|
+          if matching_name?(key:, search_string:, full_name: value)
+            names << data
+          elsif key == 'email'
+            emails << value
+          end
+        end
+      end
+
+      OpenStruct.new(names:, emails: get_duplicates(array: emails))
+    end
+
+    private
+
+    def matching_name?(key:, search_string:, full_name:)
+      key == 'full_name' && search_for(search_string:, value: full_name)
+    end
+
+    def get_duplicates(array:)
+      duplicates = []
+      array.each do |element|
+        duplicates << element if array.count(element) > 1
+      end
+      duplicates.uniq
+    end
+
+    def search_for(search_string:, value:)
+      value =~ /^#{search_string}/i
+    end
+
+    def json_data(file:)
+      @json_data ||= JSON.parse(file)
+    end
+  end
+end

data/lib/data_parser/version.rb

@@ -0,0 +1,3 @@
+module DataParser
+  VERSION = '0.1.0' unless defined?(::DataParser::VERSION)
+end

data/lib/data_parser.rb

@@ -0,0 +1,25 @@
+require_relative 'data_parser/json.rb'
+
+module DataParser
+  extend self
+
+  # Default exception class for DataParser.
+  class Exception < ::StandardError
+  end
+
+  # Exception that is raised if file is not found.
+  class FileNotFound < DataParser::Exception
+  end
+
+  # Exception that is raised if path is empty.
+  class PathMissing < DataParser::Exception
+  end
+
+  # Exception that is raised if param is an empty string.
+  class EmptyString < DataParser::Exception
+  end
+
+  def self.parse(path:)
+    DataParser::Json.new(path:)
+  end
+end

data/spec/data/clients.json

@@ -0,0 +1,72 @@
+[
+  {
+    "id": 2,
+    "full_name": "Jane Smith",
+    "email": "jane.smith@yahoo.com"
+  },
+  {
+    "id": 3,
+    "full_name": "Alex Johnson",
+    "email": "alex.johnson@hotmail.com"
+  },
+  {
+    "id": 4,
+    "full_name": "Michael Williams",
+    "email": "michael.williams@outlook.com"
+  },
+  {
+    "id": 5,
+    "full_name": "Emily Brown",
+    "email": "emily.brown@aol.com"
+  },
+  {
+    "id": 6,
+    "full_name": "William Davis",
+    "email": "william.davis@icloud.com"
+  },
+  {
+    "id": 7,
+    "full_name": "Olivia Miller",
+    "email": "olivia.miller@protonmail.com"
+  },
+  {
+    "id": 8,
+    "full_name": "James Wilson",
+    "email": "james.wilson@yandex.com"
+  },
+  {
+    "id": 9,
+    "full_name": "Ava Taylor",
+    "email": "ava.taylor@mail.com"
+  },
+  {
+    "id": 10,
+    "full_name": "Michael Brown",
+    "email": "michael.brown@inbox.com"
+  },
+  {
+    "id": 11,
+    "full_name": "Sophia Garcia",
+    "email": "sophia.garcia@zoho.com"
+  },
+  {
+    "id": 12,
+    "full_name": "Emma Lopez",
+    "email": "emma.lopez@protonmail.ch"
+  },
+  {
+    "id": 13,
+    "full_name": "Liam Martinez",
+    "email": "liam.martinez@fastmail.fm"
+  },
+  {
+    "id": 14,
+    "full_name": "Isabella Rodriguez",
+    "email": "isabella.rodriguez@me.com"
+  },
+  {
+    "id": 15,
+    "full_name": "Another Jane Smith",
+    "email": "jane.smith@yahoo.com"
+  }
+]

data/spec/lib/data_parser/json_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+RSpec.describe DataParser::Json do
+  subject { described_class.new(path:) }
+
+  let(:path) { data_path('clients.json') }
+
+  describe '#initialize' do
+    context 'with arguments' do
+      it 'initializes arguments and responds to a method' do
+        expect(subject).to respond_to(:process)
+      end
+    end
+
+    context 'with no arguments' do
+      it 'raises ArgumentError' do
+        expect { described_class.new({}) }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'when path is empty' do
+      it 'raises DataParser::PathMissing' do
+        expect { described_class.new(path: nil) }.to raise_error(DataParser::PathMissing)
+      end
+    end
+
+    context 'when file does not exists' do
+      let(:path) { data_path('client.json') }
+
+      it 'raises DataParser::FileNotFound' do
+        expect { described_class.new(path:) }.to raise_error(DataParser::FileNotFound)
+      end
+    end
+  end
+
+  describe '.process' do
+    context 'when param is an emptry string' do
+      it 'raises DataParser::EmptyString' do
+        expect { subject.process(params: '') }.to raise_error(DataParser::EmptyString)
+      end
+    end
+
+    context 'when searching for partially matching name' do
+      let(:full_name) { 'Mich' }
+
+      it 'returns an array of matching names' do
+        expect(subject.process(params: { full_name: }).names).to eq(
+          [
+            {
+              'email' => 'michael.williams@outlook.com',
+              'full_name' => 'Michael Williams',
+              'id' => 4
+            },
+            {
+              'email' => 'michael.brown@inbox.com',
+              'full_name' => 'Michael Brown',
+              'id' => 10
+            }
+          ]
+        )
+      end
+    end
+
+    context 'with duplicate emails' do
+      it 'returns an array of emails having duplicate' do
+        expect(subject.process.emails).to eq(%w(jane.smith@yahoo.com))
+      end
+    end
+  end
+end

data/spec/lib/data_parser_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe DataParser do
+  subject { DataParser.parse(path:) }
+
+  let(:path) { data_path('clients.json') }
+
+  it 'does have a VERSION constant' do
+    expect(DataParser.const_defined?('VERSION')).to be(true)
+  end
+
+  describe '.parse' do
+    it 'returns an instance of DataParser::Json' do
+      expect(DataParser.parse(path: data_path('clients.json')).class).to eq(DataParser::Json)
+    end
+  end
+
+  describe '.process' do
+    context 'when searching for partially matching name' do
+      let(:full_name) { 'Mich' }
+
+      it 'returns an array of matching names' do
+        expect(subject.process(params: { full_name: }).names).to eq(
+          [
+            {
+              'email' => 'michael.williams@outlook.com',
+              'full_name' => 'Michael Williams',
+              'id' => 4
+            },
+            {
+              'email' => 'michael.brown@inbox.com',
+              'full_name' => 'Michael Brown',
+              'id' => 10
+            }
+          ]
+        )
+      end
+    end
+
+    context 'with duplicate emails' do
+      it 'returns an array of emails having duplicate' do
+        expect(subject.process.emails).to eq(%w(jane.smith@yahoo.com))
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+require 'benchmark'
+require 'rubygems'
+require 'bundler/setup'
+require 'rbconfig'
+
+require 'data_parser'
+
+module FileHelpers
+  def dimensions_for_path(path)
+    width, height = `identify -format '%wx%h' #{path}`.strip.split('x').map(&:to_f)
+  end
+
+  def data_path(name)
+    path = File.expand_path('./spec/data/')
+    File.join(path, name)
+  end
+
+  def tmp_dir
+    path = File.expand_path('./tmp')
+    Dir.mkdir(path) unless File.directory?(path)
+    path
+  end
+
+  def tmp_path(name)
+    File.join(tmp_dir, name)
+  end
+end
+
+RSpec.configure do |config|
+  config.include(FileHelpers)
+  config.filter_run_excluding :windows => true if RbConfig::CONFIG['host_os'].match(/mswin|mingw|cygwin/) == nil
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: data_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rolando Alvarado
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-07 00:00:00.000000000 Z
+dependencies: []
+description: DataParser is a simple code for parsing a json file with search capabilty
+  for partial or full name and showing of duplicate email if there is.
+email:
+- rorroland@gmail.com
+executables:
+- data_parser_runner.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/data_parser_runner.rb
+- data_parser.gemspec
+- lib/data_parser.rb
+- lib/data_parser/json.rb
+- lib/data_parser/version.rb
+- spec/data/clients.json
+- spec/lib/data_parser/json_spec.rb
+- spec/lib/data_parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rolandoalvarado/data_parser
+licenses: []
+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: []
+rubygems_version: 3.4.5
+signing_key:
+specification_version: 4
+summary: Process data from a json file.
+test_files: []