schubert-minglr 1.2.0 → 1.3.0

data/.gitignore

@@ -1 +1,3 @@
 pkg/*
+coverage/*
+.DS_Store

data/Rakefile

@@ -1,6 +1,8 @@
 require 'rubygems'
 require 'rake'
 
+task :default => [:rcov, :features]
+
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
@@ -36,6 +38,7 @@ begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |test|
     test.libs << 'test'
+    test.rcov_opts = ['--exclude', 'gems', "--text-report", "--only-uncovered"]
     test.pattern = 'test/**/*_test.rb'
     test.verbose = true
   end
@@ -46,8 +49,6 @@ rescue LoadError
 end
 
 
-task :default => :test
-
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   if File.exist?('VERSION.yml')
@@ -63,5 +64,17 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+begin
+  require 'cucumber'
+  require 'cucumber/rake/task'
+
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "features --format pretty"
+  end
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
 
-task "dev" => ["test", "gemspec", "build"]
+task "ci" => ["rcov", "features", "gemspec", "build", "install"]

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 2
-:patch: 0
 :major: 1
+:minor: 3
+:patch: 0

data/bin/mtx

@@ -2,12 +2,12 @@
 
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'minglr'))
 
-uri_options, execution_options = MtxOptionsParser.parse(ARGV, :card, :transition)
+uri_options, execution_options = MTX::OptionsParser.parse(ARGV, :card, :transition)
 
 Resources::Base.configure uri_options
 
-if card = Card.find(execution_options[:card])
-  execution = TransitionExecution.create(execution_options)
+if card = Resources::Card.find(execution_options[:card])
+  execution = Resources::TransitionExecution.create(execution_options)
   raise "Transition aborted. Errors: #{execution.errors.full_messages}" if execution.errors.any?
 else
   raise "Card '#{execution_options[:card]}' cannot be found."

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: --format profile features
+html_report: --format pretty features

data/features/cards.feature

@@ -0,0 +1,27 @@
+Feature: Cards
+  
+  Scenario: Print list of cards in the project
+    Given the project "xp"
+    When I issue the "cards" action
+    Then the result should have "119 - Task      - Build PDF Export Widget on UI" in it
+    And the result should have "105 - Epic      - Find people, projects and documents" in it
+
+  Scenario: Print list of cards in the project with a filter
+    Given the project "xp"
+    And a keyword of "Project"
+    When I issue the "cards" action
+    Then the result should not have "119 - Task      - Build PDF Export Widget on UI" in it
+    Then the result should have "113 - Feature - Update Project" in it
+    And the result should have "112 - Feature - Create Project" in it
+    And the result should have "105 - Epic    - Find people, projects and documents" in it
+
+  Scenario: Print the details of a card in the project
+    Given the project "xp"
+    And the card number "112"
+    When I issue the "card" action
+    Then the result should have "Number: 112" in it
+    And the result should have "Name: Create Project" in it
+    And the result should have "Type: Feature" in it
+    And the result should have "Status:" in it
+    And the result should have "Description: N/A" in it
+    And the result should have "Attachments:" in it

data/features/step_definitions/minglr_steps.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__), "shared_steps")
+
+Given /^the project "([^\"]*)"$/ do |project|
+  @project = project
+end
+
+Given /^the card number "([^\"]*)"$/ do |card_number|
+  if @options
+    @options << [card_number]
+  else
+    @options = [card_number]
+  end
+end
+
+Given /^a keyword of "([^\"]*)"$/ do |keyword|
+  if @options
+    @options << [keyword]
+  else
+    @options = [keyword]
+  end
+end
+
+When /^I issue the "([^\"]*)" action$/ do |action|
+  @action = action
+  @response = execute_minglr_command(@project, @action, @options)
+end
+
+Then /^the result should have "([^\"]*)" in it$/ do |string|
+  assert @response.split("\n").join(" ").include?(string), "Expected #{@response.inspect} to contain '#{string}'"
+end
+
+Then /^the result should not have "([^\"]*)" in it$/ do |string|
+  assert !@response.split("\n").join(" ").include?(string), "Expected #{@response.inspect} to not contain '#{string}'"
+end

data/features/step_definitions/shared_steps.rb

