disqus 0.1.0 → 0.1.1

data/README.textile

@@ -2,7 +2,7 @@ h1. Disqus Ruby Gem
 
 The Disqus Gem helps you easily integrate the "Disqus":http://disqus.com
 commenting system into your website. It works for any site programmed in Ruby,
-not just Rails.
+and has view helpers for Rails and Merb.
 
 h2. Get it
 
@@ -33,16 +33,20 @@ h3. Show the comment threads on a post page:
 <pre>
 <code>
   # Loads the commenting system
-  Disqus::Widget::thread
-  # Or if you're using Rails:
   disqus_thread
   
-  # Appends the comment count to a end of link text for a url that ends with
-  # #disqus_thread. For example:
+  # Or if you're not using Rails/Merb:
+  Disqus::Widget::thread
+  
+  # Sets the inner html to the comment count for any links on the page that
+  # have the anchor "disqus_thread". For example, "View Comments" below would
+  # be replaced by "1 comment" or "23 comments" etc.
   # <a href="http://my.website/article-permalink#disqus_thread">View Comments</a>
-  Disqus::Widget::comment_counts
-  # Or if you're using Rails:
+  # <a href="http://my.website/different-permalink#disqus_thread">View Comments</a>
   disqus_comment_counts
+  
+  # Or if you're not using Rails/Merb:
+  Disqus::Widget::comment_counts
 </code>
 </pre>
 
@@ -50,9 +54,10 @@ h3. Show the combo widget on a post page:
 
 <pre>
 <code>
-  Disqus::Widget::combo(:color => "blue", :hide_mods => false, :num_items => 25)
-  # Or if you're using Rails:
   disqus_combo(:color => "blue", :hide_mods => false, :num_items => 25)
+  
+  # Or for non-Rails/Merb:
+  Disqus::Widget::combo(:color => "blue", :hide_mods => false, :num_items => 25)
 </code>
 </pre>
 
@@ -62,9 +67,10 @@ h3. Show the comment count on a permalink:
 <code>
   link_to("Permalink", post_path(@post, :anchor => "disqus_thread"))
   ...
-  Disqus::Widget::comment_counts
-  # Or for Rails:
   disqus_comment_counts
+  
+  # Or for non-Rails/Merb:
+  Disqus::Widget::comment_counts
 </code>
 </pre>    
 
@@ -80,5 +86,9 @@ h2. Learn more about Disqus:
 
 "http://disqus.com":http://disqus.com
 
+h2. Thanks to the following contributors:
+
+* "Quin Hoxie":http://github.com/qhoxie - Merb support
+
 Copyright (c) 2008 "Norman Clarke":norman@randomba.org, released under
 the MIT license

data/Rakefile

@@ -38,5 +38,5 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.title    = 'Disqus'
   rdoc.options << '--line-numbers' << '--inline-source' << '-c UTF-8'
   rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.rdoc_files.include('README.txt')
-end
+  rdoc.rdoc_files.include('README.textile')
+end

data/lib/disqus.rb

@@ -1,6 +1,5 @@
 require 'disqus/widget'
   
-
 # Disqus is a javascript embed that enhances your blog's comments and
 # integrates it with a fully moderated community forum. The Disqus gem helps
 # you quickly and easily integrate Disqus's widgets into your Ruby-based 
@@ -19,18 +18,40 @@ module Disqus
     :orientation => "horizontal"
   }
   
+  # Disqus defaults:
+  #  :account => "",
+  #  :avatar_size => 48,
+  #  :color => "grey",
+  #  :default_tab => "popular",
+  #  :hide_avatars => false,
+  #  :hide_mods => true,
+  #  :num_items => 15,
+  #  :show_powered_by => true,
+  #  :orientation => "horizontal"
   def self.defaults
     @defaults
   end
   
+  # Load the view helpers if the gem is included in a Rails app.
   def self.enable_rails
     return if ActionView::Base.instance_methods.include? 'disqus_thread'
-    require 'disqus/rails_view_helpers'
-    ActionView::Base.class_eval { include Disqus::RailsViewHelpers }
+    require 'disqus/view_helpers'
+    ActionView::Base.class_eval { include Disqus::ViewHelpers }
+  end
+
+  # Load the view helpers if the gem is included in a Merb app.
+  def self.enable_merb
+    return if Merb::Controller.instance_methods.include? 'disqus_thread'
+    require 'disqus/view_helpers'
+    Merb::Controller.class_eval { include Disqus::ViewHelpers }
   end
 
 end
 
 if defined?(Rails) and defined?(ActionView)
   Disqus::enable_rails
