censor_bear 0.1.17 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da82f8fafa1a258c9009099fc66621805e19ac0750662f92153eb3a1a8ba5b01
-  data.tar.gz: 4a51f1c4260ba69397dfc583093fb59417ba0f9b95b458243d2b28ec58087454
+  metadata.gz: 718c2ec6b519d6148ea047125d8a756b3cdc982aba68b4c7ca6d62e73b71a606
+  data.tar.gz: af687db6053250f6da78e3eea1192c648725039158a236472f7e5bcc539226ba
 SHA512:
-  metadata.gz: 0fed9c06844c55e4fca2c9d997d8f7af7a1bb04c33c0cc73f7fe1d1cbf4c1f0bce029a239f058a0eda4bd8bd11c9b670ad4019d8f3d75e9916d00f8d66a6ddf2
-  data.tar.gz: 11a70e93051a636a39240dd09327ef38778c82fc22af53b325e28e1635036de93f9ab85ab4b66d6cc8e78d1c04ae6b74ad31b7fa31ee5a958a75b9ac09dcccb7
+  metadata.gz: 6f83eae4f76dca1658c2d585f36a2a5419dc49c4e3f3beaeec17fd856a7464035def3b347ecd6ae59b6e4fe31f9ce6d3bae52a9659bc0bbab7cff66219f4d5c6
+  data.tar.gz: 07b471f86713559334a67950d35483f22007005caad6c0aecc93b7cbaa01ecc5cfda3aac7d5d95f6cec37abf38218d67aa18f01965a82c5d9e39a3b6bedccbdb

data/README.md

@@ -1,8 +1,6 @@
-# CensorBear
-Short description and motivation.
+# 🐻 CensorBear
 
-## Usage
-How to use my plugin.
+CensorBear 是一个可插拔的内容审核管理工具。
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,40 +19,84 @@ Or install it yourself as:
 $ gem install censor_bear
 ```
 
-## Authentication
-### Devise
-```ruby
-authenticate :user, ->(user) { user.admin? } do
-  mount Blazer::Engine, at: "censor_bear"
-end
+Then execute to copy migrations:
+
+```bash
+rails censor_bear:install:migrations
 ```
 
-### Other
-Specify a before_action method to run in `censor_bear.yml`.
+## 初始化配置
+详细配置项可在`lib/censor_bear/configuration.rb`中查看。
+
+### 待办
+- [ ] 用户详情跳转路由 
+
 ```ruby
-before_action_method: require_admin
-```
-You can define this method in your ApplicationController.
-```
-def require_admin
-  # depending on your auth, something like...
-  redirect_to root_path unless current_user && current_user.admin?
+CensorBear.configure do |config|
+  config.user_class = 'User'
+  config.user_name_method = 'nickname'
+
+  config.aliyun_green_access_key_id = 'access key id'
+  config.aliyun_green_access_key_secret = 'access key  secret'
+  config.aliyun_green_enable_internal = false
+
+  config.main_app_root_path_method = 'root_path'
+  config.main_app_user_path_method = 'admins_user_path'
 end
 ```
-Be sure to render or redirect for unauthorized users.
 
-## Migration
-```bash
-rails censor_bear:install:migrations
+## I18n 配置
+复制i18n文件到`config/locales/censor_bear.yml`
+```yml
+"zh-CN":
+  censor_log:
+    action:
+      mod: 审核
+      banned: 禁用
+      ignore: 忽略
+      replace: 替换
+      block: 禁用
+      pass: 忽略
+      review: 审核
+    aasm_state:
+      pending: 待审
+      handled: 已处理
+      suspended: 暂缓处理
+    stage:
+      check_search: 搜索检查
+      aliyun_check: 阿里云检查
+      tencent_check: 腾讯云检查
+      local_check: 本地检查
+      qq_regex: QQ正则检查
+      wechat_regex: 微信正则检查
+    label:
+      normal: 正常文本
+      spam: 含垃圾信息
+      ad: 广告
+      politics: 涉政
+      terrorism: 暴恐
+      abuse: 辱骂
+      porn: 色情
+      flood: 灌水
+      contraband: 违禁
+      meaningless: 无意义
+      harmful: 不良场景
+      customized: 自定义
 ```
 
-## 🦆 Methods
+## 🦆 需要实现的钩子方法
 ```ruby
