trollolo 0.1.1 → 0.2.0

data/lib/card.rb

@@ -20,13 +20,14 @@ class Card
   ESTIMATED_REGEX     = /\(([\d.]+)\)/
   SPRINT_NUMBER_REGEX = /\ASprint (\d+)/
 
-  def initialize(board_data, card_id)
-    init_data(board_data, card_id)
+  def initialize(board_data, card_id, settings = nil)
+    init_data(board_data, card_id, settings)
   end
 
-  def init_data(board_data, card_id)
+  def init_data(board_data, card_id, settings = nil)
     @board_data = board_data
-    @card_data = @board_data["cards"].find{|c| c["id"] == card_id}
+    @settings = settings
+    @card_data = @board_data['cards'].find{|c| c['id'] == card_id}
   end
 
   def as_json
@@ -43,52 +44,42 @@ class Card
   end
 
   def done_tasks
-    count = 0
-    @card_data["checklists"].each do |checklist|
-      if checklist["name"] != "Feedback"
-        checklist["checkItems"].each do |checklist_item|
-          if checklist_item["state"] == "complete"
-            count += 1
-          end
-        end
-      end
-    end
-    count
+    filtered_checklists.map(&:done_tasks).sum
   end
 
   def tasks
-    count = 0
-    @card_data["checklists"].each do |checklist|
-      if checklist["name"] != "Feedback"
-        count += checklist["checkItems"].count
-      end
-    end
-    count
+    filtered_checklists.map(&:tasks).sum
   end
 
   def card_labels
-    @card_data["labels"]
+    @card_data['labels']
   end
 
   def checklists
-    @card_data["checklists"].map do |checklist|
+    @card_data['checklists'].map do |checklist|
       Checklist.new(checklist)
     end
   end
 
+  def filtered_checklists
+    checklists.reject do |checklist|
+      @settings && @settings.no_task_checklists.include?(checklist.name)
+    end
+  end
+
   def desc
-    @card_data["desc"]
+    @card_data['desc']
   end
 
   def extra?
-    self.card_labels.any? do |label|
+    card_labels.any? do |label|
       label['name'].include?('BelowWaterline') ||
           label['name'].include?('Under waterline')
     end
   end
 
   def unplanned?
-    self.card_labels.any? do |label|
+    card_labels.any? do |label|
       label['name'].include?('Unplanned')
     end
   end
@@ -104,13 +95,13 @@ class Card
 
   def fast_lane?
     # TODO: move to settings
-    self.card_labels.map{|l| l['name']}.include?('FastLane')
+    card_labels.map{|l| l['name']}.include?('FastLane')
   end
 
   # TODO: rethink storage for meta data for sprint
   def self.parse_yaml_from_description(description)
     description =~ /```(yaml)?\n(.*)```/m
-    yaml = $2
+    yaml = Regexp.last_match(2)
     if yaml
       return YAML.load(yaml) # throws an exception for invalid yaml
     else
@@ -119,14 +110,14 @@ class Card
   end
 
   def name
-    @card_data["name"]
+    @card_data['name']
   end
 
   def name=(str)
-    @card_data["name"] = str
+    @card_data['name'] = str
   end
 
   def id
-    @card_data["id"]
+    @card_data['id']
   end
 end

data/lib/checklist.rb

@@ -4,6 +4,18 @@ class Checklist
   end
 
   def name
-    @checklist_data["name"]
+    @checklist_data['name']
+  end
+
+  def checklist_items
+    @checklist_data['checkItems']
+  end
+
+  def done_tasks
+    checklist_items.count { |list_item| list_item['state'] == 'complete' }
+  end
+
+  def tasks
+    checklist_items.count
   end
 end

data/lib/cli.rb

@@ -19,16 +19,16 @@ class Cli < Thor
 
   default_task :global
 
-  class_option :version, :type => :boolean, :desc => "Show version"
-  class_option :verbose, :type => :boolean, :desc => "Verbose mode"
-  class_option :raw, :type => :boolean, :desc => "Raw mode"
-  class_option "board-id", :type => :string, :desc => "id of Trello board"
+  class_option :version, type: :boolean, desc: 'Show version'
+  class_option :verbose, type: :boolean, desc: 'Verbose mode'
+  class_option :raw, type: :boolean, desc: 'Raw mode'
+  class_option 'board-id', type: :string, desc: 'id of Trello board'
 
-  def self.settings= s
+  def self.settings=(s)
     @@settings = s
   end
 
