Flarum 1.0 (#4)

* Update for 1.0 * Rename filterer to better reflect its purpose * Apply fixes from StyleCI * Add is:followeduser gambit, integrate filter into fof/user-directory * Apply fixes from StyleCI * Correct negate query * Apply fixes from StyleCI * Add screenshot for user-directory integration Co-authored-by: Ian Morland <[email protected]>
imorland · May 26, 2021 · 2d30d91 · 2d30d91
1 parent 9b08be4
commit 2d30d91
Show file tree

Hide file tree

Showing 29 changed files with 192 additions and 56 deletions.
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Ian Morland
+Copyright (c) 2021 Ian Morland
 
 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:
 

diff --git a/README.md b/README.md
@@ -7,19 +7,24 @@ A [Flarum](http://flarum.org) extension. Follow users and be notified of new dis
 Building on top of `fof/follow-tags`, this extension allows for following of individual users.
 
 ### Features
-- Requires Flarum beta 15 or above
 - Adds a 'Followed User' badge to users that _you_ follow, forum wide
 - Adds A 'Followed Users' filter to the following filter
 - Permission for which groups can be followed
 - User preference to block followers
 - Notifications for 'Followed', 'Unfollowed', 'Followed User Started Discussion' and 'Followed User Posted'
+- Integration with `fof/user-directory`
+- Provides a search gambit `is:followeduser`
+- [Developers] events dispatched for `Following` and `Unfollowing`
 
 ##### Discussion list
 ![image](https://user-images.githubusercontent.com/16573496/102770472-2161df00-437c-11eb-8274-6f73d58b1042.png)
 
 ##### Following dropdown
 ![image](https://user-images.githubusercontent.com/16573496/102770549-40f90780-437c-11eb-801e-a7fb9e08e704.png)
 
+##### `fof/user-directory` integration
+![image](https://user-images.githubusercontent.com/16573496/119695069-ba25ea80-be45-11eb-9f0e-ff7545f29261.png)
+
 ##### Notification preferences
 ![image](https://user-images.githubusercontent.com/16573496/102770611-55d59b00-437c-11eb-8d57-408770c34d69.png)
 
@@ -28,10 +33,10 @@ Building on top of `fof/follow-tags`, this extension allows for following of ind
 
 ### Installation
 
-Install manually with composer:
+Install with composer:
 
 ```sh
-composer require ianm/follow-users
+composer require ianm/follow-users:"*"
 ```
 
 `fof/follow-tags` *must* be enabled *before* this extension is enabled.

diff --git a/composer.json b/composer.json
@@ -12,8 +12,8 @@
     "forum": "https://discuss.flarum.org/d/25701"
   },
   "require": {
-    "flarum/core": "^0.1.0-beta.16",
-    "fof/follow-tags": "^0.7.1"
+    "flarum/core": "^1.0.0",
+    "fof/follow-tags": "^1.0.0"
   },
   "authors": [
     {
@@ -29,15 +29,16 @@
   },
   "extra": {
     "flarum-extension": {
-      "title": "IM Follow Users",
+      "title": "Follow Users",
       "category": "feature",
       "icon": {
         "name": "fas fa-user-friends",
         "backgroundColor": "#0072e3",
         "color": "#fff"
       },
       "optional-dependencies": [
-        "fof/follow-tags"
+        "fof/follow-tags",
+        "fof/user-directory"
       ]
     },
     "flagrow": {

diff --git a/extend.php b/extend.php
@@ -3,7 +3,7 @@
 /*
  * This file is part of ianm/follow-users
  *
- *  Copyright (c) 2020 Ian Morland.
+ *  Copyright (c) Ian Morland.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.
@@ -23,6 +23,8 @@
 use Flarum\Discussion\Filter\DiscussionFilterer;
 use Flarum\Extend;
 use Flarum\User\Event\Saving;
+use Flarum\User\Filter\UserFilterer;
+use Flarum\User\Search\UserSearcher;
 use Flarum\User\User;
 
 return [
@@ -62,7 +64,13 @@
         ->subscribe(Listeners\QueueNotificationJobs::class),
 
     (new Extend\Filter(DiscussionFilterer::class))
-        ->addFilter(Query\FollowUsersFilter::class),
+        ->addFilter(Query\FollowUsersDiscussionFilter::class),
+
+    (new Extend\Filter(UserFilterer::class))
+        ->addFilter(Query\FollowedUsersFilterGambit::class),
+
+    (new Extend\SimpleFlarumSearch(UserSearcher::class))
+        ->addGambit(Query\FollowedUsersFilterGambit::class),
 
     (new Extend\User())
         ->registerPreference('blocksFollow', 'boolval', false),

diff --git a/js/package-lock.json b/js/package-lock.json
diff --git a/js/package.json b/js/package.json
@@ -14,6 +14,6 @@
   },
   "devDependencies": {
     "flarum": "0.1.0-beta.16",
-    "prettier": "^2.2.1"
+    "prettier": "^2.3.0"
   }
 }
diff --git a/js/src/admin/index.js b/js/src/admin/index.js
@@ -1,4 +1,4 @@
-import app from 'flarum/app';
+import app from 'flarum/common/app';
 import * as follow_tags from '@fof-follow-tags';
 import followingPageOptions from '../common/helpers/followingPageOptions';
 

diff --git a/js/src/forum/addFollowingUsers.js b/js/src/forum/addFollowingUsers.js
@@ -1,7 +1,9 @@
 import { extend } from 'flarum/common/extend';
 import * as follow_tags from '@fof-follow-tags';
+import * as user_directory from '@fof-user-directory';
 import DiscussionListState from 'flarum/common/states/DiscussionListState';
 import followingPageOptions from '../common/helpers/followingPageOptions';
+import Separator from 'flarum/common/components/Separator';
 
 export default function () {
     if (app.initializers.has('fof/follow-tags')) {
@@ -26,4 +28,33 @@ export default function () {
             }
         });
     }
+
+    if (app.initializers.has('fof-user-directory')) {
+        extend(user_directory.UserDirectoryPage.prototype, 'groupItems', function (items) {
+            items.add(
+                'follow-users',
+                user_directory.CheckableButton.component(
+                    {
+                        className: 'GroupFilterButton',
+                        icon: 'fas fa-user-friends',
+                        checked: this.enabledSpecialGroupFilters['ianm-follow-users'] === 'is:followeduser',
+                        onclick: () => {
+                            const id = 'ianm-follow-users';
+                            if (this.enabledSpecialGroupFilters[id] === 'is:followeduser') {
+                                this.enabledSpecialGroupFilters[id] = '';
+                            } else {
+                                this.enabledSpecialGroupFilters[id] = 'is:followeduser';
+                            }
+
+                            this.changeParams(this.params().sort);
+                        },
+                    },
+                    app.translator.trans('ianm-follow-users.forum.filter.following')
+                ),
+                65
+            );
+
+            items.add('seperator', Separator.component(), 50);
+        });
+    }
 }
diff --git a/js/webpack.config.js b/js/webpack.config.js
@@ -1,5 +1,5 @@
 const config = require('flarum-webpack-config')({
-  useExtensions: ['fof-follow-tags']
+  useExtensions: ['fof-follow-tags', 'fof-user-directory']
 });
 
 module.exports = config;
diff --git a/migrations/0000_00_00_000000_create_user_followers_table.php b/migrations/0000_00_00_000000_create_user_followers_table.php
@@ -3,7 +3,7 @@
 /*
  * This file is part of ianm/follow-users
  *
- *  Copyright (c) 2020 Ian Morland.
+ *  Copyright (c) Ian Morland.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.

diff --git a/migrations/0000_00_00_000001_set_default_permissions.php b/migrations/0000_00_00_000001_set_default_permissions.php
@@ -3,7 +3,7 @@
 /*
  * This file is part of ianm/follow-users
  *
- *  Copyright (c) 2020 Ian Morland.
+ *  Copyright (c) Ian Morland.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.

diff --git a/resources/locale/en.yml b/resources/locale/en.yml
@@ -32,6 +32,9 @@ ianm-follow-users:
     badge:
       label: Followed user
 
+    filter:
+      following: Followed users
+
   email:
     new_discussion_by_user_subject: "[Follow User] {title}"
     new_follower_subject: "[Follow User] You have a new follower!"

diff --git a/src/Access/UserPolicy.php b/src/Access/UserPolicy.php
@@ -3,7 +3,7 @@
 /*
  * This file is part of ianm/follow-users
  *
- *  Copyright (c) 2020 Ian Morland.
+ *  Copyright (c) Ian Morland.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.

diff --git a/src/Events/Following.php b/src/Events/Following.php
@@ -3,7 +3,7 @@
 /*
  * This file is part of ianm/follow-users
  *
- *  Copyright (c) 2020 Ian Morland.
+ *  Copyright (c) Ian Morland.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.

diff --git a/src/Events/Unfollowing.php b/src/Events/Unfollowing.php
@@ -3,7 +3,7 @@
 /*
  * This file is part of ianm/follow-users
  *
- *  Copyright (c) 2020 Ian Morland.
+ *  Copyright (c) Ian Morland.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.

diff --git a/src/Jobs/SendNotificationWhenDiscussionIsStarted.php b/src/Jobs/SendNotificationWhenDiscussionIsStarted.php
@@ -3,7 +3,7 @@
 /*
  * This file is part of ianm/follow-users
  *
- *  Copyright (c) 2020 Ian Morland.
+ *  Copyright (c) Ian Morland.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.

diff --git a/src/Jobs/SendNotificationWhenFollowerPosted.php b/src/Jobs/SendNotificationWhenFollowerPosted.php
@@ -3,7 +3,7 @@
 /*
  * This file is part of ianm/follow-users
  *
- *  Copyright (c) 2020 Ian Morland.
+ *  Copyright (c) Ian Morland.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.

diff --git a/src/Jobs/SendNotificationWhenUserIsFollowed.php b/src/Jobs/SendNotificationWhenUserIsFollowed.php
@@ -3,7 +3,7 @@
 /*
  * This file is part of ianm/follow-users
  *
- *  Copyright (c) 2020 Ian Morland.
+ *  Copyright (c) Ian Morland.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.

diff --git a/src/Jobs/SendNotificationWhenUserIsUnfollowed.php b/src/Jobs/SendNotificationWhenUserIsUnfollowed.php
@@ -3,7 +3,7 @@
 /*
  * This file is part of ianm/follow-users
  *
- *  Copyright (c) 2020 Ian Morland.
+ *  Copyright (c) Ian Morland.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.

diff --git a/src/Listeners/DeleteNotificationWhenDiscussionIsHiddenOrDeleted.php b/src/Listeners/DeleteNotificationWhenDiscussionIsHiddenOrDeleted.php
@@ -3,7 +3,7 @@
 /*
  * This file is part of ianm/follow-users
  *
- *  Copyright (c) 2020 Ian Morland.
+ *  Copyright (c) Ian Morland.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.