weekly_commits 0.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 06661e237591f3dd66a51c9a1e8a950e0064aeb7
-  data.tar.gz: 91fa20f8b52decf3b708f3db0caf385661ac8798
+SHA256:
+  metadata.gz: 1d8a69fe23bc97b9db8980934e7a4a36d062c6141084e8e2a932483fe876d18f
+  data.tar.gz: a6d6a00b73857cde9ceecc6859ae669235e4d871935049516befa165099b267c
 SHA512:
-  metadata.gz: b9d81940a33d55be2e3b26526553ece56b454a1cbe9ce3701249ed6d526c103cfc2c2f5932182e496f11ba32e70fe95066e0b42a3294bfe1e346c98b897c4133
-  data.tar.gz: f492ac2d537afdc2286a0cea64190db5a5e98492071cf7aae3abad5c5dd9903e2d3d6c71f2e757665f3f383c610361dc41d938216a4cc3d96af40743d475a4cb
+  metadata.gz: ec720cc2fd7ebac98776be53c2456944a7da47b2b2c06c9d8b410413f0c069a40def3330b33c4ac33568037c176feda389b0b0ba80c238bed211d72cb9f77d07
+  data.tar.gz: bdb7c71ef4acae11733b2f66e96d33643f385fc522d6f142285db8fad4e7b0b2699c437ea804eb3ea9aa4a8563a250f38e947047dca086eb13f3554f45908e89

data/README.md

@@ -1,12 +1,14 @@
-# WeeklyCommits
+![WeeklyCommits](weekly_commits.png)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/weekly_commits`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/dkarter/weekly_commits.svg?branch=master)](https://travis-ci.org/dkarter/weekly_commits)
 
-TODO: Delete this and the text above, and describe your gem
+WeeklyCommits is a command line tool for getting a bird's eye view of your
+commits on a branch for a specific week.
 
-## Installation
+It is particularly helpful for stand ups, filling up detailed time sheets and
+for recap when starting up again after a long weekend.
 
-Add this line to your application's Gemfile:
+## Installation
 
 ```ruby
 gem 'weekly_commits'
@@ -22,20 +24,73 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+For help type:
+
+```sh
+wcomm help
+# or
+wcomm help weekly_commits
+```
+
+Usage documentation from command-line:
+
+```
+Usage:
+  wcomm
+
+Options:
+  -w, [--week=N]                                 # Relative week number. e.g. -w=1 for last week. 0 = current week.
+                                                 # Default: 0
+      [--show-author], [--no-show-author]        # Display author(s) with each commit message. e.g. Did stuff (Ghost Ninja)
+      [--no-merge]                               # Omit merge commit messages
+      [--sort=SORT]                              # Show commits in ascending/descending order. Default: older commits on top, newer on bottom.
+                                                 # Default: desc
+                                                 # Possible values: asc, desc
+```
+
+To use the gem, navigate to a repo and make sure you have the WeeklyCommits gem
+installed for that version of ruby in that directory.
+
+Make sure you are on the correct branch.
+
+By default WeeklyCommits will only show commits on the current branch.
+
+### Example
+
+Show me this week's commits:
+
+```sh
+wcomm
+```
+
+Show me last week's commits:
+
+```sh
+wcomm -w=1
+```
+
+Show me commits from two weeks ago including author
+
+```sh
+wcomm -w=2 --show-author
+```
+
+### Screenshots
 
-## Development
+![tilex](screenshots/tilex.png)
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## TODO
 
-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).
+- [ ] Add support for specifying a branch explicitly
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/weekly_commits.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/dkarter/weekly_commits.
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
 

data/Rakefile

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

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "weekly_commits"
+require 'bundler/setup'
+require 'weekly_commits'
 
 # 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.
@@ -10,5 +10,5 @@ require "weekly_commits"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/weekly_commits.rb

@@ -2,5 +2,4 @@ require 'weekly_commits/version'
 require 'weekly_commits/cli'
 
 module WeeklyCommits
