ann-flutter-flavor 0.1.2

data/lib/fastlane/plugin/ann_flutter_flavor/helper/utils_project_config.rb

@@ -0,0 +1,96 @@
+require 'fastlane/action'
+require 'fileutils'
+
+module FastlaneFlutterFlavor
+  # ------------------------------------
+  # ProjectUtil (Helper Module)
+  # Contains logic to locate the Flutter project root directory and key config files.
+  # ------------------------------------
+  module ProjectUtil
+
+    # ===============================================
+    # Find Flutter Project Root
+    # Searches upwards from the current directory for a pubspec.yaml file.
+    # ===============================================
+    def self.find_flutter_root
+      current_dir = Dir.pwd
+      while current_dir != '/' do
+        pubspec_path = File.join(current_dir, 'pubspec.yaml')
+        if File.exist?(pubspec_path)
+          Fastlane::UI.verbose("Found pubspec.yaml at: #{current_dir}")
+          return current_dir
+        end
+        parent_dir = File.dirname(current_dir)
+        # Prevent infinite loop if we hit the root and haven't found it
+        break if parent_dir == current_dir
+        current_dir = parent_dir
+      end
+
+      # Fallback to the original logic if pubspec.yaml isn't found
+      Fastlane::UI.important("pubspec.yaml not found by searching up. Falling back to current directory.")
+      return Dir.pwd
+    end
+
+    # ===============================================
+    # Internal method to resolve config path with precedence
+    # Precedence: User Parameter > Environment Variable > Default Path
+    #
+    # ===============================================
+    def self.resolve_config_path(filename, user_defined_path, env_var_name)
+      chosen_path_value = nil
+      source = "default in project root"
+
+      # Precedence 1: User-passed parameter (from action/lane)
+      # Check if user passed an explicit path (i.e., not the action's default filename string)
+      if user_defined_path && user_defined_path != filename
+        chosen_path_value = user_defined_path
+        source = "user parameter"
+      end
+
+      # Precedence 2: Environment Variable
+      if chosen_path_value.nil?
+        env_path = ENV[env_var_name]
+        if env_path && !env_path.empty?
+          chosen_path_value = env_path
+          source = "environment variable (#{env_var_name})"
+        end
+      end
+
+      # Precedence 3: Default in Project Root
+      if chosen_path_value.nil?
+        root = find_flutter_root
+        chosen_path_value = File.join(root, filename)
+        # source remains "default in project root"
+      end
+
+      # Resolve the path and check for existence
+      resolved_path = File.expand_path(chosen_path_value)
+
+      if File.exist?(resolved_path)
+        Fastlane::UI.verbose("Found #{filename} path from #{source}: #{resolved_path}")
+      else
+        Fastlane::UI.warning("#{filename} file not found at resolved path: #{resolved_path} (Source: #{source}).")
+        # Note: We still return the path, as it might be created later or is only referenced for metadata.
+      end
+
+      return resolved_path
+    end
+
+
+    # ===============================================
+    # Find Annai Spec File Path (annspec.yaml)
+    # Uses ANN_SPEC_FILE environment variable.
+    # ===============================================
+    def self.find_annai_spec_path(user_defined_path = nil)
+      return resolve_config_path('annspec.yaml', user_defined_path, 'ANN_SPEC_FILE')
+    end
+
+    # ===============================================
+    # Find Annai Test Spec File Path (annaitestspec.yaml)
+    # Uses ANNAI_TEST_SPEC_FILE environment variable.
+    # ===============================================
+    def self.find_annai_test_spec_path(user_defined_path = nil)
+      return resolve_config_path('annaitestspec.yaml', user_defined_path, 'ANNAI_TEST_SPEC_FILE')
+    end
+  end
+end

data/lib/fastlane/plugin/ann_flutter_flavor/helper/utils_spec_loader.rb

