popolo 0.0.2 → 0.0.3

data/app/models/popolo/identifier.rb

@@ -3,7 +3,7 @@ module Popolo
   class Identifier
     include Mongoid::Document
 
-    embedded_in :organization, class_name: 'Popolo::Organization'
+    embedded_in :identifiable, polymorphic: true
 
     # An issued identifier, e.g. a DUNS number.
     field :identifier, type: String

data/app/models/popolo/link.rb

@@ -1,16 +1,20 @@
 module Popolo
-  # A URL for a document about a person.
+  # A URL.
   class Link
     include Mongoid::Document
 
-    embedded_in :person, class_name: 'Popolo::Person'
+    embedded_in :linkable, polymorphic: true
 
-    # A URL for a document about a person.
+    # A URL.
     field :url, type: String
     # A note, e.g. 'Wikipedia page'.
     field :note, type: String
 
     validates_presence_of :url
     # @note Add URL validation to match JSON Schema?
+
+    def to_s
+      note || url
+    end
   end
 end

data/app/models/popolo/membership.rb

@@ -2,24 +2,49 @@ module Popolo
   # A relationship between a person and an organization.
   class Membership
     include Mongoid::Document
+    include Mongoid::Timestamps
 
-    # An area related to the membership, e.g. an electoral riding.
+    store_in Popolo.storage_options_per_class.fetch(:Membership, Popolo.storage_options)
+
+    # The geographic area to which the membership is related.
     belongs_to :area, index: true, class_name: 'Popolo::Area'
     # The person who is a party to the relationship.
-    belongs_to :organization, index: true, class_name: 'Popolo::Organization'
-    # The organization that is a party to the relationship.
     belongs_to :person, index: true, class_name: 'Popolo::Person'
+    # The organization that is a party to the relationship.
+    belongs_to :organization, index: true, class_name: 'Popolo::Organization'
+    # The organization on whose behalf the person is a party to the relationship.
+    belongs_to :on_behalf_of, index: true, class_name: 'Popolo::Organization'
+    # The post held by the person in the organization through this membership.
+    belongs_to :post, index: true, class_name: 'Popolo::Post'
+    # Means of contacting the person who is a party to the relationship.
+    embeds_many :contact_details, as: :contactable, class_name: 'Popolo::ContactDetail'
+    # URLs to documents about the membership.
+    embeds_many :links, as: :linkable, class_name: 'Popolo::Link'
+    # URLs to documents from which the membership is derived.
+    embeds_many :sources, as: :linkable, class_name: 'Popolo::Link'
 
-    # The role that the person fulfills in the organization. Roles should
-    # preferably belong to a controlled vocabulary.
+    # A label describing the membership.
+    field :label, type: String
+    # The role that the person fulfills in the organization.
     field :role, type: String
     # The date on which the relationship began.
-    field :start_date, type: String
+    field :start_date, type: DateString
     # The date on which the relationship ended.
-    field :end_date, type: String
+    field :end_date, type: DateString
 
     validates_presence_of :organization_id, :person_id
-    validates_format_of :start_date, with: /\A\d{4}(-\d{2}){0,2}\z/, allow_blank: true
-    validates_format_of :end_date, with: /\A\d{4}(-\d{2}){0,2}\z/, allow_blank: true
+    validates_format_of :start_date, with: DATE_STRING_FORMAT, allow_blank: true
+    validates_format_of :end_date, with: DATE_STRING_FORMAT, allow_blank: true
+
+    def to_s(options = {})
+      label || case options[:format]
+      when :person
+        person.to_s
+      when :organization
+        organization.to_s
+      else
+        "#{organization.to_s} / #{person.to_s}"
+      end
+    end
   end
 end

data/app/models/popolo/motion.rb

@@ -0,0 +1,37 @@
+module Popolo
+  # A formal step to introduce a matter for consideration by an organization.
+  class Motion
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    store_in Popolo.storage_options_per_class.fetch(:Motion, Popolo.storage_options)
+
+    # The organization in which the motion is proposed.
+    belongs_to :organization, class_name: 'Popolo::Organization'
+    # The legislative session in which the motion is proposed.
+    # @todo belongs to :legislative_session, class_name: 'Popolo::Event'
+    # The person who proposed the motion.
+    belongs_to :creator, class_name: 'Popolo::Person'
+    # Events at which people vote on the motion.
+    has_many :vote_events, class_name: 'Popolo::VoteEvent', dependent: :destroy
+    # URLs to documents from which the motion is derived.
+    embeds_many :sources, as: :linkable, class_name: 'Popolo::Link'
+
+    # The transcript or text of the motion.
+    field :text, type: String
+    # A motion category, e.g. adjournment.
+    field :classification, type: String
+    # The date on which the motion was proposed.
+    field :date, type: DateString
+    # The requirement for the motion to be adopted.
+    field :requirement, type: String
+    # The result of the motion.
+    field :result, type: String
+
+    validates_format_of :date, with: DATE_STRING_FORMAT, allow_blank: true
+
+    def to_s
+      text.to_s[0...140]
+    end
+  end
+end