+censor_show_path # 被审资源路由详情
+censor_images # 被审资源图片关联资源
 censor_remove # 删除内容
-censor_cancel # 撤销删除
+censor_undo_remove # 撤销删除内容
 censor_approve # 通过审核
-censor_show_path # 详情路由
+censor_undo_approve # 撤销通过审核
 censor_ban_user # 封禁用户
+```
+
+## 用法
+```ruby
 
 ```
 
@@ -65,21 +107,34 @@ censor_ban_user # 封禁用户
 class NotPassedException < StandardError; end
 ```
 
-## 初始化配置
-详细配置项可在`lib/censor_bear/configuration.rb`中查看。
 
+## Authentication
+### Devise
 ```ruby
-CensorBear.configure do |config|
-  config.user_class = 'User'
-  config.user_name_method = 'nickname'
-
-  config.aliyun_green_access_key_id = 'access key id'
-  config.aliyun_green_access_key_secret = 'access key  secret'
-  config.aliyun_green_enable_internal = false
+authenticate :user, ->(user) { user.admin? } do
+  mount CensorBear::Engine => "/censor_bear", as: "censor_bear"
+end
+```
 
-  config.main_app_root_path_method = 'root_path'
+### Other(todo)
+Specify a before_action method to run in `censor_bear.yml`.
+```ruby
+before_action_method: require_admin
+```
+You can define this method in your ApplicationController.
+```
+def require_admin
+  # depending on your auth, something like...
+  redirect_to root_path unless current_user && current_user.admin?
 end
 ```
+Be sure to render or redirect for unauthorized users.
+
+
+## 数据库字段要求
+- is_approved
+- 支持软删
+
 
 ## 注意事项
 1. 为 MOD 时，表示需要人工审核，需要被审查对象(UGC内容)支持`is_approved`字段（默认为`true`），此时内容自己能看到，别人暂时看不到，需审核通过后可见。
@@ -90,7 +145,6 @@ end
 6. 被BAN掉的内容，无法创建，直接返回异常，速错。
 
 
-
 ## Contributing
 Contribution directions go here.
 

data/app/views/censor_bear/logs/_log.html.haml

@@ -16,7 +16,8 @@
           - unless log.label.blank?
             %span{class: "text-sm bg-green-100 text-green-600 py-1 px-2 rounded-lg"}=log.label.upcase
           - unless log.user_id.blank?
-            %span{class: "text-sm bg-gray-100 text-gray-600 py-1 px-2 rounded-lg font-bold"}="##{log.user_id}"
+            = link_to main_app.send(CensorBear.config.main_app_user_path_method.to_sym, log.user_id), data: {turbo: false} do
+              %span{class: "text-sm bg-gray-100 text-gray-600 py-1 px-2 rounded-lg font-bold"}="✍️ ##{log.user_id}"
           - unless log.ip.blank?
             %span{class: "text-sm bg-gray-100 text-gray-600 py-1 px-2 rounded-lg"}=log.ip
           - unless log.labels.blank?

data/app/views/censor_bear/mod_logs/_mod_log.html.haml

@@ -19,7 +19,7 @@
             %h3{class: "text-2xl text-red-600"} 对应条目已被永久删除，当前审核请求已无效，请删除
           - else
             %div
-              %span{class: "border border-pink-600 text-pink-600 rounded-lg text-xs p-0.5"}=mod_log.record.is_private ? "隐私" : "公开"
+              %span{class: "#{mod_log.record.is_private ? 'bg-black text-white' : 'border border-black text-black' } rounded-lg text-xs p-0.5 px-1"}=mod_log.record.is_private ? "🙈 隐私" : "🙉 公开"
               %span{class: "border border-blue-600 text-blue-600 rounded-lg text-xs p-0.5"}=mod_log.record.is_approved ? "审核通过" : "审核中..."
               - unless mod_log.labels.blank?
                 - mod_log.labels.each do |label|
