ruby-augeas 0.4.1 → 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 516d7f0b53e2ef92757c400168ab4fd4ac8f1fe121ba3378f89293d181d1a8ad
+  data.tar.gz: 7e2511ae0787aa55a441a311218caf78fe954e02f863b73cc00a6f2419834cb0
+SHA512:
+  metadata.gz: a390e7d3add28bfdc4624ebcb6b6e4887b8f613751c1507fb30f72ce2b04e36e5c2b33a51712c72a0200c9218528ab9bb02b5d15761116a8e6375d7e7d8afe01
+  data.tar.gz: c7700610c5447a52673685a4a414fb2cef0ea3bc6214a8e9ac751812e23cdd39088b80bbc62765ade52a48d7cc7aece836dcc6a9412cd3e5f8542ed9b5d8663f

data/COPYING

@@ -1,9 +1,8 @@
-
                   GNU LESSER GENERAL PUBLIC LICENSE
                        Version 2.1, February 1999
 
  Copyright (C) 1991, 1999 Free Software Foundation, Inc.
-     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -23,8 +22,7 @@ specially designated software packages--typically libraries--of the
 Free Software Foundation and other authors who decide to use it.  You
 can use it too, but we suggest you first think carefully about whether
 this license or the ordinary General Public License is the better
-strategy to use in any particular case, based on the explanations
-below.
+strategy to use in any particular case, based on the explanations below.
 
   When we speak of free software, we are referring to freedom of use,
 not price.  Our General Public Licenses are designed to make sure that
@@ -57,7 +55,7 @@ modified by someone else and passed on, the recipients should know
 that what they have is not the original version, so that the original
 author's reputation will not be affected by problems that might be
 introduced by others.
-^L
+
   Finally, software patents pose a constant threat to the existence of
 any free program.  We wish to make sure that a company cannot
 effectively restrict the users of a free program by obtaining a
@@ -89,9 +87,9 @@ libraries.  However, the Lesser license provides advantages in certain
 special circumstances.
 
   For example, on rare occasions, there may be a special need to
-encourage the widest possible use of a certain library, so that it
-becomes a de-facto standard.  To achieve this, non-free programs must
-be allowed to use the library.  A more frequent case is that a free
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard.  To achieve this, non-free programs must be
+allowed to use the library.  A more frequent case is that a free
 library does the same job as widely used non-free libraries.  In this
 case, there is little to gain by limiting the free library to free
 software only, so we use the Lesser General Public License.
@@ -113,7 +111,7 @@ modification follow.  Pay close attention to the difference between a
 "work based on the library" and a "work that uses the library".  The
 former contains code derived from the library, whereas the latter must
 be combined with the library in order to run.
-^L
+
                   GNU LESSER GENERAL PUBLIC LICENSE
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
@@ -138,8 +136,8 @@ included without limitation in the term "modification".)
   "Source code" for a work means the preferred form of the work for
 making modifications to it.  For a library, complete source code means
 all the source code for all modules it contains, plus any associated
-interface definition files, plus the scripts used to control
-compilation and installation of the library.
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
 
   Activities other than copying, distribution and modification are not
 covered by this License; they are outside its scope.  The act of
@@ -218,7 +216,7 @@ instead of to this License.  (If a newer version than version 2 of the
 ordinary GNU General Public License has appeared, then you can specify
 that version instead if you wish.)  Do not make any other change in
 these notices.
-^L
+
   Once this change is made in a given copy, it is irreversible for
 that copy, so the ordinary GNU General Public License applies to all
 subsequent copies and derivative works made from that copy.
@@ -269,7 +267,7 @@ Library will still fall under Section 6.)
 distribute the object code for the work under the terms of Section 6.
 Any executables containing that work also fall under Section 6,
 whether or not they are linked directly with the Library itself.
-^L
+
   6. As an exception to the Sections above, you may also combine or
 link a "work that uses the Library" with the Library to produce a
 work containing portions of the Library, and distribute that work
@@ -305,10 +303,10 @@ of these things:
     the user installs one, as long as the modified version is
     interface-compatible with the version that the work was made with.
 
