torque 0.0.1

data/lib/torque/pivotal_html_parser.rb

@@ -0,0 +1,67 @@
+# Processes a project by matching commits in its git commit history to pivotal id's
+# Should have already run the getProject script, generating "commitHistory.txt" and "project_html.txt"
+
+require 'date'
+require 'nokogiri'
+require_relative 'story'
+
+class Torque
+  class PivotalHTMLParser
+
+    ##
+    # @param project_html_string An html string containing the story data for a Pivotal Tracker project
+    # @param accept_from A Date marking the lower bound for the date_accepted field of a story
+    # @param accept_to A Date marking the upper bound for the date_accepted field of a story
+    # 
+    # Returns a list of Story objects parsed from project_html_string whose date_accepted fields are within acceptable
+    # bounds (least recent to most recent date accepted)
+    def process_project_date_filter(project_html_string, accept_from, accept_to)
+
+      story_list = process_project(project_html_string)
+      story_list.select! {
+        |story|
+        (!story.date_accepted.nil? \
+          && story.date_accepted >= accept_from \
+          && story.date_accepted <= accept_to)
+      }
+
+      story_list
+
+    end
+
+    # @param project_html_string An html string containing the story data for a Pivotal Tracker project
+    #
+    # Returns a list of all Story objects parsed from project_html_string (least recent to most recent date accepted)
+    def process_project(project_html_string)
+
+      project_html = Nokogiri::HTML(project_html_string)
+      story_html_array = project_html.search('story')
+      story_list = []
+
+      story_html_array.each do
+        |story_element|
+        story_list << process_story(story_element)
+      end
+
+      story_list
+    end
+
+
+    private
+    # story: A Nokogiri::XML::Element
+    #
+    # Returns a Story object based off the information in the story
+    def process_story(story_element)
+
+      story_hash = {}
+
+      story_element.children.each do
+        |child|
+        story_hash[child.name] = child.text
+      end
+
+      Story.create(story_hash)
+    end
+
+  end
+end

data/lib/torque/project/project.rb

@@ -0,0 +1,25 @@
+class Torque
+
+  ##
+  # Stores the name and id of a single Pivotal project
+  class Project
+
+    ##
+    # True if this is the current project, else false
+    attr_accessor :current
+
+    ##
+    # The project ID
+    attr_reader :id
+
+    ##
+    # The project name
+    attr_reader :name
+
+    def initialize(id, name, current=false)
+      @current = current
+      @id = id
+      @name = name
+    end
+  end
+end

data/lib/torque/project/project_manager.rb

