ruby-augeas 0.4.1 → 0.5.0

data/NEWS

@@ -1,3 +1,22 @@
+0.5.0 - 2013-03-XX
+  - add libxml2 headers and library to Makefile
+  - add libxml2-devel build req to rpm spec
+  - split out header, add memstream utils from Augeas
+  - integrate with Travis CI
+  - Takefile: add gem authors metadata
+  - Augeas::transform: add .lns suffix if a module name is passed
+    to match aug_transform behaviour
+  - add Augeas::clearm
+  - add Augeas::context and Augeas::context=
+  - add Augeas::label
+  - add Augeas::rename
+  - add Augeas::srun
+  - add Augeas::text_retrieve
+  - add Augeas::text_store
+
+0.4.1 - 2011-03-29
+  - remove object files from release tarball
+
 0.4.0 - 2011-03-25
   - set can now set multiple elements at once
   - expose aug_setm as Augeas#setm
@@ -15,4 +34,4 @@
 
 0.2.0 - 2008-08-26
   Details for this and earlier releases need to be extracted from the
-  history of the git repo
+  history of the git repo

data/Rakefile

@@ -9,13 +9,13 @@
 # Bryan Kearney <bkearney@redhat.com>
 
 require 'rake/clean'
-require 'rake/rdoctask'
+require 'rdoc/task'
 require 'rake/testtask'
-require 'rake/gempackagetask'
+require 'rubygems/package_task'
 
 PKG_NAME='ruby-augeas'
 GEM_NAME=PKG_NAME # we'd like 'augeas' but that makes RPM fail
-PKG_VERSION='0.4.1'
+PKG_VERSION='0.5.0'
 EXT_CONF='ext/augeas/extconf.rb'
 MAKEFILE="ext/augeas/Makefile"
 AUGEAS_MODULE="ext/augeas/_augeas.so"
@@ -65,7 +65,7 @@ task :test => :build
 #
 # Generate the documentation
 #
-Rake::RDocTask.new do |rd|
+RDoc::Task.new do |rd|
     rd.main = "README.rdoc"
     rd.rdoc_dir = "doc/site/api"
     rd.rdoc_files.include("README.rdoc", "ext/**/*.[ch]","lib/**/*.rb")
@@ -91,6 +91,7 @@ SPEC = Gem::Specification.new do |s|
     s.email = "augeas-devel@redhat.com"
     s.homepage = "http://augeas.net/"
     s.summary = "Ruby bindings for augeas"
+    s.authors = [ "Bryan Kearney", "David Lutterkort" ]
     s.files = PKG_FILES
     s.autorequire = "augeas"
     s.required_ruby_version = '>= 1.8.1'
@@ -98,7 +99,7 @@ SPEC = Gem::Specification.new do |s|
     s.description = "Provides bindings for augeas."
 end
 
-Rake::GemPackageTask.new(SPEC) do |pkg|
+Gem::PackageTask.new(SPEC) do |pkg|
     pkg.need_tar = true
     pkg.need_zip = true
 end
@@ -130,3 +131,5 @@ end
 task :sync do |t|
     system "rsync -rav doc/site/ et:/var/www/sites/augeas.et.redhat.com/docs/ruby/"
 end
+
+task :default => [:build, :test]

data/ext/augeas/_augeas.c

@@ -1,7 +1,7 @@
 /*
  * augeas.c: Ruby bindings for augeas
  *
- * Copyright (C) 2008 Red Hat Inc.
+ * Copyright (C) 2008-2011 Red Hat Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -19,14 +19,13 @@
  *
  * Author: Bryan Kearney <bkearney@redhat.com>
  */
+#include "_augeas.h"
+
 #include <ruby.h>
 #include <augeas.h>
 
 static VALUE c_augeas;
 
