Skip to content

amit-singh-bisht/logger_easy_ruby

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LoggerEasy


LoggerEasy provides you a way to easily log your activity

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add logger_easy

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install logger_easy

Usage

include LoggerEasy

Initialize the module by passing a file name where you want the logs to be appended, if no file_name is passed in parameter, it will create a file with name as logger_easy.log in the current working directory

DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN

initialize logger

# below method will initialize logger
def logger_easy(log_file_name = 'logger_easy.log')
  @log_file_name = log_file_name
  @logger = Logger.new(log_file_name)
end

debug

# below method will log debug text to file
def log_debug(message)
  @logger ||= Logger.new(@log_file_name)
  @logger.debug(message)
end

info

# below method will log info text to file
def log_info(message)
  @logger ||= Logger.new(@log_file_name)
  @logger.info(message)
end

warn

# below method will log warn text to file
def log_warn(message)
  @logger ||= Logger.new(@log_file_name)
  @logger.warn(message)
end

error

# below method will log error text to file
def log_error(message)
  @logger ||= Logger.new(@log_file_name)
  @logger.error(message)
end

fatal

# below method will log fatal text to file
def log_fatal(message)
  @logger ||= Logger.new(@log_file_name)
  @logger.fatal(message)
end

unknown

# below method will log unknown text to file
def log_unknown(message)
  @logger ||= Logger.new(@log_file_name)
  @logger.unknown(message)
end

close logger

# below method will close logger
def logger_easy_close
  @logger ||= Logger.new(@log_file_name)
  @logger.close
end

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/logger_easy.

License

The gem is available as open source under the terms of the MIT License.