fastlane-plugin-flutter_versioner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35af839b7b1ec389092f33854ca32c634cd8321be82b187a2e26fc50e0b670d0
+  data.tar.gz: faf2a30fab6e9e5eb57f0be5e6023af38356cee9c99b1c6e2b9498cb9a9201a5
+SHA512:
+  metadata.gz: d3df3a6c5893dc86c2acc421ba23bacbe2b046a36dba7e1ec180829985048660433901eda8bdb4d613bed5ae465369c1e4fd1701c9a6f728be495bbbc51be9a5
+  data.tar.gz: 4e42e6a3e2c8399dbcb2c57fbe0a85282e4ac6355952b2c0b3252f13f977211623627c3d422b74fbd52f354419b6a77a65ef120c1c16b314d7c7f720e4a9db00

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Abhijith K <iamabhijith.k@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,154 @@
+# flutter_versioner plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-flutter_versioner)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-flutter_versioner`, add it to your project by running:
+
+```bash
+fastlane add_plugin flutter_versioner
+```
+
+## About flutter_versioner
+
+Flutter versioner is a powerful fastlane plugin designed to simplify the management of flutter project version. With this you can easily update project version to any specified major,minor,or patch level as well as adjust the version code/build number.
+## Syntax
+```
+flutter_versioner(pubspec_file_path:"../pubspec.yaml",
+version_component:"major"
+) 
+```
+
+### Options
+1. pubspec_file_path - relative path to the pubspec file where the version is maintained
+2. version_component - the component of version that need to be modified - **major.minor.patch+version_code**
+
+    Values
+    - major
+    - minor
+    - patch
+    - version_code (default value)
+3. value - the value given will be used to set the given version component. If `value` is not given the version compenent will be incremented by `1`
+
+## 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`.
+
+### 1. VERSION CODE/BUILD NUMBER
+#### a. Update the flutter version code by 1 
+
+eg 1.1.1+1 -> 1.1.1+2
+
+```
+flutter_versioner(pubspec_file_path:"./example/pubspec.yaml",
+version_component:"version_code")
+```
+if you dont specify `version_component` version_code will the default value
+
+```
+flutter_versioner(pubspec_file_path:"./example/pubspec.yaml",
+value:"9")
+```
+
+#### b. Set the flutter version - patch to `value` given 
+
+eg 1.1.1+1 -> 1.1.1+100
+```
+flutter_versioner(pubspec_file_path:"./example/pubspec.yaml",
+  value:"100",
+  version_component:"version_code")
+```
+### 2. VERSION - PATCH
+#### a. Update the flutter version - patch by 1 
+
+eg 1.1.1 -> 1.1.2
+
+```
+flutter_versioner(pubspec_file_path:"./example/pubspec.yaml",
+  version_component:"patch")
+```
+#### b. Set the flutter version - patch to `value` given 
+
+eg 1.1.1 -> 1.1.100
+
+```
+flutter_versioner(pubspec_file_path:"./example/pubspec.yaml",
+  value:"100",
+  version_component:"patch")
+```
+
+### 3. VERSION - MINOR
+#### a. Update the flutter version - minor by 1  (also reset patch to 0)
+
+eg 1.1.1 -> 1.2.0
+```
+flutter_versioner(pubspec_file_path:"./example/pubspec.yaml",
+  version_component:"minor")
+```
+
+#### b. Set the flutter version - major to `value` given  (also reset patch to 0)
+
+eg 1.1.1 -> 1.100.0
+```
+flutter_versioner(pubspec_file_path:"./example/pubspec.yaml",
+  value:"100",
+  version_component:"minor")
+```
+
+### 4. VERSION - MAJOR
+#### a. Update the flutter version - major by 1 (also reset minor and patch)
+
+eg 1.1.1 -> 2.0.0
+
+```
+flutter_versioner(pubspec_file_path:"./example/pubspec.yaml",
+  version_component:"major")
+```
+
+#### b. Set the flutter version - major to `value` given (also reset minor and patch)
+
+eg 1.1.1 -> 100.0.0
+
+```
+flutter_versioner(pubspec_file_path:"./example/pubspec.yaml",
+  value:"100",
+  version_component:"major")
+```
+
+
+## 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).
+
+## Meet the Team
+
+<b>Abhijith Konnayil</b><br>
+GitHub: [abhijithkonnayil](https://github.com/abhijithkonnayil)<br>
+LinkedIn: [abhijithkonnayil](https://www.linkedin.com/in/abhijithkonnayil)<br>
+Website: [abhijith.web.app](https://abhijith.web.app/)

data/lib/fastlane/plugin/flutter_versioner/actions/flutter_versioner_action.rb

@@ -0,0 +1,179 @@
+require 'fastlane/action'
+require_relative '../helper/flutter_versioner_helper'
+
+module Fastlane
+  module Actions
+    class FlutterVersionerAction < Action
+      def self.run(params)
+        new_value ||= params[:value]
+        constant_name ||= params[:ext_constant_name]
+        pubspec_file_path ||= params[:pubspec_file_path]
+        version_component ||= params[:version_component]
+        version_list = []
+
+        if pubspec_file_path.nil?
+          UI.user_error!("The pubspec file path given. Pass the `pubspec_file_path` to the action")
+        else
+          UI.message("The flutter_versioner plugin will use pubspec file at (#{pubspec_file_path})!")
+          version_list = incrementVersion(pubspec_file_path, new_value, constant_name, version_component)
+        end
+
+        if version_list.length == 2
+          # Store the version name in the shared hash
+          Actions.lane_context["VERSION_CODE"] = new_value
+          UI.message("Previous Version : #{version_list[0]}")
+          UI.success("Version has been changed to #{version_list[1]}")
+        else
+          UI.user_error!("Updating the version failed !!")
+        end
+
+        return new_value
+      end
+
+      def self.incrementVersion(path, new_value, constant_name, version_comp = 'version_code')
+        unless File.file?(path)
+          UI.user_error!("No file exist at path: (#{path})!")
+          return -1
+        end
+        begin
+          found_version_code = "false"
+          new_version = nil
+          old_verison = nil
+          temp_file = Tempfile.new('fastlaneIncrementVersionCode')
+          File.open(path, 'r') do |file|
+            file.each_line do |line|
+              if line.include?("#{constant_name}:") and found_version_code == "false"
+
+                UI.message(" -> line: (#{line})!")
+                old_version_name = get_version_name(line)
+                old_version_code = get_version_code(line)
+                new_version_code = old_version_code
+                new_version_name = old_version_name
+
+                if version_comp == 'version_code'
+                  new_version_code = increment_version_code(old_version_code, new_value)
+
+                elsif ['patch', 'major', 'minor'].include?(version_comp)
+                  new_version_name = increment_version_name(old_version_name, version_comp, new_value)
+                else
+                  UI.user_error!("Invalid version component.\nVersion Component must be any one of these -> version_code,  patch, minor,major")
+                end
+                new_version = "#{new_version_name}+#{new_version_code}"
+                old_verison = "#{old_version_name}+#{old_version_code}"
+
+                if !!(new_version_code =~ /\A[-+]?[0-9]+\z/)
+                  line.replace(line.sub(old_verison, new_version))
+                  found_version_code = "true"
+                end
+                temp_file.puts(line)
+              else
+                temp_file.puts(line)
+              end
+            end
+            file.close
+          end
+          temp_file.rewind
+          temp_file.close
+          FileUtils.mv(temp_file.path, path)
+          temp_file.unlink
+        end
+        if found_version_code == "true"
+          return [old_verison, new_version]
+        end
+
+        return -1
+      end
+
+      def self.get_version_code(line)
+        version_components = line.strip.split('+')
+        return version_components[version_components.length - 1].tr("\"", "")
+      end
+
+      def self.increment_version_code(version, new_version_code = -1)
+        if new_version_code <= 0
+          new_version_code = version.to_i + 1
+        end
+        return new_version_code.to_s
+      end
+
+      def self.get_version_name(line)
+        version_components_ver_string__build_no_list = line.strip.split('+')
+        version_components_ver_key__maj_min_pat = version_components_ver_string__build_no_list[0].split(":")
+        version_name = version_components_ver_key__maj_min_pat[version_components_ver_key__maj_min_pat.length - 1].strip
+        return version_name
+      end
+
+      def self.increment_version_name(version_name, version_component = 'patch', new_value)
+        if new_value < 0
+          new_value = nil
+        end
+        major, minor, patch  = version_name.split(".")
+        if version_component == 'major'
+          major = new_value || (major.to_i + 1)
+          minor = 0
+          patch = 0
+        elsif version_component == 'minor'
+          minor = new_value || (minor.to_i + 1)
+          patch = 0
+        elsif version_component == "patch"
+          patch = new_value || (patch.to_i + 1)
+        end
+        return "#{major}.#{minor}.#{patch}"
+      end
+
+      def self.description
+        "Effortlessly manage and update your flutter project version."
+      end
+
+      def self.authors
+        ["Abhijith K"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "Flutter versioner is a powerful fastlane plugin designed to simplify the management of flutter project version. With this you can easily update project version to any specified major,minor,or patch level as well as adjust the version code/build number."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :version_component,
+                                       env_name: "FLUTTERVERSIONER_VERSION_COMPONENT",
+                                       description: "The component of the version to be updated, version format :  major.minor.patch+version_code. (default : version_code)",
+                                       optional: true,
+                                       type: String,
+                                       default_value: "version_code"),
+          FastlaneCore::ConfigItem.new(key: :pubspec_file_path,
+                                       env_name: "FLUTTERVERSIONER_PUBSPEC_FILE_PATH",
+                                       description: "The relative path to the pubspec file containing the version parameter (default:app/build.gradle)",
+                                       optional: true,
+                                       type: String,
+                                       default_value: nil),
+          FastlaneCore::ConfigItem.new(key: :value,
+                                       env_name: "FLUTTERVERSIONER_VALUE",
+                                       description: "Change to a specific version (optional)",
+                                       optional: true,
+                                       type: Integer,
+                                       default_value: -1),
+          FastlaneCore::ConfigItem.new(key: :ext_constant_name,
+                                       env_name: "FLUTTERVERSIONER_EXT_CONSTANT_NAME",
+                                       description: "If the version code is set in an ext constant, specify the constant name (optional)",
+                                       optional: true,
+                                       type: String,
+                                       default_value: "version")
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/flutter_versioner/helper/flutter_versioner_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    class FlutterVersionerHelper
+      # class methods that you define here become available in your action
+      # as `Helper::FlutterVersionerHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the flutter_versioner plugin helper!")
+      end
+    end
+  end
+end

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

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

data/lib/fastlane/plugin/flutter_versioner.rb

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

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-flutter_versioner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abhijith K
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-09 00:00:00.000000000 Z
+dependencies: []
+description:
+email: iamabhijith.k@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/flutter_versioner.rb
+- lib/fastlane/plugin/flutter_versioner/actions/flutter_versioner_action.rb
+- lib/fastlane/plugin/flutter_versioner/helper/flutter_versioner_helper.rb
+- lib/fastlane/plugin/flutter_versioner/version.rb
+homepage: https://github.com/abhijithkonnayil/fastlane-plugin-flutter_versioner
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Effortlessly manage and update your flutter project version.
+test_files: []