pings_fast_track_gem 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07d5ebcc2f047fb5ed3a46e0be7998501dea3df8f7084c9e895963003ef21148
-  data.tar.gz: 608ea2530f1dece52cf4304e632074680fcfdf3ec6006b162c2792e308ee4828
+  metadata.gz: f3e083ad16f1e4b337afc7324ac95b779bc59b65b0eadeea64bbbdf82876da0c
+  data.tar.gz: ad5c934acd0349bf97861cc8933039fef1d2f83e503b6848cc7b61f87f1aa520
 SHA512:
-  metadata.gz: aaa4f957a604e63b2566c6f5b3b8a02128d814a99e0c9ae2f2d1ba7d3c7c851e2eff2ec5f45a1abe712c1b60ea6a925728b5f5f9bdffb8002af4082732d8bcf4
-  data.tar.gz: 424eb335a1e442ad232f0e7426a5c1efdd1a932f6db6b47ad52f8adfe8e6e8c4f4f1b3ecafc73c98f93ba1fd9a86e617520ab2c97a9e7208852a2acd40ad372b
+  metadata.gz: 51933596aa218f11a9a3f984b75dad6ed518f58e2f28056aac707ccf6887fc3ac3215dc09258aeb0795c134cb51f43efb414342cbad0f397a0d9cae4e1db9420
+  data.tar.gz: 99bbe0ff1f116741ea424e26b911406e856994705fb67c118c7cfdfed8b2ad692022d14033911bc7bc93b475ddfa7c29791d1f60fb28f099ec52efffe0bcb86b

data/Gemfile

