weekly_commits 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 032be9fd7bb56b8cd2f6480be35b329a60da4fb1
-  data.tar.gz: 6a73cc53bbe888c084950d2ac06215cf33ddf750
+  metadata.gz: 0955dfe06bad6f30979c30a6661a34b82ed329fb
+  data.tar.gz: adf8ec863ffa1c29c0459797406f468f277a9af6
 SHA512:
-  metadata.gz: b305fe4c67db86e642c70abbedfe1bd011b4ed9e4a13e06f2ee3c166bda86648b921026c8f279f4942d18f64761cc653be3947be90e433201736dc9fe6d81de7
-  data.tar.gz: 61640142bca5fff7a0ceb520d60258799673efbe2611f7fb0101cf0d5b23079f712bf144439e8d257edb448b161ac7584f822ccc30135b54d41f6fee83acd0e5
+  metadata.gz: f032558c8483599a78b08bb0a1791cfbea39849699d6995910d481a65908c66eb3d921220fb4284f6b341b4977c8fdd61b07f5abd5568090b1c8ccfbb2c2b7d3
+  data.tar.gz: 5952f50f68669a6ff9a3c32f918660da1fd104ca6b486c5a94f9b4aa5ab2730f09124dca7625e96651a9712bd3c4f8e6753cb4738a0df6cd1f7df59348d7d201

data/README.md

@@ -1,13 +1,13 @@
 # WeeklyCommits
 
-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.
+WeeklyCommits is a command line tool for getting a bird's eye view of your
+commits on a branch for a specific week.
 
-TODO: Delete this and the text above, and describe your gem
+It is particularly helpful for stand ups, filling up detailed time sheets and
+for recap when starting up again after a long weekend.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
 ```ruby
 gem 'weekly_commits'
 ```
@@ -22,20 +22,76 @@ 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-committer], [--no-show-committer]  # Display committer with each commit message. e.g. Did stuff (Dorian Karter)
+      [--sort=SORT]                              # Show commits in ascending/descending order. Default: older commits on top, newer on bottom.
+                                                 # Default: desc
+                                                 # Possible values: asc, desc
+```
+
+### Example
+
+First navigate to a repo and make sure you have the WeeklyCommits gem installed
+for that version of ruby in that directory.
+
+Show me this week's commits:
+
+```sh
+wcomm
+```
+
+Show me last weeks commits:
+
+```sh
+wcomm -w=1
+```
+
+Show me commits from two weeks ago including committer
+
+```sh
+wcomm -w=2 --show-committer
+```
 
 ## Development
 
-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.
+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.
+
+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).
+
+## 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 multiple branches
 
 ## 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/lib/weekly_commits/cli.rb

@@ -7,13 +7,27 @@ module WeeklyCommits
     package_name 'Weekly Commits'
     default_task :weekly_commits
 
-    desc 'weekly_commits', 'Lists commits for a specified week'
+    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
+      default: 0,
     }
+
+    method_option :show_committer, {
+      type: :boolean,
+      desc: 'Display committer with each commit message. e.g. Did stuff (Dorian Karter)',
+      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: ['asc','desc'],
+    }
+
     def weekly_commits
       relative_week = options[:week]
       beg_week = relative_week.week.ago.beginning_of_week
@@ -22,8 +36,11 @@ module WeeklyCommits
         date = beg_week + day_count.days
         week_title = date.strftime('%a, %e %b %Y')
         git_date_format = date.strftime('%Y-%m-%e')
+        committer = options[:show_committer] ? ' (%cn)' : ''
+
+        commits = `git --no-pager log --after='#{git_date_format} 00:00' --before='#{git_date_format} 23:59' --pretty=format:'%s#{committer}'`
 
-        commits = `git --no-pager log --after='#{git_date_format} 00:00' --before='#{git_date_format} 23:59' --pretty=format:'%s'`
+        commits = commits.lines.reverse if options[:sort].downcase == 'asc'
 
         puts week_title.yellow
         puts commits

data/lib/weekly_commits/version.rb

@@ -1,3 +1,3 @@
 module WeeklyCommits
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/weekly_commits.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   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 'pry'
 
   # runtime dependencies
   spec.add_runtime_dependency 'activesupport'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weekly_commits
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Dorian Karter
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.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: activesupport
   requirement: !ruby/object:Gem::Requirement