arli 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 716b1c4d72d5a8d569c26ca80f0bd0c86d260414
-  data.tar.gz: ccb615215a6b8ecbcf129f9a2feb94a190a1c98b
+  metadata.gz: 1457403161e523852f76082f9c5549abcaeb4277
+  data.tar.gz: 9835a1952e3a3baf19ff0e795d71851b9c4d7bab
 SHA512:
-  metadata.gz: e403f0d96a42d0d21a37e5da72e882e497c045f0139ae210b7a83f9a2ec4cf63ddda3e359055daf8379f7869b500f25e302fe5791e88d83b50bbfdff8d91d48c
-  data.tar.gz: 7444ed04113582cf6abe9bcbc54bb1141803469b7e731ab2af575f94b5f83faa1c03e8e6cc0e6b7092b03acd66a1d9a4e53aa5378c6c563b6471b851542863e2
+  metadata.gz: d0478e06f8baf8e6a71591128d917947d3017d118c3ff231edd0c0d63e1167134912c8cc950409c6dcdc0803bd1a8525bd932ab64d60285c1f708eea68cf06e0
+  data.tar.gz: 3a1498015f130059065f2c21fb3fb11eb12316579a082d73d3c6ea2144780497909b6b801ae16256093f9a66f7efb4f82ff9a4107efca54a56411bf0d53d4269

data/Gemfile

@@ -2,4 +2,6 @@ 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

@@ -5,24 +5,61 @@
 
 # Arli
 
-Arli is a simple and easy to use Arduino Dependency Manager, that uses a
-a YAML formatted file declaring dependencies, as follows:
+Arli is an awesomely simple and very easy to use Arduino Library Installer. It allows your Arduino projects to be portable by including a small text file called `Arlifile` that defines your project's Arduino library dependencies. Using either this file, or command line flags, Arli is able to search for libraries, install them locally to a custom location, and do it all consistently and reliably.
+
+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`:
+
+![](docs/arli-in-action.png)
+
+
+## Overview
+
+### How Does It Work?
+
+In a nutshell, Arli relies on the publicly available database of the vast majority of public Ardiuino libraries. This database is maintained by Arduino themselves, and is a [giant gzipped JSON file](http://downloads.arduino.cc/libraries/library_index.json.gz). Arli automatically downloads and caches the index on a local file system, and then lets you search and install libraries using either a simple name search, or more sophisticated ruby-like syntax that supports searching for ANY attribute as an equal match, or a regular expressions, or even a [Proc](http://ruby-doc.org/core-2.4.2/Proc.html).
+
+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` 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
 ```
 
-The libraries may be specified with a name and url only (in which case the URL will be used to install it), OR a library can be specified by name (and optionally version). In this case, it will be searched among the standard library index provided by the [Arduino official library database](http://downloads.arduino.cc/libraries/library_index.json.gz) JSON file.
+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.
+
+If the URL is not provided, you can specify one of several fields that are searched for a matching library. Remember, in this case Arli must find one and only one library to install, otherwise it will throw an error.
+
+You can provide the following fields in the Arilfile if you want the library to be installed from the central database:
 
-The gem was created to fill the need of slightly more complex Arduino projects that DO NOT use Arduino IDE, and instead use other technologies, such as `ArduinoCmake`  in managing many Arduino libraries  in a consistent way. Arli's API was loosely inspired by Bundler.
+ * `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. Without this field, and if the `name` is provided, the latest version is used.
+ * `checksum` and `archiveFileName` can be used as they both uniquely identify a library.
 
-## Installation
+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
+
+You can also install just a single library by passing `--name` flag (`-n`), for example:
+
+```bash
+arli install --name 'Adafruit GFX Library'
+```
+
+## Gem Installation
 
 Install the `arli` ruby gem as follows:
 
