feed-the-zettelkasten 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d4ad4b141e03670748ca1827b8fc951d46314026de410d728a20c688e487ff2
+  data.tar.gz: e9816de93de56d9c0280933d73096326ea50c01fdaade54e4e444d743e178932
+SHA512:
+  metadata.gz: b5c7c976ed6c5c4e2c97481122b9ce59b249e35936286db1d0d978d82182cf6d2710a84e0f619d0f3dfbca768cc273524c6377fc1a1fc40e853611b12664d495
+  data.tar.gz: 558811fc1895f9ae8068e6fb11d4159fb03963c9c0b0a01a1396f27abc201416c2bb748d9c5ad9fb8ec1b7ec5c61e7b16b705a35c08b7dc90c5ad93843b0ae9b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+* Initial version

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in feed-the-zettelkasten.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    feed-the-zettelkasten (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.2)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  feed-the-zettelkasten!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENCE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Gareth Rees
+
+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,33 @@
+# Feed The Zettelkasten
+
+Command Line Seinfeld calendar for The Archive Zettelkasten notes.
+
+## Installation
+
+    $ gem install feed-the-zettelkasten
+
+## Usage
+
+```
+$ feed-the-zettelkasten --from=2020-09-25 --to=2020-10-04 --target=1 ~/notes
+2020-09-25: ❌
+2020-09-26: ✅
+2020-09-27: ❌
+2020-09-28: ❌
+2020-09-29: ❌
+2020-09-30: ❌
+2020-10-01: ❌
+2020-10-02: ✅
+2020-10-03: ✅
+2020-10-04: ❌
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/garethrees/feed-the-zettelkasten.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "feed/the/zettelkasten"
+
+# 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/exe/feed-the-zettelkasten

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'feed_the_zettelkasten'
+
+exit FeedTheZettelkasten::CLI.run(ARGV)

data/feed-the-zettelkasten.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/feed_the_zettelkasten/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'feed-the-zettelkasten'
+  spec.version       = FeedTheZettelkasten::VERSION
+  spec.authors       = ['Gareth Rees']
+  spec.email         = ['gareth@garethrees.co.uk']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Report on daily note-taking progress'
+  spec.homepage      = 'https://github.com/garethrees/feed-the-zettelkasten'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{ spec.homepage }/blob/master/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.
+  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']
+end

data/lib/feed_the_zettelkasten.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'date'
+
+require 'feed_the_zettelkasten/format/pretty'
+
+require 'feed_the_zettelkasten/cli/options'
+require 'feed_the_zettelkasten/cli'
+
+require 'feed_the_zettelkasten/notes_dir'
+require 'feed_the_zettelkasten/notes'
+require 'feed_the_zettelkasten/seinfeld'
+require 'feed_the_zettelkasten/version'
+
+module FeedTheZettelkasten
+  class Error < StandardError; end
+end

data/lib/feed_the_zettelkasten/cli.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module FeedTheZettelkasten
+  # Entrypoint for CLI usage
+  class CLI
+    STATUS_SUCCESS = 0
+    STATUS_FAILURE = 1
+
+    def self.run(argv)
+      new(Options.new(argv)).run
+    end
+
+    def initialize(options)
+      @options = options
+    end
+
+    def run
+      notes = NotesDir.new(options[:path], file_extension: options[:ext])
+      range = options[:from]..options[:to]
+
+      Seinfeld.new(notes, target: options[:target]).each_day(range) do |data|
+        puts Format::Pretty.new(data)
+      end
+
+      STATUS_SUCCESS
+    rescue StandardError => e
+      $stderr.puts e
+      STATUS_FAILURE
+    end
+
+    private
+
+    attr_reader :options
+  end
+end

data/lib/feed_the_zettelkasten/cli/options.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'optparse/date'
+
+module FeedTheZettelkasten
+  class CLI
+    # Parse CLI options
+    class Options
+      DEFAULTS = {
+        from: Date.today - 30,
+        to: Date.today,
+        target: 3,
+        ext: 'md'
+      }.freeze
+    
+      def initialize(args)
+        @args = args
+      end
+
+      def [](key)
+        parse[key]
+      end
+
+      def to_hash
+        parse
+      end
+
+      private
+
+      attr_reader :args
+
+      def parse
+        @parse ||= parse!
+      end
+
+      def parse!
+        options = DEFAULTS.dup
+        option_parser.parse!(args, into: options)
+        options[:path] = args.shift
+
+        unless options[:path]
+          raise OptionParser::MissingArgument, 'Missing NOTES_DIR argument'
+        end
+
+        unless File.directory?(options[:path])
+          raise OptionParser::InvalidArgument,
+            "'#{ options[:path] } is not a directory"
+        end
+
+        options
+      end
+
+      def option_parser
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: feed-the-zettelkasten [options] NOTES_DIR'
+          opts.on('--from[=DATE]', Date, 'Include notes after DATE (default: 30 days ago)')
+          opts.on('--to[=DATE]', Date, 'Include notes before DATE (default: today)')
+          opts.on('--target[=INTEGER]', Integer, 'Number of notes required to meet daily goal (default: 3)')
+          opts.on('--ext[=STRING]', 'Note extension (default: md)')
+          opts.on('-v', '--version', 'Print version') { exit 0 }
+          opts.on('-h', '--help', 'Prints this help') do
+            puts opts
+            exit 1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/feed_the_zettelkasten/format/pretty.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module FeedTheZettelkasten
+  module Format
+    class Pretty
+      SYMBOLS = {
+        true => '✅',
+        false => '❌'
+      }.freeze
+
+      def initialize(data)
+        @data = data
+      end
+
+      def to_s
+        data.
+          map { |date, success| "#{ date }: #{ SYMBOLS[success] }"}.
+          join("\n")
+      end
+
+      protected
+
+      attr_reader :data
+    end
+  end
+end

data/lib/feed_the_zettelkasten/notes.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module FeedTheZettelkasten
+  class Notes
+    include Enumerable
+
+    def initialize(notes)
+      @notes = notes
+    end
+
+    def hit_target?(target)
+      to_a.size >= target
+    end
+
+    def each
+      notes.each { |note| yield note }
+    end
+
+    protected
+
+    attr_reader :notes
+  end
+end

data/lib/feed_the_zettelkasten/notes_dir.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module FeedTheZettelkasten
+  class NotesDir
+    def initialize(path, file_extension: 'md')
+      @path = Pathname.new(path)
+      @file_extension = file_extension
+    end
+
+    def created_on(date)
+      Notes.new(path.glob("*#{ date.strftime('%Y%m%d') }*.#{ file_extension }"))
+    end
+
+    protected
+
+    attr_reader :path, :file_extension
+  end
+end

data/lib/feed_the_zettelkasten/seinfeld.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FeedTheZettelkasten
+  class Seinfeld
+    def initialize(notes, target: 3)
+      @notes = notes
+      @target = target
+    end
+
+    def each_day(range)
+      range.each_with_object(notes) do |day, notes|
+        yield day.to_s =>
+          Notes.new(notes.created_on(day)).hit_target?(target)
+      end
+    end
+
+    protected
+
+    attr_reader :notes, :range, :target
+  end
+end

data/lib/feed_the_zettelkasten/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FeedTheZettelkasten
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: feed-the-zettelkasten
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gareth Rees
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-04 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- gareth@garethrees.co.uk
+executables:
+- feed-the-zettelkasten
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENCE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/feed-the-zettelkasten
+- feed-the-zettelkasten.gemspec
+- lib/feed_the_zettelkasten.rb
+- lib/feed_the_zettelkasten/cli.rb
+- lib/feed_the_zettelkasten/cli/options.rb
+- lib/feed_the_zettelkasten/format/pretty.rb
+- lib/feed_the_zettelkasten/notes.rb
+- lib/feed_the_zettelkasten/notes_dir.rb
+- lib/feed_the_zettelkasten/seinfeld.rb
+- lib/feed_the_zettelkasten/version.rb
+homepage: https://github.com/garethrees/feed-the-zettelkasten
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/garethrees/feed-the-zettelkasten
+  source_code_uri: https://github.com/garethrees/feed-the-zettelkasten
+  changelog_uri: https://github.com/garethrees/feed-the-zettelkasten/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Report on daily note-taking progress
+test_files: []