Merge remote-tracking branch 'origin' into setup-ci

Author: Austio

.gitignore

@@ -6,6 +6,7 @@
 /test/dummy/db/*.sqlite3
 /test/dummy/db/*.sqlite3-*
 /test/dummy/log/*.log
+/test/dummy/tmp/rake_ui/*
 /test/dummy/storage/
 /test/dummy/tmp/cache/
 /test/dummy/tmp/development_secret.txt

Gemfile

@@ -1,14 +1,12 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 # Specify your gem's dependencies in rake-ui.gemspec.
 gemspec
 
-gem 'jbuilder'
-
 group :development do
-  gem 'sqlite3'
+  gem "sqlite3"
 end
 
-gem 'pry', group: [:development, :test], require: false
-gem 'rails', group: [:development, :test], require: false
+gem "pry", group: [:development, :test], require: false
+gem "rails", group: [:development, :test], require: false

Gemfile.lock

@@ -4,7 +4,6 @@ PATH
     rake-ui (0.1.0)
       actionpack
       activesupport
-      jbuilder
       railties
       rake
 
@@ -75,8 +74,6 @@ GEM
       activesupport (>= 4.2.0)
     i18n (1.8.8)
       concurrent-ruby (~> 1.0)
-    jbuilder (2.11.2)
-      activesupport (>= 5.0.0)
     loofah (2.9.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -151,7 +148,6 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  jbuilder
   pry
   rails
   rake-ui!

README.md

@@ -1,8 +1,5 @@
 # RakeUi
-Short description and motivation.
-
-## Usage
-How to use my plugin.
+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:

Rakefile

@@ -10,8 +10,8 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 

app/controllers/rake_ui/application_controller.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module RakeUi
   class ApplicationController < ActionController::Base
     before_action :guard_not_production
 
     private
 
     def guard_not_production
-      respond :unauthorized unless (Rails.env.test? || Rails.env.development?)
+      respond :unauthorized unless Rails.env.test? || Rails.env.development?
     end
   end
 end

app/controllers/rake_ui/rake_task_logs_controller.rb

@@ -1,11 +1,26 @@
+# 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
+        format.json do
+          render json: {
+            rake_task_logs: rake_task_logs_as_json(@rake_task_logs)
+          }
+        end
       end
     end
 
@@ -18,8 +33,27 @@ def show
 
       respond_to do |format|
         format.html
-        format.json
+        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

app/controllers/rake_ui/rake_tasks_controller.rb

@@ -1,24 +1,43 @@
+# 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
 
-      if !params[:show_all]
+      unless params[:show_all]
         @rake_tasks = @rake_tasks.select(&:internal_task?)
       end
 
       respond_to do |format|
-        format.json
         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.json
         format.html
+        format.json do
+          render json: {
+            rake_task: rake_task_as_json(@rake_task)
+          }
+        end
       end
     end
 
@@ -29,5 +48,17 @@ def execute
 
       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

app/helpers/rake_ui/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RakeUi
   module ApplicationHelper
   end

app/models/rake_ui/rake_task.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RakeUi
   class RakeTask
     def self.load
@@ -12,9 +14,9 @@ def self.all
     end
 
     def self.internal
-      self.load.map do |task|
+      self.load.map { |task|
         new(task)
-      end.select(&:is_internal_task)
+      }.select(&:is_internal_task)
     end
 
     def self.find_by_id(id)
@@ -39,8 +41,14 @@ def id
 
     # actions will be something like #<Proc:0x000055a2737fe778@/some/rails/app/lib/tasks/auto_annotate_models.rake:4>
     def rake_definition_file
-      actions.first
-    rescue StandardError
+      definition = actions.first || ""
+
+      if definition.respond_to?(:source_location)
+        definition.source_location.join(":")
+      else
+        definition
+      end
+    rescue
       "unable_to_determine_defining_file"
     end
 
@@ -50,7 +58,7 @@ def is_internal_task
 
     # 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" }
+      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
@@ -90,16 +98,16 @@ def build_rake_command(args: nil, environment: nil)
       command = ""
 
       if environment
-        command += "#{environment.to_s} "
+        command += "#{environment} "
       end
 
       command += "rake #{name}"
 
       if args
-        command += "[#{args.to_s}]"
+        command += "[#{args}]"
       end
 
       command
     end
   end
-end
+end

app/models/rake_ui/rake_task_log.rb

@@ -1,34 +1,42 @@
+# 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')
+    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 + '/*'))
+      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', ''),
+        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:, args: nil, environment: nil,rake_definition_file:, rake_command:, raker_id:)
+    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 = Rails.root.join('tmp', 'rake_ui', log_file_name).to_s
+      log_file_full_path = REPOSITORY_DIR.join(log_file_name).to_s
 
-      File.open(log_file_full_path, 'w+') do |f|
+      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}"
@@ -39,9 +47,9 @@ def self.build_new_for_command(name:, args: nil, environment: nil,rake_definitio
         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}"
+        f.puts TASK_HEADER_OUTPUT_DELIMITER.to_s
         f.puts " INVOKED RAKE TASK OUTPUT BELOW"
-        f.puts "#{TASK_HEADER_OUTPUT_DELIMITER}"
+        f.puts TASK_HEADER_OUTPUT_DELIMITER.to_s
       end
 
       new(id: id,
@@ -55,9 +63,11 @@ def self.build_new_for_command(name:, args: nil, environment: nil,rake_definitio
     end
 
     def self.all
-      Dir.entries(REPOSITORY_DIR).reject do |file|
-        file == '.' || file == '..'
-      end.map do |log|
+      create_tmp_file_dir
+
+      Dir.entries(REPOSITORY_DIR).reject { |file|
+        file == "." || file == ".."
+      }.map do |log|
         RakeUi::RakeTaskLog.build_from_file(log)
       end
     end
@@ -148,7 +158,7 @@ def parsed_file_contents
           name, value = line.split(FILE_ITEM_SEPARATOR, 2)
           next unless name
 
-          parsed[name] = value && value.gsub("\n", '')
+          parsed[name] = value && value.delete("\n")
         end
       end.with_indifferent_access
     end

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

@@ -6,8 +6,6 @@
   <%= csp_meta_tag %>
 
   <link rel="stylesheet" href="https://cdn.rawgit.com/doximity/vital/v2.2.1/dist/css/vital.min.css">
-
-  <%= stylesheet_link_tag "rake_ui/application", media: "all" %>
 </head>
 <body>
 
@@ -22,7 +20,12 @@
       </nav>
     </div>
   </div>
+
+  <p id="notice"><%= notice %></p>
+
   <!-- End Nav Menu -->
-  <%= yield %>
+  <div class="contents">
+    <%= yield %>
+  </div>
 </body>
 </html>