cocoapods-embed-flutter 0.5.0

data/lib/cocoapods-embed-flutter/flutter/external_sources.rb

@@ -0,0 +1,201 @@
+# Similar to:
+# https://github.com/CocoaPods/CocoaPods/blob/master/lib/cocoapods/external_sources/abstract_external_source.rb
+require 'cocoapods-embed-flutter/flutter/downloader'
+require 'cocoapods'
+
+module Flutter
+  module Pub
+    module ExternalSources
+      SOURCE_KEYS = {
+        :git  => [:tag, :branch, :commit, :submodules].freeze,
+        :svn  => [:folder, :tag, :revision].freeze,
+        :hg   => [:revision].freeze,
+        :http => [:flatten, :type, :sha256, :sha1, :headers].freeze,
+      }.freeze
+
+      # Returns the path to `pubspec` with the given name and location to search.
+      #
+      # @param    [String] name
+      #           the name of the project declared in `pubspec`.
+      #
+      # @param    [Hash] options
+      #           requirement opttions for the source of project.
+      #
+      # @note       the source of project can either be local or all the remotes
+      #             supported by `cocoapods-downloader`.
+      #
+      # @return   [Spec] the `pubspec` with the given name satisfying
+      #           requirement options.
+      #
+      def self.fetchWithNameAndOptions(name, options)
+        raise StandardError, 'A flutter module requires a name.' unless name
+
+        options = options.last if options.is_a?(Array)
+        raise StandardError, "No options specified for flutter module: '#{name}'." unless options.is_a?(Hash)
+
+        if options.key?(:path)
+          path = options[:path]
+        elsif SOURCE_KEYS.keys.any? { |key| options.key?(key) }
+          source = DownloaderSource.new(name, options, Pod::Config.instance.podfile_path)
+          source.fetch(Pod::Config.instance.sandbox)
+          path = source.normalized_pupspec_path
+        else
+          raise StandardError, "Invalid flutter module: '#{name}'."
+        end
+
+        return Spec.find(name, path)
+      end
+
+      # Provides support for fetching a specification file from a source handled
+      # by the downloader. Supports all the options of the downloader
+      #
+      # @note The pubspec must be in the root of the repository 
+      #       or in directory with the name provided 
+      #
+      class DownloaderSource
+        # @return [String] the name of the Package described by this external source.
+        #
+        attr_reader :name
+
+        # @return [Hash{Symbol => String}] the hash representation of the
+        #         external source.
+        #
+        attr_reader :params
+
+        # @return [String] the path where the podfile is defined to resolve
+        #         relative paths.
+        #
+        attr_reader :podfile_path
+
+        # @return [Boolean] Whether the source is allowed to touch the cache.
+        #
+        attr_reader :can_cache
+        alias_method :can_cache?, :can_cache
+
+        # Initialize a new instance
+        #
+        # @param [String] name @see #name
+        # @param [Hash] params @see #params
+        # @param [String] podfile_path @see #podfile_path
+        # @param [Boolean] can_cache @see #can_cache
+        #
+        def initialize(name, params, podfile_path, can_cache = true)
+          @name = name
+          @params = params
+          @podfile_path = podfile_path
+          @can_cache = can_cache
+        end
+
+        # @return [Boolean] whether an external source source is equal to another
+        #         according to the {#name} and to the {#params}.
+        #
+        def ==(other)
+          return false if other.nil?
+          name == other.name && params == other.params
+        end
+
+
+        public
+
+        # @!group Subclasses hooks
+
+        # Fetches the external source from the remote according to the params.
+        #
+        # @param  [Sandbox] sandbox
+        #         the sandbox where the specification should be stored.
+        #
+        # @return [void]
+        #
+        def fetch(sandbox)
+          pre_download(sandbox)
+        end
+
+        # @return [String] a string representation of the source suitable for UI.
+        #
+        def description
+          strategy = Pod::Downloader.strategy_from_options(params)
+          options = params.dup
+          url = options.delete(strategy)
+          result = "from `#{url}`"
+          options.each do |key, value|
+            result << ", #{key} `#{value}`"
+          end
+          result
+        end
+
+        # Return the normalized path for a pubspec for a relative declared path.
+        #
+        # @param  [String] declared_path
+        #         The path declared in the podfile.
+        #
+        # @return [String] The uri of the pubspec appending the name of the file
+        #         and expanding it if necessary.
+        #
+        # @note   If the declared path is expanded only if the represents a path
+        #         relative to the file system.
+        #
+        def normalized_pupspec_path(declared_path)
+          Spec.find_file(name, declared_path)
+        end
+
+        def normalized_pupspec_path
+          Spec.find_file(name, target)
+        end
+
+        private
+
+        # @! Subclasses helpers
+
+        # Pre-downloads a Pod passing the options to the downloader and informing
+        # the sandbox.
+        #
+        # @param  [Sandbox] sandbox
+        #         The sandbox where the Pod should be downloaded.
+        #
+        # @note   To prevent a double download of the repository the pod is
+        #         marked as pre-downloaded indicating to the installer that only
+        #         clean operations are needed.
+        #
+        # @todo  The downloader configuration is the same of the
+        #        #{PodSourceInstaller} and it needs to be kept in sync.
+        #
+        # @return [void]
+        #
+        def pre_download(sandbox)
+          title = "Pre-downloading: `#{name}` #{description}"
+          Pod::UI.titled_section(title,  :verbose_prefix => '-> ') do
+            begin
+              download_result = Downloader.download(download_request, target, :can_cache => can_cache)
+            rescue Pod::DSLError => e
+              raise Pod::Informative, "Failed to load '#{name}' pubspec: #{e.message}"
+            rescue => e
+              raise Pod::Informative, "Failed to download '#{name}': #{e.message}"
+            end
+
+            # spec = download_result.spec
+            # raise Pod::Informative, "Unable to find a specification for '#{name}'." unless spec
+
+            # since the podspec might be cleaned, we want the checksum to refer
+            # to the json in the sandbox
+            # spec.defined_in_file = nil
+
+            # store_podspec(sandbox, spec)
+            # sandbox.store_pre_downloaded_pod(name)
+            # sandbox.store_checkout_source(name, download_result.checkout_options)
+          end
+        end
+
+        def download_request
+          Pod::Downloader::Request.new(
+            :name => name,
+            :params => params,
+          )
+        end
+
+        def target
+          return Pod::Config.instance.sandbox.pod_dir(name)
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods-embed-flutter/flutter/pubspec.rb

