scriptor 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3113e6f5f9a12c71ac148fa619294526176874ea8bd73ccefd6e32cee7b7ab5
-  data.tar.gz: 2997de1697ede585d1d536659438cb4a36932ef313e0c1b52c0cc720efb09be3
+  metadata.gz: 9cbfe438c0b163aed13ee3f067785c77719f9d4dc8632c7054e9e249722b530c
+  data.tar.gz: 24112730551af6d90ef3c0f4ac3fe557a3d4e0adece1913a49fb7663eb892e99
 SHA512:
-  metadata.gz: 648e0d5a14e4843982955278b7f542c84284d96fed4b8194f34c374b80e077566998ba015448f15ad4648845103902ece266248d35b9973144f235015d7b6f56
-  data.tar.gz: b47e844e4c220aa288bd371ed030f304716ef6e8ce52bea2789c5836185ffbf59868191fa5b7cfc5a5109d66b8f389b077e56f65f2dea8a0e4c3692d34d03b8b
+  metadata.gz: 74bc62088328ecf150c2cb8c02617167aa7392576edb955eea7f98785e6b9467082ab861433edb99e72fdc6ac92240f7211f67b0aab394a2348a62be82fc5e82
+  data.tar.gz: a861ce4689eadf74a6d9c814bb1a1691401953c60207ac824e64d8497f1c335dcdae2c1c1aa929bc559306db3bb2355266b3aa38e7c151da9b4ecde59ae44e69

data/README.md

@@ -1,28 +1,42 @@
 # Scriptor
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+Scriptorはscriptフォルダにあるrubyファイルを、ブラウザから実行できるようにしたRails Engineです。
+`Rails 8.0.0 >= 0` の場合 `bin/rails generate scriot my_script` を実行すると `script/myscript.rb` が作成されます。
+(Rails 8.0.0 以上でなくても、scriptフォルダにファイルを置いておけば利用可能です。)
 
-## Installation
-Add this line to your application's Gemfile:
+このscriptをブラウザから一覧で見たり、詳細ページではコードを閲覧したり、実行できます。
 
-```ruby
-gem "scriptor"
-```
+https://github.com/user-attachments/assets/057c75ce-7c8e-4c89-a238-13546b5797f1
 
-And then execute:
-```bash
-$ bundle
-```
 
-Or install it yourself as:
-```bash
-$ gem install scriptor
-```
+
+## 使い方
+
+1. `bundle add scriptor`
+2. `bin/rails generate maintenance_tasks:install` を実行
+    - `config/routes.rb` に `mount Scriptor::Engine => "/scriptor"` が記載されます
+    - `db/migrations/****_create_scriptor_executions.scriptor.rb` ファイルが作成されます
+3. scriptフォルダにスクリプトを作ると、/scriptor ページにスクリプト一覧が並びます
+
+で完成です。
+
+## リリース手順
+
+0. version.rb と Gemfile.lockのscriptorのバージョンが適切か確認しましょう
+
+
+1. gemのbuild
+    ```shell
+    gem build scriptor.gemspec
+    ```
+
+2. gemのpush
+    ```shll
+    gem push scriptor-*.*.*.gem
+    ```
 
 ## 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/app/controllers/scriptor/scripts_controller.rb

@@ -6,14 +6,16 @@ module Scriptor
 
     def show
       @script = Scriptor::Script.find(params[:filename])
+      @executions = Execution.where(script_filename: @script.filename).order(id: :desc)
     end
 
     def run
       script = Scriptor::Script.find(params[:filename])
       args = params[:args].to_s.strip.split
       script.run(*args)
-
-      redirect_to script_path(script.filename, notice: "Script executed successfully.")
+      redirect_to script_path(script.filename), notice: "Script executed successfully."
+    rescue StandardError => e
+      redirect_to script_path(script.filename), alert: "Error executing script: #{e.message}"
     end
   end
 end

data/app/models/scriptor/execution.rb

