mailmanager 1.0.15 → 1.0.16

data/.gitignore

@@ -4,3 +4,4 @@ html/*
 doc/*
 results/*
 mailman
+coverage/*

data/Changelog

@@ -1,4 +1,9 @@
-Current version is 1.0.15
+Current version is 1.0.16
+
+changes since 1.0.15
+- added rubygems-test support -- https://github.com/rubygems/rubygems-test/blob/master/README.txt
+- added a boatload of tests
+- removed some old unused code
 
 changes since 1.0.14
 - added a Cucumber integration test suite

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mailmanager (1.0.15)
+    mailmanager (1.0.16)
       json (~> 1.4.6)
       open4 (~> 1.0.1)
 
@@ -45,6 +45,11 @@ GEM
       ruby-debug-base19 (>= 0.11.19)
     ruby_core_source (0.1.4)
       archive-tar-minitar (>= 0.5.2)
+    simplecov (0.3.9)
+      simplecov-html (>= 0.3.7)
+    simplecov-html (0.3.9)
+    simplecov-rcov (0.1.2)
+      simplecov
     term-ansicolor (1.0.5)
 
 PLATFORMS
@@ -57,3 +62,5 @@ DEPENDENCIES
   mailmanager!
   rspec (~> 2.4.0)
   ruby-debug19
+  simplecov
+  simplecov-rcov

data/README.rdoc

@@ -13,7 +13,7 @@ check your Python version before using this.
 == Installation
 
   gem install mailmanager
-  
+
 == Basic Usage
 
   mm = MailManager.init('/mailman/root')
@@ -93,12 +93,12 @@ of 2.1.x, probably) to run the Cucumber integration tests. Make a symlink to the
 root directory of your Mailman install in the mailmanager directory. It should be
 named "mailman". So if you are in the top-level mailmanager directory and your
 Mailman installation is in /usr/local/mailman, you would run this command:
-    ln -s /usr/local/mailman mailman
+  ln -s /usr/local/mailman mailman
 
 Once that's done, you should be able to just run 'cucumber' in the top-level
 mailmanager directory.
 
-_MAKE SURE THIS IS NOT A MAILMAN INSTALLATION YOU CARE ABOUT!_ The Cucumber test
+<b>MAKE SURE THIS IS NOT A MAILMAN INSTALLATION YOU CARE ABOUT!</b> The Cucumber test
 suite will start by deleting all mailing lists so it can have a clean slate to
 test with.
 
@@ -106,6 +106,9 @@ test with.
 
 - Fork on GitHub
 - Make a new branch
+- Commit your feature addition or bug fix to that branch.
+- Don't mess with Rakefile, version.rb, or Changelog. (If you want to have your own version, that's fine but bump version in its own commit so we can ignore it when we pull.)
+- Add tests for it. This is important so we don't break it in a future version unintentionally.
 - Push your changes to that branch (i.e. not master)
 - Make a pull request
 - Bask in your awesomeness

data/Rakefile

@@ -40,3 +40,6 @@ desc "Run all specs"
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
 end
+
+desc "Run tests for rubygems-test"
+task :test => :spec

data/features/delete_list.feature

@@ -0,0 +1,16 @@
+Feature: Deleting a list
+  As a developer using MailManager
+  In order to delete lists
+  I want MailManager to offer this feature
+
+  Background:
+    Given MailManager is initialized on "./mailman"
+
+  Scenario: Deleting a list
+    Given I have a list named "foo"
+    When I delete list "foo"
+    Then I should have 0 lists
+
+  Scenario: Deleting a list that doesn't exist
+    Given no lists exist
+    Then it should raise MailManager::ListNotFoundError when I delete list "foo"

data/features/list_metadata.feature

@@ -0,0 +1,31 @@
+Feature: List metadata
+
+  Background:
+    Given MailManager is initialized on "./mailman"
+
+  Scenario: Getting the info URL
+    Given I have a list named "foo"
+    When I ask for its info_url
+    Then I should get a URL
+
+  Scenario: Getting the list address
+    Given I have a list named "foo"
+    When I ask for its address
+    Then I should get an email address
+
+  Scenario: Getting the request email
+    Given I have a list named "foo"
+    When I ask for its request_email
+    Then I should get an email address
+
+  Scenario: Setting & getting the list description
+    Given I have a list named "foo"
+    And I set its description to "foo list of fun"
+    When I ask for its description
+    Then I should get "foo list of fun"
+
+  Scenario: Setting & getting the subject prefix
+    Given I have a list named "foo"
+    And I set its subject_prefix to "[Foo List] "
+    When I ask for its subject_prefix
+    Then I should get "[Foo List] "

data/features/moderators.feature

@@ -0,0 +1,22 @@
+Feature: List moderators administration
+
+  Background:
+    Given MailManager is initialized on "./mailman"
+    Given I have a list named "foo"
+
+  Scenario: Adding a moderator
+    When I add a moderator "me@bar.com"
+    Then I should have 1 moderator
+
+  Scenario: Adding a moderator that already exists
+    Given I add a moderator "me@bar.com"
+    Then it should raise MailManager::ModeratorAlreadyExistsError when I add a moderator "me@bar.com"
+
+  Scenario: Deleting a moderator
+    Given I add a moderator "me@bar.com"
+    When I delete a moderator "me@bar.com"
+    Then I should have 0 moderators
+
+  Scenario: Deleting a moderator that doesn't exist
+    Given I add a moderator "other@bar.com"
+    Then it should raise MailManager::ModeratorNotFoundError when I delete a moderator "me@bar.com"

data/features/step_definitions/list_steps.rb

@@ -0,0 +1,47 @@
+Given /^I have a list named "([^"]*)"$/ do |list_name|
+  Given %{no lists exist}
+  When %{I create a new list "#{list_name}"}
+end
+
+When /^I create a new list "([^"]*)"$/ do |list_name|
+  @list = @mailmanager.create_list(:name => list_name, :admin_email => 'cuke@foo.org', :admin_password => 'greenisgood')
+end
+
+When /^I delete list "([^"]*)"$/ do |list_name|
+  list = @mailmanager.get_list(list_name)
+  list.delete
+end
+
+When /^I ask for its (.+)$/ do |attr|
+  @attr = @list.send(attr)
+end
+
+Then /^I should get a URL$/ do
+  @attr.should =~ %r{^http://.*/}
+end
+
+Then /^I should get an email address$/ do
+  # super basic email regex
+  @attr.should =~ %r{^[^@]+@[^\.]+\..+}
+end
+
+When /^I add a moderator "([^"]*)"$/ do |mod|
+  @list.add_moderator(mod)
+end
+
+Then /^I should have (\d+) moderators?$/ do |num|
+  @list.should have(num.to_i).moderators
+end
+
+When /^I delete a moderator "([^"]*)"$/ do |mod|
+  @list.delete_moderator(mod)
+end
+
+Given /^I set its (.+?) to "([^"]*)"$/ do |attr,val|
+  @list.send("#{attr}=",val)
+end
+
+Then /^I should get "([^"]*)"$/ do |val|
+  @attr.should == val
+end
+

