https://github.com/jun0kada/log_marker

https://github.com/jun0kada/log_marker

debug rails ruby

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/jun0kada/log_marker
• Owner: Jun0kada
• License: mit
• Created: 2019-03-03T05:30:59.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-03-05T09:02:51.000Z (over 7 years ago)
• Last Synced: 2025-04-02T12:16:20.400Z (about 1 year ago)
• Topics: debug, rails, ruby
• Language: Ruby
• Size: 13.7 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# LogMarker

[![Build Status](https://travis-ci.org/Jun0kada/log_marker.svg?branch=master)](https://travis-ci.org/Jun0kada/log_marker)

debug logging with marker

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'log_marker'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install log_marker

## Usage

log_marker methods

`ml`, `p!`, `pp!`, `puts!`

```ruby

ml 'Hello my debug log'

# => ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

#

#

#

#

#

# "Hello my debug log"

#

#

#

#

#

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

p! 'Hello my debug log'

# => ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

#

#

#

#

#

# "Hello my debug log"

#

#

#

#

#

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

puts! 'Hello my debug log'

# => ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

#

#

#

#

#

# Hello my debug log

#

#

#

#

#

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

pp! ['Hello my debug log'] * 5

# => ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

#

#

#

#

#

# ["Hello my debug log",

#  "Hello my debug log",

#  "Hello my debug log",

#  "Hello my debug log",

#  "Hello my debug log"]

#

#

#

#

#

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

# ======================================================================================================================================================

```

## Config

```ruby

# config/initializers/log_marker.rb

LogMarker.config do |config|

  config.ml_alias = :p!

  config.marker   = -> { (['=' * 150] * 5).join("\n") }

end

```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/log_marker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the LogMarker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/log_marker/blob/master/CODE_OF_CONDUCT.md).