cocoapods-embed-flutter 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 471eb33cb4b395feb321e162537e6f2bc5edd026ce7460842c446fd22f6daecc
-  data.tar.gz: 4f12be7ae404447c898e4602cd7ce70191c7e18c55fa62308ccfaf3ffc2b23c0
+  metadata.gz: 2a64be69df26a945c384cd9c91456396a1dae3542120763103cea1ea95906c62
+  data.tar.gz: 379fd07871bf85cddaf9f3287d08d92e5ef82a31502a81929f14804de9744db6
 SHA512:
-  metadata.gz: 70cabc00a991ab2d31a09428bdf14a9f1d6f2a3640065ca56f36ed630ff867228c666767de4300a1dc4d0679b65556beff82bc314728cb468d5432a6e75ab1e2
-  data.tar.gz: 1715cc8592d8fe62f4e99314c98c18f2430647a1403a39dea6df732e17248e2a677ceae42f65a2c24f3d179aba86a69b6f72dc6c775fa82e270cf529be20a162
+  metadata.gz: 81f87e0aa277b5eedbd585a6db5c026f08a06913f24e11a3037ffe5226a2bdccdac5c96339fa5cfde605896a276708ee8ce0d89ffe47769aa584ed211e0b25d6
+  data.tar.gz: 29648b77e626389b0a41e8f4548797935d9ce98638ac267dc41594652518ad69e2b22a4a4f353e2a35781b3e25133a16d9b43682d87c355fe1b82b7e140c48b6

data/.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "castwide.solargraph",
+    "rebornix.ruby"
+  ]
+}

data/CHANGELOG.md

