editus 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cec41e8e70a12bb3dd860f31729437bad4870ff201eb3a4892be778fdcf8558
-  data.tar.gz: 76b985c2519cb34198be4ce940128f1dd6265347e3ea48ec1cb1ceb5335b6028
+  metadata.gz: 60b7c7adcfdb0b6d489e79e0bb946c2a19df3ec8642d6ad701a11400db7e581f
+  data.tar.gz: 10ca7886874f225e7b3ff73d51a3befeee3bc10f09a5f5d6324c535a841a5372
 SHA512:
-  metadata.gz: e705129944f1362d82e5dc9d749547ffd4ec0d59a4d315a0b90149f843f073f4dde0522ff3ec997b7d45c29b23780df1e4a56e94ac7a239b16e087c776e1a5c4
-  data.tar.gz: 4b7d829b9c4df393a913f9b05eaebfa149c6953189ad413204e47e358409a8d1e35dfbbb0398d566686e31461729b64185e0d12a5566fe023d78733ea2fa14a8
+  metadata.gz: 38dbd733e0865a021849d89bcdd8c896082956903bee8ac717d38c09fd9cf62b8f38c857a9fa3a53b3ee39d08d94eee2633e7d216617d7caa66807cc4ddaf417
+  data.tar.gz: 69e48942bbeb9289aff7e256c105dd794fa7ff5aea852d1ddb759122be18e1af41710e778bc4c174447632b6eb959426d1705779bd597dc1468f02dd5447dfe0

data/README.md

@@ -1,11 +1,30 @@
 # Editus
-Simplify code execution and database editing. Intuitive web interface. Run code snippets, modify databases in real-time.
 
