sinatra-disqus 1.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin/
+vendor/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/CHANGES.md

@@ -0,0 +1,13 @@
+## CH-CH-CH-CH-CHANGES! ##
+
+### 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/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sinatra-extension-skeleton.gemspec
+gemspec
+
+group :development do
+  gem "rake"
+  gem "wirble"
+  gem "yard"
+  gem "maruku"
+end
+
+group :test do
+  gem "rack-test"
+  gem "rspec"
+  gem "simplecov"
+end

data/LICENCE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Iain Barnett
+
+MIT Licence
+
+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, sublicence, 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.md

@@ -0,0 +1,92 @@
+## Sinatra Disqus ##
+
+Drop in disqus to any Sinatra page via a handy helper.
+
+### Installation ###
+
+    gem install sinatra-disqus
+    
+or via Bundler:
+
+    gem "sinatra-disqus"
+
+
+### Example ###
+
+#### Classic style
+
+    require 'sinatra'
+    require 'haml'
+    require 'sinatra/disqus'
+      
+    configure do
+      # Disqus settings
+      set :disqus_shortname, "example.org"
+       # Put disqus into developer mode unless in production.
+      set :disqus_developer, !production?
+    end
+
+    get "/" do
+      @title = "Home"
+      haml :home
+    end
+
+    __END__
+
+    @@ layout
+    !!!
+    %body
+      = yield
+
+    @@ home
+    #main
+      %p
+        This is the home page.
+      %p
+        Now for some comments:
+    #comments
+      inject_disqus
+
+#### Modular style ####
+
+    require 'sinatra/base' # for modular apps
+    require 'haml'
+    require 'sinatra/disqus'
+    
+    class Example < Sinatra::Base
+      register Sinatra::Disqus # because it's modular
+      
+      configure do
+        enable :inline_templates # just for this example
+
+        # Disqus settings
+        set :disqus_shortname, "example.org"
+         # Put disqus into developer mode unless in production.
+        set :disqus_developer, !production?
+      end
+      
+      get "/" do
+        @title = "Home"
+        haml :home
+      end
+    end
+
+    __END__
+
+    @@ layout
+    !!!
+    %body
+      = yield
+
+    @@ home
+    #main
+      %p
+        This is the home page.
+      %p
+        Now for some comments:
+    #comments
+      inject_disqus # you'd probably do this at the bottom of a view instead.
+
+### Licence ###
+
+Look in the LICENCE file.

data/Rakefile

@@ -0,0 +1,61 @@
+require "bundler/gem_tasks"
+
+P = /MODULENAME/
+
+def edit_in_place( file_name, module_name )
+  File.open(file_name, 'r+') do |f|   # open file for update
+    lines = f.readlines           # read into array of lines
+    lines.each do |it|            # modify lines
+      if it =~ P
+        if it =~ /(?:\/|\-)MODULE/
+          it.gsub!(P, module_name.downcase)
+        else
+          it.gsub!(P, module_name)
+        end
+        it
+      end
+    end
+    f.pos = 0                     # back to start
+    f.print lines.join            # write out modified lines
+    f.truncate(f.pos)             # truncate to new length
+  end  
+end
+
+
+
+desc "Rename the files and folders of the project from MODULENAME to something useful."
+task :rename do
+  new_name = ENV["n"]
+  Dir["./**/*"].reject{|f| f["/vendor"] || f["/bin"] || f["Rakefile"] || f["Gemfile"] || f["LICENCE"] || f["README.md"] }.sort_by{|n| n.length }.reverse.each do |file|
+    if File.exists?(file)
+      File.file?(file) && edit_in_place(file,new_name)
+      if file =~ P
+        cmd = "git mv #{file} #{file.sub(P,new_name).downcase}"
+        warn cmd
+        system(cmd)
+      end
+    end
+  end
+end
+
+
+desc "(Re-) generate documentation and place it in the docs/ dir."
+task :docs => :"docs:yard"  
+namespace :docs do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['-odocs/', '--no-private']
+  end
+
+  desc "Docs including private methods."
+  YARD::Rake::YardocTask.new(:all) do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['-odocs/']
+  end
+    
+  desc "How to use the docs."
+  task :usage do
+    puts "Open the index.html file in the docs directory to read them. Does not include methods marked private unless you ran the 'all' version (you'll only need these if you plan to hack on the library itself)."
+  end
+end