@@ -1,3 +1,45 @@
+## [0.6.0](https://github.com/DartBuild/cocoapods-embed-flutter/compare/v0.5.3...v0.6.0) (2022-03-27)
+
+
+### 📚 Documentation
+
+* **README:** add pub.dev limitation ([8f955f3](https://github.com/DartBuild/cocoapods-embed-flutter/commit/8f955f36519b1e5eeac89ffebd660a5f84f9983b))
+
+
+### 🛠 Dependency
+
+* bump cocoapods from 1.11.2 to 1.11.3 ([#4](https://github.com/DartBuild/cocoapods-embed-flutter/issues/4)) ([152737d](https://github.com/DartBuild/cocoapods-embed-flutter/commit/152737dd77852ef6937b5f458019e6535a426755))
+
+
+### 💄 Styles
+
+* add vscode extensions recommendation ([4f021fb](https://github.com/DartBuild/cocoapods-embed-flutter/commit/4f021fbfa75dd58d1257c43ea3d19cb68b8a19e6))
+
+
+### 🚀 Features
+
+* allow specifying different path for remote sources ([bc9c850](https://github.com/DartBuild/cocoapods-embed-flutter/commit/bc9c8509f90ef88248b56361794b6f8f1182a082))
+
+### [0.5.3](https://github.com/DartBuild/cocoapods-embed-flutter/compare/v0.5.2...v0.5.3) (2022-03-18)
+
+
+### 📚 Documentation
+
+* **README:** add limitations ([9133edc](https://github.com/DartBuild/cocoapods-embed-flutter/commit/9133edc006973892b2e55ef13a30f6ae8e8b7ad4))
+
+### [0.5.2](https://github.com/DartBuild/cocoapods-embed-flutter/compare/v0.5.1...v0.5.2) (2022-03-12)
+
+
+### 📚 Documentation
+
+* add helpful links and badges ([4ab6983](https://github.com/DartBuild/cocoapods-embed-flutter/commit/4ab69837d5057a0049e1533a00c6209556aec5b0))
+
+
+### 💡 Continuous Integration
+
+* **Deps:** bump actions/checkout from 2 to 3 ([#2](https://github.com/DartBuild/cocoapods-embed-flutter/issues/2)) ([3d1ca07](https://github.com/DartBuild/cocoapods-embed-flutter/commit/3d1ca0732a87e04561bc68ba1bbfc337173cd783))
+* **Deps:** bump actions/setup-node from 2 to 3 ([#3](https://github.com/DartBuild/cocoapods-embed-flutter/issues/3)) ([efd8f1a](https://github.com/DartBuild/cocoapods-embed-flutter/commit/efd8f1a82ce8ca6cd12adc1e5ca943a316a44b03))
+
 ### [0.5.1](https://github.com/DartBuild/cocoapods-embed-flutter/compare/v0.5.0...v0.5.1) (2022-03-11)
 
 

data/Gemfile

@@ -12,4 +12,5 @@ group :development do
   gem 'bacon'
   gem 'mocha-on-bacon'
   gem 'prettybacon'
+  gem 'solargraph'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocoapods-embed-flutter (0.5.0)
+    cocoapods-embed-flutter (0.6.0)
       cocoapods
       fileutils
       yaml
@@ -22,13 +22,16 @@ GEM
     algoliasearch (1.27.5)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
+    ast (2.4.2)
     atomos (0.1.3)
+    backport (1.2.0)
     bacon (1.2.0)
+    benchmark (0.2.0)
     claide (1.1.0)
-    cocoapods (1.11.2)
+    cocoapods (1.11.3)
       addressable (~> 2.8)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.11.2)
+      cocoapods-core (= 1.11.3)
       cocoapods-deintegrate (>= 1.0.3, < 2.0)
       cocoapods-downloader (>= 1.4.0, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -43,7 +46,7 @@ GEM
       nap (~> 1.0)
       ruby-macho (>= 1.0, < 3.0)
       xcodeproj (>= 1.21.0, < 2.0)
-    cocoapods-core (1.11.2)
+    cocoapods-core (1.11.3)
       activesupport (>= 5.0, < 7)
       addressable (~> 2.8)
       algoliasearch (~> 1.0)
@@ -66,6 +69,8 @@ GEM
     concurrent-ruby (1.1.9)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.5.0)
+    e2mmap (0.1.0)
     escape (0.0.4)
     ethon (0.15.0)
       ffi (>= 1.15.0)
@@ -107,8 +112,13 @@ GEM
     httpclient (2.8.3)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
     json (2.6.1)
     jwt (2.3.0)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     minitest (5.15.0)
     mocha (1.13.0)
     mocha-on-bacon (0.2.3)
@@ -120,25 +130,70 @@ GEM
     nanaimo (0.3.0)
     nap (1.1.0)
     netrc (0.11.0)
+    nokogiri (1.13.3-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.3-x86_64-linux)
+      racc (~> 1.4)
     oauth2 (1.4.9)
       faraday (>= 0.17.3, < 3.0)
       jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
     prettybacon (0.0.2)
       bacon (~> 1.2)
     public_suffix (4.0.6)
+    racc (1.6.0)
     rack (2.2.3)
+    rainbow (3.1.1)
     rake (13.0.6)
+    regexp_parser (2.2.1)
+    reverse_markdown (2.1.1)
+      nokogiri
     rexml (3.2.5)
+    rubocop (1.26.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
     ruby-macho (2.5.1)
+    ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
+    solargraph (0.44.3)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.2.1)
     thread_safe (0.3.6)
+    tilt (2.0.10)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
     xcodeproj (1.21.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
@@ -147,6 +202,8 @@ GEM
       nanaimo (~> 0.3.0)
       rexml (~> 3.2.4)
     yaml (0.2.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
     zeitwerk (2.5.4)
 
 PLATFORMS
@@ -165,6 +222,7 @@ DEPENDENCIES
   mocha-on-bacon
   prettybacon
   rake
+  solargraph
 
 BUNDLED WITH
    2.3.7

data/README.md

@@ -1,16 +1,22 @@
 # cocoapods-embed-flutter
 
+[![CI/CD](https://github.com/DartBuild/cocoapods-embed-flutter/actions/workflows/main.yml/badge.svg?branch=main&event=push)](https://github.com/DartBuild/cocoapods-embed-flutter/actions/workflows/main.yml)
 [![Gem Version](https://badge.fury.io/rb/cocoapods-embed-flutter.svg)](http://badge.fury.io/rb/cocoapods-embed-flutter)
-<!--- [![Code Climate](https://codeclimate.com/github/DartBuild/cocoapods-embed-flutter.png)](https://codeclimate.com/github/DartBuild/cocoapods-embed-flutter) -->
+[![Code Climate](https://codeclimate.com/github/DartBuild/cocoapods-embed-flutter.png)](https://codeclimate.com/github/DartBuild/cocoapods-embed-flutter)
 
 Straight forward way of declaring flutter modules as dependency for targets, just like cocoapods does with pods.
 
 ## Installation
 
+### Install using command line.
 ```bash
 $ [sudo] gem install cocoapods-embed-flutter
 ```
 
+### Or add this to your `Gemfile`.
+```rb
+gem 'cocoapods-embed-flutter'
+```
 ## Usage
 
 In your host project `Podfile`, write the below line before any target definition
@@ -24,6 +30,7 @@ plugin 'cocoapods-embed-flutter'
 pub 'flutter_module', :path => '../'
 ```
 
+<a name="path_desc"></a>
 *`:path` can be path pointing to `pubspec.yaml` or to the directory containing `pubspec.yaml` or to the directory containg flutter module.*
 
 ### Embedding module from a repository.
@@ -33,3 +40,24 @@ pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :
 pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :tag => '0.7.0'
 pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :commit => '082f8319af'
 ```
+
+*flutter module project should be at the root of repository, if that's not the case add additional `:path` attribute for relative path to flutter project in repository. `:path` follows [these](#path_desc) restictions.*
+
+```rb
+pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :tag => '0.7.0', :path => 'relative path/to/project'
+```
+
+## Limitations
+
+- Modules hosted in [pub.dev](https://pub.dev/) are not supported, only local modules and modules in remote sources like git are supported.
+- You won't be able to add more than one flutter module to a single target. Currently flutter only supports one module per target.
+- No caching is done for external sources, every time you run `pod install` flutter module will be downloaded each time.
+
+## Links
+
+| Link | Description |
+| :----- | :------ |
+[Gem page](https://rubygems.org/gems/cocoapods-embed-flutter) | Official Ruby Gems page.
+[Code docs](https://www.rubydoc.info/gems/cocoapods-embed-flutter) | Generated code documentation.
+[Changelog](https://github.com/DartBuild/cocoapods-embed-flutter/blob/main/CHANGELOG.md) | See the changes introduced in each version.
+[Code of Conduct](CODE_OF_CONDUCT.md) | Find out the standards we hold ourselves to.

data/Rakefile

@@ -4,6 +4,16 @@ def specs(dir)
   FileList["spec/#{dir}/*_spec.rb"].shuffle.join(' ')
 end
 
+def setup_project(pod_install = false)
+  system('bundle install', exception: true)
+  Bundler.with_unbundled_env do
+    Dir.chdir('example/ios_app') do |path|
+      system('bundle install', exception: true)
+      system('bundle exec pod install', exception: true) if pod_install
+    end
+  end
+end
+
 desc 'Runs all the specs'
 task :specs do
   sh "bundle exec bacon #{specs('**')}"
@@ -11,13 +21,12 @@ end
 
 desc 'Setup example project'
 task :demo do
-  system('bundle install', exception: true)
-  Bundler.with_clean_env do
-    Dir.chdir('example/ios_app') do |path|
-      system('bundle install', exception: true)
-      system('bundle exec pod install', exception: true)
-    end
-  end
+  setup_project(true)
+end
+
+desc 'Update lock files'
+task :update do
+  setup_project
 end
 
 desc 'Publish to cocoapods plugins if not present'
@@ -31,7 +40,9 @@ task :publish do
   return if known_plugins.one? { |plugin| plugin['gem'] == gem.name }
 
   require 'github_api'
-  return if Github.search.issues(q: "#{gem.name} user:CocoaPods repo:CocoaPods/cocoapods-plugins in:title").items.count > 0
+  return if Github.search.issues(
+    q: "#{gem.name} user:CocoaPods repo:CocoaPods/cocoapods-plugins in:title"
+  ).items.count > 0
   system('pod plugins publish', exception: true)
 end
 

data/cocoapods-embed-flutter.gemspec

@@ -9,28 +9,29 @@ Gem::Specification.new do |spec|
 
   spec.name          = 'cocoapods-embed-flutter'
   spec.version       = CocoapodsEmbedFlutter::VERSION
-  spec.authors       = ['Soumya Ranjan Mahunt']
-  spec.email         = ['devsoumyamahunt@gmail.com']
-  spec.description   = %q{Embed flutter modules in iOS projects.}
-  spec.summary       = <<-DESC
-  Straight forward way of declaring flutter modules as dependency for targets,
-  just like cocoapods does with pods.
-                         DESC
   spec.homepage      = repo_url
   spec.license       = 'MIT'
+  spec.authors       = ['Soumya Ranjan Mahunt']
+  spec.email         = ['devsoumyamahunt@gmail.com']
+  spec.summary       = %q{Embed flutter modules in iOS projects.}
+  spec.description   = <<-EOF
+    Straight forward way of declaring flutter modules as dependency for targets,
+    just like cocoapods does with pods.
+  EOF
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($/).grep_v(%r{^(example|.github)/})
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'yaml'
-  spec.add_dependency 'fileutils'
-  spec.add_dependency 'cocoapods'
+  spec.add_runtime_dependency 'yaml'
+  spec.add_runtime_dependency 'fileutils'
+  spec.add_runtime_dependency 'cocoapods'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
 
+  spec.required_ruby_version = '>= 2.6'
   spec.metadata = {
     'bug_tracker_uri'   => "#{repo_url}/issues",
     'changelog_uri'     => "#{repo_url}/blob/main/CHANGELOG.md",

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

@@ -38,12 +38,12 @@ module Flutter
         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) }
+        if 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
+        elsif options.key?(:path)
+          path = options[:path]
         else
           raise StandardError, "Invalid flutter module: '#{name}'."
         end
@@ -116,8 +116,8 @@ module Flutter
         # @return [String] a string representation of the source suitable for UI.
         #
         def description
-          strategy = Pod::Downloader.strategy_from_options(params)
-          options = params.dup
+          strategy = Pod::Downloader.strategy_from_options(download_params)
+          options = download_params.dup
           url = options.delete(strategy)
           result = "from `#{url}`"
           options.each do |key, value|
@@ -148,7 +148,8 @@ module Flutter
         #         and expanding it if necessary.
         #
         def normalized_pupspec_path
-          Spec.find_file(name, target)
+          search_path = params[:path].nil? ? target : File.expand_path(params[:path], target)
+          Spec.find_file(name, search_path)
         end
 
         private
@@ -203,10 +204,16 @@ module Flutter
         def download_request
           Pod::Downloader::Request.new(
             :name => name,
-            :params => params,
+            :params => download_params,
           )
         end
 
+        # @return [Hash] the options for remote source download.
+        #
+        def download_params
+          params.select { |key, value| !key.equal?(:path) }
+        end
+
         # @return [String] the path where this flutter project
         #         will be downloaded relative paths.
         #

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

@@ -4,5 +4,5 @@
 module CocoapodsEmbedFlutter
   # The version of the cocoapods-embed-flutter.
   #
-  VERSION = '0.5.1'.freeze
+  VERSION = '0.6.0'.freeze
 end

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

@@ -99,7 +99,10 @@ module Pod
       #     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.
+      # root of the repository, if that's not the case specify relative path
+      # to flutter project in repository.
+      #
+      #     pub 'flutter_module', :git => 'https://github.com/octokit/flutter_module.git', :tag => '0.7.0', :path => 'custom/flutter_module'
       #
       #
       # @note       This method allow a nil name and the raises to be more

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-embed-flutter
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Soumya Ranjan Mahunt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaml
@@ -80,20 +80,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Embed flutter modules in iOS projects.
+description: |2
+      Straight forward way of declaring flutter modules as dependency for targets,
+      just like cocoapods does with pods.
 email:
 - devsoumyamahunt@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/config/config.js"
-- ".github/config/package-lock.json"
-- ".github/config/package.json"
-- ".github/config/pre_changelog_hook.js"
-- ".github/dependabot.yml"
-- ".github/workflows/main.yml"
 - ".gitignore"
+- ".vscode/extensions.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -102,27 +99,6 @@ files:
 - README.md
 - Rakefile
 - cocoapods-embed-flutter.gemspec
-- example/flutter_module/.gitignore
-- example/flutter_module/.metadata
-- example/flutter_module/README.md
-- example/flutter_module/analysis_options.yaml
-- example/flutter_module/flutter_module.iml
-- example/flutter_module/flutter_module_android.iml
-- example/flutter_module/lib/main.dart
-- example/flutter_module/pubspec.lock
-- example/flutter_module/pubspec.yaml
-- example/flutter_module/test/widget_test.dart
-- example/ios_app/Gemfile
-- example/ios_app/Gemfile.lock
-- example/ios_app/Podfile
-- example/ios_app/Podfile.lock
-- example/ios_app/ios_app.xcodeproj/project.pbxproj
-- example/ios_app/ios_app/Assets.xcassets/AccentColor.colorset/Contents.json
-- example/ios_app/ios_app/Assets.xcassets/AppIcon.appiconset/Contents.json
-- example/ios_app/ios_app/Assets.xcassets/Contents.json
-- example/ios_app/ios_app/ContentView.swift
-- example/ios_app/ios_app/Preview Content/Preview Assets.xcassets/Contents.json
-- example/ios_app/ios_app/ios_appApp.swift
 - lib/cocoapods-embed-flutter.rb
 - lib/cocoapods-embed-flutter/flutter.rb
 - lib/cocoapods-embed-flutter/flutter/dependency.rb
@@ -153,7 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -163,8 +139,7 @@ requirements: []
 rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
-summary: Straight forward way of declaring flutter modules as dependency for targets,
-  just like cocoapods does with pods.
+summary: Embed flutter modules in iOS projects.
 test_files:
 - spec/info_spec.rb
 - spec/spec_helper.rb

data/.github/config/config.js

@@ -1,21 +0,0 @@
-'use strict'
-const config = require('conventional-changelog-conventionalcommits');
-
-module.exports = config({
-    "types": [
-        { type: 'feat', section: '🚀 Features' },
-        { type: 'fix', section: '🐛 Fixes' },
-        { type: 'perf', section: '🐎 Performance Improvements' },
-        { type: 'revert', section: '⏪ Reverts' },
-        { type: 'build', section: '🛠 Build System' },
-        { type: 'deps', section: '🛠 Dependency' },
-        { type: 'ci', section: '💡 Continuous Integration' },
-        { type: 'refactor', section: '🔥 Refactorings' },
-        { type: 'doc', section: '📚 Documentation' },
-        { type: 'docs', section: '📚 Documentation' },
-        { type: 'style', section: '💄 Styles' },
-        { type: 'test', section: '✅ Tests' },
-        { type: 'wip', hidden: true },
-        { type: 'chore', hidden: true },
-    ]
-})