data/app/models/popolo/organization.rb

@@ -1,32 +1,53 @@
 module Popolo
   # A group with a common purpose or reason for existence that goes beyond the
-  # set of people belonging to it, e.g. a political structure.
+  # set of people belonging to it.
   class Organization
     include Mongoid::Document
+    include Mongoid::Timestamps
     include Mongoid::Tree
 
-    include Popolo::Sluggable
-    index({slug: 1, parent_id: 1}, unique: true)
+    store_in Popolo.storage_options_per_class.fetch(:Organization, Popolo.storage_options)
 
-    # An area related to the organization, e.g. a region or country.
+    # The geographic area to which the organization is related.
     belongs_to :area, index: true, class_name: 'Popolo::Area'
     # The relationships to which the organization is a party.
-    has_many :memberships, class_name: 'Popolo::Membership', dependent: :destroy
-    # The posts within the organization.
+    has_many :memberships, class_name: 'Popolo::Membership', dependent: :destroy, inverse_of: :organization
+    # The organization in which the motion is proposed.
+    has_many :motions, class_name: 'Popolo::Motion', dependent: :destroy
+    # Posts within the organization.
     has_many :posts, class_name: 'Popolo::Post', dependent: :destroy
-    # The organization's alternate or former names.
+    # The organization whose members are voting.
+    has_many :vote_events, class_name: 'Popolo::VoteEvent', dependent: :destroy
+    # The organization that is voting.
+    has_many :votes, as: :voter, class_name: 'Popolo::Vote'
+    # Alternate or former names.
     embeds_many :other_names, as: :nameable, class_name: 'Popolo::OtherName'
-    # The organization's issued identifiers.
-    embeds_many :identifiers, class_name: 'Popolo::Identifier'
+    # Issued identifiers.
+    embeds_many :identifiers, as: :identifiable, class_name: 'Popolo::Identifier'
+    # Means of contacting the organization.
+    embeds_many :contact_details, as: :contactable, class_name: 'Popolo::ContactDetail'
+    # URLs to documents about the organization.
+    embeds_many :links, as: :linkable, class_name: 'Popolo::Link'
+    # URLs to documents from which the organization is derived.
+    embeds_many :sources, as: :linkable, class_name: 'Popolo::Link'
 
-    # The organization's category.
+    # A primary name, e.g. a legally recognized name.
+    field :name, type: String
+    # An organization category, e.g. committee.
     field :classification, type: String
-    # The organization's date of founding in ISO 8601:2004 format.
-    field :founding_date, type: String
-    # The organization's date of dissolution in ISO 8601:2004 format.
-    field :dissolution_date, type: String
+    # A date of founding.
+    field :founding_date, type: DateString
+    # A date of dissolution.
+    field :dissolution_date, type: DateString
+    # A URL of an image.
+    field :image, type: String
 
-    validates_format_of :founding_date, with: /\A\d{4}(-\d{2}){0,2}\z/, allow_blank: true
-    validates_format_of :dissolution_date, with: /\A\d{4}(-\d{2}){0,2}\z/, allow_blank: true
+    validates_format_of :founding_date, with: DATE_STRING_FORMAT, allow_blank: true
+    validates_format_of :dissolution_date, with: DATE_STRING_FORMAT, allow_blank: true
+    # @note Add URL validation to match JSON Schema?
+
+    def to_s
+      name
+    end
   end
 end

data/app/models/popolo/other_name.rb

@@ -8,14 +8,14 @@ module Popolo
     # An alternate or former name.
     field :name, type: String
     # The date on which the name was adopted.
-    field :start_date, type: String
+    field :start_date, type: DateString
     # The date on which the name was abandoned.
-    field :end_date, type: String
-    # A note, e.g. "Birth name".
+    field :end_date, type: DateString
+    # A note, e.g. 'Birth name'.
     field :note, type: String
 
     validates_presence_of :name
-    validates_format_of :start_date, with: /\A\d{4}(-\d{2}){0,2}\z/, allow_blank: true
-    validates_format_of :end_date, with: /\A\d{4}(-\d{2}){0,2}\z/, allow_blank: true
+    validates_format_of :start_date, with: DATE_STRING_FORMAT, allow_blank: true
+    validates_format_of :end_date, with: DATE_STRING_FORMAT, allow_blank: true
   end
 end