-  desc "global", "Global options", :hide => true
+  desc 'global', 'Global options', hide: true
   def global
     if options[:version]
       puts "Trollolo: #{@@settings.version}"
@@ -37,7 +37,7 @@ class Cli < Thor
     end
   end
 
-  desc "get-raw [URL-FRAGMENT]", "Get raw JSON from Trello API"
+  desc 'get-raw [URL-FRAGMENT]', 'Get raw JSON from Trello API'
   long_desc <<EOT
 Get raw JSON from Trello using the given URL fragment. Trollolo adds the server
 part and API version as well as the credentials from the Trollolo configuration.
@@ -57,9 +57,9 @@ EOT
 
     url = "https://api.trello.com/1/#{url_fragment}"
     if url_fragment =~ /\?/
-      url += "&"
+      url += '&'
     else
-      url += "?"
+      url += '?'
     end
     url += "key=#{@@settings.developer_public_key}&token=#{@@settings.member_token}"
     STDERR.puts "Calling #{url}"
@@ -68,14 +68,14 @@ EOT
     print JSON.pretty_generate(JSON.parse(response.body))
   end
 
-  desc "get-lists", "Get lists"
-  option "board-id", :desc => "Id of Trello board", :required => true
+  desc 'get-lists', 'Get lists'
+  option 'board-id', desc: 'Id of Trello board', required: true
   def get_lists
     process_global_options options
     require_trello_credentials
 
     trello = TrelloWrapper.new(@@settings)
-    board = trello.board(board_id(options["board-id"]))
+    board = trello.board(board_id(options['board-id']))
     lists = board.columns
 
     if @@settings.raw
@@ -87,14 +87,14 @@ EOT
     end
   end
 
-  desc "get-cards", "Get cards"
-  option "board-id", :desc => "Id of Trello board", :required => true
+  desc 'get-cards', 'Get cards'
+  option 'board-id', desc: 'Id of Trello board', required: true
   def get_cards
     process_global_options options
     require_trello_credentials
 
     trello = TrelloWrapper.new(@@settings)
-    board = trello.board(board_id(options["board-id"]))
+    board = trello.board(board_id(options['board-id']))
     cards = board.cards
 
     if @@settings.raw
@@ -102,9 +102,9 @@ EOT
       cards.each do |card|
         cards_as_json.push(card.as_json)
       end
-      puts "["
-      puts cards_as_json.join(",")
-      puts "]"
+      puts '['
+      puts cards_as_json.join(',')
+      puts ']'
     else
       cards.each do |card|
         puts card.name
@@ -112,14 +112,14 @@ EOT
     end
   end
 
-  desc "get-checklists", "Get checklists"
-  option "board-id", :desc => "Id of Trello board", :required => true
+  desc 'get-checklists', 'Get checklists'
+  option 'board-id', desc: 'Id of Trello board', required: true
   def get_checklists
     process_global_options options
     require_trello_credentials
 
     trello = TrelloWrapper.new(@@settings)
-    board = trello.board(board_id(options["board-id"]))
+    board = trello.board(board_id(options['board-id']))
     board.cards.each do |card|
       card.checklists.each do |checklist|
         puts checklist.name
@@ -127,17 +127,15 @@ EOT
     end
   end
 
-  desc "burndowns", "run multiple burndowns"
-  option "board-list", :desc => "path to board-list.yaml", :required => true
-  option :plot, :type => :boolean, :desc => "also plot the new data"
-  option :output, :aliases => :o, :desc => "Output directory"
+  desc 'burndowns', 'run multiple burndowns'
+  option 'board-list', desc: 'path to board-list.yaml', required: true
+  option :plot, type: :boolean, desc: 'also plot the new data'
+  option :output, aliases: :o, desc: 'Output directory'
   def burndowns
     process_global_options options
-    board_list = YAML.load_file(options["board-list"])
+    board_list = YAML.load_file(options['board-list'])
     board_list.keys.each do |name|
-      if name =~ /[^[:alnum:]. _]/ # sanitize
-        raise "invalid character in team name"
-      end
+      raise 'invalid character in team name' if name =~ /[^[:alnum:]. _]/ # sanitize
       board = board_list[name]
       if options['output']
         destdir = File.join(options['output'], name)
@@ -145,36 +143,35 @@ EOT
         destdir = name
       end
       chart = BurndownChart.new @@settings
