todo_txt_viewer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8526fcfbd1454bcc870775a23bd2a4d329d9c383b21b5c1e1de4ff7a94875c29
+  data.tar.gz: e031967fa019ecb04d05ea539c3f6b3b2e00dbc00094da03aed348460a967bcb
+SHA512:
+  metadata.gz: 7ab92a1faa619acc813346642e323779b8796545104e95b7a0fb2c8501d00ae41b6bb238000a201f0232af5b14a042f39814612efaa79ddcfebb18e604906f63
+  data.tar.gz: 1437dc5e3daeb46cedf7b2c9e80550513f2012244e76556332634428b6ec80234b5f95f6b124509324d1245ab3025a11552a099b6f624de65179002576160d95

data/.gitignore

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

data/.gitlab-ci.yml

@@ -0,0 +1,7 @@
+image: ruby:2.5.1
+
+before_script:
+  - bundle install
+
+rubocop:
+  script: bundle exec rubocop

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  ThunderKey-rubocop: rubocop.yml

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nicolas@keltec.ch. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:gitlab) {|repo_name| "https://gitlab.com/#{repo_name}" }
+
+# Specify your gem's dependencies in todo_txt_viewer.gemspec
+gemspec
+
+# gem 'fullscreen_tui', path: 'vendor/gems/fullscreen_tui'
+# gem 'fullscreen_tui', gitlab: 'ThunderKey/fullscreen_tui'
+gem 'ThunderKey-rubocop'

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    todo_txt_viewer (0.1.0)
+      fullscreen_tui (~> 0.1)
+      todo-txt (~> 0.12)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ThunderKey-rubocop (0.0.9)
+      rubocop (~> 0.59)
+      rubocop-rspec (~> 1.30)
+    ast (2.4.0)
+    colorize (0.8.1)
+    fullscreen_tui (0.1.0)
+      colorize (~> 0.8)
+      ruby-terminfo (~> 0.1)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.61.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    rubocop-rspec (1.30.1)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    ruby-terminfo (0.1.1)
+    todo-txt (0.12)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ThunderKey-rubocop
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  todo_txt_viewer!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nicolas Ganz
+
+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,43 @@
+# TodoTxtViewer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/todo/txt/viewer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'todo_txt_viewer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install todo_txt_viewer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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://gitlab.com/ThunderKey/todo_txt_viewer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TodoTxtViewer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/ThunderKey/todo_txt_viewer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'todo_txt_viewer'
+
+# 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/todo_txt_viewer

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'todo_txt_viewer'
+
+TodoTxtViewer.ui.run

data/lib/todo_txt_viewer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'todo_txt_viewer/version'
+require_relative 'todo_txt_viewer/ui'
+
+module TodoTxtViewer
+  def self.ui
+    folder = Pathname.new File.join(Dir.home, '.todo-txt')
+    Ui.new folder.join('todo.txt'), folder.join('done.txt')
+  end
+end

data/lib/todo_txt_viewer/header_line.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module TodoTxtViewer
+  class HeaderLine
+    def initialize header
+      @header = header.to_s
+    end
+
+    def to_s
+      @header
+    end
+
+    def task_action(action) end
+  end
+end

data/lib/todo_txt_viewer/help_ui.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TodoTxtViewer
+  class HelpUi < FullscreenTui
+    CONTENT = {
+      'd' => 'do/mark as done',
+      'u' => 'undo/mark as todo',
+      'a' => 'archive this task',
+      '+' => 'increase the priority',
+      '-' => 'decrease the priority',
+      '1-9' => 'set priority to A-I',
+      '0' => 'remove the priority',
+      'i' => 'insert a new task',
+      'r' => 'reload the file',
+      'h/?' => 'show this help',
+      'q' => 'quit',
+    }.freeze
+
+    def initialize
+      super headers: ['Help']
+      key_width = CONTENT.keys.map(&:size).max
+      @lines = CONTENT.map {|k, v| "#{k.ljust key_width} = #{v}" }
+    end
+  end
+end

