scrum_lint 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 713f645a6fa0f2c33084d44f74a605ec0fe58266
+  data.tar.gz: 2852c9b789f35bb7e89cfd811c94fa199eebadfd
+SHA512:
+  metadata.gz: 1cdc0fdb95cae70b269bd36e339bc8d8ac8a5b7105490a5a96e7286e64736ad1b2842f0c70b3b2a552aee2727f313b6a13b2f19d647ccc821e5250839e1089e7
+  data.tar.gz: 5a4d08158dc6178d70ac68fa3d2368660a7f32f88e8366dd754aec5de66c4eebdf6110b2d4d3929a74265a5c8f7800f5b319b007c49ed4ba8127a40ca3c7ad02

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at robert@chalkschools.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Robert Fletcher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# ScrumLint
+
+ScrumLint is a tool to manage Chalk's development workflow in Trello and
+Github. It provides feedback based on actions that need to be taken to keep our
+boards in sync with what is actually happening.
+
+## Installation
+
+```sh
+gem install scrum_lint
+```
+
+## Usage
+
+ScrumLint expects the environment variables `TRELLO_DEVELOPER_PUBLIC_KEY` and
+`TRELLO_MEMBER_TOKEN` to be set in order to work. You can see how to acquire
+these tokens in the [Basic authorization section of the `ruby-trello`
+gem](https://github.com/jeremytregunna/ruby-trello#basic-authorization). Once
+you've set these, you can run the following command for a list of corrections
+to be made:
+
+```sh
+scrum-lint
+```
+
+Running ScrumLint will run a series of checks against your Trello board to
+ensure it is up to date, and list out any violations.
+
+## Linters
+
+### Context
+
+The Context linter checks that each card in task lists has a context listed at
+the beginning of it's description. This is expected to be a text label in the
+format:
+
+```
+Context: https://trello.com/c/<some_card_hash>
+```
+
+## Development
+
+After checking out the repo, run `script/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `script/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/[USERNAME]/scrum_lint. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
+conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).

data/exe/scrum-lint

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/scrum_lint'
+
+ScrumLint::Runner.()

data/lib/scrum_lint/board_validator.rb

@@ -0,0 +1,24 @@
+module ScrumLint
+
+  class BoardValidator
+    def self.call(board)
+      new.(board)
+    end
+
+    def call(board)
+      fail "no task lists found!" unless board.task_lists.any?
+      extra_list_names = board.lists.map(&:name) - expected_list_names(board)
+      warn "extra lists found: #{extra_list_names}" if extra_list_names.any?
+    end
+
+  private
+
+    def expected_list_names(board)
+      ScrumLint.config.project_list_names +
+        ScrumLint.config.task_list_names +
+        board.done_lists.map(&:name) +
+        ScrumLint.config.ignored_list_names
+    end
+  end
+
+end

data/lib/scrum_lint/checkers/context_checker.rb

@@ -0,0 +1,27 @@
+module ScrumLint
+
+  class ContextChecker
+
+    def self.call(board)
+      new.(board)
+    end
+
+    def call(board)
+      board.task_lists.each do |list|
+        cards = cards_without_context(list)
+        if cards.any?
+          puts "List #{list.name.green} has cards missing context:"
+          cards.each { |card| puts "-> #{card.name.blue}" }
+        end
+      end
+    end
+
+  private
+
+    def cards_without_context(list)
+      list.cards.select { |card| !card.desc.match(/^Context:/) }
+    end
+
+  end
+
+end

data/lib/scrum_lint/configuration.rb

@@ -0,0 +1,17 @@
+module ScrumLint
+
+  module Configuration
+    def self.new
+      OpenStruct.new(
+        board_name: 'Eng: Current',
+        task_list_names: ['Planned', 'This Sprint', 'Doing', 'In Review'],
+        done_list_matcher: /^Done.*$/,
+        project_list_names: ['Active Projects'],
+        ignored_list_names: %w(Emergent),
+        trello_developer_public_key: ENV.fetch('TRELLO_DEVELOPER_PUBLIC_KEY'),
+        trello_member_token: ENV.fetch('TRELLO_MEMBER_TOKEN'),
+      )
+    end
+  end
+
+end

data/lib/scrum_lint/configurator.rb

