commontator 0.1.46

data/lib/commontator.rb~

@@ -0,0 +1,66 @@
+module Commontator
+  # Attributes and default values
+
+  # Can be overriden in initializer only
+  ENGINE_CONFIG = {
+    :current_user_method => 'current_user',
+    :heading_proc => nil,
+    :javascript_proc => nil,
+  }
+
+  # Can be overriden in initializer and acts_as_commontator
+  COMMONTATOR_CONFIG = {
+    :commontator_name_clickable => false,
+    :commontator_email_method => 'email',
+    :commontator_name_method => '',
+    :is_admin_method => ''
+  }
+  
+  # Can be overriden in initializer and acts_as_commontable
+  COMMONTABLE_CONFIG = {
+    :comment_name => 'comment',
+    :comment_create_verb_present => 'post',
+    :comment_create_verb_past => 'posted',
+    :commontable_name => 'commontable',
+    :subscription_email_subject_proc => Proc.new {|params| "#{params[:commontator_name]} " + \
+      "#{params[:config].comment_create_verb_past} a #{params[:config].comment_name} on " + \
+      "#{params[:commontable_name]} ##{params[:commontable_id]}"},
+    :subscription_email_body_proc => nil,
+    :timestamp_format => '%b %d %Y, %I:%M %p',
+    :admin_can_edit_comments => false,
+    :auto_subscribe_on_comment => false,
+    :can_edit_old_comments => false,
+    :can_edit_own_comments => true,
+    :can_delete_old_comments => false,
+    :can_delete_own_comments => false,
+    :can_subscribe_to_thread => true,
+    :comments_can_be_voted_on => false,
+    :closed_threads_are_readable => true,
+    :deleted_comments_are_visible => true,
+    :commontable_id_method => 'id',
+    :can_edit_thread_method => '',
+    :can_read_thread_method => '',
+    :comment_created_callback => '',
+    :comment_edited_callback => '',
+    :comment_deleted_callback => '',
+    :thread_closed_callback => '',
+    :subscribe_callback => '',
+    :unsubscribe_callback => ''
+  }
+  
+  ENGINE_CONFIG.merge(COMMONTATOR_CONFIG.merge(\
+    COMMONTABLE_CONFIG)).each do |key, value|
+    mattr_accessor key
+    self.send key.to_s + '=', value
+  end
+  
+  def self.configure
+    yield self
+  end
+end
+
+require 'commontator/engine'
+require 'commontator/commontator_config'
+require 'commontator/commontable_config'
+require 'commontator/acts_as_commontator'
+require 'commontator/acts_as_commontable'

data/lib/commontator/acts_as_commontable.rb

@@ -0,0 +1,39 @@
+module Commontator
+  module ActsAsCommontable
+    def self.included(base)
+      base.class_attribute :is_commontable
+      base.is_commontable = false
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+      def acts_as_commontable(options = {})
+        class_eval do
+          has_one :thread, :as => :commontable, :class_name => 'Commontator::Thread', :dependent => :destroy
+          has_many :comments, :class_name => 'Commontator::Comment', :through => :thread
+          has_many :subscriptions, :class_name => 'Commontator::Subscription', :through => :thread
+          
+          after_initialize :create_thread, :unless => :thread, :if => :id
+          before_validation :build_thread, :unless => :thread
+          
+          validates_presence_of :thread
+          
+          cattr_accessor :commontable_config
+          self.commontable_config = Commontator::CommontableConfig.new
+          self.is_commontable = true
+          
+          def create_thread
+            thread = Commontator::Thread.new
+            thread.commontable = self
+            thread.save!
+            self.reload
+          end
+        end
+      end
+      
+      alias_method :acts_as_commentable, :acts_as_commontable
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Commontator::ActsAsCommontable

data/lib/commontator/acts_as_commontable.rb~

@@ -0,0 +1,42 @@
+module Commontator
+  module ActsAsCommontable
+    def self.included(base)
+      base.class_attribute :is_commontable
+      base.is_commontable = false
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+      def acts_as_commontable(options = {})
+        class_eval do
+          has_one :thread, :as => :commontable, :class_name => 'Commontator::Thread', :dependent => :destroy
+          has_many :comments, :class_name => 'Commontator::Comment', :through => :thread
+          has_many :subscriptions, :class_name => 'Commontator::Subscription', :through => :thread
+          
+          after_initialize :create_thread, :unless => :thread, :if => :id
+          before_validation :build_thread, :unless => :thread
+          
+          validates_presence_of :thread
+          
+          cattr_accessor :commontable_config
+          self.commontable_config = Commontator::CommontableConfig.new
+          self.is_commontable = true
+          
+          def create_thread
+            thread = Commontator::Thread.new
+            thread.commontable = self
+            thread.save!
+            self.reload
+          end
+        end
+      end
+      
+      alias_method :acts_as_commentable, :acts_as_commontable
+      def acts_as_commentable(options = {})
+        acts_as_commontable(options)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Commontator::ActsAsCommontable

data/lib/commontator/acts_as_commontator.rb

@@ -0,0 +1,28 @@
+module Commontator
+  module ActsAsCommontator
+    def self.included(base)
+      base.class_attribute :is_commontator
+      base.is_commontator = false
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+      def acts_as_commontator(options = {})
+        class_eval do
+          has_many :comments, :as => :commontator, :class_name => 'Commontator::Comment', :dependent => :destroy
+          has_many :subscriptions, :as => :subscriber, :class_name => 'Commontator::Subscription', :dependent => :destroy
+          
+          cattr_accessor :commontator_config
+          self.commontator_config = Commontator::CommontatorConfig.new(options)
+          self.is_commontator = true
+        end
+      end
+      
+      alias_method :acts_as_commonter, :acts_as_commontator
+      alias_method :acts_as_commentator, :acts_as_commontator
+      alias_method :acts_as_commenter, :acts_as_commontator
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Commontator::ActsAsCommontator

data/lib/commontator/acts_as_commontator.rb~

@@ -0,0 +1,37 @@
+module Commontator
+  module ActsAsCommontator
+    def self.included(base)
+      base.class_attribute :is_commontator
+      base.is_commontator = false
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+      def acts_as_commontator(options = {})
+        class_eval do
+          has_many :comments, :as => :commontator, :class_name => 'Commontator::Comment', :dependent => :destroy
+          has_many :subscriptions, :as => :subscriber, :class_name => 'Commontator::Subscription', :dependent => :destroy
+          
+          cattr_accessor :commontator_config
+          self.commontator_config = Commontator::CommontatorConfig.new(options)
+          self.is_commontator = true
+        end
+      end
+      
+      alias_method :acts_as_commonter, :acts_as_commontator
+      def acts_as_commonter(options = {})
+        acts_as_commontator(options)
+      end
+      
+      def acts_as_commentator(options = {})
+        acts_as_commontator(options)
+      end
+      
+      def acts_as_commenter(options = {})
+        acts_as_commontator(options)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Commontator::ActsAsCommontator

data/lib/commontator/commontable_config.rb

@@ -0,0 +1,13 @@
+module Commontator
+  class CommontableConfig
+    Commontator::COMMONTABLE_CONFIG.keys.each do |attribute|
+      cattr_accessor attribute
+    end
+  
+    def initialize(options = {})
+      Commontator::COMMONTABLE_CONFIG.keys.each do |attribute|
+        self.send attribute.to_s + '=', options[attribute] || Commontator.send(attribute)
+      end
+    end
+  end
+end

data/lib/commontator/commontator_config.rb

@@ -0,0 +1,13 @@
+module Commontator
+  class CommontatorConfig
+    Commontator::COMMONTATOR_CONFIG.keys.each do |attribute|
+      cattr_accessor attribute
+    end
+  
+    def initialize(options = {})
+      Commontator::COMMONTATOR_CONFIG.keys.each do |attribute|
+        self.send attribute.to_s + '=', options[attribute] || Commontator.send(attribute)
+      end
+    end
+  end
+end

data/lib/commontator/engine.rb

@@ -0,0 +1,5 @@
+module Commontator
+  class Engine < ::Rails::Engine
+    isolate_namespace Commontator
+  end
+end

data/lib/commontator/routes.rb~

@@ -0,0 +1,37 @@
+module ActionDispatch::Routing
+  class Mapper
+    def commontable
+      namespace :commontator do
+        resources :comment_commontable_threads, :only => [:show], :shallow => true do
+          resources :comments, :except => [:index], :shallow => true
+          put 'close', :on => :member
+          put 'reopen', :on => :member
+          get 'subscribe', :to => 'subscriptions#create',
+                            :as => 'subscribe',
+                            :on => :member
+          get 'unsubscribe', :to => 'subscriptions#destroy',
+                              :as => 'unsubscribe',
+                              :on => :member
+        end
+      end
+    end
+    
+    def commontator
+      namespace :commontator do
+        resources :subscriptions, :only => [:index], :shallow => true
+      end
+    end
+
+    def commentable
+      commontable
+    end
+    
+    def commonter
+      commontator
+    end
+    
+    def commentator
+      commontator
+    end
+  end
+end

data/lib/commontator/version.rb

@@ -0,0 +1,3 @@
+module Commontator
+  VERSION = "0.1.46"
+end

data/lib/commontator/version.rb~

@@ -0,0 +1,3 @@
+module Commontator
+  VERSION = "0.1.45"
+end

data/test/commontator_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CommontatorTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Commontator
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== 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.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.org/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
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+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. 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.