fastlane-plugin-flutter 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb29c8dc7585bdd45029e7c2718a113a6d47598c
-  data.tar.gz: a21b6f7c0ef29dca72423d6f6fcb638989cb0321
+  metadata.gz: 3e378c20ed4cdebc4af0d1034b9a33c1c6836ad8
+  data.tar.gz: 722fa1646960e5838262036a875206bb404543d8
 SHA512:
-  metadata.gz: a9b569b2f6e8fb92c5751886e8f3ed44d3ccb1cb2e0157a97accb22fa0fa4b59588afd07469fbeefad46e603c062eab80328a7f368ad27c89faa9636a1b2c90a
-  data.tar.gz: eb9887fda61f9518021b2ca43bdbc09400c996465dd5ba9971596b9aa3667dccebf344ccf49e5c5115f50ebd396fcb0bb3a9032e8bf7e2004bb717dbaa6053c3
+  metadata.gz: 53db9cf6533fc97b1b5ae367764dffeddcb6bccca320e3fe70214e88c4b90f99fdd2834ccad6d8e7797fc6a02c9ecd4df292ee92f5e19987bfa925be7ac6f406
+  data.tar.gz: 5e0387e7c92ffe9d36ba25f26daa9dab60ab25eab9f9a0f0403fe1baa91b875c783b87fdbf86f6db1c91a3f570c8f819b92b3800b2d4edab779397810ac53491

data/README.md

@@ -6,8 +6,8 @@
 
 This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-flutter`, add it to your project by running:
 
-```bash
-fastlane add_plugin flutter
+```shell
+$ fastlane add_plugin flutter
 ```
 
 ## About flutter
@@ -16,21 +16,23 @@ Flutter actions plugin for Fastlane.
 
 ## 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)
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin.
 
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run
 
-```
-rake
+```shell
+$ bundle install
+$ bundle exec rake
+$ bundle exec fastlane end_to_end_test
 ```
 
 To automatically fix many of the styling issues, use
-```
-rubocop -a
+
+```shell
+$ bundle install
+$ bundle exec rubocop -a
 ```
 
 ## Issues and Feedback

data/lib/fastlane/plugin/flutter/actions/flutter_action.rb

@@ -1,313 +1,30 @@
 require 'fastlane/action'
+require_relative '../base/flutter_action_base'
 require_relative '../helper/flutter_helper'
 
-# This is the entry point for this plugin. For more information on writing
-# plugins: https://docs.fastlane.tools/advanced/
-
 module Fastlane
   module Actions
-    module SharedValues
-      FLUTTER_OUTPUT_APP = :FLUTTER_OUTPUT_APP
-      FLUTTER_OUTPUT_APK = :FLUTTER_OUTPUT_APK
-      FLUTTER_OUTPUT_BUILD_NUMBER_OVERRIDE =
-        :FLUTTER_OUTPUT_BUILD_NUMBER_OVERRIDE
-      FLUTTER_OUTPUT_BUILD_NAME_OVERRIDE = :FLUTTER_OUTPUT_BUILD_NAME_OVERRIDE
-    end
-
     class FlutterAction < Action
-      FLUTTER_ACTIONS = %w(build analyze test format l10n bootstrap)
-
-      PLATFORM_TO_FLUTTER = {
-        ios: 'ios',
-        android: 'apk',
-      }
-
-      PLATFORM_TO_OUTPUT = {
-        ios: SharedValues::FLUTTER_OUTPUT_APP,
-        android: SharedValues::FLUTTER_OUTPUT_APK,
-      }
+      extend FlutterActionBase
 
       def self.run(params)
