rubocop-amagi 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa00724d1111fb9879f9f7c1e1dce30fdeb71f09d7f2c48eaf204a5046583782
-  data.tar.gz: 8e516fab6964c59a4cbffecb2fad4207b01738ab0e1f99648b64d5454e5d9517
+  metadata.gz: 5c511ba9414de4bf9b7fd8b9c22fd449642e137c4a6dc91ddb72ce1ba5d25843
+  data.tar.gz: dcc3756aeb88a3145b592ef21d2a1fdc1e401fd7de614454b0887c9f0a042b5d
 SHA512:
-  metadata.gz: edc06cd08d7c1b94cd6c88a42a21ab97b8043488cb3d4eb041671cf22afe47eba4ac2a07695225c007c4dbfe7ea4730646234b227b79149482ae790662a7650c
-  data.tar.gz: 57a5b9215454f2578d2fc8220cb1992bf02442be41bdfe11592b77b60d572487ad1f88e28bea791046608aefc17316a06d02fd5a712f246c7c185b8b022d6513
+  metadata.gz: b3009a45fb0297181f2d0aeabb9e6d6db74b486f6de675dab5a13a778e5e0fd7331df2308a6a4a27463302e73dfc52eea7a3f6ed4b2bf079074bec972895992a
+  data.tar.gz: 6e61fe1738eda19e5b6578c61c25ea0bebdcdddadcf837dd459bc3abd130f93529543260525db4865097d55ba0d55c8f700054120553d01bb52dd68809a4cb22

data/lib/cops/logger_format_cop.rb

@@ -0,0 +1,67 @@
+module RuboCop
+  module Cop
+    module CustomCops
+      class PutLoggerFormatCop < Cop
+        # Constant required for Rubocop
+        MSG = 'Log Format should be <module/class>#method_name:<space><message>'.freeze
+        def get_classname(node)
+            # for getting complete names of controllers
+            @name = ""
+            if node.children[0] == nil
+              @name += node.children[1].to_s + "::"
+            else
+              get_classname(node.children[0])
+              @name += node.children[1].to_s + "::"
+            end
+            return @name[0...-2]
+        end
+
+        def on_module(node)
+          # gives module name for a particular node
+          @class_name = node.children[0].children[1]
+        end
+
+        def on_class(node)
+          # gives class name for a particular node
+          @class_name = get_classname(node.children[0])
+        end
+
+        def on_def(node)
+          # gives method_name for each node
+          @method_name = node.children[0]
+        end
+
+        def on_defs(node)
+          # gives method_name for class methods
+          @method_name = node.children[1]
+        end
+
+        def on_block(node)
+          # give name of a block defined without any method
+          @method_name = node.children[0].children[1].to_s if node.parent&.parent && node.parent.parent&.class_type?
+        end
+
+        def on_send(node)
+          if node.children[1] == :puts 
+            str = get_string(node.children[2])
+            if str != "#{@class_name}##{@method_name}:"
+            # add offense if format not correct
+              add_offense(node, location: :expression)
+            end
+          end
+        end
+
+        def get_string(node)
+          string = if node&.str_type?
+                     node.children[0].to_s
+                   elsif node&.dstr_type?
+                     node.children[0].children[0].to_s
+                   else
+                     'false_string'
+                   end
+          string.partition(' ').first
+        end
+      end
+    end
+  end
+end

data/lib/cops/readme.md

@@ -0,0 +1,21 @@
+# Amagi Rubocop CustomCop Rules
+
+## How to use CustomCops?
+***
+**Using any cop**
+---
+Open .rubocop.yml in your working directory and set the enabled option as true.
+~~~ruby
+CustomCop/Copname: 
+  Enabled: true
+~~~
+### About PutLoggerFormatCop
+PutLoggerFormatCop ensures that the message format received on encountering **puts** is of the standard format 
+~~~ruby
+"<module/class>#method_name:<space><message>". 
+~~~
+Enabling the cop inside .rubocop.yml :
+~~~ruby
+CustomCop/PutLoggerFormatCop:
+  Enabled: true
+~~~

data/rubocop.yml

@@ -8,7 +8,11 @@ AllCops:
     - 'node_modules/**/*'
 
 require:
+  - './lib/cops/logger_format_cop.rb'
   - 'rubocop-rails'
+  
+CustomCops/PutLoggerFormatCop:
+  Enabled: false
 
 Bundler/DuplicatedGem:
   Enabled: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-amagi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Cloudport Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2022-07-08 00:00:00.000000000 Z
 dependencies: []
 description: amagi rubocop rules
 email: cloudport.team@amagi.com
@@ -16,6 +16,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/cops/logger_format_cop.rb
+- lib/cops/readme.md
 - rubocop.yml
 homepage: https://github.com/amagimedia/rubocop-amagi
 licenses:
@@ -36,7 +38,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: amagi rubocop rules