worque 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 567433182ef250050cd55e4142292a4e5c583aea
+  data.tar.gz: 56a867bb80135417507a4b81808965d56d26f172
+SHA512:
+  metadata.gz: 19ac08d6b0f7815b4e8390a4b2c14655378e45ca822088885310af3c88fe16dfb142f66bec665427956b269d8d4e7dfa43cedca289196ed4ddd666c8feaa9a59
+  data.tar.gz: f4171311af2b16fab768588ba4d692e57633dbd1fa3fb46fe3c06a35e3f3a6b67ab2dd65e44008fe296e0b3c5f0cada01e57b2afee5bf270cca2c9f6bc939747

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Cam Huynh
+
+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,119 @@
+# Worque
+
+Worque is a CLI which is helpful to manage your daily notes.
+
+* Ever stunned when your boss suddenly asked what you've done yesterday?
+* Wanna check/note your daily tasks without exiting your favourite editor `VIM`?
+* Something to report on daily stand-ups?
+
+Then worque is definitely a right tool for you!
+
+## Installation
+
+**DO NOT add this to your Gemfile**
+
+Install it by
+
+    $ gem install worque
+
+## Quick start guide
+
+### CLI
+
+#### `worque todo`
+
+Add this to your `.bash_profile`
+
+```sh
+export WORQUE_PATH='/path/to/your/notes'
+```
+
+I often map it to my Dropbox like this
+
+```sh
+export WORQUE_PATH='~/Dropbox/Notes/Todos'
+```
+
+Then executing the command below will create a today's note for you
+
+```sh
+worque todo --for today
+# ~/notes/notes-2016-07-19.md
+```
+
+Or look back what's done yesterday.
+
+```sh
+workque todo --for=yesterday
+# ~/notes/checklist-2016-07-18.md
+# This will jump back to Friday's note if it's Monday today!
+```
+
+If you're kind of nerd and you have no life. You would rather work over the weekend than hanging out with folks, so you should enable the **hardcore** mode which will stop skipping weekend for you.
+
+```sh
+worque todo --for yesterday --no-skip-weekend
+```
+
+You can also explicitly specify the file path
+
+```sh
+worque todo --for today --path ~/path/to/your/notes
+```
+
+It's chain-able with other commands
+
+```sh
+vim worque
+vim $(worque todo --for yesterday)
+cat $(worque todo --for=yesterday) | grep pending
+```
+
+Personally I alias it like `today` like this, so vim will automatically open the
+file when I type `today`
+
+```sh
+alias today="vim $(worque todo) +':cd $WORQUE_PATH'"
+alias ytd="vim $(worque todo) +':cd $WORQUE_PATH'"
+```
+
+### VIM Integration
+
+Add this to your VIM plugin manager
+
+```viml
+Plug 'huynhquancam/vim-worque'
+```
+
+Then `:TD`, `:YTD` for today and yesterday's notes respectively.
+
+Read more about [vim-worque](https://github.com/huynhquancam/vim-worque).
+
+View more in my [dotfiles](https://github.com/huynhquancam/dotfiles)
+
+## Development
+
+```sh
+bundle install
+bundle exec rake test
+```
+
+## To be implemented
+
+Something in my plan:
+
+* Test suites: Embarrassingly there's no test currently, but this will be my
+  first priority.
+* `worque list`: List all notes you have.
+* `worque push`: Push your daily notes to your specified Slack channel.
+* `worque changelog`: Sync your Git commits to daily notes.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/huynhquancam/worque.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+

data/bin/console

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

data/bin/worque

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'worque'
+
+Worque::CLI.start
+

data/lib/worque/cli.rb

@@ -0,0 +1,17 @@
+require 'thor'
+require 'worque/command/todo'
+require 'worque/command/todo/options'
+
+module Worque
+  class CLI < ::Thor
+    desc 'todo', 'Make a todo'
+
+    method_option :for, force: false, type: :string, enum: ['today', 'yesterday'], default: 'today'
+    method_option :skip_weekend, force: false, type: :boolean, default: true
+    method_option :path, force: false, type: :string, default: ENV['WORQUE_PATH']
+
+    def todo
+      $stdout.puts Worque::Command::Todo.run(options)
+    end
+  end
+end

data/lib/worque/command/todo/options.rb

@@ -0,0 +1,22 @@
+require 'optparse'
+require 'pathname'
+
+module Worque
+  module Command
+    class Todo::Options
+      attr_accessor :path
+      attr_accessor :for
+      attr_writer :skip_weekend
+
+      def initialize(opts)
+        @path = opts[:path]
+        @skip_weekend = opts[:skip_weekend]
+        @for = opts[:for]
+      end
+
+      def skip_weekend?
+        !!@skip_weekend
+      end
+    end
+  end
+end

data/lib/worque/command/todo.rb

@@ -0,0 +1,44 @@
+require 'worque/utils/command'
+require 'worque/utils/business_day'
+require 'date'
+
+module Worque
+  module Command
+    class Todo
+      def initialize(options)
+        @options = options
+      end
+
+      def call
+        Worque::Utils::Command.mkdir(options.path)
+
+        filename(date_for).tap do |f|
+          Worque::Utils::Command.touch f
+        end
+      end
+
+      def self.run(options)
+        Worque::Command::Todo.new(
+          Worque::Command::Todo::Options.new(options)
+        ).call()
+      end
+
+      private
+
+      attr_reader :options
+
+      def date_for
+        case options.for.to_sym
+        when :today
+          Date.today
+        when :yesterday
+          Worque::Utils::BusinessDay.previous(Date.today, options.skip_weekend?)
+        end
+      end
+
+      def filename(date)
+        "#{options.path}/notes-#{date}.md"
+      end
+    end
+  end
+end

data/lib/worque/command.rb

@@ -0,0 +1,10 @@
+require 'worque/command/todo'
+module Worque
+  module Command
+    extend self
+
+    def run(options)
+      Todo.new(options).call()
+    end
+  end
+end

data/lib/worque/utils/business_day.rb

@@ -0,0 +1,33 @@
+module Worque
+  module Utils
+    module BusinessDay
+      extend self
+
+      def next(date)
+        shift(date, 1)
+      end
+
+      def previous(date, skip_weekend = true)
+        shift(date, -1, skip_weekend)
+      end
+
+      def previous_continuous(date)
+        shift(date, -1, false)
+      end
+
+      private
+
+      def shift(date, inc, skip_weekend = true)
+        loop do
+          date += inc
+          break if !skip_weekend || !weekend?(date)
+        end
+        date
+      end
+
+      def weekend?(date)
+        date.wday == 0 || date.wday == 6
+      end
+    end
+  end
+end

data/lib/worque/utils/command.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+
+module Worque
+  module Utils
+    module Command
+      extend self
+
+      def mkdir(dir)
+        FileUtils.mkdir_p(dir)
+      end
+
+      def touch(path)
+        FileUtils.touch(path)
+      end
+    end
+  end
+end

data/lib/worque/version.rb

@@ -0,0 +1,3 @@
+module Worque
+  VERSION = "0.1.3"
+end

data/lib/worque.rb

@@ -0,0 +1,5 @@
+require "worque/version"
+require 'worque/command'
+require 'worque/cli'
+
+module Worque; end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: worque
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Cam Huynh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: Manage your daily working list in Ruby
+email:
+- huynhquancam@gmail.com
+executables:
+- worque
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/worque
+- lib/worque.rb
+- lib/worque/cli.rb
+- lib/worque/command.rb
+- lib/worque/command/todo.rb
+- lib/worque/command/todo/options.rb
+- lib/worque/utils/business_day.rb
+- lib/worque/utils/command.rb
+- lib/worque/version.rb
+homepage: https://github.com/huynhquancam/worque
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Manage your daily working list
+test_files: []