popolo 0.0.1 → 0.0.2

data/README.md

@@ -18,17 +18,19 @@ First, create your Rails application:
 
     rails new myapp --skip-active-record
 
-Add the `popolo` gem to your `Gemfile`:
+Add the `popolo` gem to your `Gemfile` and bundle your dependencies:
 
     gem 'popolo'
+    bundle
 
 If you didn't run `rails new` with the `--skip-active-record` option, follow Mongoid's [installation instructions](http://mongoid.org/en/mongoid/docs/installation.html). Otherwise:
 
     rails generate mongoid:config
 
-Finally, run the `popolo` generator:
+Finally, run the `popolo` generator and create the MongoDB indexes:
 
     rails generate popolo
+    bundle exec rake db:mongoid:create_indexes
 
 ## Bugs? Questions?
 

data/app/controllers/popolo/areas_controller.rb

@@ -16,11 +16,6 @@ module Popolo
       index!
     end
 
-    def show
-      @area = Area.find_by_slug_or_id(params[:id])
-      show!
-    end
-
     def nested_index
       @areas = @area.children
 

data/app/controllers/popolo/organizations_controller.rb

@@ -7,20 +7,15 @@ module Popolo
 
     respond_to :html, :json
     actions :index, :show
-    custom_actions collection: :nested_index, resource: :nested_show
+    custom_actions collection: :nested_index, resource: [:nested_show, :posts, :post]
 
-    before_filter :validate_path, only: [:nested_index, :nested_show]
+    before_filter :validate_path, only: [:nested_index, :nested_show, :posts, :post]
 
     def index
       @organizations = Organization.roots
       index!
     end
 
-    def show
-      @organization = Organization.find_by_slug_or_id(params[:id])
-      show!
-    end
-
     def nested_index
       @organizations = @organization.children
 
@@ -35,6 +30,14 @@ module Popolo
       end
     end
 
+    def posts
+      @posts = @organization.posts
+    end
+
+    def post
+      @post = Post.find_by(organization_id: @organization, slug: params[:id])
+    end
+
   protected
 
     # @raises [Mongoid::Errors::DocumentNotFound] if a resource is improperly nested

data/app/controllers/popolo/posts_controller.rb

@@ -3,10 +3,5 @@ module Popolo
     inherit_resources
     respond_to :html, :json
     actions :index, :show
-
-    def show
-      @post = Post.find_by_slug_or_id(params[:id])
-      show!
-    end
   end
 end

data/app/models/popolo/address.rb

@@ -10,18 +10,18 @@ module Popolo
     # The postal address.
     field :address, type: String
     # A voice telephone number.
-    field :voice, type: Integer
+    field :voice, type: String
     # A facsimile telephone number.
-    field :fax, type: Integer
+    field :fax, type: String
     # A mobile telephone number.
-    field :cell, type: Integer
+    field :cell, type: String
     # A toll-free telephone number.
-    field :tollfree, type: Integer
+    field :tollfree, type: String
     # A video conferencing telephone number.
-    field :video, type: Integer
+    field :video, type: String
     # A paging device telephone number.
-    field :pager, type: Integer
+    field :pager, type: String
     # A telecommunication device for people with hearing or speech difficulties.
-    field :textphone, type: Integer
+    field :textphone, type: String
   end
 end

data/app/models/popolo/post.rb

@@ -4,12 +4,8 @@ module Popolo
   class Post
     include Mongoid::Document
 
-    def self.slug_source
-      :role
-    end
-
     include Popolo::Sluggable
-    index({slug: 1}, unique: true)
+    index({slug: 1, organization_id: 1}, unique: true)
 
     # An area related to the post, e.g. an electoral riding.
     belongs_to :area, index: true, class_name: 'Popolo::Area'
@@ -20,6 +16,10 @@ module Popolo
     # The address at which the post is based.
     embeds_many :addresses, as: :addressable, class_name: 'Popolo::Address'
 
-    validates_presence_of :organization_id
+    # The role that the holder of the post fulfills. Roles should preferably
+    # belong to a controlled vocabulary.
+    field :role, type: String
+
+    validates_presence_of :role, :organization_id
   end
 end

data/app/views/popolo/addresses/_address.html.erb

@@ -0,0 +1,16 @@
+<section>
+  <% if address.type? %>
+  <header>
+    <%=t address.type, default: address.type %>
+  </header>
+  <% end %>
+  <% if address.voice? %>
+  <p>Phone: <%= address.voice %></p>
+  <% end %>
+  <% if address.fax? %>
+  <p>Fax: <%= address.fax %></p>
+  <% end %>
+  <% if address.address? %>
+  <%= simple_format address.address %>
+  <% end %>
+</section>

data/app/views/popolo/areas_or_organizations/_breadcrumb.html.erb

@@ -0,0 +1,13 @@
+<nav>
+  <ul class="breadcrumb">
+    <li><%= link_to resource_collection_name.capitalize, collection_path %> <span class="divider">/</span></li>
+<% ancestors = object.ancestors %>
+<% ancestors.each_with_index do |ancestor,index| %>
+    <li>
+      <%= link_to ancestor.name, nested_resource_path(ancestors[0..index]) %>
+      <span class="divider">/</span>
+    </li>
+<% end %>
+    <li class="active"><%= object.name %></li>
+  </ul>
+</nav>

data/app/views/popolo/areas_or_organizations/_index.html.erb

@@ -21,11 +21,11 @@
   <header>
     <h1><%= t(classification, scope: [:popolo, resource_collection_name, :classifications]) %></h1>
   </header>
-  <ul>
+  <ol>
     <% documents.each do |document| %>
     <li><%= link_to document.name, nested_resources_path([object, document].compact) %></li>
     <% end %>
-  </ul>
+  </ol>
 </section>
   <% end %>
 <% end %>

data/app/views/popolo/areas_or_organizations/_show.html.erb

@@ -1,16 +1,4 @@
-<nav>
-  <ul class="breadcrumb">
-    <li><%= link_to resource_collection_name.capitalize, collection_path %> <span class="divider">/</span></li>
-<% ancestors = object.ancestors %>
-<% ancestors.each_with_index do |ancestor,index| %>
-    <li>
-      <%= link_to ancestor.name, nested_resource_path(ancestors[0..index]) %>
-      <span class="divider">/</span>
-    </li>
-<% end %>
-    <li class="active"><%= object.name %></li>
-  </ul>
-</nav>
+<%= render partial: 'popolo/areas_or_organizations/breadcrumb', locals: {object: object} %>
 
 <% collection = object.children %>
 <% unless collection.empty? %>
@@ -20,11 +8,11 @@
   <header>
     <h1><%= t(classification, scope: [:popolo, resource_collection_name, :classifications]) %></h1>
   </header>
-  <ul>
+  <ol>
     <% documents.each do |document| %>
     <li><%= link_to document.name, nested_resource_path([object, document]) %></li>
     <% end %>
-  </ul>
+  </ol>
 </section>
   <% end %>
 <% end %>

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

@@ -0,0 +1,27 @@
+<%= render partial: 'popolo/areas_or_organizations/breadcrumb', locals: {object: @organization} %>
+
+<section>
+  <div class="media">
+    <% if @post.person && @post.person.image? %>
+    <span class="pull-left">
+      <%= image_tag(@post.person.image, class: 'media-object') %>
+    </span>
+    <% end %>
+    <div class="media-body">
+      <h4 class="media-heading"><%= @post.name %></h4>
+      <% if @post.person %>
+      <%= @post.person.name %>
+      <% end %>
+    </div>
+  </div>
+  <% if @post.person && @post.person.summary? %>
+  <p><%= @post.person.summary %></p>
+  <% end %>
+
+  <aside>
+    <% if @post.person && @post.person.email? %>
+    <p>Email: <%= mail_to @post.person.email %></p>
+    <% end %>
+    <%= render @post.addresses %>
+  </aside>
+</section>

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

@@ -0,0 +1,23 @@
+<%= render partial: 'popolo/areas_or_organizations/breadcrumb', locals: {object: @organization} %>
+
+<section>
+  <h1><%= @organization.name %></h1>
+
+  <ol class="media-list">
+    <% @posts.asc(:sort_name).each do |post| %>
+    <li class="media">
+      <% if post.person && post.person.image? %>
+      <span class="pull-left">
+        <%= image_tag(post.person.image, class: 'image-object') %>
+      </span>
+      <% end %>
+      <div class="media-body">
+        <h4 class="media-heading"><%= link_to post.name, nested_organization_post_path(@organization.ancestors_and_self, post) %></h4>
+        <% if post.person %>
+        <%= post.person.name %>
+        <% end %>
+      </div>
+    </li>
+    <% end %>
+  </ol>
+</section>

data/config/routes.rb

@@ -6,7 +6,10 @@ Popolo::Engine.routes.draw do
 
   match 'areas/*path/areas' => 'areas#nested_index', as: 'nested_areas'
   match 'areas/*path' => 'areas#nested_show', as: 'nested_area'
+
   match 'organizations/*path/organizations' => 'organizations#nested_index', as: 'nested_organizations'
+  match 'organizations/*path/posts/:id' => 'organizations#post', as: 'nested_organization_post'
+  match 'organizations/*path/posts' => 'organizations#posts', as: 'nested_organization_posts'
   match 'organizations/*path' => 'organizations#nested_show', as: 'nested_organization'
 
   # A host application will sometimes complain about a missing `root_path`, even

data/lib/popolo/mixins/sluggable.rb

@@ -10,6 +10,8 @@ module Popolo
       # The field used to sort the document.
       field :sort_name, type: String
 
+      index sort_name: 1
+
       validates_presence_of slug_source, :slug, :sort_name
 
       before_validation :set_slug_and_sort_name

data/lib/popolo/version.rb

@@ -1,3 +1,3 @@
 module Popolo
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/controllers/popolo/areas_controller_spec.rb

@@ -25,12 +25,6 @@ describe Popolo::AreasController do
       assigns(:area).should == @area
       response.should be_success
     end
-
-    it 'gets the requested area by slug' do
-      get :show, id: @area.slug
-      assigns(:area).should == @area
-      response.should be_success
-    end
   end
 
   describe 'GET nested_index' do

data/spec/controllers/popolo/organizations_controller_spec.rb

@@ -9,6 +9,7 @@ describe Popolo::OrganizationsController do
     @xyz           = @organization.children.create name: 'XYZ, Inc.'
     @department    = @xyz.children.create name: "Marketing Department"
     @branch        = @department.children.create name: "Youth Branch"
+    @post          = FactoryGirl.create :post, organization: @xyz
   end
 
   describe 'GET index' do
@@ -25,12 +26,6 @@ describe Popolo::OrganizationsController do
       assigns(:organization).should == @organization
       response.should be_success
     end
-
-    it 'gets the requested organization by slug' do
-      get :show, id: @organization.slug
-      assigns(:organization).should == @organization
-      response.should be_success
-    end
   end
 
   describe 'GET nested_index' do
@@ -56,4 +51,20 @@ describe Popolo::OrganizationsController do
       expect {get :nested_show, path: 'acme-corporation/abc-inc/marketing-department'}.to raise_error(Mongoid::Errors::DocumentNotFound)
     end
   end
+
+  describe 'GET posts' do
+    it 'assigns the requested posts as @posts' do
+      get :posts, path: 'acme-corporation/xyz-inc'
+      assigns(:posts).to_a.should == [@post]
+      response.should be_success
+    end
+  end
+
+  describe 'GET post' do
+    it 'assigns the requested post as @post' do
+      get :post, path: 'acme-corporation/xyz-inc', id: 'marketing-director'
+      assigns(:post).should == @post
+      response.should be_success
+    end
+  end
 end

data/spec/controllers/popolo/posts_controller_spec.rb

@@ -20,11 +20,5 @@ describe Popolo::PostsController do
       assigns(:post).should == @post
       response.should be_success
     end
-
-    it 'gets the requested post by slug' do
-      get :show, id: @post.slug
-      assigns(:post).should == @post
-      response.should be_success
-    end
   end
 end