@@ -0,0 +1,140 @@
+lib_dir = File.expand_path(File.dirname(__FILE__)) + "/../.."
+
+require 'net/http'
+require 'nokogiri'
+require 'pathname'
+require 'yaml'
+
+require_relative "#{lib_dir}/torque/file_system"
+require_relative "#{lib_dir}/torque/pivotal"
+require_relative "#{lib_dir}/torque/torque_info_parser"
+require_relative "#{lib_dir}/torque/error/invalid_token_error"
+require_relative "#{lib_dir}/torque/error/missing_token_error"
+require_relative "#{lib_dir}/torque/error/pivotal_api_error"
+require_relative "project"
+
+class Torque
+
+  ##
+  # Retrieves the list of Pivotal Tracker projects from the Pivotal API, automates the switching of projects
+  class ProjectManager
+
+    ##
+    # @param torque_info_parser An instance of the TorqueInfoParser class
+    def initialize(torque_info_parser=TorqueInfoParser.new)
+      @torque_info_parser = torque_info_parser
+    end
+
+    ##
+    # @param token A Pivotal Tracker API token (default: Loads token from .torqueinfo.yaml)
+    #
+    # Requests and processes the project list from the Pivotal Tracker API
+    #
+    # Returns the project list
+    def load_project_list(token=nil)
+      get_project_list(token)
+      @project_list
+    end
+
+    ##
+    # Returns the project list if 'load_project_list' has been called, else returns nil
+    #
+    # Does not do any processing
+    def project_list
+      @project_list
+    end
+
+    ##
+    # Returns the current project if 'load_project_list' has been called and one exists, else returns nil
+    def current_project
+      @project_list.nil? \
+      ? nil
+      : @project_list.select{|project| project.current}[0]
+    end
+
+    ##
+    # Formats the project list as a printable string
+    #
+    # Prepends an asterisk to the current project
+    def format_project_list
+
+      list_str = "PROJECTS\n"
+      @project_list.each do |project|
+        
+        project.current \
+          ? list_str += "* " \
+          : list_str += "  "
+        list_str += "#{project.id} #{project.name}" 
+        list_str += "\n"
+      end
+
+      list_str
+    end
+
+
+    private
+
+    # token: The API token to use for the request
+    #
+    # Retrieves the project list from Pivotal Tracker
+    # Stores the project list in @project_list
+    # Returns the project list
+    def get_project_list(token=nil)
+
+      # Parses data from the torque info file
+      torque_info_token, project_id = parse_torque_info
+      token = torque_info_token unless token
+
+      # If the API token doesn't exist, prompt for it     
+      raise MissingTokenError.new "API token for Pivotal Tracker has not been set" \
+        unless token
+
+      # Parses the project list from the Pivotal Tracker API
+      html = Pivotal.new(token).get_project_data
+      @project_list = parse_project_html(html)
+
+      identify_current_project(project_id)
+    end
+
+    # Identifies the current project and marks it as such
+    def identify_current_project(project_id)
+      @project_list.each do
+        |project|
+        if String(project_id) == project.id
+          project.current = true
+        end
+      end
+    end
+
+    # Parses the API token and current project from .torqueinfo.yaml
+    # Returns [token, project]
+    def parse_torque_info
+
+      torque_info = @torque_info_parser.parse
+
+      return torque_info.token, torque_info.project
+    end
+
+    # Parses the html returned from the Pivotal API
+    def parse_project_html(html)
+      project_html = Nokogiri::HTML(html)
+      project_html_array = project_html.search('project')
+      project_list = []
+
+      project_html_array.each do
+        |project_element|
+  
+        project_hash = {}
+        project_element.children.each do
+          |child|
+          project_hash[child.name] = child.text
+        end
+
+        project_list << Project.new(project_hash["id"], project_hash["name"])
+      end
+
+      project_list
+    end
+
+  end
+end

data/lib/torque/record_pathname_settings.rb

@@ -0,0 +1,80 @@
+require_relative 'file_system'
+
+class Torque
+
+  ##
+  # Generates the pathname to use for the record file of the release notes
+  class RecordPathnameSettings
+
+    ##
+    # @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 fs An instance of the FileSystem class
+    def initialize(output_dir, project, custom_date_range, fs)
+      @output_dir = output_dir
+      @project = project
+      @custom = custom_date_range
+      @fs = fs
+    end
+
+    ##
+    # Returns the path to the record file, generating one if it does not exist
+    def get_path
+      generate_record_path if !@path
+      @path
+    end
+
+
+    private
+
+    # Generates a value for @path
+    def generate_record_path
+      if @custom
+        path_for_custom_date_range
+      else
+        path_for_default_date_range
+      end
+    end
+
+    # The path to the record of the release notes file if default dates were used
+    def path_for_default_date_range
+      title = "#{@project}-#{current_date_string}"
+      @path="#{@output_dir}/previous/#{title}.txt"
+      @path
+    end
+
+    # The path to the record of the release notes file if a custom date range was used
+    def path_for_custom_date_range
+      title = "#{@project}-#{current_date_string}"
+      title += "-custom"
+      path_base = "#{@output_dir}/previous/#{title}"
+      path_to_test = "#{path_base}.txt"
+      
+      # If the first pathname tried is not in use, use it
+      if !(@fs.path_exist? path_to_test)
+        @path=path_to_test
+      
+      # Else, will append "1", "2", "3"... to the end of the pathname, returning the first name that is not in use
+      else
+        i=1
+        while true
+          path_to_test = "#{path_base}#{i}.txt"
+          if !(@fs.path_exist? path_to_test)
+            @path=path_to_test
+            break
+          end
+          i+=1
+        end
+      end
+      
+      @path
+    end
+
+    # A string representing the current date: YYYY-MM-DD
+    def current_date_string
+      Date.today.strftime("%Y-%m-%d")
+    end
+
+  end
+end

data/lib/torque/settings.rb