@@ -0,0 +1,166 @@
+require 'cocoapods-embed-flutter/flutter/dependency'
+require 'yaml'
+
+module Flutter
+  NAME = 'flutter'.freeze
+  DIR_NAME = 'Flutter'.freeze
+
+  module Pub
+    SPEC_FILE = 'pubspec.yaml'.freeze
+    TOOL_DIR = '.dart_tool'.freeze
+    CACHE_FILE = 'package_config.json'.freeze
+
+    # The Specification provides a DSL to describe a flutter project.
+    # A project is defined as a library originating from a source.
+    # A specification can support detailed attributes for modules of code
+    # through dependencies.
+    #
+    # Usually it is stored in `pubspec.yaml` file.
+    #
+    class Spec
+      # @return [String] the path where the specification is defined, if loaded
+      #         from a file.
+      #
+      attr_reader :defined_in_file
+
+      # @param  [String] path
+      #         the path to the specification.
+      #
+      def initialize(path)
+        @data = YAML.load_file path
+        @defined_in_file = path
+      end
+
+      # Returns the path to `pubspec` with the given name and location to search.
+      #
+      # @param    [String] name
+      #           the name of the project declared in `pubspec`.
+      #
+      # @param    [String] path
+      #           where project or pubspec is located.
+      #
+      # @note       either the flutter module or the `pubspec` of the flutter module
+      #             can be in the path. Optionally you can provide the `pubspec`
+      #             file directly.
+      #
+      # @return   [String] path to the `pubspec` with the given name if present.
+      #
+      def self.find_file(name, path)
+        path = File.expand_path(path, Dir.pwd)
+
+        if File.basename(path) == Pub::SPEC_FILE
+          return path
+        elsif Dir.exists?(File.expand_path(name, path)) && File.exists?(File.expand_path(Pub::SPEC_FILE, File.expand_path(name, path)))
+          return File.expand_path(Pub::SPEC_FILE, File.expand_path(name, path))
+        elsif File.exists?(File.expand_path(Pub::SPEC_FILE, path))
+          return File.expand_path(Pub::SPEC_FILE, path)
+        else
+          return nil
+        end
+      end
+
+      # Returns the path to `pubspec` with the given name and location to search.
+      #
+      # @param    [String] name
+      #           the name of the project declared in `pubspec`.
+      #
+      # @param    [String] path
+      #           where project or pubspec is located.
+      #
+      # @note       either the flutter module or the `pubspec` of the flutter module
+      #             can be in the path. Optionally you can provide the `pubspec`
+      #             file directly.
+      #
+      # @return   [Spec] the `pubspec` with the given name if present.
+      #
+      def self.find(name, path)
+        pubspec_path = find_file(name, path)
+        raise StandardError, "Invalid path: '#{path}' for flutter module: '#{name}'." unless pubspec_path
+        pubspec = Spec.new(pubspec_path)
+        raise StandardError, "Invalid path: '#{path}' for flutter module: '#{name}'." unless pubspec.name == name
+        return pubspec
+      end
+
+      # @return [Boolean] If this specification is a module specification.
+      #
+      def module?
+        return false unless @data.include?(Flutter::NAME)
+        return @data[Flutter::NAME].is_a?(Hash) && @data[Flutter::NAME].include?('module')
+      end
+
+      # @return [String] the path to the flutter project.
+      #
+      def project_path
+        File.dirname(defined_in_file)
+      end
+
+      # @return [String] the path to the flutter project
+      # dependencies cache file.
+      #
+      def package_cache_path
+        File.join(project_path, Pub::TOOL_DIR, Pub::CACHE_FILE)
+      end
+
+      # @return [String] the path to the flutter project.
+      #
+      def pod_helper_path
+        File.join(project_path, '.ios', Flutter::DIR_NAME, 'podhelper.rb') if module?
+      end
+
+      # @return [Array<Dependency>] the list of all the projects this
+      # specification depends upon and are included in app release.
+      #
+      def dependencies
+        return [] unless @data.include?('dependencies')
+        Dependency.create_from_hash(@data['dependencies'], self)
+      end
+
+      # @return [Array<Dependency>] the list of all the projects this
+      #         specification depends upon only during development.
+      #
+      def dev_dependencies
+        return [] unless @data.include?('dev_dependencies')
+        Dependency.create_from_hash(@data['dev_dependencies'], self)
+      end
+
+      # @return [Array<Dependency>] the list of all the projects this
+      #         specification depends upon.
+      #
+      def all_dependencies
+        dependencies + dev_dependencies
+      end
+
+      # @return [Boolean] If the flutter project for this specification
+      # has all its dependencies installed.
+      #
+      def setup?
+        File.exists?(package_cache_path) && (!module? || File.exists?(pod_helper_path))
+      end
+
+      # Sets up the project installing all specified dependencies.
+      #
+      # @return void
+      #
+      def setup
+        return if setup?
+        pup_get
+        all_dependencies.each(&:install)
+      end
+
+      # Runs `flutter pub get` on project directory.
+      #
+      # @return void
+      #
+      def pup_get
+        Dir.chdir(project_path) { |path| system('flutter pub get', exception: true) }
+      end
+
+      def method_missing(m, *args, &block)
+        if @data.include?(m.to_s)
+          return @data[m.to_s]
+        end
+        super.method_missing(m, *args, &block)
+      end
+    end
+  end
+end

