muck-contents 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

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,112 @@
+= MuckContents
+
+Add contents to you website.  News stories, blog posts and pages are all basically a page with content and a title.  Muck content makes 
+it easy to add this content to your website.
+
+=== Gems
+Note that all gems below should be installed automatically as a muck-contents has them set as a dependency.  
+Many of the gems are found on github so before installing do:
+  gem sources -a http://gems.github.com
+
+  sudo gem install jbasdf-acts_as_git                 # Versioning. Requires a git installation.
+  sudo gem install collectiveidea-awesome_nested_set  # Nested pages.  Used to setup navigation hierarchy (http://github.com/collectiveidea/awesome_nested_set/tree/master)
+  sudo gem install rgrove-sanitize                    # Remove harmful html. (http://github.com/rgrove/sanitize/tree/master.)
+  sudo gem install mbleigh-acts-as-taggable-on        # Tagging.  (http://github.com/mbleigh/acts-as-taggable-on/tree/master)
+  sudo gem install friendly_id                        # Pretty urls (http://github.com/norman/friendly_id/tree/master)
+  sudo gem install babelphish                         # Translations
+  sudo gem install muck-solr                          # Search Install muck_solr (or another version of acts_as_solr)
+
+=== Configure environment.rb
+Paste in the following:
+  config.gem "collectiveidea-awesome_nested_set", :lib => 'awesome_nested_set'
+  config.gem "rgrove-sanitize", :lib => 'sanitize'
+  config.gem "mbleigh-acts-as-taggable-on", :source => "http://gems.github.com", :lib => "acts-as-taggable-on"
+  config.gem "friendly_id"
+  config.gem "babelphish"
+
+
+=== Gem configuration and setup
+In your app do
+  script/generate friendly_id
+  script/generate acts_as_taggable_on_migration
+  rake db:migrate
+
+== Setup
+
+=== User model
+Add the following method to your user model and modify it according to your specific needs:
+  
+  def can_add_root_content?
+    admin?
+  end
+
+This method determines who can add content to any url on your website.  For example, if you type in
+http://www.example.com/a/test/page and that page does not exist, muck contents will automatically create
+a page for you at that location if the logged in user has a method can_add_root_content? that returns true.
+
+=== Content models
+Create the following models in your project.  This let's you add any other methods that you see fit.
+
+  class Content < ActiveRecord::Base
+    # This assumes you are using GlobalConfig.  You can also set these values directly in the model
+    acts_as_muck_content(
+      :git_repository => GlobalConfig.content_git_repository,
+      :enable_translations => GlobalConfig.enable_auto_translations,
+      :enable_solr => GlobalConfig.content_enable_solr
+    )
+  end
+  
+  class ContentTranslation < ActiveRecord::Base
+    acts_as_muck_content_translation
+  end
+  
+  class ContentPermission < ActiveRecord::Base
+    acts_as_muck_content_permission
+  end
+
+=== Contents controller
+Create a ContentsController and inherit from Muck::ContentsController.  Unfortunately, due to routing issues this is required or 
+we'd have to hard code the routes to go to muck/contents which prevent modification of the contents_controller.
+  class ContentsController < Muck::ContentsController
+  end
+
+Add a route for the new controller:
+  ActionController::Routing::Routes.draw do |map|
+    map.resource :contents
+  end
+
+  
+=== Application controller
+Add acts_as_muck_content_handler if you want muck_contents to intercept pages that are not found and provide authorized users
+and opportunity to add them.
+
+  class ApplicationController < ActionController::Base
+    acts_as_muck_content_handler
+  end
+
+=== Content controller
+Override the contents controller to change the the security model.  For example:
+
+  class ContentsController < Muck::ContentsController
+    
+    before_filter :login_required   # require the user to be logged in to add content
+    
+    # Modify this method to change how permissions are checked to see if a user can content.
+    # Each model that implements 'has_muck_content' can (and should) override can_add_content? to 
+    # change how content permissions are handled.
+    def has_permission_to_add_content(user, parent)
+      parent.can_add_content?(user)
+    end
+    
+    # Setups up the layouts that are available in the 'layouts' pulldown.
+    # Override this method to change the available layouts. Note that the
+    # layout will need to exist in your 'views/layouts' directory
+    def setup_layouts
+      @content_layouts = 
+    end
+    
+  end
+
+
+
+Copyright (c) 2009 Justin Ball, released under the MIT license