@@ -4,3 +4,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 12.0"
+gem 'colorize', '~> 0.8.1'
+gem 'tty-prompt', '~> 0.21.0'
+gem 'pastel', '~> 0.7.3'
+gem 'artii', '~> 2.1', '>= 2.1.2'

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    pings_fast_track_gem (0.1.1)
+      artii (~> 2.1, >= 2.1.2)
+      colorize (~> 0.8.1)
+      lolcat (~> 42.24)
+      pastel (~> 0.7.3)
+      tty-prompt (~> 0.21.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    artii (2.1.2)
+    colorize (0.8.1)
+    equatable (0.6.1)
+    lolcat (42.24.1)
+      paint (~> 2.0.0)
+      trollop (~> 2.1.2)
+    necromancer (0.5.1)
+    paint (2.0.3)
+    pastel (0.7.3)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    rake (12.3.3)
+    trollop (2.1.3)
+    tty-color (0.5.1)
+    tty-cursor (0.7.1)
+    tty-prompt (0.21.0)
+      necromancer (~> 0.5.0)
+      pastel (~> 0.7.0)
+      tty-reader (~> 0.7.0)
+    tty-reader (0.7.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.7)
+      wisper (~> 2.0.0)
+    tty-screen (0.7.1)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  artii (~> 2.1, >= 2.1.2)
+  colorize (~> 0.8.1)
+  lolcat (~> 42.24)
+  pastel (~> 0.7.3)
+  pings_fast_track_gem!
+  rake (~> 12.0)
+  tty-prompt (~> 0.21.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,10 +1,93 @@
-# PingsFastTrackGem
+# Roster App
+
+## Software Development Plan
+
+### Purpose
+The purpose of the roster app is provide users with a tool create employee profiles and assign roster to their employees.
+
+The main target audience for this app is managers and small business owners who will be able to keep track of their employee's shift. Many managers and small owners still tracks their employee and assign shift through paper documents. Paper documents are convenient to use but they take up physical space and can easily be misplaced or sabotage by others. The roster app will provide users with a simple and interactive prompt to input data and store in a csv file for further use. The roster app will solve a lot of employer issue when hiring as they can quickly create an employee profile, input basic details about the employee which they return to change at will.
+
+### Features
+There are two main feature for this app, the ability to create new employee profile and assigning shifts to employee. The user will be able to create many employee profile which will be store in a csv file, the user can then update any existing employee profile to change any original value that they assigned to the employee. 
+The second main feature of the app is to provide the user with the ability to assign shift to employee which will be saved to a separate cv file which store all the shift that they assigned for their employee. The other feature of the app to show a quick list all employee or shift by simply selecting the correct prompts from menu.
+
+Menu page:
+  <ul>
+  <li> Create employee profile</li>
+    ==> asking user for input about the employee
+    ==> first name, last name, age and gender
+  <li> Update employee profile </li>
+    ==> confirm which employee they want to change
+      => ask which part of the data they want to change like first name, last name, age or gender
+   <li> Assign Shift </li>
+    ==> asking user to select the day, input name, start time and end time
+  <li> View all employee profiles  </li>
+    ==> print out data about existing in the terminal
+  <li> View all shifts </li>
+    ==> print out data about existing shift in the terminal
+</ul>
+    
+### UML
+
+![UML Diagram](./docs/uml)
+
+### Resources
+[My app building process](https://trello.com/b/eLUrMcdd/terminal-app)
+[UML Diagram](https://www.lucidchart.com/invitations/accept/98b1f7c4-8408-42c2-a2bf-3874764834fa)
 
-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/pings_fast_track_gem`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Usage
+
+### Installing Ruby
+
+### Mac OS:
+
+1: You will need to install ruby on your mac os
+
+I recommend using a package manager like homebrew
+
+you can run the the following command on your terminal (to access terminal, you can search terminal in finder with cmd + space  and type 'terminal' in the prompt)
+
+    $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+
+
+Use the homebrew to install rbenv through the following command in terminal
+
+    $ brew install rbenv
+
+Set up rbenv
 
-TODO: Delete this and the text above, and describe your gem
+    $rbenv init
 
-## Installation
+Close your terminal window and one a new one (for your changes to take effect)
+Verify that rbenv is setup properly by running the rbenv-doctor script
+$ If there are no errors you are ready to go. You should see something like the following output,
+
+  Checking for `rbenv' in PATH: /usr/local/bin/rbenv
+  Checking for rbenv shims in PATH: OK
+  Checking `rbenv install' support: /usr/local/bin/rbenv-install (ruby-build 20170523)
+  Counting installed Ruby versions: none
+  There aren't any Ruby versions installed under `~/.rbenv/versions'.
+  You can install Ruby versions like so: rbenv install 2.2.4
+  Checking RubyGems settings: OK
+  Auditing installed plugins: OK
+
+Install Ruby 2.7.0
+Pease run the following command
+
+    $ rbenv install 2.7.0
+
+check to make sure you are on 2.7.0
+
+    $ ruby --version 
+
+## Window
+It is recommended to use Mac os for ruby however you can install ruby with the rubyinstaller
+
+    $https://rubyinstaller.org/
+
+follow the instruction from the website
+
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -14,15 +97,16 @@ gem 'pings_fast_track_gem'
 
 And then execute:
 
-    $ bundle install
+    $ bundle install pings_fast_track_gem
 
 Or install it yourself as:
 
     $ gem install pings_fast_track_gem
+    $ gem install tty-prompt
+    $ gem install pastel
+    $ gem install colorize
+    $ gem install artii
 
-## Usage
-
-TODO: Write usage instructions here
 
 ## Development
 

data/bin/setup

@@ -5,4 +5,4 @@ set -vx
 
 bundle install
 
-# Do any other automated setup that you need to do here
+# Do any other automated setup that you need to do here

data/lib/Class.rb

@@ -0,0 +1,22 @@
+class Employee
+attr_accessor :first_name, :last_name, :age, :gender
+  def initialize(f_name, l_name, age, gender)
+    @first_name = f_name
+    @last_name = l_name
+    @age = age
+    @gender = gender
+  end
+  def to_a
+    [@first_name, @last_name, @age, @gender]
+  end
+end
+
+class Shift
+attr_accessor :day, :name, :s_time, :e_time
+  def initialize(day, name, s_time, e_time)
+    @day  = day
+    @name = name
+    @start_time = s_time
+    @end_time = e_time
+  end
+end

data/lib/database.csv

@@ -0,0 +1,16 @@
+First Name,Last Name,Age,Gender
+Serge,Terreu,31,Male
+Rob,Thomas,31,Male
+Jones,Geris,56,Male
+Daniel,Ask,30,Male
+Harrison,Malone,26,Malone
+Justin,Flash,30,Male
+Ed,Deam,31,Male
+Kuan,Lee,28,Male
+Tom,An,23,Male
+James,Bos,18,Female
+Guy,Jones,19,Male
+Jones,Frost,30,Male
+Susu,Fung,26,Female
+Joe,Sam,65,Male
+Ping,Nge,27,Male

data/lib/menu.rb

@@ -0,0 +1,70 @@
+require 'artii'
+require 'tty-prompt'
+require 'pastel'
+require 'csv'
+require 'colorize'
+require_relative './Class'
+require_relative './methods'
+String.disable_colorization = false
+
+
+$artii = Artii::Base.new
+$pastel = Pastel.new
+
+def read_employee_csv
+  csv_text = File.read('./database.csv')
+  csv = CSV.parse(csv_text, headers: true)
+  csv.map do |employee|
+    employee_hash = employee.to_hash
+    Employee.new(employee_hash["First Name"], employee_hash["Last Name"], employee_hash["Age"], employee_hash["Gender"])
+  end 
+end
+def read_shifts_csv
+  csv_text = File.read('./shift.csv')
+  csv = CSV.parse(csv_text, headers: true)
+  csv.map do |shift|
+    shift_hash = shift.to_hash
+    Shift.new(shift_hash["Day"], shift_hash["Name"], shift_hash["Start Time"], shift_hash["End Time"])
+  end 
+end
+
+def menu(employee, shift)
+  prompt = TTY::Prompt.new
+  system("clear")
+  puts $artii.asciify('Roster App').colorize(:black).colorize( :background => :green)
+
+  puts "**" * 27
+  puts $pastel.bright_red.bold('Welcome to the roster app')
+  puts "**" * 27
+  loop do
+    user_selection = prompt.select('Please select from the following options', active_color: :bright_blue) do |menu|
+      menu.choice 'Create New Employee', 1
+      menu.choice 'Update Existing Profile', 2
+      menu.choice 'Assign Shifts', 3
+      menu.choice 'View Employee Profile', 4
+      menu.choice 'View Existing Shift', 5
+      menu.choice 'Exit Application', 6
+    end
+
+    case user_selection
+    when 1
+      create_profile
+    when 2
+      update_profile(employee)
+    when 3
+      add_shift
+    when 4
+      pp employee
+    when 5
+      pp shift
+    when 6
+      puts "**" * 27
+      puts $pastel.bright_red.bold("Thank you for using our service")
+      puts "**" * 27
+      exit
+    end
+  end
+end
+
+
+menu(read_employee_csv, read_shifts_csv)

data/lib/methods.rb

@@ -0,0 +1,137 @@
+require 'artii'
+require 'tty-prompt'
+require 'pastel'
+require 'csv'
+require 'colorize'
+require_relative './menu'
+String.disable_colorization = false
+$prompt = TTY::Prompt.new(active_color: :bright_red)
+
+def create_profile
+  system "clear"
+  puts $artii.asciify('Create Profile').colorize(:black).colorize( :background => :green)
+  puts "**" * 27
+  puts $pastel.bright_red.bold('Creating profile')
+  puts "**" * 27
+  f_name = $prompt.ask("Enter first name:") do |q|
+    q.required(true)
+    q.validate /\A\w+\Z/
+    q.modify   :capitalize
+  end
+
+  l_name = $prompt.ask("Enter last name:") do |q|
+    q.required(true)
+    q.validate /\A\w+\Z/
+    q.modify   :capitalize
+  end
+
+  age = $prompt.ask("Enter age:")
+
+  gender = $prompt.ask("Enter gender") do |q|
+    q.required(true)
+    q.validate /\A\w+\Z/
+    q.modify   :capitalize
+  end
+
+  CSV.open("./database.csv", "ab") do |csv|
+    csv << [f_name, l_name, age, gender]
+  end 
+end
+
+def update_profile(employees)
+  system "clear"
+  puts $artii.asciify('Update Profile').colorize(:black).colorize( :background => :green)
+  puts "**" * 27
+  puts $pastel.bright_red.bold('Updating Profile')
+  puts "**" * 27
+  name_input = $prompt.ask("Which employee profile would you like to update?") do |q|
+    q.required(true)
+    q.validate /\A\w+\Z/
+    q.modify   :capitalize
+  end
+  found = employees.detect do |employee|
+  employee.first_name == name_input
+  end
+
+  if found
+  selection = $prompt.select('Please select from the following options', active_color: :bright_green) do |menu|
+    menu.enum "."
+    menu.choice 'Update First Name', 1
+    menu.choice 'Update Last Name', 2
+    menu.choice 'Update Age', 3
+    menu.choice 'Update Gender', 4
+  end
+    case selection
+      when 1
+      user_input = $prompt.ask("Enter new first name:") do |q|
+        q.required(true)
+        q.validate /\A\w+\Z/
+        q.messages[:valid?] = 'invalid input'
+        q.modify   :capitalize
+      end
+      found.first_name = user_input
+      when 2
+      user_input = $prompt.ask("Enter new last name:") do |q|
+        q.required(true)
+        q.validate /\A\w+\Z/
+        q.messages[:valid?] = 'invalid input'
+        q.modify   :capitalize
+      end
+      found.last_name = user_input
+      when 3
+      user_input = $prompt.ask("Enter new age:") do |q|
+        q.required(true)
+        q.validate /\A\w+\Z/
+      end
+      found.age = user_input
+      when 4
+      user_input = $prompt.ask("Enter new gender:") do |q|
+        q.required(true)
+        q.validate /\A\w+\Z/
+        q.messages[:valid?] = 'invalid input'
+        q.modify   :capitalize
+      end
+      found.gender = user_input
+    end
+    write_csv(employees) 
+  else 
+    puts "employee not found"
+  end
+end
+
+def write_csv(employees)
+ CSV.open "./database.csv", "w" do |file|
+  file << ['First Name','Last Name','Age','Gender']
+  employees.each do |employee|
+  file << employee.to_a
+  end
+ end
+end
+
+def add_shift
+  system "clear"
+  puts $artii.asciify('Assign Shift').colorize(:black).colorize( :background => :green)
+  puts "**" * 27
+  puts $pastel.bright_red.bold('Assigning Shift')
+  puts "**" * 27
+  days = ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']
+  day = $prompt.select("Please select a day:", days, filter: true, active_color: :bright_green)
+
+  name = $prompt.ask('Please input the name of the employee:') do |q|
+    q.required(true)
+    q.validate /\A\w+\Z/
+    q.messages[:valid?] = 'invalid input'
+    q.modify   :capitalize
+  end
+
+  times = [
+    '12:00am', '1:00am', '2:00am', '3:00am', '4:00am', '5:00am', '6:00am', '7:00am', '8:00am', '9:00am', '10:00am', '11:00am', '12:30am', '1:30am', '2:30am', '3:30am', '4:30am', '5:30am', '6:30am', '7:30am', '8:30am', '9:30am', '10:30am', '11:30am', '12:00pm', '1:00pm', '2:00pm', '3:00pm', '4:00pm', '5:00pm', '6:00pm', '7:00pm', '8:00pm', '9:00pm', '10:00pm', '11:00pm', '12:30pm', '1:30pm', '2:30pm', '3:30pm', '4:30pm', '5:30pm', '6:30pm', '7:30pm', '8:30pm', '9:30pm', '10:03pm', '11:30pm'
+  ]
+  s_time = $prompt.select('Please select start time:', times, filter: true)
+
+  e_time = $prompt.select('Please select end time:', times, filter: true)
+
+  CSV.open("./shift.csv", "ab") do |csv|
+    csv << [day, name, s_time, e_time]
+  end
+end

data/lib/pings_fast_track_gem.rb

@@ -1,6 +1,6 @@
-require "pings_fast_track_gem/version"
+require_relative "./menu"
 
 module PingsFastTrackGem
   class Error < StandardError; end
   # Your code goes here...
-end
+end

data/lib/pings_fast_track_gem/version.rb

@@ -1,3 +1,5 @@
+
 module PingsFastTrackGem
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end
+

data/lib/shift.csv

@@ -0,0 +1,13 @@
+Day,Name,Start Time,End Time
+Monday,Ping,9:00am,5:00pm
+Monday,Rob,9:00am,5:00pm
+Tuesday,Josh,9:00am,5:00pm
+Tuesday,Serge,9:00am,5:00pm
+Tuesday,Ping,10:00am,6:00pm
+Wednesday,Rob,12:00pm,8:00am
+Wednesday,Ping,9:00am,5:00pm
+Thursday,Ping,9:00am,5:00pm
+Friday,Ping,9:00am,5:00pm
+Saturday,Ping,9:00am,5:00pm
+Sunday,Ping,9:00am,5:00pm
+Monday,Jo,12:00am,12:00am

data/pings_fast_track_gem.gemspec

@@ -26,4 +26,8 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-end
+  spec.add_dependency 'colorize', '~> 0.8.1'
+  spec.add_dependency 'tty-prompt', '~> 0.21.0'
+  spec.add_dependency 'artii', '~> 2.1', '>= 2.1.2'
+  spec.add_dependency 'pastel', '~> 0.7.3'
+end

metadata

@@ -1,15 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: pings_fast_track_gem
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - PING NGE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-10 00:00:00.000000000 Z
-dependencies: []
+date: 2020-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: artii
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
 description: A rostering app
 email:
 - ping.nge@hotmail.com
@@ -17,16 +79,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- lib/.DS_Store
+- lib/Class.rb
+- lib/database.csv
+- lib/menu.rb
+- lib/methods.rb
 - lib/pings_fast_track_gem.rb
 - lib/pings_fast_track_gem/version.rb
+- lib/shift.csv
 - pings_fast_track_gem.gemspec
 homepage: https://github.com/ping-n/Fast-track-Gem.git
 licenses: