arli 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4bcc7bfa074f09ae70dbf449ebe1112c6029bc2
-  data.tar.gz: 5cd8d400ae0861d24d041d39bb2fa46fcc847685
+  metadata.gz: 46f795acacbde34438dcaf8b480b23153f34c802
+  data.tar.gz: f561796a03ce3c9d71d0f4166c67c90692397e6b
 SHA512:
-  metadata.gz: aef1c241150fadc67b359d8e337d2a3998d70b6e50181800a44b5c202348bcb11f4f9894826361f63455372bdd303404042da4e14f2765de311138ffa4e7ce5c
-  data.tar.gz: 4206dd840bf013f68ee1bb5b64400d3f9ee9225767b23957ad9c02bb728931f15c4faea3cff19b23df3ef98e8129b38d22044a2793f9f755d7e20bb7ab5aa498
+  metadata.gz: 4804d1bfab9e6032f3e2b78bcfc26789f5cc5990c0eaa79d9b13e7b408ca1fe7d497b01a88b8e5a78b36def1cdfa7081a3788b4018589918da47c35d95c4fedd
+  data.tar.gz: adc5d2c4758713eca5fda31bec6e343330529a2bd03d36d19775d4f52aad54171cc5d937634a0468c8d2e4015e1f908cb8991cab162df001225d3f7f76e62a04

data/README.md

@@ -3,33 +3,32 @@
 # Arli
 
 Arli is a simple and easy to use installer of dependencies that can be 
-declared in a JSON file of the following format:
-
-
-```js
-{
-  "dependencies": [
-    {
-      "name": "DS1307RTC",
-      "git": "https://github.com/PaulStoffregen/DS1307RTC.git"
-    },
-    {
-      "name": "Adafruit_LEDBackpack",
-      "git": "https://github.com/adafruit/Adafruit-LED-Backpack-Library.git"
-    },
-  ]
-}
+declared in a YAML file of the following format:
+
+```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: SimpleTimer
+    urL: https://github.com/jfturcot/SimpleTimer
 ```
 
-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.
+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.
 
-The gem was created to fill the need of managing many external libraries for an Arduino projects 
-in a consistent way. Arli's API was loosely inspired by Bundler.
+The gem was created to fill the need of managing many external
+libraries for an Arduino projects in a consistent way. Arli's 
+API was loosely inspired by Bundler.
 
 ## Installation
 
-Install the gem globally like this: 
+Install the gem globally like this:
 
 ```bash
 # if using rbenv, or rvm
@@ -45,14 +44,14 @@ Run `arli --help` for more information:
 
 ```bash
 Usage:
-    arli [options] [command [options]]
+    arli [options] [ command [options] ]
 
-    -h, --help             prints this help
+    -h, --help     prints this help
 
 Available Commands:
-    install      : installs libraries defined in the JSON file
-    update       : updates libraries defined in the JSON file
-    library      : Install, update, or remove a single library
+    install      : installs libraries defined in ArliFile.yml
+    update       : updates libraries defined in the ArliFile.yml
+    search       : Flexible Search of the Arduino Library Database
 
 See arli <command> --help for more information on a specific command.
 ```
@@ -61,13 +60,13 @@ See arli <command> --help for more information on a specific command.
 
 Use this command to install libraries for the first time. 
 
-NOTE: you are allowed to pass `-u` flag to automatically fallback
-to updating any existing folders. So `arli install -u` will either install 
-or update all dependencies.
+NOTE: unless you pass `-e` flag, install command falls back to `update` if
+the target folder already exists.  With `-e` flag, installer aborts if the 
+target library already exists.
 
 ```bash
 Description:
-    installs libraries defined in the JSON file
+    installs libraries defined in ArliFile.yml
 
 Usage:
     arli install [options]
@@ -75,17 +74,20 @@ Usage:
 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)
-    -u, --update-existing  Update a library that already exists
-    -h, --help             prints this help
 
+    -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
 ```
 
 #### Update Command
 
 To upate previously checked out libraries, use the `update` command:
 
