todown 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: ccb20420435b76965ded948bf05e11d263dd83f6d2868e88caedd73e5c01b2c7
-  data.tar.gz: 80234205a46516aa54d22db14824efe22ea248310015bea8c0a352ccf7f2d11c
+SHA1:
+  metadata.gz: 8cbdcc511e30fb27cbc3b0754a9f73201da8ad69
+  data.tar.gz: 2d141a38c54a73d6e18d6a3f6c5216dae8a103ef
 SHA512:
-  metadata.gz: 22f2820d00a3a9487156a5fa68eed59f7064b7e5b81fa400c50b600772bac7b948e2159a903b7f658fbda0a97694252fad46585c1a0890c02e7bfa5ccdea8650
-  data.tar.gz: 99bb8570df82e1ad2cad1dcc55bbc3f78c1adc0b326253b475a815ec17b2080f4c97a0c41f9aa36f438936ca69326339474f0ed572f30c0756fbc6e976b9ce4c
+  metadata.gz: 636a15bd9ab11c114b3abd0da1926601f33302e3e06eabe5896405133f198941d63363a515d7c9e57f3e6ea375b83e3bca3c150e3adfd45d14344cf6eaa239a5
+  data.tar.gz: 8a5f485fef5ae7db93a0908a22739252d259f517d1276125df75f3f37a9c374e664b9db558431cb30836911cd877734bcfb4ad30f2bfe723170bb8481db6ae90

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    todown (0.1.0)
+    todown (0.2.0)
       terminal-table (~> 1.8)
 
 GEM

data/README.md

@@ -2,9 +2,9 @@
 
 Extract tasks from Markdown file.
 
-> I wanted to organize me without use of some too complecated software.
+> I wanted to organize me without use of too complicated software.
 
-Example:
+Example with _sample.markdown_ file:
 
 ~~~txt
 # TODO
@@ -25,46 +25,51 @@ Become bellow using
 
 ~~~bash
 $ todown sample.markdown
-+---+----------------------+-------------------------------------+
-|   | Name                 | Attributes                          |
-+---+----------------------+-------------------------------------+
-| X | Milk                 | {}                                  |
-|   | Sugar                | {}                                  |
-|   | Chocolate            | {:due=>"2019-02-14"}                |
-| X | Make something great | {:with=>"ruby", :due=>"2010-01-01"} |
-+---+----------------------+-------------------------------------+
 ~~~
-
-you can also aply filter
-
-~~~bash
-$ todown sample.markdown --field=with
-+---+----------------------+-------------------------------------+
-|   | Name                 | Attributes                          |
-+---+----------------------+-------------------------------------+
-| X | Make something great | {:with=>"ruby", :due=>"2010-01-01"} |
-+---+----------------------+-------------------------------------+
+~~~txt
++---+----------------------+------------+------+
+|   | Name                 | due        | with |
++---+----------------------+------------+------+
+| X | Milk                 |            |      |
+|   | Sugar                |            |      |
+|   | Chocolate            | 2019-02-14 |      |
+| X | Make something great | 2010-01-01 | ruby |
++---+----------------------+------------+------+
 ~~~
 
-## Installation
 
-Add this line to your application's Gemfile:
+## Usage
 
-```ruby
-gem 'todown'
-```
+You simply define task in your markdown file using [Github task list syntax](https://blog.github.com/2014-04-28-task-lists-in-all-markdown-documents/) like this:
+
+~~~txt
+- [x] Make something great
+~~~
 
-And then execute:
+You can also apply filter using `@tag=value`
 
-    $ bundle
+~~~txt
+- [x] Make something great @with=ruby @due=2010-01-01
+~~~
 
-Or install it yourself as:
+And then you can apply filter can also aply filter
 
-    $ gem install todown
+~~~bash
+$ todown sample.markdown --field=due --after=2019-01-01
+~~~
+~~~txt
++--+-----------+------------+
+|  | Name      | due        |
++--+-----------+------------+
+|  | Chocolate | 2019-02-14 |
++--+-----------+------------+
+~~~
 
-## Usage
+## Installation
 
-TODO: Write usage instructions here
+```ruby
+gem install todown
+```
 
 ## Development
 
@@ -74,7 +79,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/todown. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/madeindjs/todown. 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
 
@@ -82,4 +87,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Todown project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/todown/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Todown project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/madeindjs/todown/blob/master/CODE_OF_CONDUCT.md).

data/bin/todown

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
 require 'todown'
-require 'terminal-table'
 require 'optparse'
+require 'date'
 
 options = {
-  only_finished: false, 
-  only_unfinished: false, 
+  only_finished: false,
+  only_unfinished: false,
 }
 
 OptionParser.new do |opts|
@@ -23,21 +23,15 @@ OptionParser.new do |opts|
     options[:field] = o
   end
 
