debug_logging 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3ee7daddd54cc1199fc371d7bd48d660ce357d2
-  data.tar.gz: 7c6df260c3c44b29eb0ed34a43e3a089146884c7
+  metadata.gz: 1a00a267599393fb551ec1a302174c836e2a91f1
+  data.tar.gz: d85adc612f75cd6a7d253f1faae0f687ddf35d24
 SHA512:
-  metadata.gz: aec9afec01f1d7eaa09b4ee3a97fe7fd94b1f742371507ff171d56416a057f9e0fc4630bf15d0943cc7b72561dec7fcc828998259633c33b14fba29a8f2a0d7b
-  data.tar.gz: 6e8ccd4a314a2ae6d41bc365ac2f76813fc6a381e261fc875840d5e805ec0b3dec56c2ba92ba1e1218f66d55f0ee4258091aa11ddbab1f745eb9c8aed89e9ba5
+  metadata.gz: a592d835e6d2091dd218bf60ed0b8ab42a4034776c7c4d9f939ff10a9cefaa4fed764204e58545e7dc139df1a0a5ab5742b43ae75873efb83440be0b223dcb8e
+  data.tar.gz: 6716a893dc45a1e042d1020df6fb574a9411f3d57530bed61f1f07e9b450410a2e61dad63c91e368b95623c53325f6f0e27c9b2b6b366689aa860c57a09cfceb

data/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in debug_logging.gemspec
 gemspec
 
-gem "byebug", "~> 9.0", platform: :mri
+gem 'byebug', '~> 9.0', platform: :mri

data/README.md

@@ -1,15 +1,34 @@
 # DebugLogging
 
+| Project                 |  DebugLogging     |
+|------------------------ | ----------------- |
+| gem name                |  debug_logging    |
+| license                 |  MIT              |
+| expert support          |  [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) |
+| download rank               |  [![Total Downloads](https://img.shields.io/gem/rt/debug_logging.svg)](https://rubygems.org/gems/debug_logging) |
+| version                 |  [![Gem Version](https://badge.fury.io/rb/debug_logging.png)](http://badge.fury.io/rb/debug_logging) |
+| dependencies            |  [![Dependency Status](https://gemnasium.com/pboling/debug_logging.png)](https://gemnasium.com/pboling/debug_logging) |
+| code quality            |  [![Code Climate](https://codeclimate.com/github/pboling/debug_logging.png)](https://codeclimate.com/github/pboling/debug_logging) |
+| inline documenation     |  [![Inline docs](http://inch-ci.org/github/pboling/debug_logging.png)](http://inch-ci.org/github/pboling/debug_logging) |
+| continuous integration  |  [![Build Status](https://secure.travis-ci.org/pboling/debug_logging.png?branch=master)](https://travis-ci.org/pboling/debug_logging) |
+| test coverage           |  [![Coverage Status](https://coveralls.io/repos/pboling/debug_logging/badge.png)](https://coveralls.io/r/pboling/debug_logging) |
+| homepage                |  [https://github.com/pboling/debug_logging][homepage] |
+| documentation           |  [http://rdoc.info/github/pboling/debug_logging/frames][documentation] |
+| live chat               |  [![Join the chat at https://gitter.im/pboling/debug_logging](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pboling/debug_logging?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
+| Spread ~♡ⓛⓞⓥⓔ♡~      |  [on AngelList](https://angel.co/peter-boling), [on Coderwall](http://coderwall.com/pboling) |
+
 ## Next Level Magic
 
+
+Herein you will find:
+
 * Classes inheriting from Module.
 * Cats and dogs sleeping together.
-* Yet this gem monkey patches nothing.
-* 100% clean.
-* 0% obtrusive.
+* Zero tolerance policy on monkey patching.
+* 100% clean, 0% obtrusive.
 * 100% tested.
 * 50% Ruby 2.0+ compatible.
-* 100% Ruby 2.1+ compatible.
+* 100% Ruby 2.1+ compatible, and therefore also compatible with JRuby 9000 and later.
 * 10g Monosodium glutamate.
 
 NOTE: The manner this is made to work for class methods is totally different than the way this is made to work for instance methods.
@@ -111,6 +130,7 @@ class Car
   # Option 1: specify the exact method(s) to add logging to
   include DebugLogging::InstanceLogger.new(i_methods: [:drive, :stop])
 
+  # Provides the `logged` method decorator
   extend DebugLogging::ClassLogger
 
   logged def make; new; end
@@ -121,7 +141,6 @@ class Car
   # override options for any instance method(s), by passing a hash as the last argument
   logged :dealer_options, { multiple_last_hashes: true }
 
-
   def drive(speed); speed; end
   def stop(**opts); 0; end
 
@@ -146,3 +165,60 @@ 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/pboling/debug_logging.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+6. Create new Pull Request
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0](http://semver.org/).
+Violations of this scheme should be reported as bugs. Specifically,
+if a minor or patch version is released that breaks backward
+compatibility, a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will
+only be introduced with new major versions.
+
+As a result of this policy, you can (and should) specify a
+dependency on this gem using the [Pessimistic Version Constraint](http://docs.rubygems.org/read/chapter/16#page74) with two digits of precision.
+
+For example:
+
+```ruby
+spec.add_dependency 'debug_logging', '~> 1.0'
+```
+
+## License
+
+MIT License
+
+Copyright (c) 2017 [Peter Boling][peterboling] of [RailsBling.com][railsbling]
+
+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.
+
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+[railsbling]: http://www.railsbling.com
+[peterboling]: http://www.peterboling.com
+[documentation]: http://rdoc.info/github/pboling/debug_logging/frames
+[homepage]: https://github.com/pboling/debug_logging

data/debug_logging.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
 Unobtrusive debug logging for Ruby without the litter
 Automatically log selected methods and their arguments as they are called at runtime!
 }
+  spec.license       = "MIT"
   spec.homepage      = "https://github.com/pboling/debug_logging"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -26,6 +27,7 @@ Automatically log selected methods and their arguments as they are called at run
   spec.add_runtime_dependency "colorize", "~> 0.8"
   spec.add_development_dependency "rspec-pending_for"
   spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "coveralls", "~> 0.8"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/debug_logging/version.rb

@@ -1,3 +1,3 @@
 module DebugLogging
-  VERSION = "1.0.7"
+  VERSION = "1.0.8"
 end

data/lib/debug_logging.rb

@@ -32,6 +32,7 @@ require "debug_logging/class_logger"
 #       # Option 1: specify the exact method(s) to add logging to
 #       include DebugLogging::InstanceLogger.new(i_methods: [:drive, :stop])
 #
+#       # Provides the `logged` method decorator
 #       extend DebugLogging::ClassLogger
 #
 #       logged def debug_make; new; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debug_logging
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Peter Boling
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +122,8 @@ files:
 - lib/debug_logging/version.rb
 - lib/simple_debug_logging.rb
 homepage: https://github.com/pboling/debug_logging
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []