solid_queue_ui 0.0.1

data/lib/solid_queue_ui/web/helpers.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+require "uri"
+require "set"
+require "yaml"
+require "cgi"
+
+module SolidQueueUi
+  # This is not a public API
+  module WebHelpers
+    def strings(lang)
+      @strings ||= {}
+
+      @strings[lang] ||= settings.locales.each_with_object({}) do |path, global|
+        find_locale_files(lang).each do |file|
+          strs = YAML.safe_load(File.read(file))
+          global.merge!(strs[lang])
+        end
+      end
+    end
+
+    def to_json(x)
+      SolidQueueUi.dump_json(x)
+    end
+
+    def singularize(str, count)
+      if count == 1 && str.respond_to?(:singularize) # rails
+        str.singularize
+      else
+        str
+      end
+    end
+
+    def clear_caches
+      @strings = nil
+      @locale_files = nil
+      @available_locales = nil
+    end
+
+    def locale_files
+      @locale_files ||= settings.locales.flat_map { |path|
+        Dir["#{path}/*.yml"]
+      }
+    end
+
+    def available_locales
+      @available_locales ||= locale_files.map { |path| File.basename(path, ".yml") }.uniq
+    end
+
+    def find_locale_files(lang)
+      locale_files.select { |file| file =~ /\/#{lang}\.yml$/ }
+    end
+
+    def search(jobset, substr)
+      resultset = jobset.scan(substr).to_a
+      @current_page = 1
+      @count = @total_size = resultset.size
+      resultset
+    end
+
+    def filtering(which)
+      erb(:filtering, locals: {which: which})
+    end
+
+    def filter_link(jid, within = "retries")
+      if within.nil?
+        ::Rack::Utils.escape_html(jid)
+      else
+        "<a href='#{root_path}filter/#{within}?substr=#{jid}'>#{::Rack::Utils.escape_html(jid)}</a>"
+      end
+    end
+
+    def display_tags(job, within = "retries")
+      job.tags.map { |tag|
+        "<span class='label label-info jobtag'>#{filter_link(tag, within)}</span>"
+      }.join(" ")
+    end
+
+    # This view helper provide ability display you html code in
+    # to head of page. Example:
+    #
+    #   <% add_to_head do %>
+    #     <link rel="stylesheet" .../>
+    #     <meta .../>
+    #   <% end %>
+    #
+    def add_to_head
+      @head_html ||= []
+      @head_html << yield.dup if block_given?
+    end
+
+    def display_custom_head
+      @head_html.join if defined?(@head_html)
+    end
+
+    def text_direction
+      get_locale["TextDirection"] || "ltr"
+    end
+
+    def rtl?
+      text_direction == "rtl"
+    end
+
+    # See https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4
+    def user_preferred_languages
+      languages = env["HTTP_ACCEPT_LANGUAGE"]
+      languages.to_s.downcase.gsub(/\s+/, "").split(",").map { |language|
+        locale, quality = language.split(";q=", 2)
+        locale = nil if locale == "*" # Ignore wildcards
+        quality = quality ? quality.to_f : 1.0
+        [locale, quality]
+      }.sort { |(_, left), (_, right)|
+        right <=> left
+      }.map(&:first).compact
+    end
+
+    # Given an Accept-Language header like "fr-FR,fr;q=0.8,en-US;q=0.6,en;q=0.4,ru;q=0.2"
+    # this method will try to best match the available locales to the user's preferred languages.
+    #
+    # Inspiration taken from https://github.com/iain/http_accept_language/blob/master/lib/http_accept_language/parser.rb
+    def locale
+      @locale ||= begin
+        matched_locale = user_preferred_languages.map { |preferred|
+          preferred_language = preferred.split("-", 2).first
+
+          lang_group = available_locales.select { |available|
+            preferred_language == available.split("-", 2).first
+          }
+
+          lang_group.find { |lang| lang == preferred } || lang_group.min_by(&:length)
+        }.compact.first
+
+        matched_locale || "en"
+      end
+    end
+
+    def get_locale
+      strings(locale)
+    end
+
+    def t(msg, options = {})
+      string = get_locale[msg] || strings("en")[msg] || msg
+      if options.empty?
+        string
+      else
+        string % options
+      end
+    end
+
+    def sort_direction_label
+      (params[:direction] == "asc") ? "&uarr;" : "&darr;"
+    end
+
+
+    def root_path
+      "#{env["SCRIPT_NAME"]}/"
+    end
+
+    def current_path
+      @current_path ||= request.path_info.gsub(/^\//, "")
+    end
+
+    # def current_status
+    #   (workset.size == 0) ? "idle" : "active"
+    # end
+
+    def relative_time(time)
+      stamp = time.getutc.iso8601
+      %(<time class="ltr" dir="ltr" title="#{stamp}" datetime="#{stamp}">#{time}</time>)
+    end
+
+    SAFE_QPARAMS = %w[page direction]
+
+    # Merge options with current params, filter safe params, and stringify to query string
+    def qparams(options)
+      stringified_options = options.transform_keys(&:to_s)
+
+      to_query_string(params.merge(stringified_options))
+    end
+
+    def to_query_string(params)
+      params.map { |key, value|
+        SAFE_QPARAMS.include?(key) ? "#{key}=#{CGI.escape(value.to_s)}" : next
+      }.compact.join("&")
+    end
+
+    def csrf_tag
+      "<input type='hidden' name='authenticity_token' value='#{env[:csrf_token]}'/>"
+    end
+
+
+    def product_version
+      "SolidQueueUi v#{SolidQueueUi::VERSION}"
+    end
+
+    def server_utc_time
+      Time.now.utc.strftime("%H:%M:%S UTC")
+    end
+
+  end
+end

data/lib/solid_queue_ui/web/router.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "rack"
+
+module SolidQueueUi
+  module WebRouter
+    GET = "GET"
+    DELETE = "DELETE"
+    POST = "POST"
+    PUT = "PUT"
+    PATCH = "PATCH"
+    HEAD = "HEAD"
+
+    ROUTE_PARAMS = "rack.route_params"
+    REQUEST_METHOD = "REQUEST_METHOD"
+    PATH_INFO = "PATH_INFO"
+
+    def head(path, &block)
+      route(HEAD, path, &block)
+    end
+
+    def get(path, &block)
+      route(GET, path, &block)
+    end
+
+    def post(path, &block)
+      route(POST, path, &block)
+    end
+
+    def put(path, &block)
+      route(PUT, path, &block)
+    end
+
+    def patch(path, &block)
+      route(PATCH, path, &block)
+    end
+
+    def delete(path, &block)
+      route(DELETE, path, &block)
+    end
+
+    def route(method, path, &block)
+      @routes ||= {GET => [], POST => [], PUT => [], PATCH => [], DELETE => [], HEAD => []}
+
+      @routes[method] << WebRoute.new(method, path, block)
+    end
+
+    def match(env)
+      request_method = env[REQUEST_METHOD]
+      path_info = ::Rack::Utils.unescape env[PATH_INFO]
+
+      path_info = "/" if path_info == ""
+
+      @routes[request_method].each do |route|
+        params = route.match(request_method, path_info)
+        if params
+          env[ROUTE_PARAMS] = params
+
+          return WebAction.new(env, route.block)
+        end
+      end
+
+      nil
+    end
+  end
+
+  class WebRoute
+    attr_accessor :request_method, :pattern, :block, :name
+
+    NAMED_SEGMENTS_PATTERN = /\/([^\/]*):([^.:$\/]+)/
+
+    def initialize(request_method, pattern, block)
+      @request_method = request_method
+      @pattern = pattern
+      @block = block
+    end
+
+    def matcher
+      @matcher ||= compile
+    end
+
+    def compile
+      if pattern.match?(NAMED_SEGMENTS_PATTERN)
+        p = pattern.gsub(NAMED_SEGMENTS_PATTERN, '/\1(?<\2>[^$/]+)')
+
+        Regexp.new("\\A#{p}\\Z")
+      else
+        pattern
+      end
+    end
+
+    def match(request_method, path)
+      case matcher
+      when String
+        {} if path == matcher
+      else
+        path_match = path.match(matcher)
+        path_match&.named_captures&.transform_keys(&:to_sym)
+      end
+    end
+  end
+end

data/lib/solid_queue_ui/web.rb

@@ -0,0 +1,145 @@
+require "erb"
+
+require "solid_queue_ui"
+require "solid_queue_ui/web/helpers"
+
+require "solid_queue_ui/web/router"
+require "solid_queue_ui/web/action"
+require "solid_queue_ui/web/application"
+require "solid_queue_ui/web/csrf_protection"
+
+module SolidQueueUi
+  class Web
+    ROOT = File.expand_path("#{File.dirname(__FILE__)}/../../web")
+    VIEWS = "#{ROOT}/views"
+    LOCALES = ["#{ROOT}/locales"]
+    LAYOUT = "#{VIEWS}/layout.html.erb"
+    ASSETS = "#{ROOT}/assets"
+
+    DEFAULT_TABS = {
+      "Dashboard" => "",
+    }
+
+    if Gem::Version.new(Rack::RELEASE) < Gem::Version.new("3")
+      CONTENT_LANGUAGE = "Content-Language"
+      CONTENT_SECURITY_POLICY = "Content-Security-Policy"
+      LOCATION = "Location"
+      X_CASCADE = "X-Cascade"
+    else
+      CONTENT_LANGUAGE = "content-language"
+      CONTENT_SECURITY_POLICY = "content-security-policy"
+      LOCATION = "location"
+      X_CASCADE = "x-cascade"
+    end
+
+    class << self
+      def settings
+        self
+      end
+
+      def default_tabs
+        DEFAULT_TABS
+      end
+
+      def custom_job_info_rows
+        @custom_job_info_rows ||= []
+      end
+
+      def locales
+        @locales ||= LOCALES
+      end
+
+      def views
+        @views ||= VIEWS
+      end
+
+      def middlewares
+        @middlewares ||= []
+      end
+
+      def use(*args, &block)
+        middlewares << [args, block]
+      end
+
+      def set(attribute, value)
+        send(:"#{attribute}=", value)
+      end
+
+      attr_accessor :app_url
+      attr_writer :locales, :views
+    end
+
+    def self.inherited(child)
+      child.app_url = app_url
+    end
+
+    def settings
+      self.class.settings
+    end
+
+    def middlewares
+      @middlewares ||= self.class.middlewares
+    end
+
+    def use(*args, &block)
+      middlewares << [args, block]
+    end
+
+    def call(env)
+      app.call(env)
+    end
+
+    def self.call(env)
+      @app ||= new
+      @app.call(env)
+    end
+
+    def app
+      @app ||= build
+    end
+
+    def enable(*opts)
+      opts.each { |key| set(key, true) }
+    end
+
+    def disable(*opts)
+      opts.each { |key| set(key, false) }
+    end
+
+    def set(attribute, value)
+      send(:"#{attribute}=", value)
+    end
+
+    def self.register(extension)
+      extension.registered(WebApplication)
+    end
+
+    private
+
+    def build
+      klass = self.class
+      m = middlewares
+
+      rules = []
+      rules = [[:all, {Rack::CACHE_CONTROL => "private, max-age=86400"}]] unless ENV["SOLID_QUEUE_UI_WEB_TESTING"]
+
+      ::Rack::Builder.new do
+        use Rack::Static, urls: ["/stylesheets", "/images", "/javascripts"],
+          root: ASSETS,
+          cascade: true,
+          header_rules: rules
+        m.each { |middleware, block| use(*middleware, &block) }
+        use SolidQueueUi::Web::CsrfProtection unless $TESTING
+        run WebApplication.new(klass)
+      end
+    end
+  end
+
+  SolidQueueUi::WebApplication.helpers WebHelpers
+
+  SolidQueueUi::WebAction.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+    def _render
+      #{ERB.new(File.read(Web::LAYOUT)).src}
+    end
+  RUBY
+end

data/lib/solid_queue_ui.rb

@@ -0,0 +1,22 @@
+require "solid_queue_ui/version"
+require "solid_queue_ui/railtie"
+
+module SolidQueueUi
+  NAME = "SolidQueueUi"
+
+  def self.load_json(string)
+    JSON.parse(string)
+  end
+
+  def self.dump_json(object)
+    JSON.generate(object)
+  end
+
+  def self.freeze!
+    @frozen = true
+    @config_blocks = nil
+  end
+
+end
+
+require "solid_queue_ui/rails" if defined?(::Rails::Engine)

data/lib/tasks/solid_queue_ui_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :solid_queue_ui do
+#   # Task goes here
+# end

data/solid_queue_ui.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/solid_queue_ui/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "solid_queue_ui"
+  spec.version = SolidQueueUi::VERSION
+  spec.authors = ["Claude Ayitey"]
+  spec.email = ["code@ayitey.me"]
+
+  spec.summary = "A user interface for the solid_queue gem."
+  spec.description = "this plugin provides a user interface to the recently-released solid_queue gem which is a backend for handing jobs in Rails apps."
+  spec.homepage = "https://github.com/claudey/solid_queue_ui"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["source_code_uri"] = "https://github.com/claudey/solid_queue_ui"
+  spec.metadata["changelog_uri"] = "https://github.com/claudey/solid_queue_ui/changelog.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "solid_queue"
+  spec.add_dependency "activerecord", ">= 6.0", "< 8.0"
+  spec.add_dependency "sassc-rails", "~> 2.1"
+
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end