crusoe 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4a32192daf5b633da6ab3d4b914f79c1a76c08e48f22651656c65b4c63321ce
-  data.tar.gz: 83af5b4c5f515d1ca57fb24bddf6d0e49b01c90d68e62cd09a12b2d19344eed7
+  metadata.gz: ab82f877cbeec3310704961cf66b8563632263e18a1bb827273e9387edfae31e
+  data.tar.gz: 2b01f8406c25d12e0e8bd2685ccf2753508066e36bef7adff06f82a123016aa7
 SHA512:
-  metadata.gz: f721eb5652b8232650348c78a5a1e0285da99c6584bb48b8ff850c72c135b53041fbdf58790bfa4539583410a20f4b6e543dd505629035cf7788b5dfba6463c8
-  data.tar.gz: 43afa28420513bba378085b33313ad997d9203430baaca25c025fd5499861d981447bc7e80a0447f48662aa46b41451ebae62573d011324d8bc80dc92a952f4b
+  metadata.gz: f1183a6b331ceab966bcf2af06e5367502cc599923ece7874b81561d7a54a82638695ac370336e7d350fc8814dd35e3a46bb1194272690a8afa833b69bbf8283
+  data.tar.gz: 37a8e6da079c79f4b1ac86b93277769e246ecc0cb979c84e6b413f483b02680452ee28bbdb4069d27775ab8e6b6d0e671280d4ddc6fff726d2dd533e487380ac

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crusoe (0.1.0)
+    crusoe (0.2.0)
       git
       thor
       yaml

data/README.md

@@ -1,24 +1,51 @@
 # Crusoe
 
-TODO: Delete this and the text below, and describe your gem
-
-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/crusoe`. To experiment with that code, run `bin/console` for an interactive prompt.
+A simple daily work journal from your command-line 
+
+```
+# Open today's journal and add to it
+$ crusoe
+```
+
+```
+crusoe help
+Commands:
+  crusoe help [COMMAND]  # Describe available commands or one specific command
+  crusoe journal         # This is the default task.
+  crusoe read            # Read an entry
+  crusoe report          # Generate a report for the last week
+  crusoe toc             # Update the ToC on the README.md
+```
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+```
+gem install crusoe
+```
+
+## Feature list
+
+### Write to journal 
+
+#### `crusoe journal ✅` 
+
+- Write a single journal entry for given day (defaults to today)
+- Automatically saves to git repo configured by you
+- Default command for `crusoe`
+- Can provide an optional `--date` value (e.g. one of `"today"`, `"yesterday"`, `"2023-12-25"`)
 
-Install the gem and add to the application's Gemfile by executing:
+#### `crusoe read ✅`
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+- Read a single journal entry for given day (defaults to today)
+- Can provide an optional `--date` value (e.g. one of `"today"`, `"yesterday"`, `"2023-12-25"`)
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+#### `crusoe report ✅`
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+- Print the entries from the current week
 
-## Usage
+#### Organise journal in the README 🏗
 
-TODO: Write usage instructions here
+- WIP: Keep an up-to-date index of all entries in the README
 
 ## Development
 
@@ -28,7 +55,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/crusoe.
+Bug reports and pull requests are welcome on GitHub at https://github.com/bodacious/crusoe.
 
 ## License
 

data/lib/crusoe/cli.rb

@@ -85,6 +85,8 @@ module Crusoe
     end
 
     def update_remote_repo
+      return if Commands::Git::Status.new(directory: configuration.entries_directory_path).empty?
+
       Commands::Git::Add.new(directory: configuration.entries_directory_path).all
       Commands::Git::Commit.new(directory: configuration.entries_directory_path).commit!
       Commands::Git::Push.new(directory: configuration.entries_directory_path).main

data/lib/crusoe/commands/git/status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Crusoe
+  module Commands
+    module Git
+      class Status < GitCommand
+        def empty?
+          # TODO: Clean this up
+          git_client.status.changed.empty?
+        end
+      end
+    end
+  end
+end

data/lib/crusoe/commands/git.rb

@@ -6,6 +6,7 @@ module Crusoe
       require_relative "git/commit"
       require_relative "git/pull"
       require_relative "git/push"
+      require_relative "git/status"
     end
   end
 end

data/lib/crusoe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Crusoe
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crusoe
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gavin Morrice
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2024-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -84,6 +84,7 @@ files:
 - lib/crusoe/commands/git/pull.rb
 - lib/crusoe/commands/git/push.rb
 - lib/crusoe/commands/git/remote_git_command.rb
+- lib/crusoe/commands/git/status.rb
 - lib/crusoe/commands/journal.rb
 - lib/crusoe/commands/read.rb
 - lib/crusoe/configuration.rb
@@ -118,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: A journaling tool for developers.