torque 0.0.1

data/lib/torque/story.rb

@@ -0,0 +1,108 @@
+class Torque
+
+  ##
+  # Stores the data to represent a Pivotal Tracker story
+  class Story
+
+    ##
+    # The current state of the story (finished, accepted, etc)
+    attr_reader :current_state
+
+    ##
+    # The date that the story was accepted, or nil if it has not been accepted yet
+    attr_reader :date_accepted
+
+    ##
+    # The story description
+    attr_reader :description
+
+    ##
+    # The estimate for the story
+    attr_reader :estimate
+
+    ##
+    # The labels for the story
+    attr_reader :labels
+
+    ##
+    # The name of the story
+    attr_reader :name
+
+    ##
+    # The ID of the story's project
+    attr_reader :project_id
+
+    ##
+    # The story's ID
+    attr_reader :story_id
+
+    ##
+    # The story's type (feature, chore, etc)
+    attr_reader :story_type
+
+    ##
+    # @param html_hash A hash (of html elements keyed by their tags) generated from Pivotal Tracker story html
+    #
+    # Returns a new story whose fields were parsed from the html_hash provided
+    def self.create(html_hash)
+      Story.new(html_hash).parse
+    end
+
+    ##
+    # 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)
+      @html_hash = html_hash
+    end
+
+    # If the second input is an empty array, returns the first input
+    # Else returns the index 0 of the second
+    def handle_nil(default, value)
+      (value.nil? ? default : value)
+    end
+    private :handle_nil
+
+    ##
+    # Parses the story's fields from its html hash
+    def parse
+      html_hash = @html_hash
+
+      # Default values
+      @current_state = ""
+      @date_accepted = nil # Will be a date
+      @description = ""
+      @estimate = -1
+      @labels = "" # Will be an array
+      @name = ""
+      @project_id = -1
+      @story_id = -1
+      @story_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"])
+      
+      @estimate = Integer(handle_nil(@estimate, html_hash["estimate"]))      
+      @project_id = Integer(handle_nil(@project_id, html_hash["project_id"]))
+      @story_id = Integer(handle_nil(@story_id, html_hash["id"]))
+
+      @labels = handle_nil(@labels, html_hash["labels"])
+      @labels = @labels.split(",")
+      
+      date_acceptedString = html_hash["accepted_at"]
+      if(date_acceptedString != nil && date_acceptedString != "")
+        @date_accepted = Date.strptime(date_acceptedString, "%Y/%m/%d")
+      end
+
+      # Returns the generated story
+      self
+    end
+
+    def to_s()
+      return "Story("+@name+", "+"#{@story_id}"+")"
+    end
+
+  end
+end

data/lib/torque/torque_info_parser.rb