-  # opts.on '-aDATE', '--after=DATE', 'Filter tasks after given date', 'Exemple: `todown --field=due --after=2018 FILE`' do |filter|
-  #   if defined? options[:field]
-  #     puts 'You should provide `-field=FIELD` argument' 
-  #     exit
-  #   end
-  #   options[:after] = v
-  # end
-
-  # opts.on '-bDATE', '--before=DATE', 'Filter tasks after given date', 'Exemple: `todown --field=due --before=2018 FILE`' do |filter|
-  #   if defined? options[:field]
-  #     puts 'You should provide `-field=FIELD` argument' 
-  #     exit
-  #   end
-  #   options[:before] = v
-  # end
+  opts.on '-aDATE', '--after=DATE', 'Filter tasks after given date', 'Exemple: `todown --field=due --after=2018 FILE`' do |filter|
+    puts 'You should provide `--field=FIELD` argument' && exit if options[:field].nil?
+    options[:after] = Date.parse filter
+  end
+
+  opts.on '-bDATE', '--before=DATE', 'Filter tasks after given date', 'Exemple: `todown --field=due --before=2018 FILE`' do |filter|
+    puts 'You should provide `--field=FIELD` argument' && exit if options[:field].nil?
+    options[:before] = Date.parse filter
+  end
 
   if ARGV[0].nil?
     puts "You must provide a file\r\n\r\n"
@@ -48,23 +42,42 @@ end.parse!
 
 filepath = ARGV[0]
 
-rows = []
-headings = ['', 'Name', 'Attributes']
 
-tasks = Task.from_file filepath do |task|
+tasks = []
+total_count = 0
+
+Task.from_file(filepath) do |task|
+  total_count += 1
   # filter
   next if options[:only_finished] and task.finished == false
   next if options[:only_unfinished] and task.finished
 
   if options.has_key? :field
+    # filter only element who own the specified field
     field = options[:field]
     next unless task.attributes.has_key?(field.to_sym)
   end
 
-  status = task.finished ? 'X' : ''
-  rows << [status, task.name, task.attributes.to_s]
+  if options.has_key? :after
+    # filter only element who are after the given date
+    next if task.attributes[field.to_sym] < options[:after]
+  end
+
+  if options.has_key? :before
+    # filter only element who are after the given date
+    next if task.attributes[field.to_sym] > options[:before]
+  end
+
+  tasks << task
 end
 
-table = Terminal::Table.new rows: rows, headings: headings
 
-puts table
+puts Todown.task_to_table tasks
+
+exit if total_count == 1
+
+if options.has_key? :field
+  puts "%s of %s tasks displayed" % [ tasks.count, total_count]
+else
+  puts "%s tasks displayed" % [ tasks.count ]
+end

data/lib/todown/task.rb

@@ -1,8 +1,17 @@
+# Represent a task extracted from markdown file
 class Task
-  attr_reader :name, :finished, :attributes
+  # @return [String] The name of the task
+  attr_reader :name
+  # @return [Boolean] The status of the task (`true` for completed, `false` for to do)
+  attr_reader :finished
+  # @return [Hash] an hash containing various attributes
+  attr_reader :attributes
 
   # Create many task from given filepath
-  # @param filepath <String> filepath of readable markdown file
+  #
+  # @param filepath [String] filepath of readable markdown file
+  # @yield [Task]
+  # @return [Array<Task>]
   def self.from_file filepath
     tasks = []
 
@@ -15,6 +24,11 @@ class Task
     return tasks
   end
 
+  # Returns a new instance of Task
+  #
+  # @param name [String]
+  # @param finished [Boolean]
+  # @param attributes [Hash] an hash containing various attributes
   def initialize(name, finished = false, attributes = {})
     @name = name
     @finished = finished
@@ -25,6 +39,7 @@ class Task
 
   private
 
+  # Try to parse attributes from `Task.name`
   def parse_attributes!
     @name.scan(/@([a-z]*)=(\S+)/).each do |data|
       # insert as attribute

data/lib/todown/version.rb

@@ -1,3 +1,3 @@
 module Todown
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/todown.rb

@@ -1,6 +1,52 @@
 require "todown/version"
 require "todown/task"
+require 'terminal-table'
 
 module Todown
-  # Your code goes here...
+
+  # Create a `Terminal::Table` from many task
+  #
+  # @param tasks [Array<Task>]
+  # @return [Terminal::Table]
+  def self.task_to_table tasks
+    return Terminal::Table.new(Todown.task_to_hash_table(tasks))
+  end
+
+  # Manipulate data to transform in the expected format for `Terminal::Table`
+  #
+  # @param tasks [Array<Task>]
+  # @return [Hash<Symbol, Array>]
+  def self.task_to_hash_table tasks
+    rows = []
+    attributes_keys = []
+
+    tasks.each do |task|
+      task.attributes.keys.each {|key| attributes_keys << key.to_s }
+    end
+
+    attributes_keys.uniq!
+
+    headings = ['', 'Name'].concat attributes_keys
+
+    tasks.each do |task|
+      row = []
+      row << (task.finished ? 'X' : '')
+      row << task.name
+
+      # Insert attributes in the same order
+      attributes_keys.each do |attribute_key|
+        attribute_value = task.attributes[attribute_key.to_sym]
+        if attribute_value
+          row << attribute_value.to_s
+        else
+          row << ''
+        end
+      end
+
+      rows << row
+    end
+
+    return {rows: rows, headings: headings }
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: todown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexandre Rousseau
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-29 00:00:00.000000000 Z
+date: 2018-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: terminal-table
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Markdown + Task