arli 0.3.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 445a4cbb2237add42b7a6dac5d41ef30cb7ffc6c
-  data.tar.gz: 79d3becd74cabb839d0f2dfa699c1bfcfccf417e
+  metadata.gz: 233ae21fdec4ad9e4f6fd73c632dc632d626a5df
+  data.tar.gz: 4db04f61697a98c6288a81d5179bfc62fccf79ee
 SHA512:
-  metadata.gz: 16ebcf812896a46d11cd336ab05dda084e655f549fa0468fd367226f8dd0ae012f8b91651139e5a11906f894c183cb94a91c1731eec4790f0a362575399bc3ab
-  data.tar.gz: 21952cf71941c8b994b5b59aff00a305ab51f7abb0c98464112502e3e891c241be31518bfacb1d85bb77ad0d20c714541fd50a0a9ca77c060812f754b52b194d
+  metadata.gz: ca67abe8ac90302ffdf49aedfc0c3a33f999f5bc28721aa027e7f9ad104a29cbadff9bcc4ace2fed7bbb2fccf0fc6aada19f38f4096f597599c4188ed8eaf950
+  data.tar.gz: 1635be7126e6515ad602c68388d0e660b2536a12a5d197621c057fcec48f0641a477224cbd87072ea673c9b51c2692a9b9153e2dec1fbc6465c02816dfbb7c66

data/.gitignore

@@ -14,3 +14,4 @@
 **/.DS_Store
 .ruby-version
 .rspec_status
+!/lib/arli/commands/install.rb

data/.travis.yml

@@ -1,5 +1,18 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=f8f229bdf1f374a3a9227d3bef6f57b78f88c73a2d4705c9de5852bb484eaaef
 sudo: false
 language: ruby
+cache: bundler
 rvm:
   - 2.4.1
+  - 2.3.5
 before_install: gem install bundler -v 1.15.4
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/README.md

