devlog 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 152a77a9bf2759dee53158b75e850e5fa7eac445ffc96c1640f63994afa95657
-  data.tar.gz: fa39e2749400e54807d883f106e0a79371633f471d7ad0eb84d54254b4f586d8
+  metadata.gz: 6af19a193f7add3438d8bebacbd17cf430ac898eddaab5c82f7fa98e8b794509
+  data.tar.gz: ef126fee122ede38c05e8adc9ba12d57733b15d94ba35ec263b64ec2eb551562
 SHA512:
-  metadata.gz: 3240402228afcfe9dc9d8826f96b0a3e3579604e3d3ff139a66c9f8dc65562d03218ee66886c03fc468c1382b81b3d347f30a513c1a0e486f42f8f4d4b7c927f
-  data.tar.gz: '080462e56cd322f1af89edf7053ff912b8f9cc0a90dc4c36c2d35839a93abdcf45243b5af2dcb724a6f960e826b53312b362a1703ea6f79cd7f38830da184857'
+  metadata.gz: 8ca17bbc8140aa2ae11ffa43f95fb3e95eb2cdf8fb0e3c7232a4392a8e78978b1dbe8831f7d7483025eca13407f7913e1836ed3ea0e9b70dd41971b82001cae1
+  data.tar.gz: b725512cc215e70eec1eb327d4700d2aba3199c4042d1f60ccb932d2c83716bed828d2fc44b2697b7f55fbc2ee521b9a2f11159231724d9577573158af1d9aef

data/.github/workflows/devlog_test.yml