@@ -37,38 +74,44 @@ $ gem install arli
 Run `arli --help` for more information:
 
 ```bash
-age:
+Usage:
     arli [ options ] [ command [ options ]  ]
 
     -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
 
 Available Commands:
-    install      — installs libraries defined in Arlifile
+    install      — installs libraries defined in Arlifile or by -n flag
     search       — Flexible Search of the Arduino Library Database
 
 See arli command --help for more information on a specific command.
+
+arli (0.6.1) © 2017 Konstantin Gredeskoul, MIT License.
 ```
 
-#### Install Command
+### Command `install`
 
-Use this command to install or re-install libraries.
+Use this command to install or re-install Arduino libraries.
 
-You can specify libraries in the `Arlifile` by providing either just the `name:` (and posibly `version`) — the name must match exactly a library in the Arduino standard database. Alternatively, your can pass `archiveFileName`, `checksum` — which all uniquely identify a library in the database.
+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.
 
-Sometimes a library will not be in the database, in which case just provide the name and `url` field for it. The URL can either be a git URL, or a downloadable ZIP file.
+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.
 
+#### Automatic Folder Name Correction
 
-##### Automatic Folder Name Correction
+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.
 
-Arli has an build-in action that's invoked during installation of the libraries: once the library is upacked into a folder (either using git or unzip), it's contents is searched for source files. The name of the directory is then compared to the files found, and in some cases Arli will rename the library folder to match the source files.
+When Arli downloads libraries in ZIP format, they are unpacked into folder that are named differently. Arli will then search that folder for the source and header files. The name of the directory is then compared to the files found, and in some cases Arli will automatically **rename the library folder to match the main header file.**. 
 
-For example, 'Adafruit GFX Library' is the proper name of the corresponding library, and it's ZIP archive will unpack into `Adafruit_GFX_Library-1.4.3` folder.  Arli will first remove the version number, and move it to `Adafruit_GFX_Library`, but then it will detect that the file inside is `Adafruit_GFX.h`, and so the top-level folder gets renamed to `Adafruit_GFX` as well. This is an audacious attempt to make sense of the chaos that is the Arduino Library world.
+> 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. 
+> 
+> This is an audacious attempt to make sense of the chaos that is the Arduino Library world.
 
-##### An Example
+#### 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`:
 
@@ -89,48 +132,26 @@ 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:
+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:
 
-```bash
-❯ export ARDUINO_CUSTOM_LIBRARY_PATH=~/Documents/Arduino/libraries/
-❯ cd skethes/wallclock-arduino
-❯ arli install
-Adafruit GFX Library (1.2.2) ....... (Adafruit_GFX)
-DS1307RTC (1.4.0) ......
-Adafruit LED Backpack Library (1.1.6) ....... (Adafruit_LEDBackpack)
-Adafruit Unified Sensor (1.0.2) ....... (Adafruit_Sensor)
-DHT sensor library (1.3.0) ....... (DHT)
-OneButton (1.2.0) .......
-SimpleTimer running git clone -v https://github.com/jfturcot/SimpleTimer.git ~/Documents/Arduino/libraries/SimpleTimer 2>&1 .
-s (1.5.0) ......
-```
+![](docs/arli-in-action.png)
 
-Now, we can inspect the library folder and observe that all of the specified libraries have been installed, and into correct folders:
-
-```bash
-❯ ls -1 ~/Documents/Arduino/libraries
-Adafruit_GFX
-DS1307RTC
-Adafruit_LEDBackpack
-Adafruit_Sensor 
-DHT
-OneButton
-SimpleTimer
-Time
-```
 
