arli 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 818b4b5c9c83de430b9c59f4487731ee42cca089
-  data.tar.gz: 8a2bce6807e0a4a84245d62bcc0780386bd46244
+  metadata.gz: 0abe9044357d7bff2eab6f8cd87b80b729aebc9a
+  data.tar.gz: ce3df76a7613eccd2d7ada2426400fd4084b7724
 SHA512:
-  metadata.gz: a8eae4bcea44a72f7fe9411ac2efe3c8eec1de049b44f5829620a3d9255ee351738919c855134e4060f1931102a37b11c95abbcb0bc32b9a6fdbd878bd78ab4a
-  data.tar.gz: 8f28ec1d5c3e7ad1736ac89e3be18fe9bd003f5ddc10f908e3547cf226a34437fd89f614fe375439b0052798668bc7876277088486be33297eba51e130a1257b
+  metadata.gz: b7f6aaed86211c89a35b9da9c0083c4daf9d01d4b3a1d3d6ff39cdcc577a9f1d091c25dd7ddb62ce681568879fe72b6755641fb1c7d3a067ecbfb2e8d4daec6a
+  data.tar.gz: 26ebf7fdfc17fcf40ac043e0b7e7c95960c8c84d1f7a3239e6b575a354c181b7b9cd688f3dda56b827cdb74c37d13d7da91fcc08f6bc75487e3bf089fae94f74

data/.travis.yml

@@ -5,8 +5,9 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-- 2.4.1
-- 2.3.5
+- 2.5.1
+- 2.4.3
+- 2.3.7
 before_install: gem install bundler -v 1.15.4
 before_script:
 - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64

data/README.md