@@ -0,0 +1,69 @@
+require "test/unit/assertions"
+require File.join(File.dirname(__FILE__), "..", "..", "lib", "minglr")
+World(Test::Unit::Assertions)
+
+module Kernel
+
+  def capture_stdout
+    $stdout = $cucumberout
+    yield
+    return $cucumberout
+  ensure
+    $stdout = STDOUT
+  end
+ 
+end
+
+def rc_config
+  { 
+    :scrum => {
+      :url              => "http://localhost:9090/projects/scrum",
+      :password         => "mingle",
+      :status_property  => "cp_status",
+      :username         => "schubert"
+    }, 
+    :global => {
+      :default          => "blank",
+      :username         => "schubert"
+    },
+    :storytracker => {
+      :url              => "http://localhost:9090/projects/storytracker",
+      :password         => "mingle",
+      :status_property  => "cp_status",
+      :username         => "schubert"
+    },
+    :xp => {
+      :url => "http://localhost:9090/projects/xp",
+      :password => "mingle",
+      :username => "schubert"
+    },
+    :blank => {
+      :url => "http://localhost:9090/projects/blank",
+      :password => "mingle",
+      :username => "schubert"
+    },
+    :agilehybrid => {
+      :url => "http://localhost:9090/projects/agilehybrid",
+      :password => "mingle",
+      :status_property => "cp_status",
+      :username=>"schubert"
+    }
+  }
+end
+
+def execute_minglr_command(project, action, extra_arguments = [])
+  $cucumberout = StringIO.new
+  extra_arguments = [] if extra_arguments.nil?
+  uri_options = rc_config[:global] || {}
+  original_arguments = ([project, action] + extra_arguments)
+  
+  uri_options.merge! rc_config[project.to_sym]
+  Resources::Base.configure uri_options
+  Resources::Attachment.configure
+  extra_options = Minglr::OptionsParser.parse(original_arguments)
+  
+  output = capture_stdout do
+    Minglr::Action.execute(action, original_arguments, extra_options, rc_config[project.to_sym])
+  end
+  output.string.strip
+end

data/features/users.feature

@@ -0,0 +1,6 @@
+Feature: Users
+  
+  Scenario: Print list of users on the project
+    Given the project "xp"
+    When I issue the "users" action
+    Then the result should have "schubert - Michael Schubert - michael@schubert.cx" in it

data/lib/minglr.rb

@@ -1,3 +1,5 @@
+MINGLR_ENV = "normal" unless defined?(MINGLR_ENV)
+
 require 'rubygems'
 require 'activesupport'
 require 'activeresource'
@@ -8,8 +10,10 @@ require File.join(prefix, "action")
 require File.join(prefix, "options_parser")
 require File.join(prefix, "config_parser")
 
-require File.join(prefix, "mtx_options_parser")
-require File.join(prefix, "input_cache")
+mtx = File.join(prefix, "mtx", "*")
+Dir[mtx].each do |file_name|
+  load file_name
+end
 
 require File.join(prefix, "resources", "base")
 resources = File.join(prefix, "resources", "*")

data/lib/minglr/action.rb

@@ -12,7 +12,7 @@ module Minglr
       begin
         Commands.send(action, options, flag_options, config)
       rescue ActiveResource::ResourceNotFound => error
-        puts error.message + " for URL #{Resources::Base.site}..."
+        puts error.message + " for URL '#{Resources::Base.site}' ..."
       end
     end
   
@@ -34,7 +34,7 @@ module Minglr
 
       def self.card(options, flag_options, config)
         card_number = options.first
-        Resources::Card.print_card(options.first, config[:status_property])
+        Resources::Card.print_card(card_number, config[:status_property])
       end
   
       def self.cards(options, flag_options, config)

data/lib/minglr/mtx/input_cache.rb

@@ -0,0 +1,24 @@
+module MTX
+  class InputCache
+    class << self
+      def put(key, content)
+        File.open(file_pathname(key), File::CREAT | File::WRONLY | File::TRUNC) { |file| file.write content }
+      end
+    
+      def get(key)
+        if content = File.read(file_pathname(key))
+          return nil if content.blank?
+          content
+        end
+      rescue
+        nil
+      end
+    
+      protected
+    
+      def file_pathname(key)
+        File.join(Dir::tmpdir, "#{key.to_s.gsub(/[^\w]/, '')}.entry")
+      end
+    end
+  end
+end

data/lib/minglr/mtx/options_parser.rb

