ngauthier-aptinstaller 0.2.0 → 0.3.0

data/README.markdown

@@ -0,0 +1,43 @@
+# Aptinstaller: automatically install apt package dependencies
+
+## Description
+This gem installs packages through apt-get in a similar manner as geminstaller installs gems.
+
+## Usage
+    aptinstaller [/full/path/to/rails/project/root]
+
+## Configuration
+
+### Add a Config File
+Put something like this in config/aptinstaller.yml:
+
+    ---
+    packages:
+      - executable: firefox
+      - executable: MP4Box
+        package: gpac
+
+The executable field is the name of the executable (i.e. $ MP4Box). If the package's name in the
+repositories is different from the executable, specify the package name with the "package"
+field (i.e. "gpac" which provides the MP4Box executable).
+
+### Add to Preinitializer
+
+Then in config/preinitializer.rb (create it if it doesn't exist, it's pulled automatically
+from boot.rb):
+
+    require 'rubygems'
+    require 'aptinstaller'
+    AptInstaller.autopkg(:config => 'config/aptinstaller.yml')
+
+## Installation
+
+### Latest Stable
+    sudo gem install ngauthier-aptinstaller
+
+### Cutting Edge
+    rake gem
+    sudo gem install pkg/aptinstaller-x.y.z.gem
+
+## Other Notes
+This gem uses Jeweler. HighFive@technicalpickles!

data/TODO.markdown

@@ -0,0 +1,4 @@
+# TODO
+* Allow version requirements
+* Allow flag for "custom installation" when a package needs to be built from source
+* Different messages for non-apt systems

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 2
+:minor: 3
 :patch: 0
 :major: 0

data/bin/aptinstaller

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-
-puts "Aptinstaller"
-
+require 'rubygems'
+require 'aptinstaller'
+AptInstaller.autopkg_install(ARGV[0])

data/lib/aptinstaller/aptinstaller.rb

@@ -3,7 +3,34 @@ require 'yaml'
 class AptInstaller
 
   def self.autopkg(opts = {})
-    config_file = opts.delete(:config)
+    config_yaml = self.read_yaml_file(opts[:config])
+    packages = self.detect_packages_to_install(config_yaml['packages'])
+    if packages.size > 0
+      $stderr.write "\nThe following packages are required by this program but not installed:\n\n"
+      packages.each do |package|
+        $stderr.write "\t* "+package['executable']
+        $stderr.write " (provided by package \"#{package['package']}\")" if package['package']
+        $stderr.write "\n"
+      end
+      $stderr.write "\nYou can install them by running \"aptinstaller\" in the root of your project\n\n"
+      exit(1)
+    end
+  end
+
+  def self.autopkg_install(rails_root = '.')
+    rails_root ||= '.' # in case they pass in nil
+    config_yaml = self.read_yaml_file(File.join(rails_root, 'config', 'aptinstaller.yml'))
+    packages = self.detect_packages_to_install(config_yaml['packages'])
+    if packages.size > 0
+      exec("apt-get install #{packages.collect{|p| p['package'] || p['executable'] }.join(" ")}")
+    else
+      puts "All dependencies are installed"
+    end
+  end
+
+  private
+
+  def self.read_yaml_file(config_file)
     raise "Error reading config file, no :config parameter specified" unless config_file
     begin
       begin
@@ -19,21 +46,16 @@ class AptInstaller
     rescue => ex
       raise "Error parsing YAML file: #{ex.to_s}"
     end
-    errors = []
-    config_yaml['packages'].each do |package|
+    config_yaml
+  end
+
+  def self.detect_packages_to_install(packages)
+    not_installed = []
+    packages.each do |package|
       exec = package['executable']
       pkg = package['package']
-      errors.push(package) if `which #{exec}`.size == 0
-    end
-    if errors.size > 0
-      $stderr.write "\nThe following packages are required by this program but not installed:\n\n"
-      errors.each do |package|
-        $stderr.write "\t* "+package['executable']+"\n"
-      end
-      $stderr.write "\nYou can install them by running:\n"
-      $stderr.write "\tapt-get install "
-      $stderr.write errors.collect{|p| p['package'] || p['executable']}.join(" ")
-      $stderr.write "\n\nor by running \"aptinstaller\" in the root of your project\n\n"
-      exit(1)
+      not_installed.push(package) if `which #{exec}`.size == 0
     end
+    not_installed
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ngauthier-aptinstaller
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Nick Gauthier
@@ -23,9 +23,8 @@ extra_rdoc_files: []
 
 files: 
 - VERSION.yml
-- History.txt
-- README.txt
-- Manifest.txt
+- TODO.markdown
+- README.markdown
 - bin/aptinstaller
 - lib/aptinstaller.rb
 - lib/aptinstaller

data/History.txt

@@ -1,4 +0,0 @@
-=== v0.1.0
-2009-01-14
-
-* Initial Release: Aptinstaller will scan your rails project's aptinstaller configuration file to install packages via apt-get.

data/Manifest.txt

@@ -1,8 +0,0 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-bin/aptinstaller
-aptinstaller.gemspec
-lib/aptinstaller.rb
-lib/aptinstaller/version.rb

data/README.txt

@@ -1,54 +0,0 @@
-= aptinstaller
-
-* http://github.com/ngauthier/aptinstaller/tree/master
-
-== DESCRIPTION:
-This gem installs packages through apt-get in a similar manner as geminstaller installs gems.
-
-== Usage:
-aptinstaller [/full/path/to/rails/project/root]
-
-Note: to run on a particular environment, invoke the executable as such:
-
-$> RAILS_ENV=staging aptinstaller /full/path/to/rails/project/root
-
-== INCOMPLETE ==
-* Currently it doesn't do anything. I'm just trying to rake the gem.
-
-== SYNOPSIS:
-
-  FIX (code sample of usage)
-
-== REQUIREMENTS:
-
-* a rails app that requires apt packages
-
-== INSTALL:
-
-rake gem
-sudo gem install pkg/aptinstaller-0.1.0.gem
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2008 FIX
-
-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.