rake-ui 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 218a68e063a489cf4b9f781a1f764fbe01439d8f40ab9a7ec2c887993b1b8cc6
+  data.tar.gz: a76cca82acafcb84c0e2039448eb0c0f0fad464dcfc9ad68a5378a7059abfc32
+SHA512:
+  metadata.gz: b68e5dca03e6235494047686a766cc8a15cecb71d3bde9ac3767859d9d0971a00194527c756ac767434e15b3c7a56f833a46f9a80a99d1084bf43bae5b3f5ddb
+  data.tar.gz: f24ad6edc4612031b9cdf53b5df8046ff93a51451d216ed23cd12c7423a7c71469114d0b09e967061a78017af0268a7b5d2802a6ec15cc552a46f7acab38da2e

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,59 @@
+# RakeUi
+Rake UI is a Rails engine that enables the discovery and execution rake tasks in a UI.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do 
+  gem 'rake-ui'
+end
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rake-ui
+```
+
+once it is installed, mount the engine
+```rb
+Rails.application.routes.draw do
+  # only mounting when defined will allow us only include in development/test
+  if defined? RakeUi::Engine
+    mount RakeUi::Engine => "/rake-ui"
+  end
+end
+```
+
+### Securing RakeUi
+
+This tool is built to enable developer productivity in development.  It exposes rake tasks through a UI.
+
+This tool will currently not work in production because we add a guard in the root controller to respond not found if the environment is development or test.  
+
+We recommend adding guards in your route to ensure that the proper authentication is in place to ensure that users are authenticated so that if this were ever to be rendered in production, you would be covered.  The best way for that is [router constraints](https://guides.rubyonrails.org/routing.html#specifying-constraints)
+
+## Testing
+
+`bundle exec rake test`
+
+To iterate on this fast i normally install nodemon, you can also use guard minitest.
+
+```
+# Example with nodemon, you don't have to use this
+npm install -g nodemon
+
+# Running a single test whenever models change
+nodemon -w ./app/models/*  -e "rb" --exec "rake test TEST=test/rake_ui/rake_task_log_test.rb"
+```
+
+## Contributing
+Contributing information available in [CONTRIBUTING](./CONTRIBUTING.md)
+
+## License
+The gem is available as open source under the terms of the [Apache 2.0 License](./LICENSE).

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/assets/config/rake_ui_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/rake_ui

data/app/assets/stylesheets/rake_ui/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/rake_ui/application_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RakeUi
+  class ApplicationController < ActionController::Base
+    before_action :black_hole_production
+
+    private
+
+    def black_hole_production
+      raise ActionController::RoutingError, "Not Found" unless Rails.env.test? || Rails.env.development?
+    end
+  end
+end

data/app/controllers/rake_ui/rake_task_logs_controller.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module RakeUi
+  class RakeTaskLogsController < ApplicationController
+    RAKE_TASK_LOG_ATTRS = [:id,
+      :name,
+      :args,
+      :environment,
+      :rake_command,
+      :rake_definition_file,
+      :log_file_name,
+      :log_file_full_path].freeze
+
+    def index
+      @rake_task_logs = RakeUi::RakeTaskLog.all.sort_by(&:id)
+
+      respond_to do |format|
+        format.html
+        format.json do
+          render json: {
+            rake_task_logs: rake_task_logs_as_json(@rake_task_logs)
+          }
+        end
+      end
+    end
+
+    def show
+      @rake_task_log = RakeUi::RakeTaskLog.find_by_id(params[:id])
+
+      @rake_task_log_content = @rake_task_log.file_contents.gsub("\n", "<br />")
+      @rake_task_log_content_url = rake_task_log_path(@rake_task_log.id, format: :json)
+      @is_rake_task_log_finished = @rake_task_log.finished?
+
+      respond_to do |format|
+        format.html
+        format.json do
+          render json: {
+            rake_task_log: rake_task_log_as_json(@rake_task_log),
+            rake_task_log_content: @rake_task_log_content,
+            rake_task_log_content_url: @rake_task_log_content_url,
+            is_rake_task_log_finished: @is_rake_task_log_finished
+          }
+        end
+      end
+    end
+
+    private
+
+    def rake_task_log_as_json(task)
+      RAKE_TASK_LOG_ATTRS.each_with_object({}) do |param, obj|
+        obj[param] = task.send(param)
+      end
+    end
+
+    def rake_task_logs_as_json(tasks = [])
+      tasks.map { |task| rake_task_log_as_json(task) }
+    end
+  end
+end

data/app/controllers/rake_ui/rake_tasks_controller.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RakeUi
+  class RakeTasksController < RakeUi::ApplicationController
+    RAKE_TASK_ATTRS = [:id,
+      :name,
+      :name_with_args,
+      :arg_description,
+      :full_comment,
+      :locations,
+      :is_internal_task,
+      :sources].freeze
+
+    def index
+      @rake_tasks = RakeUi::RakeTask.all
+
+      unless params[:show_all]
+        @rake_tasks = @rake_tasks.select(&:internal_task?)
+      end
+
+      respond_to do |format|
+        format.html
+        format.json do
+          render json: {
+            rake_tasks: rake_tasks_as_json(@rake_tasks)
+          }
+        end
+      end
+    end
+
+    def show
+      @rake_task = RakeUi::RakeTask.find_by_id(params[:id])
+
+      respond_to do |format|
+        format.html
+        format.json do
+          render json: {
+            rake_task: rake_task_as_json(@rake_task)
+          }
+        end
+      end
+    end
+
+    def execute
+      @rake_task = RakeUi::RakeTask.find_by_id(params[:id])
+
+      rake_task_log = @rake_task.call(args: params[:args], environment: params[:environment])
+
+      redirect_to rake_task_log_path rake_task_log.id
+    end
+
+    private
+
+    def rake_task_as_json(task)
+      RAKE_TASK_ATTRS.each_with_object({}) do |param, obj|
+        obj[param] = task.send(param)
+      end
+    end
+
+    def rake_tasks_as_json(tasks)
+      tasks.map { |task| rake_task_as_json(task) }
+    end
+  end
+end

data/app/helpers/rake_ui/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RakeUi
+  module ApplicationHelper
+  end
+end

data/app/models/rake_ui/rake_task.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module RakeUi
+  class RakeTask
+    def self.to_safe_identifier(id)
+      CGI.escape(id)
+    end
+
+    def self.from_safe_identifier(id)
+      CGI.unescape(id)
+    end
+
+    def self.load
+      # Enables 'desc' to show up as full_comments
+      if Rake::TaskManager.respond_to? :record_task_metadata
+        Rake::TaskManager.record_task_metadata = true
+      end
+
+      Rails.application.load_tasks
+      Rake::Task.tasks
+    end
+
+    def self.all
+      self.load.map do |task|
+        new(task)
+      end
+    end
+
+    def self.internal
+      self.load.map { |task|
+        new(task)
+      }.select(&:is_internal_task)
+    end
+
+    def self.find_by_id(id)
+      t = all
+      i = from_safe_identifier(id)
+
+      t.find do |task|
+        task.name == i
+      end
+    end
+
+    attr_reader :task
+    delegate :name, :actions, :name_with_args, :arg_description, :full_comment, :locations, :sources, to: :task
+
+    def initialize(task)
+      @task = task
+    end
+
+    def id
+      RakeUi::RakeTask.to_safe_identifier(name)
+    end
+
+    # actions will be something like #<Proc:0x000055a2737fe778@/some/rails/app/lib/tasks/auto_annotate_models.rake:4>
+    def rake_definition_file
+      definition = actions.first || ""
+
+      if definition.respond_to?(:source_location)
+        definition.source_location.join(":")
+      else
+        definition
+      end
+    rescue
+      "unable_to_determine_defining_file"
+    end
+
+    def is_internal_task
+      internal_task?
+    end
+
+    # thinking this is the sanest way to discern application vs gem defined tasks (like rails, devise etc)
+    def internal_task?
+      actions.any? { |a| !a.to_s.include? "/ruby/gems" }
+
+      # this was my initial thought here, leaving for posterity in case we need to or the definition of custom
+      # from initial investigation the actions seemed like the most consistent as locations is sometimes empty
+      # locations.any? do |location|
+      #   !location.match(/\/bundle\/gems/)
+      # end
+    end
+
+    def call(args: nil, environment: nil)
+      rake_command = build_rake_command(args: args, environment: environment)
+
+      rake_task_log = RakeUi::RakeTaskLog.build_new_for_command(
+        name: name,
+        args: args,
+        environment: environment,
+        rake_command: rake_command,
+        rake_definition_file: rake_definition_file,
+        raker_id: id
+      )
+
+      puts "[rake_ui] [rake_task] [forked] #{rake_task_log.rake_command_with_logging}"
+
+      fork do
+        system(rake_task_log.rake_command_with_logging)
+
+        system(rake_task_log.command_to_mark_log_finished)
+      end
+
+      rake_task_log
+    end
+
+    # returns an invokable rake command
+    # FOO=bar rake create_something[1,2,3]
+    # rake create_something[1,2,3]
+    # rake create_something
+    def build_rake_command(args: nil, environment: nil)
+      command = ""
+
+      if environment
+        command += "#{environment} "
+      end
+
+      command += "rake #{name}"
+
+      if args
+        command += "[#{args}]"
+      end
+
+      command
+    end
+  end
+end

data/app/models/rake_ui/rake_task_log.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module RakeUi
+  class RakeTaskLog < OpenStruct
+    # year-month-day-hour(24hour time)-minute-second-utc
+    ID_DATE_FORMAT = "%Y-%m-%d-%H-%M-%S%z"
+    REPOSITORY_DIR = Rails.root.join("tmp", "rake_ui")
+    FILE_DELIMITER = "____"
+    FINISHED_STRING = "+++++ COMMAND FINISHED +++++"
+    TASK_HEADER_OUTPUT_DELIMITER = "-------------------------------"
+    FILE_ITEM_SEPARATOR = ": "
+
+    def self.create_tmp_file_dir
+      FileUtils.mkdir_p(REPOSITORY_DIR.to_s)
+    end
+
+    def self.truncate
+      FileUtils.rm_rf(Dir.glob(REPOSITORY_DIR.to_s + "/*"))
+    end
+
+    def self.build_from_file(log_file_name)
+      log_file_name.split(FILE_DELIMITER)
+
+      new(
+        id: log_file_name.gsub(".txt", ""),
+        log_file_name: log_file_name,
+        log_file_full_path: Rails.root.join(REPOSITORY_DIR, log_file_name).to_s
+      )
+    end
+
+    def self.build_new_for_command(name:, rake_definition_file:, rake_command:, raker_id:, args: nil, environment: nil)
+      create_tmp_file_dir
+
+      date = Time.now.strftime(ID_DATE_FORMAT)
+      id = "#{date}#{FILE_DELIMITER}#{raker_id}"
+      log_file_name = "#{id}.txt"
+      log_file_full_path = REPOSITORY_DIR.join(log_file_name).to_s
+
+      File.open(log_file_full_path, "w+") do |f|
+        f.puts "id#{FILE_ITEM_SEPARATOR}#{id}"
+        f.puts "name#{FILE_ITEM_SEPARATOR}#{name}"
+        f.puts "date#{FILE_ITEM_SEPARATOR}#{date}"
+        f.puts "args#{FILE_ITEM_SEPARATOR}#{args}"
+        f.puts "environment#{FILE_ITEM_SEPARATOR}#{environment}"
+        f.puts "rake_command#{FILE_ITEM_SEPARATOR}#{rake_command}"
+        f.puts "rake_definition_file#{FILE_ITEM_SEPARATOR}#{rake_definition_file}"
+        f.puts "log_file_name#{FILE_ITEM_SEPARATOR}#{log_file_name}"
+        f.puts "log_file_full_path#{FILE_ITEM_SEPARATOR}#{log_file_full_path}"
+
+        f.puts TASK_HEADER_OUTPUT_DELIMITER.to_s
+        f.puts " INVOKED RAKE TASK OUTPUT BELOW"
+        f.puts TASK_HEADER_OUTPUT_DELIMITER.to_s
+      end
+
+      new(id: id,
+          name: name,
+          args: args,
+          environment: environment,
+          rake_command: rake_command,
+          rake_definition_file: rake_definition_file,
+          log_file_name: log_file_name,
+          log_file_full_path: log_file_full_path)
+    end
+
+    def self.all
+      create_tmp_file_dir
+
+      Dir.entries(REPOSITORY_DIR).reject { |file|
+        file == "." || file == ".."
+      }.map do |log|
+        RakeUi::RakeTaskLog.build_from_file(log)
+      end
+    end
+
+    def self.find_by_id(id)
+      all.find do |a|
+        a.id == id || a.id == RakeUi::RakeTask.to_safe_identifier(id)
+      end
+    end
+
+    def self.for(rake_ui_rake_task)
+      all.select do |history|
+        history.id == rake_ui_rake_task.id
+      end
+    end
+
+    def name
+      super || parsed_log_file_name[:name] || parsed_file_contents[:name]
+    end
+
+    def date
+      super || parsed_log_file_name[:date] || parsed_file_contents[:date]
+    end
+
+    def args
+      super || parsed_file_contents[:args]
+    end
+
+    def environment
+      super || parsed_file_contents[:environment]
+    end
+
+    def rake_command
+      super || parsed_file_contents[:rake_command]
+    end
+
+    def rake_definition_file
+      super || parsed_file_contents[:rake_definition_file]
+    end
+
+    def log_file_name
+      super || parsed_file_contents[:log_file_name]
+    end
+
+    def log_file_full_path
+      super || parsed_file_contents[:log_file_full_path]
+    end
+
+    def rake_command_with_logging
+      "#{rake_command} 2>&1 >> #{log_file_full_path}"
+    end
+
+    def file_contents
+      @file_contents ||= File.read(log_file_full_path)
+    end
+
+    def command_to_mark_log_finished
+      "echo #{FINISHED_STRING} >> #{log_file_full_path}"
+    end
+
+    def finished?
+      file_contents.include? FINISHED_STRING
+    end
+
+    private
+
+    # converts standard formatted file id into an object
+    def parsed_log_file_name
+      @parsed_log_file_name ||= {}.tap do |parsed|
+        date, name = id.split(FILE_DELIMITER, 2)
+        parsed[:date] = date
+        parsed[:name] = RakeUi::RakeTask.from_safe_identifier(name)
+      end
+    end
+
+    # converts our persisted rake logs files into an object
+    # name: foo
+    # id: baz
+    #
+    # into
+    #
+    # { name: 'foo', id: 'baz' }
+    def parsed_file_contents
+      return @parsed_file_contents if defined? @parsed_file_contents
+
+      @parsed_file_contents = {}.tap do |parsed|
+        File.foreach(log_file_full_path).first(9).each do |line|
+          name, value = line.split(FILE_ITEM_SEPARATOR, 2)
+          next unless name
+
+          parsed[name] = value && value.delete("\n")
+        end
+      end.with_indifferent_access
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rake ui</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <link rel="stylesheet" href="https://cdn.rawgit.com/doximity/vital/v2.2.1/dist/css/vital.min.css">
+</head>
+<body>
+
+  <!-- Nav Menu -->
+  <div class="row header">
+    <div class="section">
+      <nav>
+        <ul class="menu">
+          <li><%= link_to "Logs", rake_task_logs_path %></li>
+          <li><%= link_to "Rake Tasks", rake_tasks_path %></li>
+        </ul>
+      </nav>
+    </div>
+  </div>
+
+  <p id="notice"><%= notice %></p>
+
+  <!-- End Nav Menu -->
+  <div class="contents">
+    <%= yield %>
+  </div>
+</body>
+</html>

data/app/views/partials/rake_ui/_table_filterable.html

@@ -0,0 +1,47 @@
+<script type="application/javascript">
+    function _hideTableElement(elm) {
+        elm.style.display = "none";
+    }
+
+    function _showTableElement(elm) {
+        elm.style.display = "";
+    }
+
+    function _filterTable(value) {
+        var tableRows = document.querySelectorAll('[data-table-filterable]');
+
+        for (var i = 0; i < tableRows.length; i++) {
+            var row = tableRows[i];
+
+            if (value == "") {
+                _showTableElement(row)
+            } else {
+                if (row.dataset.tableFilterable.includes(value)) {
+                    _showTableElement(row)
+                } else {
+                    _hideTableElement(row)
+                }
+            }
+        }
+    }
+
+    var _tableFilterInput = document.querySelector('[data-table-filter]');
+
+    var _hasFilteredTableInput = false;
+    _tableFilterInput.addEventListener('input', function handleInput(input) {
+        _hasFilteredTableInput = true;
+        _filterTable(input.target.value)
+    })
+
+    _tableFilterInput.addEventListener('input', function handleInput(input) {
+        _hasFilteredTableInput = true;
+        _filterTable(input.target.value)
+    })
+
+    // Handling cases where the browser autofills on a back button navigation due to the bfc
+    window.addEventListener('pageshow', function() {
+      if (!_hasFilteredTableInput && _tableFilterInput) {
+          _filterTable(_tableFilterInput.value)
+      }
+    });
+</script>

data/app/views/rake_ui/rake_task_logs/index.html.erb

@@ -0,0 +1,35 @@
+<div class="row">
+  <div class="section">
+    <h1>Status</h1>
+
+    <hr >
+
+    <div class="section">
+      <p>
+        Filter Table <input data-table-filter placeholder="Enter Text" />
+      </p>
+    </div>
+
+    <table>
+      <thead>
+      <tr>
+        <th>Actions</th>
+        <th>Date Ran</th>
+        <th>Rake Task</th>
+      </tr>
+      </thead>
+
+      <tbody>
+      <% @rake_task_logs.each do |rake_task_log| %>
+        <tr data-table-filterable="<%= rake_task_log.name %>">
+          <td><%= link_to "View Logs", rake_task_log_path(rake_task_log.id), { class: 'btn' } %></td>
+          <td><%= rake_task_log.date %></td>
+          <td><%= link_to rake_task_log.name, rake_task_log_path(rake_task_log.id) %></td>
+        </tr>
+      <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>
+
+<%= render "partials/rake_ui/table_filterable" %>

data/app/views/rake_ui/rake_task_logs/show.html.erb

@@ -0,0 +1,42 @@
+<div class="row">
+  <div class="section">
+
+    <h1>Rake Task Log</h1>
+
+    <hr />
+
+    <div id="log_content" class="overflow-y: scroll">
+      <%= @rake_task_log_content.html_safe %>
+    </div>
+
+    <script type="application/javascript">
+    var interval;
+    var content_url = "<%= @rake_task_log_content_url %>"
+    var is_requesting = false
+
+    function replaceContent(content) {
+      document.getElementById('log_content').innerHTML = content
+    }
+
+    interval = setInterval(function () {
+      if (is_requesting) { return }
+      is_requesting = true;
+      fetch(content_url)
+        .then(function(r) { return r.json() })
+        .then(function (r) {
+          replaceContent(r.rake_task_log_content)
+
+          if (r.is_rake_task_log_finished) {
+            clearInterval(interval)
+          }
+          is_requesting = false
+        })
+        .catch(function(err) {
+          is_requesting = false
+          clearInterval(interval)
+          throw(err)
+        })
+    }, 500)
+  </script>
+  </div>
+</div>

data/app/views/rake_ui/rake_tasks/index.html.erb

@@ -0,0 +1,47 @@
+<div class="row">
+  <div class="section">
+    <h1>Rake Tasks</h1>
+
+    <hr />
+
+    <div class="section">
+      <%= link_to "Show all tasks", rake_tasks_path(show_all: "yes"), { class: 'btn' } %>
+      <%= link_to "Show only internal tasks", rake_tasks_path, { class: 'btn' } %>
+    </div>
+
+    <div class="section">
+      <p>
+        Filter Table <input data-table-filter placeholder="Enter Text" />
+      </p>
+    </div>
+
+    <div style="word-break: break-all">
+      <table>
+        <thead>
+        <tr>
+          <th>Actions</th>
+          <th>Name </th>
+        </tr>
+        </thead>
+
+        <tbody>
+        <% @rake_tasks.each do |rake_task| %>
+          <tr data-table-filterable="<%= rake_task.name_with_args %>">
+            <td><%= link_to "Go Here", rake_task_path(rake_task.id), { class: 'btn' } %></td>
+            <td>
+              <%= link_to rake_task.name_with_args, rake_task_path(rake_task.id) %>
+
+              <% if rake_task.full_comment %>
+                <br />
+                <p> Desc: <%= rake_task.full_comment %></p>
+              <% end %>
+            </td>
+          </tr>
+        <% end %>
+        </tbody>
+      </table>
+    </div>
+  </div>
+</div>
+
+<%= render "partials/rake_ui/table_filterable" %>

data/app/views/rake_ui/rake_tasks/show.html.erb

@@ -0,0 +1,62 @@
+<div class="row">
+  <div class="section">
+    <h2>Submit Rake Task</h2>
+    <h4>Task: <%= @rake_task.name_with_args %></h4>
+
+    <% if @rake_task.full_comment %>
+      <p>Comments: <%= @rake_task.full_comment %></p>
+    <% end %>
+
+    <hr />
+
+    <p data-rake-form-error style="color: red">
+
+    </p>
+
+    <%= form_with url: rake_task_execute_path(@rake_task.id), method: :post, class: 'full-width-forms', data: {"rake-form": true} do |f| %>
+      <label>
+        Rake Arguments
+        <%= f.text_field :args, placeholder: "with no brackets, eg: 1,2,3", data: { "rake-form-input-args": true } %>
+      </label>
+
+      <br />
+
+      <label>
+        Environment Variables Overrides
+        <%= f.text_field :environment, placeholder: "eg: FOO=bar BAZ=biz", data: { "rake-form-input-environment": true }  %>
+      </label>
+
+      <p>
+        Skip Argument and Environment Validations: <input type="checkbox" data-rake-form-input-skip-validations="true" />
+      </p>
+
+      <%= f.submit "Submit", class: "btn solid blue" %>
+    <% end %>
+  </div>
+</div>
+
+<script type="application/javascript">
+  var _rakeForm = document.querySelector("[data-rake-form]");
+
+  var _skipValidationInput = document.querySelector("[data-rake-form-input-skip-validations]")
+  var _environmentInput = document.querySelector("[data-rake-form-input-environment]")
+  var _argsInput = document.querySelector("[data-rake-form-input-args]")
+  var _formError = document.querySelector("[data-rake-form-error]")
+
+  function _failWithError(event, message) {
+    event.preventDefault()
+    _formError.innerHTML = message;
+  }
+
+  _rakeForm.addEventListener("submit", function handleFormSubmit(event) {
+    if (_skipValidationInput.checked) {
+      return;
+    }
+
+    var argValue = _argsInput.value;
+    if (argValue.includes(" ") || argValue.includes("[") || argValue.includes("]")) {
+      _failWithError(event, "Do not include spaces or brackets in your rake arguments, disable validation if needed")
+    }
+  })
+
+</script>

data/config/routes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+RakeUi::Engine.routes.draw do
+  root to: "rake_tasks#index"
+
+  resources :rake_tasks, only: [:index, :show]
+
+  post "/rake_tasks/:id/execute", to: "rake_tasks#execute", as: "rake_task_execute"
+
+  resources :rake_task_logs, only: [:index, :show]
+end

data/lib/rake-ui.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "rake-ui/engine"
+
+module RakeUi
+end

data/lib/rake-ui/engine.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rake"
+require "fileutils"
+require "open3"
+
+module RakeUi
+  class Engine < ::Rails::Engine
+    isolate_namespace RakeUi
+  end
+end

data/lib/rake-ui/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RakeUi
+  VERSION = "0.0.1"
+end

data/lib/tasks/rake_ui/tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :rake_ui do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: rake-ui
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Austin Story
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem creates a Web Interface for interacting with Rake tasks.
+email:
+- lonnieastory@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/config/rake_ui_manifest.js
+- app/assets/stylesheets/rake_ui/application.css
+- app/controllers/rake_ui/application_controller.rb
+- app/controllers/rake_ui/rake_task_logs_controller.rb
+- app/controllers/rake_ui/rake_tasks_controller.rb
+- app/helpers/rake_ui/application_helper.rb
+- app/models/rake_ui/rake_task.rb
+- app/models/rake_ui/rake_task_log.rb
+- app/views/layouts/rake_ui/application.html.erb
+- app/views/partials/rake_ui/_table_filterable.html
+- app/views/rake_ui/rake_task_logs/index.html.erb
+- app/views/rake_ui/rake_task_logs/show.html.erb
+- app/views/rake_ui/rake_tasks/index.html.erb
+- app/views/rake_ui/rake_tasks/show.html.erb
+- config/routes.rb
+- lib/rake-ui.rb
+- lib/rake-ui/engine.rb
+- lib/rake-ui/version.rb
+- lib/tasks/rake_ui/tasks.rake
+homepage: https://github.com/doximity/rake-ui
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/doximity/rake-ui
+  source_code_uri: https://github.com/doximity/rake-ui
+  changelog_uri: https://github.com/doximity/rake-ui/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A Mountable Rails Engine to manage Rake Tasks through a UI
+test_files: []