todown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ccb20420435b76965ded948bf05e11d263dd83f6d2868e88caedd73e5c01b2c7
+  data.tar.gz: 80234205a46516aa54d22db14824efe22ea248310015bea8c0a352ccf7f2d11c
+SHA512:
+  metadata.gz: 22f2820d00a3a9487156a5fa68eed59f7064b7e5b81fa400c50b600772bac7b948e2159a903b7f658fbda0a97694252fad46585c1a0890c02e7bfa5ccdea8650
+  data.tar.gz: 99bb8570df82e1ad2cad1dcc55bbc3f78c1adc0b326253b475a815ec17b2080f4c97a0c41f9aa36f438936ca69326339474f0ed572f30c0756fbc6e976b9ce4c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

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 arousseau@gac-technology.com. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in todown.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    todown (0.1.0)
+      terminal-table (~> 1.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  todown!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Rousseau Alexandre
+
+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,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alexandre Rousseau
+
+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,85 @@
+# Todown
+
+Extract tasks from Markdown file.
+
+> I wanted to organize me without use of some too complecated software.
+
+Example:
+
+~~~txt
+# TODO
+
+## Somethings to buy
+
+- [x] Milk
+- [ ] Sugar
+- [ ] Chocolate @due=2019-02-14
+
+## Ideas
+
+- [x] Make something great @with=ruby @due=2010-01-01
+
+~~~
+
+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"} |
++---+----------------------+-------------------------------------+
+~~~
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'todown'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install todown
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[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.
+
+## 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 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+require 'todown'
+require 'terminal-table'
+require 'optparse'
+
+options = {
+  only_finished: false, 
+  only_unfinished: false, 
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: todown FILEPATH [options]"
+
+  opts.on '-i', '--only_unfinished', 'Display only infinished tasks' do |o|
+    options[:only_unfinished] = true
+  end
+
+  opts.on '-c', '--only_finished', 'Display only finished tasks' do |o|
+    options[:only_finished] = true
+  end
+
+  opts.on '-fFIELD', '--field=FIELD', 'Apply filter on given field' do |o|
+    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
+
+  if ARGV[0].nil?
+    puts "You must provide a file\r\n\r\n"
+    puts opts
+    exit
+  end
+end.parse!
+
+filepath = ARGV[0]
+
+rows = []
+headings = ['', 'Name', 'Attributes']
+
+tasks = Task.from_file filepath do |task|
+  # filter
+  next if options[:only_finished] and task.finished == false
+  next if options[:only_unfinished] and task.finished
+
+  if options.has_key? :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]
+end
+
+table = Terminal::Table.new rows: rows, headings: headings
+
+puts table

data/lib/todown/task.rb

@@ -0,0 +1,43 @@
+class Task
+  attr_reader :name, :finished, :attributes
+
+  # Create many task from given filepath
+  # @param filepath <String> filepath of readable markdown file
+  def self.from_file filepath
+    tasks = []
+
+    File.read(filepath).scan(/- \[( |X|x)\] (.+)/).each do |data|
+      task = Task.new data[1], (data[0] != ' ')
+      tasks << task
+      yield task if block_given?
+    end
+
+    return tasks
+  end
+
+  def initialize(name, finished = false, attributes = {})
+    @name = name
+    @finished = finished
+    @attributes = attributes
+
+    parse_attributes!
+  end
+
+  private
+
+  def parse_attributes!
+    @name.scan(/@([a-z]*)=(\S+)/).each do |data|
+      # insert as attribute
+      key = data[0].to_sym
+      value = data[1]
+      @name.gsub! "@#{key}=#{value}", ''
+      @name.strip!
+      begin
+        value = Date.parse value
+      rescue Exception => e
+      end
+      @attributes[key] = value
+    end
+  end
+
+end

data/lib/todown/version.rb

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

data/lib/todown.rb

@@ -0,0 +1,6 @@
+require "todown/version"
+require "todown/task"
+
+module Todown
+  # Your code goes here...
+end

data/sample.markdown

@@ -0,0 +1,14 @@
+# TODO
+
+## Somethings to buy
+
+- [x] Milk
+- [ ] Sugar
+- [ ] Chocolate @due=2019-02-14
+
+
+## Ideas
+
+- [x] Make something great @with=ruby @due=2010-01-01
+
+

data/todown.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "todown/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "todown"
+  spec.version       = Todown::VERSION
+  spec.authors       = ["Alexandre Rousseau", "madeindjs"]
+  spec.email         = ["contact@rousseau-alexandre.fr"]
+
+  spec.summary       = %q{Markdown + Task}
+  spec.description   = %q{Extract task from your markdown file}
+  spec.homepage      = "https://github.com/madeindjs/todown.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "bin"
+  spec.executables   = ['todown']
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "terminal-table", "~> 1.8"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: todown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexandre Rousseau
+- madeindjs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Extract task from your markdown file
+email:
+- contact@rousseau-alexandre.fr
+executables:
+- todown
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/todown
+- lib/todown.rb
+- lib/todown/task.rb
+- lib/todown/version.rb
+- sample.markdown
+- todown.gemspec
+homepage: https://github.com/madeindjs/todown.git
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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: Markdown + Task
+test_files: []