fastlane-plugin-versioning_android 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15bae969f46be3a8a3e83bd25718d261ab19fdbf
+  data.tar.gz: 4c8ded404085de387760b4aaf047f57509965b44
+SHA512:
+  metadata.gz: 000f1388360a17d8f631cca27e65a9e112967e3b9270ca96a1ae52cdd5f1c2bfb6d2c7315d675a635e607cb0ca36c962d97af49d9e07578535b77e6a7a007887
+  data.tar.gz: 3a40ecde89768df83e6cc141b57962784f16375812ad3a968d4aba452b40795fcdf70fbd86c31f14a9f295c80f0e9a3412c099571bbd356a842d8235a5e132ed

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Igor Lamos <igor@be.plus>
+
+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,56 @@
+# versioning_android plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-versioning_android)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-versioning_android`, add it to your project by running:
+
+```bash
+fastlane add_plugin versioning_android
+```
+
+## About versioning_android
+
+Android Versioning Plugin for Fastlane
+
+### Available actions
+- `android_get_version_code` to get the Version Code
+- `android_get_version_name` to get the Version Name
+- `android_set_version_code` to set the new Version Code
+- `android_set_version_name` to set the new Version Name
+
+## 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`.
+
+You can find a fully functional setup of this plugin in the [UdemyFastlane](https://github.com/igorlamos/udemy-fastlane) repo, where you can also find more info about versioning of Android apps.
+
+## 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/versioning_android.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/versioning_android/version'
+
+module Fastlane
+  module VersioningAndroid
+    # 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::VersioningAndroid.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/versioning_android/actions/android_get_version_code.rb

@@ -0,0 +1,70 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      ANDROID_VERSION_CODE = :ANDROID_VERSION_CODE
+    end
+
+    class AndroidGetVersionCodeAction < Action
+      def self.run(params)
+        gradle_file_path = Helper::VersioningAndroidHelper.get_gradle_file_path(params[:gradle_file])
+        version_code = Helper::VersioningAndroidHelper.read_key_from_gradle_file(gradle_file_path, "versionCode")
+
+        if version_code == false
+          UI.user_error!("Unable to find the versionCode in build.gradle file at #{gradle_file_path}.")
+        end
+
+        UI.success("👍  Current Android Version Code is: #{version_code}")
+
+        # Store the Version Code in the shared hash
+        Actions.lane_context[SharedValues::ANDROID_VERSION_CODE] = version_code
+      end
+
+      def self.description
+        "Get the Version Code of your Android project"
+      end
+
+      def self.details
+        "This action will return current Version Code of your Android project."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :gradle_file,
+                                  env_name: "FL_ANDROID_GET_VERSION_CODE_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",
+                              verify_block: proc do |value|
+                                UI.user_error!("Could not find app build.gradle file") unless File.exist?(value) || Helper.test?
+                              end)
+        ]
+      end
+
+      def self.output
+        [
+          ['ANDROID_VERSION_CODE', 'The Version Code of your Android project']
+        ]
+      end
+
+      def self.return_value
+        "The Version Code of your Android project"
+      end
+
+      def self.authors
+        ["Igor Lamoš"]
+      end
+
+      def self.is_supported?(platform)
+        [:android].include?(platform)
+      end
+
+      def self.example_code
+        [
+          'version_code = android_get_version_code # build.gradle is in the default location',
+          'version_code = android_get_version_code(gradle_file: "/path/to/build.gradle")'
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/versioning_android/actions/android_get_version_name.rb

@@ -0,0 +1,70 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      ANDROID_VERSION_NAME = :ANDROID_VERSION_NAME
+    end
+
+    class AndroidGetVersionNameAction < Action
+      def self.run(params)
+        gradle_file_path = Helper::VersioningAndroidHelper.get_gradle_file_path(params[:gradle_file])
+        version_name = Helper::VersioningAndroidHelper.read_key_from_gradle_file(gradle_file_path, "versionName")
+
+        if version_name == false
+          UI.user_error!("Unable to find the versionName in build.gradle file at #{gradle_file_path}.")
+        end
+
+        UI.success("👍  Current Android Version Name is: #{version_name}")
+
+        # Store the Version Name in the shared hash
+        Actions.lane_context[SharedValues::ANDROID_VERSION_NAME] = version_name
+      end
+
+      def self.description
+        "Get the Version Name of your Android project"
+      end
+
+      def self.details
+        "This action will return current Version Name of your Android project."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :gradle_file,
+                                  env_name: "FL_ANDROID_GET_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",
+                              verify_block: proc do |value|
+                                UI.user_error!("Could not find app build.gradle file") unless File.exist?(value) || Helper.test?
+                              end)
+        ]
+      end
+
+      def self.output
+        [
+          ['ANDROID_VERSION_NAME', 'The Version Name of your Android project']
+        ]
+      end
+
+      def self.return_value
+        "The Version Name of your Android project"
+      end
+
+      def self.authors
+        ["Igor Lamoš"]
+      end
+
+      def self.is_supported?(platform)
+        [:android].include?(platform)
+      end
+
+      def self.example_code
+        [
+          'version_name = android_get_version_name # build.gradle is in the default location',
+          'version_name = android_get_version_name(gradle_file: "/path/to/build.gradle")'
+        ]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+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::VersioningAndroidHelper.get_gradle_file_path(params[:gradle_file])
+        new_version_code = Helper::VersioningAndroidHelper.get_new_version_code(gradle_file_path, params[:version_code])
+
+        saved = Helper::VersioningAndroidHelper.save_key_to_gradle_file(gradle_file_path, "versionCode", new_version_code)
+
+        if saved == -1
+          UI.user_error!("Unable to set the Version Code in build.gradle file at #{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.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_SET_VERSION_CODE_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",
+                              verify_block: proc do |value|
+                                UI.user_error!("Could not find app build.gradle file") unless File.exist?(value) || Helper.test?
+                              end),
+          FastlaneCore::ConfigItem.new(key: :version_code,
+                                  env_name: "FL_ANDROID_SET_VERSION_CODE_VERSION_CODE",
+                               description: "(optional) Set specific Version Code",
+                                  optional: true,
+                                      type: Integer,
+                             default_value: nil)
+        ]
+      end
+
+      def self.output
+        [
+          ['ANDROID_NEW_VERSION_CODE', 'The new Version Code of your Android project']
+        ]
+      end
+
+      def self.return_value
+        "The new Version Code of your Android project"
+      end
+
+      def self.authors
+        ["Igor Lamoš"]
+      end
+
+      def self.is_supported?(platform)
+        [:android].include? platform
+      end
+
+      def self.example_code
+        [
+          'android_set_version_code # Automatically increment by one',
+          'android_set_version_code(
+            version_code: "17" # Set a specific number
+          )',
+          'android_set_version_code(
+            version_code: "17",
+            gradle_file: "/path/to/build.gradle" # build.gradle is not in the default location
+          )',
+          'version_code = android_set_version_code # Save returned Version Code to a variable'
+        ]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+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::VersioningAndroidHelper.get_gradle_file_path(params[:gradle_file])
+        new_version_name = Helper::VersioningAndroidHelper.get_new_version_name(gradle_file_path, params[:version_name])
+        # bump_type ||= params[:bump_type]
+
+        saved = Helper::VersioningAndroidHelper.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 build.gradle file at #{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",
+                              verify_block: proc do |value|
+                                UI.user_error!("Could not find app build.gradle 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
+        ["Igor Lamoš"]
+      end
+
+      def self.is_supported?(platform)
+        [:android].include? platform
+      end
+
+      def self.example_code
+        [
+          'android_set_version_name(
+            version_name: "2.34.5" # Set a specific number
+          )',
+          'android_set_version_name(
+            version_name: "2.34.5",
+            gradle_file: "/path/to/build.gradle" # build.gradle is not in the default location
+          )'
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/versioning_android/helper/versioning_android_helper.rb

@@ -0,0 +1,93 @@
+module Fastlane
+  module Helper
+    class VersioningAndroidHelper
+      require "shellwords"
+      require "tempfile"
+      require "fileutils"
+
+      GRADLE_FILE_TEST = "/tmp/fastlane/tests/versioning/app/build.gradle"
+
+      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 = nil)
+        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 and 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/versioning_android/version.rb

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

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-versioning_android
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Lamos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-21 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: 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.66.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.66.0
+description: 
+email: igor@be.plus
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/versioning_android.rb
+- lib/fastlane/plugin/versioning_android/actions/android_get_version_code.rb
+- lib/fastlane/plugin/versioning_android/actions/android_get_version_name.rb
+- lib/fastlane/plugin/versioning_android/actions/android_set_version_code.rb
+- lib/fastlane/plugin/versioning_android/actions/android_set_version_name.rb
+- lib/fastlane/plugin/versioning_android/helper/versioning_android_helper.rb
+- lib/fastlane/plugin/versioning_android/version.rb
+homepage: https://github.com/beplus/fastlane-plugin-versioning_android
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Android Versioning Plugin for Fastlane
+test_files: []