-        # You can print a table of plugin configuration params like that:
-        #
-        # FastlaneCore::PrintTable.print_values(
-        #   config: params,
-        #   title: "Summary for Flutter plugin #{Fastlane::Flutter::VERSION}",
-        # )
-
-        case params[:action]
-        when 'build'
-          # A map of fastlane platform name into "flutter build" args list.
-          build_args = {}
-
-          if lane_context.key?(SharedValues::PLATFORM_NAME)
-            fastlane_platform = lane_context[SharedValues::PLATFORM_NAME]
-            build_args[fastlane_platform] =
-              [PLATFORM_TO_FLUTTER[fastlane_platform]]
-          else
-            # If platform is unspecified, build for all platforms.
-            PLATFORM_TO_FLUTTER.each_key do |platform|
-              build_args[platform] = [PLATFORM_TO_FLUTTER[platform]]
-            end
-          end
-
-          if params[:debug]
-            build_args.each_value do |a|
-              a.push('--debug')
-            end
-          end
-
-          unless params[:codesign]
-            build_args[:ios].push('--no-codesign') if build_args.key?(:ios)
-          end
-
-          if lane_context[SharedValues::FLUTTER_OUTPUT_BUILD_NUMBER_OVERRIDE] =
-               build_number = Helper::FlutterHelper.build_number(
-                 params[:build_number_override]
-               )
-            build_args.each_value do |a|
-              a.push('--build-number', build_number.to_s)
-            end
-          end
-
-          if lane_context[SharedValues::FLUTTER_OUTPUT_BUILD_NAME_OVERRIDE] =
-               build_name = Helper::FlutterHelper.build_name(
-                 params[:build_name_override]
-               )
-            build_args.each_value do |a|
-              a.push('--build-name', build_name)
-            end
-          end
-
-          # Note: this statement is expected to return a value (map of platform
-          # into file name).
-          Hash[build_args.keys.zip(build_args.map do |platform, args|
-            sh('flutter', 'build', *args) do |status, res|
-              if status.success?
-                # Dirty hacks ahead!
-                if PLATFORM_TO_OUTPUT.key?(platform)
-                  if res =~ /^Built (.*?)(:? \([^)]*\))?\.$/
-                    lane_context[PLATFORM_TO_OUTPUT[platform]] =
-                      File.absolute_path($1)
-                  end
-                end
-              else
-                # fastlane does not fail automatically if we provide a block.
-                UI.build_failure!("flutter build #{platform} has failed.")
-              end
-            end
-          end.compact)]
-        when 'test'
-          sh *%w(flutter test)
-        when 'analyze'
-          sh *%w(flutter analyze)
-        when 'format'
-          sh *%w(flutter format .)
-        when 'l10n'
-          run_l10n(params)
-        when 'bootstrap'
-          Helper::FlutterHelper.bootstrap_android(params[:android_licenses])
-        end
-      end
-
-      def self.run_l10n(params)
-        unless params[:l10n_strings_file]
-          UI.user_error!('l10n_strings_file is a required parameter for ' \
-                         'l10n action')
-        end
-
-        output_dir = 'lib/l10n'
-        l10n_messages_file = File.join(output_dir, 'intl_messages.arb')
-        # This file will not exist before it's generated for the first time.
-        if File.exist?(l10n_messages_file)
-          l10n_messages_was = File.read(l10n_messages_file)
-        end
-
-        extract_to_arb_options = ["--output-dir=#{output_dir}"]
-        if params[:l10n_strings_locale]
-          extract_to_arb_options.push(
-            "--locale=#{params[:l10n_strings_locale]}"
-          )
-        end
-
-        sh *%w(flutter packages pub run intl_translation:extract_to_arb),
-           *extract_to_arb_options, params[:l10n_strings_file]
-
-        if l10n_messages_was
-          # intl will update @@last_modified even if there are no updates;
-          # this leaves Git directory unnecessary dirty. If that's the only
-          # change, just restore the previous contents.
-          if Helper::FlutterHelper.restore_l10n_timestamp(
-            l10n_messages_file, l10n_messages_was
-          )
-            UI.message(
-              "@@last_modified has been restored in #{l10n_messages_file}"
-            )
-          end
-        end
-
-        # Sort files for consistency, because messages_all.dart will have
-        # imports ordered as in the command line below.
-        arb_files = Dir.glob(File.join(output_dir, 'intl_*.arb')).sort
-
-        if params[:l10n_verify_arb]
-          errors_found = arb_files.any? do |arb_file|
-            unless arb_file == l10n_messages_file
-              UI.message("Verifying #{arb_file}...")
-              errors = Helper::FlutterHelper.compare_arb(l10n_messages_file,
-                                                         arb_file)
-              if errors.any?
-                errors.each { |e| UI.error(e) }
-              end
-            end
-          end
-          UI.user_error!('Found inconsistencies in ARB files') if errors_found
-        end
-
-        unless params[:l10n_strings_locale]
-          # Don't generate .dart for the original ARB unless it has its own
-          # locale.
-          arb_files.delete(l10n_messages_file)
-        end
-
-        if params[:l10n_reformat_arb]
-          arb_files.each do |arb_file|
-            UI.message("Reformatting file #{arb_file}...")
-            Helper::FlutterHelper.reformat_arb(arb_file)
-          end
-        end
-
-        sh *%W(flutter packages pub run intl_translation:generate_from_arb
-               --output-dir=#{output_dir}
-               --no-use-deferred-loading
-               #{params[:l10n_strings_file]}) + arb_files
+        Helper::FlutterHelper.flutter(*params[:args])
       end
 
       def self.description
-        "Flutter actions plugin for Fastlane"
-      end
-
-      def self.authors
-        ["Artem Sheremet"]
-      end
-
-      def self.return_value
-        'For "build" action, the return value is a mapping of fastlane ' \
-          'platform names into built output files, e.g.: ' +
-          { android: '/Users/foo/src/flutter/build/outputs/myapp.apk' }.inspect
-      end
-
-      def self.details
-        # Optional:
-        ""
+        'Run "flutter" binary with the specified arguments'
       end
 
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(
-            key: :action,
-            env_name: 'FL_FLUTTER_ACTION',
-            description: 'Flutter action to run',
-            optional: false,
-            type: String,
-            verify_block: proc do |value|
-              unless FLUTTER_ACTIONS.include?(value)
-                UI.user_error!("Supported actions are: #{FLUTTER_ACTIONS}")
-              end
-            end,
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :debug,
-            env_name: 'FL_FLUTTER_DEBUG',
-            description: 'Build a Debug version of the app if true',
-            optional: true,
-            is_string: false,
-            default_value: false,
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :codesign,
-            env_name: 'FL_FLUTTER_CODESIGN',
-            description: 'Set to false to skip iOS app signing. This may be ' \
-            'useful e.g. on CI or when signed by Fastlane "sigh"',
-            optional: true,
-            is_string: false,
-            default_value: true,
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :build_number_override,
-            env_name: 'FL_FLUTTER_BUILD_NUMBER_OVERRIDE',
-            description: <<-'DESCRIPTION',
-              Override build number in pubspec.yaml. Can be either a number, or
-              a schema definition, ex.: ci (take from CI) vcs (take from Git),
-              ci+1000 (take from CI and add 1000).
-            DESCRIPTION
-            optional: true,
-            verify_block: Helper::FlutterHelper.method(:build_number),
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :build_name_override,
-            env_name: 'FL_FLUTTER_BUILD_NAME_OVERRIDE',
-            description: <<-'DESCRIPTION',
-              Override build name in pubspec.yaml. Can be either a string, or a
-              schema definition, ex.: vcs* (take from VCS, add "*" for dirty
-              tree), vcs (take from VCS, no dirty mark), ^vcs (take from the
-              latest VCS tag which must be in the form X.Y, and add the number
-              of commits since that tag as the third number, unless it's zero).
-              NOTE: for App Store, build name must be in the format of at most 3
-                    integeres separated by a dot (".").
-            DESCRIPTION
-            optional: true,
-            verify_block: Helper::FlutterHelper.method(:build_name),
-          ),
-          # l10n settings
-          FastlaneCore::ConfigItem.new(
-            key: :l10n_strings_file,
-            env_name: 'FL_FLUTTER_L10N_STRINGS',
-            description: 'Path to the .dart file with l10n strings',
-            optional: true,
-            verify_block: proc do |value|
-              UI.user_error!('File does not exist') unless File.exist?(value)
-            end,
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :l10n_strings_locale,
-            env_name: 'FL_FLUTTER_L10N_STRINGS_LOCALE',
-            description: 'Locale of the data in l10n_strings_file',
-            optional: true,
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :l10n_reformat_arb,
-            env_name: 'FL_FLUTTER_L10N_REFORMAT_ARB',
-            description: 'Reformat .arb files',
-            optional: true,
-            is_string: false,
-            default_value: false,
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :l10n_verify_arb,
-            env_name: 'FL_FLUTTER_L10N_VERIFY_ARB',
-            description: 'Verify that each .arb file includes all strings',
-            optional: true,
-            is_string: false,
-            default_value: true,
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :android_licenses,
-            env_name: 'FL_FLUTTER_ANDROID_LICENSES',
-            description: 'Hashes of accepted Android SDK linceses, which may ' \
-            'be found in $ANDROID_SDK_ROOT/licenses',
-            optional: true,
-            is_string: false,
-            verify_block: proc { |value| value.kind_of?(Hash) },
-            default_value: {},
+            key: :args,
+            env_name: 'FL_FLUTTER_ARGS',
+            description: 'Arguments to Flutter command',
+            type: Array,
           ),
         ]
       end
-
-      def self.is_supported?(platform)
-        # Also support nil (root lane).
-        [nil, :ios, :android].include?(platform)
-      end
     end
   end
 end

data/lib/fastlane/plugin/flutter/actions/flutter_bootstrap_action.rb

@@ -0,0 +1,80 @@
+require 'fastlane/action'
+require_relative '../base/flutter_action_base'
+require_relative '../helper/flutter_helper'
+require_relative '../helper/flutter_bootstrap_helper'
+
+module Fastlane
+  module Actions
+    class FlutterBootstrapAction < Action
+      extend FlutterActionBase
+
+      def self.run(params)
+        if params[:android_licenses]
+          Helper::FlutterBootstrapHelper.accept_licenses(
+            File.join(android_sdk_root!, 'licenses'),
+            params[:android_licenses],
+          )
+        end
+
+        # Upgrade or install Flutter SDK.
+        flutter_sdk_root = Helper::FlutterHelper.flutter_sdk_root
+        flutter_channel = params[:flutter_channel]
+        if File.directory?(flutter_sdk_root)
+          UI.message("Upgrading Flutter SDK in #{flutter_sdk_root}...")
+          if flutter_channel
+            UI.message("Making sure Flutter is on channel #{flutter_channel}")
+            Helper::FlutterHelper.flutter(
+              'channel', flutter_channel, log: false
+            )
+          end
+          Helper::FlutterHelper.flutter('upgrade', log: false)
+        else
+          Helper::FlutterHelper.git(
+            'clone', # no --depth to keep Flutter tag-based versioning.
+            "--branch=#{flutter_channel || 'beta'}",
+            '--',
+            'https://github.com/flutter/flutter.git',
+            flutter_sdk_root,
+          )
+        end
+        UI.message('Precaching Flutter SDK binaries...')
+        Helper::FlutterHelper.flutter('precache', log: false)
+      end
+
+      def self.android_sdk_root!
+        (ENV['ANDROID_HOME'] || ENV['ANDROID_SDK_ROOT']).tap do |path|
+          unless path
+            UI.build_failure!('Android SDK directory environment variables ' \
+              'are not set. See ' \
+              'https://developer.android.com/studio/command-line/variables')
+          end
+        end
+      end
+
+      def self.description
+        'Flutter SDK installation, upgrade and application bootstrap'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :flutter_channel,
+            env_name: 'FL_FLUTTER_CHANNEL',
+            description: 'Flutter SDK channel (keep existing if unset)',
+            optional: true,
+            type: String,
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :android_licenses,
+            description: 'Map of file names to hash values of accepted ' \
+            'Android SDK linceses, which may be found in ' \
+            '$ANDROID_SDK_ROOT/licenses/ on developer workstations. Gradle ' \
+            'will refuse to install SDK unless licenses are accepted',
+            optional: true,
+            type: Hash,
+          ),
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/flutter/actions/flutter_build_action.rb

