daily_log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8c783c694e311e44ea889b3035e718ae46073bec77e1491d90d907e0c4b1552e
+  data.tar.gz: 01c0fabb78e929c5ada6832fcf436f590849000cfbc7d024e4f09385ff961026
+SHA512:
+  metadata.gz: 61039bd2ba30f414c70ce8019c6fead05fb3b78aa3d43ecccdd4d6e4975b4d2631bc4e687ce6e0db5bb1409653fb3d6390e48ea4355bf6e7ed3b58b7c23fad48
+  data.tar.gz: 5bc29134cfa37afeb9f664896e0cb9f0c01015747e9e8464100666681d76253c7b6ac808be393ce5ce99a44f518071577813ca2992f2e871c14952ba99b8b0fe

data/.byebug_history

@@ -0,0 +1,8 @@
+continue
+exit
+ecit
+_defaults[:edit] == Date.today
+_defaults[:edit]  = (_defaults[:edit] == Date.today)
+_defaults[:edit]  = _defaults[:edit] == Date.today
+_defaults[:date] == Date.today
+_defaults

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.daily_logs

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :development do
+
+  gem "yard-tomdoc"
+
+  gem "rake"
+
+  gem "irb", "~> 1.2"
+
+  gem "rspec", "~> 3.9"
+
+  gem "byebug"
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    daily_log (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    diff-lcs (1.3)
+    io-console (0.5.4)
+    irb (1.2.1)
+      reline (>= 0.0.1)
+    rake (13.0.1)
+    reline (0.1.2)
+      io-console (~> 0.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    tomparse (0.4.2)
+    yard (0.9.23)
+    yard-tomdoc (0.7.1)
+      tomparse (>= 0.4.0)
+      yard
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  byebug
+  daily_log!
+  irb (~> 1.2)
+  rake
+  rspec (~> 3.9)
+  yard-tomdoc
+
+BUNDLED WITH
+   1.17.3

data/History.md

@@ -0,0 +1,12 @@
+
+n.n.n / 2020-01-07
+==================
+
+  * Bundle as Rubygem
+  * Update README
+  * Remove YARD files from git repo
+  * Added documentation
+  * Remove .daily_logs from gitignore
+  * Basic working version up and running
+  * Basic text-file is opening
+  * Initial commit

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Bodacious
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# DailyLog
+
+Provides a simple framework for keeping a daily log of the work you do on a project
+
+## Usage
+
+Call the binary `daily_log` to open today's log.
+
+Pass in the option `--help` to see the other options available.
+
+## Installation
+
+``` bash
+cd /usr/local
+git clone https://github.com/KatanaCode/daily_log.git
+alias /usr/local/bin/daily_log /usr/local/daily_log/bin/daily_log
+```
+
+## Example
+
+At the end of a working day, you run from your console
+
+``` bash
+$ daily_log
+```
+
+This opens a text file in your editor that looks like this:
+
+``` text
+# Daily Entry - Wed 01 January, 2020
+
+## Today I worked on:
+
+- Thing one
+
+## Next time, you should continue with:
+
+- Thing two
+
+## Notes:
+
+Some optional notes here...
+
+<!--
+  Automatically generated by DailyLog https://github.com/KatanaCode/daily_log
+  Date: 2020-01-01
+  Project: dailylog
+  By: Yourname
+-->
+```
+
+You edit the file to say:
+
+``` text
+# Daily Entry - Wed 01 January, 2020
+
+## Today I worked on:
+
+- Adding two-factor authentication for admins
+
+## Next time, you should continue with:
+
+- Password management for admins
+
+## Notes:
+
+We need to rethink how we handle password resets when user has 2FA enabled
+
+<!--
+  Automatically generated by DailyLog https://github.com/KatanaCode/daily_log
+  Date: 2020-01-01
+  Project: dailylog
+  By: Yourname
+-->
+```
+
+### A few days later
+
+Some time has passed since you last worked on the project. You aren't quite sure where to pick up from the last time you worked on it.
+
+You type:
+
+```
+$ daily_log -l # short for daily_log --last
+```
+
+...to print out your log to the console.
+
+## Why bother?
+
+Managing a log file like this can help you keep your train of thought when interrupted on a project for a few days or longer.
+
+This is a simple, non-invasive way to leave notes to your future self.
+
+It's also a great way to take full stock of a project once it's complete. Were your time estimates as accurate as you thought they would be?

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+load "lib/tasks/doc.rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "daily_log"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/daily_log.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "daily_log/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "daily_log"
+  spec.version       = DailyLog::VERSION
+  spec.authors       = ["Bodacious"]
+  spec.email         = ["bodacious@katanacode.com"]
+
+  spec.summary       = %q{Daily code journal on a per project basis}
+  spec.description   = %q{Keep a short, daily log of the work you do within a project repo}
+  spec.homepage      = "https://github.com/KatanaCode/daily_log"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/exe/dl

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+
+require "daily_log"
+
+DailyLog::ScmCheck.new.perform!
+DailyLog.open_or_print(DailyLog::Options.new.to_hash)

data/lib/daily_log.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DailyLog
+
+  require_relative "daily_log/options"
+  require_relative "daily_log/latest_date"
+  require_relative "daily_log/scm_check"
+  require_relative "daily_log/day"
+  require_relative "daily_log/entry"
+  require_relative "daily_log/pathname"
+
+  module_function
+
+  # Open or print the Entry file, depending on the options
+  def open_or_print(options = {})
+    @day   = Day.new(options[:date])
+    @entry = Entry.new(@day)
+    puts @entry.pathname if options[:path]
+    @entry.print if options[:print]
+    @entry.open  if options[:edit]
+  end
+
+end

data/lib/daily_log/day.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module DailyLog
+
+  # Represents one calendar Day
+  class Day
+
+    ##
+    # Format for dates when printed as stringss
+    DATE_FORMAT  = "%Y-%m-%d"
+
+    ##
+    # The Date object for this Day
+    attr_reader :date
+
+    ##
+    # Create a new day
+    #
+    # date - A valid Date object
+    def initialize(date)
+      @date = date
+    end
+
+    # Is this Day today's calendar Date?
+    #
+    # Returns Boolean
+    def today?
+      @date == Date.today
+    end
+
+    # Print the date as a formatted string
+    #
+    # Returns String
+    def to_s
+      date.strftime(DATE_FORMAT)
+    end
+
+  end
+end

data/lib/daily_log/entry.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module DailyLog
+  # One Daily Log journal Entry
+  #
+  class Entry
+    require 'erb'
+    require "fileutils"
+
+    ##
+    # The Day this Entry is for
+    attr_reader :day
+
+    ##
+    # The Pathname of the file to the Entry
+    attr_reader :pathname
+
+
+    ##
+    # Default path for the daily entry Markdown template
+    TEMPLATE_PATH = File.join(File.dirname(__FILE__), '..', '..',
+                              'lib/templates/daily_log/entry.md.erb')
+
+
+    # Create a new Entry
+    #
+    # day - The Day we're creating a new Entry for
+    def initialize(day)
+      @day = day
+      @pathname = Pathname.new(day.date)
+    end
+
+    # Print the contents of this Entry to STDOUT. If no entry exists, print a
+    # warning.
+    def print
+      if exists?
+        puts file.read
+      else
+        puts "No file exists for date: #{@day}"
+      end
+    end
+
+    # Open the Entry file in the text editor. If one doens't already exist,
+    # create it for this Day
+    def open
+      ensure!
+      open_in_editor
+    end
+
+    private
+
+    def open_in_editor
+      exec("$EDITOR -w #{pathname}")
+    end
+
+    def file
+      @file ||= File.open(pathname, 'r')
+    end
+
+    def local_template_path
+      "./#{Pathname.dirname}/templates.md.erb"
+    end
+
+    def template_path
+      if local_template_exists?
+        local_template_path
+      else
+        TEMPLATE_PATH
+      end
+    end
+
+    def local_template_exists?
+      File.exist?(local_template_path)
+    end
+
+    def exists?
+      File.exist?(pathname)
+    end
+
+    def ensure!
+      return if exists?
+      FileUtils.mkdir_p(pathname.dirname)
+      template = ERB.new File.read(template_path)
+      File.open(pathname.to_s, "wb") do |file|
+        file.write template.result(binding)
+      end
+    end
+  end
+end

data/lib/daily_log/latest_date.rb

@@ -0,0 +1,46 @@
+module DailyLog
+
+  # Finds the latest past Date that we have an Entry for in the local filesystem
+  class LatestDate
+
+    ##
+    # Match a file path to extract a date component
+    DATE_PATH_MATCHER = /(?<year>\d{4})\/(?<month>\d{2})\/(?<day>\d{2})/
+
+    # The latest entry in the local file system
+    #
+    # Returns Date
+    # Returns nil
+    def find
+      return nil unless entry_paths.any?
+      past_entries = entry_paths.map do |path|
+        match = path.match(DATE_PATH_MATCHER)
+        Date.parse(match.to_s)
+      end.select { |date| date < today }
+
+      past_entries.last
+    end
+
+    # Convert the Date to a String
+    # Returns String
+    def to_s
+      find.to_s.strftime(Day::DATE_FORMAT)
+    end
+
+    # Return the Date as a Date object
+    def to_date
+      find
+    end
+
+    private
+
+    def today
+      @today = Date.today
+    end
+
+    def entry_paths
+      Dir[File.join(Pathname.dirname, "**", "*.md")].sort
+    end
+
+  end
+end

data/lib/daily_log/options.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module DailyLog
+  class Options
+    require "optparse"
+    require "optparse/date"
+    require "date"
+
+    attr_reader :hash
+
+    alias to_hash hash
+
+    def initialize
+      @hash = defaults
+      parse
+    end
+
+    def defaults
+      _defaults = { date: Date.today }
+      _defaults[:print] = _defaults[:date] != Date.today
+      _defaults[:edit]  = _defaults[:date] == Date.today
+      _defaults
+    end
+
+    def parse
+      OptionParser.new do |opts|
+        opts.banner = "Usage: dl [options]"
+        opts.on("-e", "--edit", "Open the entry in the editor",
+                                "(Even when it's not today's date)") do
+          hash[:edit] = true
+        end
+        opts.on("", "--path", "Show the path for the given entry file") do
+          hash[:path] = true
+        end
+        opts.on("-p", "--print", "Print the entry to STDOUT",
+                                "(Even when it's today's date)") do
+          hash[:print] = true
+        end
+        opts.on("-d", "--date=DATE", Date, "Date to show string for") do |date|
+          hash[:date] = date
+        end
+        opts.on("-l", "--last", "Show the last daily log entry") do |dh|
+          last = DailyLog::LatestDate.new.find
+          if last
+            hash[:date] = last
+          else
+            puts "There are no previous entries"
+          end
+        end
+      end.parse!
+    end
+  end
+end

data/lib/daily_log/pathname.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module DailyLog
+
+  # The pathname for an Entry file on a given Day
+  class Pathname
+    require "forwardable"
+    require "zero_padded"
+
+    extend Forwardable
+    using ZeroPadded
+
+    ##
+    # The default name for the dir where entries are stored.
+    DEFAULT_DIRNAME = ".daily_logs"
+
+    ##
+    # The default format for entries
+    FORMAT = "md"
+
+    ##
+    # The Date we're caluclating the Pathname for
+    attr_reader :date
+
+    def_delegators :date, :year, :month, :day
+
+    class << self
+
+      ##
+      # Set the dirname where entries are stored
+      attr_writer :dirname
+
+      ##
+      # The dirname where entries are stored
+      #
+      # Returns String
+      def dirname
+        @dirname || DEFAULT_DIRNAME
+      end
+
+    end
+
+    # Create a new Pathname
+    #
+    # date - The Date we're creating a Pathname for
+    def initialize(date)
+      @date = date
+    end
+
+    # The Pathname as a path string
+    # Returns String
+    def to_path
+      File.join(dirname, "#{day.zero_pad}.#{FORMAT}")
+    end
+
+    alias to_s to_path
+
+    # The name of the directory where the Entry will live
+    #
+    # Returns String
+    def dirname
+      File.join self.class.dirname, year.zero_pad, month.zero_pad
+    end
+
+  end
+end

data/lib/daily_log/scm_check.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module DailyLog
+
+  # Source-Code management check. Make sure the entries aren't being checked
+  # into Git.
+  # # TODO: Allow devs to disable this in as an option
+  # # TODO: Allow devs to disable this in a .daily_log file
+  # # TODO: Add support for other SCM
+  class ScmCheck
+
+    # Perform the check. Print to STDOUT if there is a warning
+    def perform!
+      return unless git_project?
+      return if has_gitignore? && has_ignored_daily_logs?
+      warn <<~TEXT
+        You should add .daily_logs to your .gitignore file
+      TEXT
+    end
+
+    private
+
+    def git_project?
+      Dir.exists?("./.git")
+    end
+
+    def has_gitignore?
+      File.exists?("./.gitignore")
+    end
+
+    def has_ignored_daily_logs?
+      File.read(".gitignore").include?(DailyLog::Pathname::dirname)
+    end
+
+  end
+end

data/lib/daily_log/version.rb

@@ -0,0 +1,3 @@
+module DailyLog
+  VERSION = "0.1.0"
+end

data/lib/tasks/doc.rake

@@ -0,0 +1,12 @@
+namespace :doc do
+
+  desc "Create the HTML docs for this project"
+  task :create do
+    load("lib/daily_log/version.rb")
+    system("yard doc --plugin tomdoc\
+                     --hide-void-return\
+                     --title \"Daily Logs - #{DailyLog::VERSION}\"")
+  end
+end
+
+task doc: ["doc:create"]

data/lib/templates/daily_log/entry.md.erb

@@ -0,0 +1,20 @@
+# Daily Entry - <%= @day.date.strftime("%a %d %B, %Y") %>
+
+## Today I worked on:
+
+- Thing one
+
+## Next time, you should continue with:
+
+- Thing two
+
+## Notes:
+
+Some optional notes here...
+
+<!--
+  Automatically generated by DailyLog https://github.com/KatanaCode/daily_log
+  Date: <%= @day.to_s %>
+  Project: <%= File.basename(Dir.getwd) %>
+  By: <%= Etc.getlogin %>
+-->

data/lib/zero_padded.rb

@@ -0,0 +1,13 @@
+# Extends the Integer class with zero-padded numbers, so that months are days
+# all always shown as double-digit numbers
+module ZeroPadded
+
+  refine Integer do
+
+    # Return the value of an Integer zero-padded to a min of 2 chars
+    def zero_pad
+      to_s.rjust(2, "0")
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: daily_log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bodacious
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Keep a short, daily log of the work you do within a project repo
+email:
+- bodacious@katanacode.com
+executables:
+- dl
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".daily_logs/2020/01/06.md"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- History.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- daily_log.gemspec
+- exe/dl
+- lib/daily_log.rb
+- lib/daily_log/day.rb
+- lib/daily_log/entry.rb
+- lib/daily_log/latest_date.rb
+- lib/daily_log/options.rb
+- lib/daily_log/pathname.rb
+- lib/daily_log/scm_check.rb
+- lib/daily_log/version.rb
+- lib/tasks/doc.rake
+- lib/templates/daily_log/entry.md.erb
+- lib/zero_padded.rb
+homepage: https://github.com/KatanaCode/daily_log
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Daily code journal on a per project basis
+test_files: []