@@ -0,0 +1,230 @@
+require_relative "file_system"
+require_relative "error/missing_torque_info_file_error"
+require 'yaml'
+
+class Torque
+
+  ##
+  # Parses the raw contents of the torque info file
+  # Stores each of the fields in .torqueinfo.yaml as publicly accessible fields
+  class TorqueInfoParser
+
+    ##
+    # The email_address field (String)
+    attr_reader :email_address
+
+    ##
+    # The email_password field (String)
+    attr_reader :email_password
+
+    ##
+    # The email_to field (String or Array)
+    attr_reader :email_to
+
+    ##
+    # The project field (Fixnum)
+    attr_reader :project
+
+    ##
+    # The output_dir field (String)
+    attr_reader :output_dir
+
+    ##
+    # The token field (String)
+    attr_reader :token
+
+    ##
+    # @param file_path The path to the .torqueinfo.yaml file
+    # @param file_system An instance of the FileSystem class
+    #
+    # Creates a new parser. Does not parse the file
+    def initialize(file_path = "./.torqueinfo.yaml", file_system = FileSystem.new)
+
+      @file_path = file_path
+      @fs = file_system
+    end
+
+    ##
+    # Parses the file, storing the results as public instnance fields
+    # Stores each field with no corresponding value in the file as 'nil'
+    # Returns self
+    def parse
+
+      if !@fs.path_exist?(@file_path)
+        directory = File.expand_path(File.dirname(@file_path))
+        raise MissingTorqueInfoFileError.new "'#{directory}' is not configured for Torque"
+      end
+
+      torque_info_hash = {}
+      begin
+        torque_info_hash = YAML::load(@fs.file_read(@file_path)) || {}
+      rescue Psych::SyntaxError
+        # If cannot parse, ignore contents
+      end
+
+      @email_address = torque_info_hash["email_address"]
+      @email_password = torque_info_hash["email_password"]
+      @email_to = torque_info_hash["email_to"]
+      @project = torque_info_hash["project"]
+      @output_dir = torque_info_hash["output_dir"]
+      @token = torque_info_hash["token"]
+
+      self
+    end
+
+    ##
+    # Sets the specified field to the specified value in the file on disk
+    def set(field, value)
+      file_string = @fs.file_read(@file_path)
+      new_file_string = set_string(field, value, file_string)
+      @fs.file_write(@file_path, new_file_string)
+    end
+
+    ##
+    # Adds a list of values to a sequence belonging to field on disk
+    def add(field, values)
+      file_string = @fs.file_read(@file_path)
+      new_file_string = add_string(field, values, file_string)
+      @fs.file_write(@file_path, new_file_string)
+    end
+
+    ##
+    # Adds a list of values to a sequence belonging to field, eliminating duplicates, on disk
+    # Returns a list of all values that were added (were not duplicates)
+    def add_no_duplicates(field, values)
+      file_string = @fs.file_read(@file_path)
+      values_copy = values.clone
+
+      new_file_string = add_no_duplicates_string(field, values_copy, file_string) 
+      @fs.file_write(@file_path, new_file_string)
+      values_copy
+    end
+
+    ##
+    # Removes a field to a sequence of values on disk
+    # Returns a list of the values that were removed (could be found)
+    def rm(field, values)
+      file_string = @fs.file_read(@file_path)
+      values_copy = values.clone
+      
+      new_file_string = rm_string(field, values_copy, file_string)
+      @fs.file_write(@file_path, new_file_string)
+      values_copy
+    end
+
+
+    private
+
+    # Util method. Changes the first array to the second array in place
+    def set_array_in_place(array1, array2)
+      array1.delete_if {true}
+      array1.concat(array2)
+    end
+
+    # Util method. Converts a yaml field to an applicable array
+    def to_array(value)
+      if    value.is_a? Array;    value
+      elsif value.is_a? String;   [value]
+      elsif value.is_a? NilClass; []
+      else; []
+      end
+    end
+
+    # Alters the string contents of a file, setting the specified field to the specified value
+    def set_string(field, value, file_string)
+
+      file_yaml = YAML.load(file_string) || {}
+      file_yaml[field] = value
+      file_yaml.to_yaml
+
+    end
+
+    # Alters the string contents of a file, adding all elements of 'values' to field 'field'
+    # Returns the new string contents
+    def add_string(field, values, file_string)
+
+      return file_string if values.empty?
+
+      file_yaml = YAML.load(file_string) || {}
+      file_yaml[field] = to_array(file_yaml[field])
+      file_yaml[field].concat(values)
+      file_yaml.to_yaml
+
+    end
+
+    # Alters the string contents of a file, adding all elements of 'values' to field 'field' ignoring duplicates
+    # At finish, 'values' contains all values that were added (were not duplicates)
+    # Returns the new string contents
+    def add_no_duplicates_string(field, values, file_string)
+
+      return file_string if values.empty?
+
+      file_yaml = YAML.load(file_string) || {}
+      file_yaml[field] = to_array(file_yaml[field])
+      file_yaml[field].delete(nil)
+      
+      values.uniq!
+
+      index = 0
+      while index < values.length
+        value = values[index]
+
+        if file_yaml[field].member? value
+          values.delete_at(index)
+          index-=1
+        else
+          file_yaml[field] << value
+        end
+
+        index+=1
+      end
+
+      file_yaml.to_yaml
+
+    end
+
+    # Alters the string contents of a file so that value is added to a sequence belonging to field
+    # At finish, 'values' contains all values that were removed (could be found)
+    # Returns the new string contents
+    def rm_string(field, values, file_string)
+
+      return file_string if values.empty?
+
+      file_yaml = YAML.load(file_string) || {}
+      
+      # The field does not exist
+      if file_yaml[field].is_a? NilClass
+        set_array_in_place(values, [])
+        return file_string
+        
+      # The field is a single value
+      elsif file_yaml[field].is_a? String
+        if values.member? file_yaml[field]
+          set_array_in_place(values, [ file_yaml[field] ])
+          file_yaml.delete(field)
+        else
+          set_array_in_place(values, [])
+        end
+
+      # The field is a sequence
+      else
+        index = 0;
+        while index < values.length
+          value = values[index]
+          if file_yaml[field].member? value
+            file_yaml[field].delete(value)
+          else
+            values.delete_at(index)
+            index -= 1
+          end
+          index += 1
+        end
+
+        file_yaml.delete(field) if file_yaml[field].empty?
+      end
+
+      file_yaml.to_yaml
+    end
+
+  end
+end

data/lib/torque/version.rb

@@ -0,0 +1,24 @@
+class Torque
+  class Version
+    
+    version = {}
+    File.read(File.join(File.dirname(__FILE__), '../', '../', 'VERSION')).each_line do |line|
+      type, value = line.chomp.split(":")
+      next if type =~ /^\s+$/ || value =~ /^\s+$/
+      version[type] = value
+    end
+    
+    MAJOR = version['major']
+    MINOR = version['minor']
+    PATCH = version['patch']
+
+    STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+    
+    ##
+    # The string representing the current version of Torque (eg "1.9.2") 
+    def self.string
+      STRING
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: torque
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nico Adams, Scrimmage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.19
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.19
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Compiles Pivotal Tracker stories into a local document to help generate
+  release notes
+email:
+- nico@wescrimmage.com
+executables:
+- torque
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- bin/config
+- bin/email
+- bin/project
+- bin/torque
+- lib/torque/date_settings.rb
+- lib/torque/error/invalid_project_error.rb
+- lib/torque/error/invalid_token_error.rb
+- lib/torque/error/missing_output_directory_error.rb
+- lib/torque/error/missing_project_error.rb
+- lib/torque/error/missing_token_error.rb
+- lib/torque/error/missing_torque_info_file_error.rb
+- lib/torque/error/pivotal_api_error.rb
+- lib/torque/file_system.rb
+- lib/torque/mailer.rb
+- lib/torque/pivotal.rb
+- lib/torque/pivotal_html_parser.rb
+- lib/torque/project/project.rb
+- lib/torque/project/project_manager.rb
+- lib/torque/record_pathname_settings.rb
+- lib/torque/settings.rb
+- lib/torque/story.rb
+- lib/torque/torque_info_parser.rb
+- lib/torque/version.rb
+- lib/torque.rb
+- Gemfile
+- LICENSE
+- README.md
+- VERSION
+homepage: https://github.com/Scrimmage/torque
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Generates release notes for a project from Pivotal Tracker stories
+test_files: []