data/app/models/popolo/person.rb

@@ -2,48 +2,78 @@ module Popolo
   # A real person, alive or dead.
   class Person
     include Mongoid::Document
+    include Mongoid::Timestamps
 
-    include Popolo::Sluggable
-    index({slug: 1}, unique: true)
+    store_in Popolo.storage_options_per_class.fetch(:Person, Popolo.storage_options)
 
     # The relationships to which the person is a party.
-    has_many :memberships, class_name: 'Popolo::Membership'
-    # The posts held by the person.
-    has_many :posts, class_name: 'Popolo::Post'
-    # The person's alternate or former names.
+    has_many :memberships, class_name: 'Popolo::Membership', dependent: :destroy
+    # The person who proposed the motion.
+    has_many :motions, class_name: 'Popolo::Motion'
+    # The person that is voting.
+    has_many :votes, as: :voter, class_name: 'Popolo::Vote'
+    # Alternate or former names.
     embeds_many :other_names, as: :nameable, class_name: 'Popolo::OtherName'
-    # Links to pages about this person, e.g. Wikipedia, or to accounts this
-    # person has on other websites, e.g. Twitter.
-    embeds_many :links, class_name: 'Popolo::Link'
+    # Issued identifiers.
+    embeds_many :identifiers, as: :identifiable, class_name: 'Popolo::Identifier'
+    # Means of contacting the person.
+    embeds_many :contact_details, as: :contactable, class_name: 'Popolo::ContactDetail'
+    # URLs to documents about the person.
+    embeds_many :links, as: :linkable, class_name: 'Popolo::Link'
+    # URLs to documents from which the person is derived.
+    embeds_many :sources, as: :linkable, class_name: 'Popolo::Link'
 
-    # The person's family name.
+    # A person's preferred full name.
+    field :name, type: String
+    # One or more family names.
     field :family_name, type: String
-    # The person's given name.
+    # One or more primary given names.
     field :given_name, type: String
-    # An additional name, e.g. a middle name.
+    # One or more secondary given names.
     field :additional_name, type: String
-    # An honorific prefix before the person's name, e.g. "Dr.".
+    # One or more honorifics preceding a person's name.
     field :honorific_prefix, type: String
-    # An honorific suffix after the person's name, e.g. "Jr.".
+    # One or more honorifics following a person's name.
     field :honorific_suffix, type: String
-    # The person's email address.
+    # One or more patronymic names.
+    field :patronymic_name, type: String
+    # A name to use in an lexicographically ordered list.
+    field :sort_name, type: String
+    # A preferred email address.
     field :email, type: String
-    # The person's gender, e.g. "male", "female" or another value.
+    # A gender.
     field :gender, type: String
-    # The person's date of birth in ISO 8601:2004 format.
-    field :birth_date, type: String
-    # The person's date of death in ISO 8601:2004 format.
-    field :death_date, type: String
-    # The URL of the person's head shot.
+    # A date of birth.
+    field :birth_date, type: DateString
+    # A date of death.
+    field :death_date, type: DateString
+    # A URL of a head shot.
     field :image, type: String
-    # The person's one-line biography.
+    # A one-line account of a person's life.
     field :summary, type: String
-    # The person's extended biography.
+    # An extended account of a person's life.
     field :biography, type: String
+    # A national identity.
+    field :national_identity, type: String
 
-    # @note Add email address validation to match JSON Schema?
-    # @note Add URL validation to match JSON Schema?
-    validates_format_of :birth_date, with: /\A\d{4}(-\d{2}){0,2}\z/, allow_blank: true
-    validates_format_of :death_date, with: /\A\d{4}(-\d{2}){0,2}\z/, allow_blank: true
+    validates_format_of :birth_date, with: DATE_STRING_FORMAT, allow_blank: true
+    validates_format_of :death_date, with: DATE_STRING_FORMAT, allow_blank: true
+    # @note Add email address validation and URL validation to match JSON Schema?
+
+    def to_s
+      if name.blank?
+        if given_name.present? && family_name.present?
+          "#{given_name} #{family_name}"
+        elsif given_name.present?
+          given_name
+        elsif family_name.present?
+          family_name
+        else
+          name
+        end
+      else
+        name
+      end
+    end
   end
 end

data/app/models/popolo/post.rb

@@ -1,25 +1,39 @@
 module Popolo
-  # A position in an organization that exists independently of the person
-  # holding it.
+  # A position that exists independent of the person holding it.
   class Post
     include Mongoid::Document
