logger_easy 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5ebf5a841fdd5736e003089251a7680e343d4a2b383a4eb4e41958d8256bbff
-  data.tar.gz: f8e5f7c945282285fcb14b0fb6e1922fc3a542dc93bf1d3095bf100bf51858b2
+  metadata.gz: 23558f99d926efd28695cec63a558383c5992a0bb0e1e095104869fac6994c28
+  data.tar.gz: bc67366d7e0be23f4d800a9b3557ec87e8ab58238f79a92330843df7e2f07afd
 SHA512:
-  metadata.gz: 68150925722c5178ffa3b68459e4e3b5d7ad910525854b83296abf9aaf791d80dce1833c264e91b8e7752840697c0710a5bd5a7998f50220528e852c82d40e28
-  data.tar.gz: f145a3cc422b632c91c650a59c7d905f2ca317212acd885e05e26108cf401ef022a1b67b802b13026f4fc32208ba400e49b23519007d9575e9d6ab7049c0c5c5
+  metadata.gz: 542762ce4b7e76c6c74b2cb9ecf8e765342f74381cabff3afdd789aa2d79eb7bfd4aa4ac4c9678fd95c1613ccee24d2dd2633d5ce540016fa06ad7bc031522e2
+  data.tar.gz: 8eaf8e3eadef073df003e63240a1d616f14cc30d4f425bde3b7e818afe61416f7baecd77dce87cbbc06bd8c7dc97c0bc1186bcaaaa4491a8333ff165ed088579

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logger_easy.gemspec
+gemspec
+
+gem 'logger', '~> 1.5', '>= 1.5.1'
+gem 'rubocop', '~> 1.21'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Amit Singh Bisht (https://github.com/amit-singh-bisht)
+
+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.

data/README.md

@@ -1,8 +1,16 @@
 # LoggerEasy
+<div>
+    <a href="https://rubygems.org/gems/logger_easy">
+        <img alt="GEM Version" src="https://img.shields.io/gem/v/logger_easy?color=38C160&logo=ruby&logoColor=FE1616">
+    </a>
+    <a href="https://rubygems.org/gems/logger_easy">
+        <img alt="Gem Downloads" src="https://img.shields.io/gem/dt/logger_easy?color=38C160&logo=ruby&logoColor=FE1616">
+    </a>
+</div>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/logger_easy`. To experiment with that code, run `bin/console` for an interactive prompt.
+<br>
 
-TODO: Delete this and the text above, and describe your gem
+LoggerEasy provides you a way to easily log your activity
 
 ## Installation
 
@@ -16,7 +24,43 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+`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
+```ruby
+# 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
+```
+
+Log info in file
+```ruby
+# below method will add log info to file
+def log_info(message)
+  @logger ||= Logger.new(@log_file_name)
+  @logger.info(message)
+end
+```
+
+Log debug in file
+```ruby
+# below method will add debug info to file
+def log_debug(message)
+  @logger ||= Logger.new(@log_file_name)
+  @logger.debug(message)
+end
+```
+
+Log error in file
+```ruby
+# below method will add error info to file
+def log_error(message)
+  @logger ||= Logger.new(@log_file_name)
+  @logger.error(message)
+end
+```
 
 ## Development
 

data/lib/logger_easy/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LoggerEasy
+  VERSION = '0.3.0'
+end

data/lib/logger_easy.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+# below is the code to make life easier as it already has logging methods defined
+module LoggerEasy
+
+  attr_accessor :log_file_name
+
+  def logger_easy(log_file_name = 'logger_easy.log')
+    @log_file_name = log_file_name
+    @logger = Logger.new(log_file_name)
+  end
+
+  def log_info(message)
+    @logger ||= Logger.new(@log_file_name)
+    @logger.info(message)
+  end
+
+  def log_debug(message)
+    @logger ||= Logger.new(@log_file_name)
+    @logger.debug(message)
+  end
+
+  def log_error(message)
+    @logger ||= Logger.new(@log_file_name)
+    @logger.error(message)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logger_easy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - amit-singh-bisht
@@ -9,42 +9,8 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2022-11-20 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: logger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.1
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.21'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.21'
-description: LoggerEasy provides you a way to easily log your activity. https://bit.ly/ld_doc
+dependencies: []
+description: LoggerEasy provides you a way to easily log your activity. https://bit.ly/logger_easy
 email:
 - bishtamitsingh98@gmail.com
 executables: []
@@ -52,7 +18,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
 - README.md
+- lib/logger_easy.rb
+- lib/logger_easy/version.rb
 homepage: https://github.com/amit-singh-bisht/logger_easy_ruby
 licenses:
 - MIT
@@ -79,5 +49,5 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: LoggerEasy provides you a way to easily log your activity. https://bit.ly/ld_doc
+summary: LoggerEasy provides you a way to easily log your activity. https://bit.ly/logger_easy
 test_files: []