@@ -0,0 +1,164 @@
+require 'date'
+require_relative 'date_settings'
+require_relative 'file_system'
+require_relative 'record_pathname_settings'
+require_relative 'torque_info_parser'
+require_relative 'error/missing_project_error'
+require_relative 'error/missing_token_error'
+require_relative 'error/missing_output_directory_error'
+
+class Torque
+
+  ##
+  # Stores all of the settings for a release notes generation
+  class Settings
+
+    ##
+    # The accept-from date. All stories accepted on Pivotal Tracker before this date will be ignored
+    attr_reader :accept_from
+
+    ##
+    # The accept-to date. All stories accepted on Pivotal Tracker after this date will be ignored
+    attr_reader :accept_to
+
+    ##
+    # The path to the most recently generated notes
+    attr_reader :current_notes_path
+
+    ##
+    # 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
+
+    ##
+    # True if should send the notes to the email list after notes are generated, else false
+    attr_reader :email
+
+    ##
+    # The email address from which to send notes
+    attr_reader :email_address
+
+    ##
+    # The password to the email address from which to send notes
+    attr_reader :email_password
+
+    ##
+    # A list of email addresses to send the notes to
+    attr_reader :email_to
+
+    ##
+    # The path to the .last-run file in the records directory
+    attr_reader :last_run_path
+
+    ##
+    # The Pivotal Tracker project ID to use
+    attr_reader :project
+
+    ##
+    # The output directory to use
+    attr_reader :output_dir
+
+    ##
+    # The path to the record file of the notes
+    attr_reader :record_path
+
+    ##
+    # The path to the root directory (the directory which contains a .torqueinfo.yaml file)
+    attr_reader :root_dir
+
+    ##
+    # True if should silence all output, else false
+    attr_reader :silent
+
+    ##
+    # The Pivotal Tracker api token to use to access the Pivotal project
+    attr_reader :token
+
+    ##
+    # The path to the .torqueinfo.yaml file
+    attr_reader :torque_info_path
+
+    ##
+    # True if should be verbose, else false
+    attr_reader :verbose
+
+    # @param options A hash of the options used to run the program
+    # @param fs An instance of the FileSystem class
+    #
+    # Determines the project settings from the environment
+    def initialize(options={}, fs=FileSystem.new)
+
+      @options = options
+      @fs = fs
+
+      # Handles basic "true/false" options
+
+      @email = @options[:email] || false
+      @silent = @options[:silent] || false
+      @verbose = @options[:verbose] || false
+
+      # Initializes the root directory for Torque
+
+      @root_dir = @options[:root_dir] || "."
+      @root_dir = File.expand_path(@root_dir)
+
+      # Parses and processes data from .torqueinfo.yaml
+
+      @torque_info_path = "#{@root_dir}/.torqueinfo.yaml"
+      torque_info = TorqueInfoParser.new(torque_info_path).parse
+      
+      @email_address = torque_info.email_address
+      @email_password = torque_info.email_password
+      @email_to = torque_info.email_to
+      @output_dir = torque_info.output_dir
+      @project = torque_info.project
+      @token = torque_info.token
+
+      raise MissingTokenError.new(
+        "API token for Pivotal Tracker has not been set"
+        ) if @token.blank?
+      raise MissingProjectError.new(
+        "Project ID for Pivotal Tracker has not been set"
+        ) if @project.blank?
+
+      @output_dir = "release_notes" if @output_dir.blank?
+      @output_dir = "#{@root_dir}/#{@output_dir}"
+
+      if    @email_to.class == NilClass; @email_to = []
+      elsif @email_to.class == String;   @email_to = [@email_to]
+      elsif @email_to.class == Array;    @email_to = @email_to
+      else; raise "Unknown parsing error on .torqueinfo.yaml's 'email_to' field: #{@email_to}"
+      end
+
+      # Sets up the output directory, throwing an error if it cannot be found
+
+      if !@fs.path_exist? @output_dir
+        raise MissingOutputDirectoryError.new(
+          "Could not find the output directory: #{@output_dir}"
+        )
+      elsif !@fs.path_exist? "#{@output_dir}/previous"
+        @fs.mkdir_p("#{@output_dir}/previous")
+      end
+      
+      # The path to the last-run file for this project
+      
+      @last_run_path = "#{output_dir}/previous/.last-run-#{project}"
+
+      # Determines the date range within which to accept stories
+      
+      date_settings = DateSettings.new(@options, @last_run_path, @fs)
+      @accept_from, @accept_to = date_settings.get_dates
+      @custom_date_range = date_settings.custom_date_range?
+
+      # Sets the path to the main "release-notes.txt" file
+      
+      @current_notes_path = "#{output_dir}/release-notes.txt"
+
+      # 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_path = record_pathname_settings.get_path
+
+    end
+
+  end
+end