logger_easy 0.2.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bc25bdbb82b074639ac48267a21cebdd02e45743c243de93d6f66f88c8aa146e
4
- data.tar.gz: c7bee45b91bd0cdc36b6522ef9251aef45712ac20cdcb259a4c99ed9a14ec57e
3
+ metadata.gz: ca38dde09b5211185e75a0f87d37f927291de1b0367e2b565bea0e967b8e04a3
4
+ data.tar.gz: 37d86cb0c280ffb9b2965ae2b9d73a1ecf95eab0f609007a349a58034b0d378c
5
5
  SHA512:
6
- metadata.gz: 48d08904552ff588f01cfd9b58b41f6923a16e7bdb2f85a81e456313f9b1f71fe57480034f283df83ce234a1ece184f8eb610a14e9d2a610779263ce42e77c22
7
- data.tar.gz: 1360bf87c94471e1fda5dbfbb5b13feab3d6bccc214046ebe162b56caf705110a4257cefc602047d53735eee796a70470965a5a9dad68184c0d4d1fa2131ec63
6
+ metadata.gz: 983212be40f0eabcc4eea06efab9db9de1171f00c83f22ab1f53817db20220e649a3db7d12a2a2f47e5ceb320268ce6f6f14ed202f57117e6216f930eec8825b
7
+ data.tar.gz: 5a3d6c696ec0eb824eca45795fe0f65cac0e5c2f6bf9dcd003fa5a6355f34bee6781e9cf60271be382396031aa300f472a52742d7879f4bf31ebaf181cb33287
data/.rubocop.yml CHANGED
@@ -12,6 +12,9 @@ Style/StringLiteralsInInterpolation:
12
12
  Style/OptionalBooleanParameter:
13
13
  Enabled: false
14
14
 
15
+ Style/CommentedKeyword:
16
+ Enabled: false
17
+
15
18
  Layout/LineLength:
16
19
  Max: 120
17
20
 
data/README.md CHANGED
@@ -24,38 +24,86 @@ If bundler is not being used to manage dependencies, install the gem by executin
24
24
 
25
25
  ## Usage
26
26
 
27
+ `include LoggerEasy`
28
+
27
29
  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
30
+
31
+ <pre>
32
+ DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN
33
+ </pre>
34
+
35
+ **initialize logger**
28
36
  ```ruby
29
- def initialize(log_file_name = 'logger_easy.log')
37
+ # below method will initialize logger
38
+ def logger_easy(log_file_name = 'logger_easy.log')
30
39
  @log_file_name = log_file_name
31
40
  @logger = Logger.new(log_file_name)
32
41
  end
33
42
  ```
34
43
 
35
- Log info in file
44
+ **debug**
45
+ ```ruby
46
+ # below method will log debug text to file
47
+ def log_debug(message)
48
+ @logger ||= Logger.new(@log_file_name)
49
+ @logger.debug(message)
50
+ end
51
+ ```
52
+
53
+ **info**
36
54
  ```ruby
55
+ # below method will log info text to file
37
56
  def log_info(message)
38
57
  @logger ||= Logger.new(@log_file_name)
39
58
  @logger.info(message)
40
59
  end
41
60
  ```
42
61
 
43
- Log debug in file
62
+ **warn**
44
63
  ```ruby
45
- def log_debug(message)
64
+ # below method will log warn text to file
65
+ def log_warn(message)
46
66
  @logger ||= Logger.new(@log_file_name)
47
- @logger.debug(message)
67
+ @logger.warn(message)
48
68
  end
49
69
  ```
50
70
 
51
- Log error in file
71
+ **error**
52
72
  ```ruby
73
+ # below method will log error text to file
53
74
  def log_error(message)
54
75
  @logger ||= Logger.new(@log_file_name)
55
76
  @logger.error(message)
56
77
  end
57
78
  ```
58
79
 
80
+ **fatal**
81
+ ```ruby
82
+ # below method will log fatal text to file
83
+ def log_fatal(message)
84
+ @logger ||= Logger.new(@log_file_name)
85
+ @logger.fatal(message)
86
+ end
87
+ ```
88
+
89
+ **unknown**
90
+ ```ruby
91
+ # below method will log unknown text to file
92
+ def log_unknown(message)
93
+ @logger ||= Logger.new(@log_file_name)
94
+ @logger.unknown(message)
95
+ end
96
+ ```
97
+
98
+ **close logger**
99
+ ```ruby
100
+ # below method will close logger
101
+ def logger_easy_close
102
+ @logger ||= Logger.new(@log_file_name)
103
+ @logger.close
104
+ end
105
+ ```
106
+
59
107
  ## Development
