detom 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27690f426f4574891be0599cf5316fd3f5c52af44f439e2a3a4081af034ae18a
-  data.tar.gz: 16f3a7bc52f572e97d77676b0aa0c4843308fbcda9aeedf923dd90124ab8d75a
+  metadata.gz: 82f9459a02a471b8cd6fe1168bda3f663cff518e300668c0e1f41f455ac66fa6
+  data.tar.gz: b5edb03876409bb6ba73d0ffd8c9d874a7efacd541487c93ba952b98584ce135
 SHA512:
-  metadata.gz: 7e760682f0d9b8ff4ec60c5d5aadf1ac9d4d9b5cc1f41942aa4411438f6206f0bd1d20a1b274850cc60c3b1220cb0ed95d08626c4ed39d9e8d9316e074356913
-  data.tar.gz: 54641b2f23fd77bf4647d7fe7251e2f9cd8b906a618e8548c36756539cf26d6f0fa7527a4a98463c863f2617685e396d8a1983d3f1f2527c9ef5663c98c98613
+  metadata.gz: 3bbcfcbde4995ea552c708d3cc161cfcf90189a9afe22162be9f85c6d0acb4f1bab64eec7ad41b1348501fe1e8798da655b2e6ef58ba585bd5260540a4262482
+  data.tar.gz: d32cf43ed5452561b4c93ae743ea6b5f11a3da04c40ff6ee09719981d327d74b45d1774fefcf705231cef8cfd95c8f06f055de7720d198c0213f2cf15eb8c907

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+tmp

data/README.markdown

@@ -1,7 +1,41 @@
-# detom
+# detom - A personal project
 
 _Combien de temps?_
 
 A minimal command line interface for tracking time spent against projects of clients.
 
 Time is manually logged in minutes or hours, either today or for a specified date.
