staff_bar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4db3ef168d66ec2267f51e512ac985f2648ef78f0e738f0089aa7641391bff93
+  data.tar.gz: 694ff72e8cada965044590c90fe071bf28d4bcfbe53bb25bbacb932b6a409607
+SHA512:
+  metadata.gz: 8eb796c4d0c8b16f35169525ef4773607385d6c28327d3dc56cdbe2d85b600badc776663f42ee5b7817baf0b04c09372cdfe59a96a7cce71ba2e07aed0d3ca6a
+  data.tar.gz: 45ef7137eab96f78a1dd2c6b87ea3f8b941d7f17d8025fd9397662751708852851807455ddba216a0bfc40d0c48a589fd4f649da42457390e91a2c9be6c2c39d

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/storage/
+test/dummy/tmp/

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Declare your gem's dependencies in staff_bar.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,149 @@
+PATH
+  remote: .
+  specs:
+    staff_bar (0.1.0)
+      octicons_helper (~> 9)
+      rails (>= 5.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.0)
+      actionpack (= 6.0.0)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      mail (>= 2.7.1)
+    actionmailer (6.0.0)
+      actionpack (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.0)
+      actionview (= 6.0.0)
+      activesupport (= 6.0.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.0)
+      actionpack (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.0)
+      activesupport (= 6.0.0)
+      globalid (>= 0.3.6)
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activestorage (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      marcel (~> 0.3.1)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.5)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.3.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.12.2)
+    nio4r (2.5.2)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    octicons (9.2.0)
+      nokogiri (>= 1.6.3.1)
+    octicons_helper (9.2.0)
+      octicons (= 9.2.0)
+      rails
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.0)
+      actioncable (= 6.0.0)
+      actionmailbox (= 6.0.0)
+      actionmailer (= 6.0.0)
+      actionpack (= 6.0.0)
+      actiontext (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      activemodel (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      bundler (>= 1.3.0)
+      railties (= 6.0.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.0)
+      actionpack (= 6.0.0)
+      activesupport (= 6.0.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.0)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  sqlite3
+  staff_bar!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Rolandas Barysas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Staff bar
+
+[![Preview](preview-sm.png)](preview.png)
+
+Staff bar is a tiny utility for Ruby on Rails projects. It shows a bar with some basic project information: commit hash, branch, Ruby & Rails versions, environment and caching status. You can also make a list of links that you want to show on a bar for a quick access to your internal tools.
+
+## Usage
+```ruby
+# Add this to Gemfile
+gem 'staff_bar'
+
+# Install dependencies
+bundle
+```
+
+Add this to `app/views/layouts/application.html.erb`:
+```ruby
+...
+</head>
+
+<body>
+  <%= staff_bar if current_user.staff? %>
+
+  <%= yield %>
+</body>
+...
+```
+
+(you can change `current_user.staff?` to whatever your administrators logic is of course.)
+
+Add this to your `application.css` to use default styles:
+```css
+*= require staff_bar
+```
+
+To show current branch, add staff_bar capistrano tasks in `Capfile`
+```ruby
+require "staff_bar/capistrano"
+```
+
+This will create `BRANCH` file when depoying, which will staff bar use to show the branch.
+
+## Configuration
+
+```ruby
+# app/config/initializers/staff_bar.rb
+StaffBar.configure do |config|
+  config.links = [
+    { url: '/jobs', title: 'Jobs queue' },
+    { url: '/logs', title: 'Open logs' }
+  ];
+
+  config.theme = :dark # or :light
+  config.position = :bottom # or :top
+end
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'StaffBar'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+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/stylesheets/staff_bar.scss

@@ -0,0 +1,89 @@
+$bg: #222;
+$bg-inverse: #f5f5f5;
+
+$color: #f2f2f2;
+$color-inverse: black;
+
+$link-color: #b8e8ff;
+$link-color-inverse: #166083;
+
+$border-color: black;
+$border-color-inverse: #ccc;
+
+$green: #8cfb84;
+$green-inverse: green;
+
+.staff-bar {
+  position: relative;
+  z-index: 9999;
+  display: flex;
+  justify-content: space-between;
+  width: 100%;
+  padding: 5px 10px;
+  background: $bg;
+  color: $color;
+  font-family: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
+  font-size: 12px;
+  border-style: solid;
+  border-color: $border-color;
+  box-shadow: 0 0 5px rgba(0,0,0,.1);
+
+  .octicon {
+    fill: darken($color, 25%);
+  }
+
+  a {
+    color: $link-color;
+    text-decoration: none;
+
+    &:hover {
+      color: $link-color;
+      text-decoration: underline;
+    }
+  }
+
+  .staff-bar-green {
+    color: $green;
+  }
+
+  &-inverse {
+    background: $bg-inverse;
+    color: $color-inverse;
+    border-color: $border-color-inverse;
+
+    .octicon {
+      fill: lighten($color-inverse, 25%);
+    }
+
+    a {
+      color: $link-color-inverse;
+
+      &:hover {
+        color: $link-color-inverse;
+      }
+    }
+
+    .staff-bar-green {
+      color: $green-inverse;
+    }
+  }
+
+  &-top {
+    border-width: 0 0 1px;
+  }
+
+  &-bottom {
+    position: fixed;
+    bottom: 0;
+    left: 0;
+    border-width: 1px 0 0;
+  }
+}
+
+.staff-bar-list {
+  display: flex;
+}
+
+.staff-bar-list-item {
+  padding-right: 15px;
+}

data/app/helpers/staff_bar_helper.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module StaffBarHelper
+  def staff_bar
+    render 'staff_bar/staff_bar'
+  end
+end

data/app/views/staff_bar/_staff_bar.html.erb

@@ -0,0 +1,22 @@
+<div class="staff-bar <%= StaffBar.position_class %> <%= StaffBar.theme_class %>">
+  <div class="staff-bar-list">
+    <% if StaffBar.revision.present? %>
+      <div class="staff-bar-list-item"><%= octicon "git-commit" %> <%= StaffBar.revision %></div>
+    <% end %>
+    <% if StaffBar.branch.present? %>
+      <div class="staff-bar-list-item"><%= octicon "git-branch" %> <%= StaffBar.branch %></div>
+    <% end %>
+    <div class="staff-bar-list-item"><%= octicon "ruby" %> ruby-<%= StaffBar.ruby_version %> rails-<%= StaffBar.rails_version %></div>
+    <div class="staff-bar-list-item"><%= octicon "globe" %> <%= StaffBar.environment %></div>
+    <div class="staff-bar-list-item"><%= octicon "gear" %> <span class="<%= StaffBar.cache_class %>"><%= StaffBar.cache %></span></div>
+    <div class="staff-bar-list-item"><%= octicon "clock" %> <%= StaffBar.time %> (<%= StaffBar.time_zone %>)</div>
+  </div>
+
+  <div class="staff-bar-list">
+    <% StaffBar.config.links.each do |link| %>
+      <div class="staff-bar-list-item">
+        <a href="<%= link[:url] %>" target="_blank" rel="noopener"><%= link[:title] %></a>
+      </div>
+    <% end %>
+  </div>
+</div>

data/bin/test

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../test", __dir__)
+
+require "bundler/setup"
+require "rails/plugin/test"

data/lib/staff_bar/capistrano/tasks/staff_bar.rake

@@ -0,0 +1,12 @@
+namespace :staff_bar do
+  desc "Place a BRANCH file with the current branch in the current release path"
+  task :set_current_branch do
+    on roles(:app) do
+      within release_path do
+        execute :echo, "\"#{fetch(:branch)}\" >> BRANCH"
+      end
+    end
+  end
+end
+
+after 'deploy:finished', 'staff_bar:set_current_branch'

data/lib/staff_bar/capistrano.rb

@@ -0,0 +1 @@
+load File.expand_path("../capistrano/tasks/staff_bar.rake", __FILE__)

data/lib/staff_bar/config.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module StaffBar
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @_config ||= Config.new
+    end
+  end
+
+  class Config
+    attr_accessor :links, :theme, :position
+
+    def initialize
+      @links = []
+      @theme = :dark
+      @position = :bottom
+    end
+  end
+end

data/lib/staff_bar/core.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module StaffBar
+  class << self
+    def revision
+      if File.exist?(File.join(Rails.root, "REVISION"))
+        file = File.join(Rails.root, "REVISION")
+        File.read(file).chomp.first(7)
+      elsif File.exist?(File.join(Rails.root, ".git"))
+        `git rev-parse --short HEAD`.chomp
+      end
+    end
+
+    def branch
+      if File.exist?(File.join(Rails.root, "BRANCH"))
+        file = File.join(Rails.root, "BRANCH")
+        File.read(file).chomp
+      elsif File.exist?(File.join(Rails.root, ".git"))
+        `git rev-parse --abbrev-ref HEAD`.chomp
+      end
+    end
+
+    def ruby_version
+      RUBY_VERSION
+    end
+
+    def rails_version
+      Rails.version
+    end
+
+    def environment
+      Rails.env
+    end
+
+    def time
+      Time.current.to_s
+    end
+
+    def time_zone
+      Time.zone.tzinfo.identifier
+    end
+
+    def cache
+      cache_enabled? ? "Caching enabled" : "Caching disabled"
+    end
+
+    def cache_class
+      cache_enabled? ? "staff-bar-green" : ""
+    end
+
+    def position_class
+      StaffBar.config.position == :top ? "staff-bar-top" : "staff-bar-bottom"
+    end
+
+    def theme_class
+      StaffBar.config.theme == :light ? "staff-bar-inverse" : ""
+    end
+
+    private
+      def cache_enabled?
+        Rails.application.config.action_controller.perform_caching
+      end
+  end
+end

data/lib/staff_bar/engine.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module StaffBar
+  class Engine < Rails::Engine; end
+end

data/lib/staff_bar/version.rb

@@ -0,0 +1,3 @@
+module StaffBar
+  VERSION = '0.1.0'
+end

data/lib/staff_bar.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "staff_bar/config"
+require "staff_bar/core"
+require "staff_bar/engine"
+
+module StaffBar
+end

data/staff_bar.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("lib", __dir__)
+
+# Maintain your gem's version:
+require "staff_bar/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = "staff_bar"
+  spec.version     = StaffBar::VERSION
+  spec.authors     = ["Rolandas Barysas"]
+  spec.email       = ["rolandas@rolandasb.com"]
+  spec.homepage    = "https://github.com/decentbudget/staff_bar"
+  spec.summary     = "Show a bar with general project information for administrators."
+  spec.description = "Show a bar with general project information for administrators."
+  spec.license     = "MIT"
+
+  spec.files = `git ls-files`.split("\n")
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 5.0.0"
+  spec.add_dependency "octicons_helper", "~> 9"
+
+  spec.add_development_dependency "sqlite3"
+end

data/test/dummy/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/test/dummy/BRANCH

@@ -0,0 +1 @@
+foo-branch

data/test/dummy/REVISION

@@ -0,0 +1 @@
+abcd1234

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/stylesheets/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/test/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/test/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/javascript/packs/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/test/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end