RubyGems - editus - Versions diffs - 1.0.0 - Mend

editus 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (28) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +94 -0
data/Rakefile +18 -0
data/app/controllers/editus/application_controller.rb +51 -0
data/app/controllers/editus/home_controller.rb +121 -0
data/app/helpers/editus/application_helper.rb +4 -0
data/app/helpers/editus/home_helper.rb +18 -0
data/app/models/editus/application_record.rb +5 -0
data/app/views/editus/home/index.html.erb +79 -0
data/app/views/editus/home/manual_update.html.erb +91 -0
data/app/views/editus/home/scripts.html.erb +50 -0
data/app/views/editus/home/validate.html.erb +39 -0
data/app/views/editus/supports/bug.html.erb +18 -0
data/app/views/layouts/editus/application.html.erb +186 -0
data/config/routes.rb +11 -0
data/lib/editus/actions.rb +51 -0
data/lib/editus/client.rb +31 -0
data/lib/editus/cop.rb +43 -0
data/lib/editus/definition_proxy.rb +7 -0
data/lib/editus/engine.rb +14 -0
data/lib/editus/file.rb +42 -0
data/lib/editus/proxy.rb +64 -0
data/lib/editus/script.rb +77 -0
data/lib/editus/version.rb +11 -0
data/lib/editus.rb +109 -0
data/lib/tasks/editus_tasks.rake +15 -0
metadata +105 -0

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

@@ -0,0 +1,186 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <title>Model updater</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <link rel="preconnect" href="https://fonts.googleapis.com" />
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+    <link
+      href="https://fonts.googleapis.com/css2?family=Noto+Sans:ital,wght@0,400;0,500;0,700;1,400;1,500;1,700&display=swap"
+      rel="stylesheet"
+    />
+    <link
+      rel="stylesheet"
+      href="https://cdnjs.cloudflare.com/ajax/libs/semantic-ui/2.5.0/semantic.min.css"
+      integrity="sha512-KXol4x3sVoO+8ZsWPFI/r5KBVB/ssCGB5tsv2nVOKwLg33wTFP3fmnXa47FdSVIshVTgsYk/1734xSk9aFIa4A=="
+      crossorigin="anonymous"
+      referrerpolicy="no-referrer"
+    />
+    <script
+      src="https://code.jquery.com/jquery-3.1.1.min.js"
+      integrity="sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8="
+      crossorigin="anonymous"
+    ></script>
+    <script
+      src="https://cdnjs.cloudflare.com/ajax/libs/semantic-ui/2.5.0/semantic.min.js"
+      integrity="sha512-Xo0Jh8MsOn72LGV8kU5LsclG7SUzJsWGhXbWcYs2MAmChkQzwiW/yTQwdJ8w6UA9C6EVG18GHb/TrYpYCjyAQw=="
+      crossorigin="anonymous"
+      referrerpolicy="no-referrer"
+    ></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/ace/1.23.0/ace.min.js" integrity="sha512-H7NE0Mw3ElsV/iE8dqG8hNkRkKkQ4C8l1i66QouYmeJZ0jRH/EvtMIOiIYlP6TxktZoExjy8Y+uvzTsJtwPdUQ==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <style>
+      html,body {
+        overflow: auto;
+      }
+      html,
+      body,
+      .ui.text.container {
+        font-family: "Noto Sans", sans-serif;
+      }
+      .break-words{
+        overflow-wrap: break-word;
+      }
+      .main.container {
+        margin-top: 7em;
+      }
+      .flex{
+        display: flex;
+      }
+      items-center{
+        align-items: center;
+      }
+      .flex-column {
+        flex-direction: column;
+      }
+      .w-full {
+        width: 100% !important;
+      }
+      .w-3\/5 {
+        width: 60%;
+      }
+      .bg-neutral-300 {
+        background-color: rgb(212 212 212);
+      }
+      .rounded {
+        border-radius: 0.25rem;
+      }
+      .p-4 {
+        padding: 1rem;
+      }
+      .px-4 {
+        padding: 0 1rem;
+      }
+      .mb-4 {
+        margin-bottom: 1rem;
+      }
+      .ml-2 {
+        margin-left: 0.5rem;
+      }
+      .ml-4 {
+        margin-left: 1rem;
+      }
+      .mt-4 {
+        margin-top: 1rem;
+      }
+      .mx-4 {
+        margin-bottom: 1rem;
+        margin-top: 1rem;
+      }
+      .editor {
+        height: 420px;
+      }
+      pre {
+        white-space: pre-line;
+      }
+      .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;
+      }
+      .ui.cards>.orange.card:hover, .ui.orange.card:hover, .ui.orange.cards>.card:hover {
+        box-shadow: 0 0 0 1px #d4d4d5, 0 0px 5px 1px #f26202, 0 1px 3px 0 #bcbdbd;
+      }
+      .tablewrap {
+        position: relative
+      }
+      .ui.celled.table tr td, .ui.celled.table tr th {
+        word-break: break-all;
+      }
+    </style>
+</head>
+<body>
+  <div class="ui fixed inverted menu">
+    <div class="ui container">
+      <%= link_to 'Model Updater', root_path, class: "header item" %>
+      <%= link_to 'Home', root_path, class: "item" %>
+      <div class="ui simple dropdown item">
+        Menu <i class="dropdown icon"></i>
+        <div class="menu">
+          <%= link_to 'Scripts', scripts_path, class: "item" %>
+          <%= link_to 'Models', manual_update_path, class: "item" %>
+        </div>
+      </div>
+    </div>
+  </div>
+  <%= yield %>
+  <div class="ui modal confirmation">
+      <div class="header">Confirmation</div>
+      <div class="content">
+        <p>
+          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 ok red button">OK</div>
+      </div>
+    </div>
+    <script>
+      $("button.confirmation").on("click", function (e) {
+        $(".ui.confirmation.modal")
+          .modal({
+            onApprove: function () {
+              console.log($(e.currentTarget).data('method'))
+              switch ($(e.currentTarget).data('method')) {
+                case 'run':
+                  $("#" + $(e.currentTarget).data('method')).submit()
+                  break;
+                case 'undo':
+                  console.log($(e.currentTarget).data('id'))
+                  $("#" + $(e.currentTarget).data('id')).submit()
+                  break;
+                default:
+                  break;
+              }
+            }
+          })
+          .modal("show");
+      });
+      $('section .ui.accordion').accordion();
+      $('.editor').each(function(_, ele) {
+        var editor = ace.edit(ele);
+        editor.setTheme("ace/theme/monokai");
+        editor.session.setMode("ace/mode/ruby");
+        editor.setReadOnly(true);
+      })
+      if (window.location.hash) {
+        $('#action-' + window.location.hash.replace('#', '')).addClass('orange')
+      }
+      $('a.action').on("click", function () {
+        setTimeout(() => {
+          $('#action-' + window.location.hash.replace('#', '')).addClass('orange')
+        }, 1000);
+      })
+    </script>
+</body>
+</html>

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,11 @@
+Editus::Engine.routes.draw do
+  root "home#index"
+  get "manual_update", to: "home#manual_update"
+  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
+end

data/lib/editus/actions.rb ADDED Viewed

@@ -0,0 +1,51 @@
+module Editus
+  class Actions
+    class << self
+      def all
+        con = Editus::FileLib.read(
+          Rails.root.join(Editus.configuration.actions_file_path)
+        )
+        json_parse(con)
+      end
+      def create action
+        actions = all.push(action)
+        path = Rails.root.join(Editus.configuration.actions_file_path)
+        Editus::FileLib.write(path, actions.to_json)
+      end
+      def remove action
+        actions = all.push(action)
+        path = Rails.root.join(Editus.configuration.actions_file_path)
+        Editus::FileLib.write(path, actions.to_json)
+      end
+      def json_parse con
+        arr = JSON.parse(con)
+        arr.map do |haction|
+          Action.new(**haction.symbolize_keys)
+        end
+      rescue StandardError
+        []
+      end
+    end
+  end
+  class Action
+    attr_accessor :id, :user, :created_at, :model_id, :model_name, :changes, :type
+    def initialize **args
+      @id = args[:id] || SecureRandom.uuid
+      @created_at = args[:created_at] || Time.now.utc
+      @model_id = args[:model_id]
+      @model_name = args[:model_name]
+      @changes = args[:changes]
+      @type = args[:type]
+      @user = args[:user]
+    end
+    def save
+      Editus::Actions.create self
+    end
+  end
+end

data/lib/editus/client.rb ADDED Viewed

@@ -0,0 +1,31 @@
+module Editus
+  class Client
+    class << self
+      def models
+        all_models = ::ApplicationRecord.descendants.map(&:name)
+        if all_models.blank?
+          Rails.application.eager_load!
+          all_models = ::ApplicationRecord.descendants.map(&:name)
+        end
+        if valid_model_names.blank?
+          all_models
+        else
+          all_models & valid_model_names
+        end
+      end
+      def model name
+        klass = Object.const_get(name)
+        if valid_model_names.present? && !valid_model_names.include?(klass.name)
+          raise Editus::InvalidModelError
+        end
+        Editus::Proxy.new(klass)
+      end
+      def valid_model_names
+        Editus::Cop.valid_model_names
+      end
+    end
+  end
+end

data/lib/editus/cop.rb ADDED Viewed

@@ -0,0 +1,43 @@
+module Editus
+  class Cop
+    def self.instance
+      @instance = new
+    end
+    def self.valid_model_names
+      instance.valid_model_names
+    end
+    def initialize
+      @models = Editus.configuration.models
+      @mapping = @models.map{|model| get_values(model)}.compact
+    end
+    def valid_model_names
+      @valid_model_names ||= @mapping.map{|m| m[:name]}
+    end
+    def info model
+      result = if model.is_a?(String)
+        @mapping.find{|x| x[:name] == model}
+      elsif model.respond_to?(:name)
+        @mapping.find{|x| x[:name] == model.name}
+      end
+      result || {}
+    end
+    private
+    def get_values model
+      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: name, fields: fields, exclude_fields: exclude_fields}
+    end
+  end
+end

data/lib/editus/definition_proxy.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module Editus
+  class DefinitionProxy
+    def initialize name
+      @name = name
+    end
+  end
+end

data/lib/editus/engine.rb ADDED Viewed

@@ -0,0 +1,14 @@
+module Editus
+  class Engine < ::Rails::Engine
+    isolate_namespace Editus
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+    config.after_initialize do
+      Editus.load_file_config
+      Editus.find_definitions
+    end
+  end
+end

data/lib/editus/file.rb ADDED Viewed

@@ -0,0 +1,42 @@
+module Editus
+  class FileLib
+    class << self
+      def instance
+        @instance ||= new
+      end
+      def read path
+        instance.create_file_if_not_exists(path)
+      end
+      def write path, content
+        instance.write_file_if_not_exists path, content
+      end
+    end
+    def write_file_if_not_exists path, content
+      if File.exist?(path)
+        File.write(path, content)
+      else
+        FileUtils.mkdir_p(File.dirname(path))
+        File.open(path, "w") do |file|
+          file.puts content
+        end
+      end
+    end
+    def create_file_if_not_exists path
+      if File.exist?(path)
+        File.read(path)
+      else
+        data = JSON.generate([])
+        FileUtils.mkdir_p(File.dirname(path))
+        File.open(path, "w") do |file|
+          file.puts data
+        end
+        data
+      end
+    end
+  end
+end

data/lib/editus/proxy.rb ADDED Viewed

@@ -0,0 +1,64 @@
+module Editus
+  class Proxy
+    attr_reader :klass
+    def initialize klass
+      @klass = klass
+    end
+    def column_names
+      proxied_columns
+    end
+    def update_columns attributes; end
+    def find_by *args
+      record = klass.find_by(*args)
+      return record if record.blank?
+      RecordProxy.new(record)
+    end
+    def try *args
+      klass.try(*args)
+    end
+    private
+    def proxied_columns
+      info = Editus::Cop.instance.info(klass)
+      all = cols
+      exclude_fields = info[:exclude_fields] || []
+      fields = info[:fields] ? (all & info[:fields]) : all
+      fields - %w[id] - exclude_fields
+    end
+    def method_missing method, *args, &block
+      klass.try(method, *args, &block)
+    end
+    def respond_to_missing? *args
+      klass.send(:respond_to_missing?, *args)
+    end
+    def cols
+      klass.column_names
+    end
+  end
+  class RecordProxy < Proxy
+    def update_columns attributes
+      update_fields = attributes.keys
+      raise Editus::UpdateFieldError if (update_fields - proxied_columns).present?
+      klass.update_columns attributes
+    end
+    private
+    def cols
+      klass.class.column_names
+    end
+  end
+end

data/lib/editus/script.rb ADDED Viewed

@@ -0,0 +1,77 @@
+module Editus
+  module Script
+    class << self
+      def define name, &block
+        Editus::Script::DSL.run(name, &block)
+      end
+      def all
+        Editus::Script::Internal.scripts
+      end
+    end
+    class Internal
+      @scripts = {}
+      class << self
+        attr_reader :scripts
+      end
+      def self.find_or_create name
+        @scripts[name.to_sym] || @scripts[name.to_sym] = new(name.to_sym)
+      end
+      attr_accessor :name, :title, :path, :proxy, :content
+      def initialize name = nil
+        @name = name
+      end
+      def up
+        content[/task\s.*up.*do.*\n[\s\S]*?\n\s*end/]
+      end
+      def down
+        content[/task\s.*down.*do.*\n[\s\S]*?\n\s*end/]
+      end
+    end
+    class DSL
+      TASKS = %w[up down].freeze
+      def self.run name, &block
+        new(name).instance_eval(&block)
+      end
+      def initialize name
+        @name = name
+      end
+      def task method, &block
+        return unless TASKS.include?(method.to_s)
+        internal = Internal.find_or_create @name
+        internal.proxy ||= Editus::DefinitionProxy.new(@name)
+        internal.proxy.define_singleton_method(method, &block)
+      end
+      def title txt
+        internal = Internal.find_or_create @name
+        internal.title = txt
+      end
+    end
+    class Reader
+      def self.read path
+        return unless File.exist?(path)
+        load(path)
+        filename = File.basename(path, ".rb")
+        internal = Internal.find_or_create filename
+        internal.content = File.read(path)
+        internal.path = path
+        true
+      end
+    end
+  end
+end