-```
+```bash
 Description:
     updates libraries defined in the JSON file
 
@@ -99,6 +101,27 @@ Command Options
     -h, --help             prints this help
 ```
 
+#### Search Command
+
+To search Arduino library database, you can use the search command:
+
+```bash
+Description:
+    Flexible Search of the Arduino Library Database
+
+Usage:
+    arli search [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
+    -h, --help             prints this help
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/arli.gemspec

@@ -28,8 +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 'hashie'
+  spec.add_dependency 'arduino-library'
   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_development_dependency 'simplecov'

data/lib/arli/arli_file.rb

@@ -0,0 +1,24 @@
+require 'arli'
+require 'arduino/library'
+require 'yaml'
+
+module Arli
+  class ArliFile
+    require 'arduino/library/include'
+
+    extend Forwardable
+    def_delegators :@dependencies, *(Array.new.methods - Object.methods)
+
+    DEFAULT_FILE_NAME = 'ArliFile.yml'.freeze
+
+    attr_accessor :dependencies, :arli_hash, :file
+
+    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)
+      end
+    end
+  end
+end

data/lib/arli/cli.rb

@@ -6,6 +6,7 @@ require 'arli'
 require 'arli/parser'
 require 'arli/commands/update'
 require 'arli/commands/install'
+require 'arli/commands/search'
 
 module Arli
   class CLI
@@ -60,15 +61,15 @@ module Arli
       if command
         command_class = ::Arli::Commands.const_get(command.to_s.capitalize)
 
-        options[:arli_json] ||= ::Arli::DEFAULT_JSON_FILE
-        options[:lib_home]  ||= ::Arli::DEFAULT_LIBRARY_PATH
+        options[:arli_file] ||= ::Arli::DEFAULT_ARLI_FILE
+        options[:lib_home]  ||= ::Arduino::Library::DEFAULT_ARDUINO_LIBRARY_PATH
 
         output "run_command #{command.to_s.bold.green}, options: #{options.inspect.bold.blue}" if Arli::DEBUG
-        command_class.new(options).run
+        @command_instance = command_class.new(options)
+        @command_instance.header.run
       end
     rescue NameError => e
       output e.inspect
-      output "Unfortunately command #{command.to_s.red} is not yet implemented.\n\n"
     end
 
     def parse_command_options!
@@ -87,7 +88,6 @@ module Arli
     end
 
     class << self
-
       def global
         @global ||= PARSER.new do |parser|
           parser.banner = usage_line
@@ -101,29 +101,34 @@ module Arli
       end
 
       def global_usage(command)
-        "Usage:\n    ".bold + COMMAND.bold.blue + ' ' + '[options] '.yellow + '[' + (command || 'command').green + ' [options]'.yellow + ']' + "\n"
+        "Usage:\n    ".bold + COMMAND.bold.blue +
+          ' [options] '.yellow + '[' + (command || 'command').green +
+          ' [options]'.yellow + ']' + "\n"
       end
 
       def command_usage(command)