@@ -3,85 +3,172 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/0812671b4bec27ba89b9/maintainability)](https://codeclimate.com/github/kigster/arli/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/0812671b4bec27ba89b9/test_coverage)](https://codeclimate.com/github/kigster/arli/test_coverage)
 
-Please visit Gitter to discuss this project.
+Please visit Gitter to support and a discussion of this project.
 
 [![Gitter](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/arduino-cmake-arli/) 
 
-# Arli — The Missing Arduino Library Manager
+# Arli
 
-**Arli** is a simple and very easy to use the command-line tool, which offers several vital features to aid in Arduino project development, especially for larger projects with many depenencies and external libraries.
+**Arli is an Arduino library manager with the ability to search libraries, install a single library, or bundle any number of libraries with the project. Arli also is a new project generator based on the `arduino-cmake` build system.**
+
+**Arli** is a rather simple and easy to use command-line tool which offers several indispensable features that help with Arduino project development, in particular for much larger projects with many dependencies and external libraries. 
+
+What's more, is that projects generated by Arli's `generate` command are highly portable from one system to another. Anyone can download your project build/upload with very little work.  
+
+### Capabilities
 
 Arli can:
 
- * automatically **find, download and install** of any number of third-party Arduino library dependencies, while performing a [library folder name resolution](#folder-detection)
+ * **search for Arduino libraries** in the official public [database](http://downloads.arduino.cc/libraries/library_index.json.gz) maintained by Arduino using any of the standard [library attributes](https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification) either by the exact match, or a case-insensitive regular expression, a substring, etc. 
+ 
+ * automatically **find, download and install** of any number of third-party Arduino library dependencies, while performing a non-trivial but required [library folder name resolution](#folder-detection)
 
  * **maintain a consistent set of libraries** for a given project using a YAML-formatted `Arlifile`.
+ 
+ * support libraries **that depend on other libraries**. Arli ensures the correct build/linking order.
 
- * **generate a new project skeleton** that uses [`arduino-cmake`](https://github.com/arduino-cmake/arduino-cmake) as the build environment, which builds and uploads your firmware "out of the box".
-
- * **search for Arduino libraries** in the official public [database](http://downloads.arduino.cc/libraries/library_index.json.gz) maintained by Arduino using any library attribute by exact match, or regular expression, substring, and more.
+ * **generate a new project skeleton** based on [arli-cmake](https://github.com/kigster/arli-cmake) template, which in turn relies upon [`arduino-cmake`](https://github.com/arduino-cmake/arduino-cmake) as the build environment, which builds and uploads freshly generated projects to your firmware "out of the box".
 
 To get a sense of its feature, we invite you to watch the following screen cast:
 
-[![asciicast](https://asciinema.org/a/155261.png)](https://asciinema.org/a/155261)
+[![asciicast](https://asciinema.org/a/155289.png)](https://asciinema.org/a/155289)
 
-### Who is Arli For?
+### How is Arli Different?
 
-_Arli is ideally suited for C/C++ programmers who have some basic knowledge of CMake, and who want to build larger-than-trivial projects on Arduino platform.  Arli promotes use and reuse of libraries, which help take advantage of the Object Oriented Design Patterns, decoupling your code into reusable libraries._ 
+Arli is a fast, small, and pretty specialized command line tool (written in Ruby) that only does **four or five things very well**, and relies on other well-supported projects do their job — in particular, it relies on Arduino SDK, and `arduino-cmake` when it generates new projects.
 
-Having said that, Arli is also helpful for projects that do NOT use CMake.  It can be used purely as a library manager, or GitHub repo downloader. 
+For additional discussion, and comparison with Arduino IDE, or PlatformIO — please [read the discussion section down below](#discussion)
 
-### Why not the Arduino IDE? 
 
-Arduino IDE is not meant for professional engineers — it's a fantastic educational tool for students. And while it lacks basic features of C/C++ development it succeeds in making Arduino programming accessible to young kids and students.
+<a name="folder-detection"></a>
 
-### Why not Platform.IO?
+#### Automatic Folder Name Correction
 
-[PlatformIO](http://platformio.org/) is a great "eco-system" that includes not just Arduino, but many other boards, provides integrated library manager, and Atom as the primary IDE. It's a fantastic tool for beginner/intermediate developers, much better than Arduino IDE. 
+Arli understands that the folder where the library is installed must be named correctly: in other words, **folder name must match the header file inside of the folder** for the library to be found.
 
-But it's not without its downsides: to some — PlatformIO feels *too heavy*. It comes with a gazillion additional features you'll never use and it tries to be too much all at once. Perhaps for some people — it can be a feature. But for the author and other members of the Arduino dev community, PlatformIO design goes against the fundamental principals of [Unix Philosophy](https://en.wikipedia.org/wiki/Unix_philosophy), which promotes a minimalist, modular software development delegated to specialized commands that can be all interconnected (think `grep`, `awk`, `sort`, `uniq`). 
+When Arli downloads libraries in ZIP format, they are unpacked into a folder that would not resolve as an Arduino library folder without having to be renamed. Arli provides an algorithm that searches the contents of the folder for the source and header files. The name of the directory is then compared to the files found, and in most cases Arli will automatically **rename the library folder to match the main header file ** 
 
-### How is Arli Different?
+> For example, 'Adafruit GFX Library' is the proper name of a corresponding library, and it's ZIP archive will unpack into a folder named `Adafruit_GFX_Library-1.4.3`.  Arli will then detect that the header file inside the folder is `Adafruit_GFX.h`. In this case Arli will rename the top-level folder to `Adafruit_GFX`, and make the library valid, and its folder easily found. 
 
-Arli is a fast, small, and pretty specialized command line tool (written in Ruby) that only does **four or five things very well**, and relies on other well-supported projects do their job — in particular, it relies on Arduino SDK, and `arduino-cmake` when it generates new projects.
 
-Arli shines when you need to build a complicated and multi-dependency project using an Arduino compatible board such as [Teensy](https://www.pjrc.com/teensy/), which has 16x more RAM than the Arduino UNO, and therefore allows you to take advantage of many more third-party Arduino libraries at once within a single project.
+## Installation
 
-> A few years ago the author built a complex project called [**Filx Capacitor**](https://github.com/kigster/flix-capacitor), which relied on **ten** external libraries. Managing these dependencies was very time-consuming. Asking someone else to build this project on their system was near impossible. Not just that, but even for the author himself, after taking some time off and returning to the project — it was still difficult to figure out why it was suddenly refusing to build. So many things could have gone wrong. 
->
-> This is the problem Arli (together with the very powerful `arduino-cmake` project) attempts to solve. Your project's dependencies can be cleanly defined in a YAML file called `Arlifile`, together with an optional board name and a CPU. Next, you add a bunch of C/C++ files to the folder, update `CMakeLists.txt` file and rebuild the project, upload the firmware, or connect to the serial port. See [arli-cmake](https://github.com/kigster/arli-cmake#manual-builds) for more information. 
+Arli is a ruby gem, so to install it run:
+
+```bash
+gem install arli
+```
 
-## Overview
+You may need to use `sudo` before the command, if you are using a system-wide ruby installation.
 
-Arli offers several commands, explained below:
+Once installed, run `arli` with no arguments to see it's help screen.
 
-* `arli search [ name | regex | ruby-expression]`  
-  [searches](#search-command) for a library by name or any attribute
+## Usage
 
-* `arli install [ name | regex | ruby-expression ]`  
-  search, and [install](#install-command) a single library if the search resulted in one and only one match.
+
+Arli offers several key commands, explained below:
+
+* `arli search [ name | regex ] [ options ]`  
+  [searches](#search-command) for a library by name or any attribute in the default Arduino database.
+
+* `arli install library-name [ options ]`  
+  search, and [install](#install-command) a single library if the search for the name results in one and only one match (if multiple versions of the same library exist, the latest one is installed).
     
-* `arli bundle [ -f [ yaml | json | cmake | text ]  ] `  
-  reads a YAML-formatted `Arlifile`, and [bundles](#bundle-command), i.e., searches, downloads, resolves the appropriate library folder name, and installs all libraries to either a global location, or a custom location specified by a `-l` flag, or in the `Arlifile` itself.
+* `arli bundle [ options ]`  
+  reads a YAML-formatted `Arlifile` that defines a list of libraries, as well as (optionally) a board name and CPU, and installs all specified libraries, or as we say [bundles the project](#bundle-command). This process includes a search, download, folder name resolution, and finally installation to either a global location, or a custom location specified by a `-l` flag, or in the `Arlifile` itself.
+  
+  It also generates an output file in various formats, for example `json` format will generate `Arflifile.json` with full metadata about each library. 
   
-  In the CMake mode, generates `Arlifile.cmake` that is included in the main CMake of the project.
+  In the CMake mode, Arli generates `Arlifile.cmake`, which can be included in the main `CMakeLists.txt` file of the project to automatically build and link with the libraries.
     
-* `arli generate ProjectName [ -w ~/workspace ]`  
-  [generates](#generate-command) a clean brand new C/C++ project in a given folder, that consists of  `Arlifile`, a C++ file, a `CMakeLists.txt` file, and the dependent CMake libraries all included.
+* `arli generate ProjectName [ options ]`  
+  [generates](#generate-command) a clean brand new C/C++/CMake project folder `ProjectName` in the current directory (or whatever is provided by `--workspace DIR`). The generated folder is a complete and nearly empty project, but one that builds, includes a sample `Arlifile`, a starting sketch file, and all of the `CMakeLists.txt` tooling you need to build and upload your project.
+
+
+### Arlifile Specification
+
+`Arlifile` is the cornerstone of this library, and so we discuss this in detail. It's a central configuration file that defines library dependencies, and also some additional metadata, such as the board and CPU, as well as the hardware libraries.
+
+```yaml
+version: 2.0.0
+libraries_path: "./libraries"
+lock_format: cmake
+device:
+  board: uno
+  cpu: atmega328
+  libraries:
+    hardware:
+      - name: Wire
+    arduino:
+      - name: SD
+dependencies:
+- name: "Adafruit GFX Library"
+- name: "Adafruit LED Backpack Library"
+  depends: "Adafruit GFX Library"
+- name: "Adafruit Unified Sensor"
+- name: "DHT sensor library"
+- name: "DS1307RTC"
+- name: "OneButton"
+- name: "SimpleTimer"
+  url: https://github.com/jfturcot/SimpleTimer.git
+- name: "Time"
+```
+
+Let's review the contents:
+
+ * **libraries_path** defines an absolute or relative (to `Arlifile`) folder where libraries are to be installed.
+ 
+ * **lock_format** specifies the format of the output `Arlifile.<format>` after a successful `bundle` command. If you are using Arli with CMake, you will always want to have that be specified in Arlifile to save you typing :) 
+
+ * **Device** section is optional, but can be used to specify the **Board Name** and the **Board CPU**, as well as the two types of libraries that come with Arduino SDK
+   1. general **arduino** libraries, and
+   2. **hardware-specific** libraries, found in a hardware-specific folder. For example, if your hardware is AVR — then they will be in the  `${ARDUINO_SDK_PATH}/hardware/arduino/avr/libraries` folder. 
+
+ * Finally, the **dependencies** key is an array of hashes, that list third-party libraries to be installed. Here you must specify libraries by one of the [supported fields](#arlifile-libraries). Name is the most common, but it must match library name provided in the database, not the header file name.
+ 
+   Note that you can specify `depends:` attribute, which is an array of other library names (that must also be present in the `Arlifile`). This setting only applies to CMake build.  
+
+> NOTE: One of Arli's design goals is to make `Arlifile` a sort of a reusable "configuration" file for the project that helps make your project easily portable.
+
+<a name='arlifile-libraries'></a>
+
+#### Adding Libraries to `Arlifile`
+
+You can specify libraries by providing just the `name:` (and posibly `version`) — but **the name must match exactly a library in the Arduino standard database!**  This is a critical part. 
+
+> **EXAMPLE:** If you want to add `Adafruit_GFX.h` header, you need to find the appropriate name for this library in the database. If you know the header name, the easiest way to do that is to do the following search:
+>
+> ```bash
+> arli search 'archiveFileName: /adafruit_gfx/i'
+> ```
+> 
+> You will see in the output that only two libraries match:
+> 
+> ```
+> Adafruit GFX Library                            (1.2.2)
+> WEMOS Matrix Compatible With Adafruit GFX       (1.2.0)
+> ```
+> 
+> You want to copy the name "Adafruit GFX Library" and place it in the `Arlifile` against the `name:` attribute.
 
-## Arlifile and the Bundle Command
+You can provide the following fields in the `Arilfile` if you want the library to be found in the Arduino Library database automatically:
 
-This is the cornerstone of this library, and so we discuss this in detail.
+ * `name` should be the exact match as described above. Use double quotes if the name contains spaces.
+ * `version` can be used together with the `name` to specify a particular version. When `name` is provided without `version`, the latest version is used.
+ * `checksum` and `archiveFileName` can be also used as they both uniquely identify a library, however they are not very descriptive, and we suggest you simply search by these fields first, and add the library by name, which is a good convention.
+
+#### Installing a Non-Standard Library
 
-Below is the image of a pretty comprehensive version of an [`Arlifile`](https://github.com/kigster/weather-pod/blob/master/src/Arlifile), which should be placed at the top of your project sources. 
+If a library you are using is not in the public database just provide its `name` and the `url` fields. The URL can either be a git URL, or a downloadable ZIP file. 
 
-![](docs/arlifile.png)
+**Arli will use the `url` field if it's available** without trying to search for the library elsewhere.
 
-The `dependencies` is the key that lists third-party libraries. But you can also define hardware dependencies such as `Wire`, and the BOARD name and the CPU if your project relies on a particular board. 
 
-> One of Arli's design goals was for `Arlifile` to become a central "configuration" file for the project, and go beyond pure dependencies and also contain some additional metadata about the project that makes your code easily portable to another computer.
+## Commands
+
+<a name="bundle-command"></a>
 
-#### Bundle Command Explained
+### Command `bundle`
 
 When you run `arli bundle` in the folder with an `Arlifile`, many things happen. Below is another screenshot of running bundle:
 
@@ -103,32 +190,57 @@ Let's break down what you see in the above screenshot:
 
     * the default action is to simply **overwrite the existing library folder**.
     * by using `-e [ abort | backup ]` you can optionally either abort the installation, or create a backup of the existing folder.
+    
+ * Upon completion of the `bundle` command, a new file will be created next to `Arlifile`: `Arlifile.<format>` where format is one of: `yaml`, `json`, `text` or `cmake`. Format can be specified with `--format <format>` or `-f` for short. The file contains different contents depending on the format. 
+ 
+   With `json` or `yaml` formats, the file will contain a complete metadata about each installed library, obtained from the database search.
+   
+   With `text` format (which is the default), the result is a compact CSV file with just a couple of library attributes.
+   
+   With the `cmake` format, the resulting `Arlifile.cmake` is meant to be included in the `CMakeLists.txt` file of the project build with `arduino-cmake` library.
 
-#### Arlifile "Lock" File
-
-Whenever `bundle` command runs using an `Arlifile`, upon completion another file will be found in the same folder: typically `Arlifile.txt`, which contains metadata about libraries installed.
-
-What's powerful is you can change the format of this file:
-
-```
-$ arli bundle -f [ yaml | json | cmake ]
-```
+You can change the format of this file with `-f/--format` flag. 
 
-Will create `Arlifile.yaml` or `Arlifile.cmake` with the set of resolved libraries.
+#### CMake Integration
 
-<a name="folder-detection"></a>
+The CMake format is now fully supported, in tandem with `arduino-cmake` project.
 
-### Automatic Folder Name Correction
+Below is the resulting `Arlifile.cmake` after running `arli bundle` on the above mentioned file.
 
-Arli understands that the folder where the library is installed must be named correctly: in other words, **folder name must match the header file inside of the folder** for the library to be found.
+```cmake
+set(ARLI_CUSTOM_LIBS_PATH "${CMAKE_CURRENT_SOURCE_DIR}/libraries")
+set(ARLI_CUSTOM_LIBS
+      Adafruit_GFX
+      Adafruit_LEDBackpack
+      Adafruit_Sensor
+      DHT
+      DS1307RTC
+      OneButton
+      SimpleTimer
+      Time)
+set(ARLI_ARDUINO_HARDWARE_LIBS
+      Wire)
+set(ARLI_ARDUINO_LIBS )
+set(Adafruit_LEDBackpack_DEPENDS_ON Adafruit_GFX)
+set(Adafruit_Sensor_ONLY_HEADER yes)
+
+include(Arli)
+
+arli_detect_serial_device("/dev/null")
+arli_detect_board("uno" "atmega328")
+
+message(STATUS "device: [${BOARD_DEVICE}], board: [${BOARD_NAME}], cpu: [${BOARD_CPU}] <<<")
+
+arli_build_all_libraries()
+```
 
-When Arli downloads libraries in ZIP format, they are unpacked into a folder that would not resolve as an Arduino library folder without having to be renamed. Arli provides an algorithm that searches the contents of the folder for the source and header files. The name of the directory is then compared to the files found, and in most cases Arli will automatically **rename the library folder to match the main header file ** 
+This file only works in tandem with [`arli-cmake`](https://github.com/kister/arli-cmake) project.
 
-> For example, 'Adafruit GFX Library' is the proper name of a corresponding library, and it's ZIP archive will unpack into a folder named `Adafruit_GFX_Library-1.4.3`.  Arli will then detect that the header file inside the folder is `Adafruit_GFX.h`. In this case Arli will rename the top-level folder to `Adafruit_GFX`, and make the library valid, and its folder easily found. 
+See the [`generate`](#command-generate) command, which creates a new project with CMake enabled.
 
 <a name="generate-command"></a>
 
-## Command Generate
+### Command `generate`
 
 This command creates a new project using the template provided by the [`arli-cmake`](https://github.com/kigster/arli-cmake) project.
 
@@ -141,7 +253,6 @@ This command will create a brand new project under `~/arduino/sketches/MyClock`,
 ```bash
 cd ~/arduino/sketches/MyClock
 bin/setup 
-cd src
 rm -rf build && mkdir build && cd build
 cmake ..
 make
@@ -154,76 +265,10 @@ There is an additional `example` folder that shows the complete example that use
 
 > **IMPORTANT**: Please do not forget to run `bin/setup` script. It downloads `arduino-cmake` dependency, without which the project will not build.
 
-<a name="bundle-command"></a>
-
-## Command Bundle
-
-Use this command to install Arduino libraries defined in the `Arlifile` yaml file.
-
-Below is a pretty comprehensive version, which not only defines external dependencies to be installed (in the `:depenencies` key), but also specifies built-in Arduino libraries, including Hardware libraries such as `Wire`. 
-
-Arlifile can also specify it's own installation path, lock file format (see below), and some additional device parameters.
-
-![](docs/arlifile.png)
-
-There are two main categories of libraries you will be installing:
-
- 1. One of the officially registered in the [Arduino official library database](http://downloads.arduino.cc/libraries/library_index.json.gz), which is a giant gzipped JSON file. Arli will download and cache this file locally, and use it to find libraries. 
-
- 2. Using the `:url` field that links to either a remote ZIP file, or a Github Repo.
- 
-> When using the public database, which at the time of this writing contains 1220 unique libraries, spanning 4019 separate versions. when the remote file's size changes, will Arli automatically detects that by issuing a `HEAD` HTTP request, and after comparing the size to the locally cached version, it might decide to re-download it. 
-> 
-> Note that this functionality is provided by the "sister" Ruby gem called [`arduino-library`](https://github.com/kigster/arduino-library), which essentially provides most of the underlying library-specific functionality.
- 
-#### Installing from the Database
-
-You can specify libraries by providing just the `name:` (and posibly `version`) — the name must match exactly a library in the Arduino standard 
-
-You can provide the following fields in the `Arilfile` if you want the library to be found in the Arduino Library database:
-
- * `name` should be the exact match. Use double quotes if the name contains spaces.
- * `version` can be used together with the `name` to specify a particular version. When `name` is provided without `version`, the latest version is used.
- * `checksum` and `archiveFileName` can be used as they both uniquely identify a library.
-
-#### Installing From a URL
-
-If a library you are using is not in the public database just provide its `name` and the `url` fields. The URL can either be a git URL, or a downloadable ZIP file. Arli will use the `url` field if it's available without trying to search for the library elsewhere.
-
-#### Generated "lock" file — `Arlifile.<format>`
-
-Whenever `bundle` command succeeds, it will create a "lock" file in the same folder where the `Arlifile` file is located.
-
-The purpose of this file is to list in a machine-parseable way the *fully-resolved* installed library folders. 
-
-There are four lock file formats that are supported, and they can be passed in with the `-f format` eg `--format text` flags to the `bundle` command:
-
- * `text` 
- * `json`
- * `yaml`
- * `cmake`
-
-Each format produces a file `Arlifile.<format>`: YAML and JSON will simply include the complete library info received from the database, while text format includes a *resolved* library folder names, versions, and the download URL —  all comma separated, one per line.
-
-#### CMake Integration
-
-The CMake format is now fully supported, in tandem with `arduino-cmake` project.
-
-Below is the resulting `Arlifile.cmake` after running `arli bundle` on the above mentioned file.
-
-![](docs/arlifile-cmake.png)
-
-See the `generate` command, which creates a new project with CMake enabled.
-
-If you create `build` folder and run `cmake ..` here is what you'll see:
-
-![](docs/arli-cmake-build.png)
-
-Just run `make` or `make upload` right after build and upload your firmware.
 
 <a name="install-command"></a>
 
-## Command `install`
+### Command `install`
 
 Use this command to install a single library by either a name or URL:
 
@@ -236,7 +281,7 @@ Eg:
 
 <a name="search-command"></a>
 
-## Command `search`
+### Command `search`
 
 To search Arduino library database, you can use the search command.
 
@@ -301,8 +346,27 @@ With `-m LIMIT` flag you can limit number of results. But in our case above we p
 
 A detailed description of the complete search functionality is documented in the library that provides it — [arduino-library](https://github.com/kigster/arduino-library#using-search). Arli uses the `arduino-library` gem behind the scenes to search, and lookup libraries.
 
+<a name="discussion"></a>
+
 ## Discussion
 
+### Who is Arli For?
+
+_Arli is ideally suited for C/C++ programmers who have some basic knowledge of CMake, and who want to build larger-than-trivial projects on Arduino platform.  Arli promotes use and reuse of libraries, which help take advantage of the Object Oriented Design Patterns, decoupling your code into reusable libraries._ 
+
+Having said that, Arli is also helpful for projects that do NOT use CMake.  It can be used purely as a library manager, or GitHub repo downloader. 
+
+### Why not the Arduino IDE? 
+
+Arduino IDE is not meant for professional engineers — it's a fantastic educational tool for students. And while it lacks basic features of C/C++ development it succeeds in making Arduino programming accessible to young kids and students.
+
+### Why not Platform.IO?
+
+[PlatformIO](http://platformio.org/) is a great "eco-system" that includes not just Arduino, but many other boards, provides integrated library manager, and Atom as the primary IDE. It's a fantastic tool for beginner/intermediate developers, much better than Arduino IDE. 
+
+But it's not without its downsides: to some — PlatformIO feels *too heavy*. It comes with a gazillion additional features you'll never use and it tries to be too much all at once. Perhaps for some people — it can be a feature. But for the author and other members of the Arduino dev community, PlatformIO design goes against the fundamental principals of [Unix Philosophy](https://en.wikipedia.org/wiki/Unix_philosophy), which promotes a minimalist, modular software development delegated to specialized commands that can be all interconnected (think `grep`, `awk`, `sort`, `uniq`). 
+
+
 ### More Reasons Why Arli is Needed
 
 Arli is both an *Arduino Library Manager* and a project generator. If you are using Arduino IDE you may be wondering **why is this needed?**
@@ -316,6 +380,15 @@ Arli is both an *Arduino Library Manager* and a project generator. If you are us
  * One of Arli's design goals is to provide a bridge between the [arduino-cmake](https://github.com/arduino-cmake/arduino-cmake) project, which provides an alternative build system, and is compatible with numerous IDEs such as [Atom](https://atom.io), [JetBrains CLion](https://www.jetbrains.com/clion/), [Visual Studio Code](https://code.visualstudio.com/), or even [Eclipse](https://eclipse.org).
 
 
+### Working with Complex Projects
+
+Arli shines when you need to build a complicated and multi-dependency project using an Arduino compatible board such as [Teensy](https://www.pjrc.com/teensy/), which has 16x more RAM than the Arduino UNO, and therefore allows you to take advantage of many more third-party Arduino libraries at once within a single project.
+
+> A few years ago the author built a complex project called [**Filx Capacitor**](https://github.com/kigster/flix-capacitor), which relied on **ten** external libraries. Managing these dependencies was very time-consuming. Asking someone else to build this project on their system was near impossible. Not just that, but even for the author himself, after taking some time off and returning to the project — it was still difficult to figure out why it was suddenly refusing to build. So many things could have gone wrong. 
+>
+> This is the problem Arli (together with the very powerful `arduino-cmake` project) attempts to solve. Your project's dependencies can be cleanly defined in a YAML file called `Arlifile`, together with an optional board name and a CPU. Next, you add a bunch of C/C++ files to the folder, update `CMakeLists.txt` file and rebuild the project, upload the firmware, or connect to the serial port. See [arli-cmake](https://github.com/kigster/arli-cmake#manual-builds) for more information. 
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -11,6 +11,10 @@ task :clean do
   shell('rm -rf pkg/ tmp/ coverage/ doc/ spec/fixtures/file5/libraries' )
 end
 
+task :gem => [:build] do
+  shell('gem install pkg/*')
+end
+
 task :permissions => [ :clean ] do 
   shell("chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*")
   shell("find . -type d -exec chmod o+x,g+x {} \\;")

data/arli.gemspec

@@ -32,20 +32,23 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'arduino-library', '~> 0.5.4'
+  spec.add_dependency 'arduino-library', '=0.5.5'
+
   spec.add_dependency 'awesome_print'
   spec.add_dependency 'colored2'
+
   spec.add_dependency 'dry-configurable'
-  spec.add_dependency 'dry-struct'
   spec.add_dependency 'dry-types'
-  spec.add_dependency 'hashie'
-  spec.add_dependency 'require_dir'
+  spec.add_dependency 'dry-struct'
+
+  spec.add_dependency 'hashie', '~> 3.5'
+  spec.add_dependency 'require_dir', '~> 2'
   spec.add_dependency 'tty-cursor'
 
   spec.add_development_dependency 'aruba'
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'rspec-its'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'yard'

data/lib/arli.rb

@@ -1,8 +1,7 @@
 require 'require_dir'
 
 module Arli
-  extend RequireDir
-  init __FILE__
+  RequireDir.enable_require_dir!(self, __FILE__)
 end
 
 require 'arduino/library'

data/lib/arli/cli/app.rb

@@ -55,6 +55,7 @@ module Arli
       ensure
         d = Arli.config.libraries.temp_dir
         FileUtils.rm_rf(d) if Dir.exist?(d) rescue nil
+        __pt
       end
 
       def parse_global_flags

data/lib/arli/commands/bundle.rb

@@ -18,6 +18,10 @@ module Arli
         self.lock_file = Arli::Lock::File.new(config: config, arlifile: arlifile)
       end
 
+      def additional_info
+        "\nArlifile Path: #{arlifile.arlifile_path.magenta}\nLock Format: #{config.arlifile.lock_format.to_s.yellow}\n"
+      end
+
       def params
         if arlifile&.libraries
           "libraries: \n • " + arlifile.libraries.map(&:name).join("\n • ")

data/lib/arli/commands/install.rb

@@ -21,7 +21,6 @@ module Arli
       include ::Arli::Library
 
       def setup
-        super
         self.install_argument = runtime.argv.first
         raise InvalidInstallSyntaxError,
               'Missing installation argument: a name, a file or a URL.' unless install_argument
@@ -71,7 +70,7 @@ module Arli
       end
 
       def params
-        " • #{library.to_s}"
+        nil
       end
 
       def post_install

data/lib/arli/helpers/output.rb

@@ -143,20 +143,20 @@ module Arli
       end
 
       def header(command: nil)
-        out = "\n#{hr}\n"
-        out << "Arli (#{::Arli::VERSION.yellow})"
-        out << ", Command: #{command.name.to_s.magenta.bold}" if command
+        out = "#{hr}\n"
+        out << 'Arli '.bold.red + "(#{::Arli::VERSION.yellow})"
+        out << ", executing command #{command.name.to_s.blue.bold}" if command
         if command && command.params && Arli.config.verbose
-          out << "\n#{command.params.to_s.blue}\n"
+          out << "\n#{command.params.to_s.bold.magenta}\n"
         end
         out << command.additional_info if command.respond_to?(:additional_info)
-        out << "Library Path: #{Arli.default_library_path.green}\n"
+        out << "Library Path: #{Arli.default_library_path.bold.green}\n"
         out << "#{hr}"
         info out
       end
 
       def hr
-        ('—' * ((ENV['COLUMNS'] || 70).to_i - 1)).red.dark
+        ('—' * ((ENV['COLUMNS'] || 70).to_i - 1)).bold.black
       end
 
       # Some shortcuts

data/lib/arli/library.rb

@@ -5,6 +5,8 @@ require 'arli/errors'
 
 module Arli
   module Library
+    ADDITIONAL_KEYS = %i(depends headers_only)
+
     def library_model(lib)
       return lib if lib.is_a?(::Arduino::Library::Model)
       ::Arduino::Library::Model.from(lib).tap do |model|
@@ -20,7 +22,19 @@ module Arli
     end
 
     def make_lib(lib)
-      ::Arli::Library::SingleVersion.new(library_model(lib))
+      additional_keys = {}
+      ADDITIONAL_KEYS.each do |k|
+        if lib.is_a?(Hash) && lib[k]
+          additional_keys[k] = lib[k]
+          lib.delete(k)
+        end
+      end
+
+      ::Arli::Library::SingleVersion.new(library_model(lib)).tap do |svlib|
+        additional_keys.each_pair do |key, value|
+          svlib.send("#{key}=", value)
+        end
+      end
     end
   end
 end

data/lib/arli/library/installer.rb

@@ -34,7 +34,7 @@ module Arli
             run_action(action)
           end
         end
-        ___ "\n\n"
+        ___ "\n"
       end
 
       def run_action(action_name)

data/lib/arli/library/single_version.rb

@@ -12,14 +12,18 @@ module Arli
       attr_accessor :lib,
                     :lib_dir,
                     :canonical_dir,
-                    :config,
-                    :headers_only
+                    :config
+
+      # Additional attributes that can be set via Arlifile
+      attr_accessor :headers_only,
+                    :depends
 
       def initialize(lib, config: Arli.config)
         self.lib          = lib
         self.config       = config
         self.lib_dir      = lib.name.gsub(/ /, '_')
         self.headers_only = false
+        self.depends      = nil
       end
 
       def install
@@ -56,7 +60,7 @@ module Arli
 
       def inspect
         <<-EOF
-Library: #{lib.name} (#{lib.url}), only headers? #{headers_only ? 'YES': 'NO'}
+Library: #{lib.name} (#{lib.url}), only headers? #{headers_only ? 'YES' : 'NO'}
         EOF
       end
 

data/lib/arli/lock/formats/template/Arlifile.cmake.erb

@@ -10,8 +10,11 @@
 # 
 #      arli generate MyTestProject --workspace ~/workspace
 #      cd ~/workspace/MyTestProject
-#      bin/setup
-#      bin/build src
+#      mkdir build; cd build
+#      cmake ..
+#      make                        <— builds your firmware
+#      make upload                 <— uploads your firmware to the device
+#      make MyTestProject-serial   <— starts a screen session with serial connection
 #
 # And you should see a binary image built for the default board, or the 
 # board you specified in the Arlifile.
@@ -32,18 +35,17 @@ set(ARLI_ARDUINO_HARDWARE_LIBS <% hardware_libraries.each do |library| %>
 set(ARLI_ARDUINO_LIBS <% arduino_libraries.each do |library| %>
       <%= library.name %><% end %>)
 
-<% device_libraries_headers_only.each do |library| %>
-set(<%= library.name %>_ONLY_HEADER yes)<% end %>
-<% custom_libraries_headers_only.each do |library| %>
-set(<%= library.canonical_dir %>_ONLY_HEADER yes)<% end %>
+<% libraries.each do |library| %><% if library.depends %><%= cmake_dependencies(library) %><% end %><% end %>
+
+<% device_libraries_headers_only.each do |library| %>set(<%= library.name %>_ONLY_HEADER yes)<% end %>
+<% custom_libraries_headers_only.each do |library| %>set(<%= library.canonical_dir %>_ONLY_HEADER yes)<% end %>
 
 include(Arli)
 
 arli_detect_serial_device("/dev/null")
-arli_detect_board("<%= board %>" "<%= cpu %>")
-
-message(STATUS "device: [${BOARD_DEVICE}], board: [${BOARD_NAME}], cpu: [${BOARD_CPU}] <<<")
 
-arli_build_all_libraries()
+<% if board && cpu %>arli_detect_board("<%= board %>" "<%= cpu %>")<% end %>
 
+message(STATUS "HARDWARE:\n   • BOARD_DEVICE=[${BOARD_DEVICE}]\n   • BOARD_NAME=[${BOARD_NAME}]\n   • BOARD_CPU=[${BOARD_CPU}]")
 
+arli_build_all_libraries()

data/lib/arli/lock/formats/template/cmake_renderer.rb

@@ -66,6 +66,24 @@ module Arli
             config.libraries.path
           end
 
+          def libraries_with_dependencies
+            libraries.select(&:depends)
+          end
+
+          def library_by_name(name)
+            libraries.find { |l| l.name.downcase == name.downcase }
+          end
+
+          def dependencies(lib)
+            return nil unless lib.depends
+            lib.depends.map { |name| library_by_name(name) }
+          end
+
+          def cmake_dependencies(lib)
+            return nil unless lib.depends
+            "set(#{lib.canonical_dir}_DEPENDS_ON_LIBS #{dependencies(lib).map(&:canonical_dir).join(' ')})"
+          end
+
           def arli_library_path
             if library_path.start_with?('/')
               "#{library_path}"

data/lib/arli/version.rb

@@ -1,3 +1,3 @@
 module Arli
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.1'.freeze
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: arli
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-03 00:00:00.000000000 Z
+date: 2018-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arduino-library
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.4
+        version: 0.5.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.4
+        version: 0.5.5
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dry-struct
+  name: dry-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dry-types
+  name: dry-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -98,30 +98,30 @@ dependencies:
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: require_dir
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: tty-cursor
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -329,7 +329,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: This is an Arduino helper toolkit that builds on top of the arduino-cmake