forget_me_not 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22544794f3ea49b825752e6184c69b7a6a85b4ec
+  data.tar.gz: 18d2750b71f7fb0e1a92389f15cf7523af80c250
+SHA512:
+  metadata.gz: fb2441285e7174723d3a0ef954c070fb46b01435a4a3fc82b6264a16e97b92f63e30a38ec790a95b1a61c76fc8248752944af91793f2e769a34c721377e004ee
+  data.tar.gz: 8dab65f8e483df38006f9134d145e5a14bde217703a6c775336ee8d50d16f08c48179305d10e06ace53d6402bd3c2f0945ef707d0c574c44b4b9ef5323549fd7

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'commander', '~> 4.3.4'

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    forget_me_not (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    commander (4.3.4)
+      highline (~> 1.7.2)
+    highline (1.7.3)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.9)
+  commander (~> 4.3.4)
+  forget_me_not!
+  rake (~> 10.0)

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Giovanni Lodi
+
+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,104 @@
+# Forget-Me-Not 🌸
+
+A smart, contextualised todo list. Designed to live in your terminal, and to be in your face.
+
+## Usage
+
+```
+$ fmn list
+(1) - Buy tomato sauce and basil for pasta
+(2) - Tweet about how cool fmn is
+(3) - Follow @mokagio
+
+$ fmn add Another thing to remember
+
+$ fmn list
+(1) - Buy tomato sauce and basil for pasta
+(2) - Tweet about how cool fmn is
+(3) - Follow @mokagio
+(4) - Another thing to remember
+
+$ fmn done 4
+
+$ fmn list
+(1) - Buy tomato sauce and basil for pasta
+(2) - Tweet about how cool fmn is
+(3) - Follow @mokagio
+```
+
+That's all right isn't it? But there's more. Forget-Me-Not is *contextual*:
+
+```
+$ fmn list
+(1) - Buy tomato sauce and basil for pasta
+(2) - Tweet about how cool fmn is
+(3) - Follow @mokagio
+
+$ cd my-project-folder
+$ fmn list
+(1) - Buy tomato sauce and basil for pasta
+(2) - Tweet about how cool fmn is
+(3) - Follow @mokagio
+(4) - Update README with new features
+(5) - Look into bug report 42
+```
+
+`fmn` tasks list is build by inspecting the current folder and all its ancestors. This means that if you add tasks while into a project folder, you'll won't see them when doing `fmn list` on its paraent.
+
+And one more thing. Forget-Me-Not has a *global* list, too. The tasks added to the global list will always be listed.
+
+```
+$ fmn add -g A global task
+```
+
+This is ideal if you want to share tasks across machines.
+
+_TODO: show how to set the global list location._
+
+## Motivation
+
+Forget-Me-Not is a task manager for the terminal junkies, like me. I do most of my work inside the terminal, and I'd like to manage my TODO list from there too.
+
+Juggling multiple clients and side projects it's important to keep the scope relevant. One TODO list to rule them all would be too messy, but switching between multiple ones adds _too much friction_. Forget-Me-Not location awarness does the job pretty all right, I can add tasks to the each project, and see them only when in there. And with the global list I can track important things too.
+
+On top of that I'm quite a forgetful person, and I tend to get sidetracked. That is why I want my task manager to be **in my face**, and that's where Forget-Me-Not comes in handy.
+
+## Shell Integration
+
+### zsh
+
+Add this to your `.zshrc`, or `.zshprompt`:
+
+```
+precmd() { fmn list --prompt }
+```
+
+## Tips
+
+You might want to add `.fmn.yml` to your global `.gitignore`.
+
+You might also want to speed up your workflow using aliases, for [example](https://github.com/mokagio/dotfiles/blob/master/aliases):
+
+```
+alias t='fmn list'
+alias ta='fmn add'
+alias td='fmn done'
+```
+
+## Install
+
+_TODO_
+
+## About
+
+_TODO_
+
+## Alternatives
+
+Similar softwares are:
+
+* _TODO_
+
+---
+
+(c) 2015 - Giovanni Lodi ([@mokagio](https://twitter.com/mokagio))

data/Rakefile

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

data/bin/fmn

@@ -0,0 +1,135 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+require 'psych'
+
+@gloable_folder = "#{Dir.home}/Dropbox"
+@task_file_name = '.fmn.yml'
+@tasks_key = 'tasks'
+
+def add_task(task, path)
+  yaml = Psych.load_file(path)
+end
+
+def directories_list(current_dir)
+  dirs = [current_dir]
+  parent_dir = File.expand_path('..', current_dir)
+  while parent_dir != current_dir do
+    dirs.push parent_dir
+    current_dir = parent_dir
+    parent_dir = File.expand_path('..', current_dir)
+  end
+  return dirs.reverse
+end
+
+def task_yaml_at_path(path)
+  if File.exists?(path) then
+    return Psych.load_file(path)
+  end
+  return nil
+end
+
+def tasks_at_path(path)
+  yaml = task_yaml_at_path(path)
+  return nil unless yaml
+  return yaml[@tasks_key].map do |t|
+    { task: t, path: path }
+  end
+end
+
+def tasks_for_dir_list(current_dir)
+  tasks = []
+  dirs = directories_list(Dir.pwd)
+  dirs.each do |dir|
+    path = "#{dir}/#{@task_file_name}"
+    sub_tasks = tasks_at_path(path)
+    tasks.push(sub_tasks) if sub_tasks
+  end
+  tasks = tasks.flatten
+end
+
+def all_tasks(current_dir)
+  global_tasks = tasks_at_path("#{@gloable_folder}/#{@task_file_name}")
+  other_tasks = tasks_for_dir_list(current_dir)
+  return [global_tasks, other_tasks].flatten.reject { |e| e.nil? }
+end
+
+def write_tasks_to_path(tasks, path)
+  yaml = task_yaml_at_path(path)
+  yaml = {} unless yaml
+  yaml[@tasks_key] = tasks
+
+  File.open(path, 'w') do |file|
+    file.write(Psych.dump(yaml))
+  end
+end
+
+program :name, 'Forget Me Not'
+program :version, '0.0.1'
+program :description, 'A smart, contextualized todo list. Designed to live in your terminal, and to be in your face.'
+
+command :list do |c|
+  c.syntax = 'fmn list, [options]'
+  c.summary = ''
+  c.description = ''
+  c.example 'description', 'command example'
+  c.option '--prompt', 'Use this option when integrating with the shell prompt.'
+  c.action do |args, options|
+    tasks = all_tasks(Dir.pwd)
+    if tasks.empty?
+      puts 'All tasks done. Good on ya :)' unless options.prompt
+    else
+      tasks.each_with_index do |t, index|
+        puts "(#{index + 1}) - #{t[:task]}"
+      end
+    end
+  end
+end
+
+command :add do |c|
+  c.syntax = 'fmn add, [options]'
+  c.summary = 'Add a task to the forget me not list.'
+  c.description = 'Add a task to the forget me not list.'
+  c.example 'Add a task to the forget me not list. You don\'t need quotes.', 'fmn add Buy the milk'
+  c.option '-g', '--global', 'Add to the global list'
+  c.action do |args, options|
+    task = args.join(' ')
+    path = ""
+    if options.global
+      path = "#{@gloable_folder}/#{@task_file_name}"
+    else
+      path = "#{Dir.pwd}/#{@task_file_name}"
+    end
+
+    tasks = tasks_at_path(path) || []
+    tasks = tasks.map { |t| t[:task] }
+    tasks.push(task)
+
+    write_tasks_to_path(tasks, path)
+  end
+end
+
+command :done do |c|
+  c.syntax = 'fmn done [options]'
+  c.summary = 'Mark a task as done.'
+  c.description = 'Mark a task as done, removing it from the list.'
+  c.example 'Mark a task as done.', 'fmn done 1'
+  c.action do |args, options|
+    return unless args.length >= 1
+
+    # TODO: check for non numeric arg
+    index = args[0].to_i - 1
+
+    # TODO: check for unexisting index
+    task_to_remove = all_tasks(Dir.pwd)[index]
+    tasks = tasks_at_path(task_to_remove[:path])
+
+    # TODO: this is quite silly, how can we make it better?
+    # TODO: what about tasks with the same name. Does it even make sense?
+    tasks.delete_if { |t| t[:task] == task_to_remove[:task] }
+
+    write_tasks_to_path(tasks.map { |t| t[:task] }, task_to_remove[:path])
+  end
+end
+

data/forget-me-not.rb

@@ -0,0 +1,30 @@
+# Forget Me Not 🌺 - A smart, contextualized todo list. Designed to live in your terminal, and to be in your face.
+
+require 'psych'
+
+puts 'Forget Me Not 🌺\n'
+
+task_file_name = 'tasks.yml'
+
+current_dir = Dir.pwd
+dirs = [current_dir]
+while File.expand_path('..', current_dir) != current_dir do
+  dir = File.expand_path('..', current_dir)
+  dirs.push dir
+  current_dir = dir
+end
+
+tasks = []
+dirs.each do |dir|
+  path = "#{dir}/#{task_file_name}"
+  if File.exists?(path) then
+    yaml = Psych.load_file(path)
+    tasks.push(yaml["tasks"])
+  end
+end
+
+tasks = tasks.flatten
+
+tasks.each do |t|
+  puts "- #{t}"
+end

data/forget_me_not.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fmn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "forget_me_not"
+  spec.version       = FMN::VERSION
+  spec.authors       = ["Giovanni Lodi"]
+  spec.email         = ["giovanni.lodi42@gmail.com"]
+  spec.summary       = %q{A smart, contextualised todo list. Designed to live in your terminal, and to be in your face.
+}
+  spec.description   = %q{A smart, contextualised todo list. Designed to live in your terminal, and to be in your face.}
+  spec.homepage      = "https://github.com/mokagio/forget-me-not"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables << 'fmn'
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/fmn/version.rb

@@ -0,0 +1,3 @@
+module FMN
+  VERSION = '0.0.1'
+end

data/lib/fmn.rb

@@ -0,0 +1,4 @@
+require 'fmn/version'
+
+module FMN
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: forget_me_not
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Giovanni Lodi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: A smart, contextualised todo list. Designed to live in your terminal,
+  and to be in your face.
+email:
+- giovanni.lodi42@gmail.com
+executables:
+- fmn
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/fmn
+- forget-me-not.rb
+- forget_me_not.gemspec
+- lib/fmn.rb
+- lib/fmn/version.rb
+homepage: https://github.com/mokagio/forget-me-not
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A smart, contextualised todo list. Designed to live in your terminal, and
+  to be in your face.
+test_files: []