data/Rakefile

@@ -0,0 +1,101 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test muck-contents.'
+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
+
+require 'rake/rdoctask'
+desc 'Generate documentation for the muck-contents gem.'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "muck_contents #{version}"
+  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-contents"
+    gemspec.summary = "Add content to your muck based project"
+    gemspec.email = "justinball@gmail.com"
+    gemspec.homepage = "http://github.com/jbasdf/muck_contents"
+    gemspec.authors = ["Justin Ball"]
+    gemspec.rubyforge_project = 'muck-contents'
+    gemspec.add_dependency "muck-engine"
+    gemspec.add_dependency "muck-users"
+    gemspec.add_dependency "muck-comments"
+    gemspec.add_dependency "collectiveidea-awesome_nested_set"
+    gemspec.add_dependency "rgrove-sanitize"
+    gemspec.add_dependency "mbleigh-acts-as-taggable-on"
+    gemspec.add_dependency "friendly_id"
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+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-contents/"
+        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.1

data/app/controllers/admin/muck/contents_controller.rb

@@ -0,0 +1,15 @@
+class Admin::Muck::ContentsController < ApplicationController
+  unloadable
+  
+  def index
+  end
+  
+  def edit
+    @content = Content.find(params[:id])
+    @title = @content.title
+    respond_to do |format|
+      format.html { render :template => 'contents/edit' }
+    end
+  end
+
+end

data/app/controllers/muck/contents_controller.rb

