trajectory 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f0df4ea6f99eb9dace7117580eb27e3b683641d
-  data.tar.gz: 0ce7b25d9dd4aef130c0d193313c3f0e63258565
+  metadata.gz: d010f9c28f42b607cbc7d7ffd045438cad5077b1
+  data.tar.gz: 388c7eb91ab985f2f9d74da3ef6af81d29ecabda
 SHA512:
-  metadata.gz: 7e838a4f8139b58a9efc800cb0ffa8b83541de05424b7bb47a8a36c71cc142225fa484e582def9d4155035eca5c92f33ad6f9c70ab0a8e3a16ec1c90e0155a61
-  data.tar.gz: 266263a8df3e23fc6ba720ab597539a09eae9a4a207fea0c64bd64b9d8b5b0df4bbc7566c5c89face5291ca6b961f6c046494363099a278f9c5e749ca08c49c7
+  metadata.gz: 9d704ed03e2ef065234de2ba7b63db0b3f4554d387f5b51fa8a98784418cab1bbb33a93d40363a345e3b6bc08685395153a596eabc4394de43b10b80cccaaf29
+  data.tar.gz: 8bc370caa554f3e9d7fd46bec8ca0da5f5348ffcdfdef8da3f6ba1ad66726595d0b127f350bbfa1848ec72e1dafe84691c09ac0d97b897f140cadc15ad50e590

data/README.md

@@ -1,20 +1,24 @@
-# Trajectory Ruby Wrapper
+# Trajectory API Ruby Wrapper
 
 [![Build Status](https://travis-ci.org/lminaudier/trajectory.png?branch=master)](https://travis-ci.org/lminaudier/trajectory)
 [![Code Climate](https://codeclimate.com/github/lminaudier/trajectory.png)](https://codeclimate.com/github/lminaudier/trajectory)
+[![Dependency Status](https://gemnasium.com/lminaudier/trajectory.png)](https://gemnasium.com/lminaudier/trajectory)
 
-This gem is a wrapper to the Thoughbot's Trajectory app ([apptrajectory.com](http://apptrajectory.com)).
+This gem is a wrapper to the Thoughbot's Trajectory app API ([apptrajectory.com](http://apptrajectory.com)).
 
-This is **work in progress** but you'll have read access to
-- projects
-- stories
-- iterations
-- ideas
-- updates
+This is **work in progress** but at the moment, you'll have read access to
+- [Project](http://rdoc.info/gems/trajectory/Trajectory/Project)
+- [Story](http://rdoc.info/gems/trajectory/Trajectory/Story)
+- [Iteration](http://rdoc.info/gems/trajectory/Trajectory/Iteration)
+- [Idea](http://rdoc.info/gems/trajectory/Trajectory/Idea)
+- [Update](http://rdoc.info/gems/trajectory/Trajectory/Update)
 
-Comments, Uploads wrappers are missing.
+The wrapper propose some handy methods on collections of [projects](http://rdoc.info/gems/trajectory/Trajectory/Projects), [stories](http://rdoc.info/gems/trajectory/Trajectory/Stories), [iterations](http://rdoc.info/gems/trajectory/Trajectory/Iterations) and [ideas](http://rdoc.info/gems/trajectory/Trajectory/Ideas).
 
-No write wrapper is provided at the moment.
+Comments and Uploads wrappers are not yet implemented.
+Wrapper for write access is not provided at the moment.
+
+If you have questions, you can submit an issue or ping me on twitter [@lminaudier](https://twitter.com/lminaudier).
 
 ## Installation
 
@@ -37,8 +41,7 @@ Or install it yourself as:
 #### Authentication
 
 By default, the wrapper will look for the Trajectory API key in
-`TRAJECTORY_API_KEY` environment variable. You can also pass it directly to the
-constructor.
+`TRAJECTORY_API_KEY` environment variable and for the account keyword in `TRAJECTORY_ACCOUNT_KEYWORD`.
 
 	require 'trajectory'
 
@@ -47,7 +50,7 @@ constructor.
 
 #### API
 
-See [RDoc](http://rdoc.info/github/lminaudier/trajectory/master/frames) for api details
+See [RDoc](http://rdoc.info/gems/trajectory/frames) for api details
 
 ## Contributing
 

data/lib/trajectory/data_access/data_store.rb

@@ -66,5 +66,14 @@ module Trajectory
     def iterations_for_project(project)
       Iterations.from_json project, Api.iterations_for_project(project)
     end
+
+    # Fetches a iteration of a given project by id
+    #
+    # @param project [Project] the project
+    # @param iteration_id [Integer] the iteration id
+    # @return [Iteration, false] the found iteration or false
+    def find_iteration_of_project_with_id(project, iteration_id)
+      project.find_iteration_by_id(iteration_id)
+    end
   end
 end

data/lib/trajectory/domain/iterations.rb

@@ -22,6 +22,15 @@ module Trajectory
       end)
     end
 
+    # Fetch the iteration with the given id in the collection. If it is not found,
+    # it returns false
+    #
+    # @param id [Integer] the project id
+    # @return [Iteration, false] the found iteration or false
+    def find_by_id(id)
+      iterations.find { |iteration| iteration.id == id } || false
+    end
+
     # Returns the current iteration of the project or false it no current iteration can be found
     #
     # @return [Iteration, false] the current iteration or false

data/lib/trajectory/domain/project.rb

@@ -4,7 +4,8 @@ module Trajectory
 
     NUMBER_OF_WORKING_DAYS_BY_WEEK = 5.0
 
-    attr_writer :stories, :users_collection
+    # @private
+    attr_writer :stories, :users_collection, :iterations_collection
 
     # @return [Integer] the unique identifier of the project.
     # @raise [MissingAttributeError] if id is nil
@@ -50,7 +51,7 @@ module Trajectory
     #
     # @return [Iterations] the iterations collection
     def iterations
-      @iterations ||= DataStore.iterations_for_project(self)
+      @iterations_collection ||= DataStore.iterations_for_project(self)
     end
 
     # Fetch all ideas that belongs to the project
@@ -82,6 +83,13 @@ module Trajectory
       users.find_by_id(id)
     end
 
+    # Fetch a iteration from the project given its id or false if it does not exist
+    #
+    # @return [Iteration, false] the iteration or false
+    def find_iteration_by_id(id)
+      iterations.find_by_id(id)
+    end
+
     # Fetch the stories in a given iteration of a project
     #
     # @param iteration [Iteration] the iteration
@@ -106,6 +114,13 @@ module Trajectory
       Date.today + remaining_days
     end
 
+    # Returns the number of needed iterations to complete the project
+    #
+    # @return [Integer] the number of iterations
+    def remaining_iterations
+      (remaining_points.to_f / estimated_velocity.to_f).ceil
+    end
+
     # Returns the estimated number of days (weekend included) remaining before the end of the project.
     #
     # This is usefull to estimate the project end date.
@@ -164,5 +179,29 @@ module Trajectory
     def accepted_points
       total_points - remaining_points
     end
+
+    # Returns the last non null velocity of the project or raise an error if the
+    # project never started
+    #
+    # @return [Integer] a non null velocity
+    # @raise [VelocityAlwaysEqualToZero] when historic velocity was always zero
+    # (i.e the project has not yet started)
+    def last_non_null_velocity
+      raise VelocityAlwaysEqualToZero if !has_started?
+      historic_velocity.reverse.find do |velocity|
+        velocity != 0
+      end
+    end
+
+    # Returns true if the project has already started some development (i.e
+    # stories have been accepted and a velocity has been evaluated). It returns
+    # false otherwise
+    #
+    # @return [true, false]
+    def has_started?
+      historic_velocity.any? do |velocity|
+        velocity != 0
+      end
+    end
   end
 end

data/lib/trajectory/domain/story.rb

@@ -111,8 +111,12 @@ module Trajectory
       iteration_id == iteration.id
     end
 
-    # @todo Not Yet Implemented
+    # Returns the iteration the story belongs to or false if iteration can't be
+    # found
+    #
+    # @return [Iteration, false] the iteration or false
     def iteration
+      @iteration ||= DataStore.find_iteration_of_project_by_id(project, iteration_id)
     end
   end
 end

data/lib/trajectory/exceptions.rb

@@ -1,3 +1,4 @@
 require 'trajectory/exceptions/missing_attribute_error'
 require 'trajectory/exceptions/velocity_equal_to_zero_error'
+require 'trajectory/exceptions/velocity_always_equal_to_zero_error'
 require 'trajectory/exceptions/bad_environment_error'

data/lib/trajectory/exceptions/velocity_always_equal_to_zero_error.rb

@@ -0,0 +1,4 @@
+module Trajectory
+  class VelocityAlwaysEqualToZero < RuntimeError
+  end
+end

data/lib/trajectory/version.rb

@@ -1,3 +1,3 @@
 module Trajectory
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/unit/data_access/data_store_spec.rb

@@ -82,5 +82,12 @@ module Trajectory
 
       DataStore.find_user_of_project_with_id(project, id)
     end
+
+    it 'delegates fetching of user of a project to the project' do
+      id = 12
+      project.should_receive(:find_iteration_by_id).with(id)
+
+      DataStore.find_iteration_of_project_with_id(project, id)
+    end
   end
 end

data/spec/unit/domain/iterations_spec.rb

@@ -19,6 +19,24 @@ module Trajectory
       iterations[1].project_id.should == 4567
     end
 
+    it 'can find an iteration by id' do
+      iteration = double(:iteration, id: 1234)
+      iterations = Iterations.new(double(:iteration, id: 1),
+                 double(:iteration, id: 2),
+                 iteration,
+                 double(:iteration, id: 3))
+
+      iterations.find_by_id(1234).should == iteration
+    end
+
+    it "returns false when it can't find a project by id" do
+      iterations = Iterations.new(double(:iteration, id: 1),
+                              double(:iteration, id: 2),
+                              double(:iteration, id: 3))
+
+      iterations.find_by_id(1234).should == false
+    end
+
     it 'can retrieve current iteration' do
       current_iteration = double(:current? => true)
       iterations = Iterations.new(double(:current? => false),

data/spec/unit/domain/project_spec.rb

@@ -36,6 +36,15 @@ module Trajectory
       Project.new.total_points.should == 20
     end
 
+    it 'can evaluate remaining iterations until project completion based on the last non nul velocity' do
+      stories = Stories.new(double(:story, :points => 2, :completed? => false),
+                            double(:story, :points => 10, :completed? => false),
+                            double(:story, :points => 8, :completed? => true))
+      DataStore.stub(:stories_for_project).and_return(stories)
+
+      Project.new(:estimated_velocity => 2).remaining_iterations.should == 6
+    end
+
     it 'can evaluate remaining points' do
       stories = Stories.new(double(:story, :points => 2, :completed? => false),
                             double(:story, :points => 10, :completed? => false),
@@ -108,6 +117,27 @@ module Trajectory
       Project.new.accepted_points.should == 19
     end
 
+    it 'can retrieve the last non null velocity in its history' do
+      Project.new(:historic_velocity => [20, 0, 2, 3, 0, 0, 0]).last_non_null_velocity.should == 3
+      Project.new(:historic_velocity => [0, 0, 20, 0, 2, 3, 0, 0, 0]).last_non_null_velocity.should == 3
+      Project.new(:historic_velocity => [0, 0, 20, 0, 2, 3]).last_non_null_velocity.should == 3
+    end
+
+    it 'raises an error when trying to get last non null velocity of a project that not have yet started' do
+      project = Project.new
+      project.stub(:has_started?).and_return(false)
+
+      expect do
+        project.last_non_null_velocity
+      end.to raise_error(VelocityAlwaysEqualToZero)
+    end
+
+    it 'can tell if a project has started based on historic velocity' do
+      Project.new(:historic_velocity => [0, 0, 20, 0, 2, 3]).should have_started
+      Project.new(:historic_velocity => [0, 0, 0, 0]).should_not have_started
+      Project.new(:historic_velocity => []).should_not have_started
+    end
+
     it 'delegates fetching of iterations of a project to the data store' do
       DataStore.should_receive(:iterations_for_project).with(project)
 
@@ -146,6 +176,15 @@ module Trajectory
       project.find_user_by_id(1234)
     end
 
+    it 'can get one of its iteration by id' do
+      iterations = double
+
+      project.iterations_collection = iterations
+      iterations.should_receive(:find_by_id).with(1234)
+
+      project.find_iteration_by_id(1234)
+    end
+
     context 'when estimated velocity is zero' do
       it 'cannot estimate remaining days until the project end' do
         expect do

data/spec/unit/domain/story_spec.rb

@@ -33,6 +33,16 @@ module Trajectory
       Story.new.project
     end
 
+    it 'delegates iteration fetching to data store' do
+      project = 1234
+      story = Story.new(:iteration_id => 1234)
+      story.stub(:project).and_return(project)
+
+      DataStore.should_receive(:find_iteration_of_project_by_id).with(project, 1234)
+
+      story.iteration
+    end
+
     it 'knows when it is started' do
       Story.new(state: :started).should be_started
       Story.new(state: :unstarted).should_not be_started

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trajectory
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Loïc Minaudier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-16 00:00:00.000000000 Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -77,6 +77,7 @@ files:
 - lib/trajectory/exceptions.rb
 - lib/trajectory/exceptions/bad_environment_error.rb
 - lib/trajectory/exceptions/missing_attribute_error.rb
+- lib/trajectory/exceptions/velocity_always_equal_to_zero_error.rb
 - lib/trajectory/exceptions/velocity_equal_to_zero_error.rb
 - lib/trajectory/version.rb
 - spec/fabricators/iteration_fabricator.rb