rake-ui 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 218a68e063a489cf4b9f781a1f764fbe01439d8f40ab9a7ec2c887993b1b8cc6
-  data.tar.gz: a76cca82acafcb84c0e2039448eb0c0f0fad464dcfc9ad68a5378a7059abfc32
+  metadata.gz: bd7aaae9a795ec46917f67bc68117f375f0c6fa4e22bc6e320fe082a8f633a37
+  data.tar.gz: cbf32b74d4a96a8156278a0e36c71f9f76672396a4a15031e094f8886ea5b4d7
 SHA512:
-  metadata.gz: b68e5dca03e6235494047686a766cc8a15cecb71d3bde9ac3767859d9d0971a00194527c756ac767434e15b3c7a56f833a46f9a80a99d1084bf43bae5b3f5ddb
-  data.tar.gz: f24ad6edc4612031b9cdf53b5df8046ff93a51451d216ed23cd12c7423a7c71469114d0b09e967061a78017af0268a7b5d2802a6ec15cc552a46f7acab38da2e
+  metadata.gz: 1509e6793d3f88ec54ed69a4f5cbce635dc0212b48bc657a56562fa8494a8c870c75d086287ee0786804eb14ab118d140e8a2ab4101ccf0f147e07224947e540
+  data.tar.gz: c8baa27913c7c15ba812e3f4d4832783003fa47eb47c16c90603d9107083c1258a2b6f14562ab6f3208502c91fec767cd90258c589bc033071a5bc1ad12c4762

data/README.md

@@ -1,13 +1,23 @@
 # RakeUi
 Rake UI is a Rails engine that enables the discovery and execution rake tasks in a UI.
 
+![Example](./README_example.gif)
+
+## Routes
+
+NOTE: Relative to mountpoint in application
+
+ - GET /rake_tasks(.html/.json) - list all available rake tasks
+ - GET /rake_tasks/:id(.html/.json) - list info a single tasks
+ - POST /rake_tasks/:id/execute - execute a rake task
+ - GET /rake_task_logs(.html/.json) - list rake task history
+ - GET /rake_task_logs/:id(.html/.json) - list a single rake task history
+
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-group :development do 
-  gem 'rake-ui'
-end
+gem 'rake-ui'
 ```
 
 And then execute:
@@ -34,7 +44,13 @@ end
 
 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.  
+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. You may override this guard clause with the following configuration.
+
+```rb
+RakeUi.configuration do |config|
+  config.allow_production = true
+end
+```
 
 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)
 

data/app/controllers/rake_ui/application_controller.rb

@@ -7,7 +7,9 @@ module RakeUi
     private
 
     def black_hole_production
-      raise ActionController::RoutingError, "Not Found" unless Rails.env.test? || Rails.env.development?
+      return if Rails.env.test? || Rails.env.development? || RakeUi.configuration.allow_production
+
+      raise ActionController::RoutingError, "Not Found"
     end
   end
 end

data/app/models/rake_ui/rake_task_log.rb

@@ -53,13 +53,13 @@ module RakeUi
       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)
+        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

data/lib/rake-ui/version.rb

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

data/lib/rake-ui.rb

@@ -3,4 +3,11 @@
 require "rake-ui/engine"
 
 module RakeUi
+  mattr_accessor :allow_production
+  self.allow_production = false
+
+  def self.configuration
+    yield(self) if block_given?
+    self
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rake-ui
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Austin Story
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport