motiro 0.6.3

data/app/controllers/account_controller.rb

@@ -0,0 +1,62 @@
+#  Motiro - A project tracking tool
+#  Copyright (C) 2006-2007  Thiago Arrais
+#  
+#  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 2 of the License, or
+#  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, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+class AccountController < ApplicationController
+  layout  'scaffold'
+  
+  verify :method => :post, :only => [:signup],
+         :redirect_to => {:controller => 'root', :action => 'index'}
+
+  def authorization
+    render :layout => false
+  end
+  
+  def login
+    case request.method
+      when :post
+      unless session[:user] = User.authenticate( params[:user][:login],
+                                             params[:user][:password] )
+        flash[:login_failure]  = true
+      end
+      redirect_back_or_default params[:return_to]
+    end
+  end
+  
+  def signup
+    user = User.new(params[:user])
+      
+    if user.save
+      session[:user] = User.authenticate( params[:user][:login],
+                                          params[:user][:password] )
+
+    else
+      flash[:desired_login] = params[:user][:login]
+    end
+
+    redirect_back_or_default params[:return_to]
+  end
+  
+  def availability
+    render :layout => false
+  end
+  
+  def logout
+    session[:user] = nil
+    redirect_back_or_default params[:return_to]
+  end
+    
+end

data/app/controllers/application.rb

@@ -0,0 +1,72 @@
+#  Motiro - A project tracking tool
+#  Copyright (C) 2006-2007  Thiago Arrais
+#  
+#  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 2 of the License, or
+#  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, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+require_dependency "login_system"
+require "translator"
+require 'string_extensions'
+
+# Filters added to this controller will be run for all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+class ApplicationController < ActionController::Base
+  include LoginSystem
+  include ApplicationHelper
+  
+  before_filter :set_locale, :setup_renderer, :check_desired_login_available, :drop_top_crumbs
+  
+  def set_locale
+    default_locale = 'en-US'
+    request_language = request.env['HTTP_ACCEPT_LANGUAGE']
+    request_language = request_language.nil? ? nil : request_language[/[^,;]+/]
+    
+    @locale = params[:locale] || session[:locale] ||
+              request_language || default_locale
+    session[:locale] = @locale
+    begin
+      Locale.set @locale
+    rescue
+      @locale = default_locale
+      Locale.set @locale
+    end
+  end
+  
+  def setup_renderer
+    @renderer = create_renderer
+  end
+  
+  def check_desired_login_available
+    if current_user.nil?
+      desired_login = params[:desired_login] || flash[:desired_login]
+      @login_not_available = ! User.find_by_login(desired_login).nil?
+    end
+    true
+  end
+  
+  def drop_top_crumbs
+    @crumbs = [{ 'Home'.t => {:controller => 'root', :action => 'index'} }]
+  end
+  
+private
+  
+  def create_renderer
+    WikiRenderer.new(my_url_generator, current_locale)
+  end
+
+  def my_url_generator
+    @url_generator ||= WikiUrlGenerator.new(self)
+  end
+  
+end

data/app/controllers/edition_controller.rb

@@ -0,0 +1,13 @@
+class EditionController < ApplicationController
+
+  def save
+    if params['btnSave']
+      do_save
+    else
+      redirect_to :controller => 'root', :action => 'index'
+    end
+  end
+  
+  def do_save; end
+
+end

data/app/controllers/javascript_controller.rb

@@ -0,0 +1,21 @@
+#  Motiro - A project tracking tool
+#  Copyright (C) 2006-2007  Thiago Arrais
+#  
+#  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 2 of the License, or
+#  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, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+# Placeholder controller for javascript templates
+class JavascriptController < ApplicationController
+  caches_page :motiro, :niftycube
+end

data/app/controllers/report_controller.rb

