topicz 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4caae007666aa94548df6d36d511bfeac735caa3
-  data.tar.gz: ae3b2c30457618799327904ffb2ddd40a52261ba
+  metadata.gz: 844f63d69cda9f2348e86b1065278ee4c8e52c8c
+  data.tar.gz: a298c668f262047f91195c815902c17ad8427fa3
 SHA512:
-  metadata.gz: db1be6990fe23b2f6258d5d1198ba2c7c3e02564d947321a882973ef5dd5bdd3d8516054db89e71a787c01d77ca6f11bfc800cde06f0aff46697b132eb6bf2e9
-  data.tar.gz: 0c163f2d68371b7d28f4816bfceb744b1e5cee105ffd891b48a809f434fb1732928c32ea1cd9931031b061a8c333584bbfc56b80c0dee856e59f943e4b35a186
+  metadata.gz: ebcb89858126e21bbae8db0694d958c94031824196bfb6c0e883a92ed6e5cd23127d0f66279f985e1c93b502c399b10977946f56c9c726ffaa0b8f56c828fdf8
+  data.tar.gz: 9983d8ce2d7340f2fa93c0bc89b49bbd8d27ed5a1249dcd0c06b7dafdfd04dd6d036c0a7eae962b224637a64b8ba6ceef72fb12e8fcb35349aacf23a8872d6c2

data/README.md

@@ -20,11 +20,13 @@ See below (*Development*) in case you’re working with a Git clone directly.
 
       init   : Initializes a new topic repository
       create : Creates a new topic
+      list   : List topics
       path   : Prints the full path to a topic
       journal: Opens a (new) weekly journal entry for a topic
       note   : Opens a new note for a topic
-      alfred : Searches in Alfred Script Filter format
+      stats  : Generates weekly statistics across all topics
       report : Generates a weekly report of all topics
+      alfred : Searches in Alfred Script Filter format
       help   : Shows help about a command
 
 ## Background
@@ -56,7 +58,7 @@ A topic can certainly have other subdirectories than the ones shown above. These
 
 ### Documents and Reference Material
 
-The `Documents` and `Reference Material` directories speak for themselves. The first is for stuff I create, the second for stuff that others create. There are no rules as to the files and subdirectories in these directories, although I tend to prefix each filename with the date I created or received the file in `YYYY-mm-DD` format. But that’s just my way of keeping things organized.
+The `Documents` and `Reference Material` directories speak for themselves. The first is for stuff I create, the second for stuff that others create. Files and subdirectories in these directories must have filenames that are prefixed with the date in `YYYY-mm-DD`. That keeps the files in the right order, and it makes the files show up in the `stats` command.
 
 ### Journal
 
@@ -101,7 +103,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Plans
 
-* Allow topics to be archived when no longer relevant.
+* Allow topics to be archived and unarchived when no longer relevant.
 * Allow relationships between topics to be defined in the YAML files, and use these to generate graphs for Graphviz: `depends-on`, `part-of`, `relates-to`. The CLI will help to guarantee correctness, for example when archiving a topic, or when renaming one’s title and/or ID.
 * Allow metadata to be defined for each topic, like main stakeholders, categories and topic goals.
 

data/lib/topicz/commands/_index.rb

@@ -7,8 +7,9 @@ module Topicz
       'path'    => 'Prints the full path to a topic',
       'journal' => 'Opens a (new) weekly journal entry for a topic',
       'note'    => 'Opens a new note for a topic',
-      'alfred'  => 'Searches in Alfred Script Filter format',
+      'stats'   => 'Generates weekly statistics across all topics',
       'report'  => 'Generates a weekly report of all topics',
+      'alfred'  => 'Searches in Alfred Script Filter format',
       'help'    => 'Shows help about a command',
   }
 

data/lib/topicz/commands/report_command.rb

@@ -1,5 +1,4 @@
 require_relative 'repository_command'
-require 'json'
 
 module Topicz::Commands
 
@@ -10,7 +9,6 @@ module Topicz::Commands
       @week = Date.today.cweek
       @year = Date.today.cwyear
       option_parser.order! arguments
-      @filter = arguments.join ' '
     end
 
     def option_parser
@@ -23,7 +21,7 @@ module Topicz::Commands
           @year = year.to_i
         end
         options.separator ''
-        options.separator 'Generates a weekly report from all journals across all topics.'
+        options.separator 'Generates a weekly report from all journals across all topics in a single Markdown file.'
       end
     end
 

data/lib/topicz/commands/stats_command.rb

@@ -0,0 +1,61 @@
+require_relative 'repository_command'
+
+module Topicz::Commands
+
+  class StatsCommand < RepositoryCommand
+
+    def initialize(config_file = nil, arguments = [])
+      super(config_file)
+      @week = Date.today.cweek
+      @year = Date.today.cwyear
+      option_parser.order! arguments
+    end
+
+    def option_parser
+      OptionParser.new do |options|
+        options.banner = 'Usage: stats'
+        options.on('-w', '--week WEEK', 'Use week WEEK instead of the current week') do |week|
+          @week = week.to_i
+        end
+        options.on('-y', '--year YEAR', 'Use year YEAR instead of the current year') do |year|
+          @year = year.to_i
+        end
+        options.separator ''
+        options.separator 'Generates weekly statistics across all topics.'
+        options.separator ''
+        options.separator 'This command reports on all Documents, Notes and Reference Material across all topics.'
+        options.separator 'Contrary to what you might think, this command does NOT look at file timestamps!'
+        options.separator 'Instead it expects each filename to start with a date in yyyy-mm-dd format.'
+      end
+    end
+
+    def execute
+      date = Date.commercial(@year, @week)
+      first = date.strftime('%Y-%m-%d')
+      last = (date + 7).strftime('%Y-%m-%d')
+
+      output = []
+      @repository.topics.each do |topic|
+        stats = find_files(topic, first, last)
+        next if stats.empty?
+        item = "#{topic.title}\n"
+        stats.each {|path| item += "* #{path}\n"}
+        output << item
+      end
+
+      puts output.join("\n") unless output.empty?
+    end
+
+    GLOB_PATTERN = File.join("{#{Topicz::DIR_NOTES},#{Topicz::DIR_DOCUMENTS},#{Topicz::DIR_REFERENCE}}", '*')
+
+    def find_files(topic, first, last)
+      Dir.chdir(topic.fullpath) do
+        Dir.glob(GLOB_PATTERN).select do |path|
+          file = File.basename(path)
+          file >= first && file < last
+        end.sort
+      end
+    end
+
+  end
+end

data/lib/topicz/version.rb

@@ -1,3 +1,3 @@
 module Topicz
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: topicz
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Vincent Oostindië
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-01 00:00:00.000000000 Z
+date: 2016-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zaru
@@ -128,6 +128,7 @@ files:
 - lib/topicz/commands/path_command.rb
 - lib/topicz/commands/report_command.rb
 - lib/topicz/commands/repository_command.rb
+- lib/topicz/commands/stats_command.rb
 - lib/topicz/defaults.rb
 - lib/topicz/repository.rb
 - lib/topicz/version.rb