fastlane-plugin-csv_translation 0.4.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0f16b7ee0ca379dd5ea0519771ff45f609c567715fc10e6245175a9dde17571
-  data.tar.gz: 4735dd08f4a574bf92d820937a51131a7ea73525801e507ae67bf20f37e01b48
+  metadata.gz: 5a79a9e06809c88e824a6d9da65409418b31f66d113b3bd80fc5d1eb7d1c51e1
+  data.tar.gz: 15049ca17c4f1b44c0ad2ef4ff0e3550748a8e4b34772917a6ef53cf9b70f7ae
 SHA512:
-  metadata.gz: 82be092d741b44d89dbbc1bf0b476575f4a0decb18c3f12583c87904c0de618f18a3d61af94a033099e516fee67ef55d9e06945446c1ed62adfba86acf122e65
-  data.tar.gz: 423d5e8a753a5aeb1ccd4a80ecab0e71ed98f2a9b45696c69ab43bf530ff619ffc973bcfe06e24df0a58151efb0e7652f715970a1a15bc812591ffad3ce20f79
+  metadata.gz: 85f22b21beeb5ce6e453eac34a00d2079cba1a47595a666b520dd77f36637de20667271b2dd4122e77c8090e68fb1f52d2b8fc18a181c13940dcd6b9c1529bce
+  data.tar.gz: d7972e07d8789b8336123e80f04c9ceb6d55ee7101dbe8e97db387d1714a84c3d916c6e0de14c924a88c399d7513094a5f77cb9fd91a85afa7add365c23b7f07

data/README.md

@@ -55,7 +55,7 @@ get_csv_translation_requests(
 Add a new translation request entry inside the CSV file. It will append a new row in CSV file and then git commit the CSV file changes.
 
 ``` ruby
-example_csv_payload = {Ticket: "PRJ-3030", Timeline: "30 April"}
+example_csv_payload = { "Ticket" => "PRJ-3030", "Timeline" => "30 April" }
 
 create_csv_translation_request(
   repository_name: "crazymanish/example-csv-repo", # Specify the CSV git file repo
@@ -65,7 +65,7 @@ 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.
+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. Very useful in case of resolving conflicts. 
 
 ``` ruby
 rebase_csv_translation_request(

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

@@ -0,0 +1,75 @@
+require 'fastlane/action'
+require_relative '../helper/csv_translation_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CREATE_CSV_FEATURE_BRANCH_INFO = :CREATE_CSV_FEATURE_BRANCH_INFO
+    end
+
+    class CreateCsvFeatureBranchAction < Action
+      def self.run(params)
+        # fetching csv file
+        csv_file_folder = Helper::CsvTranslationHelper.create_feature_branch(
+          repository_name: params[:repository_name],
+          branch_name: params[:branch_name],
+          feature_branch_name: params[:feature_branch_name]
+        )
+
+        Actions.lane_context[SharedValues::CREATE_CSV_FEATURE_BRANCH_INFO] = csv_file_folder
+        return csv_file_folder
+      end
+
+      def self.description
+        "Create a csv feature branch."
+      end
+
+      def self.output
+        [
+          ['CREATE_CSV_FEATURE_BRANCH_INFO', 'Created feature branch info']
+        ]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :repository_name,
+                                       env_name: "FL_CREATE_CSV_FEATURE_BRANCH_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_CREATE_CSV_BASE_BRANCH_NAME",
+                                       description: "The branch name to your repository, (default main)",
+                                       is_string: true,
+                                       default_value: "main"),
+          FastlaneCore::ConfigItem.new(key: :feature_branch_name,
+                                       env_name: "FL_CREATE_CSV_FEATURE_BRANCH_NAME",
+                                       description: "The feature branch name for new translation request (Useful if no direct commit allowed in main)",
+                                       is_string: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.authors
+        ["crazymanish"]
+      end
+
+      def self.example_code
+        [
+          'create_csv_feature_branch(
+            repository_name: "fastlane/fastlane",
+            feature_branch_name: "some_feature_branch_name")',
+          'create_csv_feature_branch(
+            repository_name: "fastlane/fastlane",
+            branch_name: "main",
+            feature_branch_name: "some_feature_branch_name")'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -20,14 +20,7 @@ module Fastlane
         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
+        Helper::CsvTranslationHelper.append_missing_eof(csv_file_path)
 
         # adding new entry into csv file
         require 'csv'
@@ -75,12 +68,12 @@ module Fastlane
                                        end),
           FastlaneCore::ConfigItem.new(key: :branch_name,
                                        env_name: "FL_CREATE_CSV_TRANSLATION_REQUEST_BRANCH_NAME",
-                                       description: "The branch name to your repository, (default master)",
+                                       description: "The branch name to your repository, (default main)",
                                        is_string: true,
-                                       default_value: "master"),
+                                       default_value: "main"),
           FastlaneCore::ConfigItem.new(key: :feature_branch_name,
                                        env_name: "FL_CREATE_CSV_TRANSLATION_REQUEST_FEATURE_BRANCH_NAME",
-                                       description: "The feature branch name for new translation request (Useful if no direct commit allowed in master)",
+                                       description: "The feature branch name for new translation request (Useful if no direct commit allowed in main)",
                                        is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :file_path,
@@ -106,7 +99,7 @@ module Fastlane
             payload: {"header_name" => "some_value"})',
           'create_csv_translation_request(
             repository_name: "fastlane/fastlane",