-## Installation
+[![Gem Version](https://badge.fury.io/rb/editus.svg)](https://badge.fury.io/rb/editus)
+
+Streamline your coding and database editing processes with Editus. Its intuitive web interface allows you to execute code snippets and perform real-time database modifications with ease.
+
+# Table of contents
+
+- [Editus](#editus)
+- [Table of contents](#table-of-contents)
+- [Installation](#installation)
+- [Usage](#usage)
+  * [Authentication](#authentication)
+  * [Models](#models)
+  * [Add Script](#add-script)
+    + [Query](#query)
+- [Contributing](#contributing)
+- [License](#license)
+
+<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>
+
+
+# Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "editus", git: "https://github.com/muoihai-com/editus.git"
+gem "editus"
 ```
 
 And then execute:
@@ -23,14 +42,14 @@ Add the following to your `config/routes.rb`:
 
 ```ruby
 Rails.application.routes.draw do
-  mount Editus::Engine => "/updater" unless Rails.env.production?
+  mount Editus::Engine => "/editus" unless Rails.env.production?
   ...
 end
 ```
 
-## Usage
+# Usage
 
-### Authentication
+## Authentication
 
 Editus supports two forms of authentication:
 
@@ -52,11 +71,19 @@ config.auth = [%w[user@example.com Pass@123456], %w[manager@example.com Pass@123
 
 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
+## 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
+You can configure to display only the models and fields that you allow:
+
+```
+config.models = ["User", {name: "Admin", fields: %w[name], exclude_fields: %w[id]}]
+```
+
+For the `Admin` model specified using the fields key. Additionally, the exclude_fields key is used to exclude the `id` field from being displayed.
+
+## Add Script
 
 To execute existing code create a directory `config/editus` in your code
 
@@ -66,12 +93,12 @@ Example:
 ```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"
+  task :up do |id, new_nick_name|
+    user = User.find(id)
+    old_nick_name = user.nick_name
+    user.update_columns nick_name: new_nick_name
 
-    [1, nick_name]
+    [id, old_nick_name]
   end
 
   task :down do |id, nick_name|
@@ -85,10 +112,23 @@ Make sure the filename and the defined name are the same. In the above code `tit
 `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
+It can use the result returned from the `up` method to use as an input parameter. The `up` method can also accept parameters directly.
+
+### Query
+
+In addition to running the two tasks `up` and `down`, you can perform other small code snippets by using `query`.
+
+```rb
+Editus::Script.define :users do
+  desc "Number of users"
+  query :count_user do
+    User.count
+  end
+end
+```
 
-## Contributing
+# Contributing
 Contribution directions go here.
 
-## License
+# License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/editus/home_controller.rb

@@ -53,12 +53,26 @@ module Editus
       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.changes = script.proxy.up(*parameters) if script.proxy.respond_to?(:up)
       action.save
 
       redirect_to root_path
     end
 
+    def query
+      script = Editus::Script.all[params[:id].to_sym]
+      method = params[:method].to_sym
+      return render json: {status: false, error: :script_not_found}, status: 200 if script.blank?
+
+      unless script.proxy.respond_to?(method)
+        return render json: {status: false, error: :undefined_method},
+                      status: 200
+      end
+
+      result = script.proxy.try(method, *parameters)
+      render json: {status: true, data: result}, status: 200
+    end
+
     def undo
       action = Editus::Actions.all.find{|act| act.id == params[:id]}
       return redirect_to(root_path) if action.blank?
@@ -117,5 +131,9 @@ module Editus
       params[:user]&.each{|key, _| params[:user].delete(key) if params[:user][key].blank?}
       (params[:user] || {}).as_json
     end
+
+    def parameters
+      params[:parameters]&.values || []
+    end
   end
 end

data/app/helpers/editus/home_helper.rb

@@ -5,14 +5,31 @@ module Editus
     end
 
     def field_tag record, col, *args
-      if record.try(col).is_a?(Time)
+      case record.type_of_col(col)
+      when :datetime
         text_field_tag(*args, placeholder: "YYYY-MM-DD HH:mm:ss UTC")
-      elsif [true, false].include? record.try(col)
+      when :boolean
         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
+
+    def parameters proxy, method
+      return [] unless proxy.respond_to?(method)
+
+      proxy.method(method).parameters.filter_map do |(type, value)|
+        value if type.in?(%i[req opt])
+      end
+    end
+
+    def field_enums? record, col
+      record.defined_enums.key?(col.to_s) && record.defined_enums[col].present?
+    end
+
+    def enums record, col
+      record.defined_enums[col].keys.join(", ")
+    end
   end
 end

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

@@ -2,7 +2,7 @@
   <h1 class="ui header">Models</h1>
 </div>
 
-<%= form_tag validate_path, class: 'ui form warning' do %>
+<%= form_tag validate_path, class: 'ui form warning manual' 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' %>
@@ -40,6 +40,10 @@
                     <%= label_tag "user[#{col}]", class: "flex items-center" do %>
                       <%= field_tag @record, col, "user[#{col}]", nil %><span class="ml-2">True</span>
                     <% end %>
+                  <% elsif field_enums?(@record, col) %>
+                    <div class="ui" data-tooltip="<%= enums(@record, col) %>" data-inverted="" data-variation="mini">
+                      <%= field_tag @record, col, "user[#{col}]", nil %>
+                    </div>
                   <% else %>
                     <%= field_tag @record, col, "user[#{col}]", nil %>
                   <% end %>

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

@@ -18,33 +18,157 @@
   <% @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">
+      <% if parameters(script.proxy, :up).present? %>
+        <button class="ui labeled mini icon red button parameters" data-name="<%= script.name %>">
           <i class="plus icon"></i>
           Run
         </button>
+      <% end %>
 
-        <%= form_tag run_path(id: script.name), method: :post, id: "run" do %>
-        <% end %>
+      <div class="ui parameters-<%= script.name %> small modal">
+        <div class="header">
+          <%= parameters(script.proxy, :up).present? ? "Parameters" : "Confirmation" %>
+        </div>
+        <div class="scrolling content">
+          <%= form_tag run_path(id: script.name), method: :post, id: "run-#{script.name}", class: 'ui form' do %>
+            <% parameters(script.proxy, :up).each do |key| %>
+            <div class="inline fields">
+              <div class="two wide field">
+              </div>
+              <div class="six wide field">
+                <label><%= key.to_s.capitalize  %></label>
+              </div>
+              <div class="six wide field">
+                <%= text_field_tag "parameters[#{key}]", nil %>
+              </div>
+            </div>
+            <% end %>
+          <% end %>
+
+          <p class="<%= parameters(script.proxy, :up).present? ? "mt-8" : "" %>">
+            These changes may cause data errors, do you still want to continue?
+          </p>
+        </div>
+        <div class="actions">
+          <div class="ui cancel button">Cancel</div>
+          <div class="ui red ok button">OK</div>
+        </div>
       </div>
       <div class="ui accordion">
         <div class="title">
           <i class="dropdown icon"></i>
-          Up
+          Content
         </div>
         <div class="content">
           <div class="transition hidden">
-            <div class="editor"><%= script.up %></div>
+            <div class="editor"><%= script.content %></div>
           </div>
         </div>
-        <div class="title">
-          <i class="dropdown icon"></i>
-          Down
-        </div>
-        <div class="content">
-          <div class="editor"><%= script.down %></div>
-        </div>
+
+        <% if script.queries.present? %>
+          <div class="title">
+            <i class="dropdown icon"></i>
+            Queries
+          </div>
+          <div class="content">
+            <div class="transition hidden">
+              <div class="ui middle aligned selection list">
+                <% script.queries.each_with_index do |query, index| %>
+                  <% query_key = "#{script.name}-#{index}" %>
+
+                  <div class="item flex items-center justify-space-between query" data-index="<%= query_key %>">
+                    <div class="content">
+                      <%= query[:description] %>
+                    </div>
+                    <div class="content">
+                      <div class="ui mini icon primary button">
+                        <i class="terminal icon"></i>
+                      </div>
+                    </div>
+                  </div>
+
+                  <div class="ui query_<%= query_key %> small modal">
+                    <div class="header">
+                      Query
+                    </div>
+                    <div class="scrolling content">
+                      <%= form_tag query_path(id: script.name, method: query[:query_name]), method: :post, id: "query_form_#{query_key}", class: 'ui form' do %>
+                        <% parameters(script.proxy, query[:query_name]).each do |key| %>
+                          <div class="inline fields">
+                            <div class="two wide field">
+                            </div>
+                            <div class="six wide field">
+                              <label><%= key.to_s.capitalize %></label>
+                            </div>
+                            <div class="six wide field">
+                              <%= text_field_tag "parameters[#{key}]", nil %>
+                            </div>
+                          </div>
+                        <% end %>
+                      <% end %>
+
+                      <p class="<%= parameters(script.proxy, query[:query_name]).present? ? "mt-8" : "" %>">
+                        These changes may cause data errors, do you still want to continue?
+                      </p>
+
+                      <button class="ui button primary" id="run_query_<%= query_key %>">
+                        Query
+                      </button>
+
+                      <pre class="bg-neutral-300 rounded p-4" id="pre_query_<%= query_key %>" style="display: none;">
+                      </pre>
+                    </div>
+                    <div class="actions">
+                      <div class="ui cancel button">Close</div>
+                    </div>
+                  </div>
+                <% end %>
+              </div>
+            </div>
+          </div>
+        <% end %>
+      </div>
     </section>
     <div class="ui divider"></div>
   <% end %>
 </div>
+
+<script>
+  $("button.parameters").on("click", function (e) {
+    const name = $(e.currentTarget).data('name')
+
+    $(`.ui.parameters-${name}.modal`)
+      .modal({
+        onApprove: function () {
+          $(`#run-${name}`).submit()
+        }
+      })
+      .modal("show");
+  });
+
+  $(".query").on("click", function (e) {
+    const index = $(e.currentTarget).data('index')
+
+    $(`.ui.query_${index}.modal`).modal("show");
+    $(`#run_query_${index}`).on("click", function() {
+      const formId = `#query_form_${index}`
+      const preId = `#pre_query_${index}`
+      const serializeArray = $(formId).serializeArray()
+      const action = $(formId).attr("action")
+
+      $.post(action, $(formId).serialize()).done(function(res) {
+        if (res.status) {
+          $(preId).text(JSON.stringify(res.data))
+        } else {
+          $(preId).text(`Query Error: ${res.error}`)
+        }
+
+        $(preId).show()
+      });
+    })
+  });
+
+  $('form input').on('keypress', function(e) {
+    return e.which !== 13;
+  });
+</script>

data/app/views/layouts/editus/application.html.erb

@@ -3,7 +3,7 @@
 <head>
   <meta name="viewport" content="width=device-width, initial-scale=1" />
 
-  <title>Model updater</title>
+  <title>Editus</title>
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
 
@@ -48,11 +48,14 @@
         margin-top: 7em;
       }
       .flex{
-        display: flex;
+        display: flex !important;
       }
-      items-center{
+      .items-center{
         align-items: center;
       }
+      .justify-space-between {
+        justify-content: space-between;
+      }
       .flex-column {
         flex-direction: column;
       }
@@ -86,6 +89,9 @@
       .mt-4 {
         margin-top: 1rem;
       }
+      .mt-8 {
+        margin-top: 2rem;
+      }
       .mx-4 {
         margin-bottom: 1rem;
         margin-top: 1rem;
@@ -95,6 +101,7 @@
       }
       pre {
         white-space: pre-line;
+        word-break: break-word;
       }
       .ui.cards>.orange.card, .ui.orange.card, .ui.orange.cards>.card {
         box-shadow: 0 0 0 1px #d4d4d5, 0 0px 3px 1px #f2711c, 0 1px 3px 0 #d4d4d5;
@@ -108,12 +115,18 @@
       .ui.celled.table tr td, .ui.celled.table tr th {
         word-break: break-all;
       }
+      .ui.list>.item.flex:after {
+        display: none;
+      }
+      [data-tooltip][data-variation='mini']:after {
+        font-size: 12px;
+      }
     </style>
 </head>
 <body>
   <div class="ui fixed inverted menu">
     <div class="ui container">
-      <%= link_to 'Model Updater', root_path, class: "header item" %>
+      <%= link_to 'Editus', root_path, class: "header item" %>
       <%= link_to 'Home', root_path, class: "item" %>
       <div class="ui simple dropdown item">
         Menu <i class="dropdown icon"></i>
@@ -146,7 +159,6 @@
         $(".ui.confirmation.modal")
           .modal({
             onApprove: function () {
-              console.log($(e.currentTarget).data('method'))
               switch ($(e.currentTarget).data('method')) {
                 case 'run':
                   $("#" + $(e.currentTarget).data('method')).submit()

data/config/routes.rb

@@ -5,7 +5,7 @@ Editus::Engine.routes.draw do
   get "scripts", to: "home#scripts"
   post "/update", to: "home#update", as: :update
   post "validate", to: "home#validate", as: :validate
-
   post "scripts/:id/run", to: "home#run_script", as: :run
   post "undo/:id", to: "home#undo", as: :undo
+  post "query/:id/:method", to: "home#query", as: :query
 end

data/lib/editus/cop.rb

@@ -33,9 +33,9 @@ module Editus
       return nil if model.blank?
       return nil unless model.is_a?(String) || model.is_a?(Hash)
 
-      name = model.is_a?(String) ? model : model["name"]
-      fields = model.is_a?(Hash) ? model["fields"] : []
-      exclude_fields = model.is_a?(Hash) ? model["exclude_fields"] : []
+      name = model.is_a?(String) ? model : model[:name]
+      fields = model.is_a?(Hash) ? model[:fields] : []
+      exclude_fields = model.is_a?(Hash) ? model[:exclude_fields] : []
 
       {name: name, fields: fields, exclude_fields: exclude_fields}
     end

data/lib/editus/proxy.rb

@@ -29,7 +29,7 @@ module Editus
       info = Editus::Cop.instance.info(klass)
       all = cols
       exclude_fields = info[:exclude_fields] || []
-      fields = info[:fields] ? (all & info[:fields]) : all
+      fields = info[:fields].present? ? (all & info[:fields]) : all
 
       fields - %w[id] - exclude_fields
     end
@@ -55,6 +55,14 @@ module Editus
       klass.update_columns attributes
     end
 
+    def type_of_col column
+      klass.class.columns_hash[column.to_s]&.type
+    end
+
+    def defined_enums
+      klass.class.defined_enums
+    end
+
     private
 
     def cols

data/lib/editus/script.rb

@@ -21,10 +21,16 @@ module Editus
         @scripts[name.to_sym] || @scripts[name.to_sym] = new(name.to_sym)
       end
 
-      attr_accessor :name, :title, :path, :proxy, :content
+      attr_accessor :name, :path, :proxy, :content, :queries
+      attr_writer :title
 
       def initialize name = nil
         @name = name
+        @queries = []
+      end
+
+      def add_query desc, name
+        @queries.push({description: desc, query_name: name})
       end
 
       def up
@@ -34,6 +40,10 @@ module Editus
       def down
         content[/task\s.*down.*do.*\n[\s\S]*?\n\s*end/]
       end
+
+      def title
+        @title || @name.to_s.humanize
+      end
     end
 
     class DSL
@@ -45,6 +55,7 @@ module Editus
 
       def initialize name
         @name = name
+        @query_index = 0
       end
 
       def task method, &block
@@ -59,6 +70,31 @@ module Editus
         internal = Internal.find_or_create @name
         internal.title = txt
       end
+
+      def desc description
+        @description = if description.blank? || !description.is_a?(String)
+          @query_index += 1
+          "Query##{@query_index}"
+        else
+          description
+        end
+      end
+
+      def query method, &block
+        internal = Internal.find_or_create @name
+        internal.proxy ||= Editus::DefinitionProxy.new(@name)
+        query_name = "query_#{method}"
+        internal.proxy.define_singleton_method(query_name, &block)
+        add_query_to_internal internal, query_name
+      end
+
+      private
+
+      def add_query_to_internal internal, query_name
+        description = desc(@description)
+        internal.add_query description, query_name
+        @description = nil
+      end
     end
 
     class Reader

data/lib/editus/version.rb

@@ -1,5 +1,5 @@
 module Editus
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
   SUMMARY = "This application is a simple web interface integrated with an existing Ruby on Rails application. It allows users to directly edit models, run predefined scripts, and easily undo changes."
   DESCRIPTION = <<~DOC
     This application is a user-friendly web interface designed to work with a Ruby on Rails application. With a simple and intuitive web interface, users can conveniently access the features of the application.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: editus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - hungkieu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2023-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -89,7 +89,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="