sinatra-disqus 1.1.0 → 2.0.0

data/CHANGES.md

@@ -1,18 +1,33 @@
 ## CH-CH-CH-CH-CHANGES! ##
 
+### Friday the 28th of June 2013, v2.0.0 ###
+
+* Disqus has dropped support for developer mode. Updated to reflect this.
+* Updated scripts.
+* 100% coverage for documentation.
+
+----
+
+
 ### Saturday the 20th of April 2013, v1.1.0 ###
 
 * More updating of docs.
 * Removed reliance on Haml.
 
+----
+
+
 ### Saturday the 20th of April 2013, v1.0.0 ###
 
 * Updated the docs a bit.
 * Bumped to v1.0.0 for semver.
 
+----
+
+
 ### Thursday the 9th of August 2012, v0.0.1 ###
 
 * First release.
 * It has a spec!
 
-----
+----

data/README.md

@@ -13,17 +13,21 @@ or via Bundler:
 
 ### Example ###
 
+Note: It used to be that you were able to put Disqus into "development mode", [this is no longer valid](http://iainbarnett.me.uk/articles/disqus-developer-mode). Instead, add another site shortname and modify the settings slightly, similar to the examples below.
+
 #### Classic style
 
     require 'sinatra'
     require 'haml'
     require 'sinatra/disqus'
       
-    configure do
+    configure :production do
       # Disqus settings
       set :disqus_shortname, "example.org"
-       # Put disqus into developer mode unless in production.
-      set :disqus_developer, !production?
+    end
+
+    configure :development, :test do
+      set :disqus_shortname, "dev-example.org"
     end
 
     get "/" do
@@ -58,11 +62,16 @@ or via Bundler:
       
       configure do
         enable :inline_templates # just for this example
+      end
 
+      configure :production do
         # Disqus settings
         set :disqus_shortname, "example.org"
-        # Put disqus into developer mode unless in production.
-        set :disqus_developer, !production?
+      end
+
+      configure :development do
+        # Disqus settings
+        set :disqus_shortname, "dev-example.org"
       end
       
       get "/" do

data/lib/sinatra/disqus/version.rb

@@ -2,6 +2,7 @@
 
 module Sinatra
   module Disqus
-    VERSION = "1.1.0"
+    # This library's version.
+    VERSION = "2.0.0"
   end
 end

data/lib/sinatra/disqus.rb

@@ -2,32 +2,36 @@
 
 require 'sinatra/base'
 
+# @see http://www.sinatrarb.com/
 module Sinatra
+
+  # Drop in disqus to any Sinatra view via a handy helper. 
   module Disqus
 
+    # Top part of the javascripts.
     Disqus_output_top = <<TOP
-<div id='disqus_thread'>
-  <script type='text/javascript'>
-    //<![CDATA[
+<div id='disqus_thread'></div>
+<script type='text/javascript'>
+  //<![CDATA[
 TOP
+
+    # The bottom bit of the sandwich we're making.
     Disqus_output_bottom = <<BOTTOM
-      (function() {
-          var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
-          dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
-          (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
-      })();
-    //]]>
-  </script>
-  <noscript>
-    Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a>
-  </noscript>
-  <p>
-    <a href="http://disqus.com" class="dsq-brlink">blog comments powered by <span class="logo-disqus">Disqus</span></a>
-  </p>
-</div>
+    (function() {
+        var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+        dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+    })();
+  //]]>
+</script>
+<noscript>
+  Please enable JavaScript to view the <a href="//disqus.com/?ref_noscript">comments powered by Disqus.</a>
+</noscript>
+<a href="//disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
 BOTTOM
 
     # @private
+    # Private yet helpful methods.
     module Private
       require 'digest/md5'
     
@@ -40,53 +44,39 @@ BOTTOM
 
       # @param [Hash] opts
       # @option opts [String] :title The page title, usually held in @title
-      # @option opts [0,1] :disqus_developer The development mode.
       # @option opts [String] :disqus_shortname The short name of the site (e.g. example.org )
       # @option opts [String] :disqus_identifier The unique identifier the page the comments sit on.
       # @option opts [String] :request_url The page's url.
       # @return [String] The portion of the disqus javascript with the vars.
+      # @note The option :disqus_developer is no longer supported by Disqus
       def self.build_vars( opts )
 <<STR
-      var disqus_title = "#{opts[:title].gsub(/'/, "\\\\'")}";
-      var disqus_developer = #{opts[:disqus_developer]}; // developer mode
-      var disqus_shortname = '#{opts[:disqus_shortname]}';
-      var disqus_identifier = '#{opts[:disqus_identifier]}'; // is on if 1
-      var disqus_url = '#{opts[:request_url]}';
+    var disqus_title = "#{opts[:title].gsub(/'/, "\\\\'")}";
+    var disqus_shortname = '#{opts[:disqus_shortname]}';
+    var disqus_identifier = '#{opts[:disqus_identifier]}';
+    var disqus_url = '#{opts[:request_url]}';
 STR
       end
     end
 
 
+    # Handy helpers.
     module Helpers
       
       # @return [String] Returns the bit of HTML/javascript to stick in the page.
       def inject_disqus
-        "#{Disqus_output_top}#{Private.build_vars(request_url: uri(request.path_info), disqus_shortname: settings.disqus_shortname, disqus_developer: settings.disqus_developer, title: @title, disqus_identifier: Private.disqus_identifier(request.path))}#{Disqus_output_bottom}"
+        "#{Disqus_output_top}#{Private.build_vars(request_url: uri(request.path_info), disqus_shortname: settings.disqus_shortname, title: @title, disqus_identifier: Private.disqus_identifier(request.path))}#{Disqus_output_bottom}"
       end
 
     end
 
 
+    # Sinatra hook for extensions.
     def self.registered(app)
       app.helpers Disqus::Helpers
-  
-  
+
       # @param [String] s The short name of the site (e.g. example.org )
       app.set :disqus_shortname, nil
-  
-  
-      # @param [true,false,nil] bool Whether developer mode is on (true), off (false) or set to use the default (nil), which is the current environment (if production then off).
-      def disqus_developer=(bool)
-        @disqus_developer = bool
-      end
-  
-      # @return [0,1] 0 is off, 1 is on.
-      def disqus_developer
-        if @disqus_developer.nil? 
-          @disqus_developer = ENV['RACK_ENV'] == "production" ? false : true
-        end
-        @disqus_developer ? 1 : 0 
-      end
 
     end # registered
   end

data/spec/disqus_spec.rb

@@ -10,28 +10,24 @@ describe "Disqus" do
   it_should_behave_like "Any route"
   context "Output" do
     let(:expected) { <<STR
-<div id='disqus_thread'>
-  <script type='text/javascript'>
-    //<![CDATA[
-      var disqus_title = "Home";
-      var disqus_developer = 1; // developer mode
-      var disqus_shortname = 'example.org';
-      var disqus_identifier = '6666cd76f96956469e7be39d750cc7d9'; // is on if 1
-      var disqus_url = 'http://example.org/';
-      (function() {
-          var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
-          dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
-          (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
-      })();
-    //]]>
-  </script>
-  <noscript>
-    Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a>
-  </noscript>
-  <p>
-    <a href="http://disqus.com" class="dsq-brlink">blog comments powered by <span class="logo-disqus">Disqus</span></a>
-  </p>
-</div>
+<div id='disqus_thread'></div>
+<script type='text/javascript'>
+  //<![CDATA[
+    var disqus_title = "Home";
+    var disqus_shortname = 'example.org';
+    var disqus_identifier = '6666cd76f96956469e7be39d750cc7d9';
+    var disqus_url = 'http://example.org/';
+    (function() {
+        var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+        dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+    })();
+  //]]>
+</script>
+<noscript>
+  Please enable JavaScript to view the <a href="//disqus.com/?ref_noscript">comments powered by Disqus.</a>
+</noscript>
+<a href="//disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
 STR
     }
     subject{ last_response.body }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-disqus
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-20 00:00:00.000000000 Z
+date: 2013-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra