middleman-disqus 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 201d480dd074109ef44da43e8623fbeaa449e876
-  data.tar.gz: 2aa8c23e7242cc564abd86a21179d96bc3a03514
+  metadata.gz: d552d193d5f180f06a48f7e49e4ce16deb72e467
+  data.tar.gz: 50615410d5a80e524dad1f174f0b1a55b0b7df29
 SHA512:
-  metadata.gz: b9381633cd561c76b96071e1c962530889a0bfa482abef5d7a8fd5b0c174ea9a5fe8c2275fa4dd84cec04586c392b258057dec41a685bf962be5c88ea12083a5
-  data.tar.gz: 8ac8c992d2fd6d70779ed23d5077cd1cd1ef2153294b0a2443be0071f9df5ce9fb9657cce55800a1f491d884ef91cbf891511d27cad0e19a9c5ccdea4e8b9e42
+  metadata.gz: 86258d1c47c86f6def9738621cfcb8cc3a68e6ce3923783496a228d0786f75565d807d1285e61706327dc2db92d340fe80b898230b25c0c4b8bde2bf3e3c2cf8
+  data.tar.gz: 063392125c3309b40cdbe86df182eb0bc7f540e6c95eb878d5d7fbbf8e1edcc0bae7dce3b2c3c5eb8777e8869f805dd8daca0da6ff004974d358e7b9a9fc477d

data/.travis.yml

@@ -1,18 +1,18 @@
 language: ruby
 rvm:
+  - ruby-head
+  - 2.1.2
+  - 2.1.1
+  - 2.1.0
   - 2.0.0
   - 1.9.3
-  - 1.9.2
-  - jruby-18mode
-  - jruby-19mode
+  - rbx-2
   - rbx-19mode
-  - ruby-head
   - jruby-head
-  - 1.8.7
-  - ree
+  - jruby-19mode
 
 matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: rbx-18mode
+    - rvm: rbx-2

data/HISTORY.md

@@ -0,0 +1,16 @@
+## 1.0.0 (2014-08-06)
+
+* Add support for Disqus JavaScript configuration variables using per page
+  YAML Frontmatter.
+* Add support for Disqus count.js to allow displaying of comment counts.
+* General refactoring of codebase.
+
+## 0.0.3 (2013-07-16)
+
+* Restructure code to conform with new extension style.
+* Update middleman dependency to v3.1.0 and up.
+* Add tests & travis-ci.org configuration file.
+
+## 0.0.2 (2013-06-23)
+
+* Initial release.

data/README.md

