arli 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adcc3fbbb5dd94f24a30c1662c9770bb010eab0e
-  data.tar.gz: 3ac5b432418cf52430e664b5409e9377f83959ab
+  metadata.gz: 818b4b5c9c83de430b9c59f4487731ee42cca089
+  data.tar.gz: 8a2bce6807e0a4a84245d62bcc0780386bd46244
 SHA512:
-  metadata.gz: 4301495fc38c55dc8ce4a4dc4062b87e87bb325ab40c7607427a9650d2b135cf7e78a6e693211e44428cae27ae8bc40965add0784e9deb5f7548c82571bea007
-  data.tar.gz: d9f2ff1345a4d6205b1258e4a81574bb58496386526a60700aaea95637113fadd293dd3edcaf0bef175890b807a4362fbd1c0619b2255161c4b29031a8f19e0d
+  metadata.gz: a8eae4bcea44a72f7fe9411ac2efe3c8eec1de049b44f5829620a3d9255ee351738919c855134e4060f1931102a37b11c95abbcb0bc32b9a6fdbd878bd78ab4a
+  data.tar.gz: 8f28ec1d5c3e7ad1736ac89e3be18fe9bd003f5ddc10f908e3547cf226a34437fd89f614fe375439b0052798668bc7876277088486be33297eba51e130a1257b

data/README.md

@@ -21,6 +21,10 @@ Arli can:
 
  * **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.
 
+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)
+
 ### 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._ 

data/arli.gemspec

@@ -5,11 +5,13 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'arli/version'
 
 Arli::DESCRIPTION = <<-eof
-  This is an Arduino Library manager, compatible with the "arduino-cmake" project. 
-  Arli offers a powerful command-line tool to manage any number of dependent Github
-  projects, or official Arduino libraries. Arli was created to offer Arduino-based 
-  projects of moderate to high complexity an easy way to reference external libraries
-  and install them at build time, instead of committing them into the project repo.
+  This is an Arduino helper toolkit that builds on top of the arduino-cmake
+  project — a powerful alternative build system for Arduino. What Arli provides
+  is capability to search for libraries by any attributes and regular expressions,
+  install a whole set of libraries defined in a YAML file Arlifile, and finally,
+  it can generate a brand new Sketch Project based on arduino-cmake, that builds
+  out the box. Arli is a command line tool, so run "arli" after installing the gem
+  for more information.
 eof
 
 Gem::Specification.new do |spec|

data/lib/arli/cli/command_finder.rb

@@ -40,7 +40,7 @@ module Arli
         return nil unless non_flag_argument?
         cmd = argv.shift.to_sym
         if factory.valid_command?(cmd)
-          cmd
+          factory.command_from_arg(cmd)
         else
           raise_invalid_arli_command!(cmd)
         end

data/lib/arli/cli/parser.rb

@@ -140,7 +140,7 @@ module Arli
           output_examples(command_hash[:examples]) if command_hash && command_hash[:examples]
           output_command_help if commands
           output_help
-
+          output_command_aliases(command_name) if command_name
           print_version_copyright
         end
       end
@@ -246,9 +246,12 @@ See #{Arli::Configuration::ARLI_COMMAND.blue + ' command '.green + '--help'.yell
             ' © 2017 Konstantin Gredeskoul, MIT License.'.dark unless Arli.config.quiet
       end
 
+      def indent
+        '    '
+      end
+
       def output_command_description(command_name)
         command_hash = factory.command_parsers[command_name]
-        indent       = '    '
 
         if command_hash
           if command_hash.description
@@ -265,6 +268,16 @@ See #{Arli::Configuration::ARLI_COMMAND.blue + ' command '.green + '--help'.yell
 
         command_hash
       end
+
+      private
+      def output_command_aliases(command_name)
+        command_aliases = factory.command_aliases(command_name) || []
+        unless command_aliases.empty?
+          header 'Aliases'
+          output indent + command_aliases.join(', ').bold.blue
+          output << ''
+        end
+      end
     end
   end
 end

data/lib/arli/cli/parser_factory.rb

@@ -35,7 +35,7 @@ module Arli
 
         def command_parsers
           @command_parsers ||= {
-              search:  Hashie::Mash.new(
+              search:   Hashie::Mash.new(
                   {
                       sentence:    'Search standard Arduino Library Database with over 4K entries ',
                       description: %Q[This command provides both the simple name-based search interface,
@@ -75,7 +75,7 @@ module Arli
                       }
                   }),
 
-              generate:  Hashie::Mash.new(
+              generate: Hashie::Mash.new(
                   {
                       sentence:    'Generates a new Arduino project with Arlifile',
 
@@ -107,24 +107,24 @@ module Arli
                       }
                   }),
 
-              bundle:  Hashie::Mash.new(
+              bundle:   Hashie::Mash.new(
                   {
-                      sentence: 'Installs all libraries specified in Arlifile',
+                      sentence:    'Installs all libraries specified in Arlifile',
                       description: %Q[This command reads #{'Arlifile'.bold.green} (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.
                                 ],
-                      example: [
-                                    { desc: 'Install all libs defined in Arlifile:',
-                                      cmd:  'arli bundle ' },
+                      example:     [
+                                       { desc: 'Install all libs defined in Arlifile:',
+                                         cmd:  'arli bundle ' },
 
-                                    { desc: 'Custom Arlifile location, and destination path:',
-                                      cmd:  'arli bundle -a ./src -l ./libraries' }
-                                ],
+                                       { desc: 'Custom Arlifile location, and destination path:',
+                                         cmd:  'arli bundle -a ./src -l ./libraries' }
+                                   ],
 
-                      parser:   -> (command_name) {
+                      parser:      -> (command_name) {
                         make_parser(command_name) do |parser|
                           parser.banner = usage_line 'bundle'
                           parser.option_bundle
@@ -132,7 +132,7 @@ module Arli
                         end
                       } }),
 
-              install: Hashie::Mash.new(
+              install:  Hashie::Mash.new(
                   {
                       sentence:    'Installs a single library either by searching, or url or local ZIP',
                       description: %Q[This command installs a single library into your library path
@@ -160,17 +160,41 @@ module Arli
           }
         end
 
+        def aliases
+          {
+              s:   :search,
+              ser: :search,
+              i:   :install,
+              ins: :install,
+              g:   :generate,
+              gen: :generate,
+              b:   :bundle,
+              bun: :bundle
+          }
+        end
+
+        def command_aliases(cmd)
+          aliases.keys.select { |k| aliases[k] == cmd }
+        end
 
         def commands
           command_parsers.keys
         end
 
         def valid_command?(command)
-          commands.include?(command)
+          commands.include?(command) || aliases[command]
+        end
+
+        def command_from_arg(arg)
+          if commands.include?(arg)
+            arg
+          elsif aliases[arg]
+            aliases[arg]
+          end
         end
 
         def command_parser(cmd)
-          cmd_hash = command_parsers[cmd]
+          cmd_hash = command_parsers[cmd] || command_parsers[aliases[cmd]]
           cmd_hash ? cmd_hash[:parser].call(cmd) : nil
         end
 

data/lib/arli/commands/generate.rb

@@ -15,7 +15,6 @@ module Arli
 
       attr_accessor :settings, :dir
 
-
       def setup
         config.generate.project_name = config.runtime.argv.first
 
@@ -32,40 +31,45 @@ module Arli
       def run
         Dir.chdir(workspace) do
           run_with_info(
-              "grabbing the template from\n • #{template_repo.bold.green}...",
+              "Grabbing the template from\n • #{template_repo.bold.green}...",
               "git clone -v #{template_repo} #{project_name} 2>&1"
           )
           Dir.chdir(project_name) do
             FileUtils.rm_rf('.git')
             FileUtils.rm_rf('example')
             run_with_info(
-                "configuring the new project #{project_name.bold.yellow}",
+                "Configuring the new project #{project_name.bold.yellow}",
                 'git init .'
             )
-            run_with_info('customizing your README and other files...')
+            run_with_info('Customizing your README and other files...')
             rename_files!
             configure_template!
             run_with_info(
-                'running bin/build — to setup and build the project',
+                'Running setup of the dependencies...',
+                'bin/setup'
             )
-            system('bin/build setup')
-            puts '[OK]'.bold.green
+            run_with_info("The project #{project_name.bold.yellow} is ready.\n" +
+                              'Follow README.md for build instructions.')
           end
         end
+        __pt hr
       end
 
       def run_with_info(message, command = nil)
-        info("\n" + message.cyan)
+        indent     = '    '
+        ok_indent  = indent + ' ✔  '.green
+        err_indent = indent + ' X   '.red
+        info("\n" + message.magenta)
         return unless command
-        o, e, s    = run_system_command(command)
-        ok_indent  = '    ✔ '.green
-        err_indent = '    x '.red
+        info(indent + command.bold.yellow)
+        o, e, s = run_system_command(command)
         info(ok_indent + o.chomp.gsub(/\n/, "\n#{ok_indent}").blue) if o && o.chomp != ''
         warn(err_indent + +e.chomp.gsub(/\n/, "\n#{err_indent}").red) if e && e.chomp != ''
       end
 
       def additional_info
-        "\nGenerating project #{project_name.bold.green}\nDestination: #{workspace.bold.yellow}\n"
+        "\nGenerating project #{project_name.bold.green} into #{workspace.bold.yellow}\n" +
+            "Template: #{template_repo.bold.red}\n"
       end
 
       private
@@ -74,22 +78,21 @@ module Arli
         FileUtils.mv('README.md', 'README-Arli-CMake.md')
         Dir.chdir('src') do
           FileUtils.mv('MyProject.cpp', "#{project_name}.cpp")
-          run_system_command "sed -i 's/MyProject/#{project_name}/g' CMakeLists.txt"
+          run_with_info('Updating CMakeLists.txt file...',
+                        "sed -i 's/MyProject/#{project_name}/g' CMakeLists.txt")
         end
-        run_system_command "sed -i 's/MyProject/#{project_name}/g' CMakeLists.txt"
+        run_with_info('Updating CMakeLists.txt file...',
+                      "sed -i 's/MyProject/#{project_name}/g' CMakeLists.txt")
       end
 
       def configure_template!
         File.open('README.md', 'w') do |f|
           f.write <<-EOF
           
-
-> This project has been auto-generated using:
+> **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!
@@ -112,25 +115,6 @@ module Arli
 
 ## Building #{project_name}
  
-### Using the BASH Helper `bin/build`
-
-This project contains a BASH script that can automate your setup and build process. The following script takes care of most dependencies, including a missing Ruby.
-
-```bash
-$ cd ~/workspace/#{project_name}
-$ bin/build [ setup | clean | make-flags ]
-```
-
-You should see a bunch of output, and upon completion, run `arli` without arguments to see if the command got installed and shows you proper help message. If you get `command not found`, please `[sudo] gem install arli --no-ri --no-rdoc`. Add sudo if your ruby installation is the system one, ie, `which ruby` returns `/usr/bin/ruby`.
-
-
-### Manual Build
-
-If you prefer to have more control over the build, you can of course build manually, 
-and manage `CMakeLists.txt` however you want. 
-
-Once you've run the setup, the manual build is:
-
 ```bash
 $ cd ~/workspace/#{project_name}
 $ rm -rf build && mkdir -p build && cd build
@@ -141,7 +125,7 @@ $ # this next command opens a serial port monitor inside a screen session
 $ make #{project_name}-serial   
 ```
 
-#### Customizing the Build
+### 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 ..`
 
@@ -163,6 +147,22 @@ Go ahead and edit that file, and under `dependencies:` you want to list all of y
 
 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.

data/lib/arli/commands/install.rb

@@ -30,12 +30,16 @@ module Arli
         raise Arli::Errors::LibraryNotFound,
               "Library #{cfg.to_hash} was not found" unless library
 
-        self.arlifile = Arli::ArliFile.new(config: config, libraries: [ library ])
+        self.arlifile = Arli::ArliFile.new(config: config, libraries: [library])
         if config.trace
           info("found library using #{install_method}:\n#{library.inspect}")
         end
       end
 
+      def additional_info
+        "\nInstalling: #{runtime.argv.join(' ').bold.green}\n"
+      end
+
       def run
         arlifile.install
       end
@@ -44,14 +48,14 @@ module Arli
       def identify_library(arg)
         results = if arg =~ %r[https?://]i
                     self.install_method = :url
-                    r = search(url: /^#{arg}$/i)
+                    r                   = search(url: /^#{arg}$/i)
                     if r.empty?
                       self.install_method = :website
-                      r = search(website: /^#{arg}$/i)
+                      r                   = search(website: /^#{arg}$/i)
                     end
                     if r.empty?
                       self.install_method = :custom
-                      r = [ Arduino::Library::Model.from_hash(url: arg, name: File.basename(arg)) ]
+                      r                   = [Arduino::Library::Model.from_hash(url: arg, name: File.basename(arg))]
                     end
                     r
                   elsif File.exist?(arg) || arg =~ /\.zip$/

data/lib/arli/commands/search.rb

@@ -25,12 +25,16 @@ module Arli
 
       def initialize(*args)
         super(*args)
-        self.format = config.search.results.output_format
+        self.format   = config.search.results.output_format
         valid_methods = Arli::Library::MultiVersion.format_methods
         raise Arli::Errors::InvalidSearchSyntaxError,
               "invalid format #{format}" unless valid_methods.include?(format)
       end
 
+      def additional_info
+        "\nSearching For: #{runtime.argv.join(' ').bold.green}\n"
+      end
+
       def run
         self.search_opts      = process_search_options!
         self.results          = search(database, **search_opts).sort
@@ -112,7 +116,7 @@ module Arli
       def handle_and_raise_error(e)
         message = e.message
         if message =~ /undefined method.*Arduino::Library::Model/
-          message = "Invalid attributed search. Possible values are:" +
+          message = 'Invalid attributed search. Possible values are:' +
               "\n#{Arduino::Library::Types::LIBRARY_PROPERTIES.keys}"
         end
         raise Arli::Errors::InvalidSearchSyntaxError,
@@ -121,10 +125,10 @@ module Arli
       end
 
       def print_total_with_help
-        puts "———————————————————————"
+        hr_short
         puts "  Total Versions : #{results.size.to_s.bold.magenta}\n"
         puts "Unique Libraries : #{unique_libraries.size.to_s.bold.magenta}\n"
-        puts "———————————————————————"
+        hr_short
         if results.size == Arli::Configuration::DEFAULT_RESULTS_LIMIT
           puts "Hint: use #{'-m 5'.bold.green} to limit the result set."
         end
@@ -133,6 +137,11 @@ module Arli
       def params
         search_opts
       end
+
+      private
+      def hr_short
+        puts '———————————————————————'
+      end
     end
   end
 end

data/lib/arli/helpers/output.rb

@@ -150,13 +150,13 @@ module Arli
           out << "\n#{command.params.to_s.blue}\n"
         end
         out << command.additional_info if command.respond_to?(:additional_info)
-        out << "\nLibrary Path: #{Arli.default_library_path.green}\n"
-        out << "#{hr}\n"
+        out << "Library Path: #{Arli.default_library_path.green}\n"
+        out << "#{hr}"
         info out
       end
 
       def hr
-        ('-' * (ENV['COLUMNS'] || 80)).red.dark
+        ('—' * ((ENV['COLUMNS'] || 70).to_i - 1)).red.dark
       end
 
       # Some shortcuts

data/lib/arli/library/installer.rb

@@ -20,7 +20,7 @@ module Arli
       end
 
       def install
-        ___ "#{library.name.blue} "
+        ___ "#{library.name.blue.bold} "
         if library.nil? && library.library.nil?
           ___ ' (no library) '
           fuck
@@ -28,13 +28,13 @@ module Arli
           ___ ' (no url) '
           fuck
         else
-          ___ "(#{library.version.green}) " if library.version
+          ___ "(#{library.version.yellow.bold}) " if library.version
           indent_cursor
           actions(library).each do |action|
             run_action(action)
           end
         end
-        ___ "\n"
+        ___ "\n\n"
       end
 
       def run_action(action_name)

data/lib/arli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arli
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-02 00:00:00.000000000 Z
+date: 2018-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arduino-library
@@ -234,11 +234,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "  This is an Arduino Library manager, compatible with the \"arduino-cmake\"
-  project. \n  Arli offers a powerful command-line tool to manage any number of dependent
-  Github\n  projects, or official Arduino libraries. Arli was created to offer Arduino-based
-  \n  projects of moderate to high complexity an easy way to reference external libraries\n
-  \ and install them at build time, instead of committing them into the project repo.\n"
+description: |2
+    This is an Arduino helper toolkit that builds on top of the arduino-cmake
+    project — a powerful alternative build system for Arduino. What Arli provides
+    is capability to search for libraries by any attributes and regular expressions,
+    install a whole set of libraries defined in a YAML file Arlifile, and finally,
+    it can generate a brand new Sketch Project based on arduino-cmake, that builds
+    out the box. Arli is a command line tool, so run "arli" after installing the gem
+    for more information.
 email:
 - kigster@gmail.com
 executables:
@@ -329,9 +332,10 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: This is an Arduino Library manager, compatible with the "arduino-cmake" project.  Arli
-  offers a powerful command-line tool to manage any number of dependent Github projects,
-  or official Arduino libraries. Arli was created to offer Arduino-based  projects
-  of moderate to high complexity an easy way to reference external libraries and install
-  them at build time, instead of committing them into the project repo.
+summary: This is an Arduino helper toolkit that builds on top of the arduino-cmake
+  project — a powerful alternative build system for Arduino. What Arli provides is
+  capability to search for libraries by any attributes and regular expressions, install
+  a whole set of libraries defined in a YAML file Arlifile, and finally, it can generate
+  a brand new Sketch Project based on arduino-cmake, that builds out the box. Arli
+  is a command line tool, so run "arli" after installing the gem for more information.
 test_files: []