arli 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 5cbff710fa5c642b1c785d3e5f57acd716383c27a5638ce1164ac4539c655706
-  data.tar.gz: 36918da039ee3f764296e3d6073af80a89d39690199ef6e80b4a15d8ed310929
+SHA1:
+  metadata.gz: f832a4537673c42612bdd05b38137b2b531c1d9f
+  data.tar.gz: 07561b363309d67e75c39ccd6933be6b39b35660
 SHA512:
-  metadata.gz: 9b73273990d8bd70ad20f1925068060bb486b74535a75f69c42ab01789502cefb555255745d6c12a805faf7778ab6851e6c68686517e2ed7b8db15738cf41af9
-  data.tar.gz: 89f52802678e11a45f2f2a6424f0aa08d4e2fde5bdcdfaf7edc8230e65fd1d0c6c75d93bc702ddc748cc956fcae710f8e0170f29d74a8ea150c48d153513c8fb
+  metadata.gz: 1e2801972673b2bf8667e578713c46025ce123ae01b684e6f640d25ef08e4bd5082811025f3b48e8f987774abe84ac0bd65e4611b530d72d2c6e7df6098d853b
+  data.tar.gz: 643bc6d45cf57d79340bab535bcf24a100c41f3f328813b790292a053fb001d89d7521d7b373ff2dd6879225fe4f4858f196d10a4fdee6890a0f1c1316e45f65

data/README.md

@@ -112,6 +112,12 @@ dependencies:
 - name: "SimpleTimer"
   url: https://github.com/jfturcot/SimpleTimer.git
 - name: "Time"
