markdo 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in markdo.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2016 Benjamin Oakes
+
+(The MIT license)
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Benjamin Oakes
+
+MIT License
+
+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,59 @@
+# Markdo
+
+Markdown-based task manager.  Inspired by OmniFocus and GitHub Flavored Markdown's task lists.
+
+## Installation
+
+Install Ruby, and then:
+
+    gem install markdo
+
+## Usage
+
+You might already be using Markdo-formatted text already!
+
+Basically, you write Markdown, and use the GFM "task list" syntax:
+
+```
+# Example
+
+Any Markdown you want
+
+## Like headings
+
+## And subheadings
+
+> Quoted text.
+
+And of course:
+
+- [x] A completed task
+- [ ] An incomplete task
+  - [ ] A subtask
+- [ ] 2016-01-01 A task with a date
+- [ ] A task with a @tag
+```
+
+Then you can use `markdo` to interact with your files.
+
+See `markdo help` for more information.
+
+    add "string"          Add a task to the inbox.  (Set $MARKDO_ROOT and $MARKDO_INBOX.)
+    edit                  Edit $MARKDO_ROOT in $EDITOR.
+    help, --help          Display this help text.
+    overview              Get overview of starred, today's, and tomorrow's tasks.
+    overdue               Search *.md files for previous dates.  (YYYY-MM-DD format.)
+    tag "string'          Search *.md files for @tag.
+    today                 Search *.md files for today's date.  (YYYY-MM-DD format.)
+    tomorrow              Search *.md files for tomorrow's date.  (YYYY-MM-DD format.)
+    star, starred         Search *.md files for @star.
+    query, q "string"     Search *.md files for string.
+    version, --version    Display the version.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/markdo

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'markdo'
+
+Markdo::CLI.new(STDOUT, STDERR, ENV).run(*ARGV)

data/lib/markdo.rb

@@ -0,0 +1,2 @@
+require "markdo/version"
+require "markdo/cli"

data/lib/markdo/add_command.rb

@@ -0,0 +1,21 @@
+require 'markdo/command'
+
+module Markdo
+  class AddCommand < Command
+    def run(task)
+      File.open(inbox_path, 'a') do |file|
+        file.puts(template(task))
+      end
+    end
+
+    protected
+
+    def template(task)
+      "- [ ] #{task}"
+    end
+
+    def inbox_path
+      File.join(@env['MARKDO_ROOT'], @env['MARKDO_INBOX'])
+    end
+  end
+end

data/lib/markdo/cli.rb

@@ -0,0 +1,62 @@
+require 'markdo/add_command'
+require 'markdo/edit_command'
+require 'markdo/help_command'
+require 'markdo/overview_command'
+require 'markdo/query_command'
+require 'markdo/star_command'
+require 'markdo/tag_command'
+require 'markdo/today_command'
+require 'markdo/tomorrow_command'
+require 'markdo/version_command'
+
+module Markdo
+  class CLI
+    def initialize(stdout, stderr, full_env)
+      @stdout = stdout
+      @stderr = stderr
+      @full_env = full_env
+    end
+
+    def run(command_name = 'help', *args)
+      command = case command_name
+                when 'add'
+                  AddCommand
+                when 'edit'
+                  EditCommand
+                when 'overdue'
+                  OverdueCommand
+                when 'overview'
+                  OverviewCommand
+                when 'query', 'q'
+                  QueryCommand
+                when 'star', 'starred'
+                  StarCommand
+                when 'tag'
+                  TagCommand
+                when 'today'
+                  TodayCommand
+                when 'tomorrow'
+                  TomorrowCommand
+                when 'version', '--version'
+                  VersionCommand
+                else
+                  HelpCommand
+                end
+
+      command.new(@stdout, @stderr, env).run(*args)
+    end
+
+    private
+
+    def default_env
+      {
+        'MARKDO_ROOT' => '.',
+        'MARKDO_INBOX' => 'Inbox.md',
+      }
+    end
+
+    def env
+      default_env.merge(@full_env)
+    end
+  end
+end

data/lib/markdo/command.rb

@@ -0,0 +1,12 @@
+module Markdo
+  class Command
+    def initialize(stdout, stderr, env)
+      @stdout = stdout
+      @stderr = stderr
+      @env = env
+    end
+
+    def run
+    end
+  end
+end

data/lib/markdo/date_command.rb

@@ -0,0 +1,9 @@
+require 'markdo/query_command'
+
+module Markdo
+  class DateCommand < QueryCommand
+    def run(date)
+      super(date.iso8601)
+    end
+  end
+end

data/lib/markdo/edit_command.rb

@@ -0,0 +1,16 @@
+require 'shellwords'
+require 'markdo/command'
+
+module Markdo
+  class EditCommand < Command
+    def run
+      system("#{@env['EDITOR']} #{safe_markdo_root}")
+    end
+
+    private
+
+    def safe_markdo_root
+      Shellwords.shellescape(@env['MARKDO_ROOT'])
+    end
+  end
+end

data/lib/markdo/help_command.rb

@@ -0,0 +1,25 @@
+require 'markdo/command'
+
+module Markdo
+  class HelpCommand < Command
+    def run
+      @stderr.puts <<-EOF
+Markdown-based task manager.
+
+    add "string"          Add a task to the inbox.  (Set $MARKDO_ROOT and $MARKDO_INBOX.)
+    edit                  Edit $MARKDO_ROOT in $EDITOR.
+    help, --help          Display this help text.
+    overview              Get overview of overdue, starred, today's, and tomorrow's tasks.
+    overdue               Search *.md files for previous dates.  (YYYY-MM-DD format.)
+    tag "string'          Search *.md files for @tag.
+    today                 Search *.md files for today's date.  (YYYY-MM-DD format.)
+    tomorrow              Search *.md files for tomorrow's date.  (YYYY-MM-DD format.)
+    star, starred         Search *.md files for @star.
+    query, q "string"     Search *.md files for string.
+    version, --version    Display the version.
+EOF
+
+      exit 1
+    end
+  end
+end

