beetle_reporter 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b36c45e5e90842e9caf265c5d6b5af031f2e01fa9c7557a9e3aaa63313a87a93
-  data.tar.gz: c86b27daab8de919d9526b6b75ba08c499e77ffd4938f34309660f950e0fb9a5
+  metadata.gz: 5e21f52dd81361247e7975618d2845f2f4fcad19105ccc425de454b56ac2d68e
+  data.tar.gz: 78a8a0b42e6109b2635999728cbd17007b9cdc848d218e73f01fb0add257d085
 SHA512:
-  metadata.gz: b2c39dad2ef2fdee37da4169d008900dac4ae1205ce1f3edb501af211fbd3caeda7272eac300d750f0aeca7b3b897c80e831b9a5126cc10dd6244ca69760e357
-  data.tar.gz: 7d6ee8e9185e6567190b692a2078e6f5466667d38b71ffa6a9e8a7d1c2334db82eb9f7a8a6654053848136a6485283f48bff5cfb9375b1212edf7a1aa7155318
+  metadata.gz: 3a433451965599cf2dd833c770d4a588e742158cf99fcafe3d47822fd005dc41cc2acfafea4cf606ab95825017e7fd778d12b0b9d316d5c038f0082f1dcedea7
+  data.tar.gz: 8ad3142dc940e29a0990e4ed054da58251dbcdcb8af33e006abdf131fb4bdd42c9aec86d54db4bbc8e9e4e13d623192c073a5c3b2e946ae0d7c2345bbd2c570a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 42up
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,11 +1,10 @@
 # BeetleReporter
+Short description and motivation.
 
-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/beetle_reporter`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+## Usage
+How to use my plugin.
 
 ## Installation
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -13,27 +12,82 @@ gem 'beetle_reporter'
 ```
 
 And then execute:
-
-    $ bundle install
+```bash
+$ bundle
+```
 
 Or install it yourself as:
+```bash
+$ gem install beetle_reporter
+```
 
-    $ gem install beetle_reporter
-
-## Usage
+路由
+```ruby
+mount BeetleReporter::Engine => "/beetle_reporter", as: "beetle_reporter"
+```
 
-TODO: Write usage instructions here
+初始化配置
+```ruby
+BeetleReporter.configure do |config|
+  config.user_class = 'Admin'
+  config.user_name_method = 'username'
 
-## Development
+  config.main_app_root_path_method = 'admins_user_root_path'
+  config.main_app_user_path_method = 'admins_user_path'
+end
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+实现hook方法
+```ruby
+class Diary
+  def beetle_record_path
+    Rails.application.routes.url_helpers.admins_diary_path(id)
+  end
+
+  def beetle_hide
+    update_columns(is_approved: false)
+  end
+
+  def beetle_undo_hide
+    update_columns(is_approved: true)
+  end
+
+  def beetle_remove
+    discard
+  end
+
+  def beetle_undo_remove
+    undiscard
+  end
+
+  def beetle_mute
+    true
+  end
+
+  def beetle_undo_mute
+    true
+  end
+
+  def beetle_forbid
+    true
+  end
+
+  def beetle_undo_forbid
+    true
+  end
+
+  def beetle_record_partial_path
+    "admins/diaries/beetle"
+  end
+end
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## 约定
++ 支持 `is_approved` 字段
++ 支持 `discard` 软删 gem
 
 ## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/beetle_reporter.
+Contribution directions go here.
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,12 +1,8 @@
-# frozen_string_literal: true
+require "bundler/setup"
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
 
-require "rubocop/rake_task"
+load "rails/tasks/statistics.rake"
 
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
+require "bundler/gem_tasks"

data/app/assets/config/beetle_reporter_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/beetle_reporter .css

data/app/assets/stylesheets/beetle_reporter/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/beetle_reporter/home.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/beetle_reporter/reports.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/