zgcp_toolkit 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdd5f30aab3e292d7eefa9c362a0e79129cfc39d48c85b74822377d80a30cd91
-  data.tar.gz: 8f0e40f5d92bad0d83c8e856b2d81d1dc347987fb28e1e963cdeb8e29d855b3d
+  metadata.gz: 84c4f7b62ed93f221db66092956a7453fd48b7ff1c89b2f826c8c4a75e265cc5
+  data.tar.gz: 19455250ff04e244d99487919385aabc21337289457780beab27663b7fb3f639
 SHA512:
-  metadata.gz: 462b117371427824f07fc8caf86b9d2af58e3304ebf38081e687e8c39264981a674600da0c6c69de9150d33a8975d7956af05ceab1a8ecd05d2f648d270a5590
-  data.tar.gz: be469a18442677b5ffddc406e029941c6cda7d9daa596d227f4785960d0f3e1801a7c49f28b5500ddd0d8caa80d8b56f4c0d06b7682ae89f833bf844b93d0e66
+  metadata.gz: 06ae78cb77e1ad779e7e19e1093b47dd2e2ee96ed32f6020a25dc1b49d4b1e2c4ee442f326f5603820dd02170b515e33ae7e142d5264104666fa9a131cf9a8a6
+  data.tar.gz: 0bf4ee4bca3bc738a4ea06e9b18a7cef34ece61e5c90353767cfc8bec4b7cd438bd7501a1179b3d00b34cf96226dc16b747b3aac20a6821837d489bb12ad474a

data/README.md

@@ -22,7 +22,6 @@ Next, you need to run the generator:
     $ rails generate zgcp_toolkit
 
 ## Logger
-Each rake task will have its own log file in Cloud Logging. The log file name on Cloud Logging are combined from the rake task `namespace`s and `task name`. The rake task also be able to access the logger object.
 
 Unexpected errors in rake tasks are caught automatically & write to a log file in Cloud Logging. And, by default, when GCP Toolkit caught an unexpected error, it push a key & value (key: `push_slack` with value: `true`) in Cloud Logging Log `jsonPayload` so that the log that should be sent on Slack can be filtered.
 
@@ -30,16 +29,17 @@ Unexpected errors in rake tasks are caught automatically & write to a log file i
 
 ```ruby
 namespace :tcv_transactions do
-  task :daily_import do |t, logger:|
-    logger.info("Heyyyyyy!")
-    # The error message & backtrace are sent to Cloud Logging
-    raise "Heyyyyyy Oops!"
+  task :daily_import
+    ZgcpToolkit::Logger.create(:log_name) do |logger|
+      logger.info("Heyyyyyy!") # You can log anything to console, also google cloud logging
+      Bug.last
+    end
   end
 end
 ```
 
 ```ruby
-logger = ZgcpToolkit::Logger.new(:any_log_name)
+logger = ZgcpToolkit::Logger.new(:log_name)
 logger.info("Heyyyyyy!")
 logger.error(message: "Heyyyyy!", backtrace: ["line-1", "line-2"])
 logger.error(message: "Hello Bug !!", backtrace: ["line-1", "line-2"], push_slack: true)
@@ -50,16 +50,18 @@ logger.warn("Hey hey nyc!")
 
 ```ruby
 namespace :test_log do 
-  task do: :environment do |args, logger:|
-    logger.send_unexpected_error_to_slack = false
-    raise 'errors'
+  task do: :environment
+    ZgcpToolkit::Logger.create(:log_name) do |logger|
+      logger.send_unexpected_error_to_slack = false
+      raise 'errors'
+    end
   end
 end
 ```
 
 ### Controller
 
-you can send controller errors to Google Cloud Loggings
+You can send controller errors to Google Cloud Loggings
 
 ```ruby
 # app/controllers/application_controller.rb

data/lib/zgcp_toolkit.rb

@@ -3,6 +3,5 @@ require "zgcp_toolkit/version"
 module ZgcpToolkit; end
 
 require 'zgcp_toolkit/logger'
-require 'zgcp_toolkit/rake/task'
 require 'zgcp_toolkit/generators/templates/zgcp_toolkit'
 require 'zgcp_toolkit/generators/zgcp_toolkit_generator'

data/lib/zgcp_toolkit/generators/templates/zgcp_toolkit.rb

@@ -1,9 +1,3 @@
-require 'dry/configurable'
-require 'google/cloud/logging'
-require 'rake/task'
-
-Rake::Task.prepend(ZgcpToolkit::Rake::Task)
-
 loggers = [:std_out]
 
 loggers.push(:google_cloud_logging) unless Rails.env.development?

data/lib/zgcp_toolkit/logger.rb

@@ -6,6 +6,8 @@ module ZgcpToolkit
   class Logger
     extend Dry::Configurable
 
+    REGEX_VALID_NAME = /^[a-z0-9_]+$/.freeze
+
     AVAILABLE_LOGGERS = {
       std_out: ZgcpToolkit::Logger::Stdout,
       google_cloud_logging: ZgcpToolkit::Logger::GoogleCloudLogging
@@ -17,6 +19,31 @@ module ZgcpToolkit
 
     class Error < StandardError; end
     class UnsupportedLogType < Error; end
+    class InvalidLogName < Error; end
+
+    class << self
+      def create(log_name)
+        raise InvalidLogName, "Log name is invalid. Log name regex is #{REGEX_VALID_NAME.inspect}" unless valid_name?(log_name.to_s)
+
+        logger = Logger.new(log_name.to_s)
+
+        begin
+          yield(logger) if block_given?
+        rescue StandardError => e
+          logger.error(e, push_slack: logger.send_unexpected_error_to_slack)
+          logger.flush!
+        end
+
+        logger
+      end
+
+      private
+
+      def valid_name?(log_name)
+        return true if log_name.match(REGEX_VALID_NAME)
+        false
+      end
+    end
 
     DEFAULT_BACKTRACE_LIMIT = 10
 

data/lib/zgcp_toolkit/version.rb

@@ -1,3 +1,3 @@
 module ZgcpToolkit
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zgcp_toolkit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - ZIGExN VeNtura developers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stackdriver
@@ -60,7 +60,6 @@ files:
 - lib/zgcp_toolkit/logger.rb
 - lib/zgcp_toolkit/logger/google_cloud_logging.rb
 - lib/zgcp_toolkit/logger/stdout.rb
-- lib/zgcp_toolkit/rake/task.rb
 - lib/zgcp_toolkit/version.rb
 - zgcp_toolkit.gemspec
 homepage: https://github.com/ZIGExN/zgcp_toolkit

data/lib/zgcp_toolkit/rake/task.rb

@@ -1,13 +0,0 @@
-module ZgcpToolkit::Rake
-  module Task
-    def execute(args=nil)
-      task_name = self.name.gsub(':', '_')
-      logger = ZgcpToolkit::Logger.new(task_name)
-      args.with_defaults(logger: logger)
-      super
-    rescue StandardError => e
-      logger.error(e, push_slack: logger.send_unexpected_error_to_slack)
-      logger.flush!
-    end
-  end
-end