Merge pull request #11 from DAMMAK/add-new-feature

Add new feature

Author: DAMMAK

CHANGELOG.md

@@ -7,3 +7,6 @@
 - Add object to json feature
 
 ## [1.0.1]
+- Update the documentation
+- Add get PostComments feature
+- Add get UserPosts feature

README.md

@@ -1,19 +1,19 @@
 # jsonplaceholder_offline
 
-A simple JsonPlaceholder https://jsonplaceholder.typicode.com/  offline package that allows you to get data for your flutter project on the go without relying on the network
+A simple package that allows you to get data for your project on the go without relying on the network
 ## Installation
 Add this to your package's pubspec.yaml file
 
 ```dart
 dependencies:
-    jsonplaceholder_offline:0.0.1
+    jsonplaceholder_offline: 1.0.1
 ```
 and run
 ```dart
 flutter packages get
 ```
 ## How it work
-The package is offline version of https://jsonplaceholder.typicode.com/ JsonPlaceholder.
+The package is offline version of[JsonPlaceholder](https://jsonplaceholder.typicode.com)
 Jsonplaceholder has 6 different data categories:
 - User
 - Post
@@ -34,7 +34,7 @@ you can get data in two format either object or json.
   # Usage
 
   ## Getting Object data
-  ### list of Users
+### list of Users
 ```dart
       JsonPlaceholder jsonPlaceholder = JsonPlaceholder();
       List<User> users = jsonPlaceholder.getData<User>(length: 20);
@@ -47,14 +47,36 @@ you can get data in two format either object or json.
 ```
 
 ## Getting Json data
- ### list of users data
+### list of users data
 ```dart
       JsonPlaceholder jsonPlaceholder = JsonPlaceholder();
-      List<Map<String,dynamic>> users = jsonPlaceholder.getJsonData<User>(length: 20);
+      List<Map<String, dynamic>> users = jsonPlaceholder.getJsonData<User>(length: 20);
 ```
 ### a single User json
 
 ```dart
       JsonPlaceholder jsonPlaceholder = JsonPlaceholder();
-      Map<String,dynamic> user = jsonPlaceholder.getJsonData<User>(length:1);
-```
+      Map<String, dynamic> user = jsonPlaceholder.getJsonData<User>(length:1);
+```
+### Get UserPost by userId
+
+```dart
+ JsonPlaceholder jsonPlaceholder = JsonPlaceholder();
+      List<dynamic> comments =
+          jsonPlaceholder.getUserPosts(userId: 1, toJson: false);
+```
+***NB:** `toJson` property can be set to true if you want the return data to be in JSON format*
+
+### Get PostComment by postId
+
+```dart
+ JsonPlaceholder jsonPlaceholder = JsonPlaceholder();
+      List<dynamic> comments =
+          jsonPlaceholder.getUserPosts(postId: 1, toJson: false);
+```
+***NB:** `toJson` property can be set to true if you want the return data to be in JSON format*
+
+
+
+
+**Data credit:** https://jsonplaceholder.typicode.com/

lib/exception/placeholder_exception.dart

@@ -1,6 +1,7 @@
 library jsonplaceholder_offline;
 
 import 'dart:math';
+import 'package:flutter/material.dart';
 import 'package:jsonplaceholder_offline/models/album.dart';
 import 'package:jsonplaceholder_offline/models/comment.dart';
 import 'package:jsonplaceholder_offline/models/data.dart';
@@ -17,7 +18,7 @@ class JsonPlaceholder {
     data = loadData();
   }
 
-  dynamic getData<T>({int length}) {
+  dynamic getData<T>({@required int length, toJson = false}) {
     List<dynamic> dataComments = data['comments'];
     List<dynamic> dataAlbums = data['albums'];
     List<dynamic> dataUsers = data['users'];
@@ -220,4 +221,26 @@ class JsonPlaceholder {
         throw ("Invalid object type");
     }
   }
+
+  List<dynamic> getPostComments({@required int postId, bool toJson = false}) {
+    if (postId == null || postId == 0) return throw ("provide a valid postId");
+    List<dynamic> comments = List<dynamic>();
+    List<dynamic> dataComments = data['comments'];
+    dataComments.forEach((_comment) {
+      if (_comment["postId"] == postId)
+        comments.add(toJson == false ? Comment.fromJson(_comment) : _comment);
+    });
+    return comments;
+  }
+
+  List<dynamic> getUserPosts({@required int userId, bool toJson = false}) {
+    if (userId == null || userId == 0) return throw ("provide a valid UserId");
+    List<dynamic> posts = List<dynamic>();
+    List<dynamic> dataPosts = data['posts'];
+    dataPosts.forEach((_post) {
+      if (_post["userId"] == userId)
+        posts.add(toJson == false ? Post.fromJson(_post) : _post);
+    });
+    return posts;
+  }
 }

lib/jsonplaceholder_offline.dart

@@ -1,6 +1,7 @@
 import 'package:flutter_test/flutter_test.dart';
 
 import 'package:jsonplaceholder_offline/jsonplaceholder_offline.dart';
+import 'package:jsonplaceholder_offline/models/comment.dart';
 import 'package:jsonplaceholder_offline/models/photo.dart';
 import 'package:jsonplaceholder_offline/models/post.dart';
 import 'package:jsonplaceholder_offline/models/todo.dart';
@@ -14,6 +15,13 @@ void main() {
           jsonPlaceholder.getJsonData<Photo>(length: 20);
       expect(users.length, 20);
     });
+
+    test('testing PostComment', () {
+      JsonPlaceholder jsonPlaceholder = JsonPlaceholder();
+      List<dynamic> comments =
+          jsonPlaceholder.getUserPosts(userId: 1, toJson: true);
+      print(comments);
+    });
   });
 }