arli 0.7.0 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c24d0e256205e016bc76654f761283e2f7bf2b21
-  data.tar.gz: 67cf5af188033eee75bdcdb430623464c36f40a4
+  metadata.gz: 4403d1e6ec0453ea707b6a1bca1cf89f47a8e848
+  data.tar.gz: 8387afcccd21d9c8cc62bd43140e70bbd34eced2
 SHA512:
-  metadata.gz: 7d34e117d98f741237f0de0a15c1e0ebae3251d85a614c7e70179e123fe0c66ac8d72523fece8a9f0d9f189fdb67ea163e32efea1260390f68b675337ce663c6
-  data.tar.gz: fddbd83b57fbbc4fe57147fd9209ea9ed9ebad1141c6a3327643b48b1292fdd454e162504e99da8448012e73bbcbac77b55a08ab58b6ec2962ec436a80be2fe7
+  metadata.gz: 448cc7c706ea9192bc13db514060d319ff7beac6bb749131aaab0a7deead3f3b036cf61cbad8b99a86eeb560d1b2018085cd7efc0c5617d83d0c75d21ee76068
+  data.tar.gz: b67cd69f59905e5136bb4bd4175e696d929a53563412c7293719b881758145e56a650f28a23419ba112abf4bb8d6cb40820f80fd85969dc03484b08c27d56a91

data/.gitignore

@@ -15,3 +15,5 @@
 .ruby-version
 .rspec_status
 !/lib/arli/commands/install.rb
+!/lib/arli/cli/parser.rb
+/spec/fixtures/file*/Arlifile.lock*

data/Gemfile

@@ -2,6 +2,4 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem 'arduino-library', git: 'https://github.com/kigster/arduino-library'
-
 gemspec

data/README.md

