i18n_debug_page 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ce8bd98e1e2bdd7e3ec39eb971b5b49ba72083b
+  data.tar.gz: 280cb5a9169dd41f6d307a1316f93233bbc22f7d
+SHA512:
+  metadata.gz: 7034265d8427489b8e50961dcb4eb0cd93b7947ae9d62a6d44a33e72553a2492875819c33c89751e376e86ae67f217a8f4144c6e30e2b0b831535df61f7f3c66
+  data.tar.gz: 15e647e88c30b7caac05baa8e14ab10535015281ac2b226c309f583f2e1b1f774511885dcf60b918a6dd59bb250c412fec4a23654c4a62e403fadf8a174cdd1c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 mike
+
+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,41 @@
+# I18n Debug Page
+Mountable rails engin for rails app to check i18n translations in page.
+
+When we develop a rails app we want to get better debug info. The gem [i18n-debug](https://github.com/fphilipe/i18n-debug) provide a very handy way to present rails translations' lookup.
+
+But the log is mixed in rails log and most time the log is really long. It's better if we have seperate place to present such thing, so I18n Debug Page comes.
+
+## Example
+<img src="https://raw.githubusercontent.com/yfractal/i18n_debug_page/master/assets/Screen%20Shot%202017-02-18%20at%209.05.42%20AM.png" />
+
+## Install
+
+```ruby
+# Gemfile
+gem 'i18n_debug_page'
+```
+
+Run:
+
+```bash
+$ bundle install
+```
+
+Mount the engine
+```ruby
+# config/routes.rb
+mount I18nDebugPage::Engine => "/"
+```
+
+Then you can find i18n debug log in path `/i18n_debug_logs`
+
+## TODO
+- Provide better UI
+- Make the installation more easier
+
+## Additional Information
+This gem was inspired by [status-page](https://github.com/rails-engine/status-page) and [i18n-debug](https://github.com/fphilipe/i18n-debug)
+
+## License
+
+The MIT License (MIT)

data/Rakefile

@@ -0,0 +1,26 @@
+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    = 'I18nDebugPage'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  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'
+
+
+
+require 'bundler/gem_tasks'
+

data/app/assets/config/i18n_debug_page_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/i18n_debug_page .js
+//= link_directory ../stylesheets/i18n_debug_page .css

data/app/assets/javascripts/i18n_debug_page/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. 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_tree .

data/app/assets/stylesheets/i18n_debug_page/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/app/controllers/i18n_debug_page/application_controller.rb

@@ -0,0 +1,5 @@
+module I18nDebugPage
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/i18n_debug_page/i18n_debug_logs_controller.rb

@@ -0,0 +1,9 @@
+require_dependency "i18n_debug_page/application_controller"
+
+module I18nDebugPage
+  class I18nDebugLogsController < ApplicationController
+    def index
+      @i18n_debug_logs = I18nDebugPage.i18n_debug_logs
+    end
+  end
+end

data/app/helpers/i18n_debug_page/application_helper.rb

@@ -0,0 +1,4 @@
+module I18nDebugPage
+  module ApplicationHelper
+  end
+end

data/app/jobs/i18n_debug_page/application_job.rb

@@ -0,0 +1,4 @@
+module I18nDebugPage
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/i18n_debug_page/application_mailer.rb

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

data/app/models/i18n_debug_page/application_record.rb

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

data/app/views/i18n_debug_page/i18n_debug_logs/index.html.erb

@@ -0,0 +1,97 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>I18n debug page</title>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width">
+    <style type="text/css" media="screen">
+      body {
+          line-height: 2rem;
+          font-family: sans;
+          font-size: 14px;
+          background-color: #f0f0f0;
+          margin: 0;
+          padding: 0;
+          color: #000;
+          text-align: center;
+      }
+
+      a {
+          color: #333;
+      }
+
+      h1 {
+          font-weight: normal;
+          line-height: 2.8rem;
+          font-size: 30px;
+          letter-spacing: -1px;
+          text-align: center;
+          color: #333;
+      }
+
+      .container {
+          width: 960px;
+          margin: 40px auto;
+          text-align: left;
+          overflow: hidden;
+      }
+
+      .i18n_debug_logs {
+          background: #FFF;
+          width: 100%;
+          border-radius: 5px;
+      }
+
+      .i18n_debug_logs h1 {
+          border-radius: 5px 5px 0 0;
+          background: #f9f9f9;
+          padding: 10px;
+          border-bottom: 1px solid #eee;
+      }
+
+      .i18n_debug_logs .i18n_debug_log {
+          font-size: 14px;
+          border-bottom: 1px solid #eee;
+          padding: 15px;
+      }
+
+      .i18n_debug_logs .i18n_debug_log:last-child {
+          border-bottom: 0px;
+      }
+
+      .i18n_debug_logs .name {
+          font-size: 20px;
+          margin-right: 20px;
+          min-width: 100px;
+          font-weight: bold;
+          color: #555;
+      }
+      .i18n_debug_logs .result {
+        font-size: 14px;
+        float: right;
+        color: #45b81d;
+      }
+      .i18n_debug_logs .missing {
+        color: red;
+      }
+    </style>
+  </head>
+
+  <body>
+    <div class="container">
+      <div class="i18n_debug_logs">
+        <h1>I18n Debug Page</h1>
+        <% @i18n_debug_logs.each do |i18n_debug_log| %>
+        <div class="i18n_debug_log">
+          <div class="">
+            <span class="name"><%= i18n_debug_log[:key] %></span>
+            <span class="result <%= i18n_debug_log[:result] || 'missing' %>">
+              <%= i18n_debug_log[:result].inspect %>
+            </span>
+          </div>
+        </div>
+        <% end %>
+      </div>
+    </div>
+  </body>
+</html>

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>I18n debug page</title>
+  <%= stylesheet_link_tag    "i18n_debug_page/application", media: "all" %>
+  <%= javascript_include_tag "i18n_debug_page/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+I18nDebugPage::Engine.routes.draw do
+  resources :i18n_debug_logs
+end

data/lib/i18n_debug_page.rb

@@ -0,0 +1,18 @@
+require "i18n_debug_page/engine"
+require "i18n_debug_page/monitor"
+
+module I18nDebugPage
+  def recollect_i18n_debug_logs
+    I18nDebugPage::Monitor.i18n_debug_logs = []
+  end
+
+  class << self
+    def included(base)
+      base.send(:before_action, :recollect_i18n_debug_logs)
+    end
+
+    def i18n_debug_logs
+      I18nDebugPage::Monitor.i18n_debug_logs
+    end
+  end
+end

data/lib/i18n_debug_page/engine.rb

@@ -0,0 +1,5 @@
+module I18nDebugPage
+  class Engine < ::Rails::Engine
+    isolate_namespace I18nDebugPage
+  end
+end

data/lib/i18n_debug_page/monitor.rb

@@ -0,0 +1,16 @@
+require 'i18n/debug'
+module I18nDebugPage
+  class Monitor
+    class << self
+      attr_accessor :i18n_debug_logs
+
+      I18n::Debug.on_lookup do |key, result|
+        Monitor.i18n_debug_logs << { key: key, result: result }
+      end
+
+      def i18n_debug_logs
+        @i18n_debug_logs ||= []
+      end
+    end
+  end
+end

data/lib/i18n_debug_page/version.rb

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

data/lib/tasks/i18n_debug_page_tasks.rake

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

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: i18n_debug_page
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mike
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: i18n-debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !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'
+description: Provide UI for debugging i18n
+email:
+- yfractal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/i18n_debug_page_manifest.js
+- app/assets/javascripts/i18n_debug_page/application.js
+- app/assets/stylesheets/i18n_debug_page/application.css
+- app/controllers/i18n_debug_page/application_controller.rb
+- app/controllers/i18n_debug_page/i18n_debug_logs_controller.rb
+- app/helpers/i18n_debug_page/application_helper.rb
+- app/jobs/i18n_debug_page/application_job.rb
+- app/mailers/i18n_debug_page/application_mailer.rb
+- app/models/i18n_debug_page/application_record.rb
+- app/views/i18n_debug_page/i18n_debug_logs/index.html.erb
+- app/views/layouts/i18n_debug_page/application.html.erb
+- config/routes.rb
+- lib/i18n_debug_page.rb
+- lib/i18n_debug_page/engine.rb
+- lib/i18n_debug_page/monitor.rb
+- lib/i18n_debug_page/version.rb
+- lib/tasks/i18n_debug_page_tasks.rake
+homepage: ''
+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.5.1
+signing_key: 
+specification_version: 4
+summary: i18n debug page
+test_files: []