@@ -0,0 +1,124 @@
+require 'fastlane/action'
+require_relative '../base/flutter_action_base'
+require_relative '../helper/flutter_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      FLUTTER_OUTPUT = :FLUTTER_OUTPUT
+    end
+
+    class FlutterBuildAction < Action
+      extend FlutterActionBase
+
+      FASTLANE_PLATFORM_TO_BUILD = {
+        ios: 'ios',
+        android: 'apk',
+      }
+
+      def self.run(params)
+        # "flutter build" args list.
+        build_args = []
+
+        if params[:build]
+          build_args.push(params[:build])
+        else
+          if fastlane_platform = (lane_context[SharedValues::PLATFORM_NAME] ||
+                                  lane_context[SharedValues::DEFAULT_PLATFORM])
+            build_args.push(FASTLANE_PLATFORM_TO_BUILD[fastlane_platform])
+          else
+            UI.user_error!('flutter_build action "build" parameter is not ' \
+            'specified and cannot be inferred from Fastlane context.')
+          end
+        end
+
+        if params[:debug]
+          build_args.push('--debug')
+        end
+
+        if params[:codesign] == false
+          build_args.push('--no-codesign')
+        end
+
+        if build_number = (params[:build_number] ||
+                           lane_context[SharedValues::BUILD_NUMBER])
+          build_args.push('--build-number', build_number.to_s)
+        end
+
+        if build_name = (params[:build_name] ||
+                         lane_context[SharedValues::VERSION_NUMBER])
+          build_args.push('--build-name', build_name.to_s)
+        end
+
+        Helper::FlutterHelper.flutter('build', *build_args) do |status, res|
+          if status.success?
+            if res =~ /^Built (.*?)(:? \([^)]*\))?\.$/
+              lane_context[SharedValues::FLUTTER_OUTPUT] =
+                File.absolute_path($1)
+            else
+              UI.important('Cannot parse built file path from "flutter build"')
+            end
+          else
+            # fastlane does not fail automatically if we provide a block.
+            UI.build_failure!('"flutter build" has failed')
+          end
+        end
+
+        lane_context[SharedValues::FLUTTER_OUTPUT]
+      end
+
+      def self.description
+        'Run "flutter build" to build a Flutter application'
+      end
+
+      def self.return_value
+        'A path to the built file, if available'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :build,
+            env_name: 'FL_FLUTTER_BUILD',
+            description: 'Type of Flutter build (e.g. apk, appbundle, ios)',
+            optional: true,
+            type: String,
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :debug,
+            env_name: 'FL_FLUTTER_DEBUG',
+            description: 'Build a Debug version of the app if true',
+            optional: true,
+            type: Boolean,
+            default_value: false,
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :codesign,
+            env_name: 'FL_FLUTTER_CODESIGN',
+            description: 'Set to false to skip iOS app signing. This may be ' \
+            'useful e.g. on CI or when signed later by Fastlane "sigh"',
+            optional: true,
+            type: Boolean,
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :build_number,
+            env_name: 'FL_FLUTTER_BUILD_NUMBER',
+            description: 'Override build number specified in pubspec.yaml',
+            optional: true,
+            type: Integer,
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :build_name,
+            env_name: 'FL_FLUTTER_BUILD_NAME',
+            description: <<-'DESCRIPTION',
+              Override build name specified in pubspec.yaml.
+              NOTE: for App Store, build name must be in the format of at most 3
+                    integeres separated by a dot (".").
+            DESCRIPTION
+            optional: true,
+          ),
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/flutter/actions/flutter_generate_action.rb