@@ -11,10 +11,11 @@ Arli is an awesomely simple and very easy to use Arduino Library Installer. It a
 
 That way you can share projects with others and they will be able to automatically download and install the dependent libraries instead of having to do that manually. The project is inspired by [Bundler](http://bundler.io/).
 
-Here is a screenshot of running `arli install` inside a project with the `Arlifile` that defines all of it's library dependencies into a local project folder `./libraries`:
+Here is a screenshot of running `arli bundle` inside a project with the `Arlifile` that defines all of the project's library dependencies. We install into a default libraries folder `~/Documents/Arduino/Libraries`:
 
 ![](docs/arli-in-action.png)
 
+Note that `-f yaml` specifies the format of the "lock" file (`Arlifile.lock`), which is also copied to `Arlifile.lock.[format]`. So in this case our `Arlifile.lock` will be in YAML format, and will contain all library details obtained from the central database.
 
 ## Overview
 
@@ -24,22 +25,12 @@ In a nutshell, Arli relies on the publicly available database of the vast majori
 
 Sometimes, however, an Arduino library you use may not part of the main database. No problem! Just add the `url:` attribute together with the library name. The URL can either be a Github URL, or a URL to a downloadable ZIP file. Arli will figure out the rest. 
 
-### Arlifile
+### Arlifile and `bundle`
 
 `Arlifile` is a YAML-formatted file that looks like this below. We list all dependencies using the library names that are provided in the database (you can search for the libraries you need prior to populating this file):
 
 
-```yaml
-# vi:syntax=yaml
-# File: Arlifile
-version: 1.0.0
-dependencies:
-  - name: Time
-  - name: "Adafruit GFX Library"
-    version: '1.2.1'
-  - name: SimpleTimer
-    url: https://github.com/jfturcot/SimpleTimer
-```
+![](docs/arlifile.png)
 
 The libraries may be specified with a name and url only, in which case no search is performed, and the provided URL is used to install the library.  The library `SimpleTimer` above is not in the main database, therefore we provide URL for Arli to use.
 
@@ -53,12 +44,36 @@ You can provide the following fields in the Arilfile if you want the library to
 
 In all of the above cases, Arli will search the standard library database provided by the [Arduino official library database](http://downloads.arduino.cc/libraries/library_index.json.gz) JSON file.
 
-### Single Library Install
+#### Lock File `Arlifile.lock`
+
+The lock file is created every time `arli bundle` runs, and it's always in the same folder that the `Arlifile` itself.
+
+The purpose of this file is to document the resolved libraries installed. There are four formats that are supported:
+
+ * text 
+ * json
+ * yaml
+ * cmake
+
+Each format is sligthly different: YAML and JSON will simply include full library info, while text format includes resolved folder names, versions, and the download URL. 
 
-You can also install just a single library by passing `--name` flag (`-n`), for example:
+#### CMake Integration
+
+The CMake lock file is meant to be consumed by projects relying on the [arduino-cmake](https://github.com/arduino-cmake/arduino-cmake). We are still working on the complete integration, which would hopefully allow the following features:
+
+ * auto-generate Arduino project with library dependencies using cmake
+ * provide CMake plugin that runs `arli bundle -f cmake`, and reads the `Arlifile.lock.cmake`
+ * this will auto-generate each Arduino library into it's own static library, and then link your project with them all.
+
+**CMake Coming Soon!**
+
+
+### Single Library and `install`
+
+You can also install just a single library by using the `install` command, instead of the `bundle`. Install accepts either a `--lib-name` flag (`-n`), or a url `-u`, `--lib-url`, for example:
 
 ```bash
-arli install --name 'Adafruit GFX Library'
+arli install --lib-name 'Adafruit GFX Library'
 ```
 
 ## Gem Installation
@@ -77,8 +92,10 @@ Run `arli --help` for more information:
 
 ```bash
 Usage:
-    arli [ options ] [ command [ options ]  ]
+    arli options
+    arli command [ options ]
 
+    -C, --no-color         Disable any color output.
     -D, --debug            Print debugging info.
     -t, --trace            Print exception stack traces.
     -v, --verbose          Print more information.
@@ -87,17 +104,18 @@ Usage:
     -h, --help             prints this help
 
 Available Commands:
-    install      — installs libraries defined in Arlifile or by -n flag
-    search       — Flexible Search of the Arduino Library Database
+    search       — Search standard Arduino Library Database with over 4K entries
+    bundle       — Installs all libraries specified in Arlifile
+    install      — Installs a single library either by searching, or url or local ZIP
 
 See arli command --help for more information on a specific command.
 
-arli (0.6.1) © 2017 Konstantin Gredeskoul, MIT License.
+arli (0.8.2) © 2017 Konstantin Gredeskoul, MIT License.
 ```
 
-### Command `install`
+### Command `bundle`
 
-Use this command to install or re-install Arduino libraries.
+Use this command to install Arduino libraries.
 
 You can specify libraries in the `Arlifile` by providing just the `name:` (and posibly `version`) — the name must match exactly a library in the Arduino standard database. Alternatively, your can pass fields `archiveFileName`, `checksum` — which all uniquely identify a library in the database.
 
@@ -115,7 +133,7 @@ When Arli downloads libraries in ZIP format, they are unpacked into folder that
 
 #### An Example
 
-Here is the `arli install` command inside CMake-based project to build a [Wall Clock using Arduino](https://github.com/kigster/wallclock-arduino). This project has the following `Arlifile`:
+Here is the `arli bundle` command inside CMake-based project to build a [Wall Clock using Arduino](https://github.com/kigster/wallclock-arduino). This project has the following `Arlifile`:
 
 ```yaml
 # vi:syntax=yaml
@@ -135,35 +153,42 @@ dependencies:
 
 You can see that most libraries are specified by name, except one (SimpleTimer) is specified together with the URL, which will be used to `git clone` the library.
 
-So let's specify where our libraries live, and run `arli install` inside that project. Below is a screenshot of running `arli` inside of the Wall Clock Arduino project:
-
-![](docs/arli-in-action.png)
+So let's specify where our libraries live, and run `arli bundle` inside that project. Below is a screenshot of running `arli` inside of the Wall Clock Arduino project:
 
 
-Below is the complete help for the install command for reference:
+Below is the complete help for the `bundle` command for reference:
 
 
 ```bash
+❯ arli bundle -h
 Description:
-    installs libraries defined in Arlifile or by -n flag
+    Installs all libraries specified in Arlifile
 
-Usage:
-    arli install [options]
+    This command reads Arlifile (from the current folder, by default),
+    and then it installs all dependent libraries specified there, checking if
+    each already exists, and if not —  downloading them, and installing them into
+    your Arduino Library folder. Both the folder with the Arlifile, as well as the
+    destination library path folder can be changed with the command line flags.
 
-Command Options
-    -n, --name NAME        If provided a library name is searched and, if found
-                           installed. In this mode Arlifile not used.
+Usage:
+    arli bundle [options]
 
-    -l, --libraries PATH   Local folder where custom Arduino libraries are installed
-                           Defaults to ~/Dropbox/Workspace/oss/arduino/libraries
+Options
+    -l, --lib-path PATH    Destination: typically your Arduino libraries folder
+                           Defaults to ~/Documents/Arduino/Libraries
 
-    -a, --arli-path PATH   Folder where Arlifile is located,
+    -a, --arli-path PATH   An alternate folder with the Arlifile file.
                            Defaults to the current directory.
 
+    -f, --format FMT       Arli writes an Arlifile.lock with resolved info.
+                           The default format is text. Use -f to set it
+                           to one of: cmake, text, json, yaml
+
     -e, --if-exists ACTION If a library folder already exists, by default
                            it will be overwritten or updated if possible.
                            Alternatively you can either abort or backup
 
+    -C, --no-color         Disable any color output.
     -D, --debug            Print debugging info.
     -t, --trace            Print exception stack traces.
     -v, --verbose          Print more information.
@@ -172,11 +197,65 @@ Command Options
     -h, --help             prints this help
 
 Examples:
-     # Install all libs defined in the ./Arlifile file
-     arli install
+    # Install all libs defined in Arlifile:
+    arli bundle
 
-     # Install a single library matched by the --name flag
-     arli install -n "Adafruit GFX Library"```
+    # Custom Arlifile location, and destination path:
+    arli bundle -a ./src -l ./libraries
+```
+
+### Command `install`
+
+Use this command to install a single library by either a name or URL:
+
+Eg:
+
+```bash
+❯ be exe/arli install -n 'Adafruit GFX Library' -l ./libs
+❯ be exe/arli install -u 'https://github.com/jfturcot/SimpleTimer' -l ./libs
+```
+
+Complete help is:
+
+
+```bash
+❯ arli install -h
+Description:
+    Installs a single library either by searching, or url or local ZIP
+
+    This command installs a single library into your library path
+    using the third argument to the command arli install
+    which can be a library name, local ZIP file, or a remote URL
+    (either ZIP or Git Repo)
+
+Usage:
+    arli install [ "library name" | url | local-zip ]  [options]
+
+Options
+    -l, --lib-path PATH    Destination: typically your Arduino libraries folder
+                           Defaults to ~/Documents/Arduino/Libraries
+
+    -e, --if-exists ACTION If a library folder already exists, by default
+                           it will be overwritten or updated if possible.
+                           Alternatively you can either abort or backup
+
+    -C, --no-color         Disable any color output.
+    -D, --debug            Print debugging info.
+    -t, --trace            Print exception stack traces.
+    -v, --verbose          Print more information.
+    -q, --quiet            Print less information.
+    -V, --version          Print current version and exit
+    -h, --help             prints this help
+
+Examples:
+    # Install the latest version of this library
+    arli install "Adafruit GFX Library"
+
+    # Install the library from a Github URL
+    arli install https://github.com/jfturcot/SimpleTimer
+
+    # Install a local ZIP file
+    arli install ~/Downloads/DHT-Library.zip
 ```
 
 ### Command `search`
@@ -224,25 +303,47 @@ A detailed description of the complete search functionality is documented in the
 Below is the help screen for the search command:
 
 ```bash
+❯ arli search -h
 Description:
-    Flexible Search of the Arduino Library Database
+    Search standard Arduino Library Database with over 4K entries
+
+    This command provides both the simple name-based search interface,
+    and the most sophisticated field-by-field search using a downloaded,
+    and locally cached Public Arduino Database JSON file, maintained
+    by Arduino and the Community. If you know of another database,
+    that's what the --database flag is for.
 
 Usage:
-    arli search [ name-match | expression ] [options]
+    arli search [ name | search-expression ] [options]
 
-Command Options
-    -d FILE/URL,           a JSON file name, or a URL that contains the index
-        --database         Defaults to the Arduino-maintained list
+Options
+    -d, --database URL     a JSON(.gz) file path or a URL of the library database.
+                           Defaults to the Arduino-maintained database.
     -m, --max NUMBER       if provided, limits the result set to this number
-                           Defaults to 100
+                           Set to 0 to disable. Default is 100.
+    -C, --no-color         Disable any color output.
     -D, --debug            Print debugging info.
     -t, --trace            Print exception stack traces.
     -v, --verbose          Print more information.
+    -q, --quiet            Print less information.
     -V, --version          Print current version and exit
     -h, --help             prints this help
 
-Example:
-     arli search 'name: /AudioZero/, version: "1.0.1"'
+Examples:
+    # Search using the regular expression containing the name:
+    arli search AudioZero
+
+    # Same exact search as above, but using ruby hash syntax:
+    arli search 'name: /AudioZero/'
+
+    # Lets get a particular version of the library
+    arli search 'name: "AudioZero", version: "1.0,2"'
+
+    # Search using case insensitive name search, and :
+    arli search 'name: /adafruit/i'
+
+    # Finally, search for the exact name match:
+    arli search '^Time$'
 ```
 
 

data/arli.gemspec

@@ -28,14 +28,12 @@ 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.1'
+  spec.add_dependency 'arduino-library', '~> 0.5.4'
   spec.add_dependency 'colored2'
   spec.add_dependency 'hashie'
   spec.add_dependency 'dry-types'
   spec.add_dependency 'dry-struct'
   spec.add_dependency 'dry-configurable'
-  spec.add_dependency 'awesome_print'
-  spec.add_dependency 'archive-zip'
   spec.add_dependency 'tty-cursor'
 
 

data/exe/arli

@@ -1,6 +1,10 @@
 #!/usr/bin/env ruby
 
-require 'arli/cli/runner'
+require 'colored2'
+if %w(-C -Ch -hC --no-color).any? { |f| ARGV.include?(f) }
+  Colored2.disable!
+end
 
+require 'arli/cli/runner'
 Arli::CLI::Runner.new(ARGV.dup).execute!
 

data/lib/arli.rb

@@ -26,10 +26,10 @@ module Arli
     end
 
     def default_library_path
-      dehomify_path(self.config.libraries.path)
+      tilda_path(self.config.libraries.path)
     end
 
-    def dehomify_path(absolute_path)
+    def tilda_path(absolute_path)
       absolute_path.gsub(%r(#{ENV['HOME']}), '~')
     end
   end

data/lib/arli/actions.rb

@@ -6,6 +6,10 @@ module Arli
       def action(name)
         self.actions[name]
       end
+
+      def action_name(klass)
+        self.actions.invert[klass]
+      end
     end
   end
 end
@@ -13,6 +17,7 @@ end
 Arli::Actions.actions = {}
 
 require_relative 'actions/action'
-require_relative 'actions/zip_file'
+require_relative 'actions/unzip_file'
 require_relative 'actions/git_repo'
 require_relative 'actions/dir_name'
+require_relative 'actions/move_to_library_path'

data/lib/arli/actions/action.rb

@@ -7,12 +7,45 @@ module Arli
       include Arli::Output
 
       extend Forwardable
-      def_delegators :@library, :exists?, :path, :dir, :libraries_home
+      def_delegators :@library,
+                     :exists?,
+                     :path, :temp_path,
+                     :dir, :temp_dir,
+                     :libraries_home
 
       class << self
-        def inherited(klazz)
-          action_name                          = klazz.name.gsub(/.*::/, '').underscore.to_sym
-          ::Arli::Actions.actions[action_name] = klazz
+        def inherited(base)
+
+          base.instance_eval do
+            class << self
+              attr_writer :check_command, :check_pattern, :description
+
+              def action_name
+                name.gsub(/.*::/, '').underscore.to_sym
+              end
+
+              def set_or_get(var_name, val = nil)
+                var = "@#{var_name}".to_sym
+                self.instance_variable_set(var, val) if val
+                self.instance_variable_get(var)
+              end
+
+              def check_pattern(val = nil)
+                set_or_get('check_pattern', val)
+              end
+
+              def check_command(val = nil)
+                set_or_get('check_command', val)
+              end
+
+              def description(val = nil)
+                set_or_get('description', val)
+              end
+            end
+          end
+
+          # Add to the list of actions
+          ::Arli::Actions.actions[base.action_name] = base
         end
       end
 
@@ -23,50 +56,37 @@ module Arli
         self.config  = config
       end
 
-      def act(**_opts)
-        raise 'Abstract method #act called on Action'
-      end
-
-      def overwrite?
-        config.install.if_exists.overwrite
+      def run!
+        execute
+      rescue Exception => e
+        action_fail(self, e)
       end
 
-      def backup?
-        config.install.if_exists.backup
-      end
-
-      def abort?
-        config.install.if_exists.abort
+      def supported?
+        return @supported if defined?(@supported)
+        if self.class.check_command && self.class.check_pattern
+          @supported = (`#{self.class.check_command} 2>/dev/null | grep "#{self.class.check_pattern}"`.chomp != '')
+        else
+          @supported = true
+        end
       end
 
       def mv(from, to)
-        handle_preexisting_folder(to)
         FileUtils.mv(from, to)
       end
 
-      def handle_preexisting_folder(to)
-        if Dir.exist?(to)
-          if abort?
-            raise ::Arli::Errors::LibraryAlreadyExists, "Directory #{to} already exists"
-          elsif backup?
-            backup!(to)
-          elsif overwrite?
-            FileUtils.rm_rf(to)
-          end
-        end
+      def to_s
+        "<Action:#{(Arli::Actions.action_name(self) || 'unknown action').bold.blue}: lib=#{library.name}>"
       end
 
-      def backup!(p)
-        if Dir.exist?(p)
-          backup_path = "#{p}.arli-backup-#{Time.now.strftime('%Y%m%d%H%M%S')}"
-          FileUtils.mv(p, backup_path)
-          if config.verbose
-            ___ "\nNOTE: path #{p.blue} has been backed up to #{backup_path.bold.green}\n"
-          elsif !config.quiet
-            ___ ' backed up and'
-          end
-        end
+      protected
+
+      def execute(**_opts)
+        raise Arli::Errors::AbstractMethodCalled,
+              'Abstract method #execute called on Base'
       end
+
+
     end
   end
 end