torque 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f854381b747109eef15b6e25a52269228662c14
-  data.tar.gz: c30b8f46bb06b4d603ee239b77334b70dad1316d
+  metadata.gz: 1c7055b042760f90fba0fe791442b4ba857bec52
+  data.tar.gz: 2e386cca466678b01c5f3e8dc7b45606285c672b
 SHA512:
-  metadata.gz: 09f97b9a365ef4445b34b1d4e4c6b0eeed47b9dcf92c45cdafa05a6308fb742ed8b1f81e2f5d6b8c0354a0f6d7d8b5fb3c2ba98a0fc45b1a4513d7e811547cfd
-  data.tar.gz: 99722a445aae3779420ab5b018f6b2fede07bb280ba6a4612f099aa2035b95c31e208f72174fba2f6b496cab7d104945f25c211ceb7140dba9b84c42ac0582e1
+  metadata.gz: eace72e27669cb57a907a3155a522d2159dcf12e592c4aa062ce89a4d053f3d7727c5483a322e020794d4235992584422044513c4eec863c0f0b6dac5e982443
+  data.tar.gz: a3c738c870d46ffbc8d84fb1fb7f09ffdcdc566de1ce9ac01ffa807fff82d49fa294be4d11918ff70c766274e3dbb21327dc2511e84bef330362df7b485196e8

data/README.md

@@ -25,6 +25,7 @@ Current Features
 * Automatically compiles all Pivotal Tracker stories accepted between the current date and the last time Torque was run
 * Compile stories accepted within a custom date range
 * Stores a record of each document as it's generated
+* Filtering stories by label, owner or story type
 * Configuration script that automatically sets up a directory to use Torque
 * Project script that automatically displays/switches between your Pivotal Tracker projects
 * Ability to email the finished release notes from a personal email account to a pre-specified mailing list. (Currently can only send from accounts hosted by Gmail)
@@ -79,6 +80,12 @@ To compile release notes for stories within a custom date range:
 
 If [from] is set, [to] will default to today. If [to] is set, [from] will default to 1/1/1900.
 
+To filter your results by story label, owner or type:
+
+    # torque --label list,of,labels --owner "list, of, owners" --type "list,of,story types"
+
+Note: The Pivotal Tracker API currently only supports "AND" searches for these fields. A search for multiple labels, for example, will turn up only the stories that match every label. ("OR" searches may or may not be added with the release of the PT API v5, which should arrive soon.)
+
 To email the release notes from a personal email to Torque's mailing list:
 
     # torque --email
@@ -89,7 +96,7 @@ To display all available Pivotal Tracker projects or change your current project
 
     # torque project
 
-To set up automatic emailing when the notes and add/remove from the mailing list:
+To set up automatic emailing of the notes and add/remove from the mailing list:
 
     # torque email
 

data/VERSION

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

data/bin/config

@@ -249,9 +249,10 @@ end
 
 # Finishes
 
-unless options[:token]
-  puts 
-  puts "Configuration complete!"
+
+puts 
+puts "Configuration complete!"
+if !options[:token] && !(options[:output_dir] && !should_setup_info)
   puts "WARNING: Do not check .torqueinfo.yaml into your version control system! (Contains sensitive information)"
-  puts
-end
+end
+puts

data/bin/torque

@@ -52,6 +52,16 @@ option_parser = OptionParser.new do |opts|
     options[:help] = arg
   end
 
+  opts.on("--label LABELS", "Filters stories by a (comma-separated) list of labels") do
+    |arg|
+    options[:label] = arg
+  end
+
+  opts.on("--owner OWNERS", "Filters stories by a (comma-separated) list of owners") do
+    |arg|
+    options[:owner] = arg
+  end
+
   opts.on("--root ROOT_DIR", "Set the root directory for the script (should contain a .torqueinfo.yaml file)") do
     |arg|
     options[:root_dir] = arg
@@ -67,6 +77,11 @@ option_parser = OptionParser.new do |opts|
     options[:accept_to] = arg
   end
 
+  opts.on("--type TYPES", "Filters stories by a (comma-separated) list of story types") do
+    |arg|
+    options[:type] = arg
+  end
+
   opts.on("-v", "--verbose", "Run verbosely") do
     |arg|
     options[:verbose] = arg
@@ -147,4 +162,8 @@ rescue Torque::MissingOutputDirectoryError => e
   puts e.message
   puts "Run 'torque config -o [directory]' to create/change your output directory"
   exit 8
