rubygem-asciidoctor

Go to file
Dan Allen a8c3364927 add additional section on testing Asciidoctor		2013-03-12 14:43:49 -06:00
srpms	update	2013-03-06 18:58:47 +01:00
.gitignore	add gem to ignore file	2013-03-11 14:37:32 -06:00
asciidoctor-disable-use-of-pending.patch	move patches	2013-03-11 13:24:12 -06:00
asciidoctor-fix-nth-child-selectors.patch	move patches	2013-03-11 13:24:12 -06:00
README.adoc	add additional section on testing Asciidoctor	2013-03-12 14:43:49 -06:00
rubygem-asciidoctor.spec	%gem_install available everywhere	2013-03-06 13:59:25 +01:00
sources	add sources file w/ checksums	2013-03-11 13:23:17 -06:00
test-install	update to use public api	2013-03-01 19:53:35 +01:00
README.adoc

= rubygem-asciidoctor: Asciidoctor RPM package spec
Dan Allen
:idprefix:
:gem_title: Asciidoctor
:gem_name: asciidoctor
:gem_version: 0.1.1
:gem_gem: {gem_name}-{gem_version}.gem
:gem_url: https://github.com/asciidoctor/asciidoctor
:rpm_name: rubygem-{gem_name}
:rpm_rpm: {rpm_name}-{gem_version}.rpm
:rpm_repo: git://github.com/asciidoctor/rubygem-asciidoctor-rpm.git

This repository is the official host of the build materials to create the Fedora RPM package for the https://github.com/asciidoctor/asciidoctor[Asciidoctor] RubyGem.
The package is named +rubygem-asciidoctor+.

While this RPM spec was developed specifically for Fedora 17 and above, it may be useful for other RPM-based systems.

== Build the Asciidoctor RPM

If you want to build the RPM on your own machine, follow the instructions in this section.
If you want to test a pre-built package, skip to the next section on <<test-the-asciidoctor-rpm-and-report-feedback,testing the RPM>>.

=== Preparing your environment

You first need to install the packages necessary to build the RPM.
Begin by installing the +@fedora-packager+ group (as root or using sudo):

 yum install @fedora-packager wget

Next, clone this repository and switch to it:

 git clone git://github.com/asciidoctor/rubygem-asciidoctor-rpm.git 
 cd rubygem-asciidoctor-rpm

Finally, install the packages that this build requires (as root or using sudo):

 yum-builddep rubygem-asciidoctor.spec

Next, we need to put the package source and patches in place.

=== Preparing the sources

You can build RPMs as a non-privileged user, though you need to prepare the directories first.
Let's use the directory rpmbuild in our +$HOME+ directory:

 echo "%_topdir %(echo $HOME)/rpmbuild" > $HOME/.rpmmacros

You'll also need to create all the required folders:

 mkdir -p $HOME/rpmbuild/{BUILD,BUILDROOT,RPMS,SOURCES,SPECS,SRPMS}

Next, grab the Asciidoctor gem (the sources) and put it into the +$HOME/rpmbuild/SOURCES+ directory:

 wget -O $HOME/rpmbuild/SOURCES/asciidoctor-0.1.1.gem http://rubygems.org/gems/asciidoctor-0.1.1.gem

Finally, copy the +.patch+ files from this repository to the same directory:

 cp *.patch $HOME/rpmbuild/SOURCES/

You're now ready to build the RPM.

=== Building the RPM

With everything in place, building the RPM is easy!

 rpmbuild -ba rubygem-asciidoctor.spec

If all goes well, both the binary and source RPMs will emerge in the +$HOME/rpmbuild/RPMS/noarch+ and +$HOME/rpmbuild/SRPMS+ directories, respectively.

=== Installing the RPM

There's nothing special about installing this RPM.
I recommend using +yum+ because it will install any dependencies that the package requires (though you should already have them if you built the RPM).

 yum localinstall $HOME/rpmbuild/RPMS/noarch/rubygem-asciidoctor-0.1.1.rpm

Now, it's time to start using Asciidoctor!