-      if !File.directory?(destdir)
-        chart.setup(destdir, board["boardid"])
-      end
-      chart.update({'output' => destdir, plot: options[:plot]})
+      chart.setup(destdir, board['boardid']) unless File.directory?(destdir)
+      chart.update('output' => destdir, plot: options[:plot])
     end
   end
 
-  desc "burndown-init", "Initialize burndown chart"
-  option :output, :aliases => :o, :desc => "Output directory", :required => true
-  option "board-id", :desc => "Id of Trello board", :required => true
-  def burndown_init command = nil
+  desc 'burndown-init', 'Initialize burndown chart'
+  option :output, aliases: :o, desc: 'Output directory', required: false
+  option 'board-id', desc: 'Id of Trello board', required: true
+  def burndown_init(command = nil)
     process_global_options options
     require_trello_credentials
 
     chart = BurndownChart.new @@settings
-    puts "Preparing directory..."
-    chart.setup(options[:output], board_id(options["board-id"]))
+    puts 'Preparing directory...'
+    chart.setup(options[:output] || Dir.pwd, board_id(options['board-id']))
   end
 
-  desc "burndown", "Update burndown chart"
-  option :output, :aliases => :o, :desc => "Output directory", :required => false
-  option :new_sprint, :aliases => :n, :desc => "Create new sprint"
-  option :sprint_number, type: :numeric, :desc => "Provide the number of the sprint"
-  option :total_days, type: :numeric, desc: "Provide how many days the sprint longs. 10 days by default"
-  option :weekend_lines, type: :array, desc: "Set the weekend_lines. [3.5, 8.5] by default"
-  option :plot, :type => :boolean, :desc => "also plot the new data"
-  option :plot_to_board, :type => :boolean, :desc => "Send the plotted data to the board"
-  option 'with-fast-lane', :desc => "Plot Fast Lane with new cards bars", :required => false, :type => :boolean
-  option 'no-tasks', :desc => "Do not plot tasks line", :required => false, :type => :boolean
-  option 'push-to-api', :desc => 'Push collected data to api endpoint (in json)', :required => false
+  desc 'burndown', 'Update burndown chart'
+  option :output, aliases: :o, desc: 'Output directory', required: false
+  option :new_sprint, aliases: :n, desc: 'Create new sprint'
+  option :sprint_number, type: :numeric, desc: 'Provide the number of the sprint'
+  option :total_days, type: :numeric, desc: 'Provide how many days the sprint longs. 10 days by default'
+  option :weekend_lines, type: :array, desc: 'Set the weekend_lines. [3.5, 8.5] by default'
+  option :plot, type: :boolean, desc: 'also plot the new data'
+  option :plot_to_board, type: :boolean, desc: 'Send the plotted data to the board'
+  option 'with-fast-lane', desc: 'Plot Fast Lane with new cards bars', required: false, type: :boolean
+  option 'no-tasks', desc: 'Do not plot tasks line', required: false, type: :boolean
+  option 'push-to-api', desc: 'Push collected data to api endpoint (in json)', required: false
+  option 'board-id', desc: 'Id of Trello Board'
   def burndown
     process_global_options options
     require_trello_credentials
@@ -192,25 +189,25 @@ EOT
     end
   end
 
-  desc "plot SPRINT-NUMBER [--output] [--no-tasks] [--with-fast-lane]", "Plot burndown chart for given sprint"
-  option :output, :aliases => :o, :desc => "Output directory", :required => false
-  option 'with-fast-lane', :desc => "Plot Fast Lane with new cards bars", :required => false, :type => :boolean
-  option 'no-tasks', :desc => "Do not plot tasks line", :required => false, :type => :boolean
+  desc 'plot SPRINT-NUMBER [--output] [--no-tasks] [--with-fast-lane]', 'Plot burndown chart for given sprint'
+  option :output, aliases: :o, desc: 'Output directory', required: false
+  option 'with-fast-lane', desc: 'Plot Fast Lane with new cards bars', required: false, type: :boolean
+  option 'no-tasks', desc: 'Do not plot tasks line', required: false, type: :boolean
   def plot(sprint_number)
     process_global_options options
     BurndownChart.plot(sprint_number, options)
   end
 
-  desc "backup", "Create backup of board"
-  option "board-id", :desc => "Id of Trello board", :required => true
+  desc 'backup', 'Create backup of board'
+  option 'board-id', desc: 'Id of Trello board', required: true
   def backup
     process_global_options options
     require_trello_credentials
 
-    Backup.new(@@settings).backup(board_id(options["board-id"]))
+    Backup.new(@@settings).backup(board_id(options['board-id']))
   end
 