data/lib/cocoapods-embed-flutter/gem_version.rb

@@ -0,0 +1,3 @@
+module CocoapodsEmbedFlutter
+  VERSION = '0.5.0'.freeze
+end

data/lib/cocoapods-embed-flutter/hooks/post_install.rb

@@ -0,0 +1,8 @@
+module CocoapodsEmbedFlutter
+  # Registers for CocoaPods plugin hooks
+  module Hooks
+    Pod::HooksManager.register('cocoapods-embed-flutter', :post_install) do |installer, options|
+      # Do nothing
+    end
+  end
+end

data/lib/cocoapods-embed-flutter/hooks.rb

@@ -0,0 +1 @@
+require 'cocoapods-embed-flutter/hooks/post_install'

data/lib/cocoapods-embed-flutter/source.rb

@@ -0,0 +1 @@
+require 'cocoapods-embed-flutter/src/pub'

data/lib/cocoapods-embed-flutter/src/pub.rb

@@ -0,0 +1,114 @@
+require 'cocoapods-embed-flutter/gem_version'
+require 'cocoapods-embed-flutter/flutter/pubspec'
+require 'cocoapods-embed-flutter/flutter/external_sources'
+
+module Pod
+  class Podfile
+    # The Podfile is a specification that describes the dependencies of the
+    # targets of one or more Xcode projects. With Embed Flutter
+    # it is possible to declare flutter module as dependency
+    #
+    # A Podfile can be very simple:
+    #
+    #     target 'MyApp'
+    #     pub 'flutter_module', :path => '../'
+    #
+    # An example of a more complex Podfile can be:
+    #
+    #     platform :ios, '9.0'
+    #     inhibit_all_warnings!
+    #
+    #     target 'MyApp' do
+    #       pub 'flutter_module', :path => '../'
+    #     end
+    #
+    #     target 'MyAppTests' do
+    #       pub 'flutter_module_test', :path => '../'
+    #     end
+    #
+    #     post_install do |installer|
+    #       installer.pods_project.targets.each do |target|
+    #         puts "#{target.name}"
+    #       end
+    #     end
+    #
+    #
+    # @note       Currently only one flutter module per target is
+    #             supported.
+    #
+    module DSL
+      # Specifies a flutter module dependency of the project.
+      #
+      # A dependency requirement is defined by the name of the module and
+      # optionally a list of requirements.
+      #
+      #
+      # ### Using the files from a local path.
+      #
+      #  If you would like to use develop a flutter module in tandem with
+      #  its client project you can use the `path` option.
+      #
+      #     pub 'flutter_module', :path => '../'
+      #
+      #  Using this option Embed Flutter will assume the given folder
+      #  to be the root of the flutter module or the root of flutter module `pubspec` file
+      #  or points to the `pubspec` file itself and will link the files directly from there
+      #  in the Pods project. This means that your edits will persist to
+      #  CocoaPods installations.
+      #
+      #  The referenced folder can be a checkout of your your favourite SCM or
+      #  even a git submodule of the current repository.
+      #
+      #  Note that either the flutter module or the `pubspec` of the flutter module
+      #  can be in the folder. Optionally you can provide the `pubspec` file directly.
+      #
+      #
+      # ### From a flutter module in the root of a library repository.
+      #
+      # Sometimes you may want to use the bleeding edge version of a module. Or a
+      # specific revision. If this is the case, you can specify that with your
+      # pub declaration.
+      #
+      # To use the `master` or `main` branch of the repository:
+      #
+      #     pub 'flutter_module', :git => 'https://github.com/octokit/flutter_module.git'
+      #
+      #
+      # To use a different branch of the repository:
+      #
+      #     pub 'flutter_module', :git => 'https://github.com/octokit/flutter_module.git', :branch => 'dev'
+      #
+      #
+      # To use a tag of the repository:
+      #
+      #     pub 'flutter_module', :git => 'https://github.com/octokit/flutter_module.git', :tag => '0.7.0'
+      #
+      #
+      # Or specify a commit:
+      #
+      #     pub 'flutter_module', :git => 'https://github.com/octokit/flutter_module.git', :commit => '082f8319af'
+      #
+      # The flutter module or its `pubspec` file is expected to be in the
+      # root of the repository.
+      #
+      #
+      # @note       This method allow a nil name and the raises to be more
+      #             informative.
+      #
+      # @return     [void]
+      #
+      def pub(name = nil, *requirements)
+        pubspec = Flutter::Pub::ExternalSources.fetchWithNameAndOptions(name, requirements)
+        pubspec.setup
+        raise StandardError, "Invalid flutter module: '#{name}'." unless File.exists?(pubspec.pod_helper_path)
+        install_flutter_pods_for_pubspec(pubspec)
+      end
+
+      def install_flutter_pods_for_pubspec(pubspec)
+        raise ArgumentError, "Invalid `pubspec` argument." unless pubspec.is_a?(Flutter::Pub::Spec)
+        load pubspec.pod_helper_path
+        install_all_flutter_pods(pubspec.project_path)
+      end
+    end
+  end
+end