+rescue ArgumentError => e
+  puts "ABORTING"
+  puts e.message
+  exit 9
 end

data/lib/torque.rb

@@ -42,11 +42,17 @@ class Torque
     notes_string += Date.today.strftime(@date_format)+"\n"
     notes_string += "Release Notes\n"
     notes_string += "Project #{@settings.project} - '#{project_name}'\n"
+
+    if @settings.filters_on
+      notes_string += "Filter - '#{@settings.filter_string}'\n"
+    end
+
     if @settings.custom_date_range
       notes_string += "(custom "+@settings.accept_from.strftime(@date_format)+" - "+@settings.accept_to.strftime(@date_format)+")\n"
     else
       notes_string += "("+@settings.accept_from.strftime(@date_format)+" - "+@settings.accept_to.strftime(@date_format)+")\n"
     end
+
     notes_string += "\nThese notes were generated with Torque, a Pivotal Tracker command line utility"
     notes_string += "\n"
     notes_string += "\n"
@@ -136,13 +142,18 @@ class Torque
 
     print_if_not_silent "Current project: #{@settings.project} - '#{project_name}'"
 
+    print_if_not_silent "Filter: '#{@settings.filter_string}'" if @settings.filters_on
+
     print_if_not_silent "Generating release notes: " \
       + (@settings.custom_date_range ? "Custom " : "") \
       + @settings.accept_from.strftime(@date_format) + " - " \
       + @settings.accept_to.strftime(@date_format) \
       + "..."
 
-    project_html = Pivotal.new(@settings.token).get_project_stories(@settings.project)
+    pivotal = Pivotal.new(@settings.token)
+    @settings.filters_on \
+    ? project_html = pivotal.get_project_stories(@settings.project, @settings.filter_string) \
+    : project_html = pivotal.get_project_stories(@settings.project)
     notes_string = generate_notes(project_html, project_name)
 
     # Writes the notes to file

data/lib/torque/date_settings.rb

@@ -66,13 +66,13 @@ class Torque
       begin
         @accept_from = Date.parse(@options[:accept_from].nil? ? "1900-01-01" : @options[:accept_from])
       rescue ArgumentError
-        raise ArgumentError.new("Date #{@options[:accept_from]} could not be parsed")
+        raise ArgumentError.new("Date '#{@options[:accept_from]}' could not be parsed")
       end
 
       begin
         @accept_to = (@options[:accept_to].nil? ? @current_date : Date.parse(@options[:accept_to]))
       rescue ArgumentError
-        raise ArgumentError.new("Date #{@options[:accept_to]} could not be parsed")
+        raise ArgumentError.new("Date '#{@options[:accept_to]}' could not be parsed")
       end
 
       if @accept_from > @accept_to

data/lib/torque/pivotal.rb

@@ -35,10 +35,13 @@ class Torque
     end
 
     ##
+    # @param project The ID of the Pivotal Tracker project from which to get data
+    # @param filter_string A string filter for the stories
+    #
     # Sends a request through the Pivotal Tracker API
     #
     # Returns a string of html data from Pivotal Tracker with data on the stories for the given project
-    def get_project_stories(project)
+    def get_project_stories(project, filter_string=nil)
 
       # Polls story data from pivotal tracker
       host="pivotaltracker.com"
@@ -46,6 +49,9 @@ class Torque
       url="http://www.pivotaltracker.com/services/v3/projects/#{project}/stories"
       headers={'X-TrackerToken'=>@token}
 
+      url += "?filter=#{filter_string} includedone:true" if filter_string
+      url = URI.escape(url)
+
       response=Net::HTTP.new(host, port).get(url, headers)
 
       # Handles network errors
@@ -77,6 +83,8 @@ class Torque
       url="http://www.pivotaltracker.com/services/v3/projects"
       headers={'X-TrackerToken'=>@token}
 
+      url = URI.escape(url)
+
       response=Net::HTTP.new(host, port).get(url, headers)
 
       # Handles network errors

data/lib/torque/record_pathname_settings.rb

@@ -9,12 +9,12 @@ class Torque
     ##
     # @param output_dir The path to the release notes output directory
     # @param project The project id
-    # @param custom_date_range True if a custom date range is being used, else false
+    # @param custom True if this is a run with custom settings, else false
     # @param fs An instance of the FileSystem class
-    def initialize(output_dir, project, custom_date_range, fs)
+    def initialize(output_dir, project, custom, fs)
       @output_dir = output_dir
       @project = project