data/lib/editus/version.rb ADDED Viewed

@@ -0,0 +1,11 @@
+module Editus
+  VERSION = "1.0.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.
+    One of the key features of this application is the ability to directly edit models. This enables users to make changes directly to the data without the need to learn and use complex tools. Through the web interface, users can access and modify the attributes of models with ease.
+    Additionally, the application provides the capability to run predefined scripts. This allows users to perform automated tasks or handle complex data processing through prebuilt scripts. Running these scripts via the web interface saves users time and effort compared to alternative methods.
+  DOC
+end

data/lib/editus.rb ADDED Viewed

@@ -0,0 +1,109 @@
+require_relative "editus/actions"
+require_relative "editus/client"
+require_relative "editus/cop"
+require_relative "editus/definition_proxy"
+require_relative "editus/engine"
+require_relative "editus/file"
+require_relative "editus/proxy"
+require_relative "editus/script"
+require_relative "editus/version"
+module Editus
+  class InvalidModelError < StandardError; end
+  class UpdateFieldError < StandardError; end
+  class Configuration
+    CONFIG_PATH = "config/editus.yml"
+    CONFIG_KEYS = %w[models auth actions_file_path]
+    INITIALIZER_FILE_PATH = "config/initializers/editus.rb"
+    def initialize
+      @table = {
+        models: [],
+        actions_file_path: "tmp/editus/actions.json"
+      }
+    end
+    def [] name
+      @table[name.to_sym]
+    end
+    def []= name, value
+      name = name.to_sym
+      @table[name] = value
+    end
+    private
+    def respond_to_missing? mid, include_private = false
+      mid[/.*(?==\z)/m].present? || super
+    end
+    def method_missing mid, *args
+      len = args.length
+      mname = mid[/.*(?==\z)/m]
+      if mname
+        if len != 1
+          raise ArgumentError, "wrong number of arguments (given #{len}, expected 1)", caller(1)
+        end
+        @table[mname.to_sym] = args[0]
+      elsif len.zero?
+        @table[mid]
+      else
+        begin
+          super
+        rescue NoMethodError => e
+          e.backtrace.shift
+          raise
+        end
+      end
+    end
+  end
+  class << self
+    attr_writer :configuration
+    attr_accessor :definition_file_paths
+  end
+  def self.configuration
+    @configuration ||= Editus::Configuration.new
+  end
+  def self.configure
+    yield(configuration)
+  end
+  self.definition_file_paths = %w[config/editus]
+  def self.find_definitions
+    absolute_definition_file_paths = definition_file_paths.map{|path| File.expand_path(path)}
+    absolute_definition_file_paths.uniq.each do |path|
+      next unless File.directory? path
+      Dir[File.join(path, "*.rb")].sort.each do |file|
+        Editus::Script::Reader.read(file)
+      end
+    end
+  end
+  def self.load_file_config
+    if File.exist?(Rails.root.join(Editus::Configuration::CONFIG_PATH))
+      yaml = File.read(Rails.root.join(Editus::Configuration::CONFIG_PATH))
+      config = YAML.safe_load(yaml)
+      configure do |c|
+        config.each do |key, value|
+          next unless Editus::Configuration::CONFIG_KEYS.include?(key)
+          c[key] = value
+        end
+      end
+    else
+      false
+    end
+  rescue StandardError
+    false
+  end
+end

data/lib/tasks/editus_tasks.rake ADDED Viewed

@@ -0,0 +1,15 @@
+namespace :editus do
+  desc "Generate config file for Editus"
+  task :install do
+    initializer_file_path = Rails.root.join(Editus::Configuration::INITIALIZER_FILE_PATH)
+    content = <<~DOC
+      # Editus.configure do |config|
+        # config.auth = [%w[user@example.com Pass@123456], %w[manager@example.com Pass@123456]]
+        # config.models = ["User", {name: "Admin", fields: %w[name], exclude_fields: %w[id]}]
+        # config.actions_file_path = "tmp/editus/actions.json"
+      # end
+    DOC
+    puts ">>> #{Editus::Configuration::INITIALIZER_FILE_PATH}"
+    File.write(initializer_file_path, content)
+  end
+end