fastlane-plugin-csv_translation 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bad9b02f320e313b6aadeccc265b8d96e6753b2d3750ddf04601cbcd2ef8611f
-  data.tar.gz: 94690626575fd7853302aad9cad12d813619429550d484c23c09e09e558a1834
+  metadata.gz: d0f16b7ee0ca379dd5ea0519771ff45f609c567715fc10e6245175a9dde17571
+  data.tar.gz: 4735dd08f4a574bf92d820937a51131a7ea73525801e507ae67bf20f37e01b48
 SHA512:
-  metadata.gz: 0af2a8d700c7ed36c93e8faadeb0071c69d7bf715d182cf721d1108d6709c6e9e2c53e59169e917166fd0e54c739feffd70ef1a1e4a7e086cdb35bf7fd6d1d80
-  data.tar.gz: a51ff28ce777a9a8e881e4309be443723d850e560e432f345c2f0a33c06d753c390af0e360296cef2b0f1d52a8ea0a9c2b2cd8291f3b9a3fd02b9de0c10e6aa4
+  metadata.gz: 82be092d741b44d89dbbc1bf0b476575f4a0decb18c3f12583c87904c0de618f18a3d61af94a033099e516fee67ef55d9e06945446c1ed62adfba86acf122e65
+  data.tar.gz: 423d5e8a753a5aeb1ccd4a80ecab0e71ed98f2a9b45696c69ab43bf530ff619ffc973bcfe06e24df0a58151efb0e7652f715970a1a15bc812591ffad3ce20f79

data/README.md

@@ -28,7 +28,7 @@ This plugin opens up an opportunity to automate reading from/writing of any `CSV
 <img width="1476" alt="Example CSV" src="https://user-images.githubusercontent.com/5364500/81500222-fe912780-92d0-11ea-87a7-952a78b5cdf7.png">
 
 ## Actions
-`fastlane-plugin-csv_translation` consists of 3 actions enabling you to manipulate `CSV` file from [`fastlane`](https://fastlane.tools).
+`fastlane-plugin-csv_translation` consists of 4 actions enabling you to manipulate `CSV` file from [`fastlane`](https://fastlane.tools).
 
 ### 📡 get_csv_translation_requests
 Get all the translation info as hash from the CSV file, **print** the `translation_status` if translation_requests found.
@@ -64,6 +64,19 @@ create_csv_translation_request(
 ) 
 ```
 
+### 🔝rebase_csv_translation_request
+Rebase a translation request entry inside the CSV file. It will append a new row top of target branch in CSV file and then git commit the CSV file changes.
+
+``` ruby
+rebase_csv_translation_request(
+  repository_name: "crazymanish/example-csv-repo", # Specify the CSV git file repo
+  branch_name: "master", #Specify the target branch (default: master)
+  feature_branch_name: "some_feature_branch",  #Specify the feature branch name
+  file_path: "example.csv",  # Specify the CSV file path under the git repo
+  identifier: "PRJ-3030"  # Specify the CSV row identifier
+) 
+```
+
 ### ✂️ delete_csv_translation_request
 Delete a new translation request entry from the CSV file based on CSV row Identifier. It will delete the matched row from the CSV file and then git commit the CSV file changes.
 

data/lib/fastlane/plugin/csv_translation/actions/create_csv_translation_request.rb

@@ -19,14 +19,25 @@ module Fastlane
         csv_file_path = "#{csv_file_folder}/#{params[:file_path]}"
         csv_payload = params[:payload]
 
+        # add missing newline if not present, at the end of the file
+        File.open(csv_file_path, "r+") do |csv|
+          csv.seek(-1, 2)
+
+          if csv.read(1) != "\n"
+            csv.write("\n")
+            csv.seek(0)
+          end
+        end
+
         # adding new entry into csv file
         require 'csv'
-        CSV.open(csv_file_path, 'a+', headers: csv_payload.keys) do |csv|
-          csv << csv_payload.values
+        headers = CSV.open(csv_file_path, &:readline)
+        CSV.open(csv_file_path, 'a', headers: headers, force_quotes: true) do |csv|
+          csv << csv_payload
         end
 
         # creating csv translation request
-        git_message = "New translation request: #{csv_payload}"
+        git_message = "New translation request:\n#{csv_payload}"
         git_commit_info = ""
         Dir.chdir(csv_file_folder) do
           GitCommitAction.run(path: ".", message: git_message)
@@ -92,12 +103,12 @@ module Fastlane
           'create_csv_translation_request(
             repository_name: "fastlane/fastlane",
             file_path: "translation/some_csv_name.csv",
-            payload: {header_name: "some_value"})',
+            payload: {"header_name" => "some_value"})',
           'create_csv_translation_request(
             repository_name: "fastlane/fastlane",
             branch_name: "master",
             file_path: "translation/some_csv_name.csv",
-            payload: {header_name: "some_value"})'
+            payload: {"header_name" => "some_value"})'
         ]
       end
 