@@ -0,0 +1,79 @@
+#  Motiro - A project tracking tool
+#  Copyright (C) 2006-2007  Thiago Arrais
+#  
+#  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 2 of the License, or
+#  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, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+require 'models/headline'
+
+require_dependency 'core/chief_editor'
+
+class ReportController < ApplicationController
+  
+  layout :determine_layout
+  
+  before_filter do |me|
+    me.instance_eval do
+      @name = params[:reporter]
+      @reporter = @chief_editor.reporter_with(@name)
+    end
+  end
+
+  before_filter(:only => [:rss, :list]) do |me|
+    me.instance_eval do
+      @headlines = @chief_editor.latest_news_from @name
+    end
+  end
+  
+  before_filter :drop_crumbs
+  
+  def initialize(chief_editor=ChiefEditor.new)
+    @chief_editor = chief_editor
+  end
+  
+  def determine_layout
+    return 'application' if params[:id] or
+                            params[:action] == 'older'
+    return nil
+  end
+  
+  def drop_crumbs
+    @crumbs << { @reporter.channel_title =>
+                 {:controller => 'report', :action => 'older',
+                  :reporter => @name}}
+  end
+  
+  def older
+    @headlines = @chief_editor.news_from @name
+  end
+  
+  def show
+    id = params[:id]
+    
+    @revision_id = id
+    @headline = @chief_editor.headline_with(@name, id)
+    
+    unless @headline
+      logger.error("Tried to access invalid headline #{id} from #{@name}")
+      flash[:notice] = 'The article %s from the %s reporter could not be found' / id / @name.capitalize
+      redirect_to(:controller => 'root', :action => 'index')
+      return
+    end            
+
+    @crumbs << { @headline.title(Translator.for(@locale)) =>
+                 {:controller => 'report', :action => 'show',
+                  :reporter => @name, :id => @headline.rid}}
+  end
+  
+end

data/app/controllers/root_controller.rb

@@ -0,0 +1,7 @@
+require 'core/reporter_fetcher'
+
+class RootController < ApplicationController
+
+  before_filter :store_location
+  
+end

data/app/controllers/wiki_controller.rb

@@ -0,0 +1,102 @@
+#  Motiro - A project tracking tool
+#  Copyright (C) 2006-2007  Thiago Arrais
+#  
+#  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 2 of the License, or
+#  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, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+class WikiController < EditionController
+
+  layout :choose_layout
+
+  before_filter :login_required, :except => [:show, :last]
+  before_filter :fetch_page, :drop_crumbs
+  before_filter :check_edit_access, :only => [:edit, :save]
+  
+  cache_sweeper :page_sweeper, :only =>  [:edit, :save]
+
+  def choose_layout
+    return if params[:context] == 'partial' || params[:action] == 'properties_edit'
+    return 'application'
+  end
+    
+  def protect?(action)
+    return false if 'show' == action
+    return true    
+  end
+    
+  def initialize(page_provider=Page, renderer=nil)
+    @renderer = renderer || create_renderer
+    @real_page_provider = page_provider
+    @default_page_provider = DefaultPageProvider.new
+  end
+  
+  def fetch_page
+    type = params[:page] ? params[:page][:type] : nil
+    @page = find_page(params[:page_name], type)
+  end
+  
+  def drop_crumbs
+    unless 'common' == @page.kind 
+      @crumbs <<{ @page.kind.pluralize.capitalize.t  =>
+                  {:controller => 'report', :action => 'older',
+                   :reporter => @page.kind.pluralize}}
+    end
+    @crumbs <<{ @page.title => {:controller => 'wiki', :action => 'show',
+                                :page_name => @page.name} }   
+  end
+  
+  def check_edit_access
+    unless current_user.can_edit?(@page)
+      flash[:not_authorized] = true
+      redirect_to :action => 'show', :page_name => @page.name
+      return false
+    end
+    
+    return true
+  end
+    
+  def edit
+    render(:layout => 'application')
+  end
+  
+  def new
+    @page.kind = params[:kind]
+    render(:action => 'edit', :layout => 'application')
+  end
+  
+  def do_save
+    params[:page].delete(:original_author_id)
+    params[:page].delete(:editors) unless current_user.can_change_editors?(@page)
+
+    @page.original_author ||= current_user
+    @page.last_editor = current_user
+    @page.modified_at = Time.now
+    @page.attributes = params[:page]
+    @page.save
+
+    if 'MainPage' == @page.name
+      redirect_to :controller => 'root', :action => 'index'
+    else
+      redirect_to :action => 'show', :page_name => @page.name
+    end
+  end
+  
+private
+
+  def find_page(name, type)
+    @real_page_provider.find_by_name(name) ||
+    @default_page_provider.find_by_name_and_type(name, type)
+  end
+    
+end