data/lib/cocoapods-embed-flutter.rb

@@ -0,0 +1,3 @@
+require 'cocoapods-embed-flutter/gem_version'
+require 'cocoapods-embed-flutter/source'
+require 'cocoapods-embed-flutter/hooks'

data/lib/cocoapods_plugin.rb

@@ -0,0 +1 @@
+require 'cocoapods-embed-flutter'

data/spec/info_spec.rb

@@ -0,0 +1,7 @@
+require_relative 'spec_helper'
+
+describe 'Plugin info test' do
+  it 'checks name' do
+    ''.should.equal ''
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$:.unshift((ROOT + 'lib').to_s)
+$:.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'bacon'
+require 'mocha-on-bacon'
+require 'pretty_bacon'
+require 'pathname'
+require 'cocoapods'
+
+Mocha.configure { |c| c.stubbing_non_existent_method = :prevent }
+
+require 'cocoapods_plugin'
+
+#-----------------------------------------------------------------------------#
+
+module Pod
+
+  # Disable the wrapping so the output is deterministic in the tests.
+  #
+  UI.disable_wrap = true
+
+  # Redirects the messages to an internal store.
+  #
+  module UI
+    @output = ''
+    @warnings = ''
+
+    class << self
+      attr_accessor :output
+      attr_accessor :warnings
+
+      def puts(message = '')
+        @output << "#{message}\n"
+      end
+
+      def warn(message = '', actions = [])
+        @warnings << "#{message}\n"
+      end
+
+      def print(message)
+        @output << message
+      end
+    end
+  end
+end
+
+#-----------------------------------------------------------------------------#