-Below is the complete help for the install command:
+Below is the complete help for the install command for reference:
 
 
 ```bash
 Description:
-    installs libraries defined in Arlifile
+    installs libraries defined in Arlifile or by -n flag
 
 Usage:
     arli install [options]
 
 Command Options
-    -l, --libraries PATH   Local folder where libraries are installed
+    -n, --name NAME        If provided a library name is searched and, if found
+                           installed. In this mode Arlifile not used.
+
+    -l, --libraries PATH   Local folder where custom Arduino libraries are installed
                            Defaults to ~/Dropbox/Workspace/oss/arduino/libraries
 
     -a, --arli-path PATH   Folder where Arlifile is located,
@@ -143,25 +164,33 @@ Command Options
     -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 all libs defined in the ./Arlifile file
+     arli install
+
+     # Install a single library matched by the --name flag
+     arli install -n "Adafruit GFX Library"```
 ```
 
-#### Search Command
+### Command `search`
 
 To search Arduino library database, you can use the search command.
 
 You can search in two ways:
 
- 1. simple name match
+ 1. simple substrin match of the library name
  2. complex arbitrary attribute match, that supports regular expressions and more.
 
-`arli search AudioZero` does a simple search by name, and returns 3 results:
+`arli search AudioZero` does a simple search by name, and would match any library with 'AudioZero' in the name, such as `AudioZeroUpdated`. This search returns three results sorted by the version number:
 
 ```bash
 ❯ arli search AudioZero
-AudioZero (1.0.1), by Arduino
 AudioZero (1.0.0), by Arduino
+AudioZero (1.0.1), by Arduino
 AudioZero (1.1.1), by Arduino
 
 Total matches: 3
@@ -169,12 +198,10 @@ Total matches: 3
 
 The search argument can also be a ruby-syntaxed expression, that (if you know ruby)  is actually `eval`-ed into the method parameters. Here are a few examples:
 