data/lib/sinatra/disqus/version.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+module Sinatra
+  module Disqus
+    VERSION = "1.0.0"
+  end
+end

data/lib/sinatra/disqus.rb

@@ -0,0 +1,90 @@
+# encoding: UTF-8
+
+require 'sinatra/base'
+require 'haml'
+
+module Sinatra
+  module Disqus
+
+    Disqus_output_top = <<TOP
+#disqus_thread
+  :javascript
+TOP
+    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);
+    })();
+    
+  %noscript
+    Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a>
+  %p
+    <a href="http://disqus.com" class="dsq-brlink">blog comments powered by <span class="logo-disqus">Disqus</span></a>
+BOTTOM
+
+    # @private
+    module Private
+      require 'digest/md5'
+    
+      # Unique (repeatable) identifier for page.
+      # @param [String] The page uri.
+      def self.disqus_identifier( request_path )
+        Digest::MD5.hexdigest(request_path)
+      end
+
+
+      # @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.
+      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]}';
+STR
+      end
+    end
+
+
+    module Helpers
+      
+      # @return [String] Returns the bit of HTML/javascript to stick in the page.
+      def inject_disqus
+        Haml::Engine.new( "#{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}" ).render
+      end
+
+    end
+
+
+    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
+  register Disqus
+end

data/sinatra-disqus.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sinatra/disqus/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Iain Barnett"]
+  gem.email         = ["iainspeed@gmail.com"]
+  gem.description   = %q{Drop in disqus to any Sinatra view via a handy helper.}
+  gem.summary       = %q{Easy disqus for Sinatra.}
+  gem.homepage      = "https://bitbucket.org/yb66/sinatra-disqus"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sinatra-disqus"
+  gem.require_paths = ["lib"]
+  gem.version       = Sinatra::Disqus::VERSION
+  gem.add_dependency( "sinatra" )
+  gem.add_dependency( "haml" )
+end

data/spec/disqus_spec.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+
+require "rspec_helper"
+
+require_relative "../lib/sinatra/Disqus.rb"
+
+describe "Disqus" do
+  before{ get '/' }
+  include_context "All pages"
+  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>
+STR
+    }
+    subject{ last_response.body }
+    it { should == expected }
+  end
+end

data/spec/rspec_helper.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+
+require 'rspec'
+require "rack/test"
+
+# code coverage
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/vendor/"
+  add_filter "/bin/"
+end
+
+ENV['RACK_ENV'] ||= 'test'
+ENV["EXPECT_WITH"] ||= "racktest"
+
+
+Spec_dir = File.expand_path( File.dirname __FILE__ )
+
+
+require "logger"
+logger = Logger.new STDOUT
+logger.level = Logger::DEBUG
+logger.datetime_format = '%a %d-%m-%Y %H%M '
+LOgger = logger
+
+
+
+Dir[ File.join( Spec_dir, "/support/**/*.rb")].each do |f| 
+  logger.info "requiring #{f}"
+  require f
+end
+
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true  
+end

data/spec/support/shared/all_routes.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+require 'sinatra/base'
+require_relative "../../../lib/sinatra/Disqus.rb"
+
+class Example < Sinatra::Base
+  register Sinatra::Disqus
+  
+  configure do
+    set :disqus_shortname, "example.org"
+  end
+  
+  get "/" do
+    @title = "Home"
+    inject_disqus
+  end
+end
+
+shared_context "All pages" do
+  include Rack::Test::Methods
+  let(:app){ Example }
+end
+
+shared_examples_for "Any route" do
+  subject { last_response }
+  it { should be_ok }
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-disqus
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Iain Barnett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Drop in disqus to any Sinatra view via a handy helper.
+email:
+- iainspeed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGES.md
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- lib/sinatra/disqus.rb
+- lib/sinatra/disqus/version.rb
+- sinatra-disqus.gemspec
+- spec/disqus_spec.rb
+- spec/rspec_helper.rb
+- spec/support/shared/all_routes.rb
+homepage: https://bitbucket.org/yb66/sinatra-disqus
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Easy disqus for Sinatra.
+test_files:
+- spec/disqus_spec.rb
+- spec/rspec_helper.rb
+- spec/support/shared/all_routes.rb