+    include Mongoid::Timestamps
 
-    include Popolo::Sluggable
-    index({slug: 1, organization_id: 1}, unique: true)
+    store_in Popolo.storage_options_per_class.fetch(:Post, Popolo.storage_options)
 
-    # An area related to the post, e.g. an electoral riding.
+    # The geographic area to which the post is related.
     belongs_to :area, index: true, class_name: 'Popolo::Area'
-    # The organization in which the post exists.
+    # The organization in which the post is held.
     belongs_to :organization, index: true, class_name: 'Popolo::Organization'
-    # The person holding the post.
-    belongs_to :person, index: true, class_name: 'Popolo::Person'
-    # The address at which the post is based.
-    embeds_many :addresses, as: :addressable, class_name: 'Popolo::Address'
+    # The memberships through which people hold the post in the organization.
+    has_many :memberships, class_name: 'Popolo::Membership'
+    # Means of contacting the holder of the post.
+    embeds_many :contact_details, as: :contactable, class_name: 'Popolo::ContactDetail'
+    # URLs to documents about the post.
+    embeds_many :links, as: :linkable, class_name: 'Popolo::Link'
+    # URLs to documents from which the post is derived.
+    embeds_many :sources, as: :linkable, class_name: 'Popolo::Link'
 
-    # The role that the holder of the post fulfills. Roles should preferably
-    # belong to a controlled vocabulary.
+    # A label describing the post.
+    field :label, type: String
+    # The function that the holder of the post fulfills.
     field :role, type: String
+    # The date on which the post was created.
+    field :start_date, type: DateString
+    # The date on which the post was eliminated.
+    field :end_date, type: DateString
 
-    validates_presence_of :role, :organization_id
+    validates_presence_of :organization_id
+    validates_format_of :start_date, with: DATE_STRING_FORMAT, allow_blank: true
+    validates_format_of :end_date, with: DATE_STRING_FORMAT, allow_blank: true
+
+    def to_s
+      label
+    end
   end
 end

data/app/models/popolo/vote.rb

@@ -0,0 +1,28 @@
+module Popolo
+  # A voter's vote in a vote event.
+  class Vote
+    include Mongoid::Document
+
+    store_in Popolo.storage_options_per_class.fetch(:Vote, Popolo.storage_options)
+
+    # A vote event.
+    belongs_to :vote_event, class_name: 'Popolo::VoteEvent'
+    # The person or organization that is voting.
+    belongs_to :voter, polymorphic: true
+    # The voter's primary political group.
+    belongs_to :group, class_name: 'Popolo::Organization'
+    # The person with whom the voter is paired.
+    belongs_to :pair, class_name: 'Popolo::Person'
+
+    # The option chosen by the voter, whether actively or passively.
+    field :option, type: String
+    # The voter's role in the event.
+    field :role, type: String
+    # The weight of the voter's vote.
+    field :weight, type: Float, default: 1.0
+
+    def to_s
+      "#{voter.name}: #{option}"
+    end
+  end
+end

data/app/models/popolo/vote_event.rb

@@ -0,0 +1,35 @@
+module Popolo
+  # An event at which people's votes are recorded.
+  class VoteEvent
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    store_in Popolo.storage_options_per_class.fetch(:VoteEvent, Popolo.storage_options)
+
+    # The organization whose members are voting.
+    belongs_to :organization, class_name: 'Popolo::Organization'
+    # The legislative session in which the vote occurs.
+    # @todo belongs to :legislative_session, class_name: 'Popolo::Event'
+    # The motion being decided.
+    belongs_to :motion, class_name: 'Popolo::Motion'
+    # The result of the vote event within groups of voters.
+    embeds_many :group_results, class_name: 'Popolo::GroupResult'
+    # The number of votes for options.
+    has_many :counts, class_name: 'Popolo::Count', dependent: :destroy
+    # Voters' votes.
+    has_many :votes, class_name: 'Popolo::Vote', dependent: :destroy
+
+    # An issued identifier.
+    field :identifier, type: String
+    # The date on which the relationship began.
+    field :start_date, type: DateTime
+    # The date on which the relationship ended.
+    field :end_date, type: DateTime
+    # The result of the vote event.
+    field :result, type: String
+
+    def to_s
+      identifier
+    end
+  end
+end

data/app/views/popolo/contact_details/_contact_detail.html.erb

