muck-blogs 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+coverage
+rdoc
+pkg
+pkg/*
+log/*
+*.gem

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Justin Ball
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,51 @@
+= Muck Blogs
+
+Add a blog to any object.
+
+== Setup
+Install the gem:
+  sudo gem install muck-blogs
+
+Then add it to your environment.rb:
+  config.gem "muck-blogs", :lib => 'muck_blogs'
+  
+Add tasks to your application's Rakefile:
+  require 'muck_blogs/tasks'
+  
+Installing the gem will also install dependencies.  Specifically Muck Blogs requires Muck Contents.  Be sure
+to properly configure your application for Muck Contents - http://github.com/jbasdf/muck_contents/tree/master
+== Usage
+
+=== Configuration
+Add 'enable_post_activities' to global_config.yml to determine whether or not an activity will be added
+after a user contributes a post.  This requires that the application be configured to use Muck Activities.
+Note that to enable this functionality the content model will need to have 
+  enable_post_activities: true
+
+=== Blog model
+Create a model called blog in your project and add the following:
+  class Blog < ActiveRecord::Base
+    acts_as_muck_blog
+  end
+This let's you override or add other methods to the blog model that you see fit.
+
+=== Content model
+Muck Blogs requires Muck Contents.  Be sure to setup Muck Content then add acts_as_muck_post to your Content model:
+  class Content < ActiveRecord::Base
+    acts_as_muck_post
+    # acts_as_activity_source # Include this if you wish to have entries added to activity feeds upon each new post
+  end
+
+=== Attach blogs to a model:
+For a given model add 'has_muck_blog'
+  class User < ActiveRecord::Base
+    has_muck_blog
+  end
+For each model that 'has_muck_blog' you will need to setup routing.  For a user model this would be:
+  map.resources :users do |users|
+    users.resource :blog, :controller => 'muck/blogs' do |blogs|
+      blogs.resources :posts, :controller => 'muck/posts'
+    end
+  end
+  
+Copyright (c) 2009 Muck Your App, released under the MIT license

data/Rakefile

@@ -0,0 +1,90 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test muck-blogs.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test/rails_root/test'
+  t.pattern = 'test/rails_root/test/**/*_test.rb'
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    #t.libs << 'lib'
+    t.libs << 'test/rails_root/lib'
+    t.pattern = 'test/rails_root/test/**/*_test.rb'
+    t.verbose = true
+    t.output_dir = 'coverage'
+    t.rcov_opts << '--exclude "gems/*"'
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+desc 'Generate documentation for the muck-blogs gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MuckBlogs'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Translate this gem'
+task :translate do
+  file = File.join(File.dirname(__FILE__), 'locales', 'en.yml')
+  system("babelphish -o -y #{file}")
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "muck-blogs"
+    gemspec.summary = "The blog engine for the muck system"
+    gemspec.email = "justinball@gmail.com"
+    gemspec.homepage = "http://github.com/jbasdf/muck_blogs"
+    gemspec.description = "The blog engine for the muck system."
+    gemspec.authors = ["Justin Ball"]
+    gemspec.rubyforge_project = 'muck-blogs'
+    gemspec.add_dependency "muck-engine"
+    gemspec.add_dependency "muck-users"
+    gemspec.add_dependency "muck-contents"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+# rubyforge tasks
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/muck-blogs/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/muck/blogs_controller.rb

@@ -0,0 +1,38 @@
+class Muck::BlogsController < ApplicationController
+  unloadable
+  
+  before_filter :setup_parent
+  
+  def index
+    if !@parent.blank?
+      @blogs = @parent.blogs.by_newest rescue nil
+      @blog ||= @parent.blog rescue nil
+      if @blog
+        redirect_to url_for([@parent, :blog, :posts])
+        return
+      end
+    end
+    @blogs ||= Blog.by_newest
+    respond_to do |format|
+      format.html { render :template => 'blogs/index', :layout => 'popup' }
+      format.pjs { render :template => 'blogs/index', :layout => false }
+    end
+  end
+  
+  # redirect to the posts for the given blog
+  def show
+    if @parent
+      @blog = @parent.blog
+      redirect_to url_for([@parent, :blog, :posts])
+    else
+      @blog ||= Blog.find(params[:id])
+      redirect_to blog_posts_path(@blog)
+    end
+  end
+  
+  protected
+    def setup_parent
+      @parent = get_parent
+    end
+  
+end

data/app/controllers/muck/posts_controller.rb

@@ -0,0 +1,42 @@
+class Muck::PostsController < Muck::ContentsController
+  unloadable
+
+  before_filter :setup_blog
+  
+  def index
+    @posts = @blog.posts.by_newest
+    respond_to do |format|
+      format.html { render :template => 'posts/index', :layout => 'popup' }
+      format.pjs { render :template => 'posts/index', :layout => false }
+    end
+  end
+
+  def show
+    @content = Content.find(params[:id], :scope => Content.contentable_to_scope(@blog)) if @blog
+    @content ||= Content.find(params[:id])
+    super
+  end
+  
+  def new
+    @content = @blog.posts.new()
+    @new_content_message = t('muck.blogs.add_post')
+    super
+  end
+  
+  protected
+    def setup_blog
+      @parent = get_parent
+      if @parent && !@parent.is_a?(Blog)
+        @blog = @parent.blog
+        @blog ||= Blog.find(params[:id], :scope => Blog.blogable_to_scope(@parent))
+      else
+        @blog = @parent # parent found the blog
+      end
+      @blog ||= Blog.find(params[:id], :scope => MuckContents::GLOBAL_SCOPE)
+    end
+    
+    def has_permission_to_add_content(user, parent, content)
+      return true if parent.can_add_content?(user)
+      super
+    end
+end