data/lib/fastlane/plugin/csv_translation/actions/delete_csv_translation_request.rb

@@ -26,7 +26,7 @@ module Fastlane
         translation_requests = CSV.table(csv_file_path, headers: true)
         translation_requests.delete_if { |row| row.map { |value| value.to_s }.join("").include?(csv_row_identifier) }
 
-        CSV.open(csv_file_path, "w", write_headers: true, headers: headers) do |csv|
+        CSV.open(csv_file_path, "w", write_headers: true, headers: headers, force_quotes: true) do |csv|
           translation_requests.each { |translation_request| csv << translation_request }
         end
 
@@ -40,14 +40,14 @@ module Fastlane
           # log message if translation request not found.
           if is_git_status_clean
             UI.important("Please check \"#{csv_row_identifier}\", not found the translation request. ⁉️")
-          end
-
-          git_message = "Deleted translation request: identifier: #{csv_row_identifier}"
-          GitCommitAction.run(path: ".", message: git_message)
-          PushToGitRemoteAction.run(remote: "origin")
-          git_commit_info = Actions.last_git_commit_dict
+          else
+            git_message = "Deleted translation request: identifier: #{csv_row_identifier}"
+            GitCommitAction.run(path: ".", message: git_message)
+            PushToGitRemoteAction.run(remote: "origin")
+            git_commit_info = Actions.last_git_commit_dict
 
-          UI.success("Successfully #{git_message} 🚀")
+            UI.success("Successfully #{git_message} 🚀")
+          end
         end
 
         # building deleted translation request info

data/lib/fastlane/plugin/csv_translation/actions/rebase_csv_translation_request.rb

@@ -0,0 +1,134 @@
+require 'fastlane/action'
+require_relative '../helper/csv_translation_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      REBASE_CSV_TRANSLATION_REQUEST_INFO = :REBASE_CSV_TRANSLATION_REQUEST_INFO
+    end
+
+    class RebaseCsvTranslationRequestAction < Action
+      def self.run(params)
+        # fetching csv file
+        csv_file_folder = Helper::CsvTranslationHelper.fetch_csv_file(
+          repository_name: params[:repository_name],
+          branch_name: params[:feature_branch_name]
+        )
+
+        csv_file_path = "#{csv_file_folder}/#{params[:file_path]}"
+        csv_row_identifier = params[:identifier]
+
+        require 'csv'
+
+        # picking translation request-identifier entry from the feature_branch csv file
+        feature_branch_translation_requests = CSV.table(csv_file_path, headers: true)
+        feature_branch_translation_requests = feature_branch_translation_requests.select { |row| row.map { |value| value.to_s }.join("").include?(csv_row_identifier) }
+
+        # rebasing CSV file
+        git_commit_info = {}
+        Dir.chdir(csv_file_folder) do
+          # Step1: Checkout the target branch csv file
+          sh("git fetch --all")
+          sh("git checkout #{params[:branch_name]} -- #{params[:file_path]}")
+
+          # Step2: Commit csv file so rebase can be performed
+          git_message = "Rebase translation request: identifier:\n#{csv_row_identifier}"
+          GitCommitAction.run(path: ".", message: git_message)
+
+          # Step3: Perfoms rebasing, take all changes from target branch
+          sh("git rebase -X theirs " + params[:branch_name])
+
+          # Step4: Add missing newline if not present, at the end of the file
+          Helper::CsvTranslationHelper.append_missing_eof(csv_file_path)
+
+          # Step5: Append back feature branch translation_requests
+          all_translation_requests = CSV.table(csv_file_path, headers: true)
+          all_translation_requests.delete_if { |row| row.map { |value| value.to_s }.join("").include?(csv_row_identifier) }
+
+          headers = CSV.open(csv_file_path, &:readline)
+          CSV.open(csv_file_path, "w", write_headers: true, headers: headers, force_quotes: true) do |csv|
+            all_translation_requests.each { |translation_request| csv << translation_request }
+            feature_branch_translation_requests.each { |translation_request| csv << translation_request }
+          end
+
+          # Step6: Commit and push to remote
+          GitCommitAction.run(path: ".", message: git_message)
+          PushToGitRemoteAction.run(remote: "origin", force: true)
+
+          git_commit_info = Actions.last_git_commit_dict
+          UI.success("Successfully #{git_message} 🚀")
+        end
+
+        # building deleted translation request info
+        rebase_translation_request_info = {
+          identifier: csv_row_identifier,
+          git_commit_info: git_commit_info}
+
+        Actions.lane_context[SharedValues::REBASE_CSV_TRANSLATION_REQUEST_INFO] = rebase_translation_request_info
+        return rebase_translation_request_info
+      end
+
+      def self.description
+        "Rebase a translation request based on identifier value."
+      end
+
+      def self.output
+        [
+          ['REBASE_CSV_TRANSLATION_REQUEST_INFO', 'Rebased translation request info i.e identifier, git_commit info']
+        ]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :repository_name,
+                                       env_name: "FL_REBASE_CSV_TRANSLATION_REQUEST_REPOSITORY_NAME",
+                                       description: "The name to your repository, e.g. 'fastlane/fastlane'",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No repository_name given in input param") unless (value and not value.empty?)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :branch_name,
+                                       env_name: "FL_REBASE_CSV_TRANSLATION_REQUEST_BRANCH_NAME",
+                                       description: "The branch name to your repository, (default master)",
+                                       is_string: true,
+                                       default_value: "master"),
+          FastlaneCore::ConfigItem.new(key: :feature_branch_name,
+                                       env_name: "FL_REBASE_CSV_TRANSLATION_REQUEST_FEATURE_BRANCH_NAME",
+                                       description: "The feature branch name for new translation request (Useful if no direct commit allowed in master)",
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :file_path,
+                                       env_name: "FL_REBASE_CSV_TRANSLATION_REQUEST_FILE_PATH",
+                                       description: "The file path to your csv file",
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :identifier,
+                                       env_name: "FL_REBASE_CSV_TRANSLATION_REQUEST_IDENTIFIER",
+                                       description: "An identifier value of the CSV file row",
+                                       is_string: true)
+        ]
+      end
+
+      def self.authors
+        ["crazymanish"]
+      end
+
+      def self.example_code
+        [
+          'rebase_csv_translation_request(
+            repository_name: "fastlane/fastlane",
+            feature_branch_name: "some_feature_branch",
+            file_path: "translation/some_csv_name.csv",
+            identifier: "some_identifier_value")',
+          'rebase_csv_translation_request(
+            repository_name: "fastlane/fastlane",
+            branch_name: "master",
+            feature_branch_name: "some_feature_branch",
+            file_path: "translation/some_csv_name.csv",
+            identifier: "some_identifier_value")'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/csv_translation/helper/csv_translation_helper.rb