-      @custom = custom_date_range
+      @custom = custom
       @fs = fs
     end
 

data/lib/torque/settings.rb

@@ -25,6 +25,10 @@ class Torque
     # The path to the most recently generated notes
     attr_reader :current_notes_path
 
+    ##
+    # True if should treat this run as a custom run, else false
+    attr_reader :custom
+
     ##
     # True if a custom date range is being used (set manually through the command line), false if using the default one
     attr_reader :custom_date_range
@@ -45,6 +49,18 @@ class Torque
     # A list of email addresses to send the notes to
     attr_reader :email_to
 
+    ##
+    # True if filters are being used for the stories, else false
+    attr_reader :filter_string
+
+    ##
+    # A hash (field => contents) of the filters being used
+    attr_reader :filters
+
+    ##
+    # True if filters are being used for the stories, else false
+    attr_reader :filters_on
+
     ##
     # The path to the .last-run file in the records directory
     attr_reader :last_run_path
@@ -90,16 +106,39 @@ class Torque
       @options = options
       @fs = fs
 
-      # Handles basic "true/false" options
+      # Initializes the root directory for Torque
+
+      @root_dir = @options[:root_dir] || "."
+      @root_dir = File.expand_path(@root_dir)
+
+      # Handles boolean options
 
       @email = @options[:email] || false
       @silent = @options[:silent] || false
       @verbose = @options[:verbose] || false
 
-      # Initializes the root directory for Torque
+      # Parses story filters from the options
 
-      @root_dir = @options[:root_dir] || "."
-      @root_dir = File.expand_path(@root_dir)
+      @filters = {}
+
+      @filters[:label] = @options[:label] if @options[:label]
+      @filters[:owner] = @options[:owner] if @options[:owner]
+      @filters[:type]  = @options[:type]  if @options[:type]
+
+      @filters_on = !@filters.empty?
+
+      # Generates a filter string from the story filters
+
+      @filter_string = ""
+      @filters.each do |field, args|
+        args.split(",").each do |arg|
+          arg.strip!
+          @filter_string += "#{field}:"
+          @filter_string += ( (arg.include? " ") ? "\"#{arg}\" " : "#{arg} " )
+        end
+      end
+
+      @filter_string.strip!
 
       # Parses and processes data from .torqueinfo.yaml
 
@@ -153,9 +192,13 @@ class Torque
       
       @current_notes_path = "#{output_dir}/release-notes.txt"
 
+      # Determines whether to treat this run as a custom or a default run
+
+      @custom = @custom_date_range || @filters_on
+
       # Determines the path name to use for the record of the output file
       
-      record_pathname_settings = RecordPathnameSettings.new(@output_dir, @project, @custom_date_range, @fs)
+      record_pathname_settings = RecordPathnameSettings.new(@output_dir, @project, @custom, @fs)
       @record_path = record_pathname_settings.get_path
 
     end

data/lib/torque/story.rb

@@ -38,7 +38,7 @@ class Torque
 
     ##
     # The story's type (feature, chore, etc)
-    attr_reader :story_type
+    attr_reader :type
 
     ##
     # @param html_hash A hash (of html elements keyed by their tags) generated from Pivotal Tracker story html
@@ -49,7 +49,7 @@ class Torque
     end
 
     ##
-    # html_hash:: A hash (of html elements keyed by their tags) generated from Pivotal Tracker story html
+    # @param html_hash A hash (of html elements keyed by their tags) generated from Pivotal Tracker story html
     # 
     # Creates a new story without parsing its fields
     def initialize(html_hash)
@@ -77,12 +77,12 @@ class Torque
       @name = ""
       @project_id = -1
       @story_id = -1
-      @story_type = ""
+      @type = ""
 
       @current_state = handle_nil(@current_state, html_hash["current_state"])
       @description = handle_nil(@description, html_hash["description"])
       @name = handle_nil(@name, html_hash["name"])
-      @story_type = handle_nil(@story_type, html_hash["story_type"])
+      @type = handle_nil(@type, html_hash["story_type"])
       
       @estimate = Integer(handle_nil(@estimate, html_hash["estimate"]))      
       @project_id = Integer(handle_nil(@project_id, html_hash["project_id"]))
@@ -100,7 +100,7 @@ class Torque
       self
     end
 
-    def to_s()
+    def to_s
       return "Story("+@name+", "+"#{@story_id}"+")"
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: torque
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Nico Adams, Scrimmage