natives 0.4.1 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MWQ1ZWNjOWFlNTg3YThlOGZhZjE3ZmEzMWU2MmJlYWY5MzhhMzdiZA==
+    MTFiNjcxMTE5N2I2NGU5NjkwNTc4NmUyMDRkMmVhZTJiOGViMTBkZA==
   data.tar.gz: !binary |-
-    YjE2ZWY5Y2IwMzI0NjljNGJkNzE1MmY0YTYzYTgyMWU3Y2FkOWE2OQ==
+    Nzg2M2Q5MWIxOTdjMGJmMDQ0Y2Y3YTUzNmJlZWI4Nzc1ZGM2MmY0NA==
 SHA512:
   metadata.gz: !binary |-
-    ZTZmYmE1YzRjNDNmMGJhM2Y3NWEzM2RhZGZjY2U0ZDNkZTM1M2U4ZDE2YmYz
-    ZTEzNzJlYTNjM2RhY2JiYjM3MzMwNjRmMGMzMWMyMDcyMWU2Zjg3NGVkY2Ux
-    MjE5YjBhODk4MWJkMmMyNWRiYzQyZmNhNjMyZmY1YjZjN2JjM2M=
+    NDRhZjJiMTQ0MmFkNjA4Y2NkOGYwY2VjMjExYWY2YTgxN2M1ODg4YzU0MDQz
+    OGQ4MzFhOTBlNjllNDA2MTBhY2IzMzI2MmJkZTZlYThmZGMxODU4YzRlNmY3
+    OTgyYzQyMmMyYWVmMzMzNjZmNWY3YWQ2YTMzZDg4NDA1MzU0NGQ=
   data.tar.gz: !binary |-
-    NmQwNzMxZjUxYmVhNjVkNjhjMjIyMzBiMDkzOWQwMWYwYzQxZTE4ZWUyM2Jh
-    YTY3ZDZmMWFhYWIyMTdkNDM4YmNhMmYwNWIzOGM3MGQxNjIwMjM1NTczZjU2
-    ODg1YWZkYTJlMjEyZTg5NmU5Zjg0MjkxZjI4MmQ0OWRhZWFhMmQ=
+    YmY3YjBmNjZlNjdlYjEzNjU2MTIxOWRkNzg4MjgzYTJmNjJkMDRmNDJhYzNi
+    MmQxZDEwZTI2ZjkxOTMzYjViOWI4YmMzOTczZTgwMTcwY2QwZjEzNDIyZDNh
+    MDExMzhhODM0YWExYTNjNmMwZWQ1NWY4NTY3MzdiNzk4YjAyMjk=

data/Gemfile

@@ -1,8 +1,6 @@
 source "http://rubygems.org"
 # Add dependencies required to use your gem here.
-
-gem "chef", ">= 11.6.2"
-gem "natives-catalog", ">= 0.3.4"
+gem "ohai"
 gem "thor"
 
 # Add dependencies to develop your gem here.
@@ -13,5 +11,6 @@ group :development do
   gem "rdoc"
   gem "bundler"
   gem "jeweler"
+  gem "debugger"
   gem "simplecov"
 end

data/Gemfile.lock

@@ -3,34 +3,14 @@ GEM
   specs:
     addressable (2.3.5)
     builder (3.2.2)
