[paludis-commits] r4070 - in trunk: . doc/api doc/api/ruby

[rbrown at svn.pioto.org]

Author: rbrown
Date: 2007-12-12 23:45:53 +0000 (Wed, 12 Dec 2007)
New Revision: 4070

Added:
   trunk/doc/api/ruby/example_package_id.rb
Modified:
   trunk/ChangeLog
   trunk/doc/api/index.html.part
Log:
(ruby) Add PackageID example.


Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2007-12-12 22:38:48 UTC (rev 4069)
+++ trunk/ChangeLog	2007-12-12 23:45:53 UTC (rev 4070)
@@ -7,6 +7,10 @@
 
 2007-12-12 Richard Brown
 
+	* doc/api/ruby/, ruby/: (ruby) Add PackageID example.
+
+2007-12-12 Richard Brown
+
 	* doc/api/ruby/, ruby/: (ruby) Add missing files.
 
 2007-12-12 Richard Brown

Modified: trunk/doc/api/index.html.part
===================================================================
--- trunk/doc/api/index.html.part	2007-12-12 22:38:48 UTC (rev 4069)
+++ trunk/doc/api/index.html.part	2007-12-12 23:45:53 UTC (rev 4070)
@@ -158,8 +158,8 @@
     <tr>
         <td>example_package_id</td>
         <td><a href="cplusplus/example__package__id_8cc-example.html">C++</a></td>
+        <td><a href="ruby/example_package_id.html">Ruby</a></td>
         <td></td>
-        <td></td>
         <td>How to use PackageID</td>
     </tr>
     <tr>

Added: trunk/doc/api/ruby/example_package_id.rb
===================================================================
--- trunk/doc/api/ruby/example_package_id.rb	                        (rev 0)
+++ trunk/doc/api/ruby/example_package_id.rb	2007-12-12 23:45:53 UTC (rev 4070)
@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+# vim: set sw=4 sts=4 et tw=100 :
+
+=begin description
+This example demonstrates how to use PackageID.
+
+See "example_action.rb" for more on actions. See "example_metadata_key.rb" for more on 
+metadata keys. See "example_mask.rb" for more on masks.
+=end
+
+require 'Paludis'
+require 'example_command_line'
+
+include Paludis
+
+exit_status = 0
+
+# We start with an Environment, respecting the user's '--environment' choice.
+env = EnvironmentMaker.instance.make_from_spec(ExampleCommandLine.instance.environment)
+
+# Fetch package IDs for installed 'sys-apps/paludis'
+ids = env.package_database.query(
+    Query::Matches.new(Paludis::parse_user_package_dep_spec("sys-apps/paludis", [])),
+    QueryOrder::OrderByVersion)
+
+# For each ID:
+ids.each do | id |
+    puts "#{id}:"
+
+    # Start by outputting some basic properties:
+    puts "    Name: ".ljust(40) + id.name
+    puts "    Version: ".ljust(40) + id.version.to_s
+    puts "    Slot: ".ljust(40) + id.slot
+    puts "    Repository: ".ljust(40) + id.repository_name
+
+    # The PackageID.canonical_form method should be used when
+    # outputting a package
+    puts "    PackageIDCanonicalForm::Full: ".ljust(40) + id.canonical_form(PackageIDCanonicalForm::Full)
+    puts "    PackageIDCanonicalForm::Version: ".ljust(40) + id.canonical_form(PackageIDCanonicalForm::Version)
+    puts "    PackageIDCanonicalForm::NoVersion: ".ljust(40) + id.canonical_form(PackageIDCanonicalForm::NoVersion)
+
+    # Let's see what keys we have. Other examples cover keys in depth,
+    # so we'll just use the basic methods here.
+    puts "    Keys: ".ljust(40)
+    id.each_metadata do |key|
+        puts "        #{key.raw_name}: ".ljust(40) + key.human_name
+    end
+
+    # And what about masks? Again, these are covered in depth
+    # elsewhere.
+    if id.masked?
+        puts "    Masks: ".ljust(40)
+        id.masks.each do |mask|
+            puts "        #{mask.key}: ".ljust(40) + mask.description
+        end
+    end
+
+    # Let's see which actions we support. There's no particularly nice
+    # way of doing this, since it's not something we'd expect to be
+    # doing.
+    actions = []
+    actions << "install" if id.supports_action(SupportsInstallActionTest.new)
+    actions << "installed" if id.supports_action(SupportsInstalledActionTest.new)
+    actions << "uninstall" if id.supports_action(SupportsUninstallActionTest.new)
+    actions << "pretend" if id.supports_action(SupportsPretendActionTest.new)
+    actions << "config" if id.supports_action(SupportsConfigActionTest.new)
+    actions << "fetch" if id.supports_action(SupportsFetchActionTest.new)
+    actions << "info" if id.supports_action(SupportsInfoActionTest.new)
+
+    puts "    Actions: ".ljust(40) + actions.join(' ')
+
+    # And various misc methods. Clients don't usually use these
+    # directly.
+    puts "    breaks_portage?: ".ljust(40) + id.breaks_portage?.to_s
+
+    puts
+end
+
+exit exit_status
+