-  desc "list-backups", "List all backups"
+  desc 'list-backups', 'List all backups'
   def list_backups
     b = Backup.new @@settings
     b.list.each do |backup|
@@ -218,93 +215,93 @@ EOT
     end
   end
 
-  desc "show-backup", "Show backup of board"
-  option "board-id", :desc => "Id of Trello board", :required => true
-  option "show-descriptions", :desc => "Show descriptions of cards", :required => false, :type => :boolean
+  desc 'show-backup', 'Show backup of board'
+  option 'board-id', desc: 'Id of Trello board', required: true
+  option 'show-descriptions', desc: 'Show descriptions of cards', required: false, type: :boolean
   def show_backup
-    Backup.new(@@settings).show(board_id(options["board-id"]), options)
+    Backup.new(@@settings).show(board_id(options['board-id']), options)
   end
 
-  desc "organization", "Show organization info"
-  option "org-name", :desc => "Name of organization", :required => true
+  desc 'organization', 'Show organization info'
+  option 'org-name', desc: 'Name of organization', required: true
   def organization
     process_global_options options
     require_trello_credentials
 
-    organization = TrelloWrapper.new(@@settings).organization(options["org-name"])
+    organization = TrelloWrapper.new(@@settings).organization(options['org-name'])
 
     puts "Display Name: #{organization.display_name}"
     puts "Home page: #{organization.url}"
   end
 
-  desc "get-description", "Reads description"
-  option "card-id", :desc => "Id of card", :required => true
+  desc 'get-description', 'Reads description'
+  option 'card-id', desc: 'Id of card', required: true
   def get_description
     process_global_options options
     require_trello_credentials
 
     trello = TrelloWrapper.new(@@settings)
 
-    puts trello.get_description(options["card-id"])
+    puts trello.get_description(options['card-id'])
   end
 
-  desc "set-description", "Writes description read from standard input"
-  option "card-id", :desc => "Id of card", :required => true
+  desc 'set-description', 'Writes description read from standard input'
+  option 'card-id', desc: 'Id of card', required: true
   def set_description
     process_global_options options
     require_trello_credentials
 
-    TrelloWrapper.new(@@settings).set_description(options["card-id"], STDIN.read)
+    TrelloWrapper.new(@@settings).set_description(options['card-id'], STDIN.read)
   end
 
-  desc "organization-members", "Show organization members"
-  option "org-name", :desc => "Name of organization", :required => true
+  desc 'organization-members', 'Show organization members'
+  option 'org-name', desc: 'Name of organization', required: true
   def organization_members
     process_global_options options
     require_trello_credentials
 
     trello = TrelloWrapper.new(@@settings)
 
-    members = trello.organization(options["org-name"]).members.sort_by(&:username)
+    members = trello.organization(options['org-name']).members.sort_by(&:username)
 
     members.each do |member|
       puts "#{member.username} (#{member.full_name})"
     end
   end
 
-  desc "set-cover <filename>", "Set cover picture"
-  option "card-id", :desc => "Id of card", :required => true
+  desc 'set-cover <filename>', 'Set cover picture'
+  option 'card-id', desc: 'Id of card', required: true
   def set_cover(filename)
     process_global_options(options)
     require_trello_credentials
 
-    TrelloWrapper.new(@@settings).add_attachment(options["card-id"], filename)
+    TrelloWrapper.new(@@settings).add_attachment(options['card-id'], filename)
   end
 
-  desc "make-cover <filename>", "Make existing picture the cover"
-  option "card-id", :desc => "Id of card", :required => true
+  desc 'make-cover <filename>', 'Make existing picture the cover'
+  option 'card-id', desc: 'Id of card', required: true
   def make_cover(filename)
     process_global_options(options)
     require_trello_credentials
 
-    TrelloWrapper.new(@@settings).make_cover(options["card-id"], filename)
+    TrelloWrapper.new(@@settings).make_cover(options['card-id'], filename)
   end
 
-  desc "list-member-boards", "List name and id of all boards"
-  option "member-id", :desc => "Id of the member", :required => true
+  desc 'list-member-boards', 'List name and id of all boards'
+  option 'member-id', desc: 'Id of the member', required: true
   def list_member_boards
     process_global_options options
     require_trello_credentials
 
     trello = TrelloWrapper.new(@@settings)
