arli 0.9.0 → 1.0.0

data/lib/arli/commands/install.rb

@@ -22,10 +22,9 @@ module Arli
 
       def setup
         super
-
         self.install_argument = runtime.argv.first
         raise InvalidInstallSyntaxError,
-              "Missing installation argument: a name, a file or a URL." unless install_argument
+              'Missing installation argument: a name, a file or a URL.' unless install_argument
 
         self.library = identify_library(install_argument)
         raise Arli::Errors::LibraryNotFound,

data/lib/arli/commands/search.rb

@@ -91,7 +91,7 @@ module Arli
         elsif search.start_with?('/')
           self.search_method = :regex_name_and_url
           # exact match
-          "#{config.search.default_field}: #{search}, archiveFileName: #{search}"
+          "#{config.search.default_field}: #{search}"
         elsif search.start_with?('=')
           self.search_method = :equals
           # exact match

data/lib/arli/configuration.rb

@@ -5,11 +5,12 @@ require 'yaml'
 module Arli
   class Configuration
 
-    DEFAULT_FILENAME      = 'Arlifile'.freeze
-    DEFAULT_LOCK_FILENAME = (DEFAULT_FILENAME + '.lock').freeze
-    ACTIONS_WHEN_EXISTS   = %i(backup overwrite abort)
-    ARLI_COMMAND          = 'arli'.freeze
-    DEFAULT_RESULTS_LIMIT = 0
+    DEFAULT_FILENAME       = 'Arlifile'.freeze
+    DEFAULT_LOCK_FILENAME  = (DEFAULT_FILENAME + '.lock').freeze
+    ACTIONS_WHEN_EXISTS    = %i(backup overwrite abort)
+    ARLI_COMMAND           = 'arli'.freeze
+    DEFAULT_RESULTS_LIMIT  = 0
+    GENERATE_TEMPLATE_REPO = 'https://github.com/kigster/arli-cmake'
 
     extend Dry::Configurable
 
@@ -60,12 +61,20 @@ module Arli
       end
     end
 
+    setting :generate do
+      setting :project_name
+      setting :workspace, '.'
+      setting :libs
+      setting :template_repo, GENERATE_TEMPLATE_REPO
+    end
+
     # Arlifile
     setting :arlifile do
       setting :path, ::Dir.pwd
       setting :name, ::Arli::Configuration::DEFAULT_FILENAME
       setting :lock_name, ::Arli::Configuration::DEFAULT_LOCK_FILENAME
       setting :lock_format, :text
+      setting :hash
     end
 
     setting :bundle do

data/lib/arli/errors.rb

@@ -23,5 +23,8 @@ module Arli
     class TooManyMatchesError < ArliError; end
 
     class ZipFileError < InstallerError; end
+
+    class RequiredArgumentsMissing < ArliError; end
+
   end
 end

data/lib/arli/helpers/output.rb

@@ -7,6 +7,7 @@ module Arli
       CHAR_FAILURE = '✖'.red
       CHAR_SUCCESS = '✔'.green
 
+      # Singleton Class
       class << self
         attr_accessor :enabled, :cursor
 
@@ -23,6 +24,8 @@ module Arli
         end
       end
 
+      # Include Module
+
       self.enable!
       self.cursor = TTY::Cursor
 
@@ -145,6 +148,7 @@ module Arli
         if command && command.params && Arli.config.verbose
           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"
         info out

data/lib/arli/helpers/system_commands.rb

@@ -0,0 +1,48 @@
+require_relative 'output'
+
+module Arli
+  module Helpers
+    module SystemCommands
+
+      include Output
+
+      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)
+          print_target_dir(backup_path, 'backed up')
+          if verbose?
+            ___ "\nNOTE: path #{p.blue} has been backed up to #{backup_path.bold.green}\n"
+          end
+        end
+      end
+
+      # @param <String> *args — list of arguments or a single string
+      def run_system_command(*args)
+        cmd = args.join(' ')
+        raise 'No command to run was given' unless cmd
+        info("\n" + cmd.green) if Arli.debug?
+        o, e, s = Open3.capture3(cmd)
+        info("\n" + o) if o if Arli.debug?
+        info("\n" + e.red) if e && Arli.debug?
+      rescue Exception => e
+        error "Error running [#{args.join(' ')}]\n" +
+                  "Current folder is [#{Dir.pwd.yellow}]", e
+        raise e
+      end
+
+    end
+  end
+end

data/lib/arli/library/installer.rb

@@ -47,7 +47,7 @@ module Arli
             end
             puts if verbose?
           else