@@ -6,12 +6,12 @@ module Fastlane
   module Helper
     class CsvTranslationHelper
 
-      def self.csv_file_folder_name
+      def self.csv_file_directory_name
         return ".fl_clone_csv_file"
       end
 
-      def self.csv_file_folder_path
-        return File.join(Dir.pwd, self.csv_file_folder_name)
+      def self.csv_file_directory_path
+        return File.join(Dir.pwd, self.csv_file_directory_name)
       end
 
       def self.fetch_csv_file(params)
@@ -19,22 +19,20 @@ module Fastlane
         branch_name = params[:branch_name]
 
         # Setup csv_file folder for fresh git clone.
-        git_clone_folder = self.csv_file_folder_path
+        git_clone_folder = self.csv_file_directory_path
         FileUtils.rm_rf(git_clone_folder) if File.directory?(git_clone_folder)
-        Dir.mkdir(self.csv_file_folder_name)
+        Dir.mkdir(self.csv_file_directory_name)
 
         UI.success("Fetching csv file from git repo... ⏳")
-        branch_option = "--branch #{branch_name}" if branch_name != 'HEAD'
         git_url = "git@github.com:#{repository_name}"
-        Fastlane::Actions::sh("git clone #{git_url.shellescape} #{git_clone_folder.shellescape} --depth 1 -n #{branch_option}")
+        Fastlane::Actions::sh("git clone #{git_url.shellescape} #{git_clone_folder.shellescape}")
         Fastlane::Actions::sh("cd #{git_clone_folder.shellescape} && git checkout #{branch_name}")
 
         return git_clone_folder
       end
 
       def self.create_feature_branch(params)
-        self.fetch_csv_file(params)
-        git_clone_folder = self.csv_file_folder_path
+        git_clone_folder = self.fetch_csv_file(params)
 
         # creating and checkout new branch
         branch_name = params[:feature_branch_name]
@@ -46,6 +44,18 @@ module Fastlane
         return git_clone_folder
       end
 
+      # add missing newline if not present, at the end of the file
+      def self.append_missing_eof(file_path)
+        File.open(file_path, "r+") do |file|
+          file.seek(-1, 2)
+
+          if file.read(1) != "\n"
+            file.write("\n")
+            file.seek(0)
+          end
+        end
+      end
+
     end
   end
 end

data/lib/fastlane/plugin/csv_translation/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module CsvTranslation
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-csv_translation
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Manish Rathi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -148,6 +148,7 @@ files:
 - lib/fastlane/plugin/csv_translation/actions/create_csv_translation_request.rb
 - lib/fastlane/plugin/csv_translation/actions/delete_csv_translation_request.rb
 - lib/fastlane/plugin/csv_translation/actions/get_csv_translation_requests.rb
+- lib/fastlane/plugin/csv_translation/actions/rebase_csv_translation_request.rb
 - lib/fastlane/plugin/csv_translation/helper/csv_translation_helper.rb
 - lib/fastlane/plugin/csv_translation/version.rb
 homepage: https://github.com/crazymanish/fastlane-plugin-csv_translation