data/app/helpers/muck_blogs_helper.rb

@@ -0,0 +1,4 @@
+module MuckBlogsHelper
+  
+
+end

data/app/views/activity_templates/_post.html.erb

@@ -0,0 +1,3 @@
+<% activity_for(activity, :activity_css_class => 'activity_blog_post') do -%>
+  <%= activity.item.body %>
+<% end -%>

data/app/views/blogs/index.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'blogs/blog', :collection => @blogs %>

data/app/views/blogs/show.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'blogs/post', :collection => @posts %>

data/app/views/posts/_post.html.erb

@@ -0,0 +1,4 @@
+<div class="blog_post">
+  <h3><%= post.title %></h3>
+  <p><%= html_summarize(post.body, 30, link_to(t('muck.general.read_more'), url_for([@parent, @blog, @post]))) %></p>
+</div>

data/app/views/posts/index.html.erb

@@ -0,0 +1,2 @@
+<%= render :partial => 'posts/post', :collection => @posts %>
+<%= link_to t('muck.blogs.add_post_link'), new_blog_post_path(@blog) %>

data/config/muck_blogs_routes.rb

@@ -0,0 +1,6 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :posts, :controller => 'muck/posts'
+  map.resources :blogs, :controller => 'muck/blogs' do |blogs|
+    blogs.resources :posts, :controller => 'muck/posts'
+  end
+end

data/db/migrate/20090808165453_create_blogs.rb

@@ -0,0 +1,16 @@
+class CreateBlogs < ActiveRecord::Migration
+  def self.up
+    create_table :blogs, :force => true do |t|
+      t.integer   :blogable_id, :default => 0
+      t.string    :blogable_type, :default => ""
+      t.string    :title
+      t.timestamps
+    end
+
+    add_index :blogs, ["blogable_id", "blogable_type"]
+  end
+
+  def self.down
+    drop_table :blogs
+  end
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/active_record/acts/muck_blog.rb

@@ -0,0 +1,67 @@
+module ActiveRecord
+  module Acts #:nodoc:
+    module MuckBlog #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        def acts_as_muck_blog(options = {})
+          
+          has_many :posts, :as => :contentable, :class_name => 'Content'
+          belongs_to :blogable, :polymorphic => true
+
+          has_friendly_id :title, :use_slug => true, :scope => :get_blog_scope
+          
+          validates_presence_of :title
+          
+          named_scope :by_newest, :order => "created_at DESC"
+          named_scope :by_oldest, :order => "created_at ASC"
+          named_scope :recent, lambda { { :conditions => ['created_at > ?', 1.week.ago] } }
+                            
+          class_eval <<-EOV
+            # prevents a user from submitting a crafted form that changes audit values
+            attr_protected :created_at, :updated_at
+          EOV
+
+          include ActiveRecord::Acts::MuckBlog::InstanceMethods
+          extend ActiveRecord::Acts::MuckBlog::SingletonMethods
+          
+        end
+      end
+
+      # class methods
+      module SingletonMethods
+        def blogable_to_scope(obj)
+          File.join('/', obj.class.to_s.tableize, obj.to_param)
+        end
+      end
+      
+      # All the methods available to a record that has had <tt>acts_as_muck_blog</tt> specified.
+      module InstanceMethods
+
+        # Setup the scope for this content object
+        def get_blog_scope
+          if self.blogable_id > 0 && !self.blogable_type.blank?
+            self.class.blogable_to_scope(self.blogable)
+          else
+            ''
+          end
+        rescue
+          debugger
+          t = 0
+        end
+        
+        # Determines whether or not the given user has the right to add content to the blog
+        # Override this method to change permissions.
+        # Currently this method looks to the parent object and calls 'can_edit?' to determine
+        # whether or not the user can edit the content
+        def can_add_content?(user)
+          blogable.can_edit?(user)
+        end
+
+      end
+    end
+  end
+end

data/lib/active_record/acts/muck_blogable.rb

@@ -0,0 +1,37 @@
+module ActiveRecord
+  module Acts #:nodoc:
+    module MuckBlogable #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        def has_muck_blog
+          has_one :blog, :as => :blogable, :dependent => :destroy
+
+          include ActiveRecord::Acts::MuckBlogable::InstanceMethods
+          extend ActiveRecord::Acts::MuckBlogable::SingletonMethods
+          
+        end
+      end
+
+      # class methods
+      module SingletonMethods
+
+      end
+      
+      # All the methods available to a record that has had <tt>acts_as_muck_blog</tt> specified.
+      module InstanceMethods
+        def after_create
+          # setup a temp title using information from the parent.
+          title = self.title rescue nil
+          title ||= self.name rescue nil
+          title ||= self.class.to_s
+          title = I18n.t('muck.blogs.blog_title', :title => title)
+          self.blog = Blog.create(:title => title)
+        end
+      end
+    end
+  end
+end

data/lib/active_record/acts/muck_post.rb

@@ -0,0 +1,32 @@
+module ActiveRecord
+  module Acts #:nodoc:
+    module MuckPost #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        def acts_as_muck_post(options = {})        
+          belongs_to :blog, :dependent => :destroy
+          include ActiveRecord::Acts::MuckPost::InstanceMethods
+          extend ActiveRecord::Acts::MuckPost::SingletonMethods
+        end
+        
+      end
+
+      # class methods
+      module SingletonMethods
+
+      end
+      
+      # All the methods available to a record that has had <tt>acts_as_muck_post</tt> specified.
+      module InstanceMethods
+        def after_create
+          if GlobalConfig.enable_post_activities
+          end
+        end
+      end
+    end
+  end
+end