wontomedia 0.0.1

data/app/helpers/items_helper.rb

@@ -0,0 +1,105 @@
+#--
+# WontoMedia - a wontology web application
+# Copyright (C) 2010 - Glen E. Ivey
+#    www.wontology.com
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License version
+# 3 as published by the Free Software Foundation.
+#
+# 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program in the file COPYING and/or LICENSE.  If not,
+# see <http://www.gnu.org/licenses/>.
+#++
+
+
+require Rails.root.join( 'app', 'helpers', 'format_helper' )
+include(FormatHelper)
+
+# Helpers for app/views/items/* pages
+module ItemsHelper
+
+  # This method is called with the _ID_ of an Item and returns markup
+  # showing the +title+ string for that item which will show a
+  # 'tooltip' with the Item's +name+ string on mouse-over.  If the
+  # argument Item is the same as the Item for which the current view
+  # is being generated (the output page's "self", <tt>@item</tt>),
+  # then the +title+ will be displayed as simple text.  If the
+  # argument Item is different from the page's item, then the +title+
+  # will be displayed as a link to _that_ Item's +show+ page.
+  def self_string_or_other_link(item_id)
+    n = @item_hash[item_id]
+    title = h filter_parenthetical n.title
+    if item_id == @item.id    # self
+      text_with_tooltip title, h( n.name )
+    else                      # other
+      link_with_tooltip title, h( n.name ), item_path(n)
+    end
+  end
+
+  # When called, this helper adds to the current page the
+  # open-<tt><table></tt> tag and table-heading cells for the table of
+  # connection subject-predicate-object Items within the
+  # <tt>app/views/items/show</tt> view.
+  def output_table_open
+    header_style = 'display: block; position: relative;'
+    concat(tag 'table', nil, true)  # generate an "open" table tag
+    concat(content_tag( 'thead',
+      content_tag( 'tr',
+        content_tag( 'th', '' ) +
+        content_tag( 'th',
+          content_tag( 'span', '<em>is</em> or <em>has</em>',
+            :style => "#{header_style} left: -3em;" )) +
+        content_tag( 'th',
+          content_tag( 'span', '<em>to</em> or <em>with</em>',
+            :style => "#{header_style} left: -1em;" ))
+      )
+    ))
+  end
+
+  # When called, this helper adds to the current page the closing
+  # <tt></table></tt> tag for the table of connection
+  # subject-predicate-object Items within the
+  # <tt>app/views/items/show</tt> view.
+  def output_table_close
+    concat('</table>')
+  end
+
+  # When called, this helper adds to the current page "Edit..." and
+  # "Delete" links if they are appropriate for the Item instance
+  # passed in.  Neither link is "appropriate" for Items flagged in the
+  # database as <tt>Item::DATA_IS_UNALTERABLE</tt>.  In addition, the
+  # "Delete" link will be output only if there are no existing
+  # connections in the database which reference the +item+ (as
+  # determined by the ItemsController and passed to the view in the
+  # <tt>@not_in_use_hash</tt>).
+  def generate_item_links(item)
+    if (item.flags & Item::DATA_IS_UNALTERABLE) == 0
+      concat(
+        link_with_help_icon({
+          :destination => link_to( 'Edit&hellip;', edit_item_path(item),
+            :rel => 'nofollow'),
+        :already_generated => @edit_help_icon_used,
+        :help_alt => 'Help edit item',
+        :which_help => 'ItemEdit' }) )
+      @edit_help_icon_used = true
+
+      if @not_in_use_hash[item.id]
+        concat(
+          link_with_help_icon({
+            :destination => link_to( 'Delete', item_path(item),
+              :rel => 'nofollow', :method => :delete,
+              :confirm => 'Are you sure?'),
+            :already_generated => @delete_help_icon_used,
+            :help_alt => 'Help delete item',
+            :which_help => 'ItemDelete' }) )
+        @delete_help_icon_used = true
+      end
+    end
+  end
+end

