editus 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3cec41e8e70a12bb3dd860f31729437bad4870ff201eb3a4892be778fdcf8558
+  data.tar.gz: 76b985c2519cb34198be4ce940128f1dd6265347e3ea48ec1cb1ceb5335b6028
+SHA512:
+  metadata.gz: e705129944f1362d82e5dc9d749547ffd4ec0d59a4d315a0b90149f843f073f4dde0522ff3ec997b7d45c29b23780df1e4a56e94ac7a239b16e087c776e1a5c4
+  data.tar.gz: 4b7d829b9c4df393a913f9b05eaebfa149c6953189ad413204e47e358409a8d1e35dfbbb0398d566686e31461729b64185e0d12a5566fe023d78733ea2fa14a8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 hungkieu
+
+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

@@ -0,0 +1,94 @@
+# Editus
+Simplify code execution and database editing. Intuitive web interface. Run code snippets, modify databases in real-time.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "editus", git: "https://github.com/muoihai-com/editus.git"
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Run the following code to create the config file:
+
+```bash
+rake editus:install # It will create file config/initializer/editus.rb
+```
+
+Add the following to your `config/routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  mount Editus::Engine => "/updater" unless Rails.env.production?
+  ...
+end
+```
+
+## Usage
+
+### Authentication
+
+Editus supports two forms of authentication:
+
+  1. Define the `editus_account` method in `ApplicationHelper`: This method should return the current account (e.g., `current_user` or `current_admin`). If this method is defined, Editus will use it to determine the current account.
+
+```ruby
+  module ApplicationHelper
+    def editus_account
+      current_user # or any other method that returns the current account
+    end
+  end
+ ```
+    
+  2. Configuration in the config/initializer/editus.rb file: Create an array containing accounts authenticated via HTTP Basic Authentication. Each account is a sub-array with two elements: the username and password.
+
+```ruby
+config.auth = [%w[user@example.com Pass@123456], %w[manager@example.com Pass@123456]]
+```
+
+Use one of the above authentication methods to secure access to Editus. Note that the `editus_account` method will take precedence if both methods are provided.
+
+### Models
+
+Display a simple form interface that helps you update the fields of the selected model. The update will use `update_columns` so will ignore callback and validate
+
+### Add Script
+
+To execute existing code create a directory `config/editus` in your code
+
+Example:
+`config/editus/update_nick_name_user.rb`
+
+```rb
+Editus::Script.define :update_nick_name_user do
+  title "Update nick_name of user"
+  task :up do
+    user = User.find(1)
+    nick_name = user.nick_name
+    user.update_columns nick_name: "xatara"
+
+    [1, nick_name]
+  end
+
+  task :down do |id, nick_name|
+    User.find(id).update_columns(nick_name: nick_name)
+  end
+end
+
+```
+
+Make sure the filename and the defined name are the same. In the above code `title` to set the title of the code.
+`task :up` is the code that will be executed when you run it.
+`task :down` is the code that will be executed when you undo, if you don't need to undo you can skip it.
+
+It can use the result returned from the `up` function to use as an input parameter
+
+## Contributing
+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

@@ -0,0 +1,18 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/editus/application_controller.rb

@@ -0,0 +1,51 @@
+module Editus
+  class ApplicationController < ActionController::Base
+    prepend ::ApplicationHelper
+
+    before_action :authenticate!, :set_locale
+
+    rescue_from "StandardError" do |exception|
+      @exception = exception
+
+      render "editus/supports/bug"
+    end
+
+    def authenticate!
+      return if editus_auth_account.present?
+      return head 401 if editus_account_needed?
+      return if authenticate(Editus.configuration.auth)
+
+      request_http_basic_authentication
+    end
+
+    def authenticate auth_configs
+      return true if auth_configs.blank?
+
+      authenticate_with_http_basic do |u, p|
+        session[:basic_auth_account] = u if auth_configs.include?([u, p])
+      end
+    end
+
+    def set_locale
+      I18n.locale = :en
+    end
+
+    private
+
+    def editus_account_needed?
+      ::ApplicationHelper.method_defined?(:editus_account)
+    end
+
+    def editus_auth_account
+      if editus_account_needed?
+        editus_account if editus_account.is_a?(ActiveRecord::Base)
+      else
+        session[:basic_auth_account]
+      end
+    end
+
+    def request_account
+      editus_auth_account.try(:email) || session[:basic_auth_account] || request.remote_ip
+    end
+  end
+end

data/app/controllers/editus/home_controller.rb

@@ -0,0 +1,121 @@
+require_dependency "editus/application_controller"
+
+module Editus
+  class HomeController < ApplicationController
+    before_action :load_model, :load_record, :load_column
+
+    def index
+      @scripts = Editus::Script.all.values
+      @actions = Editus::Actions.all.reverse
+    end
+
+    def validate
+      @record.assign_attributes user_params
+      @changes = @record.changes.transform_values do |(from, to)|
+        "From #{from.nil? ? 'null' : from} to #{to}"
+      end
+      @validate_error_flag = !@record.valid?
+      @full_messages = @record.errors.full_messages
+
+      render "validate"
+    end
+
+    def update
+      @record.assign_attributes user_params
+      return redirect_to(root_path) unless @record.changed?
+
+      action = Editus::Action.new
+      action.changes = @record.changes
+      action.type = "models"
+      action.user = request_account
+      action.model_id = @record.id
+      action.model_name = @record.klass.class.name
+      action.save
+      @record.update_columns user_params
+
+      redirect_to root_path
+    end
+
+    def manual_update
+      @model_names = Editus::Client.models
+    end
+
+    def scripts
+      @scripts = Editus::Script.all.values
+    end
+
+    def run_script
+      script = Editus::Script.all[params[:id].to_sym]
+      return redirect_to(root_path) if script.blank?
+
+      action = Editus::Action.new
+      action.type = "scripts"
+      action.user = request_account
+      action.model_id = script.name
+      action.model_name = script.title
+      action.changes = script.proxy.up if script.proxy.respond_to?(:up)
+      action.save
+
+      redirect_to root_path
+    end
+
+    def undo
+      action = Editus::Actions.all.find{|act| act.id == params[:id]}
+      return redirect_to(root_path) if action.blank?
+
+      new_action = Editus::Action.new
+      new_action.type = "undo"
+      new_action.user = request_account
+      new_action.model_id = action.id
+      new_action.model_name = action.model_name
+      case action.type
+      when "models"
+        pr = action.changes.transform_values{|(from, _to)| from}
+        record = action.model_name.constantize.find(action.model_id)
+        record.assign_attributes pr
+        new_action.changes = record.changes
+        record.update_columns pr
+      when "scripts"
+        script = Editus::Script.all[action.model_id.to_sym]
+        return redirect_to(root_path) if action.blank?
+
+        if script.proxy.respond_to?(:down)
+          action.changes.empty? ? script.proxy.down : script.proxy.down(*action.changes)
+        end
+      end
+      new_action.save
+
+      redirect_to root_path
+    end
+
+    private
+
+    def load_model
+      return if params[:klass].blank?
+
+      @proxy = Editus::Client.model(params[:klass])
+      return if @proxy.blank?
+
+      @column_names = @proxy.column_names
+    rescue NameError
+      redirect_to manual_update_path
+    end
+
+    def load_record
+      return if @proxy.blank? || params[:attribute].blank? || params[:value].blank?
+
+      @record = @proxy.find_by(params[:attribute] => params[:value])
+    end
+
+    def load_column
+      return if params[:column].blank? || @record.try(params[:column]).blank?
+
+      @update_value = @record.try(params[:column])
+    end
+
+    def user_params
+      params[:user]&.each{|key, _| params[:user].delete(key) if params[:user][key].blank?}
+      (params[:user] || {}).as_json
+    end
+  end
+end

data/app/helpers/editus/application_helper.rb

@@ -0,0 +1,4 @@
+module Editus
+  module ApplicationHelper
+  end
+end

data/app/helpers/editus/home_helper.rb

@@ -0,0 +1,18 @@
+module Editus
+  module HomeHelper
+    def path_active? path
+      request.original_url.include?(path)
+    end
+
+    def field_tag record, col, *args
+      if record.try(col).is_a?(Time)
+        text_field_tag(*args, placeholder: "YYYY-MM-DD HH:mm:ss UTC")
+      elsif [true, false].include? record.try(col)
+        safe_join [hidden_field_tag(args.first, "false", id: nil),
+          check_box_tag(args.first, "true", record.try(col))]
+      else
+        text_field_tag(*args)
+      end
+    end
+  end
+end

data/app/models/editus/application_record.rb

@@ -0,0 +1,5 @@
+module Editus
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/editus/home/index.html.erb

