dm_panlex 0.1.0

data/README.md

@@ -0,0 +1,37 @@
+# dm\_panlex 
+This package is an ORM mapping of [Panlex](http://panlex.org) database using Ruby [Data mapper](http://datamapper.org).
+
+## Differences
+
+Following are the only differences detected between the database created by this package (tested in PostgreSQL 9.1.6 on Debian Wheezy) and actual Panlex database:
+
+* 'ON UPDATE CASCADE' in wcex-wc 1-n relation is not implemented because, as far as I know, dm-constraints can't do that without adding 'ON DELETE CASCADE'.
+* A PK for cu(lv, co, loc, vb) is added because datamapper requires each model to have a PK. That makes cu(loc) field to be a required one even if it's not in original Panlex database. It forces as well cu(loc) and cu(loc) to be String instead of Text, as in MySQL a Text can't be a PK.
+* Fields with 'character' type are changed to 'character varying'.
+* PostgreSQL Cluster (http://www.postgresql.org/docs/8.1/static/sql-cluster.html) are not implemented.
+* Unique indexes appear as 'UNIQUE' instead of 'UNIQUE CONSTRAINT' (don't know why).
+* An 'index' is created for fields that are FK and haven't any index in the original Panlex database.
+* Unique indexes are named 'unique\_\*' instead of '\*\_key'
+* FK are named '\*\_fk' instead of '\_fkey'.
+* When showing a table schema from the database, fields that 'belong to' some other table are listed as the last ones.
+
+## TO DO
+
+* Solve some of the differences if it is really needed.
+
+## LICENSE
+
+Copyright 2013 Marc Busqué - <marc@lamarciana.com>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/lib/dm_panlex/models/ap.rb

@@ -0,0 +1,28 @@
+module Dm_Panlex
+   class Ap
+      include DataMapper::Resource
+
+      storage_names[:default] = 'ap'
+
+      property :ap, Integer, :key => true
+      property :dt, Date, :field => 'dt', :required => true
+      property :tt, Text, :required => true, :unique_index => true
+      property :ur, Text
+      property :bn, Text
+      property :au, Text
+      property :ti, Text
+      property :pb, Text
+      property :yr, Integer, :min => -32768, :max => 32767
+      property :uq, Integer, :min => -32768, :max => 32767, :required => true
+      property :ui, Integer, :min => -32768, :max => 32767
+      property :ul, Text
+      property :ip, Text
+      property :co, Text
+      property :ad, Text
+
+      belongs_to :apli, :parent_key => :li, :child_key  => :li
+
+      has n, :avs, :parent_key => :ap, :child_key => :ap, :constraint => :destroy
+      has n, :mns, :parent_key => :ap, :child_key => :ap
+   end
+end

data/lib/dm_panlex/models/apli.rb

@@ -0,0 +1,13 @@
+module Dm_Panlex
+   class Apli
+      include DataMapper::Resource
+
+      storage_names[:default] = 'apli'
+
+      property :id, Integer, :key => true
+      property :li, String, :length => 2, :required => true, :unique_index => true
+      property :pl, Text, :required => true, :unique_index => true
+
+      has n, :aps, :parent_key => :li, :child_key => :li
+   end
+end

data/lib/dm_panlex/models/av.rb

@@ -0,0 +1,13 @@
+module Dm_Panlex
+   class Av
+      include DataMapper::Resource
+
+      storage_names[:default] = 'av'
+
+      property :ap, Integer, :key => true
+      property :lv, Integer, :key => true
+
+      belongs_to :ap, :parent_key => :ap, :child_key => :ap
+      belongs_to :lv, :parent_key => :lv, :child_key => :lv
+   end
+end

data/lib/dm_panlex/models/cp.rb

@@ -0,0 +1,13 @@
+module Dm_Panlex
+   class Cp
+      include DataMapper::Resource
+
+      storage_names[:default] = 'cp'
+
+      property :lv, Integer, :key => true, :unique_index => :cp_lv_key
+      property :c0, String, :length => 5, :key => true
+      property :c1, String, :length => 5, :required => true, :unique_index => :cp_lv_key
+
+      belongs_to :lv, :parent_key => :lv, :child_key  => :lv
+   end
+end

data/lib/dm_panlex/models/cu.rb

@@ -0,0 +1,16 @@
+module Dm_Panlex
+   class Cu
+      include DataMapper::Resource
+
+      storage_names[:default] = 'cu'
+
+      #DataMapper requires a primary Key. It's not present in Panlex original database, but we assume it's the :cu_c0_key unique index. In MySQL a 'Text' field can't be a PK, so we change 'loc' and 'vb' to be 'String'
+      property :lv, Integer, :key => true, :required => true, :unique_index => [:cu_c0_key, :cu_c1_key]
+      property :c0, String, :length => 5, :key => true, :required => true, :unique_index => :cu_c0_key
+      property :c1, String, :length => 5, :required => true, :unique_index => :cu_c1_key
+      property :loc, String, :length => 255, :key => true, :unique_index => [:cu_c0_key, :cu_c1_key]
+      property :vb, String, :length => 255, :key => true, :required => true, :unique_index => [:cu_c0_key, :cu_c1_key]
+
+      belongs_to :lv, :parent_key => :lv, :child_key  => :lv
+   end 
+end

data/lib/dm_panlex/models/df.rb

@@ -0,0 +1,15 @@
+module Dm_Panlex
+   class Df
+      include DataMapper::Resource
+
+      storage_names[:default] = 'df'
+
+      property :df, Integer, :key => true
+      property :mn, Integer, :required => true, :unique_index => :df_mn_key
+      property :lv, Integer, :required => true, :unique_index => :df_mn_key
+      property :tt, Text, :required => true, :unique_index => :df_mn_key
+
+      belongs_to :lv, :parent_key => :lv, :child_key  => :lv
+      belongs_to :mn, :parent_key => :mn, :child_key  => :mn
+   end
+end

data/lib/dm_panlex/models/dm.rb

@@ -0,0 +1,14 @@
+module Dm_Panlex
+   class Dm
+      include DataMapper::Resource
+
+      storage_names[:default] = 'dm'
+
+      property :dm, Integer, :key => true
+      property :mn, Integer, :required => true, :unique_index => :dm_mn_key
+      property :ex, Integer, :required => true, :unique_index => :dm_mn_key
+
+      belongs_to :ex, :parent_key => :ex, :child_key  => :ex
+      belongs_to :mn, :parent_key => :mn, :child_key  => :mn
+   end
+end

data/lib/dm_panlex/models/dn.rb

@@ -0,0 +1,17 @@
+module Dm_Panlex
+   class Dn
+      include DataMapper::Resource
+
+      storage_names[:default] = 'dn'
+
+      property :dn, Integer, :key => true
+      property :mn, Integer, :required => true, :unique_index => :dm_mn_ex_key, :index => true
+      property :ex, Integer, :required => true, :unique_index => :dm_mn_ex_key, :index => true
+
+      belongs_to :ex, :parent_key => :ex, :child_key  => :ex
+      belongs_to :mn, :parent_key => :mn, :child_key  => :mn
+
+      has n, :mds, :parent_key => :dn, :child_key => :dn
+      has n, :wcs, :parent_key => :dn, :child_key => :dn
+   end
+end

data/lib/dm_panlex/models/ex.rb

@@ -0,0 +1,17 @@
+module Dm_Panlex
+   class Ex
+      include DataMapper::Resource
+
+      storage_names[:default] = 'ex'
+
+      property :ex, Integer, :key => true
+      property :lv, Integer, :required => true, :unique_index => :ex_lv_tt_key, :index => true
+      property :tt, Text, :required => true, :unique_index => :ex_lv_tt_key, :index => true
+      property :td, Text, :required => true, :index => true
+
+      belongs_to :lv, :parent_key => :lv, :child_key  => :lv
+
+      has n, :dms, :parent_key => :ex, :child_key => :ex
+      has n, :dns, :parent_key => :ex, :child_key => :ex
+   end
+end

data/lib/dm_panlex/models/i1.rb

@@ -0,0 +1,12 @@
+module Dm_Panlex
+   class I1
+      include DataMapper::Resource
+
+      storage_names[:default] = 'i1'
+
+      property :iso1, String, :length => 2, :key => true
+      property :iso3, String, :length => 3, :required => true
+
+      belongs_to :lc, :parent_key => :lc, :child_key  => :iso3
+   end
+end

data/lib/dm_panlex/models/lc.rb

@@ -0,0 +1,13 @@
+module Dm_Panlex
+   class Lc
+      include DataMapper::Resource
+
+      storage_names[:default] = 'lc'
+
+      property :lc, String, :length => 3, :key => true
+      property :tp, String, :length => 1, :required => true
+
+      has n, :i1s, :parent_key => :lc, :child_key => :iso3
+      has n, :lvs, :parent_key => :lc, :child_key => :lc
+   end
+end

data/lib/dm_panlex/models/lv.rb

@@ -0,0 +1,22 @@
+module Dm_Panlex
+   class Lv
+      include DataMapper::Resource
+
+      storage_names[:default] = 'lv'
+
+      property :lv, Integer, :key => true
+      property :lc, String, :length => 3, :required => true, :unique_index => :lv_lc_key
+      property :vc, Integer, :min => -32768, :max => 32767, :required => true, :unique_index => :lv_lc_key
+      property :sy, Boolean, :required => true, :default => true
+      property :am, Boolean, :required => true, :default => true
+      property :tt, Text, :required => true
+
+      belongs_to :lc, :parent_key => :lc, :child_key  => :lc
+
+      has n, :avs, :parent_key => :lv, :child_key => :lv, :constraint => :destroy
+      has n, :cps, :parent_key => :lv, :child_key => :lv
+      has n, :cus, :parent_key => :lv, :child_key => :lv
+      has n, :dfs, :parent_key => :lv, :child_key => :lv
+      has n, :exs, :parent_key => :lv, :child_key => :lv
+   end
+end

data/lib/dm_panlex/models/md.rb

@@ -0,0 +1,14 @@
+module Dm_Panlex
+   class Md
+      include DataMapper::Resource
+
+      storage_names[:default] = 'md'
+
+      property :md, Integer, :key => true
+      property :dn, Integer, :required => true, :unique_index => :md_dn_key
+      property :vb, Text, :required => true, :unique_index => :md_dn_key
+      property :vl, Text, :required => true, :unique_index => :md_dn_key
+
+      belongs_to :dn, :parent_key => :dn, :child_key  => :dn
+   end
+end

data/lib/dm_panlex/models/mi.rb

@@ -0,0 +1,12 @@
+module Dm_Panlex
+   class Mi
+      include DataMapper::Resource
+
+      storage_names[:default] = 'mi'
+
+      property :mn, Integer, :key => true
+      property :tt, Text, :required => true
+
+      belongs_to :mn, :parent_key => :mn, :child_key  => :mn
+   end
+end

data/lib/dm_panlex/models/mn.rb

@@ -0,0 +1,17 @@
+module Dm_Panlex
+   class Mn
+      include DataMapper::Resource
+
+      storage_names[:default] = 'mn'
+
+      property :mn, Integer, :key => true
+      property :ap, Integer, :required => true, :index => true
+
+      belongs_to :ap, :parent_key => :ap, :child_key  => :ap
+
+      has n, :dfs, :parent_key => :mn, :child_key => :mn
+      has n, :dms, :parent_key => :mn, :child_key => :mn
+      has n, :dns, :parent_key => :mn, :child_key => :mn
+      has n, :mis, :parent_key => :mn, :child_key => :mn
+   end
+end

data/lib/dm_panlex/models/us.rb

@@ -0,0 +1,16 @@
+module Dm_Panlex
+   class Us
+      include DataMapper::Resource
+
+      storage_names[:default] = 'us'
+
+      property :us, Integer, :key => true
+      property :dt, Date, :field => 'dt', :required => true
+      property :nm, Text
+      property :al, Text, :required => true, :unique_index => true
+      property :sm, Text
+      property :ht, Text
+      property :ok, Boolean, :required => true, :default => false
+      property :ad, Boolean, :required => true, :default => false
+   end
+end

data/lib/dm_panlex/models/wc.rb

@@ -0,0 +1,14 @@
+module Dm_Panlex
+   class Wc
+      include DataMapper::Resource
+
+      storage_names[:default] = 'wc'
+
+      property :wc, Integer, :key => true
+      property :dn, Integer, :required => true, :unique_index => :wc_dn_key
+      property :ex, Integer, :required => true, :unique_index => :wc_dn_key
+
+      belongs_to :dn, :parent_key => :dn, :child_key  => :dn
+      belongs_to :wcex, :parent_key => :ex, :child_key  => :ex
+   end
+end

data/lib/dm_panlex/models/wcex.rb

@@ -0,0 +1,12 @@
+module Dm_Panlex
+   class Wcex
+      include DataMapper::Resource
+
+      storage_names[:default] = 'wcex'
+
+      property :ex, Integer, :key => true
+      property :tt, Text, :required => true, :unique_index => true
+
+      has n, :wcs, :parent_key => :ex, :child_key => :ex
+   end
+end

data/lib/dm_panlex.rb

@@ -0,0 +1,26 @@
+%w[
+   data_mapper
+].each do |lib|
+   require lib
+end
+
+require 'dm_panlex/models/ap'
+require 'dm_panlex/models/apli'
+require 'dm_panlex/models/av'
+require 'dm_panlex/models/cp'
+require 'dm_panlex/models/cu'
+require 'dm_panlex/models/df'
+require 'dm_panlex/models/dm'
+require 'dm_panlex/models/dn'
+require 'dm_panlex/models/ex'
+require 'dm_panlex/models/i1'
+require 'dm_panlex/models/lc'
+require 'dm_panlex/models/lv'
+require 'dm_panlex/models/md'
+require 'dm_panlex/models/mi'
+require 'dm_panlex/models/mn'
+require 'dm_panlex/models/us'
+require 'dm_panlex/models/wc'
+require 'dm_panlex/models/wcex'
+
+DataMapper.finalize

data/panlex.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+   s.name = 'dm_panlex'
+   s.version = '0.1.0'
+   s.summary = 'Data mapper models for the Panlex database'
+   s.description = 'https://github.com/laMarciana/dm_panlex/'
+   s.license = ''
+   s.homepage = 'https://github.com/laMarciana/dm_panlex/'
+   s.authors = ['Marc Busqué']
+   s.email = 'marc@lamarciana.com'
+   s.files = `git ls-files`.split("\n")
+
+   s.add_runtime_dependency "data_mapper", "~>1.2"
+
+   s.add_development_dependency "rspec", "~>2.11"
+   s.add_development_dependency "dm-rspec", "~>0.2"
+end

data/spec/dm_panlex/models/ap_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+module Dm_Panlex
+   describe Ap, "Approvers" do
+      it "has a property id (ap)" do
+         should have_property :ap
+      end
+      it "has a property registration date (dt)" do
+         should have_property :dt
+      end
+      it "has a property label (tt)" do
+         should have_property :tt
+      end
+      it "has a property URI (ur)" do
+         should have_property :ur
+      end
+      it "has a property ISBN (bn)" do
+         should have_property :bn
+      end
+      it "has a property author (au)" do
+         should have_property :au
+      end
+      it "has a property title (ti)" do
+         should have_property :ti
+      end
+      it "has a property monograph publisher or serial title, volume, and page range (pb)" do
+         should have_property :pb
+      end
+      it "has a property year of publication (yr)" do
+         should have_property :yr
+      end
+      it "has a property quality in editor's judgement (uq)" do
+         should have_property :uq
+      end
+      it "has a property numeric ID specified by the user (ui)" do
+         should have_property :ui
+      end
+      it "has a property miscellaneous information (ul)" do
+         should have_property :ul
+      end
+      it "has a property type of offered license (li)" do
+         should have_property :li
+      end
+      it "has a property summary of intellectual-property claim (ip)" do
+         should have_property :ip
+      end
+      it "has a property name of apparent intellectual-property claimant (co)" do
+         should have_property :co
+      end
+      it "has a property SMTP address for licensing correspondence (ad)" do
+         should have_property :ad
+      end
+      it "is not valid without an id" do
+         should validate_presence_of :ap
+      end
+      it "is not valid without a registration date" do
+         should validate_presence_of :dt
+      end
+      it "is not valid without a label" do
+         should validate_presence_of :tt
+      end
+      it "is not valid without a quality in editor's judgement" do
+         should validate_presence_of :uq
+      end
+      it "belongs to an approver license (apli)" do
+         should belong_to :apli
+      end
+      it "has many approver varieties (av)" do
+         should have_many :avs
+      end
+      it "has many meanings (mn)" do
+         should have_many :mns
+      end
+   end
+end

data/spec/dm_panlex/models/apli_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module Dm_Panlex
+   describe Apli, "Approver license" do
+      it "has a property id (id)" do
+         should have_property :id
+      end
+      it "has a property type code (li)" do
+         should have_property :li
+      end
+      it "has a property text of the type's PanLex expression (pl)" do
+         should have_property :pl
+      end
+      it "is not valid without an id" do
+         should validate_presence_of :id
+      end
+      it "is not valid without a type code" do
+         should validate_presence_of :li
+      end
+      it "is not valid without a text of the type's PanLex expression" do
+         should validate_presence_of :pl
+      end
+      it "has many approvers (ap)" do
+         should have_many :aps
+      end
+   end
+end

data/spec/dm_panlex/models/av_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module Dm_Panlex
+   describe Av, "Approver variety" do
+      it "has a property approver (ap)" do
+         should have_property :ap
+      end
+      it "has a property variety (lv)" do
+         should have_property :lv
+      end
+      it "is not valid without an approver" do
+         should validate_presence_of :ap
+      end
+      it "is not valid without a variety" do
+         should validate_presence_of :lv
+      end
+      it "belongs to an approver (ap)" do
+         should belong_to :ap
+      end
+      it "belongs to a language variety (lv)" do
+         should belong_to :lv
+      end
+   end
+end

data/spec/dm_panlex/models/cp_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module Dm_Panlex
+   describe Cp, "Approved characters" do
+      it "has a property variety (lv)" do
+         should have_property :lv
+      end
+      it "has a property start of character range (c0)" do
+         should have_property :c0
+      end
+      it "has a property end of character range (c1)" do
+         should have_property :c1
+      end
+      it "is not valid without a variety" do
+         should validate_presence_of :lv
+      end
+      it "is not valid without a start of character range" do
+         should validate_presence_of :c0
+      end
+      it "is not valid without an end of character range" do
+         should validate_presence_of :c1
+      end
+      it "belongs to a language variety (lv)" do
+         should belong_to :lv
+      end
+   end
+end

data/spec/dm_panlex/models/cu_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+module Dm_Panlex
+   describe Cu, "Exemplar characters" do
+      it "has a property variety (lv)" do
+         should have_property :lv
+      end
+      it "has a property start of character range (c0)" do
+         should have_property :c0
+      end
+      it "has a property end of character range (c1)" do
+         should have_property :c1
+      end
+      it "has a property locale (loc)" do
+         should have_property :loc
+      end
+      it "has a property variable (vb)" do
+         should have_property :vb
+      end
+      it "is not valid without a variety" do
+         should validate_presence_of :lv
+      end
+      it "is not valid without a start of character range" do
+         should validate_presence_of :c0
+      end
+      it "is not valid without an end of character range" do
+         should validate_presence_of :c1
+      end
+      it "is not valid without a variable" do
+         should validate_presence_of :vb
+      end
+      it "belongs to a language variety (lv)" do
+         should belong_to :lv
+      end
+   end
+end

data/spec/dm_panlex/models/df_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+module Dm_Panlex
+   describe Df, "Definition" do
+      it "has a property id (df)" do
+         should have_property :df
+      end
+      it "has a property meaning (mn)" do
+         should have_property :mn
+      end
+      it "has a property variety of the text (lv)" do
+         should have_property :lv
+      end
+      it "has a property text (tt)" do
+         should have_property :tt
+      end
+      it "is not valid without an id" do
+         should validate_presence_of :df
+      end
+      it "is not valid without a meaning" do
+         should validate_presence_of :mn
+      end
+      it "is not valid without a variety of the text" do
+         should validate_presence_of :lv
+      end
+      it "is not valid without a text" do
+         should validate_presence_of :tt
+      end
+      it "belongs to a language variety (lv)" do
+         should belong_to :lv
+      end
+      it "belongs to a meaning (mn)" do
+         should belong_to :mn
+      end
+   end
+end

data/spec/dm_panlex/models/dm_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module Dm_Panlex
+   describe Dm, "Domain descriptors" do
+      it "has a property id (dm)" do
+         should have_property :dm
+      end
+      it "has a property meaning (mn)" do
+         should have_property :mn
+      end
+      it "has a property expression (ex)" do
+         should have_property :ex
+      end
+      it "is not valid without an id" do
+         should validate_presence_of :dm
+      end
+      it "is not valid without a meaning" do
+         should validate_presence_of :mn
+      end
+      it "is not valid without an expression" do
+         should validate_presence_of :ex
+      end
+      it "belongs to an expression (ex)" do
+         should belong_to :ex
+      end
+      it "belongs to a meaning (mn)" do
+         should belong_to :mn
+      end
+   end
+end