werd 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da297d8fac5d594a00a7d4b16e3975348af0f3f1
+  data.tar.gz: c6b329af37350e5dff78581ea69f0da5b59871de
+SHA512:
+  metadata.gz: 3e67e9642081d6963ec1c8e2bad96eae748e25a7416ec4d2dcf954188eee7e8200983fb56381a2a92ceb38d3baedda92aba48404afba1a40f1e0dba27a79331f
+  data.tar.gz: cf8bcbbc23157ade954b70684650dd0716271df972ba56bf4c8918514900fcc93afeabc64f7610b8df11fc258bc7ac6f3df7832d8e1d11ff839b20b944c10b73

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p598

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in werd.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Can Berk Guder
+
+MIT License
+
+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,31 @@
+# Werd
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'werd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install werd
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/werd/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/werd

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'escort'
+require 'werd'
+
+Escort::App.create do |app|
+  app.options do |opts|
+    opts.opt :token,  'Your Pivotal Tracker API token', short: '-t', long: '--token', type: :string
+    opts.opt :project, 'The ID of the project you want a report on', short: '-p', long: '--project', type: :string
+  end
+
+  app.action do |options, arguments|
+    Werd::Commands::Report.new(options, arguments).execute
+  end
+end

data/lib/werd.rb

@@ -0,0 +1,8 @@
+require 'escort'
+require 'contracts'
+require 'tracker_api'
+
+require 'werd/commands/report'
+require 'werd/project_word_counter'
+require 'werd/reports/basic'
+require 'werd/version'

data/lib/werd/commands/report.rb

@@ -0,0 +1,13 @@
+module Werd
+  module Commands
+    class Report < ::Escort::ActionCommand::Base
+      def execute
+        token      = command_options[:token]
+        project_id = command_options[:project]
+
+        words = Werd::ProjectWordCounter.new(token, project_id).words
+        puts Werd::Reports::Basic.new(words).to_s
+      end
+    end
+  end
+end

data/lib/werd/project_word_counter.rb

@@ -0,0 +1,41 @@
+module Werd
+  class ProjectWordCounter
+    include Contracts
+    attr_reader :project_id, :token
+
+    Contract String, String => Any
+    def initialize token, project_id
+      @token, @project_id = token, project_id
+    end
+
+    Contract String => ArrayOf[[String, Num]]
+    def words
+      counts = Hash.new 0
+      document.split(/\W/).select do |str|
+        str.size > 0
+      end.map do |chunk|
+        chunk.downcase
+      end.each do |word|
+        counts[word] += 1
+      end
+      counts.to_a.sort_by(&:last).reverse
+    end
+
+    Contract None => RespondTo[:project]
+    def client
+      @client ||= TrackerApi::Client.new(token: token)
+    end
+
+    Contract None => Any
+    def project
+      client.project project_id
+    end
+
+    Contract None => String
+    def document
+      project.stories.map do |s|
+        [s.name, s.description]
+      end.flatten.join("\n")
+    end
+  end
+end

data/lib/werd/reports/basic.rb

@@ -0,0 +1,20 @@
+module Werd
+  module Reports
+    class Basic
+      include Contracts
+      attr_reader :words
+
+      Contract ArrayOf[[String, Num]] => Any
+      def initialize words
+        @words = words.first(30)
+      end
+
+      Contract None => String
+      def to_s
+        words.map do |row|
+          "%4i %s" % [row.last, row.first]
+        end.join("\n")
+      end
+    end
+  end
+end

data/lib/werd/version.rb

@@ -0,0 +1,3 @@
+module Werd
+  VERSION = "0.0.1"
+end

data/spec/lib/werd/project_word_counter_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Werd::ProjectWordCounter do
+  let(:name) { 'Story, story!' }
+  let(:description) { 'Some words! Some: word' }
+  let(:stories) { [instance_double(TrackerApi::Resources::Story,
+                                  name: name,
+                                  description: description,
+                                 )] }
+  let(:project) { instance_double(TrackerApi::Resources::Project, stories: stories) }
+  let(:client) { instance_double(TrackerApi::Client, project: project) }
+  let(:word_counter) { Werd::ProjectWordCounter.new('token', 'project-id') }
+
+  before do
+    allow(word_counter).
+      to receive(:client).
+      and_return(verify_contracted_instance_method(Werd::ProjectWordCounter, :client, client))
+  end
+
+  let(:document_expectation) { [name, description].join("\n") }
+  describe '#document' do
+    subject { word_counter.document }
+    it { is_expected.to eq document_expectation }
+  end
+
+  let(:words_expectation) { [
+    ['story' , 2],
+    ['some'  , 2],
+    ['words' , 1],
+    ['word'  , 1],
+  ] }
+  describe '#words' do
+    before do
+      allow(word_counter).
+        to receive(:document).
+        and_return(verify_contracted_instance_method(Werd::ProjectWordCounter, :document, document_expectation))
+    end
+    subject { word_counter.words }
+    it { is_expected.to eq words_expectation }
+  end
+
+  describe '#project' do
+    subject { word_counter.project }
+    it { is_expected.to eq project }
+  end
+end

data/spec/lib/werd/reports/basic_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Werd::Reports::Basic do
+  let(:words) { verify_contracted_instance_method(Werd::ProjectWordCounter, :words, [
+    ['words', 1236],
+    ['some', 5],
+  ]) }
+
+  let(:report) { Werd::Reports::Basic.new(words) }
+
+  describe "#to_s" do
+    subject { report.to_s }
+    it { is_expected.to eq "1236 words\n   5 some" }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'werd'
+require 'pry'
+
+
+def verify_contracted_instance_method(klass, method, ret)
+  klass.decorated_methods[:instance_methods][method.to_sym].each do |contract|
+    validator = Contract.make_validator(contract.ret_contract)
+    if validator.call(ret)
+      return ret
+    else
+      raise <<-END
+      #{klass}##{method} contract violated.
+      #{contract}
+      Cannot return #{ret}
+      END
+    end
+  end
+end

data/werd.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'werd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "werd"
+  spec.version       = Werd::VERSION
+  spec.authors       = ["Ehren Murdick"]
+  spec.email         = ["emurdick@pivotal.io"]
+  spec.summary       = %q{Find the most common words on your tracker project}
+  spec.description   = %q{Pulls story descriptions and names from tracker}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.add_runtime_dependency 'escort'
+  spec.add_runtime_dependency 'tracker_api'
+  spec.add_runtime_dependency 'contracts'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: werd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ehren Murdick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: escort
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tracker_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: contracts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pulls story descriptions and names from tracker
+email:
+- emurdick@pivotal.io
+executables:
+- werd
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/werd
+- lib/werd.rb
+- lib/werd/commands/report.rb
+- lib/werd/project_word_counter.rb
+- lib/werd/reports/basic.rb
+- lib/werd/version.rb
+- spec/lib/werd/project_word_counter_spec.rb
+- spec/lib/werd/reports/basic_spec.rb
+- spec/spec_helper.rb
+- werd.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Find the most common words on your tracker project
+test_files:
+- spec/lib/werd/project_word_counter_spec.rb
+- spec/lib/werd/reports/basic_spec.rb
+- spec/spec_helper.rb