governor 0.1.0

data/app/views/governor/articles/show.html.erb

@@ -0,0 +1,10 @@
+<div id="blog">
+  <div class="articles">
+     <%= render resource %>
+  </div>
+    <%= render_plugin_partial('after_article_on_article_page', :locals => {:article => resource}) %>
+</div>
+<%= link_to 'Back', resources_url %>
+<% if governor_authorized?(:edit, resource) %>
+  | <%= link_to 'Edit', edit_resource_url(resource) %>
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"
+  unauthorized_edit: "You're not allowed to edit this %{resource_type}."

data/governor.gemspec

@@ -0,0 +1,198 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{governor}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Liam Morley"]
+  s.date = %q{2011-04-02}
+  s.description = %q{Because Blogojevich would be too tough to remember. It's a pluggable blogging system for Rails 3.}
+  s.email = %q{liam@carpeliam.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "app/controllers/governor/articles_controller.rb",
+    "app/helpers/governor_helper.rb",
+    "app/views/governor/articles/_article.html.erb",
+    "app/views/governor/articles/_form.html.erb",
+    "app/views/governor/articles/edit.html.erb",
+    "app/views/governor/articles/index.html.erb",
+    "app/views/governor/articles/new.html.erb",
+    "app/views/governor/articles/show.html.erb",
+    "config/locales/en.yml",
+    "governor.gemspec",
+    "lib/generators/USAGE",
+    "lib/generators/governor/create_articles_generator.rb",
+    "lib/generators/governor/install_generator.rb",
+    "lib/generators/governor/migrate_generator.rb",
+    "lib/generators/governor/templates/governor.rb",
+    "lib/generators/governor/templates/migrations/create_articles.rb",
+    "lib/generators/governor/templates/models/article.rb",
+    "lib/governor.rb",
+    "lib/governor/article.rb",
+    "lib/governor/controllers/helpers.rb",
+    "lib/governor/formatters.rb",
+    "lib/governor/mapping.rb",
+    "lib/governor/plugin.rb",
+    "lib/governor/plugin_manager.rb",
+    "lib/governor/rails.rb",
+    "lib/governor/rails/routes.rb",
+    "lib/tasks/.gitkeep",
+    "script/rails",
+    "spec/controllers/governor/articles_controller_spec.rb",
+    "spec/governor/article_spec.rb",
+    "spec/governor/plugin_manager_spec.rb",
+    "spec/governor_spec.rb",
+    "spec/rails_app/.gitignore",
+    "spec/rails_app/Gemfile",
+    "spec/rails_app/Gemfile.lock",
+    "spec/rails_app/README",
+    "spec/rails_app/Rakefile",
+    "spec/rails_app/app/controllers/application_controller.rb",
+    "spec/rails_app/app/controllers/home_controller.rb",
+    "spec/rails_app/app/helpers/application_helper.rb",
+    "spec/rails_app/app/helpers/home_helper.rb",
+    "spec/rails_app/app/models/article.rb",
+    "spec/rails_app/app/models/user.rb",
+    "spec/rails_app/app/views/home/index.html.erb",
+    "spec/rails_app/app/views/layouts/application.html.erb",
+    "spec/rails_app/config.ru",
+    "spec/rails_app/config/application.rb",
+    "spec/rails_app/config/boot.rb",
+    "spec/rails_app/config/database.yml",
+    "spec/rails_app/config/environment.rb",
+    "spec/rails_app/config/environments/development.rb",
+    "spec/rails_app/config/environments/production.rb",
+    "spec/rails_app/config/environments/test.rb",
+    "spec/rails_app/config/initializers/backtrace_silencers.rb",
+    "spec/rails_app/config/initializers/devise.rb",
+    "spec/rails_app/config/initializers/governor.rb",
+    "spec/rails_app/config/initializers/inflections.rb",
+    "spec/rails_app/config/initializers/mime_types.rb",
+    "spec/rails_app/config/initializers/secret_token.rb",
+    "spec/rails_app/config/initializers/session_store.rb",
+    "spec/rails_app/config/locales/devise.en.yml",
+    "spec/rails_app/config/locales/en.yml",
+    "spec/rails_app/config/routes.rb",
+    "spec/rails_app/db/migrate/20110329032256_devise_create_users.rb",
+    "spec/rails_app/db/migrate/20110330020108_governor_create_articles.rb",
+    "spec/rails_app/db/schema.rb",
+    "spec/rails_app/db/seeds.rb",
+    "spec/rails_app/lib/tasks/.gitkeep",
+    "spec/rails_app/public/404.html",
+    "spec/rails_app/public/422.html",
+    "spec/rails_app/public/500.html",
+    "spec/rails_app/public/favicon.ico",
+    "spec/rails_app/public/images/rails.png",
+    "spec/rails_app/public/javascripts/application.js",
+    "spec/rails_app/public/javascripts/controls.js",
+    "spec/rails_app/public/javascripts/dragdrop.js",
+    "spec/rails_app/public/javascripts/effects.js",
+    "spec/rails_app/public/javascripts/prototype.js",
+    "spec/rails_app/public/javascripts/rails.js",
+    "spec/rails_app/public/robots.txt",
+    "spec/rails_app/public/stylesheets/.gitkeep",
+    "spec/rails_app/script/rails",
+    "spec/rails_app/spec/factories.rb",
+    "spec/rails_app/vendor/plugins/.gitkeep",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/carpeliam/governor}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A pluggable blogging system for Rails 3.}
+  s.test_files = [
+    "spec/controllers/governor/articles_controller_spec.rb",
+    "spec/governor/article_spec.rb",
+    "spec/governor/plugin_manager_spec.rb",
+    "spec/governor_spec.rb",
+    "spec/rails_app/app/controllers/application_controller.rb",
+    "spec/rails_app/app/controllers/home_controller.rb",
+    "spec/rails_app/app/helpers/application_helper.rb",
+    "spec/rails_app/app/helpers/home_helper.rb",
+    "spec/rails_app/app/models/article.rb",
+    "spec/rails_app/app/models/user.rb",
+    "spec/rails_app/config/application.rb",
+    "spec/rails_app/config/boot.rb",
+    "spec/rails_app/config/environment.rb",
+    "spec/rails_app/config/environments/development.rb",
+    "spec/rails_app/config/environments/production.rb",
+    "spec/rails_app/config/environments/test.rb",
+    "spec/rails_app/config/initializers/backtrace_silencers.rb",
+    "spec/rails_app/config/initializers/devise.rb",
+    "spec/rails_app/config/initializers/governor.rb",
+    "spec/rails_app/config/initializers/inflections.rb",
+    "spec/rails_app/config/initializers/mime_types.rb",
+    "spec/rails_app/config/initializers/secret_token.rb",
+    "spec/rails_app/config/initializers/session_store.rb",
+    "spec/rails_app/config/routes.rb",
+    "spec/rails_app/db/migrate/20110329032256_devise_create_users.rb",
+    "spec/rails_app/db/migrate/20110330020108_governor_create_articles.rb",
+    "spec/rails_app/db/schema.rb",
+    "spec/rails_app/db/seeds.rb",
+    "spec/rails_app/spec/factories.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, ["~> 3.0.5"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<factory_girl>, ["~> 2.0.0.beta"])
+      s.add_development_dependency(%q<factory_girl_rails>, ["~> 1.1.beta"])
+      s.add_development_dependency(%q<activerecord-nulldb-adapter>, [">= 0"])
+      s.add_development_dependency(%q<will_paginate>, ["~> 3.0.beta"])
+      s.add_development_dependency(%q<devise>, [">= 0"])
+      s.add_development_dependency(%q<governor>, [">= 0"])
+      s.add_development_dependency(%q<dynamic_form>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, ["~> 3.0.5"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<factory_girl>, ["~> 2.0.0.beta"])
+      s.add_dependency(%q<factory_girl_rails>, ["~> 1.1.beta"])
+      s.add_dependency(%q<activerecord-nulldb-adapter>, [">= 0"])
+      s.add_dependency(%q<will_paginate>, ["~> 3.0.beta"])
+      s.add_dependency(%q<devise>, [">= 0"])
+      s.add_dependency(%q<governor>, [">= 0"])
+      s.add_dependency(%q<dynamic_form>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["~> 3.0.5"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rspec-rails>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<factory_girl>, ["~> 2.0.0.beta"])
+    s.add_dependency(%q<factory_girl_rails>, ["~> 1.1.beta"])
+    s.add_dependency(%q<activerecord-nulldb-adapter>, [">= 0"])
+    s.add_dependency(%q<will_paginate>, ["~> 3.0.beta"])
+    s.add_dependency(%q<devise>, [">= 0"])
+    s.add_dependency(%q<governor>, [">= 0"])
+    s.add_dependency(%q<dynamic_form>, [">= 0"])
+  end
+end
+

data/lib/generators/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/governor/create_articles_generator.rb

@@ -0,0 +1,40 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+module Governor
+  class CreateArticlesGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+    argument :class_name, :type => :string, :default => 'Article'
+  
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        Time.new.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+    
+    def create_model
+      template 'models/article.rb', "app/models/#{table_name.singularize}.rb"
+    end
+  
+    def create_migration_file
+      migration_template 'migrations/create_articles.rb', "db/migrate/governor_create_#{table_name}.rb", :skip => true
+    end
+    
+    def add_route
+      # route "resources :#{table_name}, :controller => 'governor/articles'"
+      route "governate :#{table_name}"
+    end
+    
+    private
+    def table_name
+      @table_name ||= class_name.tableize
+    end
+    
+    def model_name
+      @model_name ||= class_name.camelize
+    end
+    
+  end
+end

data/lib/generators/governor/install_generator.rb

@@ -0,0 +1,9 @@
+module Governor
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+  
+    def copy_initializer
+      template 'governor.rb', 'config/initializers/governor.rb'
+    end
+  end
+end

data/lib/generators/governor/migrate_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+module Governor
+  class MigrateGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+  
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        Time.new.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+  
+    def create_migration_file
+      PluginManager.plugins.each do |plugin|
+        plugin.migrations.each do |migration|
+          sleep 1 # advance the file name
+          migration_template File.expand_path(migration), "db/migrate/#{File.basename(migration)}", :skip => true
+        end
+      end
+    end
+  end
+end

data/lib/generators/governor/templates/governor.rb

@@ -0,0 +1,22 @@
+GOVERNOR_AUTHOR = Proc.new do |actor|
+  if actor.respond_to?(:current_user)
+    actor.current_user
+  else
+    raise "Set up GOVERNOR_AUTHOR in #{File.expand_path(__FILE__)}"
+  end
+end
+
+Governor.authorize_if do |actor, action, article|
+  case action.to_sym
+  when :new, :create
+    # if respond_to?(:user_signed_in?)
+      actor.user_signed_in?
+    # else
+    #   raise "Set up Governor.authorize_if in #{File.expand_path(__FILE__)}"
+    # end
+  when :edit, :update, :destroy
+    article.author == GOVERNOR_AUTHOR.call(actor)
+  else
+    raise ArgumentError.new('action must be new, create, edit, update, or destroy')
+  end
+end

data/lib/generators/governor/templates/migrations/create_articles.rb

@@ -0,0 +1,15 @@
+class GovernorCreate<%= model_name.pluralize %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+      t.string      :title, :description
+      t.string      :format, :default => 'default'
+      t.text        :post
+      t.references  :author, :polymorphic => true
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/lib/generators/governor/templates/models/article.rb

@@ -0,0 +1,3 @@
+class <%= model_name %> < ActiveRecord::Base
+  include Governor::Article
+end

data/lib/governor.rb

@@ -0,0 +1,32 @@
+require 'governor/plugin'
+require 'governor/plugin_manager'
+require 'governor/article'
+require 'governor/formatters'
+require 'governor/mapping'
+
+require 'governor/controllers/helpers'
+
+require 'rails'
+require 'governor/rails'
+
+
+module Governor
+  
+  mattr_accessor :resources
+  @@resources = {}
+  def self.map(resource, options = {})
+    self.resources[resource] = Governor::Mapping.new(resource, options)
+  end
+  
+  def self.setup
+    yield self
+  end
+  
+  def self.authorize_if(&blk)
+    @@authz_rules = blk
+  end
+  
+  def self.authorized?(actor, action, article=nil)
+    @@authz_rules.call(actor, action, article)
+  end
+end

data/lib/governor/article.rb

@@ -0,0 +1,26 @@
+module Governor
+  module Article
+    def self.included(base)
+      base.belongs_to :author, :polymorphic => true
+      
+      def base.find_all_by_date(year, month = nil, day = nil, page = 1)
+        from, to = self.time_delta(year, month, day)
+        conditions = ['created_at BETWEEN ? AND ?', from, to]
+        paginate :page => page, :conditions => conditions, :order => 'created_at DESC'
+      end
+
+      private
+      def base.time_delta(year, month = nil, day = nil)
+        from = Time.mktime(year, month || 1, day || 1)
+        to = if day.present?
+          from.end_of_day
+        elsif month.present?
+          from.end_of_month
+        else
+          from.end_of_year
+        end
+        [from, to]
+      end
+    end
+  end
+end

data/lib/governor/controllers/helpers.rb

@@ -0,0 +1,58 @@
+module Governor
+  module Controllers
+    module Helpers
+      def resources_url
+        url_for :controller => mapping.controller, :governor_mapping => params[:governor_mapping], :action => 'index'
+      end
+      
+      def edit_resource_url(resource)
+        url_for :controller => mapping.controller, :governor_mapping => params[:governor_mapping], :action => 'edit', :id => resource.id
+      end
+
+      def resource
+        instance_variable_get("@#{mapping.singular}")
+      end
+      
+      def resource_sym
+        mapping.singular
+      end
+
+      def resources
+        instance_variable_get("@#{mapping.plural}")
+      end
+
+      def model_class
+        @model_class ||= mapping.to
+      end
+
+      private
+      def set_resources(resources)
+        instance_variable_set("@#{mapping.plural}", resources)
+      end
+
+      def set_resource(resource)
+        instance_variable_set("@#{mapping.singular}", resource)
+      end
+
+      def mapping
+        Governor.resources[params[:governor_mapping]]
+      end
+
+      def init_resource
+        set_resource model_class.find(params[:id])
+      end
+
+      def authorize_governor!
+        if defined?(resource)
+          redirect_to root_path unless governor_authorized?(action_name, resource)
+        else
+          send("authenticate_#{Devise.default_scope}!") unless governor_authorized?(action_name)
+        end
+      end
+      
+      def governor_authorized?(action, article=nil)
+        Governor.authorized?(self, action, article)
+      end
+    end
+  end
+end