# 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)
[![CodeQL](https://github.com/DartBuild/cocoapods-embed-flutter/actions/workflows/codeql-analysis.yml/badge.svg?event=push)](https://github.com/DartBuild/cocoapods-embed-flutter/actions/workflows/codeql-analysis.yml)

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
```rb
plugin 'cocoapods-embed-flutter'
```

### Embedding module from a local path.

```rb
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.

```rb
pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :branch => 'dev'
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.