@@ -0,0 +1,363 @@
+require 'yaml'
+require 'fileutils'
+require 'fastlane/action'
+
+module FastlaneFlutterFlavor
+
+  class YamlSpecLoader
+
+    # Initialize the loader with the project root folder context and load the spec file.
+    def initialize(root_folder, file_path)
+      @root_folder = root_folder
+      @file_path = file_path # The file path, potentially overridden by ENV outside this class
+
+      # Load the file content immediately and store it
+      @spec_data = load_file
+    end
+
+    # Loads and parses the raw YAML spec file using the instance file path.
+    # @return [Hash, nil] The parsed YAML data, or nil on error.
+    def load_file
+      begin
+        # Ensure the file path is resolved relative to the project root
+        full_path = File.expand_path(@file_path, @root_folder)
+        Fastlane::UI.verbose("Reading Annai spec from: #{full_path}")
+
+        # Use safe_load to prevent arbitrary code execution from YAML files
+        yaml_content = YAML.safe_load(File.read(full_path), aliases: true)
+
+        # Ensure the content is a Hash before returning
+        unless yaml_content.is_a?(Hash)
+          raise "YAML content must be a top-level Hash."
+        end
+        return yaml_content
+      rescue => e
+        # Use @file_path for reporting the error path
+        Fastlane::UI.error("Failed to load or parse annai spec YAML file at #{@file_path}: #{e.message}")
+        return nil
+      end
+    end
+
+    # Recursively merges defaults into a flavor's data.
+    # This function prioritizes 'current_data' (the flavor-specific value).
+    # If a key is present in 'default_data' but missing in 'current_data',
+    # the default value is used.
+    #
+    # @param current_data [Object] The flavor-specific data (Hash or scalar).
+    # @param default_data [Object] The default data to merge (Hash or scalar).
+    # @return [Object] The merged data.
+    def deep_merge_defaults(current_data, default_data)
+
+      # FIX: If current_data is a scalar, it means the flavor explicitly set this value.
+      # It overrides the default, so we return it immediately.
+      return current_data unless current_data.is_a?(Hash)
+
+      # Base case 2: If default_data is not a hash, there's nothing left to merge deeply.
+      return current_data unless default_data.is_a?(Hash)
+
+      # Recursive case: Both are hashes, perform the merge
+      default_data.each do |key, default_value|
+        current_value = current_data[key]
+
+        if current_data.key?(key)
+          # Key exists in flavor (current_data), recursively merge
+          current_data[key] = deep_merge_defaults(current_value, default_value)
+        else
+          # The key is missing in the current flavor data. Use the default value.
+          current_data[key] = default_value
+        end
+      end
+
+      return current_data
+    end
+
+    # Retrieves the configuration for a specific flavor, merged with the platform defaults.
+    # This function uses the spec data loaded into the instance variable @spec_data.
+    #
+    # @param platform [Symbol] The target platform (:ios or :android).
+    # @param flavor_name [String] The name of the flavor (e.g., 'dev', 'staging').
+    # @return [Hash, nil] The fully merged configuration for the flavor, or nil if missing.
+    def get_merged_flavor_config(platform, flavor_name)
+      return nil unless @spec_data # Check if file was loaded successfully
+
+      platform_key = platform.to_s
+      flavor_key = flavor_name.to_s
+
+      # 1. Extract platform data from instance spec data
+      platform_data = @spec_data.dig('annai_app', platform_key)
+      unless platform_data.is_a?(Hash)
+        Fastlane::UI.verbose("Annai spec missing 'annai_app' or platform '#{platform_key}'.")
+        return nil
+      end
+
+      # 2. Extract specific flavor data and defaults
+      flavor_data = platform_data.dig('flavor', flavor_key)
+      default_data = platform_data.dig('default')
+
+      # If flavor data is missing entirely, and we can't merge, return nil
+      if flavor_data.nil? && default_data.nil?
+        Fastlane::UI.verbose("Flavor '#{flavor_key}' and platform default config are missing for platform '#{platform_key}'.")
+        return nil
+      end
+
+      # 3. Deep merge the flavor data (current) over the default data (base)
+      current_config = flavor_data || {}
+
+      # Perform the merge operation. We clone current_config to avoid modifying the original spec hash.
+      merged_config = deep_merge_defaults(current_config.dup, default_data || {})
+
+      # Add the flavor name itself for consistency in the returned config hash
+      merged_config['flavor'] = flavor_key
+
+      return merged_config
+    end
+
+    # --- GETTER WRAPPERS ---
+
+    # Retrieves the hash of all defined flavors for a given platform.
+    # Uses the instance spec data.
+    #
+    # @param platform [Symbol] The target platform (:ios or :android).
+    # @return [Hash] A hash where keys are flavor names (String) and values are their raw configs (Hash).
+    def get_platform_flavors(platform)
+      return {} unless @spec_data
+      platform_key = platform.to_s
+
+      # Use dig to safely retrieve the flavors hash from @spec_data
+      flavors = @spec_data.dig('annai_app', platform_key, 'flavor')
+
+      # Return the flavors hash, or an empty hash if no flavors are defined
+      return flavors.is_a?(Hash) ? flavors : {}
+    end
+
+    # @return [String, nil] The flavor name (just for consistency with other getters).
+    def get_flavor_name(platform, flavor_name)
+      config = get_merged_flavor_config(platform, flavor_name)
+      config.dig('flavor') if config
+    end
+
+    # @return [String, nil] The merged package ID (bundle ID or application ID).
+    # It combines 'id' and 'id_suffix' (if present) via direct concatenation.
+    # NOTE: It is assumed that the 'id_suffix' defined in the configuration
+    def get_package_id(platform, flavor_name)
+      config = get_merged_flavor_config(platform, flavor_name)
+      return nil unless config
+
+      base_id = config.dig('id')
+      return nil unless base_id
+
+      # Check for an optional suffix
+      suffix = config.dig('id_suffix')
+
+      # If a suffix is present, combine it directly with the base ID.
+      # This relies on the suffix string itself containing the correct separator (like ".")
+      # to correctly form the final package ID (e.g., "com.base" + ".dev" -> "com.base.dev").
+      if suffix && !suffix.empty?
+        return base_id + suffix
+      else
+        # Return the base ID if no suffix is present.
+        return base_id
+      end
+    end
+
+    # @return [String, nil] The merged app name.
+    # It combines 'name' and 'name_suffix' (if present) via direct concatenation.
+    # NOTE: It is assumed that the 'name_suffix' defined in the configuration
+    def get_display_name(platform, flavor_name)
+      config = get_merged_flavor_config(platform, flavor_name)
+      return nil unless config
+
+      base_name = config.dig('name')
+      return nil unless base_name
+
+      # Check for an optional suffix
+      suffix = config.dig('name_suffix')
+
+      # If a suffix is present, combine it directly with the base Name.
+      # This relies on the suffix string itself containing the correct separator
+      # to correctly form the final Name (e.g., "Test" + " App" -> "Test App").
+      if suffix && !suffix.empty?
+        return base_name + suffix
+      else
+        # Return the base Name if no suffix is present.
+        return base_name
+      end
+    end
+
+    # @return [String, nil] The merged version name.
+    # It combines 'version_name' and 'version_name_suffix' (if present) via direct concatenation.
+    # NOTE: It is assumed that the 'version_name_suffix' defined in the configuration
+    def get_version_name(platform, flavor_name)
+      config = get_merged_flavor_config(platform, flavor_name)
+      return nil unless config
+
+      base_version_name = config.dig('version_name')
+      return nil unless base_version_name
+
+      # Check for an optional suffix
+      suffix = config.dig('version_name_suffix')
+
+      # If a suffix is present, combine it directly with the base version name.
+      # This relies on the suffix string itself containing the correct separator
+      # to correctly form the final version name (e.g., "V" + "1.0.1" -> "V1.0.1").
+      if suffix && !suffix.empty?
+        return base_version_name + suffix
+      else
+        # Return the base version name if no suffix is present.
+        return base_version_name
+      end
+    end
+
+    # @return [String, nil] The path to the version_code.
+    def get_version_code(platform, flavor_name)
+      config = get_merged_flavor_config(platform, flavor_name)
+      if config
+        version_code_value = config.dig('version_code').to_s.strip
+        return version_code_value.to_i(10).to_s
+      end
+      return nil
+    end
+
+    # @return [String, nil] The path to the main Dart file.
+    def get_main_file(platform, flavor_name)
+      config = get_merged_flavor_config(platform, flavor_name)
+      config.dig('main_file') if config
+    end
+
+    # @return [String, nil] The priority level.
+    def get_priority(platform, flavor_name)
+      config = get_merged_flavor_config(platform, flavor_name)
+      config.dig('priority') if config
+    end
+
+    # @return [String, nil] The API key path (e.g., path to Google Service Account JSON or App Store Connect API Key JSON).
+    def get_api_key_path(platform, flavor_name)
+      # 1. Get the merged configuration for the specific flavor
+      config = get_merged_flavor_config(platform, flavor_name)
+
+      # Return nil early if configuration is missing
+      return nil unless config
+
+      # 2. Extract the key based on the platform
+      case platform
+      when :android
+        # For Android, we look for 'google_api_key'
+        config.dig('fastlane', 'google_api_key')
+      when :ios
+        # For iOS, we look for 'apple_api_key'
+        config.dig('fastlane', 'apple_api_key')
+      else
+        # Return nil for other platforms
+        nil
+      end
+    end
+
+    # @return [String, nil] The export_option_file.
+    def get_export_option_file(platform, flavor_name)
+      # 1. Get the merged configuration for the specific flavor
+      config = get_merged_flavor_config(platform, flavor_name)
+
+      # Return nil early if configuration is missing
+      return nil unless config
+
+      # 2. Extract the key based on the platform
+      case platform
+      when :ios
+        # For iOS, we look for 'export_options_plist'
+        config.dig('fastlane', 'export_options_plist')
+      else
+        # Return nil for other platforms
+        nil
+      end
+    end
+
+    # @return [String, nil] The App store Team ID.
+    def get_team_id(platform, flavor_name)
+      # 1. Get the merged configuration for the specific flavor
+      config = get_merged_flavor_config(platform, flavor_name)
+
+      # Return nil early if configuration is missing
+      return nil unless config
+
+      # 2. Extract the key based on the platform
+      case platform
+      when :ios
+        # For iOS, we look for 'export_option_file'
+        config.dig('team_id')
+      else
+        # Return nil for other platforms
+        nil
+      end
+    end
+
+    # @return [String, nil] The Firebase Project ID.
+    def get_firebase_project_id(platform, flavor_name, build_config)
+      # 1. Get the merged configuration for the specific flavor
+      config = get_merged_flavor_config(platform, flavor_name)
+
+      config.dig('firebase', build_config, 'project_id') if config
+    end
+
+    # Retrieves the firebase token from a external .properties file
+    # as defined in annai_app -> general -> firebase_token_file
+    # @return [String, nil] The token value, or nil if not found/error.
+    def get_firebase_token_from_properties
+      return nil unless @spec_data
+
+      # 1. Get the properties file path from the YAML spec
+      # Path: annai_app -> general -> firebase_token_file
+      rel_props_path = @spec_data.dig('annai_app', 'general', 'firebase_token_file')
+
+      if rel_props_path.nil? || rel_props_path.empty?
+        Fastlane::UI.verbose("No 'firebase_token_file' defined in annai_app -> general.")
+        return nil
+      end
+
+      # 2. Resolve the full path relative to project root
+      full_props_path = File.expand_path(rel_props_path, @root_folder)
+
+      unless File.exist?(full_props_path)
+        Fastlane::UI.error("Firebase token file not found at: #{full_props_path}")
+        return nil
+      end
+
+      # 3. Parse the .properties file for FIREBASE_TOKEN
+      begin
+        File.foreach(full_props_path) do |line|
+          # Remove whitespace and skip comments/empty lines
+          line = line.strip
+          next if line.empty? || line.start_with?('#', '!')
+
+          # Match KEY=VALUE (handles both = and : as separators)
+          if line =~ /^\s*FIREBASE_TOKEN\s*[=:]\s*(.*)$/
+            token = $1.strip
+            # Remove optional surrounding quotes if present
+            return token.gsub(/^['"]|['"]$/, '')
+          end
+        end
+      rescue => e
+        Fastlane::UI.error("Error reading properties file at #{rel_props_path}: #{e.message}")
+      end
+
+      Fastlane::UI.verbose("FIREBASE_TOKEN key not found in #{rel_props_path}")
+      return nil
+    end
+
+    # For AdMob (annai_ads)
+    def get_gms_ads_id(platform, flavor_name)
+      config = get_merged_flavor_config(platform, flavor_name)
+      config.dig('gms_ads_id') if config
+    end
+
+    # For Google Sign-In (annai_auth)
+    def get_auth_client_id(platform, flavor_name, build_config)
+      config = get_merged_flavor_config(platform, flavor_name)
+      config.dig('auth', build_config, 'clientId') if config
+    end
+
+    def get_auth_reversed_client_id(platform, flavor_name, build_config)
+      config = get_merged_flavor_config(platform, flavor_name)
+      config.dig('auth', build_config, 'reversedClientId') if config
+    end
+  end
+end

data/lib/fastlane/plugin/ann_flutter_flavor/helper/utils_status.rb

@@ -0,0 +1,115 @@
+require 'yaml'
+require 'fileutils'
+require 'fastlane/action'
+
+module FastlaneFlutterFlavor
+
+  # Inject the custom colors used in the StatusManager (since they aren't standard UI functions)
+  def red(text) ; "\e[31m#{text}\e[0m" ; end
+  def green(text) ; "\e[32m#{text}\e[0m" ; end
+  def amber(text) ; "\e[33m#{text}\e[0m" ; end
+
+  # ------------------------------------
+  # StatusManager (Helper Class)
+  # ------------------------------------
+  class StatusManager
+
+    def initialize(lane:)
+      @status = Hash.new
+      @lane = lane
+    end
+
+    def red(text) ; "\e[31m#{text}\e[0m" ; end
+    def green(text) ; "\e[32m#{text}\e[0m" ; end
+    def amber(text) ; "\e[33m#{text}\e[0m" ; end
+
+    def logError(flavor, laneName, variant, message)
+      key = [flavor, laneName, variant]
+
+      errorPresent = false
+      if @status.key?(key)
+        errorPresent = @status[key][0] == "err"
+      end
+
+      if errorPresent
+        message = "#{@status[key][1]}\n#{message}"
+      end
+
+      @status[key] = ["err", message]
+    end
+
+    def logWarning(flavor, laneName, variant, message)
+      key = [flavor, laneName, variant]
+
+      errorPresent = false
+      if @status.key?(key)
+        errorPresent = @status[key][0] == "err"
+      end
+
+      unless errorPresent
+        @status[key] = ["warn", message]
+      end
+    end
+
+    def logSuccess(flavor, laneName, variant)
+      key = [flavor, laneName, variant]
+
+      errorPresent = false
+      if @status.key?(key)
+        errorPresent = @status[key][0] == "err" || @status[key][0] == "warn"
+      end
+
+      unless errorPresent
+        @status[key] = ["info", ""]
+      end
+    end
+
+    def displayStatus()
+      errMsg = ""
+      message = "\n"
+      message += "+-------------------+-------------------------------+-------------------------------+----------------+\n"
+      message += "|                           #{green('Annai Fastlane summary')}                                       |\n"
+      message += "+-------------------+-------------------------------+-------------------------------+----------------+\n"
+
+      message += "| Flavor            | Variant                       | Lane                          | Status         |\n"
+      message += "+-------------------+-------------------------------+-------------------------------+----------------+\n"
+
+      @status.each { |key,value|
+        flavor = key[0].to_s
+        laneName = key[1].to_s
+        variantName = key[2].to_s
+        statusStr = value[0]
+        statusMessage = value[1]
+
+        if statusStr == 'info'
+          sts = green("Success".ljust(15))
+        elsif statusStr == 'warn'
+          sts = amber("Warning".ljust(15))
+          if errMsg != "" then
+            errMsg += "\n"
+          end
+          errMsg += "Flavor - #{flavor} : "
+          errMsg += "#{statusMessage}"
+        else
+          sts = red("Failure".ljust(15))
+          if errMsg != "" then
+            errMsg += "\n"
+          end
+          errMsg += "Flavor - #{flavor} : "
+          errMsg += "#{statusMessage}"
+        end
+        message += "| #{flavor.ljust(18)}| #{variantName.ljust(30)}| #{laneName.ljust(30)}| #{sts}|\n"
+      }
+      message += "+-------------------+-------------------------------+-------------------------------+----------------+"
+
+      if errMsg != "" then
+        Fastlane::UI.message("Summary of all the Errors/Warnings")
+        Fastlane::UI.error(errMsg)
+        # Mailgun calls removed, assuming external communication is handled outside the core action
+      else
+        # Mailgun calls removed
+      end
+      Fastlane::UI.message(message)
+    end
+  end
+end

data/lib/fastlane/plugin/ann_flutter_flavor.rb

@@ -0,0 +1,23 @@
+module Fastlane
+  module AnnFlutterFlavor
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# Import all available actions and helpers
+Fastlane::AnnFlutterFlavor.all_classes.each { |f| require f }
+
+# --- Global Helper for CocoaPods Podfile ---
+
+# Accessible directly in the Podfile's post_install block.
+def annai_ios_podfile_setup(installer)
+  if defined?(FastlaneFlutterFlavor::PodspecBridge)
+    FastlaneFlutterFlavor::PodspecBridge.apply_build_settings(installer)
+  else
+    # Fallback if Fastlane UI isn't loaded
+    msg = "[Annai] Bridge not found. Check gem installation."
+    defined?(UI) ? UI.error(msg) : puts("\e[31m#{msg}\e[0m")
+  end
+end