data/app/models/category_item.rb

@@ -0,0 +1,23 @@
+#--
+# WontoMedia - a wontology web application
+# Copyright (C) 2010 - Glen E. Ivey
+#    www.wontology.com
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License version
+# 3 as published by the Free Software Foundation.
+#
+# 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program in the file COPYING and/or LICENSE.  If not,
+# see <http://www.gnu.org/licenses/>.
+#++
+
+
+# This model class is a child of Item using Rails' single-table inheritance.
+class CategoryItem < Item
+end

data/app/models/connection.rb

@@ -0,0 +1,210 @@
+#--
+# WontoMedia - a wontology web application
+# Copyright (C) 2010 - Glen E. Ivey
+#    www.wontology.com
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License version
+# 3 as published by the Free Software Foundation.
+#
+# 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program in the file COPYING and/or LICENSE.  If not,
+# see <http://www.gnu.org/licenses/>.
+#++
+
+
+require Rails.root.join( 'lib', 'helpers', 'item_helper')
+require Rails.root.join( 'lib', 'helpers', 'tripple_navigation')
+
+# Model for the representation of "connections" (which are used to
+# make statements about the relationships between "item") in
+# WontoMedia's database.  The schema listing the data fields for a
+# Connection is, of course, in db/schema.rb.  And Rails'
+# automatically-provided model methods are based on the field names
+# there.
+#
+# A great deal of this model's behavior is provided by Rails
+# <tt>belongs_to</tt> relations between Connection object fields and
+# Item objects (see source).
+class Connection < ActiveRecord::Base
+
+  # This constant is a bit mask for Item.flags.  A non-zero value
+  # indicates that the Item instance should not be user-modifiable.
+  DATA_IS_UNALTERABLE = 1
+
+
+  before_validation :complex_validations
+#  validates_presence_of :subject, :predicate, :obj
+#explicitly do the equivalent of the above in complex_validations because
+#c_v has to be a "before" callback (so it's return value is checked), which
+#means other validations aren't run yet, so can't count on these IDs to
+#be present/valid.  Ugh.
+#  validates_uniqueness_of :subject_id, :scope => [:predicate_id, :obj_id]
+#this works, but is subsumed by checks in c_v, so eliminated duplication
+
+  belongs_to :subject,   :class_name => "Item"
+  belongs_to :predicate, :class_name => "Item"
+  belongs_to :obj,       :class_name => "Item"
+  belongs_to :connection_desc, :class_name => "Item"
+
+
+
+  # This method is a hack to provide a legitimate default value for
+  # the +flags+ field of an Item that hasn't been initialized yet.
+  # Alternative at http://blog.phusion.nl/2008/10/03/47/
+  def flags #:nodoc:
+    # Note that the default value returned here must/does match the
+    # column default specified in the database schema
+    self[:flags] or 0
+  end
+
+
+private
+
+  # This method performs checks to determine whether an individual
+  # Connection, if placed in the context of the rest of WontoMedia's
+  # database, would violate any rules about the structure of the
+  # relationship network.  It is automatically invoked using Rails'
+  # <tt>before_validation</tt> hook.  In the event that one or more
+  # checks fail, this method returns +false+ and places the
+  # appropriate message(s) in the +errors+ flash.
+  def complex_validations() #:doc:
+    [ [subject_id, :subject], [predicate_id, :predicate],
+      [obj_id, :obj] ].each do |tocheck|
+      field, symbol = *tocheck
+      if field.nil?
+        errors.add symbol, "can't be blank."
+        return false
+      end
+    end
+
+        # is there an existing connection with a predicate that is a
+        # sub-property or super-property of the current predicate?
+    # check for duplicate connection and all super-properties
+    TrippleNavigation.relation_and_all_superproperties(
+        predicate_id) do |super_prop|
+      unless (Connection.all( :conditions => [
+          "subject_id = ? AND predicate_id = ? AND obj_id = ?",
+          subject_id, super_prop, obj_id ] ).empty? )
+        errors.add :subject, 'relationship (or equivalent) already exists.'
+        return false
+      end
+    end
+
+    # check for sub-properties
+    TrippleNavigation.relation_and_all_subproperties(
+        predicate_id) do |sub_prop|
+      unless (Connection.all( :conditions => [
+          "subject_id = ? AND predicate_id = ? AND obj_id = ?",
+          subject_id, sub_prop, obj_id ] ).empty? )
+        errors.add :subject, 'equivalent relationship already exists.'
+        return false
+      end
+    end
+
+
+        # is there an existing implied opposing connection?
+    # find all connections back-connecting our subject and object, determine
+    # if any of their predicates has an (inherited)
+    # inverse_relationship to current predicate
+    if connections = Connection.all( :conditions => [
+        "subject_id = ? AND obj_id = ?", obj_id, subject_id ] )
+
+      inverse_id = Item.find_by_name("inverse_relationship").id
+
+      connections.each do |e|
+        TrippleNavigation.relation_and_all_superproperties(
+            predicate_id) do |proposed_rel|
+          TrippleNavigation.relation_and_all_superproperties(
+              e.predicate_id) do |existing_rel|
+            if Connection.all( :conditions => [
+              "subject_id = ? AND predicate_id = ? AND obj_id = ?",
+                proposed_rel, inverse_id, existing_rel ] ).length > 0
+              errors.add :subject, 'already has this relationship implied.'
+              return false
+            end
+          end
+        end
+      end
+    end
+
+
+    #used in many subsequent tests
+    spo_id  = Item.find_by_name("sub_property_of").id
+
+
+        # would this create an "individual parent_of category" relationship?
+    subItem = Item.find(subject_id)
+    objItem = Item.find(obj_id)
+    # check for "individual parent_of category"
+    if subItem.sti_type == ItemHelper::ITEM_INDIVIDUAL_CLASS_NAME  &&
+       objItem.sti_type == ItemHelper::ITEM_CATEGORY_CLASS_NAME
+      if TrippleNavigation.check_properties(
+          :does => predicate_id,
+          :inherit_from => Item.find_by_name("parent_of").id,
+          :via => spo_id)
+        errors.add :predicate,
+                   'an individual cannot be the parent of a category.'
+        return false
+      end
+    end
+
+    # check for "category child_of individual"
+    if subItem.sti_type == ItemHelper::ITEM_CATEGORY_CLASS_NAME  &&
+       objItem.sti_type == ItemHelper::ITEM_INDIVIDUAL_CLASS_NAME
+      if TrippleNavigation.check_properties(
+          :does => predicate_id,
+          :inherit_from => Item.find_by_name("child_of").id,
+          :via => spo_id)
+        errors.add :predicate,
+                   'a category cannot be the child of an individual.'
+        return false
+      end
+    end
+
+
+        # would this create a loop (including connection-to-self) of
+        # hierarchical or ordered relationships?
+    # if this is the kind of property we have to worry about?
+    [
+      Item.find_by_name("parent_of").id,
+      Item.find_by_name("child_of").id,
+      Item.find_by_name("sub_property_of").id,
+      Item.find_by_name("predecessor_of").id,
+      Item.find_by_name("successor_of").id
+    ].each do |prop_id|
+      if TrippleNavigation.check_properties(
+          :does => predicate_id, :inherit_from => prop_id, :via => spo_id)
+        if TrippleNavigation.check_properties(
+            :does => obj_id, :link_to => subject_id,
+            :through_children_of => prop_id )
+          errors.add :subject, 'this relationship would create a loop.'
+          return false
+        end
+      end
+    end
+
+        # is this a "bad" connection-to-self?
+    if subject_id == obj_id
+      [ "inverse_relationship", "hierarchical_relationship",
+        "ordered_relationship" ].each do |relation_name|
+        if TrippleNavigation.check_properties(
+            :does         => predicate_id,
+            :inherit_from => Item.find_by_name(relation_name).id,
+            :via          => spo_id  )
+          errors.add :subject,
+'cannot create an ordered/hierarchical relationship from an item to itself'
+          return false
+        end
+      end
+    end
+
+
+    true
+  end
+end

data/app/models/individual_item.rb

@@ -0,0 +1,23 @@
+#--
+# WontoMedia - a wontology web application
+# Copyright (C) 2010 - Glen E. Ivey
+#    www.wontology.com
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License version
+# 3 as published by the Free Software Foundation.
+#
+# 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program in the file COPYING and/or LICENSE.  If not,
+# see <http://www.gnu.org/licenses/>.
+#++
+
+
+# This model class is a child of Item using Rails' single-table inheritance.
+class IndividualItem < Item
+end

data/app/models/item.rb

@@ -0,0 +1,86 @@
+#--
+# WontoMedia - a wontology web application
+# Copyright (C) 2010 - Glen E. Ivey
+#    www.wontology.com
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License version
+# 3 as published by the Free Software Foundation.
+#
+# 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program in the file COPYING and/or LICENSE.  If not,
+# see <http://www.gnu.org/licenses/>.
+#++
+
+
+# Model for the representation of "items" (things that can be related
+# to each other through "connections") in WontoMedia's database.  The
+# schema listing the data fields for an Item is, of course, in
+# db/schema.rb.  And Rails' automatically-provided model methods are
+# based on the field names there.
+#
+# WontoMedia uses Rails' "single-table inheritance" to create several
+# specialized types of Item objects, all of which are stored in the
+# same database table together.  The type of object a particular table
+# row represents is determined by that object's <tt>sti_type</tt>
+# field.  There are a number of constants and methods in the module
+# ItemHelper that can be used load or evaluate +sti_type+ and to
+# perform generic operations on Item instances that correctly preserve
+# their child class.
+#
+# A great deal of this model's behavior is provided through Rails
+# validation methods (<tt>validates_...</tt>), see the source for
+# details.
+class Item < ActiveRecord::Base
+
+  # This constant is a bit mask for Item.flags.  A non-zero value
+  # indicates that the Item instance should not be user-modifiable.
+  DATA_IS_UNALTERABLE = 1
+
+
+  self.inheritance_column = "sti_type"
+
+    # name
+  validates_presence_of   :name, :message => "Item's name cannot be blank."
+  validates_length_of     :name, :maximum => 80,
+    :message => "Item name must be 80 characters or less."
+  validates_each          :name do |record, attr, value|
+    if !(value =~ /^[a-zA-Z][a-zA-Z0-9._:-]*$/m) ||
+        (value =~ /\n/m)
+      record.errors.add attr, "must start with a letter, and can contain only"\
+        "letters, numbers, and/or the period, colon, dash, and underscore."
+    end
+  end
+  validates_uniqueness_of :name, :message =>
+    "There is already a item with the same name."
+
+    # title
+  validates_presence_of   :title, :message => "Item's title cannot be blank."
+  validates_length_of     :title, :maximum => 255,
+    :message => "Item title must be 255 characters or less."
+  validates_each          :title do |record, attr, value|
+    if value =~ /[\n\t]/m
+      record.errors.add attr, "should not be multiple lines."
+    end
+  end
+
+  validates_length_of     :description, :maximum => 65000,
+    :allow_nil => true, :allow_blank => true,
+    :message => "Item description must be 65,000 characters or less."
+
+
+
+  # This method is a hack to provide a legitimate default value for
+  # the +flags+ field of an Item that hasn't been initialized yet.
+  # Alternative at http://blog.phusion.nl/2008/10/03/47/
+  def flags #:nodoc:
+    # Note that the default value returned here must/does match the
+    # column default specified in the database schema
+    self[:flags] or 0
+  end
+end