@@ -0,0 +1,18 @@
+module Scriptor
+  class Execution < ApplicationRecord
+    validates :script_filename, presence: true
+    validates :executed_command, presence: true
+    validates :started_at, presence: true
+
+    enum :status, { running: "running", success: "success", error: "error" }
+
+    #
+    # Rails.rootパスを.に置換。想定として、"ruby /Users/hatsu/..."のように
+    # ruby [space]の直後にRails.root.to_sが現れることを想定しているため、
+    # /^ruby\s+#{Rails.root}/ のような正規表現で置き換える。
+    #
+    def truncated_command
+      executed_command.sub(/^ruby\s+#{Regexp.escape(Rails.root.to_s)}/, "ruby .")
+    end
+  end
+end

data/app/models/scriptor/script.rb

@@ -1,3 +1,5 @@
+require "open3"
+
 module Scriptor
   class Script
     attr_reader :filename, :content
@@ -31,14 +33,26 @@ module Scriptor
       script_path = Rails.root.join("script", "#{filename}.rb")
       raise "Script file does not exist: #{script_path}" unless File.exist?(script_path)
 
+      escaped_args = args.map(&:shellescape).join(" ")
+      command = "ruby #{script_path} #{escaped_args}"
       # Rails 環境が正しくロードされるように Rails.root をカレントディレクトリに設定
+      execution = Execution.create!(
+        script_filename: filename,
+        status: :running,
+        executed_command: command,
+        started_at: Time.current
+      )
       Dir.chdir(Rails.root) do
-        escaped_args = args.map(&:shellescape).join(" ")
-        system("ruby #{script_path} #{escaped_args}")
+        _, err, status = Open3.capture3(command)
+        if status.success?
+          # コマンド成功時の処理
+          execution.update!(status: :success, finished_at: Time.current)
+        else
+          error_message = err.presence || "Command failed with exit status #{status.exitstatus}"
+          execution.update!(status: :error, error_message: error_message.strip, finished_at: Time.current)
+          raise error_message
+        end
       end
-    rescue StandardError => e
-      Rails.logger.error "Error running script #{filename}: #{e.message}"
-      raise e
     end
 
     private

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

@@ -7,12 +7,55 @@
 
   <%= yield :head %>
 
-  <%= stylesheet_link_tag    "scriptor/application", media: "all" %>
+  <%= stylesheet_link_tag "scriptor/application", media: "all" %>
   <script src="https://cdn.tailwindcss.com"></script>
 </head>
-<body>
-
-<%= yield %>
+<body class="bg-gray-900 text-gray-200">
+  <!-- Header -->
+  <header class="bg-gray-800 border-b border-gray-700">
+    <div class="max-w-7xl mx-auto px-4 py-4 flex items-center justify-between">
+      <!-- Left: Title -->
+      <h1 class="text-xl font-bold text-blue-400">
+        <%= link_to "Scriptor", root_path, class: "hover:underline" %>
+      </h1>
+      <!-- Right: GitHub link -->
+      <a href="https://github.com/hatsu38/scriptor" target="_blank" rel="noopener noreferrer"
+         class="flex items-center space-x-2 text-gray-300 hover:text-gray-100 transition">
+        <svg class="h-5 w-5" fill="currentColor" viewBox="0 0 24 24" aria-hidden="true">
+          <path fill-rule="evenodd" clip-rule="evenodd" d="M12 .296C5.372.296 0 5.668 0 12.296c0 5.3 3.438 9.773 8.205 11.368.6.111.82-.258.82-.578 
+             0-.285-.01-1.04-.016-2.039-3.338.726-4.042-1.61-4.042-1.61-.545-1.385-1.333-1.755-1.333-1.755-1.091-.747.083-.732.083-.732 
+             1.205.084 1.84 1.238 1.84 1.238 1.07 1.835 2.807 1.305 3.493.998.108-.776.418-1.305.76-1.606-2.665-.303-5.466-1.333-5.466-5.933 
+             0-1.311.469-2.382 1.237-3.223-.124-.304-.536-1.523.118-3.176 0 0 1.01-.323 3.301 1.23.96-.267 1.98-.399 3-.404 1.02.005 
+             2.04.137 3 .404 2.291-1.553 3.3-1.23 3.3-1.23.655 1.653.243 2.872.12 3.176.77.841 1.237 1.912 1.237 3.223 
+             0 4.61-2.804 5.626-5.476 5.922.43.372.81 1.102.81 2.222 0 1.606-.014 2.903-.014 3.301 0 .321.22.694.825.576C20.565 22.068 
+             24 17.595 24 12.296c0-6.628-5.372-12-12-12z"/>
+        </svg>
+        <span class="font-semibold">GitHub</span>
+      </a>
+    </div>
+  </header>
 
+  <section class="max-w-7xl mx-auto px-4 py-6">
+    <% if notice %>
+      <div class="mb-4 flex items-center space-x-3 bg-green-800 border border-green-500 rounded-md p-4 shadow-lg">
+        <svg class="h-5 w-5 text-green-400 flex-shrink-0" fill="none" stroke="currentColor" viewBox="0 0 24 24"
+             xmlns="http://www.w3.org/2000/svg">
+          <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
+                d="M9 11l3 3L22 4"></path>
+        </svg>
+        <span class="font-semibold"><%= notice %></span>
+      </div>
+    <% elsif alert %>
+      <div class="mb-4 flex items-center space-x-3 bg-red-800 border border-red-500 rounded-md p-4 shadow-lg">
+        <svg class="h-5 w-5 text-red-400 flex-shrink-0" fill="none" stroke="currentColor" viewBox="0 0 24 24"
+             xmlns="http://www.w3.org/2000/svg">
+          <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
+                d="M18.364 5.636L12 12m0 0L5.636 5.636M12 12l0 8"></path>
+        </svg>
+        <span class="font-semibold"><%= alert %></span>
+      </div>
+    <% end %>
+    <%= yield %>
+  </section>
 </body>
 </html>

data/app/views/scriptor/scripts/index.html.erb

@@ -1,5 +1,5 @@
 <div class="min-h-screen bg-gray-900 text-gray-200 py-8">
-  <div class="max-w-4xl mx-auto px-4">
+  <div class="max-w-7xl mx-auto px-4">
     <!-- Header -->
     <h1 class="text-4xl font-bold text-blue-400 mb-8 border-b border-gray-700 pb-2">
       📜 Scripts Explorer
@@ -10,7 +10,12 @@
       <% @scripts.each_with_index do |script, index| %>
         <div class="bg-gray-800 hover:bg-gray-700 p-4 rounded-lg shadow-lg transition duration-200 group">
           <h2 class="text-xl font-semibold mb-2 text-gray-300 group-hover:text-blue-300">
-            <%= index + 1 %>. <%= link_to script.filename, script_path(script.filename), class: "hover:underline" %>
+            <!-- 親要素か、直接テキストを含む要素にtruncateクラスを適用 -->
+            <!-- inline-blockとmax-w-fullを組み合わせることで、最大幅内で省略可能に -->
+            <span class="inline-block max-w-full truncate">
+              <%= index + 1 %>. 
+              <%= link_to script.filename, script_path(script.filename), class: "hover:underline" %>
+            </span>
           </h2>
         </div>
       <% end %>

data/app/views/scriptor/scripts/show.html.erb

@@ -1,5 +1,5 @@
 <div class="min-h-screen bg-gray-900 text-gray-200 py-8">
-  <div class="max-w-4xl mx-auto px-4">
+  <div class="max-w-7xl mx-auto px-4">
     <!-- Header -->
     <h1 class="text-4xl font-bold text-blue-400 mb-8 border-b border-gray-700 pb-2">
       Script Details
@@ -43,6 +43,60 @@
       <% end %>
     </div>
 
+    <!-- Execution History -->
+    <% if @executions.present? %>
+      <div class="bg-gray-800 shadow-lg rounded-lg p-6 mb-6">
+        <!-- タイトル部分をクリックすると開閉 -->
+        <h3 id="execution-history-toggle" class="text-xl font-semibold text-blue-300 mb-4 cursor-pointer flex items-center justify-between select-none">
+          <span>Execution History</span>
+          <svg id="toggle-icon" class="h-5 w-5 text-gray-400 transform transition-transform duration-200" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
+            <!-- 折り畳みアイコン(初期は閉じた状態に見えるように) -->
+            <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M19 9l-7 7-7-7" />
+          </svg>
+        </h3>
+
+        <!-- 初期状態ではhidden -->
+        <div id="execution-history-content" class="space-y-4 hidden">
+          <% @executions.each do |execution| %>
+            <div class="bg-gray-700 rounded-lg p-4 shadow-md flex flex-col sm:flex-row sm:justify-between sm:items-start space-y-4 sm:space-y-0 sm:space-x-4">
+              <div class="flex-1">
+                <div class="mb-6 text-gray-100 font-semibold">
+                  Status:
+                  <% if execution.status == "success" %>
+                    <span class="text-green-400"><%= execution.status.capitalize %></span>
+                  <% else %>
+                    <span class="text-red-400"><%= execution.status.capitalize %></span>
+                  <% end %>
+                </div>
+                <div class="text-sm text-gray-300 mt-1 break-words">
+                  <span class="text-gray-400 font-medium">Command:</span>
+                  <span class="font-mono text-gray-200 max-h-24 overflow-auto">
+                    <%= execution.truncated_command %>
+                  </span>
+                </div>
+                <% if execution.error_message.present? %>
+                  <div class="text-sm text-red-400 mt-2 break-words">
+                    <span class="text-gray-400 font-medium">Error:</span>
+                    <div class="font-mono whitespace-pre-wrap break-words">
+                      <%= execution.error_message %>
+                    </div>
+                  </div>
+                <% end %>
+              </div>
+              <div class="text-right text-sm text-gray-400">
+                <div>Started: <%= execution.started_at.strftime("%Y-%m-%d %H:%M:%S") %></div>
+                <% if execution.finished_at %>
+                  <div>Finished: <%= execution.finished_at.strftime("%Y-%m-%d %H:%M:%S") %></div>
+                <% else %>
+                  <div>Running...</div>
+                <% end %>
+              </div>
+            </div>
+          <% end %>
+        </div>
+      </div>
+    <% end %>
+
     <!-- Back Link -->
     <div class="flex justify-end">
       <%= link_to '⬅️ Back to Index', scripts_path, class: "text-blue-500 hover:text-blue-400 font-medium hover:underline transition duration-200" %>
@@ -71,4 +125,22 @@
     const args = argsInput.value.trim();
     commandPreviewArgs.textContent = args;
   });