-    chef (11.8.0)
-      chef-zero (~> 1.6, >= 1.6.2)
-      diff-lcs (~> 1.2, >= 1.2.4)
-      erubis (~> 2.7)
-      highline (~> 1.6, >= 1.6.9)
-      json (>= 1.4.4, <= 1.7.7)
-      mime-types (~> 1.16)
-      mixlib-authentication (~> 1.3)
-      mixlib-cli (~> 1.3)
-      mixlib-config (~> 2.0)
-      mixlib-log (~> 1.3)
-      mixlib-shellout (~> 1.2)
-      net-ssh (~> 2.6)
-      net-ssh-multi (~> 1.1.0)
-      ohai (~> 6.0)
-      pry (~> 0.9)
-      puma (~> 1.6)
-      rest-client (>= 1.0.4, < 1.7.0)
-      yajl-ruby (~> 1.1)
-    chef-zero (1.7)
-      hashie (~> 2.0)
-      json
-      mixlib-log (~> 1.3)
-      moneta (< 0.7.0)
-      rack
-    coderay (1.0.9)
+    columnize (0.3.6)
+    debugger (1.6.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
     diff-lcs (1.2.4)
-    erubis (2.7.0)
     faraday (0.8.8)
       multipart-post (~> 1.2.0)
     git (1.2.6)
@@ -42,7 +22,7 @@ GEM
       nokogiri (~> 1.5.2)
       oauth2
     hashie (2.0.5)
-    highline (1.6.20)
+    highline (1.6.19)
     httpauth (0.2.0)
     ipaddress (0.8.0)
     jeweler (1.8.8)
@@ -57,25 +37,13 @@ GEM
     json (1.7.7)
     jwt (0.1.8)
       multi_json (>= 1.5)
-    method_source (0.8.2)
-    mime-types (1.25)
-    mixlib-authentication (1.3.0)
-      mixlib-log
     mixlib-cli (1.3.0)
     mixlib-config (2.0.0)
     mixlib-log (1.6.0)
     mixlib-shellout (1.2.0)
-    moneta (0.6.0)
     multi_json (1.8.2)
     multi_xml (0.5.5)
     multipart-post (1.2.0)
-    natives-catalog (0.3.4)
-    net-ssh (2.7.0)
-    net-ssh-gateway (1.2.0)
-      net-ssh (>= 2.6.5)
-    net-ssh-multi (1.1)
-      net-ssh (>= 2.1.4)
-      net-ssh-gateway (>= 0.99.0)
     nokogiri (1.5.10)
     oauth2 (0.9.2)
       faraday (~> 0.8)
@@ -92,31 +60,22 @@ GEM
       mixlib-shellout
       systemu (~> 2.5.2)
       yajl-ruby
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    puma (1.6.3)
-      rack (~> 1.2)
     rack (1.5.2)
     rake (10.1.0)
     rdoc (4.0.1)
       json (~> 1.4)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.6)
+    rspec-core (2.14.5)
     rspec-expectations (2.14.3)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
+    rspec-mocks (2.14.3)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
-    slop (3.4.6)
     systemu (2.5.2)
     thor (0.18.1)
     yajl-ruby (1.1.0)
@@ -127,9 +86,9 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
-  chef (>= 11.6.2)
+  debugger
   jeweler
-  natives-catalog (>= 0.3.4)
+  ohai
   rdoc
   rspec
   simplecov

data/README.md

@@ -1,69 +1,166 @@
-# natives
+# natives-catalog
 
