super_awesome_print 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb39c2290ca2b6ed6ab2436a82d16b47a8edab7e
-  data.tar.gz: 0976a049b8d00556c682d9a008c05d5b7466d181
+  metadata.gz: f278fe4412a4ff7d18230b15cd8d5a36780ce476
+  data.tar.gz: 814ec19746437935d831a4ffcc1748ec4cf0b26a
 SHA512:
-  metadata.gz: 560ca36e08e3947a95d700d3f0c034757745c0a924b2c53338ef47d408436ccd49712b2a11c5dffce29de88200ccede2f703633a1887116712836744ccd50de5
-  data.tar.gz: 8d2ce3c8324a820d1bc9f0c85c9647c1eb7e344f3f01d778b65792d83717ad6829c5c946b9f84e545684a9ef9ab25e1a7e6915092e7a7c454dac0428b657b96f
+  metadata.gz: 88d59f52d0c7aa9e9bf3213fe13c038ddae55c4df0fe76e69171cc90355678423b8d71d0f34086af5af2d43e1f8e0427ffaf09b69234f877d9d981e87ed3320a
+  data.tar.gz: ac5cc4430a541b092e4eaa3d161ad9a14af26c59955566c581281c44abe580cc54020cd0c2506447ccef24099f63aded79c825fcc98fd5a5d984e33e85568d83

data/README.md

@@ -15,7 +15,7 @@ end
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'super_awesome_print', github: 'olegantonyan/super_awesome_print'
+gem 'super_awesome_print'
 ```
 
 And then execute:
@@ -26,6 +26,17 @@ Or install it yourself as:
 
     $ gem install super_awesome_print
 
+You can optionally customize configuration in an initializer.<br/>
+In Rails, you can add the following to `config/initializers/super_awesome_print.rb`:
+
+```ruby
+SuperAwesomePrint.configure do |config|
+  config.caller_lines = 3 # defaults to 1
+  config.blank_lines_top = 2 # defaults to 0
+  config.blank_lines_bottom = 2 # defaults to 0
+end
+```
+
 ## Usage
 
 Just use `sap` global function to print any variable.
@@ -38,7 +49,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/super_awesome_print. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/olegantonyan/super_awesome_print. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://www.contributor-covenant.org) code of conduct.
 
 
 ## License

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "super_awesome_print"
+require 'bundler/setup'
+require 'super_awesome_print'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "super_awesome_print"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/super_awesome_print.rb

@@ -1,13 +1,50 @@
-require "super_awesome_print/version"
-require "awesome_print"
+require 'super_awesome_print/version'
+require 'super_awesome_print/configuration'
+require 'awesome_print'
 
-def sap msg
-  ap "*** #{Time.now} ***", color: {string: :green}
-  src = caller.first.gsub(Rails.root.to_s + '/', '')
-  ap src, color: {string: :purpleish}
+def sap(msg)
+  SuperAwesomePrint.blank_lines_top
+  ap "*** #{Time.now} ***", color: { string: :green }
+  ap msg.class if msg.respond_to?(:class)
+  SuperAwesomePrint.print_caller_lines(caller)
   ap msg
-  ap '*** END ***', color: {string: :green}
+  ap '*** END ***', color: { string: :green }
+  SuperAwesomePrint.blank_lines_bottom
 end
 
 module SuperAwesomePrint
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.print_caller_lines(caller_array)
+    number_of_lines = config.caller_lines
+    lines = caller_array[0...number_of_lines].map do |line|
+      line.gsub(Rails.root.to_s + '/', '')
+    end
+    lines.each { |line| ap line, color: { string: :purpleish } }
+  end
+
+  def self.blank_lines_top
+    # The first puts has no visible effect
+    # So we want to puts once regardless of config
+    puts
+    config.blank_lines_top.times { puts }
+  end
+
+  def self.blank_lines_bottom
+    config.blank_lines_bottom.times { puts }
+  end
+
+  def self.config
+    SuperAwesomePrint.configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
 end

data/lib/super_awesome_print/configuration.rb

@@ -0,0 +1,9 @@
+class Configuration
+  attr_accessor :caller_lines, :blank_lines_top, :blank_lines_bottom
+
+  def initialize
+    @caller_lines = 1
+    @blank_lines_top = 0
+    @blank_lines_bottom = 0
+  end
+end

data/lib/super_awesome_print/version.rb

@@ -1,3 +1,3 @@
 module SuperAwesomePrint
-  VERSION = "0.1.1"
+  VERSION = '0.2.0'.freeze
 end

data/super_awesome_print.gemspec

@@ -4,22 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'super_awesome_print/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "super_awesome_print"
+  spec.name          = 'super_awesome_print'
   spec.version       = SuperAwesomePrint::VERSION
-  spec.authors       = ["Oleg Antonyan"]
-  spec.email         = ["oleg.b.antonyan@gmail.com"]
+  spec.authors       = ['Oleg Antonyan']
+  spec.email         = ['oleg.b.antonyan@gmail.com']
 
-  spec.summary       = %q{Simple wrapper around awesome_print for easier look in long log}
-  spec.description   = %q{Add colored '*********', time and line number around printed value}
-  spec.homepage      = "http://github.com/olegantonyan/super_awesome_printsuper_awesome_print"
-  spec.license       = "MIT"
+  spec.summary       = 'Simple wrapper around awesome_print for easier look in long log'
+  spec.description   = "Add colored '*********', time and line number around printed value"
+  spec.homepage      = 'http://github.com/olegantonyan/super_awesome_print'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_runtime_dependency "awesome_print"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_runtime_dependency 'awesome_print'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_awesome_print
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Oleg Antonyan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2016-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,9 +70,10 @@ files:
 - bin/console
 - bin/setup
 - lib/super_awesome_print.rb
+- lib/super_awesome_print/configuration.rb
 - lib/super_awesome_print/version.rb
 - super_awesome_print.gemspec
-homepage: http://github.com/olegantonyan/super_awesome_printsuper_awesome_print
+homepage: http://github.com/olegantonyan/super_awesome_print
 licenses:
 - MIT
 metadata: {}