@@ -0,0 +1,30 @@
+name: devlog CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['3.2.2', '3.0.1']
+        os: [ubuntu-latest, macOS-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby ${{ runner.os }}-§${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/.ruby-version

@@ -1,3 +1 @@
-2.3.0
-
-
+3.3.3

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+
+## [0.4.0] - 2024-10-17
+
+- Bump to ruby 3, which is now a dependency
+- Timezone support with the .devlog.yml setting
+- Remove Jeweler in favor of Bundler

data/Gemfile

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
-# gemspec # jeweler 2.0.1 adds 'devlog' it self as a dependency for some reason, which results in Travis failing
-gem "activesupport", "> 4.1"
+# Specify your gem's dependencies in devlog.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "activesupport"
 
 group :development, :test do
-  gem "test-unit", "~> 3.1"
-  gem "jeweler", "~> 2.0"
-  gem "nokogiri", "~> 1.8" # jeweler 2.0.1 depends on 1.5.10, but that has sec issue
-end
+  gem "test-unit"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 mihael
+
+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

@@ -28,15 +28,14 @@ like a book, top down, but always start a new session on top of the file, so tha
 devlog DSL
 ==========
 
+    #DD.MM.YYYY HH:MM:SS CodingSession::END
 
-#DD.MM.YYYY HH:MM:SS CodingSession::END
+    devlog text...
 
-devlog text...
+    #DD.MM.YYYY HH:MM:SS CodingSession::BEGIN
 
-#DD.MM.YYYY HH:MM:SS CodingSession::BEGIN
-
-using the devlog binary
-===================
+using the devlog CLI
+====================
 
 to parse a devlog file explicitly:
 
@@ -106,3 +105,19 @@ devlog_file: ../info/devlog.markdown
 weekly_timesheet_template: ../info/weekly_timesheet.erb.html
 convert_to_pdf_command: wkhtmltopdf --dpi 400  --viewport-size 600x800 --orientation Landscape
 ```
+
+development
+===========
+
+Run test suite:
+
+```
+rake test
+```
+
+Build and install gem locally:
+
+```
+rake build
+rake install
+```

data/Rakefile

@@ -1,58 +1,12 @@
-require 'rubygems'
-require 'rake'
+# frozen_string_literal: true
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "devlog"
-    gem.summary = %Q{takes devlog.markdown and gives info}
-    gem.description = %Q{devlog.markdown time&space extractor}
-    gem.email = "kitschmaster@gmail.com"
-    gem.homepage = "http://github.com/mihael/devlog"
-    gem.authors = ["mihael"]
-    gem.executables = ["devlog"]
-    gem.license     = 'MIT'
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :test #=> :check_dependencies
-
-task :default => :test
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "devlog #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task default: :test

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "devlog"
+
+# 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.
+
+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/devlog.gemspec

@@ -1,38 +1,53 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: devlog 0.3.3 ruby lib
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.name = "devlog".freeze
-  s.version = "0.3.3"
+require_relative "lib/devlog/version"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib".freeze]
-  s.authors = ["mihael".freeze]
-  s.date = "2019-10-19"
-  s.description = "devlog.markdown time&space extractor".freeze
-  s.email = "kitschmaster@gmail.com".freeze
-  s.executables = ["devlog".freeze]
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
-  ]
-  s.files = [
+Gem::Specification.new do |spec|
+  spec.name = "devlog"
+  spec.version = Devlog::VERSION
+  spec.authors = ["mihael"]
+  spec.email = ["kitschmaster@gmail.com"]
+
+  spec.summary = "Write a development log while also easily track time spent in coding sessions using just a markdown text file and a few CLI commands."
+  spec.description = "devlog.markdown time&space extractor ~ Track the time spent in coding sessions and money payed to you, while also writing a development log. Export a timesheet for your bills."
+  spec.homepage = "https://manitu.si/devlog"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/mihael/devlog"
+  spec.metadata["changelog_uri"] = "https://github.com/mihael/devlog/blob/main/CHANGELOG.md"
+
+  # 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.
+  # gemspec = File.basename(__FILE__)
+  # spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+  #   ls.readlines("\x0", chomp: true).reject do |f|
+  #     (f == gemspec) ||
+  #       f.start_with?(*%w[bin/ lib/ sublime_text/ templates/ test/ .git .github .gitignore .ruby-gemset .ruby-version devlog.gemspec devlog.markdown Gemfile LICENSE.txt CHANGELOG.md README.md Rakefile tmp/.gitignore])
+  #   end
+  # end
+  spec.files = [
+    ".github/workflows/devlog_test.yml",
     ".ruby-gemset",
     ".ruby-version",
-    ".travis.yml",
     "Gemfile",
-    "LICENSE",
+    "LICENSE.txt",
     "README.md",
+    "CHANGELOG.md",
     "Rakefile",
-    "VERSION",
-    "bin/devlog",
+    "bin/console",
+    "bin/setup",
+    "exe/devlog",
     "devlog.gemspec",
     "devlog.markdown",
     "lib/devlog.rb",
-    "lib/devlog_settings.rb",
+    "lib/devlog/utils.rb",
+    "lib/devlog/date_time_ago_in_words.rb",
+    "lib/devlog/settings.rb",
+    "lib/devlog/version.rb",
     "sublime_text/devlog.tmbundle/Snippets/begin.tmSnippet",
     "sublime_text/devlog.tmbundle/Snippets/combegin.tmSnippet",
     "sublime_text/devlog.tmbundle/Snippets/comend.tmSnippet",
@@ -62,30 +77,16 @@ Gem::Specification.new do |s|
     "test/test_helper.rb",
     "tmp/.gitignore"
   ]
-  s.homepage = "http://github.com/mihael/devlog".freeze
-  s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.0.6".freeze
-  s.summary = "takes devlog.markdown and gives info".freeze
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  spec.bindir = "exe"
+  spec.executables = ["devlog"]
+  spec.require_paths = ["lib"]
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>.freeze, ["> 4.1"])
-      s.add_development_dependency(%q<test-unit>.freeze, ["~> 3.1"])
-      s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.0"])
-      s.add_development_dependency(%q<nokogiri>.freeze, ["~> 1.8"])
-    else
-      s.add_dependency(%q<activesupport>.freeze, ["> 4.1"])
-      s.add_dependency(%q<test-unit>.freeze, ["~> 3.1"])
-      s.add_dependency(%q<jeweler>.freeze, ["~> 2.0"])
-      s.add_dependency(%q<nokogiri>.freeze, ["~> 1.8"])
-    end
-  else
-    s.add_dependency(%q<activesupport>.freeze, ["> 4.1"])
-    s.add_dependency(%q<test-unit>.freeze, ["~> 3.1"])
-    s.add_dependency(%q<jeweler>.freeze, ["~> 2.0"])
-    s.add_dependency(%q<nokogiri>.freeze, ["~> 1.8"])
-  end
-end
+  # Dependencies
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "nokogiri"
 
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/devlog.markdown

@@ -1,3 +1,19 @@
+#17.10.2024 09:10:08 CodingSession::END
+
+Fixing up for ruby 3 and doing some minor cleanup.
+
+Ditching jeweler for bundler to package and release gem.
+
+The tasks to work with the gem are now:
+
+		rake build
+		rake install
+		rake release
+
+More here: https://bundler.io/guides/creating_gem.html
+
+#17.10.2024 05:20:32 CodingSession::BEGIN
+
 #23.09.2019 23:08:08 CodingSession::END
 
 some quick adjustments...
@@ -130,7 +146,6 @@ aha... no comment haha...
 
 #09.02.2015 15:41:09 CodingSession::BEGIN
 
-
 #02.02.2015 17:53:20 CodingSession::END
 
 cleaning up a little... enhancing the devlog executable features...

data/{bin → exe}/devlog

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 require 'benchmark'
 require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib devlog.rb]))
+require "active_support/configurable"
+
 USAGE = <<-EOF
 #{Devlog.display_version}
 This software is intended to parse and present information within devlog.markdown development logs. It also helps You to write the devlog.
@@ -68,6 +70,8 @@ include Devlog
 
 def dodo
   load_settings('.devlog.yml')
+  tz = devlog_timezone_setting
+  puts "Timezone: {tz}"
   default_devlog_file = devlog_file_setting
   time = Benchmark.realtime do
     if @in_file_or_cmd =~ /.(markdown|md)$/ # devlog_file is passed directly via CLI

data/lib/devlog/date_time_ago_in_words.rb

@@ -0,0 +1,34 @@
+require "active_support/all"
+
+module DateTimeAgoInWords
+  def ago_in_words
+    return 'a very very long time ago' if self.year < 1800
+    secs = Time.now - self
+    return 'just over' if secs > -1 && secs < 1
+    return 'now' if secs <= -1
+    pair = ago_in_words_pair(secs)
+    ary = ago_in_words_singularize(pair)
+    ary.size == 0 ? '' : ary.join(' and ') << ' ago'
+  end
+  private
+  def ago_in_words_pair(secs)
+    [[60, :seconds], [60, :minutes], [24, :hours], [100_000, :days]].map{ |count, name|
+      if secs > 0
+        secs, n = secs.divmod(count)
+        "#{n.to_i} #{name}"
+      end
+    }.compact.reverse[0..1]
+  end
+  def ago_in_words_singularize(pair)
+    if pair.size == 1
+      pair.map! {|part| part[0, 2].to_i == 1 ? part.chomp('s') : part }
+    else
+      pair.map! {|part| part[0, 2].to_i == 1 ? part.chomp('s') : part[0, 2].to_i == 0 ? nil : part }
+    end
+    pair.compact
+  end
+end
+
+class ActiveSupport::TimeWithZone
+  include DateTimeAgoInWords
+end

data/lib/{devlog_settings.rb → devlog/settings.rb}

@@ -2,7 +2,7 @@ require 'yaml'
 require 'ostruct'
 # require 'pry'
 
-#
+# Devlog settings
 module Devlog
   # Settings - keeping it simple.
   # Allow settings.key besides settings[:key]
@@ -49,4 +49,14 @@ module Devlog
       DEVLOG_FILE
     end
   end
+
+  def devlog_timezone_setting
+    return 'Amsterdam' unless settings
+    devlog_timezone_setting = settings['timezone']
+    if devlog_timezone_setting.present?
+      devlog_timezone_setting
+    else
+      'Amsterdam'
+    end
+  end
 end

data/lib/devlog/utils.rb

@@ -0,0 +1,18 @@
+# Colors for devlog
+class String
+  def red; colorize(self, "\e[1m\e[31m"); end
+  def green; colorize(self, "\e[1m\e[32m"); end
+  def dark_green; colorize(self, "\e[32m"); end
+  def yellow; colorize(self, "\e[1m\e[33m"); end
+  def blue; colorize(self, "\e[1m\e[34m"); end
+  def dark_blue; colorize(self, "\e[34m"); end
+  def pur; colorize(self, "\e[1m\e[35m"); end
+  def colorize(text, color_code) "#{color_code}#{text}\e[0m" end
+end
+
+# Rounding seconds to hours
+class Float
+  def rounded_hours
+    (self / 60.0 / 60.0).round(2)
+  end
+end

data/lib/devlog/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Devlog
+  VERSION = "0.4.0"
+end