@@ -2,66 +2,127 @@
 
 [![Build Status](https://travis-ci.org/simonrice/middleman-disqus.png)](https://travis-ci.org/simonrice/middleman-disqus)
 [![Gem Version](https://badge.fury.io/rb/middleman-disqus.png)](http://badge.fury.io/rb/middleman-disqus)
-[![Dependency Status](https://gemnasium.com/simonrice/middleman-disqus.png)](https://gemnasium.com/simonrice/middleman-disqus) 
+[![Dependency Status](https://gemnasium.com/simonrice/middleman-disqus.png)](https://gemnasium.com/simonrice/middleman-disqus)
 [![Code Climate](https://codeclimate.com/github/simonrice/middleman-disqus.png)](https://codeclimate.com/github/simonrice/middleman-disqus)
 
 Middleman-Disqus is a [Middleman](https://github.com/middleman/middleman)
 extension that generates the Disqus embed code, and keeps your config
 in `config.rb`, where it belongs.
 
-This plugin is based on [middleman-google-analytics](https://github.com/MrJoy/middleman-google-analytics).
-
 ## Installation
 
-If you already have a Middleman project:
 
-Add `gem "middleman-disqus"` to your `Gemfile` then open up your `config.rb` and add:
+1. Specify the dependency in your project's `Gemfile`:
+
+  ```ruby
+  # Gemfile
+  gem "middleman-disqus"
+  ```
+
+2. Activate the Disqus extension in your project's `config.rb`.
+**(n.b. read [important information about shortnames](#important-do-not-use-real-shortnames-during-development))**
+
+  ```ruby
+  # config.rb
+  activate :disqus do |d|
+    d.shortname = 'your-shortname' # Replace with your Disqus shortname.
+  end
+  ```
+
+3. In your layout or template call `disqus` and/or `discus_count` and
+include the results in the page:
+
+  **Haml:**
+
+  ```haml
+  / link with `#disqus_thread` is optional if not using `disqus_count` -->
+  %a{:href => "http://example.com/foo.html#disqus_thread"} Comments
+
+  = disqus
+  = disqus_count
+  ```
+
+  **ERB:**
+
+  ```erb
+  <!-- link with `#disqus_thread` is optional if not using `disqus_count` -->
+  <a href="http://example.com/foo.html#disqus_thread">Comments</a>
+
+  <%= disqus %>
+  <%= disqus_count %>
+  ```
+
+## Helper methods
+
+The following helper methods are available within your templates:
+
+- `disqus` will include the Disqus embed.js code and display comments.
+- `disqus_count` will include the Disqus count.js code for displaying
+  a comment count on links when you set #disqus_thread to the href attribute.
+
+## Configuration: config.rb
 
 ```ruby
-# Activate Disqus extension
 activate :disqus do |d|
-  d.shortname = "your_shortname"
+  # Disqus shotname, without '.disqus.com' on the end (default = nil)
+  d.shortname = 'your_shortname'
 end
 ```
 
-Then, in your relevant layout(s), after your footer, call `disqus` and
-include the results in the page.  For example, in HAML:
+## Configuration: YAML Frontmatter
 
-```haml
-= disqus
-```
+You can set per page configuration variables in the YAML Fontmatter, these
+are used as parameters for Disqus' behaviors and settings.
+
+For full details about what they do, see [Disqus JavaScript configuration variables][djcv]
 
-Or ERB:
+```yaml
+---
+disqus_identifier: /2012/the-best-day-of-my-life.html
+disqus_title: The best day of my life
+disqus_url: http://example.com/2012/the-best-day-of-my-life.html
+disqus_category_id: 4
+disqus_disable_mobile: true
+---
 
-```erb
-<%= disqus %>
+Page with YAML Frontmatter.
 ```
 
-## Only Including Embed Code in Builds
+## IMPORTANT: Do not use real shortnames during development
 
-To include the embed code only in builds, and not when running
-`middleman server`, simply add environment-specific configurations in your
-`config.rb`:
+If you use the live/production shortname during development and testing, expect
+to litter your Disqus account with discussions that you can't delete!
+
+You have two options:
+
+- Create a special testing/development shortname for use during development.
+- Only include Disqus in builds, not when running `middleman server`.
+
+You can set different options for `build` and `development` by using
+Middleman's [environment specific settings][ess], for example:
 
 ```ruby
+# config.rb
 configure :development do
   activate :disqus do |d|
-    d.shortname = false
+    # using a special shortname
+    d.shortname = "development-shortname"
+    # or setting to `nil` will stop Disqus loading
+    d.shortname = nil
   end
 end
 
 configure :build do
   activate :disqus do |d|
-    d.shortname = "your_shortname"
+    # using a different shortname for production builds
+    d.shortname = "production-shortname"
   end
 end
 ```
 
-## Usage
-
-Once you've bundled you should be able to run middleman as normal, and have it
-display the Disqus comments box.
-
 ## License
 
 Usage is provided under the MIT License. See the LICENSE file for the full details.
+
+[ess]: http://middlemanapp.com/advanced/configuration/#environment-specific-settings
+[djcv]: https://help.disqus.com/customer/portal/articles/472098-javascript-configuration-variables

data/features/disqus.feature

@@ -1,10 +1,70 @@
-@new
-Feature: Adds a Disqus embed code
-  Scenario: The Disqus embed code is added with the configured short name
+Feature: Disqus Integration
+
+  Scenario: Disqus config var `shotname` is not set
+    Given a fixture app "disqus-app"
+    And a file named "config.rb" with:
+      """
+      activate :disqus do |d|
+        d.shortname = nil
+      end
+      """
+    And the Server is running
+    When I go to "/"
+    Then I should see "0" lines
+    When I go to "/count.html"
+    Then I should see "0" lines
+
+  Scenario: Basic usage, Disqus javascript is included when `shotname` is set
     Given a successfully built app at "disqus-app"
     When I cd to "build"
     Then the following files should exist:
       | index.html |
-            
+      | count.html |
     And the file "index.html" should contain 'div id="disqus_thread"'
-    And the file "index.html" should contain "dsq.src = '//test-name.disqus.com/embed.js';"
+    And the file "index.html" should contain "var disqus_shortname = 'test-name';"
+    And the file "index.html" should contain 'disqus.com/embed.js'
+    And the file "count.html" should contain "var disqus_shortname = 'test-name';"
+    And the file "count.html" should contain 'disqus.com/count.js'
+
+  Scenario: Per page Disqus variables
+    Given a fixture app "disqus-app"
+    And a file named "source/options.html.erb" with:
+      """
+      ---
+      disqus_identifier: /2012/the-best-day-of-my-life.html
+      disqus_title: The best day of my life
+      disqus_url: http://example.com/2012/the-best-day-of-my-life.html
+      disqus_category_id: 4
+      disqus_disable_mobile: true
+      ---
+      <%= disqus %>
+      """
+    And a successfully built app at "disqus-app"
+    When I cd to "build"
+    Then the following files should exist:
+      | options.html |
+    And the file "options.html" should contain "var disqus_identifier = '/2012/the-best-day-of-my-life.html';"
+    And the file "options.html" should contain "var disqus_title = 'The best day of my life';"
+    And the file "options.html" should contain "var disqus_url = 'http://example.com/2012/the-best-day-of-my-life.html';"
+    And the file "options.html" should contain "var disqus_category_id = 4;"
+    And the file "options.html" should contain "var disqus_disable_mobile = true;"
+
+  Scenario: Only set a couple of per page Disqus variables
+    Given a fixture app "disqus-app"
+    And a file named "source/options.html.erb" with:
+      """
+      ---
+      disqus_category_id: 4
+      disqus_disable_mobile: false
+      ---
+      <%= disqus %>
+      """
+    And a successfully built app at "disqus-app"
+    When I cd to "build"
+    Then the following files should exist:
+      | options.html |
+    And the file "options.html" should not contain "var disqus_identifier"
+    And the file "options.html" should not contain "var disqus_title"
+    And the file "options.html" should not contain "var disqus_url"
+    And the file "options.html" should contain "var disqus_category_id = 4;"
+    And the file "options.html" should contain "var disqus_disable_mobile = false;"

data/fixtures/disqus-app/config.rb

@@ -1,3 +1,3 @@
 activate :disqus do |d|
-  d.shortname = "test-name"
+  d.shortname = 'test-name'
 end

data/fixtures/disqus-app/source/count.html.erb

@@ -0,0 +1 @@
+<%= disqus_count %>

data/fixtures/disqus-app/source/index.html.erb

@@ -1,6 +1 @@
----
-title: Welcome to Middleman
----
-
-<p>Hello world!</p>
 <%= disqus %>

data/lib/middleman-disqus.rb

@@ -1,33 +1,7 @@
-require "middleman-core"
+require 'middleman-core'
+require 'middleman-disqus/version'
 
-class Disqus < ::Middleman::Extension
-  option :shortname, false, "Your short name for Disqus"
-  
-  def initialize(app, options_hash={}, &block)
-    super
-    
-    app.set :disqus_shortname, options.shortname
-  end
-  
-  helpers do
-    def disqus
-      if disqus_shortname
-        %Q{<div id="disqus_thread"></div>
-            <script type="text/javascript">
-            //<![CDATA[
-                (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="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
-            <a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
-        </script>}
-      end
-    end
-  end
+::Middleman::Extensions.register(:disqus) do
+  require 'middleman-disqus/extension'
+  ::Middleman::DisqusExtension
 end
-
-::Middleman::Extensions.register(:disqus, Disqus)

data/lib/middleman-disqus/count.erb

@@ -0,0 +1,11 @@
+<script type="text/javascript">
+//<![CDATA[
+    var disqus_shortname = '<%= @options[:shortname] %>';
+    (function () {
+        var s = document.createElement('script'); s.async = true;
+        s.type = 'text/javascript';
+        s.src = '//' + disqus_shortname + '.disqus.com/count.js';
+        (document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
+    }());
+//]]>
+</script>

data/lib/middleman-disqus/embed.erb

@@ -0,0 +1,20 @@
+<div id="disqus_thread"></div>
+<script type="text/javascript">
+//<![CDATA[
+    <% @options.each do |key, value| %>
+      <% if value.is_a?(String) %>
+        var disqus_<%= key %> = '<%= value %>';
+      <% elsif [Fixnum, FalseClass, TrueClass].include?(value.class) %>
+        var disqus_<%= key %> = <%= value %>;
+      <% end %>
+    <% end %>
+
+    (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="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
+<a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>

data/lib/middleman-disqus/extension.rb

@@ -0,0 +1,41 @@
+require "middleman-core"
+
+module Middleman
+  class DisqusExtension < Extension
+    option :shortname, nil, "Your short name for Disqus"
+
+    def initialize(app, options_hash={}, &block)
+      super
+      # place in class variable so helpers can access
+      @@options = options
+    end
+
+    def self.options(options = {})
+      options = options.to_hash.map do |k,obj|
+        k =~ /^disqus_(.*)$/ ? [$1, obj] : nil
+      end
+      options = Hash[options.compact]
+      @@options.to_h.merge(options).with_indifferent_access
+    end
+
+    helpers do
+      def disqus
+        page_options = current_resource.metadata[:page]
+        @options = Middleman::DisqusExtension.options(page_options)
+        return '' unless @options[:shortname]
+
+        file = File.join(File.dirname(__FILE__), 'embed.erb')
+        ERB.new(File.read(file), 0, '>').result(binding)
+      end
+
+      def disqus_count
+        @options = Middleman::DisqusExtension.options
+        return '' unless @options[:shortname]
+
+        file = File.join(File.dirname(__FILE__), 'count.erb')
+        ERB.new(File.read(file), 0, '>').result(binding)
+      end
+    end
+
+  end
+end

data/lib/{version.rb → middleman-disqus/version.rb}

@@ -1,5 +1,5 @@
 module Middleman
   module Disqus
-    VERSION = "0.0.3"
+    VERSION = '1.0.0'
   end
-end
+end

data/middleman-disqus.gemspec

@@ -1,26 +1,23 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "version"
+require "middleman-disqus/version"
 
 Gem::Specification.new do |s|
   s.name        = "middleman-disqus"
   s.version     = Middleman::Disqus::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Simon Rice"]
+  s.authors     = ["Simon Rice", "Luke Antins"]
   s.email       = ["im@simonrice.com"]
   s.homepage    = "http://github.com/simonrice/middleman-disqus"
-  s.license     = 'MIT'
-  s.summary     = %q{A Middleman plugin for adding the Disqus embed code.}
-  # s.description = %q{A longer description of your extension}
+  s.license     = "MIT"
+  s.summary     = %q{Quickly integrate Disqus comments into your Middleman site}
+  s.description = <<-EOL
+A Middleman extension to integrate Disqus into your site,
+supporting Disqus configuration variables and comment counts.
+EOL
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.test_files    = `git ls-files -- {features,fixtures}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  # The version of middleman-core your extension depends on
-  s.add_runtime_dependency("middleman-core", [">= 3.1.0"])
-
-  # Additional dependencies
-  # s.add_runtime_dependency("gem-name", "gem-version")
+  s.add_runtime_dependency("middleman-core", ["~> 3.1"])
 end

metadata

@@ -1,51 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: middleman-disqus
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Simon Rice
+- Luke Antins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2014-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
-description: 
+        version: '3.1'
+description: |
+  A Middleman extension to integrate Disqus into your site,
+  supporting Disqus configuration variables and comment counts.
 email:
 - im@simonrice.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
+- HISTORY.md
 - LICENSE
 - README.md
 - Rakefile
 - features/disqus.feature
 - features/support/env.rb
 - fixtures/disqus-app/config.rb
-- fixtures/disqus-app/layouts/layout.erb
+- fixtures/disqus-app/source/count.html.erb
 - fixtures/disqus-app/source/index.html.erb
-- fixtures/disqus-app/source/layouts/layout.erb
 - lib/middleman-disqus.rb
-- lib/middleman_extension.rb
-- lib/version.rb
+- lib/middleman-disqus/count.erb
+- lib/middleman-disqus/embed.erb
+- lib/middleman-disqus/extension.rb
+- lib/middleman-disqus/version.rb
 - middleman-disqus.gemspec
 homepage: http://github.com/simonrice/middleman-disqus
 licenses:
@@ -57,21 +62,23 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: A Middleman plugin for adding the Disqus embed code.
+summary: Quickly integrate Disqus comments into your Middleman site
 test_files:
 - features/disqus.feature
 - features/support/env.rb
-has_rdoc: 
+- fixtures/disqus-app/config.rb
+- fixtures/disqus-app/source/count.html.erb
+- fixtures/disqus-app/source/index.html.erb

data/fixtures/disqus-app/layouts/layout.erb

@@ -1,11 +0,0 @@
-<!doctype html>
-<html>
-  <head>
-    <meta charset="utf-8">
-    <title>Test</title>
-  </head>
-  
-  <body class="<%= page_classes %>">
-    <%= yield %>
-  </body>
-</html>

data/fixtures/disqus-app/source/layouts/layout.erb

@@ -1,11 +0,0 @@
-<!doctype html>
-<html>
-  <head>
-    <meta charset="utf-8">
-    <title>Test</title>
-  </head>
-  
-  <body class="<%= page_classes %>">
-    <%= yield %>
-  </body>
-</html>

data/lib/middleman_extension.rb

@@ -1 +0,0 @@
-require 'middleman-disqus'