-    trello.get_member_boards(options["member-id"]).sort_by { |board|
-      board["name"]
-    }.each { |board|
-      puts "#{board["name"]} - #{board["id"]}"
-    }
+    trello.get_member_boards(options['member-id']).sort_by do |board|
+      board['name']
+    end.each do |board|
+      puts "#{board['name']} - #{board['id']}"
+    end
   end
 
-  desc "setup-scrum", "Create necessary elements of our SCRUM setup"
+  desc 'setup-scrum', 'Create necessary elements of our SCRUM setup'
   long_desc <<-EOT
   Will create board, lists and labels with names as configured in trollolorc,
   or use the defaults.
@@ -317,58 +314,58 @@ EOT
     c.create
   end
 
-  desc "set-priorities", "Set priority text into card titles"
+  desc 'set-priorities', 'Set priority text into card titles'
   long_desc <<EOT
   Add 'P<n>: ' to the beginning of every cards title in the 'Backlog' list,
   replace where already present. n is the current position of the list on
   the card.
 EOT
-  option "board-id", :desc => "Id of the board", :required => true
-  option "backlog-list-name", :desc => "Name of backlog list", :required => false
+  option 'board-id', desc: 'Id of the board', required: true
+  option 'backlog-list-name', desc: 'Name of backlog list', required: false
   def set_priorities
     process_global_options options
     require_trello_credentials
 
     p = Scrum::Prioritizer.new(@@settings)
-    p.prioritize(board_id(options["board-id"]), options["backlog-list-name"])
+    p.prioritize(board_id(options['board-id']), options['backlog-list-name'])
   end
 
-  desc "cleanup-sprint", "Move remaining cards to the planning board"
+  desc 'cleanup-sprint', 'Move remaining cards to the planning board'
   long_desc <<EOT
   After the sprint, move remaining cards from 'Sprint Backlog', 'Doing'
   and 'QA' lists back to the planning board into the 'Ready' list.
 EOT
-  option "board-id", :desc => "Id of the board", :required => true
-  option "target-board-id", :desc => "Id of the target board", :required => true
+  option 'board-id', desc: 'Id of the board', required: true
+  option 'target-board-id', desc: 'Id of the target board', required: true
   def cleanup_sprint
     process_global_options options
     require_trello_credentials
 
     s = Scrum::SprintCleaner.new(@@settings)
-    s.cleanup(board_id(options["board-id"]),
-              board_id(options["target-board-id"]))
+    s.cleanup(board_id(options['board-id']),
+              board_id(options['target-board-id']))
   end
 
-  desc "move-backlog", "Move the planning backlog to the sprint board"
+  desc 'move-backlog', 'Move the planning backlog to the sprint board'
   long_desc <<-EOT
   Two separate boards are used, a planning board and a sprint board for the
   current sprint.
   After each planning meeting the cards are moved from the planning boards
   'Backlog' list to the sprint boards 'Sprint Backlog' list.
   EOT
-  option "planning-board-id", desc: "Id of the planning board", required: true
-  option "sprint-board-id", desc: "Id of the sprint board", required: true
+  option 'planning-board-id', desc: 'Id of the planning board', required: true
+  option 'sprint-board-id', desc: 'Id of the sprint board', required: true
   def move_backlog
     process_global_options options
     require_trello_credentials
 
     m = Scrum::BacklogMover.new(@@settings)
-    m.move(board_id(options["planning-board-id"]), board_id(options["sprint-board-id"]))
+    m.move(board_id(options['planning-board-id']), board_id(options['sprint-board-id']))
   end
 
   private
 
-  def process_global_options options
+  def process_global_options(options)
     @@settings.verbose = options[:verbose]
     @@settings.raw = options[:raw]
   end
@@ -376,24 +373,22 @@ EOT
   def require_trello_credentials
     write_back = false
 
-    if !@@settings.developer_public_key
-      puts "Put in Trello developer public key:"
+    unless @@settings.developer_public_key
+      puts 'Put in Trello developer public key:'
       @@settings.developer_public_key = STDIN.gets.chomp
       write_back = true
     end
 
-    if !@@settings.member_token
-      puts "Put in Trello member token:"
+    unless @@settings.member_token
+      puts 'Put in Trello member token:'
       @@settings.member_token = STDIN.gets.chomp
       write_back = true
     end
 
-    if write_back
-      @@settings.save_config
-    end
+    @@settings.save_config if write_back
 
     if !@@settings.developer_public_key || !@@settings.member_token
-      STDERR.puts "Require trello credentials in config file"
+      STDERR.puts 'Require trello credentials in config file'
       exit 1
     end
   end