@@ -0,0 +1,68 @@
+require 'fastlane/action'
+require_relative '../base/flutter_action_base'
+require_relative '../helper/flutter_helper'
+require_relative '../helper/flutter_generate_intl_helper'
+require_relative '../helper/flutter_generate_build_runner_helper'
+
+module Fastlane
+  module Actions
+    class FlutterGenerateAction < Action
+      extend FlutterActionBase
+
+      def self.run(params)
+        Helper::FlutterHelper.flutter(*%w(packages get), log: false)
+
+        # In an ideal world, this should be a part of build_runner:
+        # https://github.com/dart-lang/intl_translation/issues/32
+        # Generate Intl messages before others, since these are static and
+        # others may be not.
+        if generate_translation?
+          Helper::FlutterGenerateIntlHelper.generate(
+            params[:intl_strings_file], params[:intl_strings_locale]
+          )
+        end
+
+        if Helper::FlutterHelper.dev_dependency?('build_runner')
+          UI.message('Found build_runner dependency, running build...')
+          Helper::FlutterGenerateBuildRunnerHelper.build
+        end
+      end
+
+      def self.generate_translation?
+        Helper::FlutterHelper.dev_dependency?('intl_translation')
+      end
+
+      def self.description
+        'According to package:intl, take $strings_file and generate ' \
+        '${strings_file.dirname}/arb/intl_messages.arb, then take all files ' \
+        'matching ${strings_file.dirname}/intl_*.arb, fix them and generate ' \
+        '.dart files from them'
+      end
+
+      def self.available_options
+        # https://docs.fastlane.tools/advanced/actions/#configuration-files
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :intl_strings_file,
+            env_name: 'FL_FLUTTER_INTL_STRINGS_FILE',
+            description: 'Path to source .dart file with Intl.message calls',
+            verify_block: proc do |value|
+              if generate_translation?
+                unless File.exist?(value)
+                  UI.user_error!("File `#{value}' does not exist")
+                end
+              end
+            end,
+            default_value: 'lib/intl/intl.dart',
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :intl_strings_locale,
+            env_name: 'FL_FLUTTER_INTL_STRINGS_LOCALE',
+            description: 'Locale of the default data in the strings_file',
+            optional: true,
+          ),
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/flutter/base/flutter_action_base.rb