+end
+
+if defined?(Merb)
+  Disqus::enable_merb
 end

data/lib/disqus/view_helpers.rb

@@ -0,0 +1,45 @@
+module Disqus
+
+  # Shortcuts to access the widgets as simple functions as opposed to using
+  # their full qualified names. These helpers are loaded automatically in
+  # Rails and Merb apps. 
+  #
+  # For Sinatra, Camping, Nitro or other frameworks, you can include the
+  # helper if you wish, or use the fully-qualified names. Really this is just
+  # here for aesthetic purposes and to make it less likely to step on anyone's
+  # namespace.
+  module ViewHelpers
+    
+    # See Disqus::Widget.thread
+    def disqus_thread(options = {})
+      Disqus::Widget::thread(options)
+    end
+    
+    # See Disqus::Widget.comment_counts
+    def disqus_comment_counts(options = {})
+      Disqus::Widget::comment_counts(options)
+    end
+    
+    # See Disqus::Widget.top_commenters
+    def disqus_top_commenters(options = {})
+      Disqus::Widget::top_commenters(options)
+    end
+    
+    # See Disqus::Widget.popular_threads
+    def disqus_popular_threads(options = {})
+      Disqus::Widget::popular_threads(options)
+    end
+    
+    # See Disqus::Widget.recent_comments
+    def disqus_recent_comments(options = {})
+      Disqus::Widget::recent_comments(options)
+    end
+    
+    # See Disqus::Widget.combo
+    def disqus_combo(options = {})
+      Disqus::Widget::combo(options)
+    end
+    
+  end
+
+end

data/lib/disqus/widget.rb

@@ -1,9 +1,14 @@
 module Disqus
 
+  # Disqus Widget generator.
+  #
+  # All of the methods accept various options, and "account" is required for
+  # all of them. You can avoid having to pass in the account each time by
+  # setting it in the defaults like this:
+  #
+  #  Disqus::defaults[:account] = "my_account"
   class Widget
   
-    class Error < StandardError ; end
-    
     VALID_COLORS = ['blue', 'grey', 'green', 'red', 'orange']
     VALID_NUM_ITEMS = 5..20
     VALID_DEFAULT_TABS = ['people', 'recent', 'popular']
@@ -18,7 +23,8 @@ module Disqus
     TOP = ROOT_PATH + 'top_commenters_widget.js?num_items=%d&avatar_size=%d&orientation=%s'
     class << self
       
-      # Show the main Disqus thread widget. Options:
+      # Show the main Disqus thread widget.
+      # Options:
       # * <tt>account:</tt> Your Discus account (required).
       def thread(opts = {})
         opts = Disqus::defaults.merge(opts)
@@ -36,7 +42,15 @@ module Disqus
         s % [opts[:account], opts[:account]]
       end
       
-      # Loads Javascript to show the number of comments for the page. Options:
+      # Loads Javascript to show the number of comments for the page.
+      #
+      # The Javascript sets the inner html to the comment count for any links
+      # on the page that have the anchor "disqus_thread". For example, "View
+      # Comments" below would be replaced by "1 comment" or "23 comments" etc.
+      #
+      #   <a href="http://my.website/article-permalink#disqus_thread">View Comments</a>
+      #   <a href="http://my.website/different-permalink#disqus_thread">View Comments</a>
+      # Options:
       # * <tt>account:</tt> Your Discus account (required).
       def comment_counts(opts = {})
         opts = Disqus::defaults.merge(opts)        
@@ -60,7 +74,8 @@ module Disqus
         s % opts[:account]
       end
       
-      # Show the main Disqus thread widget. Options:
+      # Show the top commenters Disqus thread widget.
+      # Options:
       # * <tt>account:</tt> Your Discus account (required).
       # * <tt>header:</tt> HTML snipper with header (default h2) tag and text.
       # * <tt>show_powered_by:</tt> Show or hide the powered by Disqus text.