@@ -0,0 +1,186 @@
+class Muck::ContentsController < ApplicationController
+  unloadable
+  
+  before_filter :login_required, :only => [:new, :create, :edit, :update, :destroy]
+  before_filter :setup_parent, :only => [:new, :create]
+  before_filter :get_secure_content, :only => [:edit, :update, :destroy]
+  before_filter :setup_layouts, :only => [:new, :create, :edit, :update]
+  
+  def show
+    handle_content_request
+  end
+
+  # If a content object is not found this method will render a 404 for users that are not allowed to add content.
+  # If the user is allowed to add content a redirect to new is performed so that the content can be added.
+  #
+  # Notes:
+  # Override 'new' by setting up @content and passing in a custom message via @new_content_message
+  # For example:
+  #    def new
+  #      @content = Content.new(:custom_scope => 'my-stuff')
+  #      @new_content_message = 'Add Content to My Stuff'
+  #      super
+  #    end
+  #
+  # It is also simple to override the new template.  Simply create a template in app/views/contents/new.html.erb 
+  # and add something similar to the following:
+  #    <div id="add_content">
+  #      <%= output_errors(t('muck.contents.problem_adding_content'), {:class => 'help-box'}, @content) %>
+  #      <% content_form(@content) do |f| -%>
+  #        <%# Add custom fields here.  ie %>
+  #        <%= f.text_field :custom_thing %>
+  #      <% end -%>
+  #    </div>
+  def new
+    @content ||= Content.new
+    @content.uri = params[:path] if params[:path]
+    if has_permission_to_add_content(current_user, @parent, @content)
+      flash[:notice] = @new_content_message || t('muck.contents.page_doesnt_exist_create')
+      respond_to do |format|
+        format.html { render :template => 'contents/new'}
+        format.pjs { render :template => 'contents/new', :layout => 'popup'}
+      end
+    else
+      # TODO think about caching this:
+      @content = Content.find('404-page-not-found', :scope => MuckContents::GLOBAL_SCOPE) rescue nil
+      if @content.blank?
+        @content = Content.new(:title => I18n.t('muck.contents.default_404_title'), :body_raw => I18n.t('muck.contents.default_404_body'), :locale => I18n.locale.to_s)
+        @content.uri = '/404-page-not-found'
+        @content.save!
+      end
+      @title = @content.locale_title(I18n.locale)
+      respond_to do |format| 
+        format.html { render :template => "contents/show", :status => 404 }
+        format.all  { render :nothing => true, :status => 404 } 
+      end
+    end
+  end
+  
+  def create
+    @content = Content.new(params[:content])
+    @content.contentable = @parent if @parent
+    @content.creator = current_user
+    @content.current_editor = current_user
+    @content.locale ||= I18n.locale
+    return permission_denied unless has_permission_to_add_content(current_user, @parent, @content)
+    
+    @content.save!
+    respond_to do |format|
+      format.html do
+        redirect_back_or_default(@content.uri)
+      end
+      format.json { render :json => { :success => true, :content => @content, :parent_id => @parent ? @parent.id : nil } }
+    end
+  rescue ActiveRecord::RecordInvalid => ex
+    if @content
+      @errors = @content.errors.full_messages.to_sentence
+    else
+      @errors = ex
+    end
+    message = t('muck.contents.create_error', :errors => @errors)
+    respond_to do |format|
+      format.html do
+        flash[:error] = message
+        render :template => 'contents/new'
+      end
+      format.json { render :json => { :success => false, :message => message, :errors => @errors } }
+    end
+  end
+
+  def edit
+    @page_title = @content.locale_title(I18n.locale)
+    respond_to do |format|
+      format.html { render :template => 'contents/edit'}
+      format.pjs { render :template => 'contents/edit', :layout => 'popup'}
+    end
+  end
+  
+  def update
+    @content.current_editor = current_user
+    @content.update_attributes(params[:content])
+    respond_to do |format|
+      format.html do
+        redirect_back_or_default(@content.uri)
+      end
+      format.json { render :json => { :success => true, :content => @content, :parent_id => @parent ? @parent.id : nil } }
+    end
+  end
+  
+  def destroy
+    @content.destroy
+    respond_to do |format|
+      format.html do
+        flash[:notice] = t('muck.contents.content_removed')
+        redirect_back_or_default(current_user)
+      end
+      format.js do
+        render(:update) do |page|
+          page << "jQuery('##{@content.dom_id}').fadeOut();"
+        end
+      end
+      format.json { render :json => { :success => true, :message => t("muck.contents.content_removed"), :content_id => @content.id } }
+    end
+  end  
+
+  protected
+    
+    # Setups up the layouts that are available in the 'layouts' pulldown.
+    # Override this method to change the available layouts. Note that the
+    # layout will need to exist in your 'views/layouts' directory
+    def setup_layouts
+      @content_layouts = []
+      get_layouts(File.join(RAILS_ROOT, 'app', 'views', 'layouts')).each do |layout|
+        @content_layouts << OpenStruct.new(:name => layout.titleize, :value => layout)
+      end
+    end
+    
+    def get_layouts(path)
+      layouts = []
+      Dir.glob("#{path}/*").each do |layout_file|
+        if File.directory?(layout_file)
+          layouts << get_layouts(layout_file)
+        else
+          if layout_file.include?('.html.erb') || layout_file.include?('.html.haml')
+            trimmed_layout_file = File.basename(File.basename(layout_file, '.*'), '.*') # get ride of html.erb, html.haml
+            if trimmed_layout_file.first != '_'&& # don't include partials
+              layouts << trimmed_layout_file
+            end
+          end
+        end
+      end
+      layouts
+    end
+
+    # This method checks to see if the specified user has the right o
+    # add content.  Override this method in an individual controller
+    # to provide more restrictive or more liberal permissions.
+    # Parameters:
+    # user    - The user attempting to add content.
+    # parent  - The parent object of the content.  May be nil.
+    # content - The content to be added.  In an overridden method may want to check scope on the content
+    #           to be sure a user doesn't attempt to change the scope to something they shouldn't have
+    #           permission to.
+    def has_permission_to_add_content(user, parent, content)
+      return true if user.can_add_root_content?
+      return false if parent.blank?
+      parent.can_add_content?(user)
+    end
+    
+    # Pass the numeric id to this method to ensure that the operations update and delete occur on the correct object
+    def get_secure_content
+      @content = Content.find(params[:id])
+      unless @content.can_edit?(current_user)
+        respond_to do |format|
+          format.html do
+            flash[:notice] = I18n.t('muck.contents.cant_delete_content')
+            redirect_back_or_default current_user
+          end
+          format.js { render(:update){|page| page.alert I18n.t('muck.contents.cant_delete_content')}}
+        end
+      end
+    end
+    
+    def setup_parent
+      @parent = get_parent
+    end
+end