data/features/support/env.rb

@@ -1,2 +1,7 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', File.dirname(__FILE__))
+if ENV['COVERAGE_REPORT']
+  $LOAD_PATH.unshift File.expand_path('../../spec', File.dirname(__FILE__))
+  require "mailmanager_simplecov"
+  SimpleCov.start 'mailmanager'
+end
 require "mailmanager"

data/lib/mailmanager/lib.rb

@@ -9,6 +9,12 @@ module MailManager
   class ListNameConflictError < StandardError #:nodoc:
   end
 
+  class ModeratorNotFoundError < StandardError #:nodoc:
+  end
+
+  class ModeratorAlreadyExistsError < StandardError #:nodoc:
+  end
+
   class Lib #:nodoc:all
 
     def mailmanager
@@ -47,6 +53,7 @@ module MailManager
 
     def delete_list(params)
       params = {:name => params} unless params.respond_to?(:has_key?)
+      raise ListNotFoundError, "#{params[:name]} does not exist" unless list_names.include?(params[:name])
       cmd = :rmlist
       out = command(cmd, params)
       parse_output(cmd, out)
@@ -105,7 +112,7 @@ module MailManager
 
     def add_moderator(list, email)
       if moderators(list)['return'].include?(email)
-        return {'result' => 'already_a_moderator'}
+        raise ModeratorAlreadyExistsError, "#{email} is already a moderator of #{list.name}"
       end
       cmd = :withlist
       out = command(cmd, :name => list.name, :wlcmd => 'moderator.append',
@@ -115,7 +122,7 @@ module MailManager
 
     def delete_moderator(list, email)
       unless moderators(list)['return'].include?(email)
-        return {'result' => 'not_a_moderator'}
+        raise ModeratorNotFoundError, "#{email} is not a moderator of #{list.name}"
       end
       cmd = :withlist
       out = command(cmd, :name => list.name, :wlcmd => 'moderator.remove',
@@ -236,15 +243,6 @@ module MailManager
 
     def parse_output(mailman_cmd, output)
       case mailman_cmd
-      when :newlist
-        list_name = nil
-        output.split("\n").each do |line|
-          if match = /^##\s+(.+?)mailing\s+list\s*$/.match(line)
-            list_name = match[1]
-          end
-        end
-        raise MailmanExecuteError, "Error getting name of newly created list. Mailman sent:\n#{output}" if list_name.nil?
-        return_obj = MailManager::List.new(list_name)
       when :rmlist
         return_obj = output =~ /Removing list info/
       when :list_lists

data/lib/mailmanager/list.rb

@@ -100,8 +100,8 @@ module MailManager
       result['result'].to_sym
     end
 
-    # Deletes a moderator from the list. Returns :not_a_moderator if the
-    # requested deletion isn't a moderator.
+    # Deletes a moderator from the list. Raises a ModeratorNotFoundError
+    # if the requested deletion isn't a moderator.
     def delete_moderator(email)
       result = lib.delete_moderator(self, email)
       result['result'].to_sym

data/lib/mailmanager/version.rb

@@ -1,3 +1,3 @@
 module MailManager
-  VERSION = '1.0.15'
+  VERSION = '1.0.16'
 end

data/mailmanager.gemspec

@@ -28,4 +28,6 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency('ruby-debug19')
   s.add_development_dependency('ci_reporter')
   s.add_development_dependency('cucumber')
+  s.add_development_dependency('simplecov')
+  s.add_development_dependency('simplecov-rcov')
 end

data/spec/lib/mailmanager/lib_spec.rb

@@ -80,9 +80,7 @@ EOF
         subject.should_receive(:run_command).
           with("#{fake_root}/bin/newlist -q \"bar\" \"foo@bar.baz\" \"qux\" 2>&1", nil).
           and_return([new_list_return, process])
-        subject.should_receive(:run_command).
-          with("#{fake_root}/bin/list_lists 2>&1", nil).
-          and_return([list_result, process], [list_result_after_create, process])
+        subject.stub(:list_names).and_return([],['bar'])
         subject.create_list(:name => 'bar', :admin_email => 'foo@bar.baz',
                             :admin_password => 'qux')
       end
@@ -92,9 +90,7 @@ EOF
         subject.should_receive(:run_command).
           with("#{fake_root}/bin/newlist -q \"bar\" \"foo@bar.baz\" \"qux\" 2>&1", nil).
           and_return(["", process])
-        subject.should_receive(:run_command).
-          with("#{fake_root}/bin/list_lists 2>&1", nil).
-          and_return([list_result, process], [list_result_after_create, process])
+        subject.stub(:list_names).and_return([],['bar'])
         subject.create_list(:name => 'bar', :admin_email => 'foo@bar.baz',
                             :admin_password => 'qux')
       end
@@ -103,14 +99,23 @@ EOF
         # https://www.pivotaltracker.com/story/show/9421449
         subject.should_not_receive(:run_command).
           with("#{fake_root}/bin/newlist -q \"foo\" \"foo@bar.baz\" \"qux\" 2>&1", nil)
-        subject.should_receive(:run_command).
-          with("#{fake_root}/bin/list_lists 2>&1", nil).
-          and_return([list_result, process])
+        subject.stub(:list_names).and_return(['foo'])
         lambda {
           subject.create_list(:name => 'foo', :admin_email => 'foo@bar.baz',
                               :admin_password => 'qux')
         }.should raise_error(MailManager::ListNameConflictError)
       end
+
+      it "should raise a MailmanExecuteError if the list creation fails on the Mailman side" do
+        subject.should_receive(:run_command).
+          with("#{fake_root}/bin/newlist -q \"bar\" \"foo@bar.baz\" \"qux\" 2>&1", nil).
+          and_return(["", process])
+        subject.stub(:get_list).and_raise(MailManager::ListNotFoundError)
+        lambda {
+          subject.create_list(:name => 'bar', :admin_email => 'foo@bar.baz',
+                              :admin_password => 'qux')
+        }.should raise_error(MailManager::MailmanExecuteError)
+      end
     end
   end
 
@@ -119,8 +124,16 @@ EOF
       subject.should_receive(:run_command).
         with("#{fake_root}/bin/rmlist \"foo\" 2>&1", nil).
         and_return(["Removing list info", process])
+      subject.stub(:list_names).and_return(['foo'])
       subject.delete_list('foo')
     end
+
+    it "should raise an exception if the list doesn't exist" do
+      subject.stub(:list_names).and_return([])
+      lambda {
+        subject.delete_list('foo')
+      }.should raise_error(MailManager::ListNotFoundError)
+    end
   end
 
   context "with populated list" do
@@ -187,10 +200,11 @@ EOF
         test_lib_method(:add_moderator, 'moderator.append', nil, 'foo@bar.com')
       end
 
-      it "should return 'already_a_moderator' if they already a moderator" do
-        result = {'result' => 'already_a_moderator'}
+      it "should raise ModeratorAlreadyExistsError if they already a moderator" do
         subject.should_receive(:moderators).with(list).and_return({'result' => 'success', 'return' => ['foo@bar.com']})
-        subject.add_moderator(list, 'foo@bar.com').should == result
+        lambda {
+          subject.add_moderator(list, 'foo@bar.com')
+        }.should raise_error(MailManager::ModeratorAlreadyExistsError)
       end
     end
 
@@ -200,10 +214,11 @@ EOF
         test_lib_method(:delete_moderator, 'moderator.remove', nil, 'foo@bar.com')
       end
 
-      it "should return 'not_a_moderator' if they are not already a moderator" do
-        result = {'result' => 'not_a_moderator'}
+      it "should raise ModeratorNotFoundError if they are not already a moderator" do
         subject.should_receive(:moderators).with(list).and_return({'result' => 'success', 'return' => ['other@bar.com']})
-        subject.delete_moderator(list, 'foo@bar.com').should == result
+        lambda {
+          subject.delete_moderator(list, 'foo@bar.com')
+        }.should raise_error(MailManager::ModeratorNotFoundError)
       end
     end
 

data/spec/mailmanager_simplecov.rb

@@ -0,0 +1,21 @@
+require 'simplecov'
+require 'simplecov-rcov'
+
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    SimpleCov::Formatter::RcovFormatter.new.format(result)
+  end
+end
+
+SimpleCov.adapters.define 'mailmanager' do
+  add_filter '/spec/'
+  add_filter '/features/'
+  add_filter '/config/'
+  add_filter '/html/'
+  add_filter '/mailman/'
+  add_filter '/pkg/'
+  add_filter '/tasks/'
+  add_filter '/results/'
+end
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter

data/spec/spec_helper.rb

@@ -1,3 +1,7 @@
-$:.unshift('../lib')
+$:.unshift File.expand_path('../lib', __FILE__)
+if ENV['COVERAGE_REPORT']
+  $:.unshift File.expand_path(File.dirname(__FILE__))
+  require "mailmanager_simplecov"
+  SimpleCov.start 'mailmanager'
+end
 require 'mailmanager'
-

data/tasks/hudson.rake

@@ -1,15 +1,33 @@
-if ENV['RUBY_ENV'] == 'test'
+if ENV['RUBY_ENV'] == 'test' || ENV['RUBY_ENV'] == 'cucumber'
+
+  require 'cucumber/rake/task'
 
   namespace :hudson do
+    def report_path
+      "results/features"
+    end
+
+    Cucumber::Rake::Task.new({'cucumber' => [:report_setup, 'setup:coverage']}) do |t|
+      t.cucumber_opts = %{--profile default --no-color --format junit --out #{report_path}}
+    end
+
+    task :report_setup do
+      rm_rf report_path
+      mkdir_p report_path
+    end
+
     task :spec => ["hudson:setup:rspec", 'rake:spec']
 
     namespace :setup do
+      task :coverage do
+        ENV["COVERAGE_REPORT"] = "true"
+      end
       task :pre_ci do
         ENV["CI_REPORTS"] = 'results/rspec/'
         gem 'ci_reporter'
         require 'ci/reporter/rake/rspec'
       end
-      task :rspec => [:pre_ci, "ci:setup:rspec"]
+      task :rspec => [:pre_ci, :coverage, "ci:setup:rspec"]
     end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 15
-  version: 1.0.15
+  - 16
+  version: 1.0.16
 platform: ruby
 authors: 
 - Wes Morgan
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-01 00:00:00 -05:00
+date: 2011-02-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -116,6 +116,32 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: simplecov-rcov
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
 description: Ruby wrapper library for GNU Mailman's admin functions
 email: MorganW@dnc.org
 executables: []
@@ -125,6 +151,7 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- .gemtest
 - .gitignore
 - .rspec
 - .rvmrc
@@ -136,8 +163,11 @@ files:
 - Rakefile
 - config/cucumber.yml
 - features/create_list.feature
-- features/step_definitions/create_list_steps.rb
+- features/delete_list.feature
+- features/list_metadata.feature
+- features/moderators.feature
 - features/step_definitions/global_steps.rb
+- features/step_definitions/list_steps.rb
 - features/support/env.rb
 - lib/mailmanager.rb
 - lib/mailmanager/lib.rb
@@ -148,6 +178,7 @@ files:
 - spec/lib/mailmanager/lib_spec.rb
 - spec/lib/mailmanager/list_spec.rb
 - spec/lib/mailmanager_spec.rb
+- spec/mailmanager_simplecov.rb
 - spec/spec_helper.rb
 - tasks/hudson.rake
 has_rdoc: true
@@ -186,4 +217,5 @@ test_files:
 - spec/lib/mailmanager/lib_spec.rb
 - spec/lib/mailmanager/list_spec.rb
 - spec/lib/mailmanager_spec.rb
+- spec/mailmanager_simplecov.rb
 - spec/spec_helper.rb

data/features/step_definitions/create_list_steps.rb

@@ -1,4 +0,0 @@
-When /^I create a new list "([^"]*)"$/ do |list_name|
-  @mailmanager.create_list(:name => list_name, :admin_email => 'cuke@foo.org', :admin_password => 'greenisgood')
-end
-