delogger 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fbef0668a642331e5096b767f11653c6d5b2617
-  data.tar.gz: 8e01c55ea71d437d25e005cdaac787c7fc15b53b
+  metadata.gz: ec79336b89d1bd048e47fd1740706bb6ec0e41fb
+  data.tar.gz: 7190f5b8f2bd83fce6f463b5df60d717814b486e
 SHA512:
-  metadata.gz: 3f49acb8a053f32bac14bccbf7322aa7f6fa571091b79cdcbaa8d2e5054fbbe9d56a00b98bb225c884b3442304e4a246d48cf78e708d55811e9d8af8a634a334
-  data.tar.gz: 7ff26d70e023c4df3342dc0f56ebe61d12e468cadec4d03147081fb29bf3ebc4de6155dc8c29e05fc37e55635c650510443a50c9ed955c47c6dab7b786ca32cf
+  metadata.gz: ec68b265b5d8412a85437be839f0cbd7f43a2013deed9698f8b2d92fde1e1547870be64f61d7c3085e46407d232c7237df9ee9f989fa38279cdcd17d3588f437
+  data.tar.gz: 84e147d6b7675326d54622f5cb04a752d918f163dda408d0ed35d99a8d1d3e46a6e4aff60140e61bb5137b102db89c7a8fa890e43777d9c566539e9d9f10a6ac

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Alexander Komarov
+
+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,96 @@
+[![Gem Version](https://badge.fury.io/rb/delogger.svg)](https://badge.fury.io/rb/delogger)
+
+# Delogger
+
+Make your browser console beautiful. This gem is a work in progress.
+![Demo](/images/demo.png?raw=true)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'delogger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install delogger
+
+Add this to your `application.js`:
+```
+//= require delogger
+```
+
+And `application.css`:
+```
+*= require delogger
+```
+
+## Usage
+
+These methods work similarly to `console.log`, but they support [formatting](#formatting):
+- `DeLogger.debug`
+- `DeLogger.warn`
+- `DeLogger.error`
+
+By default, DeLogger is **disabled**. To enable it, use `DeLogger.enable()`. You can disable it again
+using `DeLogger.disable()`.
+
+## Logging levels
+
+DeLogger has three logging levels: `debug`, `warn` and `error`. Level can be set using `DeLogger.level`
+(default is `debug`). (TODO)
+
+## Formatting
+
+DeLogger supports string formatting. Syntax: `"(my text).class1.class2"`. Classes are specific for
+the logger and are not being fetched from stylesheets.
+Supported classes: `badge`, `debug`, `warn`, `error`, `bold`, `italic`.
+See also: [color classes](#color-classes).
+
+Example:
+```js
+DeLogger.log("(MyClass#myMethod).badge", "(@akxcv).badge.warn", "(bold).bold", { foo: 'bar' })
+```
+![Example output](/images/example.png?raw=true)
+
+TODO
+
+## Color classes
+
+DeLogger supports following color classes (both for badges and normal text):
+- `.blue`
+- `.orange`
+- `.red`
+- `.green`
+- `.cyan`
+- `.yellow`
+- `.gray`
+- `.brown`
+- `.purple`
+- `.pink`
+
+## Adding custom / overriding existing styles
+
+All styles are declared in a stylesheet and thus are easily extensible.
+See [`assets/stylesheets/delogger.scss`](assets/stylesheets/delogger.scss).
+At the moment, only these attributes are supported: `margin-left`, `color`, `background-color`,
+`border-radius`, `padding`, `font-weight`, `font-style`.
+
+## Development
+
+TODO
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/akxcv/delogger.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/assets/javascripts/delogger.coffee

@@ -0,0 +1,62 @@
+class @DeLogger
+  @debug: (args...) ->
+    print('debug', computeStyle('badge debug'), args...)
+
+  @warn: (args...) ->
+    print('warn', computeStyle('badge warn'), args...)
+
+  @error: (args...) ->
+    print('error', computeStyle('badge error'), args...)
+
+  @enable: ->
+    localStorage.setItem("deloggerEnabled", true)
+
+  @disable: ->
+    localStorage.removeItem("deloggerEnabled")
+
+  @setLevel: (level) ->
+    localStorage.setItem("deloggerLevel", level)
+
+  # private
+
+  print = (level, initialStyles, args...) ->
+    return unless canPrint(level)
+    text = "%c#{level}"
+    styles = [initialStyles]
+    formattedArgumentCount = 0
+
+    for arg in args
+      break unless typeof arg is 'string'
+      [string, style] = parseString(arg)
+      text += string
+      styles.push(style)
+      formattedArgumentCount += 1
+
+    args.splice(0, formattedArgumentCount)
+    console.log text, styles..., args...
+
+  canPrint = (level) ->
+    localStorage.deloggerEnabled? and availableLevels().indexOf(level) != -1
+
+  availableLevels = ->
+    switch localStorage.deloggerLevel
+      when 'debug' then ['debug', 'warn', 'error']
+      when 'warn' then ['warn', 'error']
+      when 'error' then ['error']
+      else ['debug', 'warn', 'error']
+
+  parseString = (string) ->
+    if match = string.match(/^\((.+)\)(\..+)$/)
+      classes = match[2].split('.').join(' ')
+      return ["%c#{match[1]}", computeStyle("#{classes} after")]
+    ["%c#{string}", computeStyle('default after')]
+
+  computeStyle = (classes) ->
+    div = $("<div id='delogger_temp' class='delogger #{classes}' style='display: none;'>")
+    $('body').append(div)
+    style = ("#{key}:#{value}" for key, value of div.css(supportedStyles)).join(';')
+    $('#delogger_temp').remove()
+    style
+
+  supportedStyles = ['margin-left', 'color', 'background-color', 'border-radius', 'padding',
+                     'font-weight', 'font-style']

data/assets/stylesheets/delogger.scss

@@ -0,0 +1,119 @@
+.delogger {
+  color: black;
+  background-color: transparent;
+  border-radius: 0;
+  padding: 0;
+  margin-left: 0;
+  font-weight: normal;
+  font-style: normal;
+
+  &.default {}
+  &.after {
+    margin-left: 3px;
+  }
+
+  &.badge {
+    color: white;
+    background-color: black;
+    border-radius: 9px;
+    padding: 1px 5px;
+
+    &.debug, &.blue {
+      color: white;
+      background-color: blue;
+    }
+
+    &.warn, &.orange {
+      color: white;
+      background-color: orange;
+    }
+
+    &.error, &.red {
+      color: white;
+      background-color: red;
+    }
+
+    &.green {
+      color: white;
+      background-color: green;
+    }
+
+    &.cyan {
+      color: gray;
+      background-color: cyan;
+    }
+
+    &.yellow {
+      color: gray;
+      background-color: yellow;
+    }
+
+    &.gray {
+      color: white;
+      background-color: gray;
+    }
+
+    &.brown {
+      color: white;
+      background-color: brown;
+    }
+
+    &.purple {
+      color: white;
+      background-color: purple;
+    }
+
+    &.pink {
+      color: gray;
+      background-color: pink;
+    }
+  }
+
+  &.blue {
+    color: blue;
+  }
+
+  &.orange {
+    color: orange;
+  }
+
+  &.red {
+    color: red;
+  }
+
+  &.green {
+    color: green;
+  }
+
+  &.cyan {
+    color: cyan;
+  }
+
+  &.yellow {
+    color: yellow;
+  }
+
+  &.gray {
+    color: gray;
+  }
+
+  &.brown {
+    color: brown;
+  }
+
+  &.purple {
+    color: purple;
+  }
+
+  &.pink {
+    color: pink;
+  }
+
+  &.bold {
+    font-weight: bold;
+  }
+
+  &.italic {
+    font-style: italic;
+  }
+}

data/bin/compile

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+Bundler.setup
+
+require 'coffee-script'
+require 'uglifier'
+require 'sass'
+
+JS_IN_PATH  = 'assets/javascripts/delogger.coffee'
+JS_OUT_PATH = 'vendor/assets/javascripts/delogger.js'
+CSS_IN_PATH = 'assets/stylesheets/delogger.scss'
+CSS_OUT_PATH = 'vendor/assets/stylesheets/delogger.css'
+
+compiled_coffee = CoffeeScript.compile(File.read(JS_IN_PATH))
+File.write JS_OUT_PATH, Uglifier.compile(compiled_coffee)
+File.write CSS_OUT_PATH, Sass.compile(File.read(CSS_IN_PATH))

data/delogger.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'delogger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "delogger"
+  spec.version       = DeLogger::VERSION
+  spec.authors       = ["Alexander Komarov"]
+  spec.email         = ["ak@akxcv.com"]
+
+  spec.summary       = %q{Pretty output for browser console}
+  spec.description   = %q{Format your browser console output with colors, badges and more}
+  spec.homepage      = "https://github.com/akxcv/delogger"
+  spec.license       = "MIT"
+
+  spec.require_path  = "lib"
+  spec.files         = `git ls-files`.split("\n")
+
+  %w[bundler coffee-script coffee-script-source uglifier sass].each { |x| spec.add_development_dependency x }
+end

data/lib/delogger.rb

@@ -0,0 +1,7 @@
+require "delogger/version"
+require "delogger/rails"
+
+module DeLogger
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/delogger/rails.rb

@@ -0,0 +1,6 @@
+require "delogger/rails/engine"
+
+module DeLogger
+  module Rails
+  end
+end

data/lib/delogger/rails/engine.rb

@@ -0,0 +1,6 @@
+module DeLogger
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/delogger/version.rb

@@ -0,0 +1,3 @@
+module DeLogger
+  VERSION = "0.2.1"
+end

data/vendor/assets/javascripts/delogger.js

@@ -0,0 +1 @@
+(function(){var e=[].slice;this.DeLogger=function(){function r(){}var n,l,t,o,a,c;return r.debug=function(){var r;return r=1<=arguments.length?e.call(arguments,0):[],a.apply(null,["debug",t("badge debug")].concat(e.call(r)))},r.warn=function(){var r;return r=1<=arguments.length?e.call(arguments,0):[],a.apply(null,["warn",t("badge warn")].concat(e.call(r)))},r.error=function(){var r;return r=1<=arguments.length?e.call(arguments,0):[],a.apply(null,["error",t("badge error")].concat(e.call(r)))},r.enable=function(){return localStorage.setItem("deloggerEnabled",!0)},r.disable=function(){return localStorage.removeItem("deloggerEnabled")},r.setLevel=function(e){return localStorage.setItem("deloggerLevel",e)},a=function(){var r,n,t,a,c,u,g,i,d,f,s,p;if(g=arguments[0],c=arguments[1],n=3<=arguments.length?e.call(arguments,2):[],l(g)){for(p="%c"+g,s=[c],t=0,a=0,u=n.length;a<u&&(r=n[a],"string"==typeof r);a++)i=o(r),d=i[0],f=i[1],p+=d,s.push(f),t+=1;return n.splice(0,t),console.log.apply(console,[p].concat(e.call(s),e.call(n)))}},l=function(e){return null!=localStorage.deloggerEnabled&&n().indexOf(e)!==-1},n=function(){switch(localStorage.deloggerLevel){case"debug":return["debug","warn","error"];case"warn":return["warn","error"];case"error":return["error"];default:return["debug","warn","error"]}},o=function(e){var r,n;return(n=e.match(/^\((.+)\)(\..+)$/))?(r=n[2].split(".").join(" "),["%c"+n[1],t(r+" after")]):["%c"+e,t("default after")]},t=function(e){var r,n,l,t;return r=$("<div id='delogger_temp' class='delogger "+e+"' style='display: none;'>"),$("body").append(r),l=function(){var e,l;e=r.css(c),l=[];for(n in e)t=e[n],l.push(n+":"+t);return l}().join(";"),$("#delogger_temp").remove(),l},c=["margin-left","color","background-color","border-radius","padding","font-weight","font-style"],r}()}).call(this);

data/vendor/assets/stylesheets/delogger.css

@@ -0,0 +1,69 @@
+.delogger {
+  color: black;
+  background-color: transparent;
+  border-radius: 0;
+  padding: 0;
+  margin-left: 0;
+  font-weight: normal;
+  font-style: normal; }
+  .delogger.after {
+    margin-left: 3px; }
+  .delogger.badge {
+    color: white;
+    background-color: black;
+    border-radius: 9px;
+    padding: 1px 5px; }
+    .delogger.badge.debug, .delogger.badge.blue {
+      color: white;
+      background-color: blue; }
+    .delogger.badge.warn, .delogger.badge.orange {
+      color: white;
+      background-color: orange; }
+    .delogger.badge.error, .delogger.badge.red {
+      color: white;
+      background-color: red; }
+    .delogger.badge.green {
+      color: white;
+      background-color: green; }
+    .delogger.badge.cyan {
+      color: gray;
+      background-color: cyan; }
+    .delogger.badge.yellow {
+      color: gray;
+      background-color: yellow; }
+    .delogger.badge.gray {
+      color: white;
+      background-color: gray; }
+    .delogger.badge.brown {
+      color: white;
+      background-color: brown; }
+    .delogger.badge.purple {
+      color: white;
+      background-color: purple; }
+    .delogger.badge.pink {
+      color: gray;
+      background-color: pink; }
+  .delogger.blue {
+    color: blue; }
+  .delogger.orange {
+    color: orange; }
+  .delogger.red {
+    color: red; }
+  .delogger.green {
+    color: green; }
+  .delogger.cyan {
+    color: cyan; }
+  .delogger.yellow {
+    color: yellow; }
+  .delogger.gray {
+    color: gray; }
+  .delogger.brown {
+    color: brown; }
+  .delogger.purple {
+    color: purple; }
+  .delogger.pink {
+    color: pink; }
+  .delogger.bold {
+    font-weight: bold; }
+  .delogger.italic {
+    font-style: italic; }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delogger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Alexander Komarov
@@ -86,7 +86,23 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- assets/javascripts/delogger.coffee
+- assets/stylesheets/delogger.scss
+- bin/compile
+- delogger.gemspec
+- images/demo.png
+- images/example.png
+- lib/delogger.rb
+- lib/delogger/rails.rb
+- lib/delogger/rails/engine.rb
+- lib/delogger/version.rb
+- vendor/assets/javascripts/delogger.js
+- vendor/assets/stylesheets/delogger.css
 homepage: https://github.com/akxcv/delogger
 licenses:
 - MIT