-
 end

data/lib/weekly_commits/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 require 'colorize'
 require 'active_support/all'
@@ -5,15 +7,31 @@ require 'active_support/all'
 module WeeklyCommits
   class CLI < Thor
     package_name 'Weekly Commits'
-    default_task :get_weekly_commits
-
-    desc 'weekly_commits', 'Lists commits for a specified week'
-    method_option :week, {
-      type: :numeric,
-      desc: 'Relative week number. e.g. -w=1 for last week. 0 = current week.',
-      aliases: '-w',
-      default: 0
-    }
+    default_task :weekly_commits
+
+    desc 'weekly_commits', '[DEFAULT] Lists commits for a specified week'
+    method_option :week,
+                  type: :numeric,
+                  desc: 'Relative week number. e.g. -w=1 for last week. 0 = current week.',
+                  aliases: '-w',
+                  default: 0
+
+    method_option :show_author,
+                  type: :boolean,
+                  desc: 'Display author(s) with each commit message. e.g. Did stuff (Ghost Ninja)',
+                  default: false
+
+    method_option :sort,
+                  type: :string,
+                  desc: 'Show commits in ascending/descending order. Default: older commits on top, newer on bottom.',
+                  default: 'asc',
+                  enum: %w[asc desc]
+
+    method_option :no_merge,
+                  type: :boolean,
+                  desc: 'Exclude merge commits',
+                  default: false
+
     def weekly_commits
       relative_week = options[:week]
       beg_week = relative_week.week.ago.beginning_of_week
@@ -21,9 +39,18 @@ module WeeklyCommits
       5.times do |day_count|
         date = beg_week + day_count.days
         week_title = date.strftime('%a, %e %b %Y')
-        git_date_format = date.strftime('%y-%m-%e')
+        git_date_format = date.strftime('%Y-%m-%e')
+        committer = options[:show_author] ? ' (%cn)'.magenta : ''
+
+        git_log_command = "git --no-pager log --after='#{git_date_format} 00:00' --before='#{git_date_format} 23:59' --pretty=format:'%s#{committer}'"
+        git_log_command += ' --no-merges' if options[:no_merge]
+
+        commits = `#{git_log_command}`
+        commits = commits.lines.reverse if options[:sort].casecmp('asc').zero?
+
         puts week_title.yellow
-        `git --no-pager log --after='#{git_date_format} 00:00' --before='#{git_date_format} 23:59' --pretty=format:'%s'`
+        puts commits
+        puts
       end
     end
   end

data/lib/weekly_commits/version.rb

@@ -1,3 +1,3 @@
 module WeeklyCommits
-  VERSION = "0.1.0"
+  VERSION = '1.2.1'.freeze
 end

data/weekly_commits.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'weekly_commits/version'
 
@@ -9,21 +8,22 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Dorian Karter']
   spec.email         = ['jobs@doriankarter.com']
 
-  spec.summary       = %q{List your commits on a project for every day of a specified week}
+  spec.summary       = 'List your commits on a project for every day of a specified week'
   spec.homepage      = 'http://doriankarter.com'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|screenshots)/}) }
   spec.bindir        = 'bin'
   spec.executables   = ['wcomm']
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', "~> 1.11"
-  spec.add_development_dependency 'rake', "~> 10.0"
-  spec.add_development_dependency 'rspec', "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 
   # runtime dependencies
   spec.add_runtime_dependency 'activesupport'
-  spec.add_runtime_dependency 'thor'
   spec.add_runtime_dependency 'colorize'
+  spec.add_runtime_dependency 'thor'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weekly_commits
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Dorian Karter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-28 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 2.1.4
+- !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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,6 +130,7 @@ files:
 - lib/weekly_commits/cli.rb
 - lib/weekly_commits/version.rb
 - weekly_commits.gemspec
+- weekly_commits.png
 homepage: http://doriankarter.com
 licenses:
 - MIT
@@ -135,8 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: List your commits on a project for every day of a specified week