-            branch_name: "master",
+            branch_name: "main",
             file_path: "translation/some_csv_name.csv",
             payload: {"header_name" => "some_value"})'
         ]

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

@@ -79,12 +79,12 @@ module Fastlane
                                        end),
           FastlaneCore::ConfigItem.new(key: :branch_name,
                                        env_name: "FL_DELETE_CSV_TRANSLATION_REQUEST_BRANCH_NAME",
-                                       description: "The branch name to your repository, (default master)",
+                                       description: "The branch name to your repository, (default main)",
                                        is_string: true,
-                                       default_value: "master"),
+                                       default_value: "main"),
           FastlaneCore::ConfigItem.new(key: :feature_branch_name,
                                        env_name: "FL_DELETE_CSV_TRANSLATION_REQUEST_FEATURE_BRANCH_NAME",
-                                       description: "The feature branch name for new translation request (Useful if no direct commit allowed in master)",
+                                       description: "The feature branch name for new translation request (Useful if no direct commit allowed in main)",
                                        is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :file_path,
@@ -110,7 +110,7 @@ module Fastlane
             identifier: "some_identifier_value")',
           'delete_csv_translation_request(
             repository_name: "fastlane/fastlane",
-            branch_name: "master",
+            branch_name: "main",
             file_path: "translation/some_csv_name.csv",
             identifier: "some_identifier_value")'
         ]

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

@@ -0,0 +1,66 @@
+require 'fastlane/action'
+require_relative '../helper/csv_translation_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      FETCH_CSV_BRANCH_INFO = :FETCH_CSV_BRANCH_INFO
+    end
+
+    class FetchCsvBranchAction < Action
+      def self.run(params)
+        # fetching csv file
+        csv_file_folder = Helper::CsvTranslationHelper.fetch_csv_file(
+          repository_name: params[:repository_name],
+          branch_name: params[:branch_name]
+        )
+
+        Actions.lane_context[SharedValues::CREATE_CSV_FEATURE_BRANCH_INFO] = csv_file_folder
+        return csv_file_folder
+      end
+
+      def self.description
+        "Fetch a csv file branch."
+      end
+
+      def self.output
+        [
+          ['FETCH_CSV_BRANCH_INFO', 'Fetched CSV file branch info']
+        ]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :repository_name,
+                                       env_name: "FL_FETCH_CSV_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_FETCH_CSV_BRANCH_NAME",
+                                       description: "The branch name to your repository, (default main)",
+                                       is_string: true,
+                                       default_value: "main")
+        ]
+      end
+
+      def self.authors
+        ["crazymanish"]
+      end
+
+      def self.example_code
+        [
+          'fetch_csv_branch(repository_name: "fastlane/fastlane")',
+          'fetch_csv_branch(
+            repository_name: "fastlane/fastlane",
+            branch_name: "some_feature_branch_name")'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -66,9 +66,9 @@ module Fastlane
                                        end),
           FastlaneCore::ConfigItem.new(key: :branch_name,
                                        env_name: "FL_GET_CSV_TRANSLATION_REQUESTS_BRANCH_NAME",
-                                       description: "The branch name to your repository, (default master)",
+                                       description: "The branch name to your repository, (default main)",
                                        is_string: true,
-                                       default_value: "master"),
+                                       default_value: "main"),
           FastlaneCore::ConfigItem.new(key: :file_path,
                                        env_name: "FL_GET_CSV_TRANSLATION_REQUESTS_FILE_PATH",
                                        description: "The file path to your csv file",
@@ -104,7 +104,7 @@ module Fastlane
             file_path: "translation/some_csv_name.csv")',
           'get_csv_translation_requests(
             repository_name: "fastlane/fastlane",
