fastlane-plugin-android_version_manage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7e055cfc05190b5135e5356a61e60043627837d7e37e5d26633ace778a42431
+  data.tar.gz: 7e02f33629a878bd011fac093cbcbf1c0ede553f60427ed73247696c83989b78
+SHA512:
+  metadata.gz: a6dcb9f97584cf9a739000a821aed9721ee20520bdabc665cbce5227db9c0ed60da1545474d7bf2979db7ca4fc7f1133c0980ffd19ade5970dd5235698b206f1
+  data.tar.gz: 9c5bda30eeee22b3616505ecc63b6e9e646650279e66d91d2e1dc544462d14f37d76f7738324f3faa7128a05ac1c97cf23cd5a3e8ce47e0ec13fca376cb9f37e

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 futabooo <takahiro.futagawa@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# android_version_manage plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-android_version_manage)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-android_version_manage`, add it to your project by running:
+
+```bash
+fastlane add_plugin android_version_manage
+```
+
+## About android_version_manage
+
+Manage Android App Versioning
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/android_version_manage.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/android_version_manage/version'
+
+module Fastlane
+  module AndroidVersionManage
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::AndroidVersionManage.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/android_version_manage/actions/android_commit_version_bump.rb

@@ -0,0 +1,138 @@
+module Fastlane
+  module Actions
+    class AndroidCommitVersionBumpAction < Action
+      def self.run(params)
+        require 'pathname'
+        require 'set'
+        require 'shellwords'
+
+        gradle_file_path = File.expand_path(params[:gradle_file]).shellescape
+
+        # create our list of files that we expect to have changed, they should all be relative to the project root, which should be equal to the git workdir root
+        expected_changed_files = []
+        expected_changed_files << gradle_file_path
+
+        # get the list of files that have actually changed in our git workdir
+        git_dirty_files = Actions.sh("git -C #{repo_path} diff --name-only HEAD").split("\n") + Actions.sh("git -C #{repo_path} ls-files --other --exclude-standard").split("\n")
+        if git_dirty_files.empty?
+          UI.user_error!("No file changes picked up. Make sure you run the `increment_version_code` action first.")
+        end
+
+        # check if the files changed are the ones we expected to change (these should be only the files that have version info in them)
+        changed_files_as_expected = Set.new(git_dirty_files.map(&:downcase)).subset?(Set.new(expected_changed_files.map(&:downcase)))
+
+        unless changed_files_as_expected
+          unless params[:force]
+            error = [
+              "Found unexpected uncommited changes in the working directory. Expected these files to have ",
+              "changed: \n#{expected_changed_files.join("\n")}.\nBut found these actual changes: ",
+              "#{git_dirty_files.join("\n")}.\nMake sure you have cleaned up the build artifacts and ",
+              "are only left with the changed version files at this stage in your lane, and don't touch the ",
+              "working directory while your lane is running. You can also use the :force option to bypass this ",
+              "check, and always commit a version bump regardless of the state of the working directory."
+            ].join("\n")
+            UI.user_error!(error)
+          end
+        end
+
+        # get the absolute paths to the files
+        git_add_paths = expected_changed_files.map do |path|
+          updated = path
+          updated.replace(updated.sub(repo_pathname.to_s, "./")) # .gsub(repo_pathname, ".")
+          puts(" -- updated = #{updated}".yellow)
+          File.expand_path(File.join(repo_pathname, updated))
+        end
+
+        # then create a commit with a message
+        command_add = build_git_command_add(repo_path, git_add_paths.map(&:shellescape).join(' '))
+        Actions.sh(command_add)
+
+        begin
+          command_commit = build_git_command(params, repo_path)
+          Actions.sh(command_commit)
+          UI.success("Committed \"#{params[:message]}\" 💾.")
+        rescue => ex
+          UI.error(ex)
+          UI.important("Didn't commit any changes.")
+        end
+      end
+
+      def self.description
+        "This action is like a commit_version_bump action for Android"
+      end
+
+      def self.authors
+        ["futabooo"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :gradle_file,
+                                       env_name: "FL_ANDROID_COMMIT_VERSION_BUMP_GRADLE_FILE",
+                                       description: "(optional) Specify the path to your app build.gradle if it isn't in the default location",
+                                       optional: true,
+                                       type: String,
+                                       default_value: "app/build.gradle"),
+          FastlaneCore::ConfigItem.new(key: :message,
+                                       env_name: "FL_ANDROID_COMMIT_VERSION_BUMP_COMMIT_MESSAGE",
+                                       description: "(optional) The commit message when committing the version bump",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :force,
+                                       env_name: "FL_ANDROID_COMMIT_VERSION_BUMP_FORCE_COMMIT",
+                                       description: "(optional) Forces the commit, even if other files than the ones containing the version number have been modified",
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :no_verify,
+                                       env_name: "FL_ANDROID_COMMIT_VERSION_BUMP_GIT_PUSH_USE_NO_VERIFY",
+                                       description: "Whether or not to use --no-verify",
+                                       type: Boolean,
+                                       default_value: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+
+      class << self
+        def build_git_command_add(repo_path, paths)
+          command = ['git',
+                     '-C',
+                     "'#{repo_path}'",
+                     'add',
+                     "'#{paths}'"]
+
+          return command.join(' ')
+        end
+
+        def build_git_command_commit(params, repo_path)
+          version_code = Actions.lane_context[SharedValues::ANDROID_NEW_VERSION_CODE]
+
+          params[:message] ||= (version_code ? "Version Bump to #{version_code}" : "Version Bump")
+
+          command = [
+            'git',
+            '-C',
+            "'#{repo_path}'",
+            'commit',
+            '-m',
+            "'#{params[:message]}'"
+          ]
+
+          command << '--no-verify' if params[:no_verify]
+
+          return command.join(' ')
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/android_version_manage/actions/android_set_version_code.rb

@@ -0,0 +1,76 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      ANDROID_NEW_VERSION_CODE = :ANDROID_NEW_VERSION_CODE
+    end
+
+    class AndroidSetVersionCodeAction < Action
+      def self.run(params)
+        gradle_file_path = Helper::AndroidVersionManageHelper.get_gradle_file_path(params[:gradle_file])
+        new_version_code = Helper::AndroidVersionManageHelper.get_new_version_code(gradle_file_path, params[:version_code])
+
+        UI.message(gradle_file_path)
+
+        saved = Helper::AndroidVersionManageHelper.save_key_to_gradle_file(gradle_file_path, "versionCode", new_version_code)
+
+        if saved == -1
+          UI.user_error!("Unable to set the Version Code #{gradle_file_path}.")
+        end
+
+        UI.success("☝️ Android Version Code has been set to: #{new_version_code}")
+
+        # Store the Version Code in the shared hash
+        Actions.lane_context[SharedValues::ANDROID_NEW_VERSION_CODE] = new_version_code
+      end
+
+      def self.description
+        "Set the Version Code of your Android project"
+      end
+
+      def self.authors
+        ["futabooo"]
+      end
+
+      def self.output
+        [
+          ['ANDROID_NEW_VERSION_CODE', 'The new Version Code of Android project']
+        ]
+      end
+
+      def self.return_value
+        "The new Version Code of your Android project"
+      end
+
+      def self.details
+        [
+          "This action will set the new Version Code on your Android project.",
+          "Without specifying new Version Code, current one will be incremented"
+        ].join(' ')
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :gradle_file,
+                                       env_name: "FL_ANDROID_VERSION_MANAGE_GRADLE_FILE",
+                                       description: "(optional) Specify the path to your app build.gradle if it isn't in the default location",
+                                       optional: true,
+                                       type: String,
+                                       default_value: "app/build.gradle.kts",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Could not find #{value} file") unless File.exist?(value) || Helper.test?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :version_code,
+                                       env_name: "FL_ANDROID_VERSION_MANAGE_VERSION_CODE",
+                                       description: "(optional) Set specific Version Code",
+                                       optional: true,
+                                       type: Integer,
+                                       default_value: nil)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/android_version_manage/actions/android_set_version_name.rb

@@ -0,0 +1,77 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      ANDROID_NEW_VERSION_NAME = :ANDROID_NEW_VERSION_NAME
+    end
+
+    class AndroidSetVersionNameAction < Action
+      def self.run(params)
+        gradle_file_path = Helper::AndroidVersionManageHelper.get_gradle_file_path(params[:gradle_file])
+        new_version_name = Helper::AndroidVersionManageHelper.get_new_version_name(gradle_file_path, params[:version_name], params[:bump_type])
+
+        saved = Helper::AndroidVersionManageHelper.save_key_to_gradle_file(gradle_file_path, "versionName", new_version_name)
+
+        if saved == -1
+          UI.user_error!("Unable to set the Version Name in #{gradle_file_path}.")
+        end
+
+        UI.success("☝️  Android Version Name has been set to: #{new_version_name}")
+
+        # Store the versionName in the shared hash
+        Actions.lane_context[SharedValues::ANDROID_NEW_VERSION_NAME] = new_version_name
+      end
+
+      def self.description
+        "Set the Version Name of your Android project"
+      end
+
+      def self.details
+        "This action will set the new Version Name on your Android project."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :gradle_file,
+                                       env_name: "FL_ANDROID_SET_VERSION_NAME_GRADLE_FILE",
+                                       description: "(optional) Specify the path to your app build.gradle if it isn't in the default location",
+                                       optional: true,
+                                       type: String,
+                                       default_value: "app/build.gradle.kts",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Could not find #{value} file") unless File.exist?(value) || Helper.test?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :version_name,
+                                       env_name: "FL_ANDROID_SET_VERSION_NAME_VERSION_NAME",
+                                       description: "(optional) Set specific Version Name",
+                                       optional: true,
+                                       type: String,
+                                       default_value: nil),
+          FastlaneCore::ConfigItem.new(key: :bump_type,
+                                       env_name: "FL_ANDROID_SET_VERSION_NAME_BUMP_TYPE",
+                                       description: "(optional) Type of version bump (major, minor, patch)",
+                                       optional: true,
+                                       type: String,
+                                       default_value: nil)
+        ]
+      end
+
+      def self.output
+        [
+          ['ANDROID_NEW_VERSION_NAME', 'The new Version Name of your Android project']
+        ]
+      end
+
+      def self.return_value
+        "The new Version Name of your Android project"
+      end
+
+      def self.authors
+        ["futabooo"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/android_version_manage/helper/android_version_manage_helper.rb

@@ -0,0 +1,92 @@
+module Fastlane
+  module Helper
+    class AndroidVersionManageHelper
+      require "tempfile"
+      require "fileutils"
+
+      GRADLE_FILE_TEST = "/tmp/fastlane/tests/android-version-manage/app/build.gradle.kts"
+
+      def self.get_gradle_file(gradle_file)
+        return Helper.test? ? GRADLE_FILE_TEST : gradle_file
+      end
+
+      def self.get_gradle_file_path(gradle_file)
+        gradle_file = self.get_gradle_file(gradle_file)
+        return File.expand_path(gradle_file).shellescape
+      end
+
+      def self.get_new_version_code(gradle_file, new_version_code)
+        if new_version_code.nil?
+          current_version_code = self.read_key_from_gradle_file(gradle_file, "versionCode")
+          new_version_code = current_version_code.to_i + 1
+        end
+
+        return new_version_code.to_i
+      end
+
+      def self.get_new_version_name(gradle_file, new_version_name, bump_type)
+        if new_version_name.nil?
+          current_version_name = self.read_key_from_gradle_file(gradle_file, "versionName")
+          current_version_parts = current_version_name.split(/[.]/)
+
+          major = current_version_parts[0].to_i
+          minor = current_version_parts[1].to_i
+          patch = current_version_parts[2].to_i
+
+          if bump_type == "major"
+            new_version_name = "#{major + 1}.0.0"
+          elsif bump_type == "minor"
+            new_version_name = "#{major}.#{minor + 1}.0"
+          elsif bump_type == "patch"
+            new_version_name = "#{major}.#{minor}.#{patch + 1}"
+          end
+        end
+
+        return new_version_name.to_s
+      end
+
+      def self.read_key_from_gradle_file(gradle_file, key)
+        value = false
+        begin
+          file = File.new(gradle_file, "r")
+          while (line = file.gets)
+            next unless line.include?(key)
+            components = line.strip.split(' ')
+            value = components[components.length - 1].tr("\"", "")
+            break
+          end
+          file.close
+        rescue => err
+          UI.error("An exception occured while reading gradle file: #{err}")
+          err
+        end
+        return value
+      end
+
+      def self.save_key_to_gradle_file(gradle_file, key, value)
+        current_value = self.read_key_from_gradle_file(gradle_file, key)
+
+        begin
+          found = false
+          temp_file = Tempfile.new("flSave_#{key}_ToGradleFile")
+          File.open(gradle_file, "r") do |file|
+            file.each_line do |line|
+              if line.include?(key) && found == false
+                found = true
+                line.replace(line.sub(current_value.to_s, value.to_s))
+              end
+              temp_file.puts(line)
+            end
+            file.close
+          end
+          temp_file.rewind
+          temp_file.close
+          FileUtils.mv(temp_file.path, gradle_file)
+          temp_file.unlink
+        end
+
+        return found == true ? value : -1
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module AndroidVersionManage
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-android_version_manage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- futabooo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.134.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.134.0
+description: 
+email: takahiro.futagawa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/android_version_manage.rb
+- lib/fastlane/plugin/android_version_manage/actions/android_commit_version_bump.rb
+- lib/fastlane/plugin/android_version_manage/actions/android_set_version_code.rb
+- lib/fastlane/plugin/android_version_manage/actions/android_set_version_name.rb
+- lib/fastlane/plugin/android_version_manage/helper/android_version_manage_helper.rb
+- lib/fastlane/plugin/android_version_manage/version.rb
+homepage: https://github.com/futabooo/fastlane-plugin-android_version_manage
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Manage Android App Versioning
+test_files: []