@@ -0,0 +1,58 @@
+module MTX
+  
+  class OptionsParser
+    
+    def self.parse(args, *required_by_command)
+      uri_options = {}
+      command_options = {}
+
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: mtx [options]"
+        opts.on("--transition TRANSITION", "Transition name.") do |transition|
+          command_options[:transition] = transition
+        end
+
+        opts.on("--card CARD", "Card number.") do |card|
+          command_options[:card] = card
+        end
+
+        opts.on("--properties ARGS", Array, "User-entered properties and values for the transition in array format. Must be an even number of comma-delimited values, like \"A,B,'C with spaces','D with spaces'\".") do |args|
+          command_options[:properties] = args.in_groups_of(2).map { |key, value| {'name' => key, 'value' => value} }
+        end
+      
+        opts.on("--comment COMMENT", "Transition comment. This may be required depending on your transition settings.") do |comment|
+          command_options[:comment] = comment
+        end
+
+        opts.on("--username USERNAME", "Mingle username.") do |username|
+          uri_options[:username] = username
+        end
+
+        opts.on("--password PASSWORD", "Mingle password.") do |password|
+          uri_options[:password] = password
+        end
+
+        opts.on("--host_port HOST_PORT", "Host and port.") do |host_and_port|
+          uri_options[:host_and_port] = host_and_port
+        end
+
+        opts.on("--project PROJECT", "Project name.") do |project|
+          uri_options[:project] = project
+        end
+      end
+    
+      parser.parse! args
+
+      ([:project, :host_and_port] | required_by_command).each do |arg|
+        unless command_options[arg] || uri_options[arg]
+          # TODO: let commands handle their own errors
+          $stderr.puts "Missing command-line argument --#{arg.to_s}, use --help for command-line options."
+          exit 1
+        end
+      end
+
+      [uri_options, command_options]
+    end
+  end
+  
+end

data/lib/minglr/options_parser.rb

@@ -1,3 +1,5 @@
+require "yaml"
+
 module Minglr
   class OptionsParser
     def self.parse(args, *required_by_command)
@@ -9,7 +11,7 @@ module Minglr
         rescue ActiveResource::UnauthorizedAccess => exception
           puts "Connection #{exception.message} to #{Resources::Base.site.to_s}"
           puts "Did you set 'basic_authentication_enabled: true' in your auth_config.yml file?"
-          exit 1
+          exit 1 unless MINGLR_ENV == "test"
         end
       end
       
@@ -21,23 +23,23 @@ module Minglr
         opts.separator "Valid Commands Are: #{Minglr::Action.valid_actions.join(", ")}"
       
         opts.on("-n NAME", String, "Short name of card") do |card_name|
-          command_options[:name] = card_name
+          command_options[:name] = card_name.strip
         end
       
         opts.on("-d DESCRIPTION", String, "Description of card") do |card_description|
-          command_options[:description] = card_description
+          command_options[:description] = card_description.strip
         end
       
         opts.on("-t TYPE", String, "Type of card") do |card_type|
-          command_options[:card_type_name] = card_type
+          command_options[:card_type_name] = card_type.strip
         end
       
         opts.on("-c COMMENT", String, "Comment") do |comment|
-          command_options[:comment] = comment
+          command_options[:comment] = comment.strip
         end
       
         opts.on("-f FILE", String, "File to attach") do |file|
-          command_options[:file_attachment] = file
+          command_options[:file_attachment] = file.strip
         end
       
         unless project_options.empty?
@@ -56,17 +58,18 @@ module Minglr
     
         opts.on_tail("-h", "--help", "Show this help message.") do |help|
           puts opts
-          exit
+          exit 0 unless MINGLR_ENV == "test"
         end
       
         opts.on_tail("--version", "Show version") do
-          puts Minglr::VERSION
-          exit
+          version = YAML.load(File.read(File.join(File.dirname(__FILE__), "..", "..", "VERSION.yml")))
+          puts "#{version[:major]}.#{version[:minor]}.#{version[:patch]}"
+          exit 0 unless MINGLR_ENV == "test"
         end
       
         if args.empty?
           puts opts
-          exit
+          exit 0 unless MINGLR_ENV == "test"
         end
       end
 

data/lib/minglr/resources/attachment.rb

@@ -8,6 +8,10 @@ module Resources
       self.prefix += "cards/:card_number/"
     end
     