@@ -0,0 +1,79 @@
+<div class="ui main text container">
+  <h1 class="ui header">Scripts</h1>
+ 
+  <% if @scripts.blank? %>
+    <div class="ui placeholder segment">
+      <div class="ui icon header">
+        <i class="file code outline icon"></i>
+        No scripts are listed.
+      </div>
+      <%= link_to 'https://github.com/muoihai-com/editus#add-script', target: "_blank" do %>
+        <div class="ui primary button">
+          Tutorial - Add Script
+        </div>
+      <% end %>
+    </div>
+  <% else %>
+    <div class="ui relaxed divided list">
+    <% @scripts.each do |script| %>
+      <div class="item">
+        <div class="content">
+          <%= link_to "#{scripts_path}##{script.name}", class: "header" do %>
+            <div class="ui horizontal label">#<%= script.name %></div>
+            <%= script.title %>
+          <% end %>
+        </div>
+      </div>
+    <% end %>
+    </div>
+  <% end %>
+
+  <h1 class="ui header">Histories</h1>
+  <div class="ui cards flex-column">
+    <% if @actions.blank? %>
+      <div class="ui placeholder segment">
+        <div class="ui icon header">
+          <i class="calendar alternate outline icon"></i>
+          No action has been taken yet
+        </div>
+      </div>
+    <% else %>
+      <% @actions.each do |action| %>
+        <div class="ui card w-full" id="action-<%= action.id %>">
+          <div class="content">
+          <div class="header"><%= action.user %></div>
+          <% if action.type == "models" %>
+            <div class="meta">updated <b><%= action.model_name %>#<%= action.model_id %></b> <%= time_ago_in_words(action.created_at) %> ago</div>
+          <% elsif action.type == "scripts"%>
+            <div class="meta">used script <b><%= link_to action.model_name, "#{scripts_path}##{action.model_id}" %></b> <%= time_ago_in_words(action.created_at) %> ago</div>
+          <% elsif action.type == "undo"%>
+            <div class="meta">undo action <b><%= link_to action.model_id, "##{action.model_id}", class: "action" %></b> <%= time_ago_in_words(action.created_at) %> ago</div>
+          <% end %>
+          <div class="description">
+            <% if (action.type == "models" || action.type == "undo") && action.changes %>
+              <pre class="bg-neutral-300 rounded p-4">
+                <%= action.changes.transform_values{|(from, to)| "From #{from.nil? ? 'null' : from} to #{to}"} %>
+              </pre>
+            <% elsif action.type == "scripts" && action.changes %>
+              <pre class="bg-neutral-300 rounded p-4">
+                <%= action.changes %>
+              </pre>
+            <% end %>
+          </div>
+          </div>
+          <% if action.type != "undo" %>
+            <div class="extra content">
+              <button class="ui labeled icon button red confirmation" data-method="undo" data-id="<%= action.id %>">
+                <i class="undo icon"></i>
+                Undo
+              </button>
+
+              <%= form_tag undo_path(id: action.id), method: :post, id: action.id do %>
+              <% end %>
+            </div>
+          <% end %>
+        </div>
+      <% end %>
+    <% end %>
+  </div>
+</div>

data/app/views/editus/home/manual_update.html.erb

@@ -0,0 +1,91 @@
+<div class="ui main text container">
+  <h1 class="ui header">Models</h1>
+</div>
+
+<%= form_tag validate_path, class: 'ui form warning' do %>
+  <div class="ui mt-4 text container">
+    <p>
+      <%= select_tag "klass", options_for_select(@model_names.sort, params[:klass]), prompt: "Select a model", id: 'select-klass' %>
+    </p>
+
+    <% if params[:klass].present? %>
+      <p>
+      find by <%= text_field_tag "attribute", params[:attribute] || 'id', placeholder: "Id, Email,..." %>
+      </p>
+      <p>
+      with value <%= text_field_tag "value", params[:value], placeholder: "value..." %>
+      </p>
+      <p>
+        <button class="ui button blue" id="find">Find</button>
+      </p>
+    <% end %>
+  </div>
+  <% if @record.present? %>
+    <div class="ui mt-4 px-4 container">
+      <table class="ui celled table">
+        <thead>
+            <tr>
+                <th>Attribute</th>
+                <th>Value</th>
+                <th>Update</th>
+            </tr>
+        </thead>
+        <tbody>
+            <% @column_names.each do |col| %>
+              <tr>
+                <td><%= col %></td>
+                <td class="w-3/5"><%= @record.try(col) %></td>
+                <td>
+                  <% if [true, false].include? @record.try(col) %>
+                    <%= label_tag "user[#{col}]", class: "flex items-center" do %>
+                      <%= field_tag @record, col, "user[#{col}]", nil %><span class="ml-2">True</span>
+                    <% end %>
+                  <% else %>
+                    <%= field_tag @record, col, "user[#{col}]", nil %>
+                  <% end %>
+                </td>
+              </tr>
+            <% end %>
+        </tbody>
+      </table>
+    </div>
+
+    <div class="ui mt-4 mb-4 text container">
+      <%= submit_tag "Validate", class: "ui button blue" %>
+    </div>
+  
+  <% elsif params[:klass] && params[:attribute] && params[:value] %>
+    <div class="ui mt-4 text container">
+      <div class="ui warning message">
+        <i class="warning icon"></i>
+        Record Not Found
+      </div>
+    </div>
+  <% end %>
+<% end %>
+
+<script>
+  function selectClassChange(e) {
+    const value = e.target.value
+
+    window.location.href = `${window.location.origin}${window.location.pathname}?klass=${value}`
+  }
+
+  function findBy(e) {
+    e.preventDefault()
+
+    const attribute = document.getElementById('attribute').value
+    const value = document.getElementById('value').value
+
+    const search = new URLSearchParams()
+    search.set('klass', '<%= params[:klass] %>')
+    search.set('attribute', attribute)
+    search.set('value', value)
+    window.location.href = `${window.location.origin}${window.location.pathname}?${search}`
+  }
+
+  document.addEventListener('DOMContentLoaded', function(event) {
+    document.getElementById('select-klass').addEventListener('change', selectClassChange)
+    document.getElementById('find').addEventListener('click', findBy)
+  });
+</script>