@@ -27,6 +27,9 @@
               - unless mod_log.mod_words.blank?
                 - mod_log.mod_words.each do |word|
                   %span{class: "border border-red-600 text-red-600 rounded-lg text-xs p-0.5"}="##{word}"
+              - unless mod_log&.record&.user_id&.blank?
+                = link_to main_app.send(CensorBear.config.main_app_user_path_method.to_sym, mod_log.record.user_id), data: {turbo: false} do
+                  %span{class: "text-sm bg-gray-100 text-gray-600 py-1 px-2 rounded-lg font-bold"}="✍️ ##{mod_log.record.user_id}"
             - if mod_log.record.discarded?
               %div{class: "text-gray-900 leading-relaxed"}
                 %del= mod_log.record.content

data/app/views/censor_bear/mod_logs/index.html.haml

@@ -8,8 +8,6 @@
           = link_to "重置", mod_logs_path, class: "text-sm"
     %div{class: "flex items-center space-x-2"}
       %div{class: "text-sm text-gray-600"}="共 #{@pagy.count} 条"
-      %div{class: "bg-gray-200 rounded-full px-3 py-1 text-xs #{params[:filter] == "all" ? 'font-bold' : ''}"}
-        = link_to "全部", request.params.merge(filter: "all", state: "")
       %div{class: "bg-gray-200 rounded-full px-3 py-1 text-xs #{params[:state].blank? && params[:filter].blank? ? 'font-bold' : ''}"}
         = link_to "待处理", request.params.merge(state: "", filter: "")
       %div{class: "bg-gray-200 rounded-full px-3 py-1 text-xs #{params[:state] == 'rejected' ? 'font-bold' : ''}"}
@@ -18,6 +16,8 @@
         = link_to "通过", request.params.merge(state: "passed", filter: "")
       %div{class: "bg-gray-200 rounded-full px-3 py-1 text-xs #{params[:state] == 'suspended' ? 'font-bold' : ''}"}
         = link_to "暂缓处理", request.params.merge(state: "suspended", filter: "")
+      %div{class: "bg-gray-200 rounded-full px-3 py-1 text-xs #{params[:filter] == "all" ? 'font-bold' : ''}"}
+        = link_to "全部", request.params.merge(filter: "all", state: "")
   %div
     - if @mod_logs.blank?
       %div{class: "flex justify-center text-gray-500 p-8 border rounded-md"} 空空如也

data/lib/censor_bear/configuration.rb

@@ -19,5 +19,6 @@ module CensorBear
     attr_accessor :aliyun_green_enable_internal
 
     attr_accessor :main_app_root_path_method
+    attr_accessor :main_app_user_path_method
   end
 end

data/lib/censor_bear/version.rb

@@ -1,3 +1,3 @@
 module CensorBear
-  VERSION = '0.1.17'.freeze
+  VERSION = '0.1.18'.freeze
 end

data/lib/censor_bear.rb

@@ -26,6 +26,7 @@ module CensorBear
       @config.aliyun_green_access_key_secret = ''
       @config.aliyun_green_enable_internal = false
       @config.main_app_root_path_method = 'root_path'
+      @config.main_app_user_path_method = 'user_path'
 
       @config
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: censor_bear
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.18
 platform: ruby
 authors:
 - 42up
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-10 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -114,7 +114,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Description of CensorBear.
+description: "\U0001F43B Watch your back! Young man."
 email:
 - foobar@v2up.com
 executables: []
@@ -215,5 +215,5 @@ requirements: []
 rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
-summary: Summary of CensorBear.
+summary: "\U0001F43B Watch your back! Young man."
 test_files: []