+    def self.curl(command)
+      `#{command}`
+    end
+    
     def self.fetch(card_number, username, password)
       if card_to_update = Card.find(card_number)
         attachments = find(:all, :params => { :card_number => card_number })
@@ -15,7 +19,8 @@ module Resources
           url = self.site + attachment.url
           url.userinfo = nil, nil
           puts "Downloading #{url.to_s}:"
-          `curl --insecure --progress-bar --output #{attachment.file_name} --user #{username}:#{password} #{url}`
+          command = "curl --insecure --progress-bar --output #{attachment.file_name} --user #{username}:#{password} #{url}"
+          curl(command)
         end
       end
     end

data/lib/minglr/resources/card.rb

@@ -7,7 +7,7 @@ module Resources
       card = self.new(options)
       if card.save
         card.reload
-        puts "Card #{card.number} created"
+        puts "Card ##{card.number} created"
       else
         warn "Unable to create card"
       end
@@ -17,7 +17,12 @@ module Resources
       if card_to_move = find(card_number)
         transition_options = { :card => card_number }
         transition_options.merge!({ :comment => options[:comment]}) if options[:comment]
-        current_status = card_to_move.send(config[:status_property]) if config[:status_property]
+        if config[:status_property]
+          current_status = card_to_move.send(config[:status_property])
+        else
+          warn "No known status of card ##{card_number}, cannot move!"
+          return
+        end
         next_transition = nil
         
         card_type = card_to_move.card_type_name.downcase
@@ -35,7 +40,8 @@ module Resources
             key.to_s =~ /^story_state/
           end
         else
-          puts "No transitions defined for card of type #{card_to_move.card_type_name}"  
+          warn "No transitions defined for card of type #{card_to_move.card_type_name}"
+          return
         end
         status_states = status_states.collect {|state| state.last }.collect {|state| state.split(">").collect { |value| value.strip } }
         next_transition = status_states.select {|state| state.first.downcase == current_status.downcase }.first.last
@@ -47,13 +53,13 @@ module Resources
           end
         end
       else
-        warn "No card #{card_number} found to move"
+        warn "No card ##{card_number} found to move"
       end
     end
     
     def self.print_all(options = [], status_property = nil)
       attributes = [:number, :card_type_name, status_property, :name].compact
-      cards = Resources::Card.find(:all)
+      cards = find(:all)
       cards.send(:extend, Minglr::Extensions::Array)
       cards = cards.filter(attributes, options)
       if cards.any?
@@ -64,8 +70,7 @@ module Resources
     end
     
     def self.print_card(card_number, status_property = nil)
-      attributes = [:number, :card_type_name, status_property, :name, :description].compact
-      if card = find(card_number)
+      if card = find(card_number.to_i)
         puts card.to_s(status_property)
       else
         warn "No card ##{card_number} found"
@@ -78,24 +83,29 @@ module Resources
           card_to_update.send("#{attribute.to_s}=".to_sym, value)
         end
         card_to_update.save
-        puts "Card #{card_to_update.number} updated\n\n"
-        puts card.to_s
+        puts "Card ##{card_to_update.number} updated\n\n"
+        puts card_to_update.to_s
       else
-        warn "Unable to update card #{card_number}"
+        warn "Unable to update card ##{card_number}"
       end
     end
     
     def to_s(status_property = nil)
-      attachments = Resources::Attachment.find(:all, :params => { :card_number => number })
-      attachments = attachments.collect do |attachment|
-        "* #{attachment.file_name}: #{Resources::Base.site + attachment.url}"
+      attachments = []
+      begin
+        attachments = Attachment.find(:all, :params => { :card_number => number })
+        attachments = attachments.collect do |attachment|
+          "* #{attachment.file_name}: #{Resources::Base.site + attachment.url}"
+        end
+      rescue ActiveResource::ResourceNotFound => error
+        attachments = ["N/A"]
       end
       output = <<-EOS
      Number: #{number}
        Name: #{name}
-       Type: #{card_type_name}
-     Status: #{send(status_property) if status_property}
-Description: #{description}
+       Type: #{card_type_name.nil? ? "N/A" : card_type_name}
+     Status: #{send(status_property) if status_property && self.respond_to?(status_property)}
+Description: #{description.nil? ? "N/A" : description}
 
 Attachments:
   #{attachments.join("\n")}