@@ -86,7 +101,8 @@ module Disqus
         s % [opts[:account], opts[:num_items], opts[:avatar_size], opts[:orientation]]
       end
       
-      # Show the main Disqus thread widget. Options:
+      # Show the popular threads Disqus widget.
+      # Options:
       # * <tt>account:</tt> Your Discus account (required).
       # * <tt>header:</tt> HTML snipper with header (default h2) tag and text.
       # * <tt>num_items:</tt>: How many items to show.
@@ -106,7 +122,8 @@ module Disqus
         s % [opts[:account], opts[:num_items]]
       end
     
-      # Show the main Disqus thread widget. Options:
+      # Show the recent comments Disqus widget.
+      # Options:
       # * <tt>account:</tt> Your Discus account (required).
       # * <tt>header:</tt> HTML snipper with header (default h2) tag and text.
       # * <tt>num_items:</tt>: How many items to show.
@@ -129,10 +146,13 @@ module Disqus
         s % [opts[:account], opts[:num_items], opts[:avatar_size]]
       end
     
-      # Show the main Disqus thread widget. Options:
-      # * <tt>account:</tt> Your Discus account (required).
-      # * <tt>num_items:</tt>: How many items to show.
-      # * <tt>hide_mods:</tt> Don't show moderators.
+      # Show the Disqus combo widget. This is a three-tabbed box with links
+      # popular threads, top posters, and recent threads.
+      # Options:
+      # * <tt>:account:</tt> Your Discus account (required).
+      # * <tt>:num_items:</tt> How many items to show.
+      # * <tt>:hide_mods:</tt> Don't show moderators.
+      # * <tt>:default_tab:</tt> Should be 'people', 'recent', or 'popular'.
       def combo(opts = {})
         opts = Disqus::defaults.merge(opts)
         validate_opts!(opts)
@@ -146,12 +166,12 @@ module Disqus
       private
 
       def validate_opts!(opts)
-        raise Error.new("You must specify an :account") if !opts[:account]
-        raise Error.new("Invalid color") if opts[:color] && !VALID_COLORS.include?(opts[:color])
-        raise Error.new("Invalid num_items") if opts[:num_items] && !VALID_NUM_ITEMS.include?(opts[:num_items])
-        raise Error.new("Invalid default_tab") if opts[:default_tab] && !VALID_DEFAULT_TABS.include?(opts[:default_tab])
-        raise Error.new("Invalid avatar size") if opts[:avatar_size] && !VALID_AVATAR_SIZES.include?(opts[:avatar_size])
-        raise Error.new("Invalid orientation") if opts[:orientation] && !VALID_ORIENTATIONS.include?(opts[:orientation])
+        raise ArgumentError.new("You must specify an :account") if !opts[:account]
+        raise ArgumentError.new("Invalid color") if opts[:color] && !VALID_COLORS.include?(opts[:color])
+        raise ArgumentError.new("Invalid num_items") if opts[:num_items] && !VALID_NUM_ITEMS.include?(opts[:num_items])
+        raise ArgumentError.new("Invalid default_tab") if opts[:default_tab] && !VALID_DEFAULT_TABS.include?(opts[:default_tab])
+        raise ArgumentError.new("Invalid avatar size") if opts[:avatar_size] && !VALID_AVATAR_SIZES.include?(opts[:avatar_size])
+        raise ArgumentError.new("Invalid orientation") if opts[:orientation] && !VALID_ORIENTATIONS.include?(opts[:orientation])
       end
       
     end

data/test/{rails_view_helpers_test.rb → view_helpers_test.rb}

@@ -1,10 +1,10 @@
 require 'test/unit'
 require 'disqus'
-require 'disqus/rails_view_helpers'
+require 'disqus/view_helpers'
 
-class DisqusWidgetTest < Test::Unit::TestCase
+class ViewHelpersTest < Test::Unit::TestCase
   
-  include Disqus::RailsViewHelpers
+  include Disqus::ViewHelpers
   
   def setup
     Disqus::defaults[:account] = "tests"

data/test/widget_test.rb

@@ -32,25 +32,25 @@ class DisqusWidgetTest < Test::Unit::TestCase
   end
 
   def test_invalid_default_tab
-    assert_raises Disqus::Widget::Error do
+    assert_raises ArgumentError do
       Disqus::Widget::combo(:default_tab => "test")
     end
   end
 
   def test_invalid_color