@@ -0,0 +1,16 @@
+require 'fastlane/action'
+
+module Fastlane
+  module Actions
+    module FlutterActionBase
+      def authors
+        ['github.com/dotdoom']
+      end
+
+      def is_supported?(platform)
+        # Also support nil (root lane).
+        [nil, :ios, :android].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/flutter/helper/flutter_bootstrap_helper.rb

@@ -0,0 +1,19 @@
+require 'fastlane_core/ui/ui'
+require 'fileutils'
+
+module Fastlane
+  module Helper
+    class FlutterBootstrapHelper
+      def self.accept_licenses(licenses_directory, licenses)
+        FileUtils.mkdir_p(licenses_directory)
+        licenses.each_pair do |license, hash|
+          license_file = File.join(licenses_directory, license)
+          next if File.exist?(license_file) &&
+                  File.readlines(license_file).map(&:strip).include?(hash)
+          UI.message("Updating Android SDK license in #{license_file}...")
+          File.open(license_file, 'a') { |f| f.puts('', hash) }
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/flutter/helper/flutter_generate_build_runner_helper.rb

@@ -0,0 +1,14 @@
+require 'yaml'
+
+module Fastlane
+  module Helper
+    class FlutterGenerateBuildRunnerHelper
+      def self.build
+        Helper::FlutterHelper.flutter(
+          *%w(packages pub run build_runner build --delete-conflicting-outputs),
+          log: false,
+        )
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/flutter/helper/flutter_generate_intl_helper.rb