+
+This project is a small, personal project that I don't expect anyone else to use seriously.
+If you do think this is something that you might use, please [let me know on Twitter](https://twitter.com/njpearman).
+
+Installation is as one would expect:
+
+```
+   gem install detom
+```
+
+## Motivation
+This is a toy project that allows me to practice a few different things:
+
+* Think about the design of command line apps.
+* Practice the topics covered in Build Awesome Command Line Applications in Ruby 2 by David Copeland, published by The Pragmatic Bookshelf but seemingly now out of print (which is a great shame because it's a great book)
+* Think about what's important when recording time spent on projects and clients.
+* Practice writing and testing Ruby code.
+
+## Commands
+
+For detailed instructions on commands, use `detom --help` and `detom <command> --help`.
+
+`detom clients`
+
+Lists all clients that have time recorded against them, and the total amount of time in minutes.
+
+`detom record`
+
+Allows an amount of time in minutes to be added to a client / project. Optionally can be set to a different date of the same year.
+
+## Commands to implement
+
+* `archive`
+* `mark`

data/bin/detom

@@ -34,15 +34,15 @@ class App
   end
 
   desc "Record some time spent on a client. <client> and <time> are required. <client> is the name of the client and <time> is an amount of time in minutes, e.g. 39m, or hours, e.g. 3h"
-  arg_name "<client> <time>"
+  arg_name "<time> <client>"
   command :record do |c|
     c.flag [:d, :"day-month"]
     c.action do |global_options, options, args|
-      help_now! "You must provide record with <client> and <time> as arguments" if args.length < 2
-
       begin
         store = YamlFileStore.new
-        Commands::Record.new(store).call args[0], args[1], options[:d]
+        local_config = Detom::LocalConfig.new
+        Commands::Record.new(store, local_config)
+          .call args[0], args[1], options[:d]
       rescue StandardError => e
         STDERR.puts e.message
         STDERR.puts e.backtrace
@@ -50,6 +50,23 @@ class App
     end
   end
 
+  desc "Sets a default client and project for the current folder, by creating or updating a .detom file. Run in the root of a project directory"
+  arg_name "<client> [project]"
+  command :set do |c|
+    c.action do |global_options, options, args|
+      Commands::Set.new.call args[0], args[1]
+    end
+  end
+
+  desc "Outputs time tracked against one client in detail."
+  arg_name "<client>"
+  command :client do |c|
+    c.action do |global_options, options, args|
+      store = YamlFileStore.new
+      Commands::Client.new(store).call args[0]
+    end
+  end
+
   desc "Archive tracking for a client or a project. Literally copies the client file into ~/.detom/archive/client-<today>.json"
   arg_name "client"
   command :archive do |c|

data/lib/detom.rb

@@ -1,8 +1,12 @@
 require "detom/version.rb"
 
 require "detom/yaml_file_store"
+require "detom/local_config"
+
+require "detom/commands/client"
 require "detom/commands/clients"
 require "detom/commands/record"
+require "detom/commands/set"
 
 # Add requires for other files you add to your project here, so
 # you just need to require this one file in your bin file

data/lib/detom/commands/client.rb

@@ -0,0 +1,38 @@
+module Commands
+  class Client
+    CLIENT_REQUIRED_MESSAGE = "You must provide a client name to detom client."
+
+    def initialize(store)
+      @store = store
+    end
+
+    def call(client_name)
+      raise CLIENT_REQUIRED_MESSAGE if client_name.nil? || client_name.empty?
+
+      client = @store[client_name]
+
+      if client
+        output = client.sort.map do |day, times|
+          "#{day}: #{format times}"
+        end.join "\n"
+        $stdout.puts output
+      else
+        $stdout.puts "No time logged against #{client_name}" 
+      end
+    end
+
+    private 
+    def format(times)
+      total_time = times.inject(0, &:+)
+
+      parts = []
+      hours = (total_time / 60).floor
+      parts << "#{hours}h" if hours > 0
+
+      minutes = total_time % 60
+      parts << "#{minutes}m" if minutes > 0
+
+      parts.join
+    end
+  end
+end

data/lib/detom/commands/record.rb

@@ -1,35 +1,55 @@
 module Commands
   class Record
-    def initialize(store)
+    CLIENT_REQUIRED_MESSAGE = "Cannot log time without a client. Either provide <client> to detom record, or configure a value for client in this directory using detom set."
+    DATE_FORMAT_MESSAGE = "Day/month is an unrecognised format. Use `%d-%m` format"
+    TIME_TO_LOG_FORMAT_MESSAGE = "Time must be provided in minutes or hours, e,g 40m or 3h"
+
+    def initialize(store, local_config)
       @store = store
+      @local_config = local_config
     end
 
-    def call(client_name, time_to_log, day_month = nil)
-      if day_month
-        raise "Day/month is an unrecognised format. Use `%d-%m` format" unless day_month =~ /\d\d-\d\d/
-
-        day = day_month.split("-").first
-        month = day_month.split("-").last
-        
-        # parse
-        day_month = [Time.now.year.to_s, month, day].join "-"
-      else
-        day_month = Time.now.strftime("%Y-%m-%d")
-      end
+    def call(time_to_log, client_name=nil, day_month=nil)
+      client = client_for client_name
+
+      date_stamp = format(day_month)
+  
+      client[date_stamp] = [] unless client[date_stamp]
+
+      client[date_stamp] << minutes_from(time_to_log)
+
+      @store.save!
+      $stdout.puts "Logged #{time_to_log} for #{client_name}"
+    end
+
+    private
+    def format(day_month)
+      return Time.now.strftime("%Y-%m-%d") if day_month.nil?
+
+      raise DATE_FORMAT_MESSAGE unless day_month =~ /\d\d-\d\d/
+
+      splits = day_month.split "-"
+      [Time.now.year.to_s,  splits.last, splits.first].join "-"
+    end
+
+    def client_for(client_name)
+      raise CLIENT_REQUIRED_MESSAGE if client_name.nil? && @local_config.client.nil?
+
+      client_name = client_name || @local_config.client 
 
       @store[client_name] = {} if @store[client_name].nil?
 
-      client = @store[client_name]
+      @store[client_name]
+    end
 
-      if client[day_month]
-        client[day_month] << time_to_log.to_i
-      else
-        client[day_month] = [ time_to_log.to_i ]
+    def minutes_from(time_to_log)
+      multiplier = case time_to_log
+        when /\d+m/ then 1
+        when /\d+h/ then 60
+        else raise TIME_TO_LOG_FORMAT_MESSAGE
       end
 
-      @store.save!
-      puts "Logged #{time_to_log} for #{client_name}"
+      multiplier * time_to_log.to_i
     end
   end
 end
-

data/lib/detom/commands/set.rb

@@ -0,0 +1,16 @@
+module Commands
+  class Set
+    def initialize(local_config=Detom::LocalConfig.new)
+      @local_config = local_config
+    end
+
+    def call(client, project=nil)
+      @local_config.load!
+
+      @local_config.client = client
+      @local_config.project = project
+
+      @local_config.save!
+    end
+  end
+end

data/lib/detom/local_config.rb

@@ -0,0 +1,54 @@
+require 'yaml'
+
+module Detom
+  class LocalConfig
+    def load!
+      return if @store
+
+      if Dir.exist? ".detom"
+        raise "Found .detom but it is a directory. Are you running `detom set` in your home directory?\n`detom set` should be run in the root of a project folder"
+      end
+
+      if File.exist? ".detom"
+        @store = YAML.load File.read(".detom")
+      else
+        @store = {}
+      end
+    end
+
+    def load_from!(config)
+      @store ||= {}
+      @store.merge! config
+    end
+
+    def save!
+      @store.keys.each {|key| @store.delete(key) if @store[key].nil? }
+
+      File.open(".detom", "w") {|file| file.write YAML.dump(@store) }
+      puts "New config: #{@store}"
+    end
+
+    def method_missing(name, *args, &block)
+      super unless handle?(name)
+
+      handle(name, *args)
+    end
+
+    private
+      def handle?(name)
+        %i(client client= project=).include? name
+      end
+
+      def handle(name, *args)
+        self.load!
+
+        setter_match = name.match /(.*)=\B/
+
+        if setter_match && setter_match[1]
+          @store[setter_match[1].to_sym] = args.shift
+        else
+          @store[name]
+        end
+      end
+  end
+end

data/lib/detom/version.rb

@@ -1,3 +1,3 @@
 module Detom
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/detom/commands/client_spec.rb

@@ -0,0 +1,69 @@
+require "detom/commands/client"
+
+describe Commands::Client do
+  describe "#call" do
+    subject { described_class.new(store).call(client_name) }
+
+    let(:store) { {} }
+    let(:today) { Time.now.strftime("%Y-%m-%d") }
+
+    context "with a nil client" do 
+      let(:client_name) { nil }
+      it do 
+        expect { subject }.to raise_error Commands::Client::CLIENT_REQUIRED_MESSAGE
+      end
+    end
+
+    context "with no client given" do 
+      let(:client_name) { "" }
+      it do 
+        expect { subject }.to raise_error Commands::Client::CLIENT_REQUIRED_MESSAGE
+      end
+    end
+
+    context "with a client that has no time logged" do
+      let(:client_name) { "foo_client" }
+      it do
+        expect { subject }.to output("No time logged against foo_client\n").to_stdout
+      end
+    end
+
+    context "with a client that has one entry today" do
+      let(:client_name) { "foo_client" }
+
+      let(:store) { { "foo_client" => { today => [50] } } }
+      it do
+        expected_output = <<OUT
+#{today}: 50m
+OUT
+        expect { subject }.to output(expected_output).to_stdout
+      end
+    end
+
+    context "with a client that has two entries today" do
+      let(:client_name) { "foo_client" }
+
+      let(:store) { { "foo_client" => { today => [50, 5] } } }
+      it do
+        expected_output = <<OUT
+#{today}: 55m
+OUT
+        expect { subject }.to output(expected_output).to_stdout
+      end
+    end
+
+    context "with a client that has two entries today and one in the past" do
+      let(:client_name) { "foo_client" }
+      let(:time_before) { (Time.now - (60*60*24*10)).strftime("%Y-%m-%d") }
+
+      let(:store) { { "foo_client" => { today => [50, 5], time_before => [130] } } }
+      it do
+        expected_output = <<OUT
+#{time_before}: 2h10m
+#{today}: 55m
+OUT
+        expect { subject }.to output(expected_output).to_stdout
+      end
+    end
+  end
+end

data/spec/detom/commands/record_spec.rb

@@ -2,8 +2,16 @@ require "detom/commands/record"
 require "detom/yaml_file_store"
 
 describe Commands::Record do
-  subject { described_class.new(store) }
+  subject { described_class.new(store, local_config) }
   let(:store) { YamlFileStore.new(test_filepath) }
+  let(:local_config) { Detom::LocalConfig.new }
+
+  before(:all) do
+    @the_stdout = $stdout
+    $stdout = File.open(File::NULL, 'w') 
+  end
+
+  after(:all) { $stdout = @the_stdout }
 
   describe "#call" do
     let(:test_filepath) { File.join(File.dirname(__FILE__), "..", "..", "..", "tmp", "record_test") }
@@ -13,22 +21,60 @@ describe Commands::Record do
     after { FileUtils.rm_rf test_filepath if Dir.exists? test_filepath }
 
     context "when recording time today" do
+      context "for project with a configured client" do
+        before { local_config.load_from! client: "faa" }
+
+        it do
+          subject.call("12m")
+          expect(store["faa"]).to eq({ today => [12] })
+        end
+
+        context "and explicitly providing a client" do
+          it do
+            subject.call("50m", "bloo")
+            expect(store["bloo"]).to eq({ today => [50] })
+            expect(store["faa"]).to be_nil
+          end
+        end
+      end
+
       context "once for one client" do
-        it "stores the time spent on the client" do
-          subject.call("foo_client", "6m")
-          expect(store["foo_client"]).to eq({ today => [6] })
-          expect(File.read(File.join(test_filepath, "foo_client"))).to eq <<-JSON
+        context "in minutes" do
+          it "stores the time spent on the client" do
+            subject.call("6m", "foo_client")
+            expect(store["foo_client"]).to eq({ today => [6] })
+            expect(File.read(File.join(test_filepath, "foo_client"))).to eq <<-JSON
 ---
 '#{today}':
 - 6
 JSON
+          end
+        end
+
+        context "in hours" do
+          it "stores the time spent on the client in minutes" do
+            subject.call("6h", "foo_client")
+            expect(store["foo_client"]).to eq({ today => [360] })
+            expect(File.read(File.join(test_filepath, "foo_client"))).to eq <<-JSON
+---
+'#{today}':
+- 360
+JSON
+          end
+        end
+
+        context "in an unrecognised format" do
+          it "raises an error" do
+            expect { subject.call("700s", "foo_client") }.to raise_error Commands::Record::TIME_TO_LOG_FORMAT_MESSAGE
+
+          end
         end
       end
 
       context "twice for one client" do
         it "stores the time spent on the client" do
-          subject.call("foo_client", "6m")
-          subject.call("foo_client", "39m")
+          subject.call("6m", "foo_client")
+          subject.call("39m", "foo_client")
           expect(store["foo_client"]).to eq({ today => [6, 39] })
           expect(File.read(File.join(test_filepath, "foo_client"))).to eq <<-JSON
 ---
@@ -41,9 +87,9 @@ JSON
 
       context "three times for one client" do
         it "stores the time spent on the client" do
-          subject.call("foo_client", "6m")
-          subject.call("foo_client", "39m")
-          expect { subject.call("foo_client", "92m") }.to output("Logged 92m for foo_client\n").to_stdout
+          subject.call("6m", "foo_client")
+          subject.call("39m", "foo_client")
+          expect { subject.call("92m", "foo_client") }.to output("Logged 92m for foo_client\n").to_stdout
           expect(store["foo_client"]).to eq({ today => [6, 39, 92] })
           expect(File.read(File.join(test_filepath, "foo_client"))).to eq <<-JSON
 ---
@@ -57,9 +103,9 @@ JSON
 
       context "once each for two clients" do
         it "stores the time spent on the clients" do
-          record_command = described_class.new(store)
-          record_command.call("foo_client", "6m")
-          record_command.call("raa_client", "39m")
+          record_command = described_class.new(store, local_config)
+          record_command.call("6m", "foo_client")
+          record_command.call("39m", "raa_client")
           expect(store["foo_client"]).to eq({ today => [6] })
           expect(store["raa_client"]).to eq({ today => [39] })
           expect(File.read(File.join(test_filepath, "foo_client"))).to eq <<-JSON
@@ -77,9 +123,9 @@ JSON
 
       context "once each for three clients" do
         it "stores the time spent on the clients" do
-          subject.call("foo_client", "6m")
-          subject.call("raa_client", "39m")
-          subject.call("gii_client", "72m")
+          subject.call("6m", "foo_client")
+          subject.call("39m", "raa_client")
+          subject.call("72m", "gii_client")
           expect(store["foo_client"]).to eq({ today => [6] })
           expect(File.read(File.join(test_filepath, "foo_client"))).to eq <<-JSON
 ---
@@ -108,7 +154,7 @@ JSON
 
       context "once for one client" do
         it "stores the time spent on the client" do
-          subject.call("foo_client", "6m", five_days_ago.strftime("%d-%m"))
+          subject.call("6m", "foo_client", five_days_ago.strftime("%d-%m"))
           expect(store["foo_client"]).to eq({ expected_formatted_date => [6] })
           expect(File.read(File.join(test_filepath, "foo_client"))).to eq <<-JSON
 ---
@@ -127,8 +173,8 @@ JSON
 
       context "once for one client" do
         it "stores the time spent on the client" do
-          subject.call("foo_client", "6m", five_days_ago.strftime("%d-%m"))
-          subject.call("foo_client", "45m", ten_days_ago.strftime("%d-%m"))
+          subject.call("6m", "foo_client", five_days_ago.strftime("%d-%m"))
+          subject.call("45m", "foo_client", ten_days_ago.strftime("%d-%m"))
           expect(store["foo_client"]).to eq({ expected_formatted_date_1 => [6], expected_formatted_date_2 => [45] })
           expect(File.read(File.join(test_filepath, "foo_client"))).to eq <<-JSON
 ---
@@ -150,7 +196,7 @@ JSON
       context "once for one client" do
         it "stores the time spent on the client" do
           File.open(File.join(test_filepath, "foo_client"), "w") {|f| f.write YAML.dump(expected_formatted_date_1 => [6]) }
-          subject.call("foo_client", "45m", ten_days_ago.strftime("%d-%m"))
+          subject.call("45m", "foo_client", ten_days_ago.strftime("%d-%m"))
           expect(store["foo_client"]).to eq({ expected_formatted_date_1 => [6], expected_formatted_date_2 => [45] })
           expect(File.read(File.join(test_filepath, "foo_client"))).to eq <<-JSON
 ---

data/spec/detom/local_config_spec.rb

@@ -0,0 +1,11 @@
+require "detom/local_config"
+
+describe Detom::LocalConfig do
+  describe "a dynamic setter" do
+    it do
+      config = described_class.new
+      config.client = "a value"
+      expect(config.client).to eq "a value"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -44,6 +44,12 @@ RSpec.configure do |config|
   # triggering implicit auto-inclusion in groups with matching metadata.
   config.shared_context_metadata_behavior = :apply_to_host_groups
 
+  config.order = :random
+
+  # Runs and outputs all assertions in a test regardless of failures.
+  config.define_derived_metadata do |meta|
+    meta[:aggregate_failures] = true
+  end
 # The settings below are suggested to provide a good initial experience
 # with RSpec, but feel free to customize to your heart's content.
 =begin

data/spec/system/record_spec.rb

@@ -0,0 +1,32 @@
+require "open3"
+
+describe "detom record" do
+  subject { Open3.capture3(command) }
+
+  let(:stdout) { subject[0] }
+  let(:stderr) { subject[1] }
+
+  before do
+    @original_dir = Dir.pwd
+    Dir.chdir File.join(File.dirname(__FILE__), "..", "..", "tmp")
+    %x(rm -rf .detom)
+  end
+
+  after do
+    Dir.chdir @original_dir
+  end
+
+  let(:command) { "bundle exec ../bin/detom record 90m" }
+  let(:expected_stdout) do
+    <<OUT
+Logged 90m for foofoo
+OUT
+  end
+
+  it do
+    %x(bundle exec ../bin/detom set foofoo)
+
+    expect(stdout).to eq expected_stdout
+    expect(stderr).to eq ""
+  end
+end

data/spec/system/set_spec.rb

@@ -0,0 +1,91 @@
+require "open3"
+
+describe "detom set" do
+  subject { Open3.capture3(command) }
+
+  let(:stdout) { subject[0] }
+  let(:stderr) { subject[1] }
+
+  before do
+    @original_dir = Dir.pwd
+    Dir.chdir File.join(File.dirname(__FILE__), "..", "..", "tmp")
+    %x(rm -rf .detom)
+  end
+
+  after do
+    Dir.chdir @original_dir
+  end
+
+  context "when no args are provided" do
+    let(:command) { "bundle exec ../bin/detom set" }
+    let(:expected_stderr) do 
+      <<ERR
+error: Found .detom but it is a directory. Are you running `detom set` in your home directory?
+`detom set` should be run in the root of a project folder
+ERR
+end
+
+    before { %x(mkdir .detom) }
+
+    it do
+      expect(stderr).to eq expected_stderr
+      expect(Dir.exist? ".detom").to be_truthy
+    end
+  end
+
+  context "when a client is provided" do
+    let(:command) { "bundle exec ../bin/detom set foo" }
+    let(:expected_stdout) do
+<<OUT
+New config: {:client=>"foo"}
+OUT
+    end
+
+    it do
+      expect(stdout).to eq expected_stdout
+      expect(File.exist? ".detom").to be_truthy
+    end
+
+    context "and config already exists" do
+      before { %x(bundle exec ../bin/detom set faa) }
+      let(:expected_stdout) do
+  <<OUT
+New config: {:client=>"foo"}
+OUT
+      end
+
+      it do
+        expect(stdout).to eq expected_stdout
+        expect(File.exist? ".detom").to be_truthy
+      end
+    end
+  end
+
+  context "when a client and project are provided" do
+    let(:command) { "bundle exec ../bin/detom set foo project_tree" }
+    let(:expected_stdout) do
+<<OUT
+New config: {:client=>"foo", :project=>"project_tree"}
+OUT
+    end
+
+    it do
+      expect(stdout).to eq expected_stdout
+      expect(File.exist? ".detom").to be_truthy
+    end
+
+    context "and config already exists" do
+      before { %x(bundle exec ../bin/detom set faa) }
+      let(:expected_stdout) do
+  <<OUT
+New config: {:client=>"foo", :project=>"project_tree"}
+OUT
+      end
+
+      it do
+        expect(stdout).to eq expected_stdout
+        expect(File.exist? ".detom").to be_truthy
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: detom
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - NJ Pearman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -75,6 +75,7 @@ extra_rdoc_files:
 - README.rdoc
 - detom.rdoc
 files:
+- ".gitignore"
 - ".rspec"
 - Gemfile
 - Gemfile.lock
@@ -85,13 +86,20 @@ files:
 - detom.gemspec
 - detom.rdoc
 - lib/detom.rb
+- lib/detom/commands/client.rb
 - lib/detom/commands/clients.rb
 - lib/detom/commands/record.rb
+- lib/detom/commands/set.rb
+- lib/detom/local_config.rb
 - lib/detom/version.rb
 - lib/detom/yaml_file_store.rb
+- spec/detom/commands/client_spec.rb
 - spec/detom/commands/clients_spec.rb
 - spec/detom/commands/record_spec.rb
+- spec/detom/local_config_spec.rb
 - spec/spec_helper.rb
+- spec/system/record_spec.rb
+- spec/system/set_spec.rb
 - tmp/record_test.json
 homepage: https://github.com/njpearman/detom
 licenses: []