-            print_action_failure("unsupported", "missing pre-requisites: #{klass.command_name.bold.yellow} did not succeed")
+            print_action_failure('unsupported', "missing pre-requisites: #{klass.command_name.bold.yellow} did not succeed")
           end
         else
           print_action_failure("#{action_name.red} not found")

data/lib/arli/lock/file.rb

@@ -13,34 +13,34 @@ module Arli
                     :config,
                     :formatter,
                     :file,
-                    :format
+                    :format,
+                    :arlifile
 
-      def initialize(config: Arli.config)
+      def initialize(config: Arli.config, arlifile: nil)
         self.config         = config
+        self.arlifile       = arlifile
         self.format         = config.arlifile.lock_format
         self.formatter      = set_formatter(format)
         self.lock_file_path = "#{config.arlifile.path}/#{config.arlifile.name}.#{formatter.extension}"
         self.file           = ::File.open(lock_file_path, 'w')
-
-        append(formatter.header)
       end
 
       def lock(*libraries)
+        append(formatter.header)
         libraries.each do |lib|
           append(formatter.format(lib))
         end
+        append(formatter.footer)
+      ensure
+        close
       end
 
       def lock!(*args)
         lock(*args)
-      ensure
-        close
       end
 
       def close
-        append(formatter.footer)
-      ensure
-        file.close
+        file.close rescue nil
       end
 
       def append(line = nil)

data/lib/arli/lock/formats/base.rb

@@ -7,10 +7,11 @@ module Arli
         include Arli::Helpers::Inherited
         attr_assignable :extension
 
-        attr_accessor :lock_file
+        attr_accessor :lock_file, :arlifile
 
         def initialize(lock_file)
           self.lock_file = lock_file
+          self.arlifile = lock_file.arlifile
         end
 
         # Optional header
@@ -18,7 +19,6 @@ module Arli
         end
 
         def format(library)
-          raise Arli::Errors::AbstractMethodCalled, "#format on Base"
         end
 
         # Optional footer

data/lib/arli/lock/formats/cmake.rb

@@ -1,4 +1,5 @@
 require_relative 'base'
+require_relative 'template/cmake_renderer'
 
 module Arli
   module Lock
@@ -6,33 +7,21 @@ module Arli
       class Cmake < Base
         extension :cmake
 
+        attr_accessor :libraries
 
-        attr_accessor :libs, :comments
-
-        def header
-          @comments = []
-          @libs = []
-          "# vi:syntax=cmake"
+        def initialize(*args)
+          super(*args)
+          self.libraries = []
         end
 
         def format(library)
-          @libs << library
-          @comments << "# Library #{library.name}:\n# version #{library.version}\n#    url: #{library.url}"
+          self.libraries << library
           nil
         end
 
         def footer