data/lib/todo_txt_viewer/task_line.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module TodoTxtViewer
+  class TaskLine
+    ALLOWED_ACTIONS = %i(do! undo! priority_inc! priority_dec!).freeze
+
+    attr_reader :task
+
+    def initialize task
+      @task = task
+    end
+
+    def to_s
+      task.to_s
+    end
+
+    def task_action action
+      raise "illegal action #{action}" unless ALLOWED_ACTIONS.include? action
+
+      task.send action
+    end
+  end
+end

data/lib/todo_txt_viewer/ui.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'todo-txt'
+require 'fullscreen_tui'
+require_relative 'task_line'
+require_relative 'header_line'
+require_relative 'help_ui'
+
+module TodoTxtViewer
+  class Ui < FullscreenTui
+    def initialize main_file, archive_file
+      super headers: []
+
+      @main_file = main_file.to_s
+      @archive_file = archive_file.to_s
+      load_file
+    end
+
+    def key_press key # rubocop:disable Metrics/CyclomaticComplexity
+      case key
+      when 'd' then task_action :do!
+      when 'u' then task_action :undo!
+      when 'a' then archive_task
+      when '+' then task_action :priority_inc!
+      when '-' then task_action :priority_dec!
+      when ('0'..'9') then select_priority key
+      when 'i' then create_task
+      when 'r' then load_file
+      when 'h', '?' then help
+      else super
+      end
+    end
+
+    private
+
+    def task_action action
+      selected_line.task_action action
+      @list.save!
+      load_lines
+    end
+
+    def archive_task
+      archive = Todo::List.new @archive_file
+      task = selected_line.task
+      @list.delete_if {|other| other.object_id == task.object_id }
+      archive << task
+      archive.save!
+      @list.save!
+      load_lines
+      @footer.message = "Archived the Task #{task}"
+    end
+
+    def select_priority key
+      task = selected_line.task
+      key = key.to_i
+      priority = key.zero? ? nil : ('A'.ord + key - 1).chr
+      task.instance_variable_set :@priority, priority
+      @list.save!
+      load_lines
+    end
+
+    def create_task
+      line = read_full_line 'Please enter a task:'
+      task = Todo::Task.new line
+      task.instance_variable_set(:@created_on, Date.today) unless task.created_on
+      @list << task
+      @list.save!
+      load_lines
+      @footer.message = 'Task inserted'
+    end
+
+    def help
+      HelpUi.new.run
+    end
+
+    def load_file
+      @list = Todo::List.new @main_file
+      load_lines
+      @footer.message = "Loaded: #{@main_file}"
+    end
+
+    def load_lines
+      @lines = []
+
+      @lines << HeaderLine.new('# todo')
+      @list.by_not_done.sort.reverse_each {|t| @lines << TaskLine.new(t) }
+
+      @lines << HeaderLine.new('# done')
+      @list.by_done.sort.reverse_each {|t| @lines << TaskLine.new(t) }
+    end
+  end
+end

data/lib/todo_txt_viewer/version.rb

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

data/todo_txt_viewer.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'todo_txt_viewer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'todo_txt_viewer'
+  spec.version       = TodoTxtViewer::VERSION
+  spec.authors       = ['Nicolas Ganz']
+  spec.email         = ['nicolas@keltec.ch']
+
+  spec.summary       = 'An interactive viewer for todo.txt'
+  spec.homepage      = 'https://gitlab.com/ThunderKey/todo_txt_viewer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency 'fullscreen_tui', '~> 0.1'
+  spec.add_dependency 'todo-txt', '~> 0.12'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: todo_txt_viewer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Ganz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fullscreen_tui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: todo-txt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 
+email:
+- nicolas@keltec.ch
+executables:
+- todo_txt_viewer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/todo_txt_viewer
+- lib/todo_txt_viewer.rb
+- lib/todo_txt_viewer/header_line.rb
+- lib/todo_txt_viewer/help_ui.rb
+- lib/todo_txt_viewer/task_line.rb
+- lib/todo_txt_viewer/ui.rb
+- lib/todo_txt_viewer/version.rb
+- todo_txt_viewer.gemspec
+homepage: https://gitlab.com/ThunderKey/todo_txt_viewer
+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.7.6
+signing_key: 
+specification_version: 4
+summary: An interactive viewer for todo.txt
+test_files: []