rails_execution 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 144dd7fcf30e5af4eeba4abba9112b46663919b4463db267a0b9ebcc665f6756
-  data.tar.gz: b68d85f26a544eb520492d866d99f5e6af1fef98ba90c701c38204b6624af94e
+  metadata.gz: 7d04b62e7461cf38c3519551e7c96a9792418b5769d1e1782f317957c34bf617
+  data.tar.gz: cf09e00dfb2b487fae01323230b337f02b2867729ff05a6887d7dce0494cddbb
 SHA512:
-  metadata.gz: 65dea3b11985125e87f87c73b6905aad2caf25b1baa4ab8dfc43d6f33f19e7883bb451ff1d3a35715f8a857a9d0fcaeaa34b8ae0e9d516a023a857d392195001
-  data.tar.gz: bdc10fd5cd2f83853245e6fe43e17d13e8a014dbe242c49d182228fb6d152f9780913b9e99da596ff0e8aa60bf42117778c2d513e6f20c3ee2cfaa8f011ad42e
+  metadata.gz: 8ad2c6d2a14b9c6c3cb3be1e2728afbd9c691d5db1bd9d91f66a48d43219af9f334e4b9d23bf81d348e37422e7651d1d84469369845267d64b9ebf0aac4922de
+  data.tar.gz: b2e17748bdc9cb169ed742cb19fbe4ff80fc759c5465b25448f1d2ab47043d0bc40005b6b1c643cdd4f81c61944751f98108109e7f1ea1fcb086b7c220a8eabe

data/README.md

@@ -1,35 +1,121 @@
-# RailsExecution
+# Rails Execution
+Rails Execution is an Engine to manage the Rails scripts for migration, cleanup, and fixing the bad data without deployment.
+- Supported the Syntax checker
+- Supported the Execution logs
+- Supported the Reviewing process
+- Supported the Attachment files
+- Supported the Comments communication
+- Supported the Activities tracking
 
-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/rails_execution`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
+![image](https://user-images.githubusercontent.com/6081795/193129359-fc1e8858-c3e7-4376-be1e-ca453890a98d.png)
+![image](https://user-images.githubusercontent.com/6081795/193129792-39176d6e-97fa-4a47-8541-30e7169841cd.png)
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Add the following line to your **Gemfile**:
 
-    $ bundle add rails_execution
+```ruby
+gem 'rails_execution'
+```
+Then run `bundle install`
 
-If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install rails_execution
-
-## Usage
+## Getting started
 
 ### How to setup
+You need to run the generator:
+```bash
     $ rails g rails_execution:install
+```
+And you can change the config in `config/initializers/rails_execution.rb`
+
+Default is `Solo Mode`, without the Reviewing process.
+
+#### Enable the Reviewing process
+The first step is to disable the  `Solo Mode`
+```ruby
+    config.solo_mode = false
+```
+And then uncomment the configures of the `owner` and `reviewers`
+```ruby
+    config.owner_model = 'User'
+    config.owner_method = :current_user
+    config.owner_name_method = :name
+    config.owner_avatar = ->(owner) { owner.avatar.url }
+  
+    config.reviewers = -> do
+      User.where(is_admin: true).map do |user|
+        {
+          name: user.name,
+          id: user.id,
+          type: 'User',
+          avatar_url: user.avatar.url,
+        }
+      end
+    end
+```
+
+#### Enable the Attachment files
+Run the generator to add the **FileUploader** and **FileReader**
+```bash
     $ rails g rails_execution:file_upload
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-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).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_execution.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```
+And then uncomment the file upload
+```ruby
+  config.file_upload = true
+  config.file_uploader = ::RailsExecution::FileUploader
+  config.file_reader = ::RailsExecution::FileReader
+```
+To limit the File types. Default: `.png`, `.gif`, `.jpg`, `.jpeg`, `.pdf`, `.csv`
+You can modify the limitation like this
+```ruby
+  config.acceptable_file_types = {
+    '.jpeg': 'image/jpeg',
+    '.pdf': 'application/pdf',
+    '.csv': ['text/csv', 'text/plain'],
+  }
+```
+
+#### Control the Permissions
+For example with  *[Pundit](https://github.com/varvet/pundit)* authorization.
+```ruby
+  config.task_creatable = lambda do |user|
+    YourPolicy.new(user).creatable?
+  end
+  config.task_editable = lambda do |task, user|
+    YourPolicy.new(user, task).editable?
+  end
+  config.task_closable = lambda do |task, user|
+    YourPolicy.new(user, task).closable?
+  end
+  config.task_approvable = lambda do |task, user|
+    YourPolicy.new(user, task).approvable?
+  end
+  config.task_executable = lambda do |task, user|
+    YourPolicy.new(user, task).executable?
+  end
+```
+
+#### Setup the Logger
+To storage the logfile
+```ruby
+  config.logging = lambda do |file, task|
+    LoggerModel.create!(task: task, file: file)
+  end
+```
+And list the logfiles on Task page
+```ruby
+  config.logging_files = lambda do |task|
+    LoggerModel.where(task: task).map do |log|
+      log.file.expiring_url(30.minutes.to_i)
+    end
+  end
+```
+
+#### Others
+To change the Per page of the tasks list.
+Default value: `20`
+```ruby
+  config.per_page = 10
+```

data/app/assets/javascripts/executions/comments.js

@@ -12,6 +12,7 @@ window.comments.clickEditComment = function(el) {
     status: false,
     maxHeight: '150px',
     showIcons: ['code'],
+    spellChecker: false,
     placeholder: 'Type your comment here...',
     renderingConfig: {
       codeSyntaxHighlighting: true,
@@ -24,6 +25,7 @@ window.comments.initAddNewComment = function(id) {
     status: false,
     maxHeight: '100px',
     showIcons: ['code'],
+    spellChecker: false,
     placeholder: 'Type your comment here...',
     renderingConfig: {
       codeSyntaxHighlighting: true,

data/app/assets/stylesheets/executions/comments.css

@@ -1,7 +1,8 @@
 .g-height-50 { height: 50px; }
 .g-width-50 { width: 50px !important; }
 .g-bg-secondary { background-color: white !important; }
-.media-comment { margin-top:20px }
+.media-comment { margin-top:20px; }
+.media-comment .media-body { overflow-x: auto; }
 
 @media (min-width: 0) {
   .g-mr-15 { margin-right: 1.07143rem !important; }

data/app/controllers/rails_execution/comments_controller.rb

@@ -6,6 +6,7 @@ module RailsExecution
     def create
       @new_comment = current_task.comments.new(owner: current_owner, content: params.dig(:comment, :content))
       if @new_comment.save
+        ::RailsExecution.configuration.notifier.new(current_task).add_comment(current_owner, @new_comment.content)
         current_task.activities.create(owner: current_owner, message: "Added a comment: #{@new_comment.content.truncate(30)}")
       else
         @alert = "Your comment can't adding!"

data/app/controllers/rails_execution/tasks_controller.rb

@@ -31,6 +31,7 @@ module RailsExecution
 
       if @task.save
         @task.add_files(params[:attachments]&.permit!.to_h, current_owner) if ::RailsExecution.configuration.file_upload
+        ::RailsExecution.configuration.notifier.new(@task).after_create
         flash[:notice] = 'Create the request is successful!'
         redirect_to action: :index
       else
@@ -38,6 +39,22 @@ module RailsExecution
       end
     end
 
+    def fork
+      raise(::RailsExecution::AccessDeniedError, 'Fork task') unless can_create_task?
+
+      @task = ::RailsExecution::Task.new({
+        status: :created,
+        owner_id: current_owner&.id,
+        owner_type: ::RailsExecution.configuration.owner_model.to_s,
+        title: current_task.title,
+        description: current_task.description,
+        script: current_task.script,
+      })
+      @task.syntax_status = ::RailsExecution::Services::SyntaxChecker.new(@task.script).call ? 'good' : 'bad'
+
+      render action: :new
+    end
+
     def show
     end
 
@@ -49,6 +66,7 @@ module RailsExecution
 
       if current_task.update(status: :closed)
         current_task.activities.create(owner: current_owner, message: 'Closed the task')
+        ::RailsExecution.configuration.notifier.new(current_task).after_close
         redirect_to(action: :show) and return
       else
         flash[:alert] = "Has problem when close this Task: #{current_task.errors.full_messages.join(', ')}"
@@ -66,6 +84,10 @@ module RailsExecution
       raise(::RailsExecution::AccessDeniedError, 'Edit task') unless can_edit_task?(current_task)
 
       @task = current_task
+      old_script = @task.script
+      old_reviewer_ids = @task.task_reviews.pluck(:owner_id)
+      checked_owner_ids = @task.task_reviews.checked.pluck(:owner_id)
+
       update_data = {
         title: params.dig(:task, :title),
         description: params.dig(:task, :description),
@@ -78,6 +100,8 @@ module RailsExecution
       if @task.update(update_data)
         @task.add_files(params[:attachments]&.permit!.to_h, current_owner) if ::RailsExecution.configuration.file_upload
         @task.activities.create(owner: current_owner, message: 'Updated the Task')
+        ::RailsExecution.configuration.notifier.new(@task).after_update_script(current_owner, checked_owner_ids) if old_script != @task.script
+        ::RailsExecution.configuration.notifier.new(@task).after_assign_reviewers(current_owner, @task.task_reviews.reload.pluck(:owner_id) - old_reviewer_ids)
         redirect_to action: :show
       else
         render action: :edit
@@ -99,6 +123,7 @@ module RailsExecution
     def reopen
       if current_task.update(status: :created)
         current_task.activities.create(owner: current_owner, message: 'Re-opened the Task')
+        ::RailsExecution.configuration.notifier.new(current_task).after_reopen
         flash[:notice] = 'Your task is re-opened'
       else
         flash[:alert] = "Re-open is failed: #{current_task.errors.full_messages.join(', ')}"
@@ -108,6 +133,7 @@ module RailsExecution
 
     def reject
       if ::RailsExecution::Services::Approvement.new(current_task, reviewer: current_owner).reject
+        ::RailsExecution.configuration.notifier.new(current_task).after_reject(current_owner)
         flash[:notice] = 'Your decision is updated!'
       else
         flash[:alert] = "Your decision is can't update!"
@@ -117,6 +143,7 @@ module RailsExecution
 
     def approve
       if ::RailsExecution::Services::Approvement.new(current_task, reviewer: current_owner).approve
+        ::RailsExecution.configuration.notifier.new(current_task).after_approve(current_owner)
         flash[:notice] = 'Your decision is updated!'
       else
         flash[:alert] = "Your decision is can't update!"
@@ -134,8 +161,10 @@ module RailsExecution
       if execute_service.call
         current_task.update(status: :completed)
         current_task.activities.create(owner: current_owner, message: 'Execute: The task is completed')
+        ::RailsExecution.configuration.notifier.new(current_task).after_execute_success(current_owner)
         flash[:notice] = 'This task is executed'
       else
+        ::RailsExecution.configuration.notifier.new(current_task).after_execute_fail(current_owner)
         flash[:alert] = "Sorry!!! This task can't execute right now"
       end
 
@@ -167,7 +196,7 @@ module RailsExecution
     helper_method :task_attachment_files
 
     def reviewing_accounts
-      @reviewing_accounts ||= current_task.task_reviews
+      @reviewing_accounts ||= current_task.task_reviews.preload(:owner)
     end
     helper_method :reviewing_accounts
 

data/app/models/rails_execution/task_review.rb

@@ -11,4 +11,6 @@ class RailsExecution::TaskReview < RailsExecution::AppModel
     rejected: 'rejected',
   }, _prefix: :is
 
+  scope :checked, -> { where(status: [:approved, :rejected]) }
+
 end

data/app/views/rails_execution/shared/_header.html.haml

@@ -8,6 +8,6 @@
         %li= link_to 'Processing', tasks_path, class: "nav-link px-2 link-#{ current_page?(tasks_path) ? 'secondary' : 'dark' }"
         %li= link_to 'Completed', completed_tasks_path, class: "nav-link px-2 link-#{ current_page?(completed_tasks_path) ? 'secondary' : 'dark' }"
         %li= link_to 'Closed', closed_tasks_path, class: "nav-link px-2 link-#{ current_page?(closed_tasks_path) ? 'secondary' : 'dark' }"
-      .col-md-3.text-end
+      .col-md-6.text-end
         = yield :page_actions
         = link_to 'New Task', new_task_path, class: 'btn btn-outline-primary ms-2', disabled: !can_create_task?

data/app/views/rails_execution/tasks/_comments.html.haml

@@ -1,5 +1,5 @@
 = render partial: 'new_comment', locals: { comment: (new_comment || current_task.comments.new) }
-= render current_task.comments.ascending
+= render current_task.comments.ascending.preload(:owner)
 
 :javascript
   hljs.highlightAll();

data/app/views/rails_execution/tasks/_form.html.haml

@@ -1,4 +1,4 @@
-= form_for task, html: { enctype: 'multipart/form-data' } do |f|
+= form_for task, method: task.new_record? ? :post : :patch, html: { enctype: 'multipart/form-data' } do |f|
   .row
     - if task.errors.any?
       .col-12.text-danger.small.mt-3= task.errors.full_messages.join("\n")

data/app/views/rails_execution/tasks/_form_scripts.html.haml

@@ -4,6 +4,7 @@
     element: document.getElementById('task_description'),
     status: false,
     showIcons: ['code'],
+    spellChecker: false,
     placeholder: "Type description here...",
     renderingConfig: {
       codeSyntaxHighlighting: true,

data/app/views/rails_execution/tasks/show.html.haml

@@ -4,6 +4,10 @@
   - elsif current_task.is_closed? && can_create_task?
     = link_to 'Re-Open', reopen_task_path(current_task), class: 'btn btn-outline-info', method: :patch, data: { confirm: 'Are you sure?' }
 
+  - if can_create_task?
+    = link_to fork_task_path(current_task), class: 'btn btn-outline-info ms-1 me-2' do
+      %i.bi.bi-diagram-2
+      Fork
   - if can_edit_task?(current_task)
     = link_to 'Edit', edit_task_path(current_task), class: 'btn btn-outline-warning me-2'
 

data/config/routes.rb

@@ -9,6 +9,7 @@ RailsExecution::Engine.routes.draw do
 
   resources :tasks do
     member do
+      get :fork
       patch :reopen
       patch :reject
       patch :approve

data/lib/generators/rails_execution/templates/config.rb.tt

@@ -60,4 +60,7 @@ RailsExecution.configuration do |config|
   # Paging
   # config.per_page = 30 # Default: 20
 
+  # Notify
+  # config.notifier = ::RailsExecution::Services::Notifier
+
 end

data/lib/rails_execution/config.rb

@@ -44,6 +44,9 @@ module RailsExecution
     # Paging
     attr_accessor :per_page
 
+    # Notify
+    attr_accessor :notifier
+
     def initialize
       self.solo_mode = true
 
@@ -67,6 +70,8 @@ module RailsExecution
 
       self.logging = -> (_log_file, _task) { }
       self.logging_files = -> (_task) { [] }
+
+      self.notifier = ::RailsExecution::Services::Notifier
     end
 
   end

data/lib/rails_execution/files/uploader.rb

@@ -34,7 +34,7 @@ module RailsExecution
       end
 
       def acceptable_file_types
-        ::RailsExecution.configuration.acceptable_file_types.values
+        ::RailsExecution.configuration.acceptable_file_types.values.flatten
       end
 
     end

data/lib/rails_execution/services/notifier.rb

@@ -0,0 +1,27 @@
+module RailsExecution
+  module Services
+    class Notifier
+
+      def initialize(task)
+        @task = task
+      end
+
+      def after_create; end
+      def after_close; end
+      def after_reopen; end
+      def after_update_script(_editor, _reviewer_ids); end
+      def after_assign_reviewers(_editor, _new_reviewer_ids); end
+      def after_reject(_reviewer); end
+      def after_approve(_reviewer); end
+      def after_execute_success(_executor); end
+      def after_execute_fail(_executor); end
+
+      def add_comment(_commenter, _content); end
+
+      private
+
+      attr_reader :task
+
+    end
+  end
+end

data/lib/rails_execution/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsExecution
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/rails_execution.rb

@@ -9,6 +9,7 @@ require 'rails_execution/files/reader'
 require 'rails_execution/files/uploader'
 require 'rails_execution/services/paging'
 require 'rails_execution/services/executor'
+require 'rails_execution/services/notifier'
 require 'rails_execution/services/execution'
 require 'rails_execution/services/approvement'
 require 'rails_execution/services/syntax_checker'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_execution
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Khoa Nguyen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2022-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -124,6 +124,7 @@ files:
 - lib/rails_execution/services/approvement.rb
 - lib/rails_execution/services/execution.rb
 - lib/rails_execution/services/executor.rb
+- lib/rails_execution/services/notifier.rb
 - lib/rails_execution/services/paging.rb
 - lib/rails_execution/services/syntax_checker.rb
 - lib/rails_execution/version.rb