@@ -0,0 +1,110 @@
+require 'fileutils'
+require 'json'
+require 'set'
+require 'yaml'
+
+require_relative 'flutter_helper'
+
+module Fastlane
+  module Helper
+  end
+end
+
+class Fastlane::Helper::FlutterGenerateIntlHelper
+  def self.generate(messages_filename, messages_locale = nil)
+    dart_files_dirname = File.dirname(messages_filename)
+    arb_files_dirname = File.join(dart_files_dirname, 'arb')
+    full_arb_filename = generate_arb_from_dart(
+      messages_filename, messages_locale, arb_files_dirname
+    )
+
+    arb_filenames = amend_arb_files(arb_files_dirname, full_arb_filename)
+
+    unless messages_locale
+      # Don't generate .dart for the ARB generated from original, unless it
+      # has its own locale.
+      arb_filenames.delete(full_arb_filename)
+    end
+
+    Fastlane::UI.message('Generating .dart files from .arb...')
+    Fastlane::Helper::FlutterHelper.flutter(
+      *%W(packages pub run intl_translation:generate_from_arb
+          --output-dir=#{dart_files_dirname}
+          --no-use-deferred-loading
+          #{messages_filename}) + arb_filenames
+    )
+  end
+
+  def self.amend_arb_files(arb_files_dirname, full_arb_filename)
+    full_arb_json = JSON.parse(File.read(full_arb_filename))
+
+    # Sort files for consistency, because generated messages_all.dart will
+    # have imports ordered as in the command line below.
+    arb_filenames = Dir.glob(File.join(arb_files_dirname, 'intl_*.arb')).sort
+    arb_filenames.each do |arb_filename|
+      arb_json = JSON.parse(File.read(arb_filename))
+      if arb_filename != full_arb_filename
+        Fastlane::UI.message("Amending #{arb_filename}...")
+        full_arb_json.each_pair do |k, v|
+          # Ignore @@keys. We don't want to copy @@locale over all files, and
+          # it's often unspecified to be inferred from file name.
+          arb_json[k] ||= v unless k.start_with?('@@')
+        end
+        arb_json.keep_if { |k| full_arb_json.key?(k) }
+      end
+      File.write(arb_filename, JSON.pretty_generate(arb_json) + "\n")
+    end
+  end
+
+  def self.generate_arb_from_dart(dart_filename, dart_locale, arb_dirname)
+    arb_filename = File.join(arb_dirname, 'intl_messages.arb')
+    Fastlane::UI.message("Generating #{arb_filename} from #{dart_filename}...")
+
+    if File.exist?(arb_filename)
+      arb_file_was = File.read(arb_filename)
+    else
+      # The file may not exist on the first run. Then it's also probable that
+      # the output directory does not exist yet.
+      FileUtils.mkdir_p(arb_dirname)
+    end
+
+    extract_to_arb_options = ["--output-dir=#{arb_dirname}"]
+    if dart_locale
+      extract_to_arb_options.push("--locale=#{dart_locale}")
+    end
+
+    Fastlane::Helper::FlutterHelper.flutter(
+      *%w(packages pub run intl_translation:extract_to_arb),
+      *extract_to_arb_options, dart_filename
+    )
+
+    # intl will update @@last_modified even if there are no updates; this
+    # leaves Git directory unnecessary dirty. If that's the only change,
+    # just restore the previous contents.
+    if arb_file_was
+      if restore_last_modified(arb_filename, arb_file_was)
+        Fastlane::UI.message(
+          "@@last_modified has been restored in #{arb_filename}"
+        )
+      end
+    end
+
+    arb_filename
+  end
+
+  def self.restore_last_modified(filename, old_content)
+    new_content_tree = JSON.parse(File.read(filename))
+    old_content_tree = JSON.parse(old_content)
+    new_content_tree['@@last_modified'] = old_content_tree['@@last_modified']
+
+    # Use to_json to compare the objects deep and in consistent format.
+    if new_content_tree.to_json == old_content_tree.to_json
+      # Except for the @@last_modified attribute that we replaced
+      # above, the objects are identical. Restore previous timestamp.
+      File.write(filename, old_content)
+      return true
+    end
+
+    false
+  end
+end

data/lib/fastlane/plugin/flutter/helper/flutter_helper.rb

@@ -1,147 +1,35 @@
-require 'fastlane_core/ui/ui'
-require 'fileutils'
-require 'json'
-require 'set'
-require 'tempfile'
+require 'yaml'
 
 module Fastlane
-  # UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
-
   module Helper
     class FlutterHelper
-      def self.restore_l10n_timestamp(file_name, old_content)
-        new_content_tree = JSON.parse(File.read(file_name))
-        old_content_tree = JSON.parse(old_content)
-
-        new_content_tree['@@last_modified'] =
-          old_content_tree['@@last_modified']
-
-        # Use to_json to compare the objects deep and in consistent format.
-        if new_content_tree.to_json == old_content_tree.to_json
-          # Except for the @@last_modified attribute that we replaced
-          # above, the objects are identical. Restore previous timestamp.
-          File.write(file_name, old_content)
-          return true
-        end
-
-        false
-      end
-
-      def self.reformat_arb(file_name)
-        pretty_content = JSON.pretty_generate(JSON.parse(File.read(file_name)))
-
-        File.write(file_name, pretty_content + "\n")
-      end
-
-      def self.compare_arb(origin, sample)
-        is_significant_key = ->(key) { !key.start_with?('@') }
-
-        origin_keys = Set.new(JSON.parse(File.read(origin))
-          .keys
-          .select(&is_significant_key))
-        sample_keys = Set.new(JSON.parse(File.read(sample))
-          .keys
-          .select(&is_significant_key))
-
-        keys_not_in_sample = origin_keys - sample_keys
-        keys_not_in_origin = sample_keys - origin_keys
-
-        differencies = []
-        if keys_not_in_sample.any?
-          differencies.push("Translation string(s): " \
-                            "#{keys_not_in_sample.to_a.join(', ')}; " \
-                            "are missing")
-        end
-        if keys_not_in_origin.any?
-          differencies.push("Translation string(s): " \
-                            "#{keys_not_in_origin.to_a.join(', ')}; " \
-                            "are unused")
-        end
-        differencies
+      def self.flutter(*argv, &block)
+        # TODO(dotdoom): explain special keys in params, like "log" etc.
+        # TODO(dotdoom): most commands set "log: false", which means that the
+        #                output is lost (even in case of error). Perhaps we
+        #                could print the output here, via error_callback?
+        # https://github.com/fastlane/fastlane/blob/b1495d134eec6681c8d7a544aa3520f1da00c80e/fastlane/lib/fastlane/helper/sh_helper.rb#L73
+        Actions.sh(File.join(flutter_sdk_root, 'bin', 'flutter'), *argv, &block)
       end
 
-      def self.build_number(schema)
-        schema and Integer(schema)
-      rescue ArgumentError
-        build_number_source, build_number_base = schema.split('+', 2)
-
-        case build_number_source
-        when 'vcs'
-          build_number = Integer(
-            Actions.sh(*%w(git rev-list --count HEAD)).strip
-          )
-        when 'ci'
-          begin
-            build_number = Integer(ENV['TRAVIS_BUILD_NUMBER'] ||
-                                   ENV['CIRCLE_BUILD_NUM'])
-          rescue ArgumentError, TypeError
-            raise if ENV.key?('CI')
-            raise ArgumentError, 'CI version requested, but not running on a CI'
-          end
-        end
-
-        if build_number_base
-          build_number + Integer(build_number_base)
-        else
-          build_number
-        end
+      def self.git(*argv, &block)
+        Actions.sh('git', *argv, &block)
       end
 
-      def self.build_name(schema)
-        if schema && schema =~ /^(\^)?vcs(.*)$/
-          schema_caret = $1
-          schema_dirty_mark = $2
-          vcs_version = Actions.sh(
-            *%W(git describe --tags --dirty=#{schema_dirty_mark})
-          ).strip
-
-          # We try to match, otherwise assume vcs_version = $TAG, which means
-          # that there are 0 commits since the latest tag.
-          if schema_caret && vcs_version =~ /^
-                  (\d+[.]\d+)-
-                  (\d+)-
-                  g.*?
-                  (#{Regexp.quote(schema_dirty_mark)})?
-                $/x
-
-            vcs_version = "#{$1}.#{$2}"
-            # Making the best guess whether it's dirty.
-            if $3
-              vcs_version += schema_dirty_mark
-            end
+      def self.flutter_sdk_root
+        @flutter_sdk_root ||= File.expand_path(
+          if ENV.include?('FLUTTER_SDK_ROOT')
+            ENV['FLUTTER_SDK_ROOT']
+          elsif flutter_binary = FastlaneCore::CommandExecutor.which('flutter')
+            File.dirname(File.dirname(flutter_binary))
+          else
+            'vendor/flutter'
           end
-
-          vcs_version
-        else
-          schema
-        end
+        )
       end
 
-      # Bootstrap Flutter application for build with Android SDK:
-      # https://github.com/flutter/flutter/issues/28076
-      def self.bootstrap_android(licenses = {})
-        # Gradle will refuse to install Android SDK unless the SDK directory
-        # exists and licenses are accepted.
-        licenses_directory = File.join(android_sdk_root!, 'licenses')
-        FileUtils.mkdir_p(licenses_directory)
-        if licenses.any?
-          licenses.each_pair do |license, hash|
-            license_file = File.join(licenses_directory, license)
-            unless File.exist?(license_file) &&
-                   File.readlines(license_file).map(&:strip).include?(hash)
-              File.open(license_file, 'a') { |f| f.puts('', hash) }
-            end
-          end
-        end
-      end
-
-      def self.android_sdk_root!
-        (ENV['ANDROID_HOME'] || ENV['ANDROID_SDK_ROOT']).tap do |path|
-          unless path
-            raise 'Android SDK directory environment variables are not set. ' \
-              'See https://developer.android.com/studio/command-line/variables'
-          end
-        end
+      def self.dev_dependency?(package)
+        (YAML.load_file('pubspec.yaml')['dev_dependencies'] || {}).key?(package)
       end
     end
   end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Flutter
-    VERSION = "0.2.7"
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-flutter
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Artem Sheremet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-24 00:00:00.000000000 Z
+date: 2019-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -146,6 +146,13 @@ files:
 - README.md
 - lib/fastlane/plugin/flutter.rb
 - lib/fastlane/plugin/flutter/actions/flutter_action.rb
+- lib/fastlane/plugin/flutter/actions/flutter_bootstrap_action.rb
+- lib/fastlane/plugin/flutter/actions/flutter_build_action.rb
+- lib/fastlane/plugin/flutter/actions/flutter_generate_action.rb
+- lib/fastlane/plugin/flutter/base/flutter_action_base.rb
+- lib/fastlane/plugin/flutter/helper/flutter_bootstrap_helper.rb
+- lib/fastlane/plugin/flutter/helper/flutter_generate_build_runner_helper.rb
+- lib/fastlane/plugin/flutter/helper/flutter_generate_intl_helper.rb
 - lib/fastlane/plugin/flutter/helper/flutter_helper.rb
 - lib/fastlane/plugin/flutter/version.rb
 homepage: https://github.com/dotdoom/fastlane-plugin-flutter