twstats 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c03859f83739b7704e23e9df4faba575ea6f3aa6
+  data.tar.gz: 5906375e59625f9a5ffef39dbd8905325e2ea4f4
+SHA512:
+  metadata.gz: 3a6d20cc0fe85c57ad9872e33f16237d54440725cbed8e6cc17dc155a090e96cdf970b2a56dab224e5fc403275872bb470e34128a39747ad7b3a622f3e6667ef
+  data.tar.gz: 7d25b85fb90cfc3da98763eca74f47c4f3d6377fab7075e2faf3be86912e7000c6ce585797bc5155ef9e73f555e5ee0196f198de94de18ae4b619ec4f63ee287

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea

data/.gitlab-ci.yml

@@ -0,0 +1,23 @@
+image: "ruby:2.4"
+
+stages:
+  - publish
+# This is a basic example for a gem or script which doesn't use
+# services such as redis or postgres
+before_script:
+  - ruby -v
+  - gem install bundler  --no-ri --no-rdoc
+  - bundle install
+
+# Use dpl to publish the tem
+rubygems:
+  stage: publish
+  only:
+  - tags
+  environment:
+    name: rubygems
+    url: https://rubygems.org/gems/twstats
+  script:
+  - gem build twstats.gemspec
+  - gem install dpl
+  - dpl --provider=rubygems --api-key=$RUBYGEMS_KEY

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jp.araque@cern.ch. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in twstats.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    twstats (0)
+      tty-prompt (~> 0.17)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    equatable (0.5.0)
+    hitimes (1.3.0)
+    necromancer (0.4.0)
+    pastel (0.7.2)
+      equatable (~> 0.5.0)
+      tty-color (~> 0.4.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    timers (4.1.2)
+      hitimes
+    tty-color (0.4.3)
+    tty-cursor (0.6.0)
+    tty-prompt (0.17.0)
+      necromancer (~> 0.4.0)
+      pastel (~> 0.7.0)
+      timers (~> 4.0)
+      tty-cursor (~> 0.6.0)
+      tty-reader (~> 0.4.0)
+    tty-reader (0.4.0)
+      tty-cursor (~> 0.6.0)
+      tty-screen (~> 0.6.4)
+      wisper (~> 2.0.0)
+    tty-screen (0.6.5)
+    wisper (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  twstats!
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 J.P. Araque
+
+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,13 @@
+# TW-stats gem
+The teamwork stats (tw-stats) gem allows you to import a csv file with the times logged in a given project and extract usefull information about the time spent filtered by different metrics.
+
+## Generate report
+To install just run
+
+`gem install tw-stat`
+
+and run it as follows
+
+`tw-stat -f filename.csv`
+
+using a file named `filename.csv` with the times logged.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "twstats"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/twstats

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "twstats"
+
+Twstats::Runner.new

data/lib/twstats.rb

@@ -0,0 +1,25 @@
+require_relative 'twstats/version'
+require_relative 'twstats/csv_reader'
+require_relative 'twstats/runner'
+require_relative 'twstats/tw_log'
+
+module Twstats
+
+  DEFAULT_OPTIONS = {encoding: 'ISO-8859-1:UTF-8', headers: true}
+  WELLCOME_MESSAGE = "\n***************************************************************************************
+** TWStats helps you to get some stats from a CSV export of Time loggin gin Teamwork **
+***************************************************************************************\n\n"
+  STATS_MENU_CHOICES = [
+      {name: 'Projects', value: 0},
+      {name: 'People', value: 1},
+      {name: 'Tags', value: 2},
+      {name: 'Billable vs non-villable', value: 3},
+      {name: 'Full stats', value: 4},
+      {name: 'Back', value: 5}
+  ]
+  MENU_CHOICES = [
+      {name: 'Stats', value: 0},
+      {name: 'Info', value: 1},
+      {name: 'Quit', value: 2}
+  ]
+end

data/lib/twstats/csv_reader.rb

@@ -0,0 +1,47 @@
+require 'csv'
+require "twstats/tw_log"
+
+module Twstats
+  class CSVReader
+    attr_reader :logs
+    attr_reader :tags
+    attr_reader :people
+    attr_reader :tasks
+    attr_reader :projects
+    # Create an object structure from the csv file which allows to easily read the content
+    def initialize(file)
+      @logs = Set.new([])
+      @tags = Set.new([])
+      @people = Set.new([])
+      @tasks = Set.new([])
+      @projects = Set.new([])
+      # Initialize the reader with a csv file and fill the times as an array of columns
+      CSV.foreach(file, DEFAULT_OPTIONS) do |row|
+        update_info TwLog.new(row)
+      end
+    end
+
+    def update_info(log)
+      @projects << log.project
+      @people << log.who
+      log.tags.each{|x| @tags << x}
+      @tasks << log.task
+      @logs << log
+    end
+
+    def get_total_time(object, element)
+      case object
+        when :projects
+          logs.select{|log| log.project == element}.inject(0){ |sum, l| sum + l.decimal_time}
+        when :tags
+          logs.select{|log| log.tags.include?(element)}.inject(0){ |sum, l| sum + l.decimal_time}
+        when :people
+          logs.select{|log| log.who == element}.inject(0){ |sum, l| sum + l.decimal_time}
+        when :tasks
+          logs.select{|log| log.task == element}.inject(0){ |sum, l| sum + l.decimal_time}
+        else
+          -99999
+      end
+    end
+  end
+end

data/lib/twstats/runner.rb

@@ -0,0 +1,71 @@
+require 'tty-prompt'
+
+require_relative 'csv_reader'
+
+module Twstats
+  class Runner
+    def initialize
+      # Load interactive console
+      @prompt = TTY::Prompt.new
+      puts WELLCOME_MESSAGE
+      # Ask for the csv file
+      file = @prompt.ask('Specify the CSV file from a Teamwork time log export', default: 'exportTimeLog.csv') do |input|
+        input.modify :chomp
+      end
+      @csv = CSVReader.new(file)
+      loop do
+        option = @prompt.select("Choose an option", Twstats::MENU_CHOICES)
+        case option
+          when 0
+            show_stats_menu
+          when 1
+            show_info
+          when 2
+            break
+          else
+            puts 'Option not recognized!'
+        end
+      end
+    end
+
+    def show_stats_menu
+      loop do
+        option = @prompt.select("Select what time logging stats you want to see", Twstats::STATS_MENU_CHOICES)
+        case option
+          when 0
+            show_stats :projects
+          when 1
+            show_stats :people
+          when 2
+            show_stats :tags
+          when 3
+            show_bil_vs_non_stats
+          when 4
+            show_full_stats
+          when 5
+            return
+          else
+            puts 'Option not recognized'
+        end
+      end
+    end
+
+    def show_stats(obj)
+      puts "Time logged vs #{obj.to_s}:"
+      toshow = {}
+      max = 0
+      @csv.send(obj).each do |element|
+        toshow[element] = @csv.get_total_time(obj, element).round(2)
+        max = element.size if max < element.size
+      end
+      toshow.sort_by{ |k,v| v}.reverse.to_h.each do |k,v|
+        puts " - #{k.ljust(max,' ')} -> #{v}"
+      end
+    end
+
+    def show_info
+
+    end
+
+  end
+end

data/lib/twstats/tw_log.rb

@@ -0,0 +1,26 @@
+require 'time'
+module Twstats
+  class TwLog
+    attr_reader :who
+    attr_reader :time
+    attr_reader :decimal_time
+    attr_reader :description
+    attr_reader :tags
+    attr_reader :project
+    attr_reader :task
+
+
+    # Class use to store the information needed form a given log
+    def initialize(row)
+      # Receives a row of the CSV file
+      @who = row["Who"]
+      @decimal_time = row["Decimal Hours"].to_f
+      @time = (DateTime.parse(row["End Date/Time"]) - DateTime.parse(row["Date/Time"]))*24
+      @description = row["Description"]
+      @tags = row["Tags"].split(',')
+      @project = row["Project"]
+      @task = row["Task"]
+      @billable = row["Is it Billable?"]
+    end
+  end
+end

data/lib/twstats/version.rb

@@ -0,0 +1,3 @@
+module Twstats
+  VERSION = `git describe --tags`
+end

data/twstats.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "twstats/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "twstats"
+  spec.version       = Twstats::VERSION
+  spec.authors       = ["J.P. Araque"]
+  spec.email         = ["jp.araque@cern.ch"]
+
+  spec.summary       = 'Read a csv file generate by Teamwork to quickly get some stats from time logging.'
+  spec.description   = 'Teamwork allows to log time for all tasks within a project but the stats capabilities do not allow for a quick overview of time loggin stats. TWStats produces useful stats from a CSV file exported from Teamwork'
+  spec.homepage      = "https://gitlab.com/jensen-technologies/public/tw-stats"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'http://mygemserver.com'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency "tty-prompt", "~> 0.17"
+
+  spec.required_ruby_version = '~> 2.0'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: twstats
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- J.P. Araque
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+description: Teamwork allows to log time for all tasks within a project but the stats
+  capabilities do not allow for a quick overview of time loggin stats. TWStats produces
+  useful stats from a CSV file exported from Teamwork
+email:
+- jp.araque@cern.ch
+executables:
+- twstats
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/twstats
+- lib/twstats.rb
+- lib/twstats/csv_reader.rb
+- lib/twstats/runner.rb
+- lib/twstats/tw_log.rb
+- lib/twstats/version.rb
+- twstats.gemspec
+homepage: https://gitlab.com/jensen-technologies/public/tw-stats
+licenses:
+- MIT
+metadata:
+  allowed_push_host: http://mygemserver.com
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Read a csv file generate by Teamwork to quickly get some stats from time
+  logging.
+test_files: []