+- name: BackSeatDriver
+  url: https://github.com/kigster/back-seat-driver
+  folder: libraries/BackSeatDriver
+- name: BackSeatDriver_DCMotorAdapter
+  url: https://github.com/kigster/back-seat-driver
+  folder: libraries/BackSeatDriver_DCMotorAdapter
 ```
 
 Let's review the contents:
@@ -163,6 +169,9 @@ If a library you are using is not in the public database just provide its `name`
 
 **Arli will use the `url` field if it's available** without trying to search for the library elsewhere.
 
+#### Installing a Sub-Folder of a Library
+
+As of version 1.3.0, Arli supports `folder` key in the Arlifile against each library. If provided, it is meant to be a relative sub-folder within the checked-out library directory structure, and only that folder will be installed as the library, and the rest removed. In the provided example, [BackSeatDriver](https://github.com/kigster/back-seat-driver/) is a collection of three libraries, and therefore to install one of them we must tell Arli a folder within that repository.j:wq
 
 ## Commands
 

data/arli.gemspec

@@ -32,7 +32,7 @@ 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.5'
+  spec.add_dependency 'arduino-library', '~> 0.6'
 
   spec.add_dependency 'awesome_print'
   spec.add_dependency 'colored2'

data/lib/arli/cli/parser.rb

@@ -104,13 +104,15 @@ module Arli
           config.generate.workspace = v
         end
 
-        # on('-L', '--libs "LIBS"',
-        #    'Comma separated list of library names, or name ',
-        #    'substrings, to be searched for and added to the ',
-        #    'initial Arlifile. Multiple matches are added anyway',
-        #    'while no matches are skipped' + "\n\n") do |v|
-        #   config.generate.libs = v.split(',')
-        # end
+        on('-L', '--libs LIB',
+           'Full or partial name of a public Arduino library, can be used more',
+           'than once. Libraries will be searched in the Arduino database, ',
+           'and added to the project Arlifile. Multiple matches or no match',
+           'will raise an error.' + "\n\n") do |v|
+          config.generate.libs ||= []
+          config.generate.libs << v.strip
+          config.generate.libs.uniq!
+        end
 
         option_if_exists('project')
       end

data/lib/arli/commands/generate.rb

@@ -5,20 +5,33 @@ require_relative 'base'
 require_relative '../arli_file'
 require_relative '../helpers/system_commands'
 require 'forwardable'
+require 'arduino/library'
 module Arli
   module Commands
     class Generate < Base
+
+      include ::Arduino::Library
       include ::Arli::Helpers::SystemCommands
 
       extend Forwardable
       def_delegators :@settings, :project_name, :project_name=, :workspace, :workspace=, :libs, :libs=, :template_repo
 
-      attr_accessor :settings, :dir
+      attr_accessor :settings, :dir, :libraries
 
       def setup
         config.generate.project_name = config.runtime.argv.first
 
         self.settings = config.generate
+        self.libraries = []
+
+        (settings.libs || []).each do |lib|
+          library = find_library({ name: lib }, version: :latest)
+          if library
+            self.libraries << library
+          else
+            raise ::Arli::Errors::LibraryNotFound, "Can not find library by name #{lib}"
+          end
+        end
 
         raise ::Arli::Errors::RequiredArgumentsMissing, 'Project name is required' unless project_name
         raise ::Arli::Errors::RequiredArgumentsMissing, 'Template Repo is missing' unless template_repo
@@ -42,8 +55,14 @@ module Arli
                 'git init .'
             )
             run_with_info('Customizing your README and other files...')
+
             rename_files!
+
             configure_template!
+            configure_arlifile!
+
+            configure_main!
+
             run_with_info(
                 'Running setup of the dependencies...',
                 'bin/setup'
@@ -74,136 +93,46 @@ module Arli
 
       private
 
+      def configure_arlifile!
+        arli_config = YAML.load(File.read('src/Arlifile'))
+        arli_config['dependencies'] = []
+
+        (libraries || []).each do |library|
+          arli_config['dependencies'] << { 'name' => library.name, 'version' => library.version }
+        end
+
+        File.open('src/Arlifile', 'w') do |f|
+          f.write(YAML.dump(arli_config))
+        end
+      end
+
+      def configure_main!
+        template = File.read(File.expand_path('../main.cpp.erb', __FILE__))
+        main = ERB.new(template).result(binding)
+        require 'erb'
+        File.open("src/#{project_name}.cpp", 'w') do |f|
+          f.write(main)
+        end
+      end
+
       def rename_files!
         FileUtils.mv('README.md', 'README-Arli-CMake.md')
+        run_with_info('Updating CMakeLists.txt file...',
+                      "sed -E -i '' 's/example/src/g' CMakeLists.txt")
+        run_with_info('Updating CMakeLists.txt files...',
+                      "find . -type f -name CMakeLists.txt -exec sed -E -i '' 's/MyProject/#{project_name}/g' {} \\; ")
         Dir.chdir('src') do
-          FileUtils.mv('MyProject.cpp', "#{project_name}.cpp")
-          run_with_info('Updating CMakeLists.txt file...',
-                        "sed -i 's/MyProject/#{project_name}/g' CMakeLists.txt")
+          FileUtils.rm_f('MyProject.cpp')
         end
-        run_with_info('Updating CMakeLists.txt file...',
-                      "sed -i 's/MyProject/#{project_name}/g' CMakeLists.txt")
       end
 
       def configure_template!
+        template = File.read(File.expand_path('../readme.md.erb', __FILE__))
+        @project_name = config.generate.project_name
+        readme = ERB.new(template).result(binding)
+        require 'erb'
         File.open('README.md', 'w') do |f|
-          f.write <<-EOF
-          
-> **NOTE**: This project has been auto-generated using:
-> 
->  * [arli](https://github.com/kigster/arli) Arduino toolkit, and using the `generate` command. Thank you for using Arli!
->  * [arli-cmake](https://github.com/kigster/arli-cmake) is the template project that was used as a source for this one.
->  * [arduino-cmake](https://github.com/arduino-cmake/arduino-cmake) is the CMake-based build system for Arduino projects.
->
-> There is a discussion board for Arli/CMake-based projects. Please join if you have any questions or suggestions!
-> [![Gitter](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/arduino-cmake-arli/)
-
-
-# #{project_name}
-
-**TODO: Please update this README to reflect information about you project. :)** 
-
-## Prerequisites
-
- * On a Mac, you always need to run `xcode-select --install` before you can do any development. You must have `git` installed;
-
- * Requires [CMake](https://cmake.org/download/)
-
- * Requires [Arduino IDE](https://www.arduino.cc/en/Main/Software) or an SDK, either for [Mac](https://downloads.arduino.cc/arduino-1.8.5-macosx.zip) or [Linux](https://downloads.arduino.cc/arduino-1.8.5-linux.zip) installed;
-
- * Requires ruby, 2.3 or 2.4+ installed. On a Mac's Terminal, run `ruby --version`. If for some reason you don't have it installed, the `bin/setup` script will prompt you to install it.
-
-## Building #{project_name}
- 
-```bash
-$ cd ~/workspace/#{project_name}
-$ rm -rf build && mkdir -p build && cd build
-$ cmake ..
-$ make                          # this builds the image
-$ make upload                   # this uploads it to the device
-$ # this next command opens a serial port monitor inside a screen session
-$ make #{project_name}-serial   
-```
-
-### Customizing the Build
-
-You can use environment variables to set the board, CPU and the port. Simply prefix the following variables before you run `cmake ..`
-
-```bash
-$ rm -rf build
-$ mkdir -p build
-$ cd build
-$ BOARD_NAME=nano \\
-  BOARD_CPU=atmega328p \\
-  BOARD_DEVICE=/dev/tty.usbserial-DA00WXFY \\
-  cmake ..
-```
-
-### Adding External Libraries
-
-Your repo contains `Arlifile` inside the `src` folder. Please [read the documentation](https://github.com/kigster/arli#command-bundle) about the format of `Arlifile`.
-
-Go ahead and edit that file, and under `dependencies:` you want to list all of your libraries by their exact name, and an optional version. 
-
-The best way to do that is to **first search for the library** using the `arli search terms` command. Once you find the library you want, just copy it's name as is into `Arlifile`. If it contains spaces, put quotes around it.
-
-For example:
-
-```bash
-❯ arli search /adafruit.*bmp085/i
-
-Arli (1.0.2), Command: search
-Library Path: ~/Documents/Arduino/Libraries
-
-Adafruit BMP085 Library                         (1.0.0)    ( 1 total versions )
-Adafruit BMP085 Unified                         (1.0.0)    ( 1 total versions )
-———————————————————————
-  Total Versions : 2
-Unique Libraries : 2
-———————————————————————
-```
-
-If the library is not in the official database, just add it with a name and a url. Arli will use the url field to fetch it.
-
-To verify that your Arlifile can resolve all libraries, please run `arli bundle` inside the `src` folder. If Arli suceeds, you've got it right, and the `libraries` folder inside `src` should contain all referenced libraries.
-
-### Adding Source Files
-
-You will notice that inside `src/CMakeLists.txt` file, there is a line:
-
-```cmake
-set(PROJECT_SOURCES #{project_name}.cpp)
-```
-
-If you add any additional source files or headers, just add their names right after, separated by spaces or newlines. For example:
-
-```cmake
-set(PROJECT_SOURCES 
-  #{project_name}.cpp
-  #{project_name}.h
-  helpers/Loader.cpp
-  helpers/Loader.h
-  config/Configuration.h
-)
-```
-
-The should be all you need to do add custom logic and to rebuild and upload the project.
-
-## Where to get Support?
-
-Please feel free to file bug reports and submit pull requests on GitHub — [https://github.com/kigster/arli-cmake](https://github.com/kigster/arli-cmake) is the project URL, and this is the [issues](https://github.com/kigster/arli-cmake/issues) URL.
-
-## License
-
-The original project is distributed as open source, under the terms of the [MIT License](http://opensource.org/licenses/MIT). 
-
-However, feel free to change the license of your project, as long as you provide the credit to the original.
-
-Thanks!
-Good luck!
-
-
-          EOF
+          f.write(readme)
         end
       end
     end

data/lib/arli/commands/main.cpp.erb

@@ -0,0 +1,10 @@
+#include <Arduino.h>
+// add your library headers here
+
+void setup() {
+
+}
+
+void loop() {
+
+}

data/lib/arli/commands/readme.md.erb

@@ -0,0 +1,122 @@
+# <%= project_name %>
+
+> **NOTE**: This project and its README were auto-generated using
+>
+>  * [arli](https://github.com/kigster/arli) Arduino toolkit, and using the `generate` command. Thank you for using Arli!
+>  * [arli-cmake](https://github.com/kigster/arli-cmake) is the template project that was used as a source for this one.
+>  * [arduino-cmake](https://github.com/arduino-cmake/arduino-cmake) is the CMake-based build system for Arduino projects.
+>
+> There is a discussion board for Arli/CMake-based projects. Please join if you have any questions or suggestions!
+> [![Gitter](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/arduino-cmake-arli/)
+
+## Overview
+
+This Arduino project uses CMake build system, and the Arduino-CMake project. It also uses `arli` CLI tool to manage it's library dependencies.
+
+## Usage
+
+### Prerequisites
+
+ * On a Mac, you always need to run `xcode-select --install` before you can do any development. You must have `git` installed;
+
+ * Requires [CMake](https://cmake.org/download/)
+ * Requires [Arduino IDE](https://www.arduino.cc/en/Main/Software) or an SDK, either for [Mac](https://downloads.arduino.cc/arduino-1.8.5-macosx.zip) or [Linux](https://downloads.arduino.cc/arduino-1.8.5-linux.zip) installed;
+ * Requires ruby, 2.3 or 2.4+ installed. On a Mac's Terminal, run `ruby --version`. If for some reason you don't have it installed, the `bin/setup` script will prompt you to install it.
+
+### Building
+
+You can build the project using provided BASH helpers:
+
+```bash
+$ cd ~/workspace/<%= project_name %>
+$ bin/setup
+$ bin/build
+```
+
+Or you can build manually using cmake/make:
+
+```bash
+$ cd ~/workspace/<%= project_name %>
+$ rm -rf build && mkdir build
+$ cd build
+$ cmake ..
+$ make                          # this builds the image
+$ make upload                   # this uploads it to the device
+$ # this next command opens a serial port monitor inside a screen session
+$ make <%= project_name %>-serial
+```
+
+### Customizing the Build
+
+You can use environment variables to set the board, CPU and the port. Simply prefix the following variables before you run `cmake ..`
+
+```bash
+$ rm -rf build && mkdir -p build && cd build
+$ BOARD_NAME=nano \
+  BOARD_CPU=atmega328p \
+  BOARD_DEVICE=/dev/tty.usbserial-DA00WXFY \
+  cmake ..
+```
+
+### Adding External Libraries
+
+Your repo contains `Arlifile` (which is a YAML file) inside the `src` folder. Please [read the documentation](https://github.com/kigster/arli#arlifile-specification) about the format of `Arlifile`.
+
+Go ahead and edit that file, and under `dependencies:` you want to list all of your libraries by their exact name, and an optional version.
+
+The best way to do that is to **first search for the library** using the `arli search terms` command. Once you find the library you want, just copy it's name as is into `Arlifile`. If it contains spaces, put quotes around it.
+
+For example:
+
+```bash
+$ arli search /adafruit.*bmp085/i
+
+Arli (1.0.2), Command: search
+Library Path: ~/Documents/Arduino/Libraries
+
+Adafruit BMP085 Library                         (1.0.0)    ( 1 total versions )
+Adafruit BMP085 Unified                         (1.0.0)    ( 1 total versions )
+———————————————————————
+  Total Versions : 2
+Unique Libraries : 2
+———————————————————————
+```
+
+If the library is not in the official database, just add it with a name and a url, and an optional sub-folder. Arli will use the url field to fetch it.
+
+To verify that your Arlifile can resolve all libraries, please run `arli bundle` inside the `src` folder. If Arli succeeds, you've got it right, and the `libraries` folder inside `src` should contain all referenced libraries.
+
+### Adding Source Files
+
+You will notice that inside `src/CMakeLists.txt` file, there is a line:
+
+```cmake
+set(PROJECT_SOURCES <%= project_name %>.cpp)
+```
+
+If you add any additional source files or headers, just add their names right after, separated by spaces or newlines. For example:
+
+```cmake
+set(PROJECT_SOURCES
+  <%= project_name %>.cpp
+  <%= project_name %>.h
+  helpers/Loader.cpp
+  helpers/Loader.h
+  config/Configuration.h
+)
+```
+
+The should be all you need to do add custom logic and to rebuild and upload the project.
+
+## Where to get Support?
+
+Please feel free to file bug reports and submit pull requests on GitHub — [https://github.com/kigster/arli-cmake](https://github.com/kigster/arli-cmake) is the project URL, and this is the [issues](https://github.com/kigster/arli-cmake/issues) URL.
+
+## License
+
+The original project is distributed as open source, under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+However, feel free to change the license of your project, as long as you provide the credit to the original.
+
+Thanks!
+Good luck!

data/lib/arli/version.rb

@@ -1,3 +1,3 @@
 module Arli
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.4.0'.freeze
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: arli
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-08 00:00:00.000000000 Z
+date: 2018-08-20 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.5
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -288,6 +288,8 @@ files:
 - lib/arli/commands/bundle.rb
 - lib/arli/commands/generate.rb
 - lib/arli/commands/install.rb
+- lib/arli/commands/main.cpp.erb
+- lib/arli/commands/readme.md.erb
 - lib/arli/commands/search.rb
 - lib/arli/configuration.rb
 - lib/arli/errors.rb
@@ -329,7 +331,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+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