+
+  // Toggle execution history
+  const toggleHeading = document.getElementById('execution-history-toggle');
+  const content = document.getElementById('execution-history-content');
+  const toggleIcon = document.getElementById('toggle-icon');
+
+  if (toggleHeading && content) {
+    toggleHeading.addEventListener('click', () => {
+      content.classList.toggle('hidden');
+      // アイコンの向きを切り替え
+      // 開いている場合は上向き矢印、閉じている場合は下向き矢印に
+      if (content.classList.contains('hidden')) {
+        toggleIcon.classList.remove('rotate-180');
+      } else {
+        toggleIcon.classList.add('rotate-180');
+      }
+    });
+  }
 </script>

data/db/migrate/20241219110922_create_scriptor_executions.rb

@@ -0,0 +1,14 @@
+class CreateScriptorExecutions < ActiveRecord::Migration[8.0]
+  def change
+    create_table :scriptor_executions do |t|
+      t.string :script_filename, null: false, index: true
+      t.string :status, null: false
+      t.text :executed_command, null: false
+      t.text :error_message, null: true
+      t.datetime :started_at, null: false
+      t.datetime :finished_at, null: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/scriptor/install_generator.rb

@@ -0,0 +1,16 @@
+module Scriptor
+  class InstallGenerator < Rails::Generators::Base
+    desc "Install Scriptor"
+
+    # Mounts the engine in the host application's config/routes.rb
+    def mount_engine
+      route("mount Scriptor::Engine, at: \"/scriptor\"")
+    end
+
+    # Copies engine migrations to host application and migrates the database
+    def install_migrations
+      rake("scriptor:install:migrations")
+      rake("db:migrate")
+    end
+  end
+end

data/lib/scriptor/version.rb

@@ -1,3 +1,3 @@
 module Scriptor
-  VERSION = "0.0.1".freeze
+  VERSION = "0.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scriptor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - hatsu38
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-18 00:00:00.000000000 Z
+date: 2024-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -51,11 +51,14 @@ files:
 - app/jobs/scriptor/application_job.rb
 - app/mailers/scriptor/application_mailer.rb
 - app/models/scriptor/application_record.rb
+- app/models/scriptor/execution.rb
 - app/models/scriptor/script.rb
 - app/views/layouts/scriptor/application.html.erb
 - app/views/scriptor/scripts/index.html.erb
 - app/views/scriptor/scripts/show.html.erb
 - config/routes.rb
+- db/migrate/20241219110922_create_scriptor_executions.rb
+- lib/generators/scriptor/install_generator.rb
 - lib/scriptor.rb
 - lib/scriptor/engine.rb
 - lib/scriptor/version.rb