scrum_lint 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 713f645a6fa0f2c33084d44f74a605ec0fe58266
-  data.tar.gz: 2852c9b789f35bb7e89cfd811c94fa199eebadfd
+  metadata.gz: d61fb1e76e63f0d5ef49bbf8a5c10b0f454e43c6
+  data.tar.gz: a9e1a7fc6ba2935e5544d5d09caf87c19b9228f2
 SHA512:
-  metadata.gz: 1cdc0fdb95cae70b269bd36e339bc8d8ac8a5b7105490a5a96e7286e64736ad1b2842f0c70b3b2a552aee2727f313b6a13b2f19d647ccc821e5250839e1089e7
-  data.tar.gz: 5a4d08158dc6178d70ac68fa3d2368660a7f32f88e8366dd754aec5de66c4eebdf6110b2d4d3929a74265a5c8f7800f5b319b007c49ed4ba8127a40ca3c7ad02
+  metadata.gz: 38b38598927e3b68738978b3863465073c2c41ad272fdd414e24b7f7cf5f938c02a5d9415258df0eec27113bf45cbf1a47d78614b583bd681d3a3f6f57d3c9fe
+  data.tar.gz: 4a413679359d281a13aa5887992cfc034bf147d4b6ae403bd0cf8db0d3e4b975595924b25227c04c8f8856f7134131755cf5a7645c90e81a9ea2350ad41e6670

data/README.md

@@ -12,9 +12,10 @@ 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`
+ScrumLint expects a `.scrum-lint.yml` file in the current working directory
+with at a minimum a `trello_developer_public_key` and `trello_member_token`.
+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:
@@ -28,14 +29,14 @@ ensure it is up to date, and list out any violations.
 
 ## Linters
 
-### Context
+**Context**
 
-The Context linter checks that each card in task lists has a context listed at
+The Context linter checks that each card in task lists has a context link 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>
+Context: <link to a Trello card>
 ```
 
 ## Development

data/lib/scrum_lint/configuration.rb

@@ -1,17 +1,63 @@
+require 'yaml'
+require 'erb'
+
 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'),
-      )
+  class Configuration
+
+    DEFAULT_CONFIGURATION = {
+      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),
+    }.freeze
+
+    REQUIRED_CONFIGURATION_KEYS = [
+      :trello_developer_public_key,
+      :trello_member_token,
+    ].freeze
+
+    CONFIGURATION_KEYS =
+      (DEFAULT_CONFIGURATION.keys + REQUIRED_CONFIGURATION_KEYS).freeze
+
+    attr_accessor(*CONFIGURATION_KEYS)
+
+    def initialize
+      options = load_yaml_config.merge(DEFAULT_CONFIGURATION)
+
+      CONFIGURATION_KEYS.each do |key|
+        self.send("#{key}=", options.fetch(key))
+        options.delete(key)
+      end
+      raise "invalid options: #{options.keys}" if options.any?
     end
+
+  private
+
+    def load_yaml_config
+      unless File.exist?(config_file_path)
+        abort('Please add a ".scrum-lint.yml" file and try again')
+      end
+      symbolize_keys(YAML.safe_load(config_file_contents))
+    end
+
+    def config_file_contents
+      ERB.new(IO.read(config_file_path)).result
+    end
+
+    def config_file_path
+      './.scrum-lint.yml'
+    end
+
+    def symbolize_keys(hash)
+      hash.each_with_object({}) do |(key, value), result|
+        new_key = key.is_a?(String) ? key.to_sym : key
+        new_value = value.is_a?(Hash) ? symbolize_keys(value) : value
+        result[new_key] = new_value
+      end
+    end
+
   end
 
 end

data/lib/scrum_lint/configurator.rb

@@ -3,6 +3,10 @@ module ScrumLint
   class Configurator
 
     def self.call
+      new.()
+    end
+
+    def call
       Trello.configure do |trello_config|
         trello_config.developer_public_key = trello_developer_public_key
         trello_config.member_token = trello_member_token
@@ -11,11 +15,11 @@ module ScrumLint
 
   private
 
-    def self.trello_developer_public_key
+    def trello_developer_public_key
       ScrumLint.config.trello_developer_public_key
     end
 
-    def self.trello_member_token
+    def trello_member_token
       ScrumLint.config.trello_member_token
     end
 

data/lib/scrum_lint/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrum_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Robert Fletcher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-12 00:00:00.000000000 Z
+date: 2016-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-trello