trollolo 0.0.3 → 0.0.4

data/spec/data/lists.json

@@ -1,50 +1,50 @@
 [
   {
-    "pos": 16384,
-    "subscribed": false,
+    "id": "53186e8391ef8671265eba9e",
     "name": "Sprint Backlog",
     "closed": false,
-    "id": "53186e8391ef8671265eba9e",
-    "idBoard": "53186e8391ef8671265eba9d"
+    "idBoard": "53186e8391ef8671265eba9d",
+    "pos": 16384,
+    "subscribed": false
   },
   {
-    "pos": 32768,
-    "subscribed": false,
+    "id": "53186e8391ef8671265eba9f",
     "name": "Doing",
     "closed": false,
-    "id": "53186e8391ef8671265eba9f",
-    "idBoard": "53186e8391ef8671265eba9d"
+    "idBoard": "53186e8391ef8671265eba9d",
+    "pos": 32768,
+    "subscribed": false
   },
   {
-    "pos": 36864,
-    "subscribed": false,
+    "id": "5319bf088cdf9cd82be336b0",
     "name": "Done Sprint 10",
     "closed": false,
-    "id": "5319bf088cdf9cd82be336b0",
-    "idBoard": "53186e8391ef8671265eba9d"
+    "idBoard": "53186e8391ef8671265eba9d",
+    "pos": 36864,
+    "subscribed": false
   },
   {
-    "pos": 40960,
-    "subscribed": false,
+    "id": "5319bf045c6ef0092c55331e",
     "name": "Done Sprint 9",
     "closed": false,
-    "id": "5319bf045c6ef0092c55331e",
-    "idBoard": "53186e8391ef8671265eba9d"
+    "idBoard": "53186e8391ef8671265eba9d",
+    "pos": 40960,
+    "subscribed": false
   },
   {
-    "pos": 49152,
-    "subscribed": false,
+    "id": "53186e8391ef8671265ebaa0",
     "name": "Done Sprint 8",
     "closed": false,
-    "id": "53186e8391ef8671265ebaa0",
-    "idBoard": "53186e8391ef8671265eba9d"
+    "idBoard": "53186e8391ef8671265eba9d",
+    "pos": 49152,
+    "subscribed": false
   },
   {
-    "pos": 114688,
-    "subscribed": false,
+    "id": "5319bc0aa338308d42f108d6",
     "name": "Legend",
     "closed": false,
-    "id": "5319bc0aa338308d42f108d6",
-    "idBoard": "53186e8391ef8671265eba9d"
+    "idBoard": "53186e8391ef8671265eba9d",
+    "pos": 114688,
+    "subscribed": false
   }
-]
+]

data/spec/data/trollolorc

@@ -1,2 +1,7 @@
 developer_public_key: mykey
 member_token: mytoken
+not_done_columns:
+  - Blocked
+  - Doing
+  - In review
+  - Sprint Backlog

data/spec/{command_line_spec.rb → integration/command_line_spec.rb}

@@ -1,8 +1,5 @@
-require_relative 'spec_helper'
+require_relative 'integration_spec_helper'
 
-require "aruba/api"
-
-include Aruba::Api
 include GivenFilesystemSpecHelpers
 
 def trollolo_cmd

data/spec/integration/create_burndown_spec.rb

