qup 1.4.0 → 1.4.1

data/lib/qup.rb

@@ -1,6 +1,6 @@
 module Qup
   # The Current Version of the library
-  VERSION = '1.4.0'
+  VERSION = '1.4.1'
 
   class Error < StandardError; end
 

data/lib/qup/adapter/kestrel/queue.rb

@@ -28,6 +28,12 @@ class Qup::Adapter::Kestrel
       @client.flush(@name)
     end
 
+    # Internal: Remove the Queue if possible
+    #
+    # Returns nothing
+    def destroy
+      @client.delete(@name)
+    end
 
     # Internal: return the number of Messages on the Queue
     #

data/lib/qup/adapter/kestrel/topic.rb

@@ -32,6 +32,16 @@ class Qup::Adapter::Kestrel
       ::Qup::Subscriber.new( self, subscriber_queue( name )  )
     end
 
+    # Internal: Destroy the topic
+    #
+    # Returns nothing
+    def destroy
+      subscribers.each do |name, sub|
+        sub.destroy
+      end
+      @client.delete( @name )
+    end
+
 
     # Internal: Return the number of Subscribers to this Topic
     #
@@ -43,15 +53,7 @@ class Qup::Adapter::Kestrel
     #
     # Returns integer
     def subscriber_count
-      c = Set.new
-
-      stats['queues'].keys.each do |k|
-        next unless k =~ %r{\A#{@name}\+}
-        parts = k.split("+")
-        c << parts[1]
-      end
-
-      return c.size
+      subscriber_names.size
     end
 
     # Internal: Publish a Message to all the Subscribers
@@ -66,6 +68,26 @@ class Qup::Adapter::Kestrel
     #######
     private
     #######
+ 
+    def subscribers
+      subs = {}
+      subscriber_names.each do |sub_name|
+        subs[sub_name] = subscriber_queue( sub_name )
+      end
+      return subs
+    end 
+
+    def subscriber_names
+      names = []
+
+      stats['queues'].keys.each do |k|
+        next unless k =~ %r{\A#{@name}\+}
+        parts = k.split("+")
+        names << parts[1]
+      end
+
+      return names
+    end 
 
     def subscriber_queue( sub_name )
       sname = subscriber_queue_name( sub_name )

data/lib/qup/adapter/maildir/queue.rb

@@ -21,6 +21,8 @@ class Qup::Adapter::Maildir
       @name       = name
       @queue_path = @root_path + @name
       @maildir    = ::Maildir.new( @queue_path, true )
+      # FIXME: this is a -w for Maildir issue, remove when fixed upstream
+      @maildir.serializer = ::Maildir::Serializer::Base.new
     end
 
 

data/lib/qup/adapter/maildir/topic.rb

@@ -20,9 +20,9 @@ class Qup::Adapter::Maildir
       @root_path   = ::Pathname.new( root_path )
       @name        = name
       @topic_path  = @root_path + @name
-      @subscribers = Hash.new
 
       FileUtils.mkdir_p( @topic_path )
+      @topic_path_mtime = @topic_path.mtime
     end
 
     # Internal: Destroy the Topic
@@ -31,7 +31,7 @@ class Qup::Adapter::Maildir
     #
     # Returns nothing.
     def destroy
-      @topic_path.rmtree
+      @topic_path.rmtree if @topic_path.directory?
     end
 
     # Internal: Creates a Publisher for the Topic
@@ -60,7 +60,7 @@ class Qup::Adapter::Maildir
     #
     # Returns integer
     def subscriber_count
-      @subscribers.size
+      subscribers.size
     end
 
     # Internal: Publish a Message to all the Subscribers
@@ -69,7 +69,7 @@ class Qup::Adapter::Maildir
     #
     # Returns nothing
     def publish( message )
-      @subscribers.each do |name, sub|
+      subscribers.each do |name, sub|
         sub.produce( message )
       end
     end
@@ -77,9 +77,22 @@ class Qup::Adapter::Maildir
     #######
     private
     #######
+   
+    def subscribers
+      subs = {}
+      if @topic_path.directory? then
+        @topic_path.each_child do |child|
+          if child.directory?
+            name = child.basename
+            subs[name] = sub_queue( name )
+          end
+        end
+      end
+      return subs
+    end 
 
     def sub_queue( name )
-      @subscribers[name] ||= ::Qup::Adapter::Maildir::Queue.new( @topic_path, name )
+      ::Qup::Adapter::Maildir::Queue.new( @topic_path, name )
     end
   end
 end

data/lib/qup/adapter/redis/topic.rb

@@ -33,6 +33,15 @@ class Qup::Adapter::Redis
       ::Qup::Subscriber.new( self, queue )
     end
 
+    # Internal: Destroy the topic and all of its subscribers
+    #
+    # Returns nothing
+    def destroy
+      subscribers.each do |name, subscriber|
+        subscriber.destroy
+      end
+    end
+
     # Internal: Return the number of Subscribers to this Topic
     #
     # Returns integer
@@ -46,8 +55,8 @@ class Qup::Adapter::Redis
     #
     # Returns nothing
     def publish( message )
-      subscribers.each do |subscriber|
-        @client.lpush subscriber, message
+      subscribers.each do |name, subscriber|
+        subscriber.produce( message )
       end
     end
 
@@ -55,12 +64,22 @@ class Qup::Adapter::Redis
     private
     #######
 
-    # Private: retrieve the current list of subscribers
+    # Private: retrieve the current list of subscriber names
     #
     # Returns an array of subscriber queue names
-    def subscribers
+    def subscriber_names
       @client.smembers @name
     end
 
+    # Private: return the current list of subscribers
+    #
+    # Return a Hash of subscriber names and queues
+    def subscribers
+      subs = {}
+      subscriber_names.each do |sname|
+        subs[sname] = ::Qup::Adapter::Redis::Queue.new(@uri, sname, @name)
+      end
+      return subs
+    end
   end
 end

data/spec/qup/shared_adapter_examples.rb

@@ -19,11 +19,13 @@ shared_examples Qup::Adapter do
     q = adapter.queue( 'q' )
     q.should be_kind_of( Qup::QueueAPI )
     q.name.should eq 'q'
+    q.destroy
   end
 
   it 'can create a QueueAPI-like object' do
     t = adapter.topic( 't' )
     t.should be_kind_of( Qup::TopicAPI )
     t.name.should eq 't'
+    t.destroy
   end
 end

data/spec/qup/shared_topic_examples.rb

@@ -31,17 +31,29 @@ shared_examples Qup::TopicAPI do
   describe "subscribers" do
     before do
       @subs = []
+      @topic2 = adapter.topic( 'topic' )
+
       3.times do |x|
-        @subs << @topic.subscriber( "sub-#{x}")
+        @subs << @topic2.subscriber( "sub-#{x}")
       end
     end
 
     after do
-      @subs.each { |s| s.unsubscribe }
+      @topic2.destroy
+      @topic.subscriber_count.should eq 0
     end
 
-    it "are counted" do
-      @topic.subscriber_count.should eq 3
+    it "updates the publisher with the number of subscribers" do
+      start_count   = @topic.subscriber_count
+      @topic2.subscriber_count.should eq start_count
+      current_count = start_count
+
+      3.times do |x|
+        current_count += 1
+        @topic2.subscriber( "sub2-#{x}" )
+        @topic.subscriber_count.should eq current_count
+        @topic2.subscriber_count.should eq current_count
+      end
     end
 
     it "each receives a copy of the message" do

data/tasks/default.rake

@@ -0,0 +1,269 @@
+# vim: syntax=ruby
+require 'rake/clean'
+require 'digest'
+#------------------------------------------------------------------------------
+# If you want to Develop on this project just run 'rake develop' and you'll
+# have all you need to get going. If you want to use bundler for development,
+# then run 'rake develop:using_bundler'
+#------------------------------------------------------------------------------
+namespace :develop do
+
+  # Install all the development and runtime dependencies of this gem using the
+  # gemspec.
+  task :default do
+    require 'rubygems/dependency_installer'
+    installer = ::Gem::DependencyInstaller.new
+
+    This.set_coverage_gem
+
+    puts "Installing gem depedencies needed for development"
+    This.platform_gemspec.dependencies.each do |dep|
+      if dep.matching_specs.empty? then
+        puts "Installing : #{dep}"
+        installer.install dep
+      else
+        puts "Skipping   : #{dep} -> already installed #{dep.matching_specs.first.full_name}"
+      end
+    end
+    puts "\n\nNow run 'rake test'"
+  end
+
+  # Create a Gemfile that just references the gemspec
+  file 'Gemfile' => :gemspec do
+    File.open( "Gemfile", "w+" ) do |f|
+      f.puts 'source "https://rubygems.org/"'
+      f.puts 'gemspec'
+    end
+  end
+
+  desc "Create a bundler Gemfile"
+  task :using_bundler => 'Gemfile' do
+    puts "Now you can 'bundle'"
+  end
+
+  # Gemfiles are build artifacts
+  CLOBBER << FileList['Gemfile*']
+end
+desc "Boostrap development"
+task :develop => "develop:default"
+
+#------------------------------------------------------------------------------
+# RSpec - standard RSpec rake task
+#------------------------------------------------------------------------------
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new( :test ) do |t|
+    t.ruby_opts    = %w[ -w ]
+    t.rspec_opts   = %w[ --color --format documentation ]
+  end
+  task :default => :test
+rescue LoadError
+  Util.task_warning( 'test' )
+end
+
+
+#------------------------------------------------------------------------------
+# RDoc - standard rdoc rake task, although we must make sure to use a more
+#        recent version of rdoc since it is the one that has 'tomdoc' markup
+#------------------------------------------------------------------------------
+begin
+  gem 'rdoc' # otherwise we get the wrong task from stdlib
+  require 'rdoc/task'
+  RDoc::Task.new do |t|
+    t.markup   = 'tomdoc'
+    t.rdoc_dir = 'doc'
+    t.main     = 'README.md'
+    t.title    = "#{This.name} #{This.version}"
+    t.rdoc_files.include( FileList['*.{rdoc,md,txt}'], FileList['ext/**/*.c'],
+                          FileList['lib/**/*.rb'] )
+  end
+rescue StandardError, LoadError
+  This.task_warning( 'rdoc' )
+end
+
+#------------------------------------------------------------------------------
+# Coverage - optional code coverage, rcov for 1.8 and simplecov for 1.9, so
+#            for the moment only rcov is listed.
+#------------------------------------------------------------------------------
+if RUBY_VERSION < "1.9.0"
+  begin
+   require 'rcov/rcovtask'
+   Rcov::RcovTask.new( 'coverage' ) do |t|
+     t.libs      << 'spec'
+     t.pattern   = 'spec/**/*_spec.rb'
+     t.verbose   = true
+     t.rcov_opts << "-x ^/"           # remove all the global files
+     t.rcov_opts << "--sort coverage" # so we see the worst files at the top
+   end
+  rescue LoadError
+   This.task_warning( 'rcov' )
+  end
+else
+  begin
+    require 'simplecov'
+    desc 'Run tests with code coverage'
+    task :coverage do
+      ENV['COVERAGE'] = 'true'
+      Rake::Task[:test].execute
+    end
+    CLOBBER << FileList["coverage"]
+  rescue LoadError
+    This.task_warning( 'simplecov' )
+  end
+end
+
+#------------------------------------------------------------------------------
+# Manifest - We want an explicit list of thos files that are to be packaged in
+#            the gem. Most of this is from Hoe.
+#------------------------------------------------------------------------------
+namespace 'manifest' do
+  desc "Check the manifest"
+  task :check => :clean do
+    files = FileList["**/*", ".*"].exclude( This.exclude_from_manifest ).to_a.sort
+    files = files.select{ |f| File.file?( f ) }
+
+    tmp = "Manifest.tmp"
+    File.open( tmp, 'w' ) do |f|
+      f.puts files.join("\n")
+    end
+
+    begin
+      sh "diff -du Manifest.txt #{tmp}"
+    ensure
+      rm tmp
+    end
+    puts "Manifest looks good"
+  end
+
+  desc "Generate the manifest"
+  task :generate => :clean do
+    files = %x[ git ls-files ].split("\n").sort
+    files.reject! { |f| f =~ This.exclude_from_manifest }
+    File.open( "Manifest.txt", "w" ) do |f|
+      f.puts files.join("\n")
+    end
+  end
+end
+
+#------------------------------------------------------------------------------
+# Fixme - look for fixmes and report them
+#------------------------------------------------------------------------------
+namespace :fixme do
+  task :default => 'manifest:check' do
+    This.manifest.each do |file|
+      next if file == __FILE__
+      next unless file =~ %r/(txt|rb|md|rdoc|css|html|xml|css)\Z/
+      puts "FIXME: Rename #{file}" if file =~ /fixme/i
+      IO.readlines( file ).each_with_index do |line, idx|
+        prefix = "FIXME: #{file}:#{idx+1}".ljust(42)
+        puts "#{prefix} => #{line.strip}" if line =~ /fixme/i
+      end
+    end
+  end
+
+  def fixme_project_root
+    This.project_path( '../fixme' )
+  end
+
+  def fixme_project_path( subtree )
+    fixme_project_root.join( subtree )
+  end
+
+  def local_fixme_files
+    This.manifest.select { |p| p =~ %r|^tasks/| }
+  end
+
+  def outdated_fixme_files
+    local_fixme_files.reject do |local|
+      upstream     = fixme_project_path( local )
+      Digest::SHA256.file( local ) == Digest::SHA256.file( upstream )
+    end
+  end
+
+  def fixme_up_to_date?
+    outdated_fixme_files.empty?
+  end
+
+  desc "See if the fixme tools are outdated"
+  task :outdated => :release_check do
+    if fixme_up_to_date? then
+      puts "Fixme files are up to date."
+    else
+      outdated_fixme_files.each do |f|
+        puts "#{f} is outdated"
+      end
+    end
+  end
+
+  desc "Update outdated fixme files"
+  task :update => :release_check do
+    if fixme_up_to_date? then
+      puts "Fixme files are already up to date."
+    else
+      puts "Updating fixme files:"
+      outdated_fixme_files.each do |local|
+        upstream = fixme_project_path( local )
+        puts "  * #{local}"
+        FileUtils.cp( upstream, local )
+      end
+      puts "Use your git commands as appropriate."
+    end
+  end
+end
+desc "Look for fixmes and report them"
+task :fixme => "fixme:default"
+
+#------------------------------------------------------------------------------
+# Gem Specification
+#------------------------------------------------------------------------------
+# Really this is only here to support those who use bundler
+desc "Build the #{This.name}.gemspec file"
+task :gemspec do
+  File.open( This.gemspec_file, "wb+" ) do |f|
+    f.write This.platform_gemspec.to_ruby
+  end
+end
+
+# the gemspec is also a dev artifact and should not be kept around.
+CLOBBER << This.gemspec_file.to_s
+
+# .rbc files from ruby 2.0
+CLOBBER << FileList["**/*.rbc"]
+
+# The standard gem packaging task, everyone has it.
+require 'rubygems/package_task'
+::Gem::PackageTask.new( This.platform_gemspec ) do
+  # nothing
+end
+
+#------------------------------------------------------------------------------
+# Release - the steps we go through to do a final release, this is pulled from
+#           a compbination of mojombo's rakegem, hoe and hoe-git
+#
+# 1) make sure we are on the master branch
+# 2) make sure there are no uncommitted items
+# 3) check the manifest and make sure all looks good
+# 4) build the gem
+# 5) do an empty commit to have the commit message of the version
+# 6) tag that commit as the version
+# 7) push master
+# 8) push the tag
+# 7) pus the gem
+#------------------------------------------------------------------------------
+task :release_check do
+  unless `git branch` =~ /^\* master$/
+    abort "You must be on the master branch to release!"
+  end
+  unless `git status` =~ /^nothing to commit/m
+    abort "Nope, sorry, you have unfinished business"
+  end
+end
+
+desc "Create tag v#{This.version}, build and push #{This.platform_gemspec.full_name} to rubygems.org"
+task :release => [ :release_check, 'manifest:check', :gem ] do
+  sh "git commit --allow-empty -a -m 'Release #{This.version}'"
+  sh "git tag -a -m 'v#{This.version}' v#{This.version}"
+  sh "git push origin master"
+  sh "git push origin v#{This.version}"
+  sh "gem push pkg/#{This.platform_gemspec.full_name}.gem"
+end