@@ -0,0 +1,17 @@
+<dt>
+  <% if contact_detail.label? %>
+    <%= contact_detail.label %>
+  <% else %>
+    <%=t contact_detail.type, scope: [:popolo, :contact_details, :types], default: contact_detail.type %>
+  <% end %>
+</dt>
+<dd>
+  <% if contact_detail.type == 'email' %>
+    <%= mail_to contact_detail.value %>
+  <% else %>
+    <%= contact_detail.value %>
+  <% end %>
+  <% if contact_detail.note? %>
+    <span class="label label-info"><%= contact_detail.note %></span>
+  <% end %>
+</dd>

data/app/views/popolo/identifiers/_identifier.html.erb

@@ -0,0 +1,2 @@
+<dt><%= identifier.scheme %></dt>
+<dd><%= identifier.identifier %></dd>

data/app/views/popolo/links/_link.html.erb

@@ -0,0 +1 @@
+<li><%= link_to link, link.url %></li>

data/app/views/popolo/memberships/show.html.erb

@@ -0,0 +1,81 @@
+<nav>
+  <ol class="breadcrumb">
+    <li><%= link_to Popolo::Organization.model_name.human(count: Float::INFINITY), organizations_path %></li>
+    <% @membership.organization.ancestors_and_self.each do |ancestor| %>
+      <li><%= link_to ancestor, ancestor %></li>
+    <% end %>
+    <li class="active"><%= @membership %></li>
+  </ol>
+</nav>
+
+<section>
+  <header class="page-header">
+    <div class="media">
+      <div class="media-body">
+        <h1 class="media-heading">
+          <%= @membership %>
+        </h1>
+      </div>
+    </div>
+  </header>
+
+  <dl>
+    <dt><%= Popolo::Membership.human_attribute_name(:organization) %></dt>
+    <dd><%= link_to @membership.organization, @membership.organization %></dd>
+    <dt><%= Popolo::Membership.human_attribute_name(:person) %></dt>
+    <dd><%= link_to @membership.person, @membership.person %></dd>
+    <% if @membership.on_behalf_of? %>
+      <dt><%= Popolo::Membership.human_attribute_name(:on_behalf_of) %></dt>
+      <dd><%= link_to @membership.on_behalf_of, @membership.on_behalf_of %></dd>
+    <% end %>
+    <% if @membership.post? %>
+      <dt><%= Popolo::Membership.human_attribute_name(:post) %></dt>
+      <dd><%= link_to @membership.post, @membership.post %></dd>
+    <% end %>
+    <% if @membership.role? %>
+      <dt><%= Popolo::Membership.human_attribute_name(:role) %></dt>
+      <dd><%= @membership.role %></dd>
+    <% end %>
+    <% if @membership.start_date? %>
+      <dt><%= Popolo::Membership.human_attribute_name(:start_date) %></dt>
+      <dd><%=l @membership.start_date %></dd>
+    <% end %>
+    <% if @membership.end_date? %>
+      <dt><%= Popolo::Membership.human_attribute_name(:end_date) %></dt>
+      <dd><%=l @membership.end_date %></dd>
+    <% end %>
+  </dl>
+
+  <aside>
+    <% unless @membership.contact_details.empty? %>
+      <section>
+        <header>
+          <h2><%= Popolo::ContactDetail.model_name.human(count: @membership.contact_details.size) %></h2>
+        </header>
+        <dl class="dl-horizontal">
+          <%= render @membership.contact_details %>
+        </dl>
+      </section>
+    <% end %>
+    <% unless @membership.links.empty? %>
+      <section>
+        <header>
+          <h2><%= Popolo::Link.model_name.human(count: @membership.links.size) %></h2>
+        </header>
+        <ul>
+          <%= render @membership.links %>
+        </ul>
+      </section>
+    <% end %>
+    <% unless @membership.sources.empty? %>
+      <section>
+        <header>
+          <h2><%=t 'popolo/source', count: @membership.sources.size, scope: [:popolo]  %></h2>
+        </header>
+        <ul>
+          <%= render @membership.sources %>
+        </ul>
+      </section>
+    <% end %>
+  </aside>
+</section>

data/app/views/popolo/organizations/index.html.erb

@@ -1 +1,16 @@
-<%= render partial: 'popolo/areas_or_organizations/index', locals: {collection: @organizations, object: @organization} %>
+<% @organizations.group_by(&:classification).each do |classification,organizations| %>
+  <section>
+    <header>
+      <h1>
+        <%=t classification, count: organizations.size, scope: [:popolo, :organizations, :classifications], default: classification %>
+      </h1>
+    </header>
+    <ol>
+      <% organizations.each do |organization| %>
+        <li>
+          <%= link_to organization, organization %>
+        </li>
+      <% end %>
+    </ol>
+  </section>
+<% end %>