governor 0.1.0

data/lib/governor/formatters.rb

@@ -0,0 +1,43 @@
+# much love to Feather, borrowed from Merb
+module Governor
+  module Formatters
+    class << self
+      ##
+      # This registers a block to format article content
+      def register_formatter(name, &block)
+        @formatters ||= {'default' => default_formatter}
+        raise "Formatter `#{name}` already registered!" unless @formatters[name].nil?
+        @formatters[name] = block
+      end
+
+      ##
+      # This returns an array of available formatters that have been registered
+      def available_formatters
+        @formatters ||= {'default' => default_formatter}
+        return @formatters
+      end
+
+      ##
+      # This returns a default formatter used for replacing line breaks within text
+      # This is the only formatter included within Governor
+      def default_formatter
+        Proc.new do |text|
+          text.gsub("\r\n", "\n").gsub("\n", '<br>')
+        end
+      end
+
+      ##
+      # This performs the relevant formatting for the article, and returns the formatted article content
+      def format_article(article)
+        format_text(article.format, article.post)
+      end
+
+      ##
+      # This performs the requested formatting, returning the formatted text
+      def format_text(formatter, text)
+        formatter = 'default' unless available_formatters.include?(formatter)
+        @formatters[formatter].call(text).html_safe
+      end
+    end
+  end
+end

data/lib/governor/mapping.rb

@@ -0,0 +1,32 @@
+module Governor
+  class Mapping
+    attr_reader :singular, :plural, :path, :controller, :path_names, :class_name
+    alias :resource :plural
+    
+    def initialize(resource, options = {})
+      @plural   = (options[:as] ? "#{options[:as]}_#{resource}" : resource).to_sym
+      @singular = (options[:singular] || @plural.to_s.singularize).to_sym
+      
+      @class_name = (options[:class_name] || resource.to_s.classify).to_s
+      @ref = ActiveSupport::Dependencies.ref(@class_name)
+      
+      @path = (options[:path] || resource).to_s
+      @path_prefix = options[:path_prefix]
+      
+      @controller = options[:controller] || 'governor/articles'
+    end
+    
+    def fullpath
+      "#{@path_prefix}/#{@path}".squeeze("/")
+    end
+    
+    def to
+      @ref.get
+    end
+    
+    def humanize
+      @singular.to_s.humanize
+    end
+    
+  end
+end

data/lib/governor/plugin.rb

@@ -0,0 +1,13 @@
+module Governor
+  class Plugin
+    attr_reader :name, :migrations
+    def initialize(name)
+      @name = name
+      @migrations = []
+    end
+    
+    def add_migration(path)
+      @migrations << path
+    end
+  end
+end

data/lib/governor/plugin_manager.rb

@@ -0,0 +1,20 @@
+module Governor
+  class PluginManager
+    cattr_reader :plugins
+    cattr_reader :view_hooks
+    
+    class << self
+      @@view_hooks = Hash.new []
+      
+      def register(plugin)
+        @@plugins ||= []
+        @@plugins << plugin
+      end
+      
+      def register_partial(where, partial_path)
+        @@view_hooks[where] ||= []
+        @@view_hooks[where] << partial_path
+      end
+    end
+  end
+end

data/lib/governor/rails.rb

@@ -0,0 +1,7 @@
+require 'governor/rails/routes'
+
+module Governor
+  class Engine < ::Rails::Engine
+    
+  end
+end

data/lib/governor/rails/routes.rb

@@ -0,0 +1,12 @@
+module ActionDispatch::Routing
+  class Mapper
+    def governate(*resources)
+      options = resources.extract_options!
+      resources.map!(&:to_sym)
+      resources.each do |resource|
+        mapping = Governor.map(resource, options)
+        resources mapping.resource, :controller => mapping.controller, :governor_mapping => resource
+      end
+    end
+  end
+end

data/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/controllers/governor/articles_controller_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+module Governor
+  describe ArticlesController do
+    include Devise::TestHelpers
+    
+    before(:each) do
+      @user = Factory(:user)
+      @article = Factory(:article, :author => @user)
+    end
+    context "#index" do
+      it "assigns the correct instance variable" do
+        get :index, :governor_mapping => :articles
+        assigns[:articles].should == [@article]
+      end
+    end
+    
+    context "#new" do
+      it "assigns the correct instance variable" do
+        sign_in @user
+        get :new, :governor_mapping => :articles
+        assigns[:article].should be_a ::Article
+        assigns[:article].attributes.should == ::Article.new.attributes
+      end
+    end
+    
+    %w(show edit).each do |action|
+      context "##{action}" do
+        it "assigns the correct instance variable" do
+          get action, :governor_mapping => :articles, :id => @article.id
+          assigns[:article].should == @article
+        end
+      end
+    end
+    
+    context "#create" do
+      it "creates a new instance of Article" do
+        sign_in @user
+        post :create, :governor_mapping => :articles
+        assigns[:article].should be_a ::Article
+        assigns[:article].should_not be_a_new_record
+        assigns[:article].author.should == @user
+      end
+    end
+    
+    context "#update" do
+      it "updates the article" do
+        sign_in @user
+        put :update, :governor_mapping => :articles, :id => @article.id, :article => {:title => 'I am awesome, you are awesome'}
+        assigns[:article].title.should == 'I am awesome, you are awesome'
+      end
+    end
+    
+    context "#destroy" do
+      it "deletes the article" do
+        sign_in @user
+        delete :destroy, :governor_mapping => :articles, :id => @article.id
+        assigns[:article].should == @article
+        assigns[:article].should be_destroyed
+        ::Article.count.should == 0
+      end
+    end
+  end
+end