data/app/views/editus/home/scripts.html.erb

@@ -0,0 +1,50 @@
+<div class="ui main text container">
+  <h1 class="ui header">Scripts</h1>
+
+  <% if @scripts.blank? %>
+    <div class="ui placeholder segment">
+      <div class="ui icon header">
+        <i class="file code outline icon"></i>
+        No scripts are listed.
+      </div>
+      <%= link_to 'https://github.com/muoihai-com/editus#add-script', target: "_blank" do %>
+        <div class="ui primary button">
+          Tutorial - Add Script
+        </div>
+      <% end %>
+    </div>
+  <% end %>
+
+  <% @scripts.each do |script| %>
+    <section id="<%= script.name %>">
+      <h1 class="ui header"><%= script.title %></h1>
+      <div>
+        <button class="ui labeled mini icon red button confirmation" data-method="run">
+          <i class="plus icon"></i>
+          Run
+        </button>
+
+        <%= form_tag run_path(id: script.name), method: :post, id: "run" do %>
+        <% end %>
+      </div>
+      <div class="ui accordion">
+        <div class="title">
+          <i class="dropdown icon"></i>
+          Up
+        </div>
+        <div class="content">
+          <div class="transition hidden">
+            <div class="editor"><%= script.up %></div>
+          </div>
+        </div>
+        <div class="title">
+          <i class="dropdown icon"></i>
+          Down
+        </div>
+        <div class="content">
+          <div class="editor"><%= script.down %></div>
+        </div>
+    </section>
+    <div class="ui divider"></div>
+  <% end %>
+</div>

data/app/views/editus/home/validate.html.erb

@@ -0,0 +1,39 @@
+<div class="ui main text container">
+  You have made the following changes: 
+  <pre class="bg-neutral-300 rounded p-4">
+    <%= @changes %>
+  </pre>
+
+  <div class="ui warning message">
+    <div class="header">
+      <%= "Verify that these changes are #{@validate_error_flag ? "invalid" : "valid"}." %>
+    </div>
+    <% if @full_messages.present? %>
+      <pre class="bg-neutral-300 rounded p-4 mx-4">
+        <%= @full_messages.join("\n") %>
+      </pre>
+    <% end %>
+
+    Please be aware that: These updates will skip the validation of the record and may potentially cause data errors.
+  </div>
+
+  <%= form_tag update_path, class: 'pure-form' do %>
+    <%= hidden_field_tag "klass", @record.klass.class %>
+    <%= hidden_field_tag "attribute", 'id' %>
+    <%= hidden_field_tag "value", @record.id %>
+    <% @column_names.each do |col| %>
+      <% next unless @record.try("#{col}_changed?") %>
+      
+      <%= hidden_field_tag "user[#{col}]", @record.try(col) %>
+    <% end %>
+
+    <div class="ui buttons">
+      <%= link_to manual_update_path, class: "ui button" do %>
+        Back
+      <% end %>
+      <div class="or"></div>
+
+      <%= submit_tag "Save", class: "ui button red" %>
+    </div>
+  <% end %>
+</div>

data/app/views/editus/supports/bug.html.erb

@@ -0,0 +1,18 @@
+<div class="ui text main container">
+  <h1 class="ui center aligned icon header">
+    <i class="circular inverted bug icon"></i>
+    Server Error
+  </h1>
+
+  <div class="ui negative message">
+    <div class="header">
+      <%= @exception.class %> - <%= @exception.message %>
+    </div>
+    <p class="break-words">
+      <%= @exception.backtrace.first(10).join("\n") %>
+    </p>
+  </div>
+
+  <div style="height: 2rem;" />
+</div>
+