@@ -0,0 +1,57 @@
+require_relative "integration_spec_helper"
+
+include GivenFilesystemSpecHelpers
+
+HELPER_SCRIPT = File.expand_path("../../../scripts/create_burndown.py", __FILE__)
+
+describe "create_burndown.py" do
+  use_given_filesystem(keep_files: true)
+
+  it "creates burndown chart for sprint 23" do
+    @working_dir = given_directory do
+      given_file("burndown-data-23.yaml", from: "create_burndown_helper/burndown-data-23.yaml")
+    end
+
+    cmd = "#{HELPER_SCRIPT} 23 --output=#{@working_dir} --no-head"
+    run(cmd)
+    assert_exit_status(0)
+    expect(File.join(@working_dir, "burndown-23.png")).
+      to be_same_image_as("create_burndown_helper/burndown-23.png")
+  end
+
+  it "creates burndown chart for sprint 31" do
+    @working_dir = given_directory do
+      given_file("burndown-data-31.yaml", from: "create_burndown_helper/burndown-data-31.yaml")
+    end
+
+    cmd = "#{HELPER_SCRIPT} 31 --output=#{@working_dir} --no-head"
+    run(cmd)
+    assert_exit_status(0)
+    expect(File.join(@working_dir, "burndown-31.png")).
+      to be_same_image_as("create_burndown_helper/burndown-31.png")
+  end
+
+  it "creates burndown chart for sprint 35" do
+    @working_dir = given_directory do
+      given_file("burndown-data-35.yaml", from: "create_burndown_helper/burndown-data-35.yaml")
+    end
+
+    cmd = "#{HELPER_SCRIPT} 35 --output=#{@working_dir} --no-head"
+    run(cmd)
+    assert_exit_status(0)
+    expect(File.join(@working_dir, "burndown-35.png")).
+      to be_same_image_as("create_burndown_helper/burndown-35.png")
+  end
+
+  it "creates burndown chart for sprint 8" do
+    @working_dir = given_directory do
+      given_file("burndown-data-08.yaml", from: "create_burndown_helper/burndown-data-08.yaml")
+    end
+
+    cmd = "#{HELPER_SCRIPT} 08 --output=#{@working_dir} --no-tasks --with-fast-lane --no-head"
+    run(cmd)
+    assert_exit_status(0)
+    expect(File.join(@working_dir, "burndown-08.png")).
+      to be_same_image_as("create_burndown_helper/burndown-08.png")
+  end
+end

data/spec/integration/integration_spec_helper.rb

@@ -0,0 +1,10 @@
+require_relative '../../lib/trollolo'
+require 'given_filesystem/spec_helpers'
+
+bin_path = File.expand_path( "../../../bin/", __FILE__ )
+
+if ENV['PATH'] !~ /#{bin_path}/
+  ENV['PATH'] = bin_path + File::PATH_SEPARATOR + ENV['PATH']
+end
+
+Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }

data/spec/integration/support/aruba_hook.rb

@@ -0,0 +1,11 @@
+require 'aruba/api'
+require 'aruba/reporting'
+
+RSpec.configure do |config|
+  config.include Aruba::Api
+
+  config.before(:each) do
+    restore_env
+    clean_current_dir
+  end
+end

data/spec/integration/support/custom_matchers.rb

@@ -0,0 +1,13 @@
+RSpec::Matchers.define :be_same_image_as do |expected|
+  match do |actual|
+    expected_path = File.expand_path('../../../data/' + expected, __FILE__)
+    expected_file = File.binread(expected_path)
+    actual_file = File.binread(actual)
+
+    expected_file == actual_file
+  end
+
+  description do
+    "be the same image as \"#{expected}\""
+  end
+end

data/spec/{wrapper → integration/wrapper}/credentials_input_wrapper

@@ -1,10 +1,10 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
 require "expect"
 require "pty"
 
 config_path = "/tmp/test-trollolorc-#{rand(100000)}"
-bin_path = File.expand_path('../../../bin/trollolo',__FILE__)
+bin_path = File.expand_path('../../../../bin/trollolo',__FILE__)
 
 ENV["TROLLOLO_CONFIG_PATH"] = config_path
 

data/spec/{wrapper → integration/wrapper}/empty_config_trollolo_wrapper

@@ -1,7 +1,7 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
 config_path = "/tmp/test-trollolorc-#{rand(100000)}"
-bin_path = File.expand_path('../../../bin/trollolo',__FILE__)
+bin_path = File.expand_path('../../../../bin/trollolo',__FILE__)
 
 ENV["TROLLOLO_CONFIG_PATH"] = config_path
 

data/spec/integration/wrapper/trollolo_wrapper

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+test_config_path = File.expand_path('../../../data/trollolorc',__FILE__)
+bin_path = File.expand_path('../../../../bin/trollolo',__FILE__)
+
+ENV["TROLLOLO_CONFIG_PATH"] = test_config_path
+
+cmd = "#{bin_path} #{ARGV.join(" ")}"
+
+exec(cmd)

data/spec/unit/backup_spec.rb

@@ -0,0 +1,107 @@
+require_relative "spec_helper"
+
+include GivenFilesystemSpecHelpers
+
+describe Backup do
+  it "sets backup directory" do
+    backup = Backup.new(dummy_settings)
+    expect(backup.directory).to match File.expand_path("~/.trollolo/backup")
+  end
+
+  context "custom backup directory" do
+    use_given_filesystem(keep_files: true)
+
+    before(:each) do
+      full_board_mock
+      @backup = Backup.new(dummy_settings)
+      @directory = given_directory
+      @backup.directory = @directory
+    end
+
+    it "backups board" do
+      @backup.backup("53186e8391ef8671265eba9d")
+      backup_file = File.join(@directory, "53186e8391ef8671265eba9d", "board.json")
+      expect(File.exist?(backup_file)).to be true
+      expect(File.read(backup_file)).to eq load_test_file("full-board.json").chomp
+    end
+
+    it "lists backups" do
+      @backup.backup("53186e8391ef8671265eba9d")
+      expect(@backup.list).to eq ["53186e8391ef8671265eba9d"]
+    end
+
+    it "shows backup" do
+      output_capturer = StringIO.new
+      @backup.backup("53186e8391ef8671265eba9d")
+      @backup.show("53186e8391ef8671265eba9d", output: output_capturer )
+      expect(output_capturer.string).to eq(<<EOT
+Trollolo Testing Board
+  Sprint Backlog
+    Sprint 3
+    (3) P1: Fill Backlog column
+      Tasks
+        Add card to fill Backlog column (incomplete)
+        Add card to read data from Trollolo (incomplete)
+        Add card to save read data as reference data (incomplete)
+        Add card under the waterline (incomplete)
+    (5) P4: Read data from Trollolo
+      Tasks
+        Add option to Trollolo to provide the board id (incomplete)
+        Call command (incomplete)
+    (3) P5: Save read data as reference data
+      Tasks
+        Save test data (incomplete)
+        Make tests work (incomplete)
+    Waterline
+    (8) P6: Celebrate testing board
+      Tasks
+        Party (incomplete)
+  Doing
+    (2) P2: Fill Doing column
+      Tasks
+        Add task to add task to Fill Doing column card (incomplete)
+        Create card to Fill Doing column (complete)
+      Feedback
+        Ask user who requested the feature (complete)
+        Ask product manager (incomplete)
+  Done Sprint 10
+    Burndown chart
+    Sprint 10
+    (3) P3: Fill Done columns
+      Tasks
+        Fill Done Sprint 1 (complete)
+        Fill Done Sprint 2 (complete)
+        Fill Done Sprint 3 (complete)
+  Done Sprint 9
+    Burndown chart
+    Sprint 9
+    (2) P1: Explain purpose
+    (2) P2: Create Scrum columns
+      Tasks
+        Backlog (complete)
+        Doing (complete)
+        Multiple Done Columns (complete)
+  Done Sprint 8
+    Burndown chart
+    Sprint 8
+    (1) P1: Create Trello Testing Board
+      Tasks
+        Create board (complete)
+        Name board (complete)
+    (5) P2: Add fancy background
+      Tasks
+        Find image (complete)
+        Download image (complete)
+        Set image (complete)
+        Add attribution (complete)
+    (1) P4: Add legend
+      Tasks
+        Create Legend column (complete)
+  Legend
+    Purpose
+    Background image
+EOT
+      )
+    end
+  end
+end

data/spec/unit/burndown_chart_spec.rb

