logbook-cli 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: faa1289d6a90350ba14ebc5385fa377241f7d1b8
-  data.tar.gz: f3efd0bc44b39eab2e7df5e7375520e53cbabab1
+  metadata.gz: 8471149dad881c6f580faebec08b44da16699507
+  data.tar.gz: 1951dea527c3070db56d2d3d25b828e81d7ab6b9
 SHA512:
-  metadata.gz: 25f46d61436a7ad23fd606edee2e2c758a9dca73926064a33df3798d16fbc535bc40e7813e356bd635e27ef9a8b8a20f0f4ca7002c7f4640b16eded1cd720267
-  data.tar.gz: 0b9f81ce4b70456f3d64da03fbbb4de5d248484c4e9d114d2118cbddda58a8c4fe0a9075896fd8400c7db275547f317497e4f03e919196713b3b9b60d0efdec6
+  metadata.gz: 1b0411a27cc0024f4650c7b9b7cd956601c5b58a18bf73c58a140263d09b7996488a9f47ddaf22a7e847711fddd141a5f7562bd8a0595ff9c42ae08d7d8c8294
+  data.tar.gz: 50cc7461cc9437059a31ee43ade706bb6044a7f36ff3f1986fb1cc804d0e35ef80e4061eb2d12f5c4779483016a3dd300b4a1ae0c004beacfa296838d790578e

data/README.md

@@ -1,35 +1,57 @@
-# Logbook
+# logbook-cli
 
-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/logbook`. To experiment with that code, run `bin/console` for an interactive prompt.
+`logbook-cli` is a Ruby gem providing the `logbook` executable which offers
+various commands to process logbook files.
 
-TODO: Delete this and the text above, and describe your gem
+## On Logbooks
+
+Logbooks are plain text files used to capture thoughts and activities as they
+occur throughout the day without interrupting flow as much as possible.
+
+The rather minimalistic syntax is optimized for readability and quick editing
+without the need for anything fancier than a good text editor.
+
+To find out more about logbooks and the logbook file format, check out the
+documentation of [the vim plugin](https://github.com/logbooksh/vim-logbook).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+`logbook-cli` is packaged as a Ruby gem and requires Ruby 2.4+.
 
-```ruby
-gem 'logbook'
+```console
+$ gem install logbook-cli
 ```
 
-And then execute:
+## Usage
 
-    $ bundle
+Once installed, you have access to the `logbook` executable:
 
-Or install it yourself as:
+```console
+$ logbook
+logbook stats <file>...
+```
 
-    $ gem install logbook
+### stats
 
-## Usage
+The `stats` command reads from one or more files and prints out the amount of
+time logged in each file:
 
-TODO: Write usage instructions here
+```console
+$ logbook stats *.logbook
+2018-01-18.logbook: 1h47min
+2018-01-19.logbook: 2h28min
+2018-01-20.logbook: 2h54min
+2018-01-21.logbook: 2h48min
+2018-01-22.logbook: 1h24min
+```
 
-## Development
+## Changelog
 
-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.
+### 0.1
 
-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 `stats` command showing the number of hours logged in a given file
 
-## Contributing
+## License
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/logbook.
+`logbook-cli` is licensed under the Apache License 2.0.
+See [`LICENSE`](LICENSE) for more information.

data/exe/logbook

@@ -1,15 +1,25 @@
 #!/usr/bin/env ruby
 
-require "logbook/cli"
+require "optparse"
+require_relative "../lib/logbook/cli"
 
 USAGE = <<~DOC
 logbook stats <file>...
 DOC
 
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{USAGE}"
+
+  opts.on("--per-task", "Determine duration of each task in the file") do
+    options[:per_task] = true
+  end
+end.parse!
+
 case ARGV.shift
 when "stats"
   paths = ARGV.map { |path| File.expand_path(path) }
-  Logbook::CLI::App.stats(paths)
+  Logbook::CLI::App.stats(paths, options)
 else
   puts USAGE
 end

data/lib/logbook/cli.rb

@@ -2,7 +2,7 @@ require "logbook"
 
 module Logbook
   module CLI
-    require "logbook/cli/app"
-    require "logbook/cli/version"
+    require_relative "cli/app"
+    require_relative "cli/version"
   end
 end

data/lib/logbook/cli/app.rb

@@ -1,6 +1,13 @@
 module Logbook::CLI
   class App
-    def self.stats(paths)
+    def initialize
+    end
+
+    def self.stats(paths, options = {})
+      new.stats(paths, options)
+    end
+
+    def stats(paths, options)
       return if paths.empty?
 
       paths.select { |path| File.file?(path) }.each do |path|
@@ -8,14 +15,37 @@ module Logbook::CLI
         contents = File.read(path)
 
         if page = Logbook::Builder.build(contents)
-          duration = page.total_duration.minutes.to_i
+          total_duration = page.logged_time.minutes.to_i
+          next unless total_duration > 0
+
+          puts "#{name}: #{format_duration(total_duration)}"
 
-          hours = duration / 60
-          minutes = duration % 60
+          if options[:per_task]
+            page.tasks.each do |_, task|
+              task_duration = task.time_logged.minutes.to_i
+              next unless task_duration > 0
 
-          puts "#{name}: #{hours}h#{minutes}min"
+              puts " " * (name.length + 1) + " #{task.title}: #{format_duration(task_duration)}"
+            end
+          end
         end
       end
     end
+
+    private
+    def format_duration(duration)
+      hours = duration / 60
+      minutes = duration % 60
+
+      if duration == 0
+        "0"
+      elsif minutes == 0
+        "#{hours}h"
+      elsif hours == 0
+        "#{minutes} min"
+      else
+        "#{hours} h #{minutes} min"
+      end
+    end
   end
 end

data/lib/logbook/cli/version.rb

@@ -1,5 +1,5 @@
 module Logbook
   module CLI
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logbook-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Gabriel Malkas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler