peephole 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b84f93566189ed05ae8a5555258543dc9b5eceeb
+  data.tar.gz: c49f1a5a8da8b8d3fa9c2dd4182880763641b88f
+SHA512:
+  metadata.gz: 59390333d669f65f7ee1c06c34fa2f8c7e85bd3afdb3a92cab16f2041ae264382c43cdb0cbc7c7dc5fc82f2784684b5439a3b4987e2ed6c94ac3ed79d3587a1a
+  data.tar.gz: 781fefaaa54e3c64ef6bde2a4f32fc577080548c496b96199e7de8c0431089a0b48fa5528245a62544603d9caa0274f390a2a2eaea19a931180e9c9d77b65efa

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 tnantoka
+
+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,58 @@
+# Peephole
+
+[![Circle CI](https://circleci.com/gh/tnantoka/peephole.svg?style=svg)](https://circleci.com/gh/tnantoka/peephole)
+[![Code Climate](https://codeclimate.com/github/tnantoka/peephole/badges/gpa.svg)](https://codeclimate.com/github/tnantoka/peephole)
+[![Test Coverage](https://codeclimate.com/github/tnantoka/peephole/badges/coverage.svg)](https://codeclimate.com/github/tnantoka/peephole/coverage)
+
+A log viewer engine for Rails.
+
+![](screenshot.png)
+
+## Installation
+
+```
+# Gemfile
+gem 'peephole'
+
+$ bundle
+
+$ rails g peephole:install
+      create  config/initializers/log_tags.rb
+      create  config/initializers/peephole.rb
+```
+
+## Configuration
+
+```
+# config/initializers/peephole.rb
+Peephole.configure do |config|
+  config.paginates_per = 200
+  config.peeper? do
+    # current_user.role.admin?
+
+    # admin_user_signed_in?
+
+    # authenticate_or_request_with_http_basic do |user, pass|
+    #   user == 'user' && pass == 'pass'
+    # end
+  end
+end
+```
+
+## Example
+
+```
+$ git clone git@github.com:tnantoka/peephole.git
+$ cd peephole/spec/dummy
+$ rails s
+$ open http://localhost:3000/peephole
+```
+
+## License
+
+MIT
+
+## Author
+
+[@tnantoka][https://twitter.com/tnantoka]
+

data/Rakefile

@@ -0,0 +1,28 @@
+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    = 'Peephole'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/app/assets/javascripts/peephole/application.js

@@ -0,0 +1,13 @@
+// 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.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

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

@@ -0,0 +1,16 @@
+/*
+ * 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 styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require peephole/bootstrap/css/bootstrap
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/peephole/peephole.css

@@ -0,0 +1,29 @@
+#peephole .table pre {
+  margin-bottom: 0;
+}
+
+#peephole .text-break {
+  word-break: break-all;
+}
+
+#peephole .navbar {
+  border-left: 0;
+  border-right: 0;
+}
+
+#peephole .navbar.navbar-default {
+  background: none;
+}
+
+#peephole .well {
+  box-shadow: none;
+}
+
+#peephole .navbar,
+#peephole .breadcrumb,
+#peephole .pager li a,
+#peephole .well, 
+#peephole pre,
+#peephole .label {
+  border-radius: 0;
+}

data/app/controllers/peephole/application_controller.rb

@@ -0,0 +1,10 @@
+module Peephole
+  class ApplicationController < ::ApplicationController
+    before_action :authenticate_user!
+
+    private
+      def authenticate_user!
+        redirect_to main_app.root_url unless instance_eval(&Peephole.config.peeper?)
+      end
+  end
+end

data/app/controllers/peephole/logfiles_controller.rb

@@ -0,0 +1,21 @@
+require_dependency "peephole/application_controller"
+
+module Peephole
+  class LogfilesController < ApplicationController
+    before_action :set_logfile
+
+    def show
+      @page = params[:page].to_i.nonzero? || 1
+      @loglines, @eof = @logfile.loglines(@page)
+    end
+
+    def download
+      send_file @logfile.path
+    end
+
+    private
+      def set_logfile
+        @logfile = Logfile.find(params[:id])       
+      end
+  end
+end

data/app/controllers/peephole/welcome_controller.rb

@@ -0,0 +1,9 @@
+require_dependency "peephole/application_controller"
+
+module Peephole
+  class WelcomeController < ApplicationController
+    def index
+      @logfiles = Logfile.all
+    end
+  end
+end

data/app/helpers/peephole/application_helper.rb

@@ -0,0 +1,15 @@
+module Peephole
+  module ApplicationHelper
+    def status_label(status)
+      label = case status
+              when /\A2/
+                'success'
+              when /\A3/
+                'info'
+              else
+                'danger'
+              end
+      content_tag(:span, status, class: "label label-#{label}")
+    end
+  end
+end

data/app/models/peephole/logfile.rb

@@ -0,0 +1,39 @@
+module Peephole
+  class Logfile
+    attr_accessor :filename, :path
+
+    LOG_PATH = Rails.root.join('log')
+
+    class << self
+      def glob
+        Dir.glob(LOG_PATH.join("#{Rails.env}.log*"))
+      end
+
+      def all
+        glob.map do |path|
+          Logfile.new(path)
+        end
+      end
+
+      def find(filename)
+        path = glob.find do |path|
+          File.basename(path) == filename
+        end
+        Logfile.new(path)
+      end
+    end
+
+    def initialize(path)
+      self.path = path
+      self.filename = File.basename(path)
+    end
+
+    def to_param
+      filename
+    end
+
+    def loglines(page)
+      Logline.where(path, page)
+    end
+  end
+end

data/app/models/peephole/logline.rb

@@ -0,0 +1,93 @@
+module Peephole
+  class Logline
+    attr_accessor :uuid, :type, :num
+    attr_accessor :method, :target, :started_at
+    attr_accessor :params
+    attr_accessor :status
+
+    module TYPE
+      STARTED = 1
+      PARAMS = 2
+      COMPLETED = 3
+    end
+
+    class << self
+      def first(page)
+        (page - 1) * Peephole.config.paginates_per
+      end
+
+      def last(page)
+        page * Peephole.config.paginates_per
+      end
+
+      def where(path, page)
+        loglines = []
+        logmap = {}
+        eof = true
+        each(path, page) do |line, i|
+          next if i < first(page)
+          if i >= last(page)
+            eof = false
+            break
+          end
+          parse(line, i, loglines, logmap)
+        end
+        [loglines, eof]
+      end
+
+      def parse(line, i, loglines, logmap)
+        logline = new(line, i)
+        case logline.type
+        when TYPE::STARTED
+          logmap[logline.uuid] = logline if logline.uuid.present?
+        when TYPE::PARAMS
+          line = logmap[logline.uuid].presence || logline
+          line.params = logline.params
+          loglines << line
+        when TYPE::COMPLETED
+          logmap[logline.uuid].try(:status=, logline.status)
+        end
+      end
+
+      def each(path, page, &block)
+        iterator = case path.to_s
+        when /\.gz\z/
+          Zlib::GzipReader.open(path).each
+        else
+          IO.foreach(path)
+        end
+        iterator.with_index(&block)
+      end
+    end
+
+    def initialize(line, num)
+      self.num = num
+
+      case line
+      when / Started (\w+) "(.+)" .+ at (.+)/
+        self.method = $1
+        self.target = $2
+        self.started_at = Time.parse($3)
+        self.type = TYPE::STARTED
+      when /   Parameters: ({.+})/
+        params = JSON.parse($1.gsub('=>', ':'))
+        params.dup.each do |k, v|
+          if v.is_a?(Hash)
+            v.each do |k2, v2|
+              params["#{k}[#{k2}]"] = v2
+            end
+            params.delete(k)
+          end
+        end
+        self.params = params
+        self.type = TYPE::PARAMS
+      when / Completed (\d+)/
+        self.status = $1
+        self.type = TYPE::COMPLETED
+      end
+      if line =~ /\[(\w+\-\w+\-\w+\-\w+\-\w+)\] /
+        self.uuid = $1
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Peephole</title>
+  <%= stylesheet_link_tag    "peephole/application", media: "all" %>
+  <%= javascript_include_tag "peephole/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body id="peephole">
+
+<nav class="navbar navbar-default">
+  <div class="container-fluid">
+    <div class="navbar-header">
+      <%= link_to 'Peephole', :root, class: 'navbar-brand' %>
+    </div>
+  </div>
+</nav>
+
+<div class="container-fluid">
+  <%= yield %>
+
+  <footer>
+    <p>
+      <a href="https://github.com/tnantoka/peephole" target="_blank" class="text-muted">
+        Peephole
+        <%= Peephole::VERSION %>
+      </a>
+    </p>
+  </footer>
+</div>
+
+</body>
+</html>

data/app/views/peephole/logfiles/_pager.html.erb

@@ -0,0 +1,24 @@
+<nav>
+  <ul class="pager">
+    <% if @page == 1 %>
+      <li class="previous disabled"><a>&larr; Older</a></li>
+    <% else %>
+      <li class="previous">
+        <%= link_to url_for(params.merge(page: @page - 1)) do %>
+          &larr; Older
+        <% end %>
+      </li>
+    <% end %>
+    <% if @eof %>
+      <li class="next disabled"><a>Newer &rarr;</a></li>
+    <% else %>
+      <li class="next">
+        <%= link_to url_for(params.merge(page: @page + 1)) do %>
+          Newer &rarr;
+        <% end %>
+      </li>
+    <% end %>
+  </ul>
+</nav>
+
+

data/app/views/peephole/logfiles/show.html.erb

@@ -0,0 +1,55 @@
+<ol class="breadcrumb">
+  <li><%= link_to 'Home', :root %></li>
+  <li><%= link_to @logfile.filename, logfile_path(@logfile) %></li>
+  <li class="active">
+    Displaying lines <%= Peephole::Logline.first(@page) %> - <%= Peephole::Logline.last(@page) %>
+  </li>
+</ol>
+
+<%= render 'pager' %>
+
+<table class="table table-bordered">
+  <% if @loglines.present? %>
+    <tr>
+      <td>#num</td>
+      <td>
+        started_at<br>
+        <span class="text-muted">uuid</span>
+      </td>
+      <td>
+        method <code>target</code>
+      </td>
+      <td>status</td>
+      <td colspan="2">params</td>
+    </tr>
+    <% @loglines.each do |logline| %>
+      <% logline.params.each_with_index do |(key, value), i| %>
+        <tr>
+          <% if i.zero? %>
+            <% rowspan = logline.params.size %>
+            <td rowspan="<%= rowspan %>">
+              #<%= logline.num %>
+            </td>
+            <td rowspan="<%= rowspan %>" class="text-break">
+              <%= logline.started_at %><br>
+              <span class="text-muted"><%= logline.uuid %></span>
+            </td>
+            <td rowspan="<%= rowspan %>" class="text-break">
+              <%= logline.method %>
+              <code><%= logline.target %></code>
+            </td>
+            <td rowspan="<%= rowspan %>"><%= status_label(logline.status) %></td>
+          <% end %>
+          <td><%= key %></td>
+          <td>
+            <pre><%= value %></pre>
+          </td>
+        </tr>
+      <% end %>
+    <% end %>
+  <% else %>
+    <div class="well">No logline found.</div>
+  <% end %>
+</table>
+
+<%= render 'pager' %>

data/app/views/peephole/welcome/index.html.erb

@@ -0,0 +1,19 @@
+<ol class="breadcrumb">
+  <li class="active">Home</li>
+</ol>
+
+<table class="table">
+  <tbody>
+    <% @logfiles.each do |logfile| %>
+      <tr>
+        <td><%= link_to logfile.filename, logfile_path(logfile) %></td>
+        <td class="text-right">
+          <%= link_to download_logfile_path(logfile) do %>
+            <span class="glyphicon glyphicon-download-alt"></span>
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+

data/config/routes.rb

@@ -0,0 +1,10 @@
+Peephole::Engine.routes.draw do
+  get 'welcome/index'
+  root 'welcome#index'
+
+  resources :logfiles, only: [:show], id: /.+/ do
+    member do
+      get :download
+    end
+  end
+end

data/lib/generators/peephole/install_generator.rb

@@ -0,0 +1,10 @@
+module Peephole
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def install
+      template 'log_tags.rb', 'config/initializers/log_tags.rb'
+      template 'initializer.rb', 'config/initializers/peephole.rb'
+    end
+  end
+end

data/lib/generators/peephole/templates/initializer.rb

@@ -0,0 +1,6 @@
+Peephole.configure do |config|
+  config.paginates_per = 200
+  config.peeper? do
+    !Rails.env.production?
+  end
+end

data/lib/generators/peephole/templates/log_tags.rb

@@ -0,0 +1 @@
+Rails.application.config.log_tags = [:uuid]

data/lib/peephole/config.rb

@@ -0,0 +1,15 @@
+module Peephole
+  class Config
+    include ActiveSupport::Configurable
+
+    config_accessor :paginates_per do
+      200 
+    end
+
+    DEFAULT_PEEPER = proc { !Rails.env.production? }
+    def peeper?(&block)
+      @peeper = block if block_given?
+      @peeper.presence || DEFAULT_PEEPER
+    end 
+  end
+end

data/lib/peephole/engine.rb

@@ -0,0 +1,12 @@
+module Peephole
+  class Engine < ::Rails::Engine
+    isolate_namespace Peephole
+
+    config.generators do |g|
+      g.stylesheets false
+      g.javascripts false
+      g.helper false
+      g.test_framework :rspec, view_specs: false, helper_specs: false
+    end
+  end
+end

data/lib/peephole/version.rb

@@ -0,0 +1,3 @@
+module Peephole
+  VERSION = "0.0.1"
+end

data/lib/peephole.rb

@@ -0,0 +1,14 @@
+require "peephole/engine"
+require "peephole/config"
+
+module Peephole
+  class << self
+    def configure(&block)
+      yield config
+    end
+
+    def config
+      @config ||= Config.new
+    end
+  end
+end

data/lib/tasks/peephole_tasks.rake

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

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: peephole
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- tnantoka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.3
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Peephole is a Rails engine that provides interface to view logs.
+email:
+- tnantoka@bornneet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/peephole/application.js
+- app/assets/stylesheets/peephole/application.css
+- app/assets/stylesheets/peephole/peephole.css
+- app/controllers/peephole/application_controller.rb
+- app/controllers/peephole/logfiles_controller.rb
+- app/controllers/peephole/welcome_controller.rb
+- app/helpers/peephole/application_helper.rb
+- app/models/peephole/logfile.rb
+- app/models/peephole/logline.rb
+- app/views/layouts/peephole/application.html.erb
+- app/views/peephole/logfiles/_pager.html.erb
+- app/views/peephole/logfiles/show.html.erb
+- app/views/peephole/welcome/index.html.erb
+- config/routes.rb
+- lib/generators/peephole/install_generator.rb
+- lib/generators/peephole/templates/initializer.rb
+- lib/generators/peephole/templates/log_tags.rb
+- lib/peephole.rb
+- lib/peephole/config.rb
+- lib/peephole/engine.rb
+- lib/peephole/version.rb
+- lib/tasks/peephole_tasks.rake
+homepage: https://github.com/tnantoka/peephole
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Log viewer for Rails
+test_files: []