latin-language-toolkit/llt-db_handler

Classes used by llt gems to communicate with stem databases

LLT::DbHandler

LLT abstraction to communicate with stem dictionaries/databases.

Installation

Add this line to your application's Gemfile:

gem 'llt-db_handler'

And then execute:

$ bundle

Or install it yourself as:

$ gem install llt-db_handler

You will also want to install a proper postgresql adapter for the stem dictionary. You could add this to your Gemfile:

  platform :ruby do
    gem 'pg'
  end

  platform :jruby do
    gem 'activerecord-jdbcpostgresql-adapter'
  end

Usage

The Prometheus Stem Dictionary comes with this gem. To use it make sure you have postgresql installed and a user called prometheus ready:

  psql
    create user prometheus with password 'admin'
    alter user prometheus with createdb

Create the database and seed data:

  rake db:prometheus:create
  rake db:prometheus:seed

The database prometheus_stems will now be available.

This should not be needed as the db is created by the user prometheus

anyway. You might have to grant privileges to the user prometheus before going further:

  psql
    grant all on database prometheus_stems to prometheus

-->

  require 'llt/db_handler/prometheus'

  db = LLT::DbHandler::Prometheus.new
  db.count            # => returns the total number of entries
  db.all_entries      # => returns all entries as AR models
  db.lemma_list       # => returns an Array of lemmas as strings
  db.lemma_list(true) # => returns detailed lemma strings

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request