data/spec/governor/article_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+class ArticleStub < ActiveRecord::Base
+  establish_connection 'nulldb'
+  include Governor::Article
+end
+
+module Governor
+  describe Article do
+    # find_all_by_date(year, month = nil, day = nil, page = 1)
+    context "#time_delta" do
+      it "should span a whole year when that's all I ask for" do
+        time = Time.parse('1/1/2010')
+        ArticleStub.time_delta(2010).should == [time, time.end_of_year]
+      end
+      
+      it "should span a month when that's specified" do
+        time = Time.parse('8/1/2010')
+        ArticleStub.time_delta(2010, 8).should == [time, time.end_of_month]
+      end
+      
+      it "should span a single day when that's specified" do
+        time = Time.parse('8/17/2010')
+        ArticleStub.time_delta(2010, 8, 17).should == [time, time.end_of_day]
+      end
+    end
+  end
+end

data/spec/governor/plugin_manager_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+module Governor
+  describe PluginManager do
+    it "should keep track of plugins I've added" do
+      plugin = Plugin.new('my plugin')
+      PluginManager.register plugin
+      PluginManager.plugins.should include plugin
+    end
+  end
+end

data/spec/governor_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+class FakeArticle < ActiveRecord::Base
+  establish_connection 'nulldb'
+  include Governor::Article
+  def author
+    'Rod'
+  end
+end
+
+# we're going to need 'self' later
+GOVERNOR_SPEC = self
+
+describe Governor do
+  context "authorization" do
+    
+    %w(new create).each do |action|
+      it "should make sure a user is logged in when going to the #{action} page" do
+        GOVERNOR_SPEC.expects(:user_signed_in?).returns false
+        Governor.authorized?(GOVERNOR_SPEC, action).should be_false
+        GOVERNOR_SPEC.expects(:user_signed_in?).returns true
+        Governor.authorized?(GOVERNOR_SPEC, action).should be_true
+      end
+    end
+    
+    %w(edit update destroy).each do |action|
+      it "should make sure the current user is the author when going to the #{action} page" do
+        article = FakeArticle.new
+        GOVERNOR_SPEC.expects(:current_user).returns('milorad')
+        Governor.authorized?(GOVERNOR_SPEC, action, article).should be_false
+        GOVERNOR_SPEC.expects(:current_user).returns('Rod')
+        Governor.authorized?(GOVERNOR_SPEC, action, article).should be_true
+      end
+    end
+    
+    it "should raise an exception if any other action is requested" do
+      lambda{Governor.authorized(GOVERNOR_SPEC, 'who knows what this is')}.should raise_error
+    end
+  end
+end

data/spec/rails_app/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/

data/spec/rails_app/Gemfile

@@ -0,0 +1,38 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.5'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+gem 'devise'
+gem 'governor', :path => '../..'
+
+gem 'dynamic_form'
+
+gem 'will_paginate', '~> 3.0.beta'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+# group :development, :test do
+#   gem 'webrat'
+# end

data/spec/rails_app/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: ../..
+  specs:
+    governor (0.0.0)
+      rails (~> 3.0.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.5)
+      actionpack (= 3.0.5)
+      mail (~> 2.2.15)
+    actionpack (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    bcrypt-ruby (2.1.4)
+    builder (2.1.2)
+    devise (1.1.7)
+      bcrypt-ruby (~> 2.1.2)
+      warden (~> 1.0.2)
+    dynamic_form (1.1.3)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.5)
+      actionmailer (= 3.0.5)
+      actionpack (= 3.0.5)
+      activerecord (= 3.0.5)
+      activeresource (= 3.0.5)
+      activesupport (= 3.0.5)
+      bundler (~> 1.0)
+      railties (= 3.0.5)
+    railties (3.0.5)
+      actionpack (= 3.0.5)
+      activesupport (= 3.0.5)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    sqlite3 (1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.25)
+    warden (1.0.3)
+      rack (>= 1.0.0)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  devise
+  dynamic_form
+  governor!
+  rails (= 3.0.5)
+  sqlite3
+  will_paginate (~> 3.0.beta)

data/spec/rails_app/README

@@ -0,0 +1,256 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.com/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |   |-- images
+  |   |-- javascripts
+  |   `-- stylesheets
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for
+  images, stylesheets, and javascripts. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.