data/app/helpers/muck_contents_helper.rb

@@ -0,0 +1,22 @@
+module MuckContentsHelper
+  
+  # share is an optional share object that can be used to pre populate the form.
+  # options:
+  #     html options for form:
+  #     :html => {:id => 'a form'}
+  def content_form(content = nil, options = {}, &block)
+    content ||= Content.new
+    options[:html] = {} if options[:html].nil?
+    raw_block_to_partial('contents/form', options.merge(:content => content), &block)
+  end
+  
+  # content uses friendly_id but we want the param in the form to use the number id
+  def get_content_form_url(content, parent)
+    if content.new_record?
+      contents_path(make_muck_parent_params(parent))
+    else
+      content_path(content.id, make_muck_parent_params(parent))
+    end
+  end
+  
+end

data/app/views/admin/contents/index.html.erb

@@ -0,0 +1,28 @@
+<div id="content-pages">
+  <h2><%= t('muck.content.manage_pages_title') %></h2>
+  <div id="pageSearch">
+    <label>Search by Page Name:</label> <input id="autoPages" />
+    <span class="link-button"><%= link_to _("Add New Page"), new_admin_page_path %></span>
+  </div>
+  <div id="pageList">
+    <ul id="pageMasterUl">
+      <%= render :partial => 'admin/pages/page', :collection => @pages, :locals => {:parent_id => 0} -%>
+    </ul>
+  </div>
+</div>
+
+<input id="updatePath" type="hidden" value="<%=admin_pages_path%>">
+
+<script type="text/javascript" language="JavaScript">
+jQuery(document).ready(function() {
+  var data = <%= @pages.collect{|page| { :title => page.title, :id => page.id } }.to_json %>;
+  jQuery("#autoPages").autocomplete(data, {
+    minChars: 0,
+    autoFill: true,
+    mustMatch: false,
+    formatItem: function(item) {
+      return item.title;
+    }
+  }).result(function(event, item) { location.href = '/admin/pages/' + item.id + '/edit'; });
+});
+</script>

data/app/views/contents/_admin.html.erb

@@ -0,0 +1,7 @@
+<% if logged_in? && content.can_edit?(current_user) -%>
+  <% if current_user.can_add_root_content? -%>
+    <%= link_to t('muck.contents.add'), new_content_path, :title => t('muck.contents.add_title'), :class => 'admin-content' -%> |
+  <% end -%>
+  <%= link_to t('muck.contents.edit'), edit_content_path(content.id), :title => t('muck.contents.edit_this_page'), :class => 'admin-content' -%> | 
+  <%= link_to t('muck.contents.delete'), content_path(content.id), :method => :delete, :title => t('muck.contents.delete_title'), :class => 'admin-content', :confirm => t('muck.contents.confirm_delete_content') -%>
+<% end -%>

data/app/views/contents/_form.html.erb

@@ -0,0 +1,13 @@
+<div id="<%= "#{content.dom_id}" %>" class="content_editor">
+  <% custom_form_for(content, :url => get_content_form_url(content, @parent), :html => html.merge(:id => "#{content.dom_id}_content_form", :class => 'content_form') ) do |f| -%>
+    <%= f.text_field :title, {:class => 'title', :tip => t('muck.contents.title_help'), :label => t('muck.contents.title_label') } %>
+    <%= f.text_area :body_raw, {:label => t('muck.contents.content_label'), :class => 'mceEditor', :id => 'mce_content', :tip_key => 'mce_content', :tip => t('muck.contents.content_help') } %>
+    <%= capture(f, &block) %>
+    <%= f.muck_select(:layout, :value, :name, t('muck.contents.choose_layout'), @content_layouts, {:tip => t('muck.contents.choose_layout_help')}) %>
+    <div class="button form-row">
+      <%= f.submit t('muck.contents.submit_content_button'), :class => "button share-submit", :id => "content_submit_#{content.dom_id}" %>
+      <%= f.hidden_field :uri_path unless content.uri_path.blank? %>
+      <%= f.hidden_field :custom_scope unless content.custom_scope.blank? %>
+    </div>
+  <% end %>
+</div>