-            branch_name: "master",
+            branch_name: "main",
             file_path: "translation/some_csv_name.csv")'
         ]
       end

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

@@ -17,12 +17,15 @@ module Fastlane
 
         csv_file_path = "#{csv_file_folder}/#{params[:file_path]}"
         csv_row_identifier = params[:identifier]
+        csv_row_identifier_header = params[:identifier_header]
 
         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) }
+        feature_branch_translation_requests = CSV.foreach(csv_file_path, headers: true).map { |row| row.to_h }
+        feature_branch_translation_requests = feature_branch_translation_requests.select do |translation_request|
+            translation_request[csv_row_identifier_header].eql?(csv_row_identifier)
+        end
 
         # rebasing CSV file
         git_commit_info = {}
@@ -31,32 +34,15 @@ module Fastlane
           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)
+          # Validate: Do we really need to perfoem `rebase` ?
+          repo_status = Actions::sh("git status --porcelain")
+          repo_clean = repo_status.empty?
 
-          # 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 }
+          if repo_clean
+            UI.important("Rebase is not required, CSV file is up to date! 💪")
+          else
+            git_commit_info = self.perform_rebase(params, csv_file_path, feature_branch_translation_requests)
           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
@@ -68,6 +54,36 @@ module Fastlane
         return rebase_translation_request_info
       end
 
+      def self.perform_rebase(params, csv_file_path, feature_branch_translation_requests)
+        csv_row_identifier = params[:identifier]
+
+        # 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)
+
+        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)
+
+        UI.success("Successfully #{git_message} 🚀")
+        Actions.last_git_commit_dict
+      end
+
       def self.description
         "Rebase a translation request based on identifier value."
       end
@@ -88,17 +104,23 @@ module Fastlane
                                        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)",
+                                       description: "The branch name to your repository, (default main)",
                                        is_string: true,
-                                       default_value: "master"),
+                                       default_value: "main"),
           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)",
+                                       description: "The feature branch name for new translation request (Useful if no direct commit allowed in main)",
                                        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_header,
+                                       env_name: "FL_REBASE_CSV_TRANSLATION_REQUEST_IDENTIFIER_HEADER",
+                                       description: "An identifier header(column name) of the CSV file",
+                                       is_string: true,
+                                       optional: true,
+                                       default_value: "Ticket"),
           FastlaneCore::ConfigItem.new(key: :identifier,
                                        env_name: "FL_REBASE_CSV_TRANSLATION_REQUEST_IDENTIFIER",
                                        description: "An identifier value of the CSV file row",
@@ -119,7 +141,7 @@ module Fastlane
             identifier: "some_identifier_value")',
           'rebase_csv_translation_request(
             repository_name: "fastlane/fastlane",
-            branch_name: "master",
+            branch_name: "main",
             feature_branch_name: "some_feature_branch",
             file_path: "translation/some_csv_name.csv",
             identifier: "some_identifier_value")'

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-csv_translation
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Manish Rathi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -145,8 +145,10 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane/plugin/csv_translation.rb
+- lib/fastlane/plugin/csv_translation/actions/create_csv_feature_branch.rb
 - 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/fetch_csv_branch.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
@@ -170,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: "A fastlane plugin to manage translation using a CSV file under git repository.