-    c) Accompany the work with a written offer, valid for at least
-    three years, to give the same user the materials specified in
-    Subsection 6a, above, for a charge no more than the cost of
-    performing this distribution.
+    c) Accompany the work with a written offer, valid for at
+    least three years, to give the same user the materials
+    specified in Subsection 6a, above, for a charge no more
+    than the cost of performing this distribution.
 
     d) If distribution of the work is made by offering access to copy
     from a designated place, offer equivalent access to copy the above
@@ -331,7 +329,7 @@ restrictions of other proprietary libraries that do not normally
 accompany the operating system.  Such a contradiction means you cannot
 use both them and the Library together in an executable that you
 distribute.
-^L
+
   7. You may place library facilities that are a work based on the
 Library side-by-side in a single library together with other library
 facilities not covered by this License, and distribute such a combined
@@ -372,7 +370,7 @@ subject to these terms and conditions.  You may not impose any further
 restrictions on the recipients' exercise of the rights granted herein.
 You are not responsible for enforcing compliance by third parties with
 this License.
-^L
+
   11. If, as a consequence of a court judgment or allegation of patent
 infringement or for any other reason (not limited to patent issues),
 conditions are imposed on you (whether by court order, agreement or
@@ -386,10 +384,9 @@ all those who receive copies directly or indirectly through you, then
 the only way you could satisfy both it and this License would be to
 refrain entirely from distribution of the Library.
 
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply, and the section as a whole is intended to apply in other
-circumstances.
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
 
 It is not the purpose of this section to induce you to infringe any
 patents or other property right claims or to contest validity of any
@@ -407,11 +404,11 @@ be a consequence of the rest of this License.
 
   12. If the distribution and/or use of the Library is restricted in
 certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Library under this License
-may add an explicit geographical distribution limitation excluding those
-countries, so that distribution is permitted only in or among
-countries not thus excluded.  In such case, this License incorporates
-the limitation as if written in the body of this License.
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded.  In such case, this License incorporates the limitation as if
+written in the body of this License.
 
   13. The Free Software Foundation may publish revised and/or new
 versions of the Lesser General Public License from time to time.
@@ -425,7 +422,7 @@ conditions either of that version or of any later version published by
 the Free Software Foundation.  If the Library does not specify a
 license version number, you may choose any version ever published by
 the Free Software Foundation.
-^L
+
   14. If you wish to incorporate parts of the Library into other free
 programs whose distribution conditions are incompatible with these,
 write to the author to ask for permission.  For software which is
@@ -459,21 +456,19 @@ SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
 DAMAGES.
 
                      END OF TERMS AND CONDITIONS
-^L
+
            How to Apply These Terms to Your New Libraries
 
   If you develop a new library, and you want it to be of the greatest
 possible use to the public, we recommend making it free software that
 everyone can redistribute and change.  You can do so by permitting
-redistribution under these terms (or, alternatively, under the terms
-of the ordinary General Public License).
-
-  To apply these terms, attach the following notices to the library.
-It is safest to attach them to the start of each source file to most
-effectively convey the exclusion of warranty; and each file should
-have at least the "copyright" line and a pointer to where the full
-notice is found.
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
 
+  To apply these terms, attach the following notices to the library.  It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
 
     <one line to give the library's name and a brief idea of what it does.>
     Copyright (C) <year>  <name of author>
@@ -490,21 +485,18 @@ notice is found.
 
     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
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 Also add information on how to contact you by electronic and paper mail.
 
-You should also get your employer (if you work as a programmer) or
-your school, if any, to sign a "copyright disclaimer" for the library,
-if necessary.  Here is a sample; alter the names:
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary.  Here is a sample; alter the names:
 
   Yoyodyne, Inc., hereby disclaims all copyright interest in the
-  library `Frob' (a library for tweaking knobs) written by James
-  Random Hacker.
+  library `Frob' (a library for tweaking knobs) written by James Random Hacker.
 
   <signature of Ty Coon>, 1 April 1990
   Ty Coon, President of Vice
 
 That's all there is to it!
-
-

data/NEWS

@@ -1,3 +1,28 @@
+0.6.0 - 2024-08-07
+  - Updated ruby bindings that behave more Ruby-ish
+  - Fix errors and warnings during build process
+  - Minor updates to README.md
+  - Update ruby-augeas.spec from current Fedora 39 spec file
+
+0.5.0 - 2013-03-12
+  - 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 +40,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/README.md

@@ -0,0 +1,86 @@
+![ruby-augeas ci build status](../../actions/workflows/ci.yml/badge.svg)
+
+# Ruby bindings for augeas
+
+The class Augeas provides bindings to [Augeas](https://augeas.net) library.
+
+
+## Building
+
+To build the bindings, which unfortunately includes installing them from a
+gem, you need to have Augeas and its header file installed as well as
+`pkg-config`.
+
+On Fedora, you can do that simply by running
+```
+dnf install augeas-devel pkgconfig
+```
+
+On MacOS (OSX), you need to set up [Homebrew](https://brew.sh/) and then run
+```
+brew install augeas pkg-config
+```
+
+Build the ruby gem by running
+```
+rake build
+rake test
+rake gem
+```
+The output is pkg/ruby-augeas-VERSION.gem
+
+Build the rpm package (optional) in the pkg/ subdirectory
+```
+rake rpm
+```
+The output is pkg/ruby-augeas-VERSION-1.DIST.src.rpm with binary packages in pkg/$(uname -m)
+
+Create html documentation using rdoc
+
+```
+rake rdoc
+```
+
+The output is in doc/site/api/
+The starting document is doc/site/api/index.html
+
+## Usage
+
+### Setting Data
+```ruby
+    Augeas::open do |aug|
+      aug.set("/files/etc/sysconfig/firstboot/RUN_FIRSTBOOT", "YES")
+      unless aug.save
+        raise IOError, "Failed to save changes"
+      end
+    end
+```
+
+### Accessing Data
+```ruby
+    firstboot = Augeas::open { |aug| aug.get("/files/etc/sysconfig/firstboot/RUN_FIRSTBOOT") }
+```
+
+### Removing Data
+```ruby
+    Augeas::open do |aug|
+      aug.rm("/files/etc/sysconfig/firstboot/RUN_FIRSTBOOT")
+      unless aug.save
+        raise IOError, "Failed to save changes"
+      end
+    end
+```
+
+### Minimal Setup with a Custom Root
+
+By passing `NO_MODL_AUTOLOAD`, no files are read on startup; that allows
+setting up a custom transform.
+
+```ruby
+  Augeas::open("/var/tmp/augeas-root", "/usr/local/share/mylenses",
+                Augeas::NO_MODL_AUTOLOAD) do |aug|
+    aug.transform(:lens => "Aliases.lns", :incl => "/etc/aliases")
+    aug.load
+    aug.get("/files/etc/aliases/*[name = 'postmaster']/value")
+  end
+```

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.6.0'
 EXT_CONF='ext/augeas/extconf.rb'
 MAKEFILE="ext/augeas/Makefile"
 AUGEAS_MODULE="ext/augeas/_augeas.so"
@@ -65,17 +65,17 @@ task :test => :build
 #
 # Generate the documentation
 #
-Rake::RDocTask.new do |rd|
-    rd.main = "README.rdoc"
+RDoc::Task.new do |rd|
+    rd.main = "README.md"
     rd.rdoc_dir = "doc/site/api"
-    rd.rdoc_files.include("README.rdoc", "ext/**/*.[ch]","lib/**/*.rb")
+    rd.rdoc_files.include("README.md", "ext/**/*.[ch]","lib/**/*.rb")
 end
 
 #
 # Packaging
 #
 PKG_FILES = FileList[
-  "Rakefile", "COPYING","README.rdoc", "NEWS",
+  "Rakefile", "COPYING","README.md", "NEWS",
   "ext/**/*.[ch]", "lib/**/*.rb", "ext/**/MANIFEST", "ext/**/extconf.rb",
   "tests/**/*",
   "spec/**/*"
@@ -91,14 +91,16 @@ 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.licenses = ['LGPL-2.1+']
     s.autorequire = "augeas"
     s.required_ruby_version = '>= 1.8.1'
     s.extensions = "ext/augeas/extconf.rb"
     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 +132,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]