delogger 0.2.1 → 0.3.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec79336b89d1bd048e47fd1740706bb6ec0e41fb
-  data.tar.gz: 7190f5b8f2bd83fce6f463b5df60d717814b486e
+  metadata.gz: dba07624ea89cafdd1db84f72c879abaf0472637
+  data.tar.gz: 13cb174e168c085a6c420bb09e16eeae6dbfb9a8
 SHA512:
-  metadata.gz: ec68b265b5d8412a85437be839f0cbd7f43a2013deed9698f8b2d92fde1e1547870be64f61d7c3085e46407d232c7237df9ee9f989fa38279cdcd17d3588f437
-  data.tar.gz: 84e147d6b7675326d54622f5cb04a752d918f163dda408d0ed35d99a8d1d3e46a6e4aff60140e61bb5137b102db89c7a8fa890e43777d9c566539e9d9f10a6ac
+  metadata.gz: 9d385a1820dde27ffc7a3159f3340710113e3073873ace763b7fcd0cbdb4fe83f15d9bd7f62363cf3d15c3cd0c173a2f13bb00045d7c2a98818fbf88a878ac87
+  data.tar.gz: 40770d16bd88cf05751bdb07be79d9896014979b5a0fcbeed41a127da79a63aaaf15f6de735399695efc8ca1a46c3970990f6a16161e5b96520af3a6802b566c

data/README.md

@@ -2,25 +2,19 @@
 
 # Delogger
 
-Make your browser console beautiful. This gem is a work in progress.
+This gem is a simple wrapper for the browser's console. It can be turned off both globally
+(e.x. production environment) and locally. It also supports CSS formatting.
 ![Demo](/images/demo.png?raw=true)
 
-## Installation
+## Getting Started
 
-Add this line to your application's Gemfile:
+### Rails:
 
+Add the gem to your Gemfile:
 ```ruby
 gem 'delogger'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install delogger
-
 Add this to your `application.js`:
 ```
 //= require delogger
@@ -31,35 +25,39 @@ And `application.css`:
 *= require delogger
 ```
 
-## Usage
+### Without Rails:
 
-These methods work similarly to `console.log`, but they support [formatting](#formatting):
-- `DeLogger.debug`
-- `DeLogger.warn`
-- `DeLogger.error`
+Include `vendor/assets/javascripts/delogger.js` and `vendor/assets/stylesheets/delogger.css` into
+your application.
 
-By default, DeLogger is **disabled**. To enable it, use `DeLogger.enable()`. You can disable it again
-using `DeLogger.disable()`.
+## Usage
 
-## Logging levels
+First, DeLogger has to be initialized:
+```js
+logger = new DeLogger
+```
+See also: [options](#options).
+
+By default, DeLogger is **disabled on the client side**. To enable it, use `logger.enable()` in your
+console. You can disable it again using `logger.disable()`.
 
-DeLogger has three logging levels: `debug`, `warn` and `error`. Level can be set using `DeLogger.level`
-(default is `debug`). (TODO)
+DeLogger supports same output methods as console:
+- `log`, `debug`: ![debug][/images/debug.png?raw=true]
+- `info`: ![info][/images/info.png?raw=true]
+- `warn`: ![warn][/images/warn.png?raw=true]
+- `error`: ![error][/images/error.png?raw=true]
 
 ## 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`.
+DeLogger supports string formatting. Syntax: `"(my text).class1.class2"`.
+Supported classes: `badge`, `bold`, `italic`.
 See also: [color classes](#color-classes).
 
 Example:
 ```js
-DeLogger.log("(MyClass#myMethod).badge", "(@akxcv).badge.warn", "(bold).bold", { foo: 'bar' })
+logger.log("(MyClass#myMethod).badge.italic (@akxcv).badge.orange (bold).bold", { foo: 'bar' })
 ```
-![Example output](/images/example.png?raw=true)
-
-TODO
+![Example output](/images/formatting.png?raw=true)
 
 ## Color classes
 
@@ -84,13 +82,12 @@ At the moment, only these attributes are supported: `margin-left`, `color`, `bac
 
 ## Development
 
-TODO
+Modify files in the `assets` folder, compile them afterwards using `./bin/compile`.
 
 ## 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).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delogger
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0.alpha1
 platform: ruby
 authors:
 - Alexander Komarov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-03 00:00:00.000000000 Z
+date: 2017-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,29 +80,18 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Format your browser console output with colors, badges and more
+description: |-
+  Turn your console on and off globally or locally.
+                            Format your output with colors and badges.
 email:
 - ak@akxcv.com
 executables: []
 extensions: []
 extra_rdoc_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
@@ -118,13 +107,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Pretty output for browser console
+summary: A simple browser console wrapper
 test_files: []

data/.gitignore

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

data/Gemfile

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

data/assets/javascripts/delogger.coffee

@@ -1,62 +0,0 @@
-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

@@ -1,119 +0,0 @@
-.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

@@ -1,16 +0,0 @@
-#!/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

@@ -1,21 +0,0 @@
-# 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/rails.rb

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

data/lib/delogger/rails/engine.rb

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

data/lib/delogger/version.rb

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

data/vendor/assets/javascripts/delogger.js

@@ -1 +0,0 @@
-(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

@@ -1,69 +0,0 @@
-.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; }