@@ -0,0 +1,24 @@
+module ScrumLint
+
+  class Configurator
+
+    def self.call
+      Trello.configure do |trello_config|
+        trello_config.developer_public_key = trello_developer_public_key
+        trello_config.member_token = trello_member_token
+      end
+    end
+
+  private
+
+    def self.trello_developer_public_key
+      ScrumLint.config.trello_developer_public_key
+    end
+
+    def self.trello_member_token
+      ScrumLint.config.trello_member_token
+    end
+
+  end
+
+end

data/lib/scrum_lint/models/board.rb

@@ -0,0 +1,35 @@
+require_relative 'list'
+
+module ScrumLint
+
+  class Board
+    attr_accessor :trello_board
+
+    def initialize(trello_board)
+      self.trello_board = trello_board
+    end
+
+    def lists
+      @lists ||= trello_board.lists.map { |list| ScrumLint::List.new(list) }
+    end
+
+    def done_lists
+      @done_lists ||= lists.select { |list| done_list_name?(list.name) }
+    end
+
+    def task_lists
+      @task_lists ||= lists.select { |list| task_list_name?(list.name) }
+    end
+
+  private
+
+    def task_list_name?(name)
+      ScrumLint.config.task_list_names.include?(name) # || done_list_name?(name)
+    end
+
+    def done_list_name?(name)
+      name.match(ScrumLint.config.done_list_matcher)
+    end
+  end
+
+end

data/lib/scrum_lint/models/card.rb

@@ -0,0 +1,22 @@
+module ScrumLint
+
+  class Card
+
+    attr_accessor :trello_card, :list
+
+    def initialize(trello_card, list:)
+      self.trello_card = trello_card
+      self.list = list
+    end
+
+    def desc
+      trello_card.desc
+    end
+
+    def name
+      trello_card.name
+    end
+
+  end
+
+end

data/lib/scrum_lint/models/list.rb

@@ -0,0 +1,25 @@
+require_relative 'card'
+
+module ScrumLint
+
+  class List
+
+    attr_accessor :trello_list
+
+    def initialize(trello_list)
+      self.trello_list = trello_list
+    end
+
+    def name
+      trello_list.name
+    end
+
+    def cards
+      @cards ||= trello_list.cards.map do |card|
+        ScrumLint::Card.new(card, list: self)
+      end
+    end
+
+  end
+
+end

data/lib/scrum_lint/runner.rb

@@ -0,0 +1,41 @@
+require_relative 'configurator'
+require_relative 'models/board'
+require_relative 'board_validator'
+require_relative 'checkers/context_checker'
+
+module ScrumLint
+
+  class Runner
+    def self.call
+      new.()
+    end
+
+    def call
+      ScrumLint::Configurator.()
+      ScrumLint::BoardValidator.(board)
+      ScrumLint::ContextChecker.(board)
+    end
+
+  private
+
+    def board
+      @board ||= ScrumLint::Board.new(locate_board)
+    end
+
+    def locate_board
+      matching_boards = boards.select { |board| board.name == board_name }
+      fail 'multiple boards match' if matching_boards.size > 1
+      matching_boards.first
+    end
+
+    def boards
+      Trello::Board.all
+    end
+
+    def board_name
+      ScrumLint.config.board_name
+    end
+
+  end
+
+end

data/lib/scrum_lint/version.rb

@@ -0,0 +1,3 @@
+module ScrumLint
+  VERSION = '0.0.1'
+end

data/lib/scrum_lint.rb

@@ -0,0 +1,15 @@
+require 'trello'
+require 'colorize'
+require 'byebug'
+
+require_relative 'scrum_lint/version'
+require_relative 'scrum_lint/configuration'
+require_relative 'scrum_lint/runner'
+
+module ScrumLint
+
+  def self.config
+    @config ||= ScrumLint::Configuration.new
+  end
+
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: scrum_lint
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Fletcher
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-trello
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+description: 
+email:
+- robert@chalkschools.com
+executables:
+- scrum-lint
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- exe/scrum-lint
+- lib/scrum_lint.rb
+- lib/scrum_lint/board_validator.rb
+- lib/scrum_lint/checkers/context_checker.rb
+- lib/scrum_lint/configuration.rb
+- lib/scrum_lint/configurator.rb
+- lib/scrum_lint/models/board.rb
+- lib/scrum_lint/models/card.rb
+- lib/scrum_lint/models/list.rb
+- lib/scrum_lint/runner.rb
+- lib/scrum_lint/version.rb
+homepage: https://github.com/ChalkSchools/scrum-lint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Toolkit to help manage a very specific Trello workflow
+test_files: []