data/app/views/contents/edit.html.erb

@@ -0,0 +1,6 @@
+<div id="edit_content">
+  <%= output_errors(t('muck.contents.problem_updating_content'), {:class => 'help-box'}, @content) %>
+  <% content_form(@content) do |f| -%>
+    <%# can add form fields as desired here -%>
+  <% end -%>
+</div>

data/app/views/contents/new.html.erb

@@ -0,0 +1,5 @@
+<div id="add_content">
+  <%= output_errors(t('muck.contents.problem_adding_content'), {:class => 'help-box'}, @content) %>
+  <% content_form(@content) do |f| -%>
+  <% end -%>
+</div>

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

@@ -0,0 +1,5 @@
+<% content_for :head do  -%>
+  <meta name="keywords" content="<%=@content.tags.join(',')%>" />
+<% end -%>
+<%= @content.locale_body(I18n.locale) %>
+<%= render :partial => 'contents/admin', :locals => { :content => @content } -%>

data/config/muck_contents_routes.rb

@@ -0,0 +1,8 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :contents, :controller => 'muck/contents'
+  
+  # MuckContents.routes.each do |route|
+  #   map.connect route[:uri], MuckContents.build_route_options(route)
+  # end
+  
+end

data/db/migrate/20090703055724_add_contents.rb

@@ -0,0 +1,49 @@
+class AddContents < ActiveRecord::Migration
+  def self.up
+    create_table :contents, :force => true do |t|
+      t.integer  :creator_id
+      t.string   :title
+      t.text     :body
+      t.string   :locale
+      t.text     :body_raw
+      t.integer  :contentable_id
+      t.string   :contentable_type
+      t.integer  :parent_id
+      t.integer  :lft
+      t.integer  :rgt
+      t.boolean  :is_public
+      t.string   :state
+      t.timestamps
+    end
+
+    create_table :content_translations, :force => true do |t|
+      t.integer  :content_id
+      t.string   :title
+      t.text     :body
+      t.string   :locale
+      t.boolean  :user_edited, :default => false
+      t.timestamps
+    end
+    
+    create_table :content_permissions, :force => true do |t|
+      t.integer  :content_id
+      t.integer  :user_id
+      t.timestamps
+    end
+    
+    add_index :contents, :parent_id
+    add_index :contents, :creator_id
+    
+    add_index :content_translations, :content_id
+    add_index :content_translations, :locale
+    
+    add_index :content_permissions, [:content_id, :user_id]
+  end
+
+  def self.down
+    drop_table :content_versions
+    drop_table :contents
+    drop_table :content_translations
+    drop_table :content_permissions
+  end
+end

data/db/migrate/20090806230610_add_layout_to_contents.rb

@@ -0,0 +1,9 @@
+class AddLayoutToContents < ActiveRecord::Migration
+  def self.up
+    add_column :contents, :layout, :string
+  end
+
+  def self.down
+    remove_column :contents, :layout
+  end
+end

data/db/migrate/20090808005918_add_scope_index_to_slugs.rb

@@ -0,0 +1,9 @@
+class AddScopeIndexToSlugs < ActiveRecord::Migration
+  def self.up
+    add_index :slugs, :scope
+  end
+
+  def self.down
+    remove_index :slugs, :scope
+  end
+end

data/db/migrate/20090808175401_add_contents_comment_counter_cache.rb

@@ -0,0 +1,9 @@
+class AddContentsCommentCounterCache < ActiveRecord::Migration
+  def self.up
+    add_column :contents, :comment_count, :integer, :default => 0
+  end
+
+  def self.down
+    remove_column :contents, :comment_count
+  end
+end