rails_execution 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d04b62e7461cf38c3519551e7c96a9792418b5769d1e1782f317957c34bf617
-  data.tar.gz: cf09e00dfb2b487fae01323230b337f02b2867729ff05a6887d7dce0494cddbb
+  metadata.gz: cb0ab6279226fbab64ea8e0a6619202528381361c6c63500dad575b5620f67b5
+  data.tar.gz: 97d51f2050d6a9f8ea2ba465eabe86a2c5b6d26b4b16c9f1fd209f22619ee42b
 SHA512:
-  metadata.gz: 8ad2c6d2a14b9c6c3cb3be1e2728afbd9c691d5db1bd9d91f66a48d43219af9f334e4b9d23bf81d348e37422e7651d1d84469369845267d64b9ebf0aac4922de
-  data.tar.gz: b2e17748bdc9cb169ed742cb19fbe4ff80fc759c5465b25448f1d2ab47043d0bc40005b6b1c643cdd4f81c61944751f98108109e7f1ea1fcb086b7c220a8eabe
+  metadata.gz: 82365cd8b77f73cd78e8caf3672cdbf50dc3093a6a0aee83b8db77e7977a1d87e1414c5248aefec4533f0f59f0fa046403d591dd95f238de813e8d0837f5cc96
+  data.tar.gz: fac5f09675ff272f0dc65f1be8b8c0b56c69504c8ac1396d8c7281b255b11b34f8f1c1662fb1d7a8a714c8b836cec464647c2e4afaea6ab7eed5393c18de72d8

data/README.md

@@ -119,3 +119,68 @@ Default value: `20`
 ```ruby
   config.per_page = 10
 ```
+
+#### Pro-tips
+##### Logging
+- In editor, you can call the `log` method with `message` to log the message to logfile
+
+  Example:
+  ```ruby
+  log('Read upload file successful')
+  ```
+  Output:
+  ```
+  ==================== Wed, 22 Mar 2023 00:31:48
+  Read upload file successful
+  ```
+
+  And within the label liked it
+  ```ruby
+  log('Success', 'Read upload file')
+  ```
+  Output:
+  ```
+  ==================== Success
+  Read upload file
+  ```
+
+##### Show object Information
+
+- If you want to show the object information in loop or in the step by step, you can use the `info` method to show **Model name** and **id**.
+  ```ruby
+  ids = [1, 2]
+  Product.where(id: ids).each do |product|
+    info(product)
+    # Your code to process the product
+  end
+  ```
+  
+  Output: 
+  ```
+  ==================== Product#1
+  ==================== Product#2
+  ```
+
+##### Force to stop the process
+  If you want to add the message to log and **STOP** process, you can use the `error!` method
+
+Example:
+  ```ruby
+  error!('Bad-data', 'Unmatched value!') if var_x != var_y
+  ```
+  Output:
+  ```
+  ==================== Bad-data
+  Unmatched value!
+  ==================== Rolling back...
+  ```
+OR you can use the `stop!` method to Stop the process
+
+Example:
+```ruby
+stop!
+```
+or
+```ruby
+stop!('bad-data')
+```

data/app/views/rails_execution/tasks/_tips.html.haml

@@ -6,6 +6,22 @@
       Use
       %code Rails.logger.info 'message...'
       to add a message into log file
+    %span.tip
+      Use
+      %code info(object)
+      to add a Object info into log file
+    %span.tip
+      Use
+      %code log('Tag', 'message...')
+      to add a message into log file
+    %span.tip
+      Use
+      %code error!('Tag', 'message...')
+      to Stop the execution with the message and Tag in log file
+    %span.tip
+      Use
+      %code stop!('message...')
+      to Stop the execution with the message
     - if RailsExecution.configuration.file_upload
       %span.tip
         Call

data/lib/rails_execution/files/reader.rb

@@ -33,15 +33,19 @@ module RailsExecution
       attr_reader :task
 
       def save_to_tempfile(file_name, url)
-        file_extension = URI(url).path.split('.').last
-        file_extension = ".#{file_extension}" if file_extension
-        tmp_file = Tempfile.new([file_name, file_extension])
-        tmp_file.binmode
-        open(url) do |url_file|
-          tmp_file.write(url_file.read)
-        end
+        file = open(url)
+        return file if file.is_a?(Tempfile)
+
+        raise "Unsupported the Filetype #{file.class.name}" unless file.is_a?(StringIO)
 
-        return tmp_file
+        file_extension = file.base_uri.path.split('.').last
+        file_extension = ".#{file_extension}" if file_extension
+        tempfile = Tempfile.new([file_name, file_extension])
+        tempfile.binmode
+        tempfile.write(file.string)
+        tempfile.rewind
+        tempfile.close
+        tempfile
       end
 
     end

data/lib/rails_execution/services/executor.rb

@@ -2,6 +2,8 @@ module RailsExecution
   module Services
     class Executor
 
+      HIGHLIGHT = '=' * 20
+
       def initialize(task)
         @task = task
         @file_reader = ::RailsExecution.configuration.file_reader.new(task)
@@ -19,6 +21,29 @@ module RailsExecution
         @file_reader.get_file(name)
       end
 
+      def info(object)
+        model_name = object.respond_to?(:model_name) ? object.model_name.name : object.to_s
+        message = model_name + '#' + object&.id.to_s
+        log(message, nil)
+      end
+
+      def log(label = nil, message)
+        label ||= Time.current
+
+        Rails.logger.info("#{HIGHLIGHT} #{label}")
+        Rails.logger.info(message) if message
+      end
+
+      def error!(label = nil, message)
+        log(label, message)
+        stop!
+      end
+
+      def stop!(message = nil)
+        log('Rolling back...', message)
+        raise :rollback
+      end
+
     end
   end
 end

data/lib/rails_execution/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsExecution
-  VERSION = '0.1.2'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_execution
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Khoa Nguyen
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -135,7 +135,7 @@ metadata:
   homepage_uri: https://github.com/ThanhKhoaIT/rails_execution
   source_code_uri: https://github.com/ThanhKhoaIT/rails_execution
   changelog_uri: https://github.com/ThanhKhoaIT/rails_execution
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -150,8 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: 'Rails Engine: Execute the script for migration, cleanup data and specially
   case'