Ruber – Installing Ruber

Latest news:

Dependencies

To run Ruber, you need to have the following installed

Ruby 1.8.7 MRI or later (www.ruby-lang.org). Ruber works with both ruby 1.8.7 and ruby 1.9.x
Korundum (KDE Ruby bindings) version 4.5.2 or later (rubyforge.org/projects/korundum). Version 4.5.0 and 4.5.1 will likely not work, while the 4.4 releases may or may not work (some bugs have been fixed since these versions, so earlier versions may lead to crashes).
The Facets gem (rubyworks.github.com/facets/), version 2.7 or later
The Dictionary gem (death.rubyforge.org/dictionary)

Plugin dependencies

Some plugins need external libraries and/or programs to work. If you don’t have these requirements, then some of the plugins won’t work. Ruber itself and the other plugins will still work correctly, however. The programs needed by the plugins are:

rak (rak.rubyforge.org), needed by the Find in Files plugin
rake (rake.rubyforge.org), needed by the Rake plugin (already included in ruby 1.9.x)
rspec, either the 1.x series or the 2.x series, needed by the RSpec plugin
rdoc (https://github.com/rdoc/rdoc), needed by the RI plugin. RDoc is included in both ruby 1.8.7 and ruby 1.9.x, but the version shipped with ruby 1.8.7 isn’t supported by the plugin. If you want to use it with ruby 1.8.7, you’ll have to install a new version.

Installing Ruber and its dependencies

The easy way

This is the recommanded way to install Ruber, and, if possible, you should always used this method. It makes use of the package manager provided by your distribution to install most of the required libraries, and uses rubygems to install Ruber and the gems which aren’t availlable as packages for your distribution. This is what you need to do:

Install Ruby (and rubygems, if using ruby 1.8.7) using your package manager
Install the KDE Ruby bindings using your package manager (usually, the name of the package will be something like korundum, korundum4 or kdebindings-ruby). Depending on the packages you have already installed on your system, other packages may also be installed.
Install Facets and Dictionary using your package manager. You can skip this step if you want: these libraries will be installed as gems in the following step.
Install Ruber using rubygems (this will also install any gem Ruber depends upon): gem install ruber

The hard way

The hard way to install ruber is to install the needed dependencies by hand. In particular (depending on what you have already installed) this may mean installing ruby, the KDE libraries and the KDE Ruby bindings. If you want, you can also mix the easy and the hard way, installing some of the above programs using your package manager and some other by hand.

Warning: installing the hard way is much more difficult than using the easy way, so you’re advised not to use this method, unless absolutely needed (that is, if the easy method doesn’t work for some reason which can’t be fixed).

Installing Ruby by hand

Download ruby from the Ruby home page
Unpack the tarball
cd in the directory created by unpacking the tarball
Run ./configure, passing it any argument you want. In particular, you may want to change the installation directory (which by default is /usr/local) and add a prefix or suffix to the executable name (this is useful if you want two) versions of ruby installed at the same time. To change the installation directory, pass the --prefix DIR argument to configure, where DIR is the directory you want to install ruby into. To add a prefix or a suffix to the executables, use the --program-prefix or --program-suffix options, followed by the prefix or suffix you want. Use ./configure --help to see all the options accepted by configure
Run make
Run make install. Unless you changed the installation directory to a directory you have write access to, this command must be run as superuser.

Installing the KDE libraries by hand

I strongly discourage from building the KDE libraries by hand, given the large number of dependencies they have and the fact that every distribution has packages for them. To install using a package manager, simply install the kdelibs package.

If you really want to install by hand, here’s what to do

Install the needed dependencies. They’re listed on the KDE techbase site, with instructions for different distributions. However, not all the dependencies listed here are required to install Ruber. You can try skipping this section for now and return to it after running cmake (see below).
Download the KDE libraries from the KDE home page. Choose the version marked as recommended for end users, then, following the link, download the kdelibs tarball. Do not follow the instructions linked on the download page, as they’re for people developing KDE itself
Unpack the tarball
cd in the directory created unpacking the tarball
Create a build directory: mkdir build
cd build
cmake .. This will fail if you’re missing a required library. In this case, it’ll tell you which it is and you’ll be able to install it
Run ccmake . This will give you a pseudo-graphical interface where to set some options. In particular, look at the CMAKE_INSTALL_PREFIX option, which controls the directory KDE will be installed into, and change it as you like. After changing the options you need, press c to configure and g to generate. Then e to exit
make
make install. Unless you changed the installation directory to a directory you have write access to, this command must be run as superuser.

Installing the KDE Ruby bindings

First, Make sure you have both the Ruby and KDE headers installed. If you installed Ruby or the KDE libraries using the package manager, depending on your distribution, you may not have installed the header files needed by the compiler. Using your package manager, see if there are packages called something like ruby-devel and kdelibs-devel (or ruby-headers and kdelibs-headers). If so, install them. If you installed Ruby and the KDE libraries by hand, the header files are already installed. The next part of the installation changes depending on the version of KDE you’ve installed.

For KDE up to 4.6.x

Download the kdebindings tarball from the KDE home page. Choose the same version as your KDE libraries.
Unpack the tarball.
cd in the directory created unpacking the tarball

If you’re using ruby 1.9.2 and are installing a version of korundum lesser than 4.5.3, run the following two commands:


    sed -i -e 's#STR2CSTR(rb_obj_as_string#RSTRING_PTR(rb_obj_as_string#'\
      ruby/korundum/src/krubypluginfactory.cpp@
    sed -i -e "s#STR2CSTR#StringValueCStr#"\
      ruby/korundum/src/krubypluginfactory.cpp@

Create a build directory: mkdir build
cd build
cmake ..
If you had a KDE environment installed before deciding to install Ruber, check, using your package manager, whether you also have a package called smoke installed
run ccmake . This will give you a pseudo-graphical interface where to set some options. In particular, you may want to change the installation directory by setting the CMAKE_INSTALL_PREFIX option. Most likely, you’ll also want to avoid building the bindings for languages other than Ruby, so set the corresponding BUILD_* options (for example, BUILD_perl) to OFF. If you already have smoke installed, also set BUILD_smoke to OFF. After changing the options you need, press c to configure and g to generate. Then e to exit
make
make install. Unless you changed the installation directory to a directory you have write access to, this command must be run as superuser.

For KDE from 4.7.0

Download the smokegen, smokeqt, smokekde, qtruby and korundum tarballs from the KDE website.
If you installed KDE using your package manager, you may use it to also install the smokeqt and smokekde packages. If so, you can ignore both them and smokegen in the previous list.
For each of the downloaded tarballs (in the order given above), do the following:
unpack the tarball and cd in the directory containing the code
create a build directory: mkdir build
run cmake ..
run cmake .. This will give you a pseudo-graphical interface where to set some options. In particular, you may want to change the installation directory by setting the CMAKE_INSTALL_PREFIX option. When you’re finished with the options, press c to configure and g to generate. Then e to exit.
run make
run make install. Unless you changed the installation directory to a directory you have write access to, this command must be run as superuser.

Installing plugin dependencies

rake: gem install rake (you don’t need this if using ruby 1.9, unless you want to install a newer version of rake)
rspec: gem install rspec
rak: gem install rak. If you’re using ruby 1.9, you may want to edit the source code of rak to avoid encoding issues. To do so, you’ll have to find out where rubygems installed it. It’ll be in the gems/rak-x.y.z subdirectory of one of the directories listed by gem env command under the GEM PATHS heading. Once located the directory where rak is installed, make the following changes to the bin/rak file (thanks to FooBarWidget who made a pull request with this fix on the rak github page):
- after the first line of the file, add the code # encoding: binary
- on line 486, replace f = File.open(fn, "r") with f = File.open(fn, "rb")
rdoc: (shell) gem install rdoc

Building the API documentation

Ruber’s documentation is written in YARD format, using Textile as markup format. If you truly want, you can use RDoc to generate the documentation, but you’ll miss some information (in particular regarding signals and slots) and the formatting will be missing or wrong.

Building the documentation using YARD

Install Ruber
Install YARD e RedCloth: gem install yard rdoc (or use your package manager to install them)
cd to the directory you installed Ruber into (to find out where this is, look at the output gem environment, in particular at the GEM_PATHS entry. Ruber will be installed under the gems/ruber-x.y.z subdirectory of one of the directories listed there)
Issue the command rake doc OUTPUT_DIR=/path/to/output/dir command. OUTPUT_DIR is the directory where you want to install the documentation. If you don’t specify it, it’ll be installed under the doc directory in the Ruber installation directory.

Building the documentation using rdoc

Install Ruber
cd to the directory you installed Ruber into (see above how to find it)
Issue the command rake rdoc OUTPUT_DIR=/path/to/output/dir command. OUTPUT_DIR is the directory where you want to install the documentation. If you don’t specify it, it’ll be installed under the rdoc directory in the Ruber installation directory.

Installing other plugins

Currently, the only way to install a plugin is to download the tarball and extract it in one of the directories where Ruber looks for plugins( by default, they are the plugins subdirectory of the Ruber installation directory and $KDEHOME/share/apps/ruber/plugins). This should create a subdirectory named as the plugin in that directory.

Using the development version of Ruber

If you want to use a version of Ruber which hasn’t as yet been released, you can download the source code from the git repository and install it by hand. To do so, make sure you have all the prerequisites installed, then download the source code doing one of the following:

clone Ruber’s git repository: git clone git://github.com/stcrocco/ruber.git. You need to have git installed to do this.
go to the Ruber project page, then press the download button and choose either the Download .tar.gz or the Download .zip entry. This will download a compressed file with the appropriate extension on your computer. Extract this file with the appropriate method.

Now, enter the directory where you’ve downloaded the source code and issue rake ruber. This is needed to generate files describing the user interface (mainly dialogs) from files produced by the Qt Designer program. Once this is done, you can run Ruber from this directory with the following command: ruby -Ilib bin/ruber. If you only want to try the development version once or twice, or if you want to help developing Ruber, that’s all you need to do. If you want to go on using it, and want to run it with a simple ruber, you’ll have to build a gem with gem build ruber.gemspec followed by gem install ruber-x.y.z.gem, where ruber-x.y.z is the file generated by the previous command.

Ruber IDE

Site menu: