arpm 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f5a1c1cfb42651abccccd469487764ace2b7feb
+  data.tar.gz: 801769a8aa288b45690c5d3863272aa9828f052f
+SHA512:
+  metadata.gz: 375a6b4dcc7195801db1349317daa030bfb51b9ae67c1967a2f13385b8826ac04ff6ef4a46b0fa17f5b533f5a3f0c1b5d2d34a8248cc27e41f3d23027cc5ce97
+  data.tar.gz: 81ec2b26e71330ef34683851231f48b09d18702819daad6eb167d529cfa3961aa1612e4b693eb9e320fd115c652c5da3be751719fd230a48eef22ef82275e312

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+Libfile

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in arpm.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex Forey
+
+MIT License
+
+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,92 @@
+# arpm
+
+arpm is the Arduino Package Manager, a simple way to keep track of all the libraries used in an Arduino project.
+
+## Installation
+
+Install it via RubyGems:
+
+    $ gem install arpm
+
+## Usage
+
+There are two ways of installing libraries, much like with other package managers such as RubyGems. You can either install them by hand, and use arpm as an easy way of quickly installing libraries, or you can use the Libfile to keep track of which libraries a project requires and allows anyone else to install all of them by running a single command, `arpm bundle`.
+
+### Bundle
+
+Projects should have a Libfile in their root (the folder with the `.ino` sketch file in it), which looks something like:
+
+```
+lib "bergcloud", "1.0"
+lib "time", "3.2"
+```
+
+Then, open a console in that directory and type:
+
+    $ arpm bundle
+
+This will read the list of dependencies and install them into your Arduino's library directory (`~/Documents/Arduino/libraries` on OS X and `~\My Documents\Arduino\libaries` on Windows).
+
+### Manual Installing
+
+Manually installing libraries is as simple as running a command. For the most recent version of a library, run:
+
+    $ arpm install package_name
+
+To specify a version, you can do this, for instance:
+
+    $ arpm install package_name 1.0
+
+## Registering a Library
+
+So you've made a library and you want to get it on arpm? There are only 3 things you need to do:
+
+1. Put the source code for the library on GitHub (or some other Git host, like BitBucket)
+2. Create a release of your code with the tag of a version number (e.g. `1.0`)
+3. Add your library to `packages.json`
+
+### Putting Source Online
+
+Push your source code to your favourite Git hosting site, and obtain an URL that looks like:
+
+> https://github.com/bergcloud/devshield-arduino.git
+
+### Create a Release
+
+This is as simple as going to the releases tab of the site you use. For GitHub, it's:
+
+> https://github.com/username/your-repository/releases
+
+Then hit the 'Create a New Release' button, and put the version number in the `tag` box. Make sure your version number starts with a number, and is separated by dots. Version numbers cannot contain `-` however because the Arduino IDE doesn't like them.
+
+For instance, `1.0`, `0.9.2` and `2.0.beta` are all valid version names.
+
+### Adding to `packages.json`
+
+First, fork this repository. Then edit the `packages.json` file, adding a section like this:
+
+```
+{
+  "name": "bergcloud",
+  "repository": "https://github.com/bergcloud/devshield-arduino.git",
+  "authors": ["Nick Ludlam", "Andy Huntington"],
+  "email": "info@bergcloud.com"
+}
+```
+Note: the `name` cannot contain dashes (`-`) either because Arduino doesn't like them. It can only contain letters, numbers, and underscores.
+
+Add the git URL you got earlier to the `repository` section.
+
+Make sure that there's a comma on the end of the previous repository (`},`) and one on the end of yours if there are packages after it.
+
+Then make a pull request, and if everything's fine, I'll merge it as soon as I can, and your package will go live.
+
+## Contributing to Source
+
+To contribute to the source of arpm:
+
+1. Fork it (https://github.com/alfo/arpm/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/arpm.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arpm/version'
+require 'arpm/string'
+
+Gem::Specification.new do |spec|
+  spec.name          = "arpm"
+  spec.version       = ARPM::VERSION
+  spec.authors       = ["Alex Forey"]
+  spec.email         = ["me@alexforey.com"]
+  spec.summary       = %q{The Arduino Package Manager}
+  spec.description   = %q{Keep your libraries in shape}
+  spec.homepage      = "http://arpm.github.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = ["arpm"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "thor", "~> 0.19"
+
+end

data/bin/arpm

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require 'arpm'
+
+ARPM::CLI.start(ARGV)

data/lib/arpm.rb

@@ -0,0 +1,14 @@
+require "json"
+require "open-uri"
+
+require "arpm/vendor/ruby-git/git"
+
+require "arpm/config"
+require "arpm/version"
+require "arpm/string"
+require "arpm/os"
+
+require "arpm/libfile"
+require "arpm/list"
+require "arpm/package"
+require "arpm/cli"

data/lib/arpm/cli.rb

@@ -0,0 +1,250 @@
+require "fileutils"
+
+module ARPM
+  class CLI < Thor
+
+    desc "install [PACKAGE] ([VERSION])", "Install a package"
+    def install(name, version = nil)
+
+      # Install all the things
+      puts "Searching for packages...".cyan
+
+      package = ARPM::Package.search(name)
+
+      if package
+
+        # Check to see if there actually any releases yet
+        puts "No releases of #{name} yet".red and return unless package.latest_version
+
+        # Check that the requested version exists
+        if version and !package.versions.include?(version)
+          puts "Version #{version} of #{name} doesn't exist".red
+          return false
+        end
+
+        # Get the install path
+        path = package.install_path(version)
+
+        puts "Cloning #{name} into #{path}"
+
+        # Delete the path if it already exists
+        FileUtils.rm_r(path) if File.exists?(path)
+
+        # Was the version specified?
+        version = package.latest_version unless version
+
+        package.install(version)
+
+        puts "Installed #{name} version #{version}".green.bold
+
+      else
+
+        puts "No package named #{name} found".red
+        return false
+
+      end
+
+    end
+
+    desc "uninstall [PACKAGE] ([VERSION])", "Uninstall a package"
+    def uninstall(name, version = nil)
+
+      if ARPM::List.includes?(name)
+
+        package = ARPM::Package.new(:name => name, :versions => ARPM::List.versions(name))
+
+        versions = package.installed_versions
+
+        # Was a version specified?
+        if version
+
+          # Yes it was, is it installed?
+          if versions.include?(version)
+
+            # Yes it is! Unintstall it
+            package.uninstall(version)
+
+            puts "#{package.name} version #{version} uninstalled".green.bold
+
+
+          else
+
+            # Nope, it's not installed
+            puts "Version #{version} of #{name} is not installed".red and return
+          end
+
+        else
+
+          if package.installed_versions.size > 1
+
+            # They've got multiple installed but haven't said which one
+            puts "Please specify a version to uninstall from this list:".red
+
+            package.installed_versions.each do |v|
+              puts "  #{v}"
+            end
+
+          else
+
+            version = installed_versions.first
+
+            # There's only one installed version
+            package.uninstall(version)
+
+            puts "#{package.name} version #{version} uninstalled".green.bold
+
+          end
+
+        end
+
+      else
+
+        puts "#{name} is not installed".red and return
+
+      end
+
+    end
+
+    desc "update PACKAGE", "Update a package"
+    def update(name)
+
+      # Check to see if it is installed?
+      if ARPM::List.includes?(name)
+
+        # Get the current info
+        package = ARPM::Package.search(name)
+
+        # Does it exist?
+        if package
+
+          # Do we have more than one installed version?
+          if package.installed_versions.size > 1
+
+            # Yes, ask the user to deal with it
+            puts "#{name} has more than one version installed:".red
+            package.installed_versions.each do |v|
+              puts "  #{v}"
+            end
+            puts "Please run" + "arpm install #{name}".bold + "to install the latest one"
+
+          else
+
+            # No, just one installed version
+
+            current_version = package.installed_versions.first
+
+            # Does this package even need updating?
+            if current_version == package.latest_version
+
+              # Nope
+              puts "#{name} is already at the most recent version (#{package.latest_version})".red
+
+            else
+
+              # Yes, so let's actually fucking do it
+
+              package.uninstall(current_version)
+              package.install(package.latest_version)
+
+              puts "#{name} updated to version #{package.latest_version}".green.bold
+
+            end
+
+          end
+
+        else
+
+          puts "#{name} no longer exists".red and return
+
+        end
+
+      else
+        puts "#{name} is not installed yet".red and return
+      end
+    end
+
+    desc "list", "List the installed packages"
+    def list
+
+      # Get a list of all the packages
+      packages = ARPM::List.all
+
+      puts "\nLocal Packages: \n".bold
+
+      # Loop over them
+      packages.each do |p|
+
+        name = p.keys.first
+        versions = p[name]
+
+        # Print them out
+        puts "#{name} (#{versions.join(', ')})".cyan
+
+      end
+
+      puts "\n"
+
+    end
+
+    desc "search [PACKAGE]", "Search for packages with names containing [PACKAGE]"
+    def search(name)
+
+      # Search for the package
+      packages = ARPM::Package.search(name, false)
+
+      if packages
+
+        # Loop over any results
+        packages.each do |package|
+          puts "#{package.name}-#{package.latest_version}"
+        end
+
+      else
+        puts "No results".red
+      end
+    end
+
+    desc "bundle", "Install all a project's dependencies"
+    def bundle
+
+      # Find the Libfile
+      lib_file = ARPM::Libfile.location
+
+      if File.exists?(lib_file)
+
+        # It exists, so get its contents and make an object
+        lib_file = ARPM::Libfile.new(File.open(lib_file).read)
+
+        # Loop over the dependencies
+        lib_file.dependencies.each do |dependency|
+
+          name = dependency.keys[0]
+          version = dependency[dependency.keys[0]]
+
+          # Make sure the package exists
+          package = ARPM::Package.search(name)
+
+          if package
+
+            # Is it already installed?
+            if ARPM::List.includes?(name, version)
+              puts "Using #{name}-#{version}"
+            else
+
+              # No, so install it
+              package.install(version)
+            end
+          else
+
+            # The package doesn't exist
+            puts "Could not find #{name}".red
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end