-    assert_raises Disqus::Widget::Error do
+    assert_raises ArgumentError do
       Disqus::Widget::combo(:color => "test")
     end
   end
 
   def test_invalid_num_items
-    assert_raises Disqus::Widget::Error do
+    assert_raises ArgumentError do
       Disqus::Widget::combo(:num_items => 100)
     end
   end
 
   def test_invalid_avatar_size
-    assert_raises Disqus::Widget::Error do
+    assert_raises ArgumentError do
       Disqus::Widget::top_commenters(:avatar_size => 100)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: disqus
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Norman Clarke
@@ -9,33 +9,32 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-27 00:00:00 -03:00
+date: 2008-09-03 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
-description: Integrates Disqus into your Ruby-powered site. Works with any Ruby website, not just Rails.
+description: Integrates Disqus into your Ruby-powered site. Works with any Ruby website, and has view helpers for Rails and Merb.
 email: norman@randomba.org
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.txt
+- README.textile
 files: 
 - MIT-LICENSE
 - README.textile
-- README.txt
 - init.rb
 - lib/disqus.rb
 - lib/disqus/widget.rb
-- lib/disqus/rails_view_helpers.rb
+- lib/disqus/view_helpers.rb
 - Rakefile
 has_rdoc: true
 homepage: http://randomba.org
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.textile
 - --inline-source
 - --line-numbers
 require_paths: 
@@ -61,4 +60,4 @@ specification_version: 2
 summary: Integrates Disqus commenting system into your Ruby-powered site.
 test_files: 
 - test/widget_test.rb
-- test/rails_view_helpers_test.rb
+- test/view_helpers_test.rb

data/README.txt

@@ -1,65 +0,0 @@
-Disqus Ruby Gem
-
-The Disqus Gem helps you easily integrate the Disqus commenting system into your website. It works for any site programmed in Ruby, not just Rails.
-
-Get it
-
-Stable release:
-
-gem install disqus
-
-Bleeding edge:
-
-gem install norman-disqus --source http://gems.github.com
-
-Use it:
-
-Configure it:
-
-
-  Disqus::defaults[:account] = "my_account" 
-
-Show the comment threads on a post page:
-
-
-  # Loads the commenting system
-  Disqus::Widget::thread
-  # Or if you're using Rails:
-  disqus_thread
-
-  # Appends the comment count to a end of link text for a url that ends with
-  # #disqus_thread. For example:
-  # <a href="http://my.website/article-permalink#disqus_thread">View Comments</a>
-  Disqus::Widget::comment_counts
-  # Or if you're using Rails:
-  disqus_comment_counts
-
-Show the combo widget on a post page:
-
-
-  Disqus::Widget::combo(:color => "blue", :hide_mods => false, :num_items => 25)
-  # Or if you're using Rails:
-  disqus_combo(:color => "blue", :hide_mods => false, :num_items => 25)
-
-Show the comment count on a permalink:
-
-
-  link_to("Permalink", post_path(@post, :anchor => "disqus_thread"))
-  ...
-  Disqus::Widget::comment_counts
-  # Or for Rails:
-  disqus_comment_counts
-
-Hack it:
-
-Github repository: http://github.com/norman/disqus
-
-Complain about it:
-
-norman@randomba.org
-
-Learn more about Disqus:
-
-http://disqus.com
-
-Copyright© 2008 Norman Clarke, released under the MIT license

data/lib/disqus/rails_view_helpers.rb

@@ -1,31 +0,0 @@
-module Disqus
-
-  module RailsViewHelpers
-    
-    def disqus_thread(options = {})
-      Disqus::Widget::thread(options)
-    end
-    
-    def disqus_comment_counts(options = {})
-      Disqus::Widget::comment_counts(options)
-    end
-    
-    def disqus_top_commenters(options = {})
-      Disqus::Widget::top_commenters(options)
-    end
-    
-    def disqus_popular_threads(options = {})
-      Disqus::Widget::popular_threads(options)
-    end
-    
-    def disqus_recent_comments(options = {})
-      Disqus::Widget::recent_comments(options)
-    end
-    
-    def disqus_combo(options = {})
-      Disqus::Widget::combo(options)
-    end
-    
-  end
-
-end