== Test the Asciidoctor RPM and report feedback

Before the Asciidoctor package (+rubygem-asciidoctor+) can be included in the Fedora distribution, it must be tested by users and receive karma via the http://admin.fedoraproject.org/updates[Bohdi system].
One way to provide this feedback is to use the http://admin.fedoraproject.org/pkgdb/acls/name/fedora-easy-karma[fedora-easy-karma] tool.

=== Enable the updates-testing repository temporarily

In a terminal, type:

 sudo yum install rubygem-asciidoctor --enablerepo=updates-testing

This command will download and install the asciidoctor package.

=== Test the Asciidoctor package: +rubygem-asciidoctor+

First, let's test using Asciidoctor as a Ruby library.

. On your computer, create a new file and name it +asciidoctor-test.rb+ 
. Copy and paste the following code into the file:

  require 'asciidoctor'
  content = "= My First Document\n\nRender me some **HTML**!"
  puts Asciidoctor.render(content, :header_footer => true, :compact => true)

. Save the file.
. In a terminal, navigate to the directory where you saved +asciidoctor-test.rb+ and type the following command to execute the file with Ruby:

 ruby asciidoctor-test.rb
+
You should see this output in your terminal.

 <!DOCTYPE html>
 <html lang="en">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
     <meta name="generator" content="Asciidoctor 0.1.1">
     <title>My First Document</title>
   </head>
   <body class="article">
     <div id="header">
       <h1>My First Document</h1>
     </div>
     <div id="content">
 <div id="preamble">
   <div class="sectionbody">
 <div class="paragraph">
   <p>Render me some <strong>HTML</strong>!</p>
 </div>
   </div>
 </div>
     </div>
     <div id="footer">
       <div id="footer-text">
         Last updated 2013-03-12 10:43:15 MDT
       </div>
     </div>
   </body>
 </html>

. You can render the output as HTML using:

 ruby asciidoctor-test.rb > asciidoctor-test.html

. Open your browser to see the result.
. Alternatively, if you're using Gnome, type:

 gnome-open asciidoctor-test.html
+
A new tab should open in your current browser session.

Now let's test using the Asciidoctor executable.

. On your computer, create a new file and name it +test.ad+ 
. Copy and paste the following markup into the file:

 = My Second Document
 Your Name

 AsciiDoc is _rockin'_ docs.

. Save the file
. In a terminal, navigate to the directory where you saved +test.ad+ and type the following command to run it through the Asciidoctor processor:

 asciidoctor test.ad
+
You shouldn't see any output in your terminal.
That's because it writes the output to the file +test.html+.

. Open your browser to see the result.
. Alternatively, if you're using Gnome, type:

 gnome-open test.html
+
A new tab should open in your current browser session.

=== Provide feedback with fedora-easy-karma

. If you don't have fedora-easy-karma installed on your computer, type the following command in a terminal.

 sudo yum install fedora-easy-karma

. Once fedora-easy-karma is installed, run it in the terminal.

 fedora-easy-karma --fas-username <yourFASaccount> *asciidoctor
+
To be on the safe side, include the flag for your FAS account when you start fedora-easy-karma.
Once fedora-easy-karma runs, you will not be able to switch accounts.
+
NOTE: It may take fedora-easy-karma several minutes to fetch the list of packages in updates-testing.
+
When fedora-easy-karma finds +rubygem-asciidoctor+, it will display a summary of the package and prompt you to give -1 (negative), 0 (neutral), or 1 (postive) karma to the package.
For more information about providing karma for packages and how to comment on packages, review the http://fedoraproject.org/wiki/QA:Update_feedback_guidelines[Fedora feedback guidelines].

. Enter your karma rating.
. Next, you will be asked to provide additional, detailed feedback.
  Please comment whether the package worked as expected and you successfully used it, if you think you may have encountered an error, but aren't sure, or if you definitely encountered a bug.
. When prompted, enter your FAS password.
. W00t! The feedback process is complete.
. You can verify your feedback was recorded by visiting the https://admin.fedoraproject.org/updates[Bodhi updates page].