popolo 0.0.1

data/config/routes.rb

@@ -0,0 +1,15 @@
+Popolo::Engine.routes.draw do
+  resources :areas, only: [:index, :show]
+  resources :organizations, only: [:index, :show]
+  resources :people, only: [:index, :show]
+  resources :posts, only: [:index, :show]
+
+  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' => 'organizations#nested_show', as: 'nested_organization'
+
+  # A host application will sometimes complain about a missing `root_path`, even
+  # if it defines a `root_path`. Setting a reasonable default here.
+  root to: 'organizations#index'
+end

data/lib/generators/popolo_generator.rb

@@ -0,0 +1,36 @@
+module Popolo
+  module Generators
+    # Run this generator once before using Popolo in your application.
+    #
+    # @example
+    #   rails generate popolo
+    class PopoloGenerator < Rails::Generators::Base
+      desc "Adds Popolo routes and rescues Mongoid exceptions."
+
+      namespace 'popolo'
+      source_root File.expand_path('../templates', __FILE__)
+
+      def add_routes
+        route "mount Popolo::Engine => '/'"
+      end
+
+      def add_rescue_from_block_to_application_controller
+        inject_into_class 'app/controllers/application_controller.rb', 'ApplicationController' do
+          <<-EOS
+  rescue_from Mongoid::Errors::DocumentNotFound do |exception|
+    respond_to do |format|
+      format.html { render file: Rails.root.join('public', '404.html'), status: :not_found, layout: false }
+      format.json { head :not_found }
+      format.atom { head :not_found }
+    end
+  end
+          EOS
+        end
+      end
+
+      def show_readme
+        readme 'README' if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1,7 @@
+Popolo by default adds its routes to the root path:
+
+    mount Popolo::Engine => '/'
+
+You can namespace its routes by changing the mount point:
+
+    mount Popolo::Engine => '/mynamespace'

data/lib/popolo/engine.rb

@@ -0,0 +1,7 @@
+require 'rails'
+
+module Popolo
+  class Engine < ::Rails::Engine
+    isolate_namespace Popolo
+  end
+end

data/lib/popolo/mixins/eventable.rb

@@ -0,0 +1,15 @@
+module Popolo
+  module Eventable
+    extend ActiveSupport::Concern
+
+    included do
+      embeds_many :sources, as: :sourceable, class_name: 'Popolo::Source'
+    end
+
+    # @note It's not possible to do a many-to-many polymorphic relation, so
+    #   we must create the relation manually.
+    def events
+      Event.where("related.#{self.class.name.demodulize.underscore}" => id)
+    end
+  end
+end

data/lib/popolo/mixins/sluggable.rb

@@ -0,0 +1,64 @@
+module Popolo
+  module Sluggable
+    extend ActiveSupport::Concern
+
+    included do
+      # The field used as the basis of the slug, usually the resource's name.
+      field slug_source, type: String
+      # A lowercase identifier composed of letters, numbers and dashes.
+      field :slug, type: String
+      # The field used to sort the document.
+      field :sort_name, type: String
+
+      validates_presence_of slug_source, :slug, :sort_name
+
+      before_validation :set_slug_and_sort_name
+    end
+
+    module ClassMethods
+      # Finds a resource by its slug or ID.
+      #
+      # @param [String] slug a slug or ID
+      # @return a matching resource
+      def find_by_slug_or_id(slug)
+        where(slug: slug.to_s.parameterize).first || find(slug)
+      end
+
+      # Finds a resource by its slug or raises an error.
+      #
+      # @param [String] slug a slug
+      # @param [Hash] opts conditions
+      # @return a matching resource
+      # @raises [Mongoid::Errors::DocumentNotFound] if not found
+      def find_by_slug(slug, opts = {})
+        find_by(opts.merge(slug: slug.parameterize))
+      end
+
+      # @private
+      def slug_source
+        if defined?(super)
+          super
+        else
+          :name
+        end
+      end
+    end
+
+    def to_param
+      slug
+    end
+
+  private
+
+    # @return [String] the value of the field used as the basis of the slug
+    def slug_source
+      send(self.class.slug_source)
+    end
+
+    # @note Leave it to the content manager to choose a slug in case of conflicts.
+    def set_slug_and_sort_name
+      self.slug ||= slug_source.parameterize if slug_source
+      self.sort_name ||= slug_source
+    end
+  end
+end

data/lib/popolo/version.rb

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

data/lib/popolo.rb

@@ -0,0 +1,18 @@
+require 'popolo/engine'
+
+require 'active_support/concern'
+require 'inherited_resources'
+require 'mongoid'
+require 'mongoid/tree'
+
+module Popolo
+  # The parent controller all Popolo controllers inherits from.
+  # Defaults to ApplicationController. This should be set early
+  # in the initialization process and should be set to a string.
+  #
+  # @see https://github.com/plataformatec/devise/blob/master/lib/devise.rb#L196
+  mattr_accessor :parent_controller
+  @@parent_controller = 'ApplicationController'
+end
+
+require 'popolo/mixins/sluggable'

data/spec/controllers/popolo/areas_controller_spec.rb