-#define StringValueCStrOrNull(v)                \
-    NIL_P(v) ? NULL : StringValueCStr(v)
-
 static augeas *aug_handle(VALUE s) {
     augeas *aug;
 
@@ -383,6 +382,109 @@ VALUE augeas_span(VALUE s, VALUE path) {
     return result;
 }
 
+/*
+ * call-seq:
+ *   srun(COMMANDS) -> [int, String]
+ *
+ * Run one or more newline-separated commands, returning their output.
+ *
+ * Returns:
+ * an array where the first element is the number of executed commands on
+ * success, -1 on failure, and -2 if a 'quit' command was encountered.
+ * The second element is a string of the output from all commands.
+ */
+VALUE augeas_srun(VALUE s, VALUE text) {
+    augeas *aug = aug_handle(s);
+    const char *ctext = StringValueCStr(text);
+
+    struct memstream ms;
+    __aug_init_memstream(&ms);
+
+    int r = aug_srun(aug, ms.stream, ctext);
+    __aug_close_memstream(&ms);
+
+    VALUE result = rb_ary_new();
+    rb_ary_push(result, INT2NUM(r));
+    rb_ary_push(result, rb_str_new2(ms.buf));
+
+    free(ms.buf);
+    return result;
+}
+
+/*
+ * call-seq:
+ *   label(PATH) -> String
+ *
+ * Lookup the label associated with PATH
+ */
+VALUE augeas_label(VALUE s, VALUE path) {
+    augeas *aug = aug_handle(s);
+    const char *cpath = StringValueCStr(path);
+    const char *label;
+
+    aug_label(aug, cpath, &label);
+    if (label != NULL) {
+        return rb_str_new(label, strlen(label)) ;
+    } else {
+        return Qnil;
+    }
+}
+
+/*
+ * call-seq:
+ *   rename(SRC, LABEL) -> int
+ *
+ * Rename the label of all nodes matching SRC to LABEL.
+ *
+ * Returns +false+ if +aug_rename+ fails, and the number of nodes renamed
+ * on success.
+ */
+VALUE augeas_rename(VALUE s, VALUE src, VALUE label) {
+    augeas *aug = aug_handle(s);
+    const char *csrc = StringValueCStr(src);
+    const char *clabel = StringValueCStr(label);
+    int r = aug_rename(aug, csrc, clabel);
+
+    return (r < 0) ? Qfalse : INT2NUM(r);
+}
+
+/*
+ * call-seq:
+ *   text_store(LENS, NODE, PATH) -> boolean
+ *
+ * Use the value of node NODE as a string and transform it into a tree
+ * using the lens LENS and store it in the tree at PATH, which will be
+ * overwritten. PATH and NODE are path expressions.
+ */
+VALUE augeas_text_store(VALUE s, VALUE lens, VALUE node, VALUE path) {
+    augeas *aug = aug_handle(s);
+    const char *clens = StringValueCStr(lens);
+    const char *cnode = StringValueCStr(node);
+    const char *cpath = StringValueCStr(path);
+    int r = aug_text_store(aug, clens, cnode, cpath);
+
+    return (r < 0) ? Qfalse : Qtrue;
+}
+
+/*
+ * call-seq:
+ *   text_retrieve(LENS, NODE_IN, PATH, NODE_OUT) -> boolean
+ *
+ * Transform the tree at PATH into a string using lens LENS and store it in
+ * the node NODE_OUT, assuming the tree was initially generated using the
+ * value of node NODE_IN. PATH, NODE_IN, and NODE_OUT are path expressions.
+ */
+VALUE augeas_text_retrieve(VALUE s, VALUE lens, VALUE node_in, VALUE path, VALUE node_out) {
+    augeas *aug = aug_handle(s);
+    const char *clens = StringValueCStr(lens);
+    const char *cnode_in = StringValueCStr(node_in);
+    const char *cpath = StringValueCStr(path);
+    const char *cnode_out = StringValueCStr(node_out);
+    int r = aug_text_retrieve(aug, clens, cnode_in, cpath, cnode_out);
+
+    return (r < 0) ? Qfalse : Qtrue;
+}
+
 void Init__augeas() {
 
     /* Define the ruby class */
@@ -414,6 +516,8 @@ void Init__augeas() {
     DEF_AUG_ERR(ESYNTAX);
     DEF_AUG_ERR(ENOLENS);
     DEF_AUG_ERR(EMXFM);
+    DEF_AUG_ERR(ENOSPAN);
+    DEF_AUG_ERR(ECMDRUN);
 #undef DEF_AUG_ERR
 
     /* Define the methods */
@@ -433,6 +537,11 @@ void Init__augeas() {
     rb_define_method(c_augeas, "close", augeas_close, 0);
     rb_define_method(c_augeas, "error", augeas_error, 0);
     rb_define_method(c_augeas, "span", augeas_span, 1);
+    rb_define_method(c_augeas, "srun", augeas_srun, 1);
+    rb_define_method(c_augeas, "label", augeas_label, 1);
+    rb_define_method(c_augeas, "rename", augeas_rename, 2);
+    rb_define_method(c_augeas, "text_store", augeas_text_store, 3);
+    rb_define_method(c_augeas, "text_retrieve", augeas_text_retrieve, 4);
 }
 
 /*

data/ext/augeas/_augeas.h

@@ -0,0 +1,48 @@
+/*
+ * augeas.h: internal headers for Augeas Ruby bindings
+ *
+ * Copyright (C) 2008-2011 Red Hat Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
+ */
+
+#include <ruby.h>
+
+#ifndef _AUGEAS_H_
+#define _AUGEAS_H_
+
+#define StringValueCStrOrNull(v)                \
+    NIL_P(v) ? NULL : StringValueCStr(v)
+
+/* memstream support from Augeas internal.h */
+struct memstream {
+    FILE   *stream;
+    char   *buf;
+    size_t size;
+};
+
+int __aug_init_memstream(struct memstream *ms);
+int __aug_close_memstream(struct memstream *ms);
+
+#endif
+
+/*
+ * Local variables:
+ *  indent-tabs-mode: nil
+ *  c-indent-level: 4
+ *  c-basic-offset: 4
+ *  tab-width: 4
+ * End:
+ */

data/ext/augeas/extconf.rb

@@ -27,4 +27,8 @@ unless pkg_config("augeas")
     raise "augeas-devel not installed"
 end
 
+unless pkg_config("libxml-2.0")
+    raise "libxml2-devel not installed"
+end
+
 create_makefile(extension_name)

data/lib/augeas.rb

@@ -77,6 +77,18 @@ class Augeas
         set_internal(path, nil)
     end
 
+    # Clear multiple nodes values in one operation. Find or create a node matching +sub+
+    # by interpreting +sub+ as a path expression relative to each node matching
+    # +base+. If +sub+ is '.', the nodes matching +base+ will be modified.
+    def clearm(base, sub)
+        setm(base, sub, nil)
+    end
+
+    # Create the +path+ with empty value if it doesn't exist
+    def touch(path)
+        set_internal(path, nil) if match(path).empty?
+    end
+
     # Clear all transforms under <tt>/augeas/load</tt>. If +load+
     # is called right after this, there will be no files
     # under +/files+
@@ -98,6 +110,7 @@ class Augeas
         excl = hash[:excl]
         raise ArgumentError, "No lens specified" unless lens
         raise ArgumentError, "No files to include" unless incl
+        lens = "#{lens}.lns" unless lens.include? '.'
         name = lens.split(".")[0].sub("@", "") unless name
 
         xfm = "/augeas/load/#{name}/"
@@ -116,4 +129,14 @@ class Augeas
         raise Augeas::Error unless load
     end
 
+    # Set path expression context to +path+ (in /augeas/context)
+    def context=(path)
+      set_internal('/augeas/context', path)
+    end
+
+    # Get path expression context (from /augeas/context)
+    def context
+      get('/augeas/context')
+    end
+
 end

data/tests/tc_augeas.rb

@@ -84,7 +84,7 @@ class TestAugeas < Test::Unit::TestCase
                           :incl => [ "/etc/fstab" ],
                           :excl => [ "*~", "*.rpmnew" ])
         }
-        aug.transform(:lens => "Inittab.lns",
+        aug.transform(:lens => "Inittab",
                       :incl => "/etc/inittab")
         aug.transform(:lens => "Fstab.lns",
                       :incl => "/etc/fstab*",
@@ -195,6 +195,87 @@ class TestAugeas < Test::Unit::TestCase
         assert_equal(29..40, span[:span])
     end
 
+    def test_srun
+        aug = aug_open
+
+        path = "/files/etc/hosts/*[canonical='localhost.localdomain']/ipaddr"
+        r, out = aug.srun("get #{path}\n")
+        assert_equal(1, r)
+        assert_equal("#{path} = 127.0.0.1\n", out)
+
+        assert_equal(0, aug.srun(" ")[0])
+        assert_equal(-1, aug.srun("foo")[0])
+        assert_equal(-1, aug.srun("set")[0])
+        assert_equal(-2, aug.srun("quit")[0])
+    end
+
+    def test_label
+        Augeas::open("/dev/null") do |aug|
+            assert_equal 'augeas', aug.label('/augeas')
+            assert_equal 'files', aug.label('/files')
+        end
+    end
+
+    def test_rename
+        Augeas::open("/dev/null") do |aug|
+            assert_equal false, aug.rename('/files', 'invalid/label')
+            assert_equal 0, aug.rename('/nonexistent', 'label')
+            assert_equal ['/files'], aug.match('/files')
+            assert_equal 1, aug.rename('/files', 'label')
+        end
+    end
+
+    def test_text_store_retrieve
+        Augeas::open("/dev/null") do |aug|
+            # text_store errors
+            assert_equal false, aug.text_store('Simplelines.lns', '/input', '/store')
+
+            # text_store
+            aug.set('/input', "line1\nline2\n")
+            assert aug.text_store('Simplelines.lns', '/input', '/store')
+            assert_equal 'line2', aug.get('/store/2')
+
+            # text_retrieve errors
+            assert_equal false, aug.text_retrieve('Simplelines.lns', '/unknown', '/store', '/output')
+
+            # text_retrieve
+            aug.set('/store/3', 'line3')
+            assert aug.text_retrieve('Simplelines.lns', '/input', '/store', '/output')
+            assert_equal "line1\nline2\nline3\n", aug.get('/output')
+        end
+    end
+
+    def test_context
+        Augeas::open("/dev/null") do |aug|
+            aug.context = '/augeas'
+            assert_equal '/augeas', aug.get('/augeas/context')
+            assert_equal '/augeas', aug.get('context')
+            assert_equal '/augeas', aug.context
+        end
+    end
+
+    def test_touch
+        Augeas::open("/dev/null") do |aug|
+            assert_equal [], aug.match('/foo')
+            aug.touch '/foo'
+            assert_equal ['/foo'], aug.match('/foo')
+
+            aug.set '/foo', 'bar'
+            aug.touch '/foo'
+            assert_equal 'bar', aug.get('/foo')
+        end
+    end
+
+    def test_clearm
+        Augeas::open("/dev/null") do |aug|
+            aug.set('/foo/a', '1')
+            aug.set('/foo/b', '2')
+            aug.clearm('/foo', '*')
+            assert_nil aug.get('/foo/a')
+            assert_nil aug.get('/foo/b')
+        end
+    end
+
     private
     def aug_open(flags = Augeas::NONE)
         if File::directory?(TST_ROOT)

metadata

@@ -1,80 +1,59 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby-augeas
-version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
 platform: ruby
-authors: []
-
+authors:
+- Bryan Kearney
+- David Lutterkort
 autorequire: augeas
 bindir: bin
 cert_chain: []
-
-date: 2011-03-29 00:00:00 -07:00
-default_executable: 
+date: 2013-03-12 00:00:00.000000000 Z
 dependencies: []
-
 description: Provides bindings for augeas.
 email: augeas-devel@redhat.com
 executables: []
-
-extensions: 
+extensions:
 - ext/augeas/extconf.rb
 extra_rdoc_files: []
-
-files: 
+files:
 - Rakefile
 - COPYING
 - README.rdoc
 - NEWS
 - ext/augeas/_augeas.c
+- ext/augeas/_augeas.h
 - lib/augeas.rb
 - ext/augeas/extconf.rb
-- tests/tc_augeas.rb
-- tests/root/etc/hosts
 - tests/root/etc/group
+- tests/root/etc/hosts
 - tests/root/etc/inittab
 - tests/root/etc/ssh/sshd_config
-has_rdoc: true
+- tests/tc_augeas.rb
 homepage: http://augeas.net/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 53
-      segments: 
-      - 1
-      - 8
-      - 1
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.1
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby bindings for augeas
 test_files: []
-