arli 0.9.0 → 1.0.0

data/Rakefile

@@ -7,8 +7,11 @@ def shell(*args)
   system(args.join(' '))
 end
 
+task :clean do 
+  shell('rm -rfv pkg/ tmp/ coverage/' )
+end
+
 task :permissions do 
-  shell('rm -rf pkg/ tmp/ coverage/' )
   shell("chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*")
   shell("find . -type d -exec chmod o+x,g+x {} \\;")
 end
@@ -16,8 +19,8 @@ end
 task :build => :permissions
 
 YARD::Rake::YardocTask.new(:doc) do |t|
-  t.files = %w(lib/**/*.rb exe/*.rb - README.md LICENSE)
-  t.options.unshift('--title','"Sym – Symmetric Key Encryption for Your Data"')
+  t.files = %w(lib/**/*.rb exe/*.rb - README.md LICENSE.txt)
+  t.options.unshift('--title','Arli — The Missing Arduino Library Manager')
   t.after = ->() { exec('open doc/index.html') }
 end
 

data/arli.gemspec

@@ -5,9 +5,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'arli/version'
 
 Arli::DESCRIPTION = <<-eof
-  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.
+  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.
 eof
 
 Gem::Specification.new do |spec|
@@ -29,20 +31,20 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'arduino-library', '~> 0.5.4'
-  spec.add_dependency 'colored2'
   spec.add_dependency 'awesome_print'
-  spec.add_dependency 'hashie'
-  spec.add_dependency 'dry-types'
-  spec.add_dependency 'dry-struct'
+  spec.add_dependency 'colored2'
   spec.add_dependency 'dry-configurable'
+  spec.add_dependency 'dry-struct'
+  spec.add_dependency 'dry-types'
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'require_dir'
   spec.add_dependency 'tty-cursor'
 
-
-  spec.add_development_dependency 'yard'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'aruba'
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-its'
-  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'yard'
 end

data/lib/arli.rb

@@ -1,5 +1,13 @@
+require 'require_dir'
+
+module Arli
+  extend RequireDir
+  init __FILE__
+end
+
 require 'arduino/library'
 require 'arli/helpers/inherited'
+require 'arli/helpers/system_commands'
 require 'arli/version'
 require 'arli/extensions'
 require 'arli/errors'

data/lib/arli/actions/git_repo.rb

@@ -1,7 +1,12 @@
 require_relative 'action'
+require_relative '../helpers/system_commands'
+
 module Arli
   module Actions
     class GitRepo < Action
+
+      include ::Arli::Helpers::SystemCommands
+
       description 'Fetches or updates remote git repositories'
       check_command 'git --version'
       check_pattern 'git version'
@@ -19,21 +24,6 @@ module Arli
         "git clone -v #{library.url} #{library.dir} 2>&1"
       end
 
-      protected
-
-      # @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/actions/move_to_library_path.rb

@@ -1,15 +1,17 @@
 require_relative 'action'
+require_relative '../helpers/system_commands'
 
 module Arli
   module Actions
     class MoveToLibraryPath < Action
+
       description 'Moves the downloaded library to the proper path, optionally creating a backup'
 
+      include ::Arli::Helpers::SystemCommands
+
       def execute
         Dir.chdir(config.runtime.pwd) do
-
           handle_preexisting_folder(path) if exists?
-
           if Dir.exist?(temp_path) && !Dir.exist?(path)
             FileUtils.mkdir_p(File.dirname(path))
             ___ "current: #{Dir.pwd.yellow}\ntemp_path: #{temp_path.yellow}\nlibrary_path: #{path.yellow}\n" if debug?
@@ -23,32 +25,6 @@ module Arli
           end
         end
       end
-
-      private
-
-      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
-
     end
   end
 end

data/lib/arli/arli_file.rb

@@ -18,9 +18,10 @@ module Arli
     include ::Arli::Library
 
     attr_accessor :dependencies,
-                  :parsed_data,
+                  :arlifile_hash,
                   :arlifile_path,
-                  :config
+                  :config,
+                  :device
 
     def initialize(config: Arli.config, libraries: [])
       self.config = config
@@ -29,15 +30,7 @@ module Arli
 
       self.config.libraries.temp_dir ||= Dir.mktmpdir
 
-      if parsed_data
-        if parsed_data.libraries_path
-          self.config.libraries.path = parsed_data.libraries_path
-        end
-
-        if parsed_data.lock_format
-          Arli.config.arlifile.lock_format = parsed_data.lock_format
-        end
-      end
+      configure_via_arlifile!(arlifile_hash)
     end
 
     alias libraries dependencies
@@ -50,6 +43,14 @@ module Arli
 
     private
 
+    def configure_via_arlifile!(mash)
+      if mash
+        config.libraries.path = mash.libraries_path if mash.libraries_path
+        config.arlifile.lock_format = mash.lock_format if mash.lock_format
+        self.device = mash.device if mash.device
+      end
+    end
+
     def within_temp_path(&block)
       within_path(Arli.config.libraries.temp_dir, &block)
     end
@@ -80,15 +81,17 @@ module Arli
     end
 
     def parse_yaml_file
-      self.parsed_data = Hashie::Mash.new(
+      self.arlifile_hash = Hashie::Mash.new(
           Hashie::Extensions::SymbolizeKeys.symbolize_keys(
               ::YAML.load(
-                  ::File.read(
-                      self.arlifile_path)
+                  ::File.read(self.arlifile_path)
               )
           )
       )
-      parsed_data.dependencies.map {|lib| make_lib(lib)}
+
+      config.arlifile.hash = arlifile_hash
+
+      arlifile_hash.dependencies.map {|lib| make_lib(lib)}
     end
   end
 end

data/lib/arli/cli/command_finder.rb

@@ -52,7 +52,7 @@ module Arli
       end
 
       def instantiate_command
-        self.command_name = detect_command unless command_name
+        self.command_name ||= detect_command
         begin
           name          = command_name.to_s.capitalize.to_sym
           command_class = ::Arli::Commands.const_get(name)

data/lib/arli/cli/parser.rb

@@ -97,9 +97,27 @@ module Arli
         option_search_attributes
       end
 
-      def option_if_exists
+      def option_generate
+        on('-w', '--workspace DIR',
+           'a top-level folder under which the project will be created',
+           'Default is the current folder.' + "\n\n") do |v|
+          config.generate.workspace = v
+        end
+
+        # on('-L', '--libs "LIBS"',
+        #    'Comma separated list of library names, or name ',
+        #    'substrings, to be searched for and added to the ',
+        #    'initial Arlifile. Multiple matches are added anyway',
+        #    'while no matches are skipped' + "\n\n") do |v|
+        #   config.generate.libs = v.split(',')
+        # end
+
+        option_if_exists('project')
+      end
+
+      def option_if_exists(what = 'library')
         on('-e', '--if-exists ACTION',
-           'If a library folder already exists, by default',
+           "If a #{what} folder already exists, by default",
            'it will be overwritten or updated if possible.',
            'Alternatively you can either ' + 'abort'.bold.blue + ' or ' + 'backup'.bold.blue
         ) do |v|
@@ -115,23 +133,19 @@ module Arli
 
       def option_help(commands: false, command_name: nil)
         common_help_options
-
         on('-h', '--help', 'prints this help') do
           ::Arli.config.help = true
 
           command_hash = output_command_description(command_name)
-
-          output_help
+          output_examples(command_hash[:examples]) if command_hash && command_hash[:examples]
           output_command_help if commands
+          output_help
 
-          if command_hash && command_hash[:examples]
-            output_examples(command_hash[:examples])
-          else
-            print_version_copyright
-          end
+          print_version_copyright
         end
       end
 
+
       def option_search_attributes
         on('-A', '--print-attrs', 'prints full list of available library',
            'attributes that can be used in search strings.', ' ') do
@@ -240,12 +254,12 @@ See #{Arli::Configuration::ARLI_COMMAND.blue + ' command '.green + '--help'.yell
           if command_hash.description
             header 'Description'
             if command_hash.sentence
-              output indent + command_hash.sentence.bold
+              output indent + command_hash.sentence.bold.blue
               output ''
             end
 
             text = Array(command_hash[:description]).flatten.join(' ')
-            output text.reformat_wrapped(width = 70, indent_with = 8)
+            output text.reformat_wrapped(width = 70, indent_with = 4).yellow.dark
           end
         end
 

data/lib/arli/cli/parser_factory.rb

@@ -75,6 +75,38 @@ module Arli
                       }
                   }),
 
+              generate:  Hashie::Mash.new(
+                  {
+                      sentence:    'Generates a new Arduino project with Arlifile',
+
+                      description: %Q[This will create a new project folder, a source file, and an Arlifile
+                                      based on the template project repo defined in the config file. At the moment
+                                      only arduino-cmake is supported as the build environment as it's the one that
+                                      provides the widest choice of developer IDEs to use for programming your project.
+                                      You can use Vim or Emacs, Atom, CLion, Eclipse, Visual Studio, or just plain
+                                      command line to build and upload your project. Some knowledge of CMake is
+                                      helpful.
+                                    ],
+                      examples:    [
+                                       { desc: 'Creates a new project in the specified folder. Default is current dir.',
+                                         cmd:  'arli generate MyClock --workspace ~/Documents/Arduino/Sketches' },
+
+                                       { desc: 'Creates a folder "Blinker" in the current directory',
+                                         cmd:  %Q{arli generate Blinker  } },
+
+                                       { desc: 'Populate initial Arlifile with the libs provided',
+                                         cmd:  %Q{arli generate Weather --libs 'Adafruit Unified Sensor,Adafruit GFX Library,Time' } },
+                                   ],
+
+                      parser:      -> (command_name) {
+                        make_parser(command_name) do |parser|
+                          parser.banner = usage_line 'generate' + ' project-name '.magenta
+                          parser.option_generate
+                          parser.option_help(command_name: command_name)
+                        end
+                      }
+                  }),
+
               bundle:  Hashie::Mash.new(
                   {
                       sentence: 'Installs all libraries specified in Arlifile',
@@ -145,7 +177,7 @@ module Arli
         def global_usage(command)
           'Usage:'.magenta.bold +
               "\n    " + arli_command + ' options '.yellow +
-              "\n    " + arli_command + ' ' + ((command || 'command')).green + ' [ options ] '.yellow + "\n"
+              "\n    " + arli_command + ' ' + ((command || 'command')).cyan.bold + ' [ options ] '.yellow + "\n"
         end
 
         def arli_command
@@ -154,7 +186,7 @@ module Arli
 
         def command_usage(command)
           'Usage:'.magenta.bold +
-              "\n    " + arli_command + ' ' + command.green + ' [options]'.yellow + "\n\n" +
+              "\n    " + arli_command + ' ' + command.bold.cyan + ' [options]'.yellow + "\n\n" +
               'Options'.magenta.bold
         end
 

data/lib/arli/cli/runner.rb

@@ -1,5 +1,6 @@
+require 'arli'
 require 'arli/cli/app'
-require 'pp'
+
 module Arli
   module CLI
     # For the reasons this file is the way it is, please refer to

data/lib/arli/commands.rb

@@ -3,7 +3,5 @@ module Arli
   end
 end
 
-require_relative 'commands/base'
-require_relative 'commands/search'
-require_relative 'commands/bundle'
-require_relative 'commands/install'
+
+Arli.dir('arli/commands')

data/lib/arli/commands/bundle.rb

@@ -15,7 +15,7 @@ module Arli
       def setup
         super
         self.arlifile = Arli::ArliFile.new(config: config)
-        self.lock_file = Arli::Lock::File.new(config: config)
+        self.lock_file = Arli::Lock::File.new(config: config, arlifile: arlifile)
       end
 
       def params

data/lib/arli/commands/generate.rb

@@ -0,0 +1,122 @@
+require 'json'
+require 'arli'
+require 'net/http'
+require_relative 'base'
+require_relative '../arli_file'
+require_relative '../helpers/system_commands'
+require 'forwardable'
+module Arli
+  module Commands
+    class Generate < Base
+      include ::Arli::Helpers::SystemCommands
+
+      extend Forwardable
+      def_delegators :@settings, :project_name, :project_name=, :workspace, :workspace=, :libs, :libs=, :template_repo
+
+      attr_accessor :settings, :dir
+
+
+      def setup
+        config.generate.project_name = config.runtime.argv.first
+
+        self.settings = config.generate
+
+        raise ::Arli::Errors::RequiredArgumentsMissing, 'Project name is required' unless project_name
+        raise ::Arli::Errors::RequiredArgumentsMissing, 'Template Repo is missing' unless template_repo
+
+        self.dir = settings.workspace + '/' + project_name
+        handle_preexisting_folder(dir) if Dir.exist?(dir)
+        FileUtils.mkdir_p(workspace) unless Dir.exist?(workspace)
+      end
+
+      def run
+        Dir.chdir(workspace) do
+          run_system_command "git clone -v #{template_repo} #{project_name} 2>&1"
+          Dir.chdir(project_name) do
+            FileUtils.rm_rf('.git')
+            run_system_command 'git init .'
+            run_system_command 'bin/setup'
+            configure_template!
+            rename_files!
+          end
+        end
+      end
+
+      def additional_info
+        "Generating project #{project_name.bold.green} into #{workspace.bold.yellow}..."
+      end
+
+      private
+
+      def rename_files!
+        Dir.chdir('src') do
+          FileUtils.mv('MyProject.cpp', "#{project_name}.cpp")
+          run_system_command "sed -i 's/MyProject/#{project_name}/g' CMakeLists.txt"
+        end
+      end
+
+      def configure_template!
+        File.open('README.md', 'w') do |f|
+          f.write <<-EOF
+
+# #{project_name}
+
+Please refer to the README for the template project, available here:
+[arli-cmake](#{template_repo}).
+
+## Usage
+
+Let's cd into the project folder:
+
+```bash
+cd #{project_name}
+```
+
+The directory structure should look as follows:
+
+```
+  #{project_name}
+     |
+     |__ bin/
+     |   |___ setup
+     |   |___ build
+     |
+     |__ cmake/
+     |   |___ Arli.cmake
+     |   |___ ArduinoToolchain.cmake          <———— provided by arduino-cmake project
+     |   |___ Platform/                       <———— provided by arduino-cmake project
+     |
+     |__ src/
+     |   |___ Arlifile
+     |   |___ CMakeLists.txt
+     |   |___ #{project_name}.cpp
+     |
+     |__ example/
+         |___ Arlifile
+         |___ CMakeLists.txt
+         |___ Adafruit7SDisplay.cpp
+```
+
+You might need to run `bin/setup` first to ensure you have all the dependencies. 
+
+Once you do that, you can build any of the source folders (i.e. either `src` or `example`) by
+running `bin/build src` or `bin/build example`.
+
+### Building Manually
+
+The process to build and upload manually is super simple too:
+
+```bash
+cd src
+rm -rf build && mkdir build && cd build
+cmake ..
+make 
+make upload
+```
+
+          EOF
+        end
+      end
+    end
+  end
+end