@@ -1,23 +1,29 @@
+[![Gem Version](https://badge.fury.io/rb/arli.svg)](https://badge.fury.io/rb/arli)
 [![Build Status](https://travis-ci.org/kigster/arli.svg?branch=master)](https://travis-ci.org/kigster/arli)
+[![Maintainability](https://api.codeclimate.com/v1/badges/0812671b4bec27ba89b9/maintainability)](https://codeclimate.com/github/kigster/arli/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/0812671b4bec27ba89b9/test_coverage)](https://codeclimate.com/github/kigster/arli/test_coverage)
 
 # Arli
 
-Arli is a simple and easy to use installer of dependencies that can be 
-declared in a YAML file of the following format:
+Arli is a simple and easy to use Arduino Dependency Manager, that uses a
+a YAML formatted file declaring dependencies, as follows:
 
 ```yaml
+# vi:syntax=yaml
 version: 1.0.0
 dependencies:
   - name: ESP8266WiFi
     version: '1.0'
     url: https://github.com/esp8266/Arduino
-    subfolder: libraries/ESP8266WiFi
-  - name: NTPClient
-    version: '3.1.0'
+  - name: Time
+  - name: "Adafruit GFX Library"
   - name: SimpleTimer
-    urL: https://github.com/jfturcot/SimpleTimer
+    url: https://github.com/jfturcot/SimpleTimer
 ```
 
+The libraries may be specified with a name and url only, OR they can be specified by name (and optionally version) — as long as this is one of the standard libraries documented in the [Arduino official library database](http://downloads.arduino.cc/libraries/library_index.json.gz) JSON file.
+
+
 Basically a simple pairing of a library/project name 
 (which also happens to be the local directory it's cloned into) 
 and a remote URL.
@@ -31,11 +37,9 @@ API was loosely inspired by Bundler.
 Install the gem globally like this:
 
 ```bash
-# if using rbenv, or rvm
+# if using rbenv, or rvm; otherwise you may need to prefix 
+# with 'sudo'
 $ gem install arli 
-
-# OR, if your Ruby is a system ruby installed in eg. /usr/local, 
-$ sudo gem install arli 
 ```
 
 ## Usage
@@ -43,14 +47,18 @@ $ sudo gem install arli
 Run `arli --help` for more information:
 
 ```bash
+
 Usage:
-    arli [options] [ command [options] ]
+    arli [options] [ command [options]  ]
 
-    -h, --help     prints this help
+    -D, --debug            Print debugging info.
+    -t, --trace            Print exception stack traces.
+    -v, --verbose          Print more information.
+    -V, --version          Print current version and exit
+    -h, --help             prints this help
 
 Available Commands:
-    install      : installs libraries defined in ArliFile.yml
-    update       : updates libraries defined in the ArliFile.yml
+    install      : installs libraries defined in Arlifile
     search       : Flexible Search of the Arduino Library Database
 
 See arli <command> --help for more information on a specific command.
@@ -66,41 +74,30 @@ target library already exists.
 
 ```bash
 Description:
-    installs libraries defined in ArliFile.yml
+    installs libraries defined in Arlifile
 
 Usage:
     arli install [options]
 
 Command Options
-    -l, --lib-home HOME    Local folder where libraries are installed
-                           Default: ~/Documents/Arduino/Libraries
-
-    -a, --arli-file FILE   ArliFile.yml is the file listing the dependencies
-                           Default filename is ArliFile.yml
-
-    -e, --abort-on-exiting Abort if a library folder already exists
-                           instead of updating it.
-    -h, --help             prints this help
-```
+    -l, --libs PATH        Local folder where libraries are installed
+                           Defaults to ~/Dropbox/Workspace/oss/arduino/libraries
 
-#### Update Command
+    -p, --arli-path PATH   Folder where Arlifile is located,
+                           Defaults to the current directory.
 
-To upate previously checked out libraries, use the `update` command:
+    -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
 
-```bash
-Description:
-    updates libraries defined in the JSON file
-
-Usage:
-    arli update [options]
-
-Command Options
-    -l, --lib-home HOME    Local folder where libraries are installed
-                           Default: ~/Documents/Arduino/Libraries
-    -j, --json FILE        JSON file with dependencies (defaults to arli.json)
+    -D, --debug            Print debugging info.
+    -t, --trace            Print exception stack traces.
+    -v, --verbose          Print more information.
+    -V, --version          Print current version and exit
     -h, --help             prints this help
 ```
 
+
 #### Search Command
 
 To search Arduino library database, you can use the search command:
@@ -110,17 +107,22 @@ Description:
     Flexible Search of the Arduino Library Database
 
 Usage:
-    arli search [options]
+    arli search <query> [options]
 
 Command Options
-    -s, --search TERMS     ruby-style hash arguments to search for
-                           eg: -s "name: 'AudioZero', version: /^1.0/"
-    -d, --database SOURCE  a JSON file name, or a URL that contains the index
-                           By default, the Arduino-maintained list is searched
-    -m, --max LIMIT        if provided, limits the result set to this number
-                           Default value is 100
+    -d FILE/URL,           a JSON file name, or a URL that contains the index
+        --database         Defaults to the Arduino-maintained list
+    -m, --max NUMBER       if provided, limits the result set to this number
+                           Defaults to 100
+    -D, --debug            Print debugging info.
+    -t, --trace            Print exception stack traces.
+    -v, --verbose          Print more information.
+    -V, --version          Print current version and exit
     -h, --help             prints this help
-```
+
+Example:
+    arli search 'name: /AudioZero/, version: "1.0.1"'
+I```
 
 ## Development
 

data/arli.gemspec

@@ -28,12 +28,13 @@ 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'
+  spec.add_dependency 'arduino-library', '~> 0.4.1'
   spec.add_dependency 'colored2'
   spec.add_dependency 'hashie'
   spec.add_dependency 'dry-types'
   spec.add_dependency 'dry-struct'
   spec.add_dependency 'awesome_print'
+  spec.add_dependency 'archive-zip'
 
 
   spec.add_development_dependency 'simplecov'

data/exe/arli

@@ -6,4 +6,3 @@ Arli::CLI.new.tap do |cli|
   cli.parse
 end
 
-

data/lib/arli.rb

@@ -1,41 +1,42 @@
-require 'arli/version'
-require 'arli/arli_file'
-require 'arli/configuration'
-require 'arli/cli'
+require 'forwardable'
 require 'logger'
+require 'arduino/library'
 
-module Arli
-  LIBRARY_INDEX_JSON_GZ = 'http://downloads.arduino.cc/libraries/library_index.json.gz'.freeze
+require 'arli/version'
+require 'arli/errors'
+require 'arli/logger'
+require 'arli/config'
 
-  DEFAULT_ARLI_FILE_ENV = 'ARDUINO_ARLI_LIBRARY_FILE'.freeze
-  DEFAULT_ARLI_FILE     = ENV[DEFAULT_ARLI_FILE_ENV] || ArliFile::DEFAULT_FILE_NAME
+module Arli
 
-  DEBUG = ENV['DEBUG'] ? true : false
+  class << self
+    attr_accessor :config
+  end
 
-  @logger       = Logger.new(STDOUT)
-  @logger.level = Logger::INFO
+  self.config = ::Arli::Config
 
   class << self
-    attr_accessor :logger
-    attr_writer :configuration
+    extend Forwardable
+    def_delegators :@config, *::Arli::Config::PARAMS
 
-    %i(debug info error warn fatal).each do |level|
-      define_method level do |*args|
-        self.logger.send(level, *args) if self.logger
-      end
+    def configure(&_block)
+      yield(self.config)
     end
-  end
-
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
 
-  def self.reset
-    @configuration = Configuration.new
+    def debug?
+      self.debug
+    end
   end
+end
 
-  def self.configure
-    yield(configuration)
-  end
+Arli.configure do |config|
+  config.library_path       = ::Arduino::Library::DefaultDatabase.library_path
+  config.library_index_path = ::Arduino::Library::DefaultDatabase.library_index_path
+  config.library_index_url  = ::Arduino::Library::DefaultDatabase.library_index_url
+  config.logger             = ::Logger.new(STDOUT, level: :info)
+  config.debug              = ENV['ARLI_DEBUG'] || false
 end
 
+require 'arli/arli_file'
+require 'arli/installer'
+require 'arli/cli'

data/lib/arli/arli_file.rb

@@ -1,24 +1,67 @@
 require 'arli'
-require 'arduino/library'
 require 'yaml'
+require 'forwardable'
+require 'arduino/library'
 
 module Arli
   class ArliFile
     require 'arduino/library/include'
 
+    include Enumerable
+
     extend Forwardable
     def_delegators :@dependencies, *(Array.new.methods - Object.methods)
 
-    DEFAULT_FILE_NAME = 'ArliFile.yml'.freeze
+    attr_accessor :dependencies, :file_hash, :file, :lib_path, :resolved
 
-    attr_accessor :dependencies, :arli_hash, :file
+    def initialize(lib_path: Arli.library_path,
+                   arlifile_path: nil)
+
+      self.lib_path = lib_path
+      self.file     = arlifile_path ? "#{arlifile_path}/#{Arli::Config::DEFAULT_FILENAME}" :
+                        Arli::Config::DEFAULT_FILENAME
+      raise(Arli::Errors::ArliFileNotFound, 'Arlifile could not be found') unless file || !File.exist?(file)
+      self.dependencies = []
+
+      parse!
+    end
 
-    def initialize(file = DEFAULT_FILE_NAME)
-      self.file         = file
-      self.arli_hash    = ::YAML.load(File.read(file))
-      self.dependencies = arli_hash['dependencies'].map do |lib_hash|
-        library_from(lib_hash)
+
+    def libraries
+      self.dependencies
+    end
+
+    def within_lib_path
+      FileUtils.mkpath(lib_path) unless Dir.exist?(lib_path)
+      Dir.chdir(lib_path) do
+        yield if block_given?
       end
     end
+
+    def each_dependency(&_block)
+      within_lib_path do
+        dependencies.each do |dependency|
+          yield(dependency)
+        end
+      end
+    end
+
+    def error(*args)
+      STDERR.puts *args.join("\n")
+    end
+
+    def info(*args)
+      STDOUT.puts *args.join("\n") if Arli.debug?
+    end
+
+    private
+
+    def parse!
+      self.file_hash    = ::YAML.load(::File.read(self.file))
+      self.dependencies = file_hash['dependencies'].map do |lib|
+        ::Arduino::Library::Model.from_hash(lib)
+      end
+    end
+
   end
 end

data/lib/arli/cli.rb

@@ -4,19 +4,16 @@ require 'hashie/extensions/symbolize_keys'
 require 'colored2'
 require 'arli'
 require 'arli/parser'
-require 'arli/commands/update'
 require 'arli/commands/install'
 require 'arli/commands/search'
 
 module Arli
   class CLI
-    class InvalidCommandError < ArgumentError;
-    end
 
-    COMMAND = 'arli'
+    COMMAND = 'arli'.freeze
     PARSER  = ::Arli::CLI::Parser
 
-    attr_accessor :argv, :command, :parser
+    attr_accessor :argv, :parser, :command_name, :command
     attr_accessor :options
 
     def initialize(argv = ARGV.dup)
@@ -41,53 +38,95 @@ module Arli
 
       self.options = Hashie::Extensions::SymbolizeKeys.symbolize_keys!(options.to_h)
 
-      run_command! unless options[:help]
+      unless options[:help]
+        self.command = create_command if command_name
+        execute
+      end
 
-    rescue InvalidCommandError => e
-      output e.message
-    end
+    rescue OptionParser::InvalidOption => e
+      report_exception(e, 'Command line usage error!')
 
-    def self.output(*args)
-      puts args.join("\n") unless args.empty?
-    end
+    rescue Arli::Errors::InvalidCommandError
+      report_exception(e, 'This command does not exist')
 
-    def output(*args)
-      self.class.output(*args)
+    rescue Exception => e
+      report_exception(e)
+      raise e if options[:trace]
     end
 
     private
 
-    def run_command!
-      if command
-        command_class = ::Arli::Commands.const_get(command.to_s.capitalize)
-
-        options[:arli_file] ||= ::Arli::DEFAULT_ARLI_FILE
-        options[:lib_home]  ||= ::Arduino::Library::DEFAULT_ARDUINO_LIBRARY_PATH
+    def report_exception(e, header = nil)
+      error header.bold.yellow if header
+      printf ' ☠   '
+      error e.message if e && e.respond_to?(:message)
+    end
 
-        output "run_command #{command.to_s.bold.green}, options: #{options.inspect.bold.blue}" if Arli::DEBUG
-        @command_instance = command_class.new(options)
-        @command_instance.header.run
+    def execute
+      if command
+        header
+        command.run
+      else
+        gp = self.class.global
+        gp.parse!(%w(--help))
+        gp.print
+        nil
       end
     rescue NameError => e
-      output e.inspect
+      error e.inspect
+      error e.backtrace.join("\n") if options[:trace]
+    end
+
+    def create_command
+      command_class = ::Arli::Commands.const_get(command_name.to_s.capitalize)
+
+      options[:lib_home] ||= ::Arli.config.library_path
+      options[:argv]     = argv
+
+      info "created command #{command_name.to_s.green},\noptions: #{options.inspect.blue}" if Arli.debug?
+
+      command_class.new(options)
+    end
+
+    def header
+       out = ''
+       out << "Arli (#{::Arli::VERSION.yellow})"
+       out << " running #{command.name.to_s.blue}" if command
+       out << "\n"
+       out << "Library Folder: #{options[:lib_home].gsub(/#{ENV['HOME']}/, '~').green}\n" if options[:lib_home]
+       out << '——————————————————————————————————————————————————————————'
+       info out
+     end
+
+    def info(*args)
+      self.class.output(*args)
+    end
+
+    def error(*args)
+      self.class.output(*(args.compact.map { |a| a.to_s.red }))
     end
 
     def parse_command_options!
-      self.class.parser_for(command)
+      self.class.parser_for(command_name)
     end
 
     def command_detected?
-      self.command = argv.shift if argv.first && argv.first !~ /^-.*$/
-      if self.command
-        self.command = command.to_sym
-        unless self.class.commands.key?(command)
-          raise InvalidCommandError, "Error: #{command ? command.to_s.bold.red : 'nil'} is not a valid arli command!"
+      self.command_name = argv.shift if argv.first && argv.first !~ /^-.*$/
+      if self.command_name
+        self.command_name = command_name.to_sym
+        unless self.class.commands.key?(command_name)
+          raise Arli::Errors::InvalidCommandError, "Error: #{command_name ? command_name.to_s.red : 'nil'} is not a valid arli command_name!"
         end
       end
-      self.command
+      self.command_name
     end
 
     class << self
+
+      def output(*args)
+        puts args.join("\n") unless args.empty?
+      end
+
       def global
         @global ||= PARSER.new do |parser|
           parser.banner = usage_line
@@ -101,63 +140,43 @@ module Arli
       end
 
       def global_usage(command)
-        "Usage:\n    ".bold + COMMAND.bold.blue +
-          ' [options] '.yellow + '[' + (command || 'command').green +
-          ' [options]'.yellow + ']' + "\n"
+        "Usage:\n    " + COMMAND.blue +
+          ' [options] '.yellow + '[ ' + (command || 'command').green +
+          ' [options] '.yellow + ' ]' + "\n"
       end
 
       def command_usage(command)
-        "Usage:\n    ".bold + COMMAND.bold.blue + ' ' +
-          command.bold.green +
+        "Usage:\n    " + COMMAND.blue + ' ' +
+          command.green +
           ' [options]'.yellow + "\n\n" +
-          'Command Options'.bold
+          'Command Options'
       end
 
       def commands
         @commands ||= {
           install: {
-            description: 'installs libraries defined in ArliFile.yml',
-            parser:      -> (command) {
+            description: 'installs libraries defined in Arlifile',
+            parser:      -> (command_name) {
               PARSER.new do |parser|
                 parser.banner = usage_line 'install'
                 parser.option_lib_home
                 parser.option_dependency_file
                 parser.option_abort_if_exists
-                parser.option_help(command: command)
-              end
-            } },
-
-          update:  {
-            description: 'updates libraries defined in the ArliFile.yml',
-            parser:      -> (command) {
-              PARSER.new do |parser|
-                parser.banner = usage_line 'update'
-                parser.option_lib_home
-                parser.option_dependency_file
-                parser.option_help(command: command)
+                parser.option_help(command_name: command_name)
               end
             } },
 
           search:  {
             description: 'Flexible Search of the Arduino Library Database',
-            parser:      -> (command) {
+            example:     'arli search '.green + %Q['name: /AudioZero/, version: "1.0.1"'].green,
+            parser:      -> (command_name) {
               PARSER.new do |parser|
-                parser.banner = usage_line 'search'
+                parser.banner = usage_line 'search ' + '<query>'.magenta
                 parser.option_search
-                parser.option_help(command: command)
+                parser.option_help(command_name: command_name)
               end
-            } }
-
-          # library: {
-          #   description: 'Install, update, or remove a single library',
-          #   parser:      -> (command) {
-          #     PARSER.new do |parser|
-          #       parser.banner = usage_line 'library'
-          #       parser.option_lib_home
-          #       parser.option_library
-          #       parser.option_help(command: command)
-          #     end
-          #   } }
+            }
+          }
         }
       end
 
@@ -166,7 +185,8 @@ module Arli
           cmd_hash = commands[cmd]
           commands[cmd][:parser][cmd_hash]
         else
-          raise(InvalidCommandError, "'#{cmd}' is not a valid command.\nSupported commands are:\n\t#{commands.keys.join("\n\t")}")
+          raise(Arli::Errors::InvalidCommandError,
+                "'#{cmd}' is not a valid command_name.\nSupported commands are:\n\t#{commands.keys.join("\n\t")}")
         end
       end
     end