60
108
 
61
109
  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.
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module LoggerEasy
4
- VERSION = '0.2.0'
4
+ VERSION = '0.4.0'
5
5
  end
data/lib/logger_easy.rb CHANGED
@@ -5,26 +5,44 @@ require 'logger'
5
5
  # below is the code to make life easier as it already has logging methods defined
6
6
  module LoggerEasy
7
7
 
8
- attr_accessor :log_file_name
9
-
10
- def initialize(log_file_name = 'logger_easy.log')
8
+ def logger_easy(log_file_name = 'logger_easy.log')
11
9
  @log_file_name = log_file_name
12
10
  @logger = Logger.new(log_file_name)
13
- end
11
+ end # logger_easy
12
+
13
+ def log_debug(message)
14
+ @logger ||= Logger.new(@log_file_name)
15
+ @logger.debug(message)
16
+ end # log_debug
14
17
 
15
18
  def log_info(message)
16
19
  @logger ||= Logger.new(@log_file_name)
17
20
  @logger.info(message)
18
- end
21
+ end # log_info
19
22
 
20
- def log_debug(message)
23
+ def log_warn(message)
21
24
  @logger ||= Logger.new(@log_file_name)
22
- @logger.debug(message)
23
- end
25
+ @logger.warn(message)
26
+ end # log_warn
24
27
 
25
28
  def log_error(message)
26
29
  @logger ||= Logger.new(@log_file_name)
27
30
  @logger.error(message)
28
- end
31
+ end # log_error
32
+
33
+ def log_fatal(message)
34
+ @logger ||= Logger.new(@log_file_name)
35
+ @logger.fatal(message)
36
+ end # log_fatal
37
+
38
+ def log_unknown(message)
39
+ @logger ||= Logger.new(@log_file_name)
40
+ @logger.unknown(message)
41
+ end # log_unknown
42
+
43
+ def logger_easy_close
44
+ @logger ||= Logger.new(@log_file_name)
45
+ @logger.close
46
+ end # logger_easy_close
29
47
 
30
- end
48
+ end # LoggerEasy
metadata CHANGED
@@ -1,49 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logger_easy
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - amit-singh-bisht
8
- autorequire:
8
+ autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
11
  date: 2022-11-20 00:00:00.000000000 Z
12
- dependencies:
13
- - !ruby/object:Gem::Dependency
14
- name: logger
15
- requirement: !ruby/object:Gem::Requirement
16
- requirements:
17
- - - "~>"
18
- - !ruby/object:Gem::Version
19
- version: '1.5'
20
- - - ">="
21
- - !ruby/object:Gem::Version
22
- version: 1.5.1
23
- type: :runtime
24
- prerelease: false
25
- version_requirements: !ruby/object:Gem::Requirement
26
- requirements:
27
- - - "~>"
28
- - !ruby/object:Gem::Version
29
- version: '1.5'
30
- - - ">="
31
- - !ruby/object:Gem::Version
32
- version: 1.5.1
33
- - !ruby/object:Gem::Dependency
34
- name: rubocop
35
- requirement: !ruby/object:Gem::Requirement
36
- requirements:
37
- - - "~>"
38
- - !ruby/object:Gem::Version
39
- version: '1.21'
40
- type: :runtime
41
- prerelease: false
42
- version_requirements: !ruby/object:Gem::Requirement
43
- requirements:
44
- - - "~>"
45
- - !ruby/object:Gem::Version
46
- version: '1.21'
12
+ dependencies: []
47
13
  description: LoggerEasy provides you a way to easily log your activity. https://bit.ly/logger_easy
48
14
  email:
49
15
  - bishtamitsingh98@gmail.com
@@ -65,7 +31,7 @@ metadata:
65
31
  homepage_uri: https://github.com/amit-singh-bisht/logger_easy_ruby
66
32
  source_code_uri: https://github.com/amit-singh-bisht/logger_easy_ruby
67
33
  changelog_uri: https://github.com/amit-singh-bisht/logger_easy_ruby/blob/master/README.md
68
- post_install_message:
34
+ post_install_message:
69
35
  rdoc_options: []
70
36
  require_paths:
71
37
  - lib
@@ -80,8 +46,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
80
46
  - !ruby/object:Gem::Version
81
47
  version: '0'
82
48
  requirements: []
83
- rubygems_version: 3.2.3
84
- signing_key:
49
+ rubyforge_project:
50
+ rubygems_version: 2.7.3
51
+ signing_key:
85
52
  specification_version: 4
86
53
  summary: LoggerEasy provides you a way to easily log your activity. https://bit.ly/logger_easy
87
54
  test_files: []