-          %Q[
-# This file is auto-generated by Arli library manager.
-# See https://github.com/kigster/arli for more info.
-
-set(ARLI_LIBRARIES_PATH "#{Arli.config.libraries.path}")
-set(ARLI_LIBRARIES #{@libs.map(&:canonical_dir).join(' ')})
-
-set(ARLI_LIBRARIES $ARLI_LIBRARIES PARENT_SCOPE)
-
-#{@comments.join("\n")}
-          ]
+          renderer = Template::CMakeRenderer.new(arlifile)
+          renderer.render
         end
       end
     end

data/lib/arli/lock/formats/template/Arlifile.cmake.erb

@@ -0,0 +1,38 @@
+# vi:syntax=cmake
+#
+# © 2017 Konstantin Gredeskoul
+#   Distributed under MIT license.
+#
+# This file is auto-generated by the Arli library manager
+# which works in tandem with another projects — "arduino-cmake",
+# and "arli-cmake".
+#
+# For more info:
+#   See https://github.com/kigster/arli
+#   See https://github.com/kigster/arli-cmake
+#   See https://github.com/kigster/arduino-cmake
+
+set(ARLI_CUSTOM_LIBS_PATH "<%= arli_library_path %>")
+
+set(ARLI_CUSTOM_LIBS <% libraries.each do |library| %>
+      <%= library.canonical_dir %><% end %>)
+
+set(ARLI_ARDUINO_HARDWARE_LIBS <% hardware_libraries.each do |library| %>
+      <%= library.name %><% end %>)
+
+set(ARLI_ARDUINO_LIBS <% arduino_libraries.each do |library| %>
+      <%= library.name %><% end %>)
+
+<% device_libraries_headers_only.each do |library| %>
+set(<%= library.name %>_ONLY_HEADER yes)<% end %>
+
+include(Arli)
+
+arli_detect_serial_device("/dev/null")
+arli_detect_board("<%= board %>" "<%= cpu %>")
+
+message(STATUS "device: [${BOARD_DEVICE}], board: [${BOARD_NAME}], cpu: [${BOARD_CPU}] <<<")
+
+arli_build_all_libraries()
+
+

data/lib/arli/lock/formats/template/cmake_renderer.rb

@@ -0,0 +1,82 @@
+require 'erb'
+require 'forwardable'
+
+module Arli
+  module Lock
+    module Formats
+      module Template
+        class CMakeRenderer
+
+          extend Forwardable
+
+          def_delegators :@arlifile, :config, :arlifile_hash, :libraries
+
+          class << self
+            attr_accessor :template
+          end
+
+          self.template = ::File.read(::File.expand_path('../Arlifile.cmake.erb', __FILE__))
+
+          attr_accessor :arlifile, :erb
+
+          def initialize(arlifile)
+            self.arlifile = arlifile
+            self.erb      = ERB.new(self.class.template)
+          end
+
+          def render
+            erb.result(binding)
+          end
+
+          alias output render
+
+          def device
+            arlifile_hash.device
+          end
+
+          def board
+            device && device.board ? device.board : 'uno'
+          end
+
+          def cpu
+            device && device.cpu ? device.cpu : 'atmega328p'
+          end
+
+          def hardware_libraries
+            device && device.libraries ? device.libraries.hardware || [] : []
+          end
+
+          def arduino_libraries
+            device && device.libraries ? device.libraries.arduino || [] : []
+          end
+
+          def device_libraries
+            Array(hardware_libraries + arduino_libraries).flatten
+          end
+
+          def device_libraries_headers_only
+            device_libraries.select { |l| l.headers_only } || []
+          end
+
+          def library_path
+            config.libraries.path
+          end
+
+          def arli_library_path
+            if library_path.start_with?('/')
+              "#{library_path}"
+            elsif library_path.start_with?('~')
+              "$ENV{HOME}#{library_path[1..-1]}"
+            elsif library_path.start_with?('./')
+              "${CMAKE_CURRENT_SOURCE_DIR}/#{library_path[2..-1]}"
+            elsif library_path && library_path.size > 0
+              library_path
+            else
+              '${CMAKE_CURRENT_SOURCE_DIR}/libraries'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/arli/version.rb

@@ -1,3 +1,3 @@
 module Arli
-  VERSION = '0.9.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arli
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-23 00:00:00.000000000 Z
+date: 2017-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arduino-library
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.4
 - !ruby/object:Gem::Dependency
-  name: colored2
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: colored2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dry-types
+  name: dry-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dry-struct
+  name: dry-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dry-configurable
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tty-cursor
+  name: require_dir
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,13 +123,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: tty-cursor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,7 +207,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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
     requirements:
     - - ">="
@@ -220,9 +234,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "  This is a command-line installer of any number of dependent Github\n
-  \ projects, or libraries. Arli was created to offer Arduino-based projects \n  an
-  easy to use and consistent library manager.\n"
+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"
 email:
 - kigster@gmail.com
 executables:
@@ -260,6 +276,7 @@ files:
 - lib/arli/commands.rb
 - lib/arli/commands/base.rb
 - lib/arli/commands/bundle.rb
+- lib/arli/commands/generate.rb
 - lib/arli/commands/install.rb
 - lib/arli/commands/search.rb
 - lib/arli/configuration.rb
@@ -267,6 +284,7 @@ files:
 - lib/arli/extensions.rb
 - lib/arli/helpers/inherited.rb
 - lib/arli/helpers/output.rb
+- lib/arli/helpers/system_commands.rb
 - lib/arli/library.rb
 - lib/arli/library/installer.rb
 - lib/arli/library/multi_version.rb
@@ -276,6 +294,8 @@ files:
 - lib/arli/lock/formats/base.rb
 - lib/arli/lock/formats/cmake.rb
 - lib/arli/lock/formats/json.rb
+- lib/arli/lock/formats/template/Arlifile.cmake.erb
+- lib/arli/lock/formats/template/cmake_renderer.rb
 - lib/arli/lock/formats/text.rb
 - lib/arli/lock/formats/yaml.rb
 - lib/arli/version.rb
@@ -302,7 +322,9 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: This is a command-line installer of any number of dependent Github projects,
-  or libraries. Arli was created to offer Arduino-based projects  an easy to use and
-  consistent library manager.
+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.
 test_files: []