Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[discussion] -> dev env with rainforest #26

Merged
merged 3 commits into from
Sep 13, 2014
Merged

[discussion] -> dev env with rainforest #26

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5b7ce2f
dev env rainforest
orta Sep 13, 2014
c35151d
[Rainforest] Rake -T to show a list of tasks
kylef Sep 13, 2014
a419b32
minor improvements to environment
orta Sep 13, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 16 additions & 32 deletions source/contributing/dev-environment.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,39 +4,29 @@ description: If you're looking to contribute to the CocoaPods project through fe
order: 2
---

> Create a clone of the CocoaPods source.
CocoaPods is a collection of ruby gems. It is possible to clone them individually and set up a bundler environment for working in CocoaPods. However for someone new to high-level library development in ruby this comes with a high learning curve. Because of this we will be using this guide to show how to set up using the CocoaPods Rainforest.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More commas'd be cool:

However, for someone new to high-level library development in ruby, this comes with a high learning curve.


Rainforest is a git repo that when bootstrapped has submodules of all the required gems for CocoaPods development. Let's clone it:

```shell
$ git clone git://github.com/CocoaPods/CocoaPods.git
$ cd CocoaPods
$ git clone https://github.com/CocoaPods/Rainforest.git
$ cd Rainforest
```
All of the commands in Rainforest are Rake Tasks. This is a ruby varient of Make Tasks. You can take a look at all the available tasks by running `rake -t` in the terminal.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rake -T, -t just invokes the default.


Update git submodules and install the dependencies. CocoaPods supports Ruby 1.8.7 and newer. Instructions for RVM are provided, but feel free to use whichever tool you prefer.

> If you are using RVM:
To get started downloading run:

```shell
# Create a blank environment for CocoaPods.
$ echo "rvm use --create ruby-1.9.3-p194@cocoapods" > .rvmrc
$ echo ".rvmrc" >> .git/info/exclude

# Reload the rvm config by jumping in and out of your dev folder
# then init & update git submodules and install ruby dependencies using a rake task.
$ cd .. ; cd -
$ rake bootstrap
$ rake bootstrap
```

> Otherwise:
This will loop through all the known gems downloading them, and setting up their environments. To verify that everything is set up, run: `CocoaPods/bin/pod --help`.

```shell
# If bundler is not already installed.
$ sudo gem install bundler
### Working on CocoaPods

# Init & update git submodules and install ruby dependencies using a rake task.
$ rake bootstrap
```
If you're not sure where your changes are going to be, you may way to look at the [Core Components](http://guides.cocoapods.org/contributing/components.html) to get a sense of where the change will take place.

> Verify that all specs pass and all examples build. (See rake -T for other tasks.)
Once in the correct gem you should verify that all specs pass and all examples build. ( See rake -T for other gem based tasks. )

```shell
$ rake spec
Expand All @@ -53,30 +43,24 @@ Create your patch, verify all specs still pass and examples still build, and cre

## Using latest pod version

If you would like to run latest pod command in terminal for you project.
If you would like to run latest pod command in terminal for you project.

> You could run it with full path, i.e.

```shell
$HOME/code/CocoaPods/bin/pod install
$DEV/Rainforest/CocoaPods/bin/pod install
```

> For convenience you could add the next alias to you .zshrc or .bashrc or similar:

```shell
alias pod-dev='$HOME/code/CocoaPods/bin/pod'
alias pod-dev='$DEV/Rainforest/CocoaPods/bin/pod'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason for changing from $HOME to $DEV here? Might be less specific to use something like ~/path/to/Rainforest/CocoaPods/bin/pod?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

think this is better 👍

```

Other advanced aliases:

> If you are using RVM and have specific gemset for cocoapods (i.e. with the same name) than you could use next alias:

```shell
alias pod-dev='rvm ruby-1.9.3-p194@cocoapods do $HOME/code/CocoaPods/bin/pod'
```

> If you want to autoload [Pry](https://github.com/pry/pry) and the [Awesome Print](https://github.com/michaeldv/awesome_print) gems set the ```COCOA_PODS_ENV``` environment variable to ```development```. This can be done with an alias like:

```shell
alias pod-dev='COCOA_PODS_ENV=development ~/Documents/GitHub/CocoaPods/bin/pod'
```
```