natives-catalog 0.3.2 → 0.3.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    M2JjMGU4NDZiNjk3MWY5ZTc3OTFlMGZmMjVmZDkzN2MwOWZkNjNkYg==
+    YmQwNTEwNTQwNTg4MGFkNDRkNTk2N2FkMDBmOWVhZjMwODUxMzU4Ng==
   data.tar.gz: !binary |-
-    ZWMyMWUyZTc4OTY0Y2JhZDI0NWFjZGM3MGU3ZjMyMjVmNTM2MGZkNg==
+    N2U5OGFjMGY0M2VjNmIxMWI1OWZiN2UxY2EyZDVhNWU0MDU0Njg4Zg==
 SHA512:
   metadata.gz: !binary |-
-    ZWRlODA4MzM3ZTI5MjY0NDkxNmQwYTVmMGFjYjFlN2I5ZTc2ODBlOTJhNzFk
-    MWZiZTJjMWVjNjk3MzY5ZGYxZTY3MTZiY2Q3MjU3ZDQ3M2ExNTVkYTNkZTE4
-    ZTQ4ZWMyMzc0NDAyYTRhZjkyMDJhNDkxOWZlZmMwNTE3NDZjNTU=
+    YjZiYzg0YWI1NTkxZGI3MWRjYjZjM2NjNWIxNTFhYzIxMDM3MDkxZTIxZDQ5
+    ZjI0MzdhODg1ZTI1ZDgyYTdjYjBmNjZiZDcyMDM0MzFiMjkxNjZlZDlkNWFh
+    MzI4OTQ0ZTYwMDg3ZDgxMWJjN2Y0ZTY5ODllOGZlOTBhMzc4YjI=
   data.tar.gz: !binary |-
-    YzkyOTZiYzAwYTk0NmU3YmNlZDc1ZDZmNjQ0MjNmNjFjOGE2MThlZWNhNjFh
-    OGQ4MjcxOTgxODU2NTcyMzgwMGQ3MzdiZTQ3OTQ3ZThjMmRhZDBhNGY5MDcx
-    NjkxYmUwZjMxZTEzZjg4ZWQzNmUyZjQ1ODkyZmJiYTk5NzFhMmI=
+    MGVkZmNlNWRiNTBiNDBiZGYyNTczZDkzMmZjOWM4ZTU2NzI1MWZjOGY4M2Ew
+    M2U5Yjk0YzZmOWQ5Y2IzZDQxMzg4ZjMwOWQwMmE5ZTA2OTk3MDM0MjE1OTI5
+    ZGNiY2I1ZmIzYTcwYzkxNzE4YzVkNjVmNjliOWU4NzQyYWJkZmY=

data/README.md

@@ -1,6 +1,158 @@
 # natives-catalog
 
-Description goes here.
+Maintains a catalog of native library packages required by Ruby gems, and a parser to load catalog files.
+
+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 ruby gems catalog contributors!
+
+Your pull requests are welcomed to maintain the [rubygems catalog](https://github.com/teohm/natives-catalog/blob/master/catalogs/rubygems.yaml) and keep it up-to-date! 
+
+## Install
+
+```
+gem install natives-catalog
+```
+
+## Use
+
+```
+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"]
+```
+
+
+## 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
+```
+
+For example,
+
+```
+rubygems:
+  capybara-webkit:
+    mac_os_x/homebrew:
+      10.7.5:
+        - libqtwebkit-dev
+```
+
+#### Use `default` when apply to all platforms
+
+```
+rubygems:
+  curb:
+    default:
+      - curl
+```
+
+#### Use `default` when apply to all versions
+
+```
+rubygems:
+  capybara-webkit:
+    mac_os_x/homebrew:
+      default:
+        - libqtwebkit-dev
+```
+
+#### Use array to group platforms
+
+```
+rubygems:
+  capybara-webkit:
+    [ubuntu/apt, debian/apt]:
+      default:
+        - libqtwebkit-dev
+```
+
+#### Use array to group versions
+
+
+
+```
+rubygems:
+  capybara-webkit:
+    ubuntu/apt:
+      [10.04, 10.04.1, 10.04.2, 10.04.3, 10.04.4]:
+        - libqt4-dev
+      default:
+        - libqtwebkit-dev
+```
+
+
+#### 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-catalog
 

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.3.3

data/lib/natives-catalog.rb

@@ -0,0 +1 @@
+require 'natives/catalog'

data/natives-catalog.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: natives-catalog 0.3.2 ruby lib
+# stub: natives-catalog 0.3.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "natives-catalog"
-  s.version = "0.3.2"
+  s.version = "0.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Huiming Teo"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: natives-catalog
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Huiming Teo