@@ -0,0 +1,59 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe Popolo::AreasController do
+  before :each do
+    @routes = Popolo::Engine.routes
+    @area       = FactoryGirl.create :area, name: 'Canada'
+    @ontario    = @area.children.create name: 'Ontario'
+    @quebec     = @area.children.create name: 'Québec'
+    @montreal   = @quebec.children.create name: 'Montréal'
+    @villemarie = @montreal.children.create name: 'Ville-Marie'
+  end
+
+  describe 'GET index' do
+    it 'assigns all areas as @areas' do
+      get :index
+      assigns(:areas).to_a.should == [@area]
+      response.should be_success
+    end
+  end
+
+  describe 'GET show' do
+    it 'assigns the requested area as @area' do
+      get :show, id: @area.id.to_s
+      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
+    it 'succeeds if properly nested' do
+      get :nested_index, path: 'canada/quebec/montreal'
+      assigns(:areas).to_a.should == [@villemarie]
+      response.should be_success
+    end
+
+    it 'fails if improperly nested' do
+      expect {get :nested_index, path: 'canada/ontario/montreal'}.to raise_error(Mongoid::Errors::DocumentNotFound)
+    end
+  end
+
+  describe 'GET nested_show' do
+    it 'succeeds if properly nested' do
+      get :nested_show, path: 'canada/quebec/montreal'
+      assigns(:area).should == @montreal
+      response.should be_success
+    end
+
+    it 'fails if improperly nested' do
+      expect {get :nested_show, path: 'canada/ontario/montreal'}.to raise_error(Mongoid::Errors::DocumentNotFound)
+    end
+  end
+end

data/spec/controllers/popolo/organizations_controller_spec.rb

@@ -0,0 +1,59 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe Popolo::OrganizationsController do
+  before :each do
+    @routes = Popolo::Engine.routes
+    @organization  = FactoryGirl.create :organization, name: 'Acme Corporation'
+    @abc           = @organization.children.create name: 'ABC, Inc.'
+    @xyz           = @organization.children.create name: 'XYZ, Inc.'
+    @department    = @xyz.children.create name: "Marketing Department"
+    @branch        = @department.children.create name: "Youth Branch"
+  end
+
+  describe 'GET index' do
+    it 'assigns all organizations as @organizations' do
+      get :index
+      assigns(:organizations).to_a.should == [@organization]
+      response.should be_success
+    end
+  end
+
+  describe 'GET show' do
+    it 'assigns the requested organization as @organization' do
+      get :show, id: @organization.id.to_s
+      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
+    it 'succeeds if properly nested' do
+      get :nested_index, path: 'acme-corporation/xyz-inc/marketing-department'
+      assigns(:organizations).to_a.should == [@branch]
+      response.should be_success
+    end
+
+    it 'fails if improperly nested' do
+      expect {get :nested_index, path: 'acme-corporation/abc-inc/marketing-department'}.to raise_error(Mongoid::Errors::DocumentNotFound)
+    end
+  end
+
+  describe 'GET nested_show' do
+    it 'succeeds if properly nested' do
+      get :nested_show, path: 'acme-corporation/xyz-inc/marketing-department'
+      assigns(:organization).should == @department
+      response.should be_success
+    end
+
+    it 'fails if improperly nested' do
+      expect {get :nested_show, path: 'acme-corporation/abc-inc/marketing-department'}.to raise_error(Mongoid::Errors::DocumentNotFound)
+    end
+  end
+end

data/spec/controllers/popolo/people_controller_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Popolo::PeopleController do
+  before :each do
+    @routes = Popolo::Engine.routes
+    @person = FactoryGirl.create :person
+  end
+
+  describe 'GET index' do
+    it 'assigns all people as @people' do
+      get :index
+      assigns(:people).to_a.should == [@person]
+      response.should be_success
+    end
+  end
+
+  describe 'GET show' do
+    it 'assigns the requested person as @person' do
+      get :show, id: @person.id.to_s
+      assigns(:person).should == @person
+      response.should be_success
+    end
+
+    it 'gets the requested person by slug' do
+      get :show, id: @person.slug
+      assigns(:person).should == @person
+      response.should be_success
+    end
+  end
+end

data/spec/controllers/popolo/posts_controller_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Popolo::PostsController do
+  before :each do
+    @routes = Popolo::Engine.routes
+    @post = FactoryGirl.create :post
+  end
+
+  describe 'GET index' do
+    it 'assigns all posts as @posts' do
+      get :index
+      assigns(:posts).to_a.should == [@post]
+      response.should be_success
+    end
+  end
+
+  describe 'GET show' do
+    it 'assigns the requested post as @post' do
+      get :show, id: @post.id.to_s
+      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

data/spec/controllers/popolo_controller_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe PopoloController do
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/cat.rb

@@ -0,0 +1,6 @@
+class Cat
+  include Mongoid::Document
+
+  include Popolo::Sluggable
+  index({slug: 1}, unique: true)
+end

data/spec/dummy/app/models/dog.rb

@@ -0,0 +1,10 @@
+class Dog
+  include Mongoid::Document
+
+  def self.slug_source
+    :moniker
+  end
+
+  include Popolo::Sluggable
+  index({slug: 1}, unique: true)
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config/application.rb

@@ -0,0 +1,62 @@
+require File.expand_path('../boot', __FILE__)
+
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "active_resource/railtie"
+require "sprockets/railtie"
+
+Bundler.require
+require "popolo"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    # config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Raise exception on mass assignment protection for Active Record models
+  # config.active_record.mass_assignment_sanitizer = :strict
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  # config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,67 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to nil and saved in location specified by config.assets.prefix
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Prepend all log lines with the following tags
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  # config.active_record.auto_explain_threshold_in_seconds = 0.5
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Raise exception on mass assignment protection for Active Record models
+  # config.active_record.mass_assignment_sanitizer = :strict
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end