data/app/core/cache_reporter.rb

@@ -0,0 +1,53 @@
+#  Motiro - A project tracking tool
+#  Copyright (C) 2006-2007  Thiago Arrais
+#  
+#  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 2 of the License, or
+#  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, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+require 'core/settings'
+require 'core/reporter'
+
+# A cache reporter is a reporter that just repeats news discovered by real
+# reporters
+#
+# Every cache reporter has a real reporter that it tries to mimic. This type
+# of reporter will go to the news database and retrieve all news that its real
+# correspondent reported.
+class CacheReporter < MotiroReporter
+  
+  def initialize(reporter, settings=SettingsProvider.new,
+                 headlines_source=Headline)
+    @headlines_source = headlines_source
+    @settings = settings
+    @source_reporter = reporter
+  end
+  
+  def latest_headlines
+    @headlines_source.latest(@settings.package_size, name)
+  end
+  
+  def headlines
+    @headlines_source.find(:all, :conditions => ['reported_by = ?', name],
+                                 :order => 'happened_at DESC')
+  end
+  
+  def headline(rid)
+    @headlines_source.find_with_reporter_and_rid(name, rid)
+  end
+  
+  def name; @source_reporter.name; end
+  def channel_title; @source_reporter.channel_title; end
+  def params_for(rid); @source_reporter.params_for(rid); end
+  
+end

data/app/core/cache_reporter_fetcher.rb

@@ -0,0 +1,33 @@
+#  Motiro - A project tracking tool
+#  Copyright (C) 2006-2007  Thiago Arrais
+#  
+#  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 2 of the License, or
+#  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, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+require_dependency 'core/cache_reporter'
+require_dependency 'core/settings'
+
+class CacheReporterFetcher
+
+  def initialize(fetcher, settings=SettingsProvider.new)
+    @fetcher, @settings = fetcher, settings
+  end
+  
+  def active_reporters
+    @fetcher.active_reporters.map do |reporter|
+      reporter.cache? ? CacheReporter.new(reporter, @settings) : reporter
+    end
+  end
+  
+end

data/app/core/chief_editor.rb

@@ -0,0 +1,69 @@
+#  Motiro - A project tracking tool
+#  Copyright (C) 2006-2007  Thiago Arrais
+#  
+#  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 2 of the License, or
+#  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, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+require_dependency 'reporters/svn_settings'
+require_dependency 'models/headline'
+
+require_dependency 'core/cache_reporter_fetcher'
+require_dependency 'core/reporter_fetcher'
+require_dependency 'core/settings'
+
+# The ChiefEditor is the guy that makes all the reporters work
+class ChiefEditor
+  
+  def initialize(conf=SettingsProvider.new, fetcher=ReporterFetcher.new)
+    @reporters = Hash.new
+    
+    fetcher = CacheReporterFetcher.new(fetcher, conf) unless
+      conf.update_interval == 0
+    fetcher.active_reporters.each do |reporter|
+      self.employ(reporter)
+    end
+  end
+  
+  def latest_news_from(reporter_name)
+    @reporters[reporter_name].latest_headlines
+  end
+  
+  def news_from(reporter_name)
+    @reporters[reporter_name].headlines
+  end
+  
+  def reporter_with(reporter_name)
+    @reporters[reporter_name]
+  end
+  
+  def headline_with(reporter_name, rid)
+    @reporters[reporter_name].headline(rid)
+  end
+  
+  def title_for(reporter_name)
+    reporter = @reporters[reporter_name]
+    return reporter.channel_title
+  end
+  
+  def buttons_for(reporter_name)
+    reporter = @reporters[reporter_name]
+    return reporter.buttons
+  end
+  
+  # Adds the given reporter to the set of reporters employed by the editor
+  def employ(reporter)
+    @reporters.update(reporter.name => reporter)
+  end
+  
+end

data/app/core/reporter.rb

@@ -0,0 +1,105 @@
+#  Motiro - A project tracking tool
+#  Copyright (C) 2006-2007  Thiago Arrais
+#  
+#  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 2 of the License, or
+#  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, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+require 'rubygems'
+require 'active_support'
+
+# A reporter is someone capable of going out for news
+#
+# For a Motiro reporter, "going out" may include, but is not limited to,
+# accessing the local file system, executing external processes and consulting
+# the web
+class MotiroReporter
+
+private
+
+  OLDER_BUTTON = "link_to('Older'.t, :controller => 'report', " +
+                                    ":action => 'older', :reporter => @name)"
+public
+  
+  def self.reporter_name
+    class_name = self.name
+    return class_name[0, class_name.size - 8].underscore
+  end
+  
+  # Replaces the default title with a custom one. Example usage:
+  #
+  #       class MyReporter < MotiroReporter
+  #           title "This is my reporter's custom title"
+  #       end
+  #       
+  #       MyReporter.new.channel_title => "This is my reporter's custom title"
+  #
+  # If not called, a default title will be generated based on the class name
+  def self.title(title)
+    define_method :channel_title do
+      title.t
+    end
+  end
+  
+  # Adds a button to this reporter's toolbar. Accepts a text parameter that
+  # will be fed into the ERB templates when generating web pages.
+  # 
+  # It is a better idea to use one of the buttons available on the buttons hash
+  # than to hard-code the button code.
+  def self.add(code)
+    write_inheritable_array 'buttons', [code]
+  end
+  
+  # A hash of buttons available for reporters
+  # 
+  # Usage : class MyReporter < MotiroReporter
+  #           add_button buttons[:older]
+  #         end
+  def self.button
+    @@buttons ||= { :older => OLDER_BUTTON }
+  end
+  
+  # Turns caching on and off for the reporter
+  # 
+  # Usage : class MyReporter < MotiroReporter
+  #           caching :off
+  #         end
+  def self.caching(switch)
+    define_method :cache? do; :off != switch; end
+  end
+  
+  def name
+    return self.class.reporter_name
+  end
+  
+  def channel_title
+    return 'Latest news from %s' / name.humanize
+  end
+  
+  def buttons
+    self.class.read_inheritable_attribute 'buttons' || []
+  end
+  
+  def params_for(rid)
+    {:controller => 'report', :action => 'show', :reporter => name, :id => rid}
+  end
+  
+  def cache?; true; end
+
+  def latest_headline
+    return latest_headlines.first
+  end
+  
+  add button[:older]
+  
+end

data/app/core/reporter_driver.rb

@@ -0,0 +1,36 @@
+#  Motiro - A project tracking tool
+#  Copyright (C) 2006-2007  Thiago Arrais
+#  
+#  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 2 of the License, or
+#  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, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+require 'core/reporter_fetcher'
+require 'headline'
+
+class ReporterDriver
+
+  def initialize(fetcher=ReporterFetcher.new, headline_cache=Headline)
+    @fetcher, @headline_cache = fetcher, headline_cache
+  end
+
+  def tick
+    @fetcher.active_reporters.each do |reporter|
+      rid = @headline_cache.latest_filled_headline_rid_for(reporter.name)
+      reporter.latest_headlines(rid).each do |hl|
+        hl.cache
+      end
+    end
+  end
+
+end