naija-faker 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f896e8cbe9b34c1baf5dc11d58acabee1127ae434fef34ff25a2e6d93aafe504
-  data.tar.gz: de802235d28a138a2bf1ccbd54fc23d46e615e5d77bde88fffcedc7cb0615739
+  metadata.gz: 292c5ba2ff172473374b07660b6ce4683cc08eafea78f306a7d49cab2b84fe85
+  data.tar.gz: 1e920310cbd75c0f20547e8fff89a93994395c975086369a8ba7b7d1d7e9e73f
 SHA512:
-  metadata.gz: 0e821fab6bb8da49f95c36cca7e020704ee654e9778535ef6627f25752729e22222f42e1c4ddd4f136f930033c91956deb6eb36e6471a21b0199deb58da9f2f8
-  data.tar.gz: 28ebcb0de3ecd40a7d223f9be1bfc7564aa368f25a378aae08289f59094a992eac19fdff1422b7b5157f9f50c8ebce493566a828b25b45553763cbbd9a08c25f
+  metadata.gz: d28dd5852a8303985cb5a047f83952350a1dc06fa572d45f5d5fecb745a32755941e1326b53264f507b0a31740fac3cb52f561f577274ce5b9a11bdb3fe0267c
+  data.tar.gz: 9239c09343c56da5173ac926b4c9be0e9ee8e008305de07098bd4566b492b4015c57d1011a0cd8b19d4aa076115fccf68a9d44833c8a3f7e3413c54481b4a071

data/README.md

@@ -0,0 +1,136 @@
+[![Build Status](https://travis-ci.com/onedebos/naija-faker-gem.svg?branch=master)](https://travis-ci.com/onedebos/naija-faker-gem)[![codecov](https://codecov.io/gh/onedebos/naija-faker-gem/branch/master/graph/badge.svg)](https://codecov.io/gh/onedebos/naija-faker-gem)
+
+# naija-faker
+
+This gem helps you generate fake Nigerian data on the fly for use in your projects.
+
+# Getting Started
+
+**To get started, follow the instructions below**
+
+- install the gem `gem install naija-faker`
+- import it in your app using:
+
+```
+ require "naija-faker"
+```
+
+- use it!
+
+```ruby
+  NaijaFaker.fname
+```
+
+# Available methods
+
+### Generate an array of people with first name, last name, age, bank and state
+
+- To generate an array of people, simply pass an `amt` value to `person_list` i.e `NaijaFaker.person_list(amt: 2)`
+- NB: Default `amt` is 5
+
+```ruby
+
+ NaijaFaker.person_list(amt: 2)
+  # outputs:
+  [
+    {:fname=> 'abdul', :lname=>'qadr', :age=>40, :email=> 'abdul.qadr@hey.com', :state=>'ekiti' },
+    {:fname=>'frank', :lname=>'edoho', :age=>23, :email=> 'frank.edoho@gmail.com', :state=>'delta' }
+  ]
+
+```
+
+### Generate a random First name or Last name
+
+- `NaijaFaker.fname //=> 'abraham'`
+- `NaijaFaker.lname //=> 'fatai`
+
+### Generate a random First name or Last name that starts with a letter/letters
+
+- `NaijaFaker.fname('r') //=> 'rahman'`
+- `NaijaFaker.lname('bo') //=> 'bolanle'`
+
+### Generate a person hash map with random values for First name, Last name and Age
+
+- **NB: Default age is between 18 - 50**
+
+```ruby
+ NaijaFaker.person
+ # outputs:
+  {
+    :fname=>'abdul', :lname=>'qadr', :age=>20,
+    :email=>'abdul.qadr@hey.com', :state=>'ekiti'
+  }
+```
+
+-- To change the default `min` and `max` values for age, pass in min and max values as an object like below.
+
+- e.g:
+
+```ruby
+  NaijaFaker.person(min:20, max:50)
+  #outputs:
+  {
+    :fname=>'abdul', :lname=>'qadr', :age=>40,
+    :email=>'abdul.qadr@hey.com', :state=>'ekiti', :bank=>'Access bank'
+  }
+
+```
+
+### Generate an array of only names
+
+- Simply pass `amt` to `name_list()` e.g
+
+  **NB: Default `amt` is 5**
+
+```
+NaijaFaker.name_list(amt: 5)
+
+```
+
+### Generate a random Nigerian state
+
+- Simply call `NaijaFaker.state //=> 'Ondo'`
+
+### Generate a bank name
+
+- Simply call `NaijaFaker.bank //=> 'Access Bank'`
+
+### Test
+
+- To run the test
+
+```ruby
+#install rspec and simplecov:
+gem install rspec
+gem install simplecov
+
+# in /lib, run
+bundle exec rspec spec/naija-faker.spec.rb
+```
+
+## Authors
+
+👤 **Adebola Adeniran**
+
+- Github: [@githubhandle](https://github.com/onedebos)
+- Twitter: [@twitterhandle](https://twitter.com/debosthefirst)
+- Linkedin: [linkedin](https://www.linkedin.com/in/adebola-niran/)
+- Web: [Adebola.dev](https://adebola.dev)
+
+## 🤝 Contributors
+
+👤 **Nikhil Chaurasia**
+
+- Github: [Github](https://github.com/nikhil-chaurasia14)
+- Linkedin: [linkedin](https://www.linkedin.com/in/nikhil-chaurasia-613755192)
+- Email: [Gmail](nikhil.chaurasia140298@gmail.com)
+
+## Show your support
+
+Give a ⭐️ if you like this project!
+
+## Acknowledgments
+
+## 📝 License
+
+This project is [MIT](lic.url) licensed.

data/lib/naija-faker.rb

@@ -1,4 +1,4 @@
-require './data/data.rb'
+require 'data.rb'
 
 class NaijaFaker
     WRONG_KEY_MESSAGE = "Did you forget to specify the key:"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: naija-faker
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Adebola Adeniran
@@ -17,9 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/data/data.rb
+- README.md
+- lib/data.rb
 - lib/naija-faker.rb
-homepage: https://rubygems.org/gems/naija-faker
+homepage: https://github.com/onedebos/naija-faker-gem
 licenses:
 - MIT
 metadata: {}