@@ -0,0 +1,396 @@
+require_relative 'spec_helper'
+
+include GivenFilesystemSpecHelpers
+
+describe BurndownChart do
+
+  before(:each) do
+    @settings = dummy_settings
+    @burndown_data = BurndownData.new(@settings)
+    @chart = BurndownChart.new(@settings)
+    full_board_mock
+  end
+
+  describe "initializer" do
+    it "sets initial meta data" do
+      expect(@chart.data["meta"]["sprint"]).to eq 1
+      expect(@chart.data["meta"]["total_days"]).to eq 10
+      expect(@chart.data["meta"]["weekend_lines"]).to eq [3.5, 8.5]
+    end
+  end
+
+  describe "data" do
+    use_given_filesystem
+
+    before(:each) do
+      @raw_data = [
+        {
+          "date" => '2014-04-23',
+          "updated_at" => '2014-04-23T10:00:00+01:00',
+          "story_points" =>
+          {
+            "total" => 30,
+            "open" => 23
+          },
+          "tasks" =>
+          {
+            "total" => 25,
+            "open" => 21
+          }
+        },
+        {
+          "date" => '2014-04-24',
+          "updated_at" => '2014-04-24T19:00:00+01:00',
+          "story_points" =>
+          {
+            "total" => 30,
+            "open" => 21
+          },
+          "tasks" =>
+          {
+            "total" => 26,
+            "open" => 19
+          },
+          "story_points_extra" =>
+          {
+            "done" => 3
+          },
+          "tasks_extra" =>
+          {
+            "done" => 2
+          }
+        }
+      ]
+    end
+
+    it "creates first data entry" do
+      @burndown_data.story_points.open = 16
+      @burndown_data.story_points.done = 7
+      @burndown_data.tasks.open = 10
+      @burndown_data.tasks.done = 11
+      @burndown_data.date_time = DateTime.parse("2014-05-30")
+
+      @chart.add_data(@burndown_data)
+
+      expect( @chart.data["days"].first["story_points"] ).to eq(
+        {
+          "total" => 23,
+          "open" => 16
+        } )
+      expect( @chart.data["days"].first["tasks"] ).to eq(
+        {
+          "total" => 21,
+          "open" => 10
+        } )
+    end
+
+    it "returns sprint number" do
+      expect(@chart.sprint).to eq 1
+    end
+
+    it "adds data" do
+      @chart.data["days"] = @raw_data
+
+      @burndown_data.story_points.open = 16
+      @burndown_data.story_points.done = 7
+      @burndown_data.tasks.open = 10
+      @burndown_data.tasks.done = 11
+      @burndown_data.extra_story_points.open = 2
+      @burndown_data.extra_story_points.done = 3
+      @burndown_data.extra_tasks.open = 5
+      @burndown_data.extra_tasks.done = 2
+      @burndown_data.date_time = DateTime.parse("2014-05-30")
+
+      @chart.add_data(@burndown_data)
+
+      expect( @chart.data["days"].count ).to eq 3
+      expect( @chart.data["days"].last["date"] ).to eq ( "2014-05-30" )
+      expect( @chart.data["days"].last["story_points"] ).to eq ( {
+        "total" => 23,
+        "open" => 16
+      } )
+      expect( @chart.data["days"].last["tasks"] ).to eq ( {
+        "total" => 21,
+        "open" => 10
+      } )
+      expect( @chart.data["days"].last["story_points_extra"] ).to eq ( {
+        "done" => 3
+      } )
+      expect( @chart.data["days"].last["tasks_extra"] ).to eq ( {
+        "done" => 2
+      } )
+    end
+
+    it "replaces data of same day" do
+      @chart.data["days"] = @raw_data
+
+      @burndown_data.story_points.open = 16
+      @burndown_data.story_points.done = 7
+      @burndown_data.tasks.open = 10
+      @burndown_data.tasks.done = 11
+      @burndown_data.date_time = DateTime.parse("2014-05-30")
+
+      @chart.add_data(@burndown_data)
+
+      expect( @chart.data["days"].count ).to eq 3
+      expect( @chart.data["days"].last["story_points"] ).to eq ( {
+        "total" => 23,
+        "open" => 16
+      } )
+
+      @burndown_data.story_points.done = 8
+      @chart.add_data(@burndown_data)
+
+      expect( @chart.data["days"].count ).to eq 3
+      expect( @chart.data["days"].last["story_points"] ).to eq ( {
+        "total" => 24,
+        "open" => 16
+      } )
+    end
+
+    describe "#read_data" do
+      it "reads data" do
+        @chart.read_data given_file('burndown-data.yaml')
+
+        expect(@chart.data["days"]).to eq @raw_data
+      end
+
+      it "reads not done columns" do
+        @chart.read_data given_file('burndown-data.yaml', from: 'burndown-data-with-config.yaml')
+        expect(@settings.not_done_columns).to eq ["Sprint Backlog", "Doing", "QA"]
+      end
+    end
+
+    describe "#write_data" do
+      it "writes object to disk" do
+        @chart.sprint = 2
+        @chart.data["meta"]["total_days"] = 9
+        @chart.data["meta"]["weekend_lines"] = [3.5, 7.5]
+        @chart.data["meta"]["board_id"] = "myboardid"
+        @chart.data["days"] = @raw_data
+
+        write_path = given_dummy_file
+        @chart.write_data(write_path)
+        expect(File.read(write_path)). to eq load_test_file('burndown-data.yaml')
+      end
+
+      it "writes all data which was read" do
+        read_path = given_file('burndown-data.yaml')
+        @chart.read_data(read_path)
+
+        write_path = given_dummy_file
+        @chart.write_data(write_path)
+
+        expect(File.read(write_path)).to eq File.read(read_path)
+      end
+
+      it "doesn't write extra entries with 0 values" do
+        raw_data = [
+          {
+            "date" => '2014-04-24',
+            "story_points" =>
+            {
+              "total" => 30,
+              "open" => 21
+            },
+            "tasks" =>
+            {
+              "total" => 26,
+              "open" => 19
+            },
+            "story_points_extra" =>
+            {
+              "done" => 0
+            },
+            "tasks_extra" =>
+            {
+              "done" => 0
+            }
+          }
+        ]
+        @chart.data["days"] = raw_data
+        @chart.data["meta"]["board_id"] = "1234"
+
+        write_path = given_dummy_file
+        @chart.write_data(write_path)
+
+        expected_file_content = <<EOT
+---
+meta:
+  board_id: '1234'
+  sprint: 1
+  total_days: 10
+  weekend_lines:
+  - 3.5
+  - 8.5
+days:
+- date: '2014-04-24'
+  story_points:
+    total: 30
+    open: 21
+  tasks:
+    total: 26
+    open: 19
+EOT
+        expect(File.read(write_path)).to eq expected_file_content
+      end
+    end
+
+  end
+
+  describe "commands" do
+    use_given_filesystem(keep_files: true)
+
+    describe "setup" do
+      it "initializes new chart" do
+        path = given_directory
+        @chart.setup(path,"53186e8391ef8671265eba9d")
+
+        expect(File.exist?(File.join(path,"burndown-data-01.yaml"))).to be true
+
+        chart = BurndownChart.new(@settings)
+        chart.read_data(File.join(path,"burndown-data-01.yaml"))
+
+        expect(chart.board_id).to eq "53186e8391ef8671265eba9d"
+      end
+    end
+
+    describe "last_sprint" do
+      it "gets the last sprint based on the burndown files" do
+        path = given_directory_from_data("burndown_dir")
+        expect(@chart.last_sprint(path)).to eq(2)
+      end
+    end
+
+    describe "load_last_sprint" do
+      let(:path) { given_directory_from_data("burndown_dir") }
+      it "loads the burndown form the 2nd sprint into data" do
+        @chart.load_last_sprint(path)
+        expect(@chart.data).to eq({"meta"=>
+                                   {"board_id"=>"53186e8391ef8671265eba9d",
+                                    "sprint"=>2,
+                                    "total_days"=>9,
+                                    "weekend_lines"=>[3.5, 7.5]},
+                                   "days"=>[]})
+      end
+
+      it "returns the path of the last sprint" do
+        expect(@chart.load_last_sprint(path)).to eq(File.join(path,"burndown-data-02.yaml"))
+      end
+    end
+
+    describe "update" do
+      let(:path) { given_directory_from_data("burndown_dir") }
+      let(:options) { {'output' => path} }
+      let(:before) { BurndownChart.new(@settings) }
+      let(:after) { BurndownChart.new(@settings) }
+
+      it "updates chart with latest data" do
+        updated_at = "2015-01-12T13:57:16+01:00"
+        expected_date_time = DateTime.parse(updated_at)
+        allow(DateTime).to receive(:now).and_return(expected_date_time)
+
+        before.read_data(File.join(path,'burndown-data-02.yaml'))
+        @chart.update(options)
+        after.read_data(File.join(path,'burndown-data-02.yaml'))
+        expect(after.days.size).to eq before.days.size + 1
+
+        expect(after.days.last["date"]).to eq "2015-01-12"
+        expect(after.days.last["updated_at"]).to eq updated_at
+      end
+
+      it "overwrites data on same date" do
+        before.read_data(File.join(path,'burndown-data-02.yaml'))
+        @chart.update(options)
+        @chart.update(options)
+        after.read_data(File.join(path,'burndown-data-02.yaml'))
+        expect(after.days.size).to eq before.days.size + 1
+      end
+    end
+
+    describe "create_next_sprint" do
+      it "create new sprint file" do
+        path = given_directory_from_data("burndown_dir")
+        chart = BurndownChart.new(@settings)
+        chart.create_next_sprint(path)
+
+        next_sprint_file = File.join(path, "burndown-data-03.yaml")
+        expect(File.exist?(next_sprint_file)).to be true
+
+        expected_file_content = <<EOT
+---
+meta:
+  board_id: 53186e8391ef8671265eba9d
+  sprint: 3
+  total_days: 9
+  weekend_lines:
+  - 3.5
+  - 7.5
+days: []
+EOT
+        expect(File.read(next_sprint_file)).to eq expected_file_content
+      end
+    end
+  end
+
+  describe "reads meta data from the board" do
+
+    use_given_filesystem
+
+    it "merges meta data from board if present" do
+      chart = BurndownChart.new(@settings)
+      chart.read_data(given_file("burndown-data-10.yaml"))
+
+      expect(chart.data["meta"]["weekend_lines"]).to eq([3.5, 8.5])
+
+      burndown = BurndownData.new(@settings)
+      burndown.board_id = "53186e8391ef8671265eba9d"
+      burndown.fetch
+
+      chart.merge_meta_data_from_board(burndown)
+
+      expect(chart.data["meta"]["weekend_lines"]).to eq([1.5, 6.5, 11.5, 16.5])
+    end
+  end
+
+  describe '.plot' do
+
+    it 'sends joined parsed options to python script' do
+      allow(described_class).to receive(:process_options).and_return(%w{ --test 1 --no-blah })
+      allow(described_class).to receive(:plot_helper).and_return('mescript')
+      expect(described_class).to receive(:system).with('python mescript 42 --test 1 --no-blah')
+      described_class.plot(42, {foo: 1, bar: 2})
+    end
+
+  end
+
+  describe '.plot_helper' do
+
+    it 'expands path to burndown generator' do
+      expect(described_class.plot_helper).to include('scripts/create_burndown.py')
+    end
+
+  end
+
+  describe '.process_options' do
+
+    it 'builds an array of switches for burndown chart based on input hash' do
+      test_hash = { 'no-tasks' => true }
+      expect(described_class.send(:process_options, test_hash)).to eq %w{ --no-tasks }
+      test_hash = { 'with-fast-lane' => true }
+      expect(described_class.send(:process_options, test_hash)).to eq %w{ --with-fast-lane }
+      test_hash = { 'output' => 'fanagoro' }
+      expect(described_class.send(:process_options, test_hash)).to eq [ '--output fanagoro' ]
+      test_hash = {}
+      expect(described_class.send(:process_options, test_hash)).to eq [ ]
+      test_hash = {
+        'no-tasks'       => true,
+        'with-fast-lane' => true,
+        'output'         => 'fanagoro',
+        'verbose'        => true
+      }
+      expect(described_class.send(:process_options, test_hash)).to eq ['--no-tasks', '--with-fast-lane', '--output fanagoro', '--verbose']
+    end
+
+  end
+end