data/lib/markdo/overdue_command.rb

@@ -0,0 +1,47 @@
+require 'date'
+require 'markdo/query_command'
+
+module Markdo
+  # TODO: More testing of this logic.  As of 2016-01-23, I was building this
+  # project as a proof of concept.
+  class OverdueCommand < Command
+    def initialize(*)
+      @date = Date.today
+      super
+    end
+
+    def run
+      query_command = QueryCommand.new(@stdout, @stderr, @env)
+
+      all_queries.each do |query|
+        query_command.run(query)
+      end
+    end
+
+    private
+
+    def all_queries
+      [previous_years, previous_months_this_year, previous_days_this_month].flatten
+    end
+
+    def previous_days_this_month
+      (1...@date.day).to_a.map { |day|
+        "#{@date.year}-#{justify(@date.month)}-#{justify(day)}"
+      }
+    end
+
+    def previous_months_this_year
+      (1...@date.month).to_a.map { |month|
+        "#{@date.year}-#{justify(month)}"
+      }
+    end
+
+    def previous_years
+      (2000...@date.year).to_a.map { |year| "#{year}-" }
+    end
+
+    def justify(less_than_100)
+      less_than_100.to_s.rjust(2, '0')
+    end
+  end
+end

data/lib/markdo/overview_command.rb

@@ -0,0 +1,17 @@
+require 'markdo/command'
+require 'markdo/overdue_command'
+require 'markdo/star_command'
+require 'markdo/today_command'
+require 'markdo/tomorrow_command'
+
+module Markdo
+  class OverviewCommand < Command
+    def run
+      commands = [OverdueCommand, StarCommand, TodayCommand, TomorrowCommand]
+      
+      commands.each do |command|
+        command.new(@stdout, @stderr, @env).run
+      end
+    end
+  end
+end

data/lib/markdo/query_command.rb

@@ -0,0 +1,23 @@
+require 'markdo/command'
+
+module Markdo
+  class QueryCommand < Command
+    def run(string)
+      regexp = Regexp.new(string, Regexp::IGNORECASE)
+
+      matches = Dir.
+        glob(markdown_glob).
+        map { |path| File.readlines(path) }.
+        flatten.
+        grep(regexp)
+
+      @stdout.puts(matches)
+    end
+
+    protected
+
+    def markdown_glob
+      "#{@env['MARKDO_ROOT']}/*.md"
+    end
+  end
+end

data/lib/markdo/star_command.rb

@@ -0,0 +1,9 @@
+require 'markdo/tag_command'
+
+module Markdo
+  class StarCommand < TagCommand
+    def run
+      super('star')
+    end
+  end
+end

data/lib/markdo/tag_command.rb

@@ -0,0 +1,9 @@
+require 'markdo/query_command'
+
+module Markdo
+  class TagCommand < QueryCommand
+    def run(string)
+      super("@#{string}")
+    end
+  end
+end

data/lib/markdo/today_command.rb

@@ -0,0 +1,10 @@
+require 'date'
+require 'markdo/date_command'
+
+module Markdo
+  class TodayCommand < DateCommand
+    def run
+      super(Date.today)
+    end
+  end
+end

data/lib/markdo/tomorrow_command.rb

@@ -0,0 +1,10 @@
+require 'date'
+require 'markdo/date_command'
+
+module Markdo
+  class TomorrowCommand < DateCommand
+    def run
+      super(Date.today + 1)
+    end
+  end
+end

data/lib/markdo/version.rb

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

data/lib/markdo/version_command.rb

@@ -0,0 +1,10 @@
+require 'markdo/command'
+require 'markdo/version'
+
+module Markdo
+  class VersionCommand < Command
+    def run
+      @stdout.puts("v#{Markdo::VERSION}")
+    end
+  end
+end

data/markdo.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'markdo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "markdo"
+  spec.version       = Markdo::VERSION
+  spec.authors       = ["Benjamin Oakes"]
+  spec.email         = ["hello@benjaminoakes.com"]
+  spec.description   = %q{Markdown-based task manager}
+  spec.summary       = %q{Markdown-based task manager}
+  spec.homepage      = "http://github.com/benjaminoakes/markdo"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: markdo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Benjamin Oakes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &23813680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *23813680
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &23812900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *23812900
+description: Markdown-based task manager
+email:
+- hello@benjaminoakes.com
+executables:
+- markdo
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/markdo
+- lib/markdo.rb
+- lib/markdo/add_command.rb
+- lib/markdo/cli.rb
+- lib/markdo/command.rb
+- lib/markdo/date_command.rb
+- lib/markdo/edit_command.rb
+- lib/markdo/help_command.rb
+- lib/markdo/overdue_command.rb
+- lib/markdo/overview_command.rb
+- lib/markdo/query_command.rb
+- lib/markdo/star_command.rb
+- lib/markdo/tag_command.rb
+- lib/markdo/today_command.rb
+- lib/markdo/tomorrow_command.rb
+- lib/markdo/version.rb
+- lib/markdo/version_command.rb
+- markdo.gemspec
+homepage: http://github.com/benjaminoakes/markdo
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Markdown-based task manager
+test_files: []
+has_rdoc: