arli 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43e1909fb095e1501d093f53991d7272281c9bb5
+  data.tar.gz: ade74d5c96106dc1e1bea96716332fcdbe7648b8
+SHA512:
+  metadata.gz: 4c9daf3b81b26a8ce323b03f71d14f70523566a6cf39cf29a1292a64f60f8812c5b819414542e43c0fac8c482a756b219f23fec025b8a1ce46efc2ad36a8fd5e
+  data.tar.gz: d5f564e8272beead7287ebd6b773456ecb42a02af44a61e3ab2a935a33805517390678dc4ae992fadd2f6ade61f71cd79ddfa0c0ebac4756cdf3c3da06d36513

data/.gitignore

@@ -0,0 +1,16 @@
+.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/doc/
+/pkg/
+/coverage/
+/spec/coverage/
+/tmp/
+/data
+/spec/coverage/
+/*.enc
+**/.DS_Store
+.ruby-version
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Konstantin Gredeskoul
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+[![Build Status](https://travis-ci.org/kigster/arli.svg?branch=master)](https://travis-ci.org/kigster/arli)
+
+# Arli
+
+Arli is a simple and easy to use installer of dependencies that can be 
+declared in a JSON file of the following format:
+
+
+```json
+{
+  "dependencies": [
+    {
+      "name": "DS1307RTC",
+      "git": "https://github.com/PaulStoffregen/DS1307RTC.git"
+    },
+    {
+      "name": "Adafruit_LEDBackpack",
+      "git": "https://github.com/adafruit/Adafruit-LED-Backpack-Library.git"
+    },
+  ]
+}
+```
+
+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.
+
+## Installation
+
+Install the gem globally like this: 
+
+```bash
+# if using rbenv, or rvm
+$ gem install arli 
+
+# OR, if your Ruby is a system ruby installed in eg. /usr/local, 
+$ sudo gem install arli 
+```
+
+## Usage
+
+Run `arli --help` for more information:
+
+```
+Usage:
+    arli [options] [command [options]]
+
+    -L, --lib-home HOME              Specify a local directory where libraries are installed
+    -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
+
+See arli <command> --help for more information on a specific command.
+```
+
+#### Install Command
+
+`install` is currently the only implemented command, and it should be used as follows:
+
+```
+Description:
+    installs libraries defined in the JSON file
+
+Usage:
+    arli install [options]
+
+Command Options
+    -L, --lib-home HOME              Specify a local directory where libraries are installed
+    -a, --arli-json FILE             JSON file with dependencies (defaults to arli.json)
+    -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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kigster/arli.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/arli.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$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.
+eof
+
+Gem::Specification.new do |spec|
+  spec.name          = 'arli'
+  spec.version       = Arli::VERSION
+  spec.authors       = ['Konstantin Gredeskoul']
+  spec.email         = ['kigster@gmail.com']
+
+  spec.summary       = Arli::DESCRIPTION
+  spec.description   = Arli::DESCRIPTION
+  spec.homepage      = 'https://github.com/kigster/arli'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'colored2'
+
+
+  spec.add_development_dependency 'simplecov'
+  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'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "arli"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/arli

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'arli'
+
+Arli::CLI.new.tap do |cli|
+  cli.parse
+end
+
+

data/lib/arli.rb

@@ -0,0 +1,10 @@
+require 'arli/version'
+require 'arli/cli'
+
+module Arli
+  DEFAULT_JSON_FILE_ENV    = 'ARDUINO_ARLI_LIBRARY_FILE'.freeze
+  DEFAULT_JSON_FILE        = ENV[DEFAULT_JSON_FILE_ENV] || 'arli.json'.freeze
+
+  DEFAULT_LIBRARY_PATH_ENV = 'ARDUINO_CUSTOM_LIBRARY_PATH'.freeze
+  DEFAULT_LIBRARY_PATH     = ENV[DEFAULT_LIBRARY_PATH_ENV] || (ENV['HOME'] + '/Documents/Arduino/Libraries')
+end

data/lib/arli/app.rb

@@ -0,0 +1,46 @@
+require 'colored2'
+require 'optparse'
+require 'hashie/mash'
+require 'saves/cli/parser'
+require 'forwardable'
+module Saves
+  module CLI
+    class App
+      extend Forwardable
+      def_delegators :@parser, :options, :output
+
+      attr_accessor :args, :command, :parser, :options, :output
+
+      def initialize(args)
+        if args.nil? || args.empty?
+          self.args = %w[--help]
+        else
+          self.args = args.dup
+        end
+
+        self.parser  = ::Saves::CLI::Parser
+        self.options = parser.options
+        self.output  = parser.output
+      end
+
+      def parse!
+        if args.first =~ /^-/
+          parser.global.parse!(args)
+        else
+          cmd = self.args.shift.to_sym
+          begin
+            Parser.parser_for(cmd).parse!(args)
+            self.command = cmd # did not raise exception, so valid command.
+          rescue Saves::CLI::InvalidCommandError => e
+            options[:errors] = [e.message]
+          end
+        end
+      end
+
+      def out
+        output.join("\n")
+      end
+
+    end
+  end
+end

data/lib/arli/cli.rb

@@ -0,0 +1,147 @@
+require 'optparse'
+require 'hashie/mash'
+require 'hashie/extensions/symbolize_keys'
+require 'colored2'
+require 'arli'
+require 'arli/parser'
+require 'arli/commands/install'
+
+module Arli
+  class CLI
+    class InvalidCommandError < ArgumentError;
+    end
+
+    COMMAND = 'arli'
+    PARSER  = ::Arli::CLI::Parser
+
+    attr_accessor :argv, :command, :parser
+    attr_accessor :options
+
+    def initialize(argv = ARGV.dup)
+      self.argv    = argv
+      self.options = Hashie::Mash.new
+    end
+
+    def parse
+      if argv.first
+        if argv.first =~ /^-.*$/
+          self.parser = self.class.global
+        elsif command_detected?
+          self.parser = parse_command_options!
+        end
+      end
+
+      if parser
+        parser.parse!(argv)
+        parser.print
+        options.merge!(parser.options)
+      end
+
+      @options = Hashie::Extensions::SymbolizeKeys.symbolize_keys!(options.to_h)
+
+      run_command! unless options[:help]
+
+    rescue InvalidCommandError => e
+      puts e.message
+    end
+
+    private
+
+    def run_command!
+      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
+
+        command_class.new(options).run
+      end
+    rescue NameError => e
+      puts "Unfortunately command #{command.to_s.red} is not yet implemented.\n\n"
+    end
+
+    def parse_command_options!
+      self.class.parser_for(command)
+    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!"
+        end
+      end
+      self.command
+    end
+
+    class << self
+
+      def global
+        @global ||= PARSER.new do |parser|
+          parser.banner = usage_line
+          parser.sep
+          parser.option_help(commands: true)
+        end
+      end
+
+      def usage_line(command = nil)
+        command ? command_usage(command) : global_usage(command)
+      end
+
+      def global_usage(command)
+        "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
+      end
+
+      def commands
+        @commands ||= {
+          install: {
+            description: 'installs libraries defined in the JSON file',
+            parser:      -> (command) {
+              PARSER.new do |parser|
+                parser.banner = usage_line 'install'
+                parser.option_lib_home
+                parser.option_dependency_file
+                parser.option_help(command: command)
+              end
+            } },
+
+          update:  {
+            description: 'updates libraries defined in the JSON file',
+            parser:      -> (command) {
+              PARSER.new do |parser|
+                parser.banner = usage_line 'update'
+                parser.option_lib_home
+                parser.option_dependency_file
+                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
+
+      def parser_for(cmd)
+        if commands[cmd]
+          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")}")
+        end
+      end
+    end
+  end
+end

data/lib/arli/commands/install.rb

@@ -0,0 +1,51 @@
+require 'json'
+require 'fileutils'
+require 'open3'
+require 'arli'
+
+module Arli
+  module Commands
+
+    class Install
+      attr_accessor :lib_path, :json_file
+
+      def initialize(options)
+
+        self.lib_path  = options[:lib_home]
+        self.json_file = options[:arli_json]
+
+        setup
+      end
+
+      def run
+        libs = JSON.load(File.read(json_file))
+        puts "Installing into #{lib_path.bold.green}"
+
+        Dir.chdir(lib_path) do
+          libs['dependencies'].each do |dependency|
+            name = dependency['name']
+            url  = dependency['git']
+            printf 'processing library: ' + name.yellow.bold + "\n"
+            unless Dir.exist?(name)
+              cmd = "git clone -v #{url} #{name} 2>&1"
+            else
+              cmd = "cd #{name} && git pull --rebase 2>&1"
+            end
+            puts 'command: ' + cmd.bold.blue
+            o, e, s = Open3.capture3(cmd)
+            puts o if o
+            puts e.red if e
+          end
+        end
+      end
+
+      private
+
+      def setup
+        FileUtils.mkdir_p(lib_path)
+        yield self if block_given?
+        self
+      end
+    end
+  end
+end

data/lib/arli/parser.rb

@@ -0,0 +1,84 @@
+module Arli
+  class CLI
+    class Parser < OptionParser
+      attr_accessor :output_lines, :command, :options
+
+      def initialize(command = nil)
+        super
+        self.output_lines = Array.new
+        self.command      = command
+        self.options = Hashie::Mash.new
+
+      end
+
+      def sep(text = nil)
+        separator text || ''
+      end
+
+      def option_dependency_file
+        on('-a FILE', '--arli-json FILE', "JSON file with dependencies (defaults to #{DEFAULT_JSON_FILE.bold.magenta})") { |v| options[:arli_json] = v }
+      end
+
+      def option_help(commands: false, command: nil)
+        on('-h', '--help', 'prints this help') do
+          puts 'Description:'.bold if command
+          output ' ' * 4 + command[:description].bold.green if command
+          output ''
+          output_help
+          output_command_help if commands
+          options[:help] = true
+        end
+      end
+
+      def option_lib_home
+        on('-L', '--lib-home HOME', 'Specify a local directory where libraries are installed') { |v| options[:lib_home] = v }
+      end
+
+      def option_library
+        on('-l', '--lib LIBRARY', 'Library Name') { |v| options[:library_name] = v }
+        on('-f', '--from FROM', 'A git or https URL') { |v| options[:library_from] = v }
+        on('-v', '--version VERSION', 'Library Version, i.e. git tag') { |v| options[:library_version] = v }
+        on('-i', '--install', 'Install a library') { |v| options[:library_action] = :install }
+        on('-r', '--remove', 'Remove a library') { |v| options[:library_action] = :remove }
+        on('-u', '--update', 'Update a local library') { |v| options[:library_action] = :update }
+      end
+
+      def option_help_with_subtext
+        option_help
+      end
+
+      def output_help
+        output self.to_s
+      end
+
+      def output_command_help
+        output command_help
+      end
+
+      def command_help
+        subtext = "  Available Commands:\n"
+
+        ::Arli::CLI.commands.each_pair do |command, config|
+          subtext << <<-EOS
+#{sprintf('    %-12s', command.to_s).green} : #{sprintf('%-70s', config[:description]).yellow}
+          EOS
+        end
+        subtext << <<-EOS
+        
+See #{COMMAND.bold.blue + ' <command> '.bold.green + '--help'.bold.yellow} for more information on a specific command.
+
+        EOS
+        subtext
+      end
+
+      def output(value = nil)
+        self.output_lines << value if value
+        self.output_lines
+      end
+
+      def print
+        puts output.join("\n")
+      end
+    end
+  end
+end

data/lib/arli/version.rb

@@ -0,0 +1,3 @@
+module Arli
+  VERSION = '0.2.1'.freeze
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: arli
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Konstantin Gredeskoul
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-21 00:00:00.000000000 Z
+dependencies:
+- !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: colored2
+  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
+    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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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'
+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"
+email:
+- kigster@gmail.com
+executables:
+- arli
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- arli.gemspec
+- bin/console
+- bin/setup
+- exe/arli
+- lib/arli.rb
+- lib/arli/app.rb
+- lib/arli/cli.rb
+- lib/arli/commands/install.rb
+- lib/arli/parser.rb
+- lib/arli/version.rb
+homepage: https://github.com/kigster/arli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+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.
+test_files: []