-
-
 You can also use regular expressions, and set maximum number of results printed by the `-m MAX` flag.
 
 ```bash
-❯ arli search 'name: /adafruit/i' -m 0
+❯ arli search 'name: /adafruit/i' 
 Adafruit ADS1X15 (1.0.0), by Adafruit
 Adafruit ADXL345 (1.0.0), by Adafruit
 Adafruit AM2315 (1.0.0), by Adafruit

data/arli.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dry-configurable'
   spec.add_dependency 'awesome_print'
   spec.add_dependency 'archive-zip'
+  spec.add_dependency 'tty-cursor'
 
 
   spec.add_development_dependency 'yard'

data/lib/arli/actions.rb

@@ -16,4 +16,3 @@ require_relative 'actions/action'
 require_relative 'actions/zip_file'
 require_relative 'actions/git_repo'
 require_relative 'actions/dir_name'
-require_relative 'actions/backup'

data/lib/arli/actions/action.rb

@@ -11,7 +11,7 @@ module Arli
 
       class << self
         def inherited(klazz)
-          action_name = klazz.name.gsub(/.*::/, '').underscore.to_sym
+          action_name                          = klazz.name.gsub(/.*::/, '').underscore.to_sym
           ::Arli::Actions.actions[action_name] = klazz
         end
       end
@@ -27,6 +27,46 @@ module Arli
         raise 'Abstract method #act called on Action'
       end
 
+      def overwrite?
+        config.install.if_exists.overwrite
+      end
+
+      def backup?
+        config.install.if_exists.backup
+      end
+
+      def abort?
+        config.install.if_exists.abort
+      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
+      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
+      end
     end
   end
 end

data/lib/arli/actions/dir_name.rb

@@ -19,23 +19,30 @@ module Arli
         # but we found header Adafruit_Sensor we should
         # rename the folder
 
-        return if headers.include?(dir)
-        return if sources.include?(dir)
+        if headers.include?(dir) || sources.include?(dir)
+          print_target_dir(dir)
+        else
+          # if we end up setting this, we'll also move the folder.
+          canonical_dir =
+              if_only_one(headers) ||
+                  if_only_one(sources) ||
+                  if_header_a_substring(headers)
 
-        ___
+          if canonical_dir
+            library.canonical_dir = canonical_dir
+            mv(dir, library.canonical_dir)
+            print_target_dir(canonical_dir)
+          else
+            library.canonical_dir = dir
+            print_target_dir(dir)
+          end
+        end
 
-        # if we end up setting this, we'll also move the folder.
-        canonical_dir =
-            if_only_one(headers) ||
-            if_only_one(sources) ||
-            if_header_a_substring(headers)
 
-        if canonical_dir
-          library.canonical_dir = canonical_dir
-          FileUtils.rm_rf(canonical_dir) if Dir.exist?(canonical_dir)
-          ___ " (#{canonical_dir.bold.green}) "
-          FileUtils.mv(dir, library.canonical_dir)
-        end
+      end
+
+      def print_target_dir(d)
+        ___ " installed to #{d.green} #{'✔'.green}" unless Arli.config.quiet
       end
 
       def if_header_a_substring(files)

data/lib/arli/actions/git_repo.rb

@@ -5,20 +5,18 @@ module Arli
 
       def act
         c = library.exists? ? git_update_command : git_clone_command
-        ___ 'running ' + c.blue + ' '
         execute(c)
-        ok
       rescue Exception => e
         fuck
         raise e
       end
 
       def git_update_command
-        "cd #{path} && git pull --rebase 2>&1"
+        "cd #{library.path} && git pull --rebase 2>&1"
       end
 
       def git_clone_command
-        "git clone -v #{library.url} #{path} 2>&1"
+        "git clone -v #{library.url} #{library.dir} 2>&1"
       end
 
       protected
@@ -36,8 +34,6 @@ module Arli
                 "Current folder is [#{Dir.pwd.yellow}]", e
         raise e
       end
-
-
     end
   end
 end

data/lib/arli/actions/zip_file.rb

@@ -4,20 +4,14 @@ require_relative 'action'
 module Arli
   module Actions
     class ZipFile < Action
-
       def act
-        ___
+        # TODO: verify that this works if backup option is provided
         library.rm_rf!
         download!
         if File.exist?(zip_archive)
-          ok; ___
           FileUtils.rm_rf(zip_folder) if zip_folder
           unzip(zip_archive, '.')
-          if Dir.exist?(zip_folder)
-            ok; ___
-            FileUtils.move(zip_folder, dir)
-            ok
-          end
+          FileUtils.move(zip_folder, dir) if Dir.exist?(zip_folder)
         end
       rescue Exception => e
         fuck

data/lib/arli/arli_file.rb

@@ -17,17 +17,20 @@ module Arli
                   :file,
                   :library_path
 
-    def initialize(config: Arli.config)
+    def initialize(config: Arli.config, libraries: [])
       self.library_path = config.libraries.path
-      self.file         = "#{config.arlifile.path}/#{config.arlifile.name}"
+      FileUtils.mkpath(library_path) unless Dir.exist?(library_path)
 
-      unless file && File.exist?(file)
-        raise(Arli::Errors::ArliFileNotFound,
-              "Arlifile could not be found at\n#{file.bold.yellow}")
+      if libraries && !libraries.empty?
+        self.dependencies = libraries.map{ |lib| make_lib(lib) }
+      else
+        self.file         = "#{config.arlifile.path}/#{config.arlifile.name}"
+        unless file && File.exist?(file)
+          raise(Arli::Errors::ArliFileNotFound,
+                "Arlifile could not be found at\n#{file.bold.yellow}")
+        end
+        self.dependencies = parse_file
       end
-
-      FileUtils.mkpath(library_path) unless Dir.exist?(library_path)
-      self.dependencies = parse_file
     end
 
     def within_library_path
@@ -44,9 +47,11 @@ module Arli
 
     def parse_file
       self.file_hash = ::YAML.load(::File.read(self.file))
-      file_hash['dependencies'].map do |lib|
-        ::Arli::Library.new(::Arduino::Library::Model.from(lib))
-      end
+      file_hash['dependencies'].map { |lib| make_lib(lib) }
+    end
+
+    def make_lib(lib)
+      ::Arli::Library.new(::Arduino::Library::Model.from(lib))
     end
   end
 end

data/lib/arli/cli/app.rb

@@ -25,10 +25,12 @@ module Arli
       def start
         if argv.empty?
           factory.default_help
+          factory.global_parser.print_version_copyright
           return
         end
 
         parse_global_flags
+
         return if Arli.config.help
 
         finder = CommandFinder.new(argv, config: config)
@@ -58,7 +60,7 @@ module Arli
 
       def execute!
         if command
-          header(command: command) if config.verbose
+          header(command: command) unless config.quiet
           command.run
         else
           factory.default_help

data/lib/arli/cli/parser.rb

@@ -20,6 +20,13 @@ module Arli
         separator text || ''
       end
 
+      def option_install
+        option_library_name
+        option_lib_home
+        option_dependency_file
+        option_if_exists
+      end
+
       def option_dependency_file
         on('-a', '--arli-path PATH',
            'Folder where ' + 'Arlifile'.green + ' is located,',
@@ -28,9 +35,17 @@ module Arli
         end
       end
 
+      def option_library_name
+        on('-n', '--name NAME',
+           'If provided a library name is searched and, if found',
+           'installed. In this mode Arlifile not used.' + "\n\n") do |v|
+          config.install.library_names << { name: v }
+        end
+      end
+
       def option_lib_home
         on('-l', '--libraries PATH',
-           'Local folder where libraries are installed',
+           'Local folder where custom Arduino libraries are installed',
            "Defaults to #{Arli.default_library_path}\n\n") do |v|
           config.libraries.path = v
         end
@@ -38,19 +53,19 @@ module Arli
 
       def option_search
         on('-d', '--database FILE/URL',
-           'a JSON file name, or a URL that contains the index',
-           'Defaults to the Arduino-maintained list') do |v|
+           'a JSON(.gz) file path or a URL of the library database.',
+           'Defaults to the Arduino-maintained database.') do |v|
           config.database.path = v
         end
 
         on('-m', '--max NUMBER',
            'if provided, limits the result set to this number',
-           'Defaults to 100') do |v|
+           'Set to 0 to disable. Default is 100.') do |v|
           config.search.results.limit = v.to_i if v
         end
       end
 
-      def option_abort_if_exists
+      def option_if_exists
         on('-e', '--if-exists ACTION',
            'If a library folder already exists, by default',
            'it will be overwritten or updated if possible.',
@@ -83,13 +98,25 @@ module Arli
           output_help
           output_command_help if commands
 
-          if command_hash && command_hash[:example]
-            output 'Example:'
-            output '     ' + command_hash[:example]
+          if command_hash && command_hash[:examples]
+            output_examples(command_hash[:examples])
+          else
+            print_version_copyright
           end
         end
       end
 
+      def output_examples(examples)
+        output 'Examples:'
+        indent = '     '
+        examples.each do |example|
+          output
+          output indent + '# ' + example[:desc]
+          output indent + example[:cmd].green
+          output ''
+        end
+      end
+
       def option_help_with_subtext
         option_help
       end
@@ -111,7 +138,6 @@ module Arli
         subtext << <<-EOS
 
 See #{Arli::Configuration::ARLI_COMMAND.blue + ' command '.green + '--help'.yellow} for more information on a specific command.
-
         EOS
         subtext
       end
@@ -142,12 +168,21 @@ See #{Arli::Configuration::ARLI_COMMAND.blue + ' command '.green + '--help'.yell
            'Print more information.') do |v|
           config.verbose = true
         end
+        on('-q', '--quiet',
+           'Print less information.') do |v|
+          config.quiet = true
+        end
         on('-V', '--version',
            'Print current version and exit') do |v|
-          puts 'Version: ' + Arli::VERSION
-          exit
+          print_version_copyright
+          Arli.config.help = true
         end
       end
+
+      def print_version_copyright
+        output << Arli::Configuration::ARLI_COMMAND.bold.yellow + ' (' + Arli::VERSION.bold.green + ')' +
+            " © 2017 Konstantin Gredeskoul, MIT License."
+      end
     end
   end
 end

data/lib/arli/cli/parser_factory.rb

@@ -21,7 +21,7 @@ module Arli
 
         def make_parser(command = nil, &block)
           ::Arli::CLI::Parser.new(command: command,
-                                  config: Arli.config, &block)
+                                  config:  Arli.config, &block)
         end
 
         def global_parser
@@ -35,23 +35,41 @@ module Arli
         def command_parsers
           @command_parsers ||= {
               install: {
-                  description: 'installs libraries defined in Arlifile',
+                  description: 'installs libraries defined in Arlifile or by -n flag',
+                  examples:    [
+                                   { desc: 'Install all libs defined in the ./Arlifile file',
+                                     cmd:  'arli install' },
+                                   { desc: 'Install a single library matched by the --name flag',
+                                     cmd:  'arli install -n "Adafruit GFX Library"' }
+                               ],
+
                   parser:      -> (command_name) {
                     make_parser(command_name) do |parser|
                       parser.banner = usage_line 'install'
-                      parser.option_lib_home
-                      parser.option_dependency_file
-                      parser.option_abort_if_exists
+                      parser.option_install
                       parser.option_help(command_name: command_name)
                     end
                   } },
 
               search:  {
                   description: 'Flexible Search of the Arduino Library Database',
-                  example:     'arli search '.green + %Q['name: /AudioZero/, version: "1.0.1"'].green,
+                  examples:    [
+                                   { desc: 'Search using the regular expression containing the name:',
+                                     cmd:  'arli search AudioZero' },
+
+                                   { desc: 'Same exact search as above, but using advanced ruby hash arguments syntax:',
+                                     cmd:  %Q{arli search 'name: /AudioZero/'} },
+
+                                   { desc: 'Search using case insensitive name search:',
+                                     cmd:  %Q{arli search 'name: /adafruit/i'} },
+
+                                  { desc: 'Finally, search for the exact name match:',
+                                     cmd:  %Q{arli search '^Time$'} },
+                               ],
+
                   parser:      -> (command_name) {
                     make_parser(command_name) do |parser|
-                      parser.banner = usage_line 'search ' + '[ name-match | expression ]'.magenta
+                      parser.banner = usage_line 'search ' + '[ name | search-expression ]'.magenta
                       parser.option_search
                       parser.option_help(command_name: command_name)
                     end
@@ -60,6 +78,7 @@ module Arli
           }
         end
 
+
         def commands
           command_parsers.keys
         end

data/lib/arli/commands/install.rb

@@ -15,11 +15,13 @@ module Arli
       end
 
       def setup
-        self.arlifile = Arli::ArliFile.new(config: config)
+        self.arlifile = Arli::ArliFile.new(
+            config:    config,
+            libraries: Arli.config.install.library_names)
       end
 
       def params
-        arlifile.file
+        "libraries: \n • " + arlifile.dependencies.map(&:name).join("\n • ")
       end
 
       def run

data/lib/arli/commands/search.rb

@@ -57,7 +57,7 @@ module Arli
 
       def run
         self.results = search(database, **search_opts)
-        results.map do |lib|
+        results.sort.map do |lib|
           puts pretty_library(lib)
         end
         puts "\nTotal matches: #{results.size.to_s.bold.magenta}"

data/lib/arli/configuration.rb

@@ -43,7 +43,7 @@ module Arli
     end
 
     setting :install do
-      setting :library
+      setting :library_names, []
       setting :if_exists do
         setting :overwrite, true
         setting :backup, false
@@ -55,7 +55,7 @@ module Arli
     setting :trace, false
     setting :verbose, false
     setting :help, false
-    setting :command_help, false
+    setting :quiet, false
   end
 end
 

data/lib/arli/installer.rb

@@ -27,6 +27,7 @@ module Arli
         fuck
       else
         ___ "(#{library.version.green}) " if library.version
+        ___ cursor.column(45) unless config.quiet
         actions(library).each do |action|
           run_action(action)
         end
@@ -41,7 +42,6 @@ module Arli
 
     def actions(library)
       actions = []
-      actions << :backup if exists?
       # First, how do we get the library?
       actions << ((library.url =~ /\.zip$/i) ? :zip_file : :git_repo)
       actions << :dir_name

data/lib/arli/output.rb

@@ -1,10 +1,11 @@
 require 'colored2'
+require 'tty-cursor'
 
 module Arli
   module Output
 
     class << self
-      attr_accessor :enabled
+      attr_accessor :enabled, :cursor
       def enable!
         self.enabled = true
       end
@@ -17,6 +18,11 @@ module Arli
     end
 
     self.enable!
+    self.cursor = TTY::Cursor
+
+    def cursor
+      Arli::Output.cursor
+    end
 
     def info(msg, header = nil)
       __pf('%-20s', header.blue) if header
@@ -52,7 +58,6 @@ module Arli
     def ___(msg = nil, newline = false)
       return unless Arli::Output.enabled?
       __pf msg if msg
-      __p '.'.green if msg.nil?
       __pt if newline
     end
 
@@ -69,17 +74,21 @@ module Arli
     end
 
     def ok
-      ___ '.'.bold.green
+      ___ '.'.green
+    end
+
+    def check
+      ___ '✔'.green
     end
 
     def fuck
-      ___ '✖'.bold.red
+      ___ '✖'.red
     end
 
     def header(command: nil)
       out = "\n#{hr}\n"
       out << "Arli (#{::Arli::VERSION.yellow})"
-      out << " running #{command.name.to_s.magenta.bold}" if command
+      out << " running command #{command.name.to_s.magenta.bold}" if command
       out << " for #{command.params.to_s.blue}\n" if command
       out << "Library Path: #{Arli.default_library_path.green}\n"
       out << "#{hr}\n"
@@ -87,7 +96,7 @@ module Arli
     end
 
     def hr
-      '——————————————————————————————————————————————————————————'.red
+      ('-' * (ENV['COLUMNS'] || 80)).red.dark
     end
 
   end

data/lib/arli/version.rb

@@ -1,3 +1,3 @@
 module Arli
-  VERSION = '0.6.1'.freeze
+  VERSION = '0.6.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arli
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-27 00:00:00.000000000 Z
+date: 2017-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arduino-library
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-cursor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -241,11 +255,12 @@ files:
 - arli.gemspec
 - bin/console
 - bin/setup
+- docs/arli-full.png
+- docs/arli-in-action.png
 - exe/arli
 - lib/arli.rb
 - lib/arli/actions.rb
 - lib/arli/actions/action.rb
-- lib/arli/actions/backup.rb
 - lib/arli/actions/dir_name.rb
 - lib/arli/actions/git_repo.rb
 - lib/arli/actions/zip_file.rb

data/lib/arli/actions/backup.rb

@@ -1,30 +0,0 @@
-require_relative 'action'
-
-module Arli
-  module Actions
-    class Backup < Action
-
-      def act(**options)
-        return false unless exists?
-
-        if backup_action.abort
-          raise Arli::Errors::LibraryAlreadyExists, path
-        elsif backup_action.backup
-          FileUtils.mv(path, backup_library_path)
-        elsif backup_action.overwrite
-          library.rm_rf!
-        end
-      end
-
-      def backup_action
-        config.install.if_exists
-      end
-
-      private
-
-      def backup_library_path
-        path + ".#{Time.now.strftime('%Y%m%d%H%M%S')}"
-      end
-    end
-  end
-end