-        "Usage:\n    ".bold + COMMAND.bold.blue + ' ' + command.bold.green + ' [options]'.yellow + "\n\n" + 'Command Options'.bold
+        "Usage:\n    ".bold + COMMAND.bold.blue + ' ' +
+          command.bold.green +
+          ' [options]'.yellow + "\n\n" +
+          'Command Options'.bold
       end
 
       def commands
         @commands ||= {
           install: {
-            description: 'installs libraries defined in the JSON file',
+            description: 'installs libraries defined in ArliFile.yml',
             parser:      -> (command) {
               PARSER.new do |parser|
                 parser.banner = usage_line 'install'
                 parser.option_lib_home
                 parser.option_dependency_file
-                parser.option_update_if_exists
+                parser.option_abort_if_exists
                 parser.option_help(command: command)
               end
             } },
 
           update:  {
-            description: 'updates libraries defined in the JSON file',
+            description: 'updates libraries defined in the ArliFile.yml',
             parser:      -> (command) {
               PARSER.new do |parser|
                 parser.banner = usage_line 'update'
@@ -133,16 +138,26 @@ module Arli
               end
             } },
 
-          library: {
-            description: 'Install, update, or remove a single library',
+          search:  {
+            description: 'Flexible Search of the Arduino Library Database',
             parser:      -> (command) {
               PARSER.new do |parser|
-                parser.banner = usage_line 'library'
-                parser.option_lib_home
-                parser.option_library
+                parser.banner = usage_line 'search'
+                parser.option_search
                 parser.option_help(command: command)
               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
 

data/lib/arli/commands/base.rb

@@ -7,28 +7,32 @@ require 'arli/version'
 module Arli
   module Commands
     class Base
-      attr_accessor :lib_path, :json_file, :update_if_exists, :command
+      attr_accessor :lib_path, :arli_file, :abort_if_exists, :command
 
       def initialize(options)
-        self.lib_path         = options[:lib_home]
-        self.json_file        = options[:arli_json]
-        self.update_if_exists = options[:update_if_exists]
-        self.command          = self.class.name.gsub(/.*::/, '').downcase.to_sym
+        self.lib_path        = options[:lib_home]
+        self.abort_if_exists = options[:abort_if_exists]
+        self.command         = self.class.name.gsub(/.*::/, '').downcase.to_sym
         setup
       end
 
+      def header
+        out  = "——————————————————————————————————————————————————————————\n"
+        out  <<  "Arli           : Version #{::Arli::VERSION.bold.yellow}\n"
+        out  << "Command        : #{command.to_s.bold.blue}\n" if command
+        out  << "Library Path   : #{lib_path.bold.green}\n" if lib_path
+        out  << "ArliFile       : #{arli_file.file.bold.magenta}\n" if
+          arli_file && arli_file.file
+        out << '——————————————————————————————————————————————————————————'
 
-      # Commands implement #run method that uses helpers below:
-      protected
+        info out
 
-      def header
-        info   "Arli            : Version #{::Arli::VERSION.bold.yellow}\n" +
-               "Running command : #{command.to_s.bold.blue}\n" +
-               "Library Path    : #{lib_path.bold.green}\n" +
-               "JSON File       : #{json_file.bold.magenta}\n" +
-               '———————————————————————————————————————————————————————'
+        self
       end
 
+      # Commands implement #run method that uses helpers below:
+      protected
+
       def all_dependencies(cmd, *args)
         for_each_dependency do |dep|
           begin
@@ -71,22 +75,15 @@ module Arli
       end
 
       def for_each_dependency(&_block)
-        dependencies['dependencies'].each do |dependency|
+        raise 'Library Path is nil!' unless lib_path
+        FileUtils.mkpath(lib_path) unless Dir.exist?(lib_path)
+        arli_file.each do |dependency|
           Dir.chdir(lib_path) do
             yield(dependency)
           end
         end
       end
 
-      def dependencies
-        @deps ||= begin
-          JSON.load(File.read(json_file))
-        rescue Errno::ENOENT => e
-          error("File #{json_file.bold.yellow} could not be found!", e)
-          { 'dependencies' => [] }
-        end
-      end
-
       def error(msg, exception = nil)
         printf 'Runtime Error: '.bold.red + "\n#{msg}\n" if msg
         if exception

data/lib/arli/commands/install.rb

@@ -9,22 +9,21 @@ module Arli
     class Install < Update
 
       def run
-        header
-        all_dependencies(command, 'name', 'git')
+        all_dependencies(command, 'name', 'url')
       end
 
       def install_dependency(name, url)
         cmd = if Dir.exist?(name)
-                if update_if_exists
-                  update_dependency(name)
-                else
+                if abort_if_exists
                   raise <<-EOF
-               Existing folder found for library #{name.red}. 
-               Please use -u switch with 'install' command, 
-               or invoke the 'update' command directly."
-                        EOF
+                               Existing folder found for library #{name.red}. 
+                               Please use -u switch with 'install' command, 
+                               or invoke the 'update' command directly."
+                                EOF
                           .gsub(/^\s+/, '')
 
+                else
+                  update_dependency(name)
                 end
               else
                 "git clone -v #{url} #{name} 2>&1"

data/lib/arli/commands/search.rb

@@ -0,0 +1,52 @@
+require 'json'
+require 'fileutils'
+require 'open3'
+require 'arli'
+require 'arli/commands/base'
+require 'arduino/library'
+require 'awesome_print'
+module Arli
+  module Commands
+    class Search < Base
+      require 'arduino/library/include'
+
+      attr_accessor :search_string,
+                    :search_opts,
+                    :limit,
+                    :database
+
+      class InvalidOptionError < ArgumentError; end
+
+      def initialize(options)
+        super(options)
+        self.search_string = options[:search]
+        self.limit         = options[:limit] || 100
+
+        raise InvalidOptionError, 'Please provide search string with --search' \
+          unless search_string
+
+        begin
+          self.search_opts = eval("{ #{search_string} }")
+        rescue => e
+          raise InvalidOptionError "Search string '#{search_string}' is invalid.\n" +
+            e.message.red
+        end
+
+        unless search_opts.is_a?(::Hash) && search_opts.size > 0
+          raise InvalidOptionError, "Search string '#{search_string}' did not eval to Hash.\n"
+        end
+
+        self.database = options[:database] ? db_from(option[:database]) : db_default
+
+        search_opts.merge!(limit: limit) if limit
+      end
+
+      def run
+        ap search(database, **search_opts).map(&:to_hash)
+      rescue Exception => e
+        error e
+        puts e.backtrace.join("\n") if ENV['DEBUG']
+      end
+    end
+  end
+end

data/lib/arli/commands/update.rb

@@ -7,9 +7,12 @@ require_relative 'base'
 module Arli
   module Commands
     class Update < Base
+      def initialize(options)
+        super(options)
+        self.arli_file = options[:arli_file] ? ArliFile.new(options[:arli_file]) : ArliFile.new
+      end
 
       def run
-        header
         all_dependencies(command, 'name')
       end
 

data/lib/arli/configuration.rb

@@ -0,0 +1,4 @@
+module Arli
+  class Configuration
+  end
+end

data/lib/arli/parser.rb

@@ -1,3 +1,4 @@
+require 'arduino/library'
 module Arli
   class CLI
     class Parser < OptionParser
@@ -7,7 +8,7 @@ module Arli
         super(nil, 22)
         self.output_lines = Array.new
         self.command      = command
-        self.options = Hashie::Mash.new
+        self.options      = Hashie::Mash.new
       end
 
       def sep(text = nil)
@@ -15,23 +16,43 @@ module Arli
       end
 
       def option_dependency_file
-        on('-j', '--json FILE',
-           "JSON file with dependencies (defaults to #{DEFAULT_JSON_FILE.bold.magenta})\n\n") do |v|
-          options[:arli_json] = v
+        on('-a', '--arli-file FILE',
+           'ArliFile.yml'.bold.green + ' is the file listing the dependencies',
+           "Default filename is #{DEFAULT_ARLI_FILE.bold.magenta})\n\n") do |v|
+          options[:arli_file] = v
         end
       end
 
       def option_lib_home
         on('-l', '--lib-home HOME', 'Local folder where libraries are installed',
-          "Default: #{Arli::DEFAULT_LIBRARY_PATH.gsub(%r(#{ENV['HOME']}), '~').blue}\n\n") do |v|
+           "Default: #{default_library_path}\n\n") do |v|
           options[:lib_home] = v
         end
       end
 
-      def option_update_if_exists
-        on('-u', '--update-existing',
-           'Update a library that already exists') do |v|
-          options[:update_if_exists] = true
+
+      def option_search
+        on('-s', '--search TERMS', 'ruby-style hash arguments to search for',
+           %Q(eg: -s "name: 'AudioZero', version: /^1.0/")) do |v|
+          options[:search] = v
+        end
+        on('-d', '--database SOURCE',
+           'a JSON file name, or a URL that contains the index',
+           'By default, the Arduino-maintained list is searched') do |v|
+          options[:database] = v
+        end
+        on('-m', '--max LIMIT',
+           'if provided, limits the result set to this number',
+           'Default value is 100') do |v|
+          options[:limit] = v
+        end
+      end
+
+      def option_abort_if_exists
+        on('-e', '--abort-on-exiting',
+           'Abort if a library folder already exists',
+           'instead of updating it.') do |v|
+          options[:abort_if_exists] = true
         end
       end
 
@@ -89,6 +110,11 @@ See #{COMMAND.bold.blue + ' <command> '.bold.green + '--help'.bold.yellow} for m
       def print
         puts output.join("\n") unless output.empty?
       end
+
+      def default_library_path
+        Arduino::Library::DEFAULT_ARDUINO_LIBRARY_PATH.gsub(%r(#{ENV['HOME']}), '~').blue
+      end
+
     end
   end
 end

data/lib/arli/version.rb

@@ -1,3 +1,3 @@
 module Arli
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.3.1'.freeze
 end

data/lib/arli.rb

@@ -1,13 +1,14 @@
 require 'arli/version'
+require 'arli/arli_file'
+require 'arli/configuration'
 require 'arli/cli'
 require 'logger'
 
 module Arli
-  DEFAULT_JSON_FILE_ENV = 'ARDUINO_ARLI_LIBRARY_FILE'.freeze
-  DEFAULT_JSON_FILE     = ENV[DEFAULT_JSON_FILE_ENV] || 'arli.json'.freeze
+  LIBRARY_INDEX_JSON_GZ = 'http://downloads.arduino.cc/libraries/library_index.json.gz'.freeze
 
-  DEFAULT_LIBRARY_PATH_ENV = 'ARDUINO_CUSTOM_LIBRARY_PATH'.freeze
-  DEFAULT_LIBRARY_PATH     = ENV[DEFAULT_LIBRARY_PATH_ENV] || (ENV['HOME'] + '/Documents/Arduino/Libraries')
+  DEFAULT_ARLI_FILE_ENV = 'ARDUINO_ARLI_LIBRARY_FILE'.freeze
+  DEFAULT_ARLI_FILE     = ENV[DEFAULT_ARLI_FILE_ENV] || ArliFile::DEFAULT_FILE_NAME
 
   DEBUG = ENV['DEBUG'] ? true : false
 
@@ -16,6 +17,7 @@ module Arli
 
   class << self
     attr_accessor :logger
+    attr_writer :configuration
 
     %i(debug info error warn fatal).each do |level|
       define_method level do |*args|
@@ -23,5 +25,17 @@ module Arli
       end
     end
   end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
 end
 

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: arli
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-21 00:00:00.000000000 Z
+date: 2017-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: arduino-library
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,6 +38,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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: dry-types
+  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: dry-struct
+  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: awesome_print
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -130,10 +186,13 @@ files:
 - bin/setup
 - exe/arli
 - lib/arli.rb
+- lib/arli/arli_file.rb
 - lib/arli/cli.rb
 - lib/arli/commands/base.rb
 - lib/arli/commands/install.rb
+- lib/arli/commands/search.rb
 - lib/arli/commands/update.rb
+- lib/arli/configuration.rb
 - lib/arli/parser.rb
 - lib/arli/version.rb
 homepage: https://github.com/kigster/arli