-[![Gem Version](https://badge.fury.io/rb/natives.png)](http://badge.fury.io/rb/natives)
-[![Code Climate](https://codeclimate.com/github/teohm/natives.png)](https://codeclimate.com/github/teohm/natives)
+[![Gem Version](https://badge.fury.io/rb/natives-catalog.png)](http://badge.fury.io/rb/natives-catalog)
+[![Code Climate](https://codeclimate.com/github/teohm/natives-catalog.png)](https://codeclimate.com/github/teohm/natives-catalog)
 
-Installs native library packages required by gems on your machine.
+Maintains a catalog of native library packages required by Ruby gems, and a parser to load catalog files.
 
-It lookups native packages from a [multi-platform  catalog](https://github.com/teohm/natives-catalog/blob/master/catalogs/rubygems.yaml) maintained by [natives-catalog](https://github.com/teohm/natives-catalog) project.
+It can be extended to maintain additional catalogs e.g. for other package dependency manager such as `npm`.
+
+It is currently used by [natives](https://github.com/teohm/natives) gem to install native packages on multiple platforms.
+
+-----
+### Calling for rubygems catalog contributors!
+
+We need your help to populate and maintain the [rubygems catalog](https://github.com/teohm/natives-catalog/blob/master/catalogs/rubygems.yaml)! :-)
+
+-----
 
 ## Install
 
 ```
-gem install natives
+gem install natives-catalog
 ```
 
 ## Use
+
 ```
-natives install curb capybara-webkit nokogiri sqlite3
+require 'natives/catalog'
+
+catalog = Natives::Catalog.new(
+  'rubygems',
+  'mac_os_x', '10.7.5',
+  'homebrew')
+
+catalog.to_hash  # returns the loaded catalog hash
+
+catalog.reload   # reloads catalog files
+
+catalog.native_packages_for('webcapybara', 'sqlite3')
+# => ["qt", "sqlite"]
 ```
-It will lookup and install native packages (e.g. curl, qt, sqlite) required by the following gems: curb, capybara-webkit, nokogiri, sqlite3.
 
 
-### Have a Gemfile?
-If your working directory has a Gemfile, `natives install` will automatically use gems specified in the Gemfile.
+## Catalog
+
+### Supported catalogs
+
+* **[rubygems](https://github.com/teohm/natives-catalog/blob/master/catalogs/rubygems.yaml) (calling for your PR contributions!)**
+* (new catalog contributors e.g. for `npm` are welcomed :-)
+
+### Catalog load paths
+
+It loads YAML files (.yaml, .yml) from the following paths in this order:
+
+1. `catalogs/` in this gem.
+2. `natives-catalogs/` in current working directory, if any.
 
+When there are several YAML files in a path, they are **sorted by filename** and loaded in the same order.
+
+### Catalog file format
+
+A catalog file is written in YAML, based on this format:
+
+```
+catalog_name:
+  entry_name:
+    platform/package_provider:
+      version:
+        - package_name
 ```
-natives install
-natives  # run 'install' task by default
 
-natives install --gemfile=Gemfile.special
-natives install --gemfile=path/to/Gemfile.special
+For example,
+
+```
+rubygems:
+  capybara-webkit:
+    mac_os_x/homebrew:
+      10.7.5:
+        - libqtwebkit-dev
 ```
 
-### Switch catalog
+#### Use `default` when apply to all platforms
 
 ```
-natives install --catalog npm sqlite3
+rubygems:
+  curb:
+    default:
+      - curl
 ```
-By default, it uses `rubygems` catalog, but it's easy to tell `natives` to use another catalog.
 
-### Misc
+#### Use `default` when apply to all versions
 
 ```
-natives install --test-run  # run without installing native packages
-natives install --update-provider  # update homebrew/apt-get repo first
-natives help
+rubygems:
+  capybara-webkit:
+    mac_os_x/homebrew:
+      default:
+        - libqtwebkit-dev
 ```
 
-## Catalogs
+#### Use array to group platforms
 
-### System-wide
+```
+rubygems:
+  capybara-webkit:
+    [ubuntu/apt, debian/apt]:
+      default:
+        - libqtwebkit-dev
+```
+
+#### Use array to group versions
 
-By default, it uses [the catalog](https://github.com/teohm/natives-catalog/blob/master/catalogs/rubygems.yaml) shipped with [natives-catalog](https://github.com/teohm/natives-catalog) gem.
 
-To update the catalogs:
 
 ```
-gem update natives-catalog
+rubygems:
+  capybara-webkit:
+    ubuntu/apt:
+      [10.04, 10.04.1, 10.04.2, 10.04.3, 10.04.4]:
+        - libqt4-dev
+      default:
+        - libqtwebkit-dev
 ```
 
-### Project-specific
 
-It also looks for a `natives-catalog/` directory in current working directory, and loads any YAML catalog files in the directory.
+#### Supported values for platform/package_provider
+
+The values are limited to the platforms and package providers [supported by Chef](https://github.com/opscode/chef/blob/master/lib/chef/platform/provider_mapping.rb), so that Chef can be used to perform the package installation (see [natives](https://github.com/teohm/natives) gem).
+
+```
+aix/aix
+amazon/yum
+arch/pacman
+centos/yum
+debian/apt
+fedora/yum
+freebsd/freebsd
+gcel/apt
+gentoo/portage
+linaro/apt
+linuxmint/apt
+mac_os_x/homebrew
+mac_os_x/macports
+mac_os_x_server/macports
+nexentacore/solaris
+omnios/ips
+openindiana/ips
+opensolaris/ips
+opensuse/zypper
+oracle/yum
+raspbian/apt
+redhat/yum
+scientific/yum
+smartos/smartos
+solaris2/ips
+suse/zypper
+ubuntu/apt
+xcp/yum
+xenserver/yum
+```
 
 
-## Contributing to natives
+## Contributing to natives-catalog
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "natives"
   gem.homepage = "http://github.com/teohm/natives"
   gem.license = "MIT"
-  gem.summary = %Q{Installs native library packages required by Ruby gems on your machine.}
-  gem.description = %Q{Installs native library packages required by Ruby gems on different platforms, based on the catalog maintained by natives-catalog project.}
+  gem.summary = %Q{Lookup native packages required by gems.}
+  gem.description = %Q{Lookup native package dependencies required by gems.}
   gem.email = "teohuiming@gmail.com"
   gem.authors = ["Huiming Teo"]
   # dependencies defined in Gemfile
@@ -31,9 +31,8 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+RSpec::Core::RakeTask.new(:coverage) do |spec|
+  ENV['COVERAGE'] = 'true'
 end
 
 task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.5.0

data/bin/natives

@@ -6,3 +6,4 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'natives/cli'
 
 Natives::Cli.start
+

data/catalogs/rubygems.yaml

@@ -0,0 +1,50 @@
+rubygems:
+  capybara-webkit:
+    mac_os_x/macports:
+      default:
+        - qt4-mac-devel
+    mac_os_x/homebrew:
+      default:
+        - qt
+    ubuntu/apt:
+      default:
+        - libqtwebkit-dev
+  curb:
+    ubuntu/apt:
+      default:
+        - libcurl4-openssl-dev
+  nokogiri:
+    ubuntu/apt:
+      default:
+        - libxslt-dev
+        - libxml2-dev
+  pg:
+    mac_os_x/homebrew:
+      default:
+        - postgres
+    ubuntu/apt:
+      default:
+        - libpq-dev
+  rmagick:
+    mac_os_x/homebrew:
+      default:
+        - imagemagick
+    ubuntu/apt:
+      default:
+        - imagemagick
+        - libmagickwand-dev
+  tesseract-ocr:
+    mac_os_x/homebrew:
+      default:
+        - tesseract
+    ubuntu/apt:
+      default:
+        - libtesseract-dev
+        - libleptonica-dev
+  sqlite3:
+    ubuntu/apt:
+      default:
+        - libsqlite3-dev
+    fedora/yum:
+      default:
+        - sqlite-devel

data/lib/natives/apps/detect.rb

@@ -0,0 +1,21 @@
+require 'natives/host_detection'
+
+module Natives
+  module Apps
+    class Detect
+
+      def detection_info
+        host = new_host_detection
+        return [
+          "platform: #{host.platform}",
+          "platform_version: #{host.platform_version}",
+          "package_provider: #{host.package_provider}",
+        ].join("\n")
+      end
+
+      def new_host_detection
+        HostDetection.new
+      end
+    end
+  end
+end

data/lib/natives/apps/list.rb

@@ -0,0 +1,39 @@
+require 'natives/host_detection'
+require 'natives/catalog'
+require 'natives/gemfile_viewer'
+
+module Natives
+  module Apps
+    class List
+
+      def natives_for(catalog_name, entry_names)
+        host = new_host_detection
+        catalog = new_catalog(catalog_name,
+                              host.platform, host.platform_version,
+                              host.package_provider)
+        catalog.native_packages_for(entry_names)
+      end
+
+      def natives_for_gemfile(gemfile_path)
+        host = new_host_detection
+        gem_names = new_gemfile_viewer(gemfile_path).gem_names
+        catalog = new_catalog('rubygems',
+                              host.platform, host.platform_version,
+                              host.package_provider)
+        catalog.native_packages_for(gem_names)
+      end
+
+      def new_gemfile_viewer(gemfile_path)
+        GemfileViewer.new(gemfile_path)
+      end
+
+      def new_catalog(catalog_name, platform, platform_version, package_provider)
+        Catalog.new(catalog_name, platform, platform_version, package_provider)
+      end
+
+      def new_host_detection
+        HostDetection.new
+      end
+    end
+  end
+end

data/lib/natives/apps.rb

@@ -0,0 +1,2 @@
+require 'natives/apps/list'
+require 'natives/apps/detect'

data/lib/natives/catalog/loader.rb

@@ -0,0 +1,30 @@
+require 'natives/catalog/merger'
+require 'yaml'
+
+module Natives
+  class Catalog
+    class Loader
+      def initialize(opts={})
+        @merger = opts.fetch(:merger, Merger.new)
+      end
+
+      def load_from_paths(paths)
+        master_hash = {}
+        Array(paths).each do |path|
+          yaml_files_in_path(path).sort.each do |file|
+            @merger.merge_catalog!(master_hash, load_yaml_file(file))
+          end
+        end
+        master_hash
+      end
+
+      def yaml_files_in_path(path)
+        Dir.glob(File.join(path, '*.{yml,yaml}'))
+      end
+
+      def load_yaml_file(filename)
+        YAML.load_file(filename)
+      end
+    end
+  end
+end

data/lib/natives/catalog/merger.rb

@@ -0,0 +1,26 @@
+require 'natives/catalog/validator'
+
+module Natives
+  class Catalog
+    class Merger
+      def initialize(opts={})
+        @validator = opts.fetch(:validator, Validator.new)
+      end
+
+      def merge_catalog!(master_hash, hash_to_merge)
+        @validator.ensure_valid_catalog_groups(master_hash)
+        @validator.ensure_valid_catalog_groups(hash_to_merge)
+
+        hash_to_merge.each do |group_name, entries|
+          if master_hash.key? group_name
+            master_hash[group_name].merge! entries
+          else
+            master_hash[group_name] = entries
+          end
+        end
+
+        master_hash
+      end
+    end
+  end
+end

data/lib/natives/catalog/selector.rb

@@ -0,0 +1,79 @@
+module Natives
+  class Catalog
+    class Selector
+      def initialize(platform_hash)
+        assert_valid_platform_hash(platform_hash)
+        @values = normalize_platform_hash(platform_hash)
+      end
+
+      def value_for(platform, platform_version, package_provider)
+        key = "#{platform.to_s}/#{package_provider.to_s}"
+        if @values.key?(key) && @values[key].key?(platform_version)
+          @values[key][platform_version]
+        elsif @values.key?(key) && @values[key].key?('default')
+          @values[key]['default']
+        elsif @values.key?('default')
+          @values['default']
+        else
+          nil
+        end
+      end
+
+      protected
+
+      def normalize_platform_hash(platform_hash)
+        normalized_hash = {}
+        platform_hash.each do |keys, value|
+          if keys.to_s == 'default'
+            normalized_hash['default'] = value
+          else
+            Array(keys).each do |key|
+              normalized_hash[key.to_s] = normalize_keys(value)
+            end
+          end
+        end
+        normalized_hash
+      end
+
+      def normalize_keys(hash)
+        normalized_hash = {}
+        hash.each do |keys, value|
+          Array(keys).each do |key|
+            normalized_hash[key.to_s] = value
+          end
+        end
+        normalized_hash
+      end
+
+      def assert_valid_platform_hash(platform_hash)
+        unless platform_hash.kind_of? Hash
+          raise ArgumentError, 'catalog entry should be a hash'
+        end
+
+        platform_hash.each do |platforms, value|
+          assert_valid_key_and_value(platforms, value)
+        end
+      end
+
+      def assert_valid_key_and_value(platforms, value)
+        return if platforms.to_s == 'default'
+
+        keys = platforms.kind_of?(Array) ? platforms : [platforms]
+        keys.each do |key|
+          if (%r{\A.+/.+\Z} =~ key.to_s) == nil && key.to_s != 'default'
+            msg = "Found an invalid key: #{key.inspect}. "
+            msg << "A valid key should be in this format: 'platform/package_provider'."
+            raise ArgumentError, msg
+          end
+        end
+
+        unless value.kind_of? Hash
+          msg = "Found an invalid value: #{value.inspect} "
+          msg << "for key: #{platforms.inspect}. The value should be a Hash."
+          raise ArgumentError, msg
+        end
+      end
+
+    end
+  end
+end

data/lib/natives/catalog/validator.rb

@@ -0,0 +1,18 @@
+module Natives
+  class Catalog
+    class Validator
+      def ensure_valid_catalog_groups(hash)
+        unless hash.kind_of? Hash
+          raise ArgumentError, 'catalog should be a Hash'
+        end
+
+        invalid_groups = hash.select {|key, value| !value.kind_of?(Hash) }
+        unless invalid_groups.empty?
+          group_names = invalid_groups.keys
+          raise ArgumentError,
+            "The following catalog group(s) should be a Hash: #{group_names.join(', ')}"
+        end
+      end
+    end
+  end
+end