worque 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 509912a33940b740eb50a0c98aa55f256e90cd48
-  data.tar.gz: d7dc7cd45b482af9b5c6001289c2ea7dac11b258
+  metadata.gz: fcaba8f8f67002bfdd2c6b8eb49961deda41186f
+  data.tar.gz: bcc471deff6aa73ab3481819b6396a0e13e214d8
 SHA512:
-  metadata.gz: 23dfc71b98a0d455469892dd4f917885bf7f40173db4bd30c4363f7c680d2da22c455eeb13a067da700409a74fdbd99cd28b09c1070fe06ef54c2c9406acc4d6
-  data.tar.gz: 9c16073df9e1e2d069739c4c7b535254892f765d8604d72e90b9abec64f539d529ca17e1888529665df2c46eca44969dfe50939e8842a613d2816ceae0e747af
+  metadata.gz: 4e7143b95c2d5a40c92290189ae9c62c45442c265ceb8807dd54519216a2d5184544df2c9e9f96b422280b3b8df0340fe8165fc3f373fae50cc8e9257a8c7124
+  data.tar.gz: 2a3b41249ac41cec06aeea39a10f58b7d4234c5c773083d04dca0a85d757d354aeafac7106ac9fbc8e7962e9dc3238e26271f0e707cd02cfa4c11e99b50c94ef

data/README.md

@@ -37,19 +37,30 @@ Or, if you're using RVM and want the command available system-wide while keeping
 
 #### `worque todo`
 
-Add this to your `.bash_profile`
+Explicitly declare your path
 
 ```sh
-export WORQUE_PATH='/path/to/your/notes'
+worque todo --path /path/to/your/notes
 ```
 
-I often map it to my Dropbox like this
+Or you might want to put it in the global configuration file `~/.worquerc`
+
+```json
+{
+  "path": "/path/to/your/notes"
+}
+```
+
+
+I often prefer mapping notes to my Dropbox like this:
 
 ```sh
-export WORQUE_PATH='~/Dropbox/Notes/Todos'
+{
+  "path": "~/Dropbox/Notes/Todos"
+}
 ```
 
-Then executing the command below will create a today's note for you
+Then executing the command below will create a today's note.
 
 ```sh
 worque todo --for today
@@ -59,21 +70,22 @@ worque todo --for today
 Or look back what's done yesterday.
 
 ```sh
-workque todo --for=yesterday
+worque 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.
+Lastly, jump ahead and start to plan for tomorrow.
 
 ```sh
-worque todo --for yesterday --no-skip-weekend
+worque todo --for=tomorrow
+# ~/notes/checklist-2016-07-20.md
 ```
 
-You can also explicitly specify the file path
+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 today --path ~/path/to/your/notes
+worque todo --for yesterday --no-skip-weekend
 ```
 
 Moreover, you can add a task into your notes quickly without open that file.
@@ -93,8 +105,8 @@ 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'"
+alias today="vim $(worque todo)"
+alias ytd="vim $(worque todo --for=yesterday)"
 ```
 
 #### `worque push`
@@ -138,7 +150,7 @@ bundle install
 bundle exec rake test
 ```
 
-## To be implemented
+## WORKQUE FOR WORKQUE
 
 Something in my plan:
 

data/lib/worque/cli.rb

@@ -1,8 +1,9 @@
 require 'thor'
-require 'worque/command/todo'
+require 'worque/command/todo/action'
 require 'worque/command/todo/options'
-require 'worque/command/push'
+require 'worque/command/push/action'
 require 'worque/command/push/options'
+require 'worque/default_config'
 
 module Worque
   class CLI < ::Thor
@@ -10,16 +11,17 @@ module Worque
 
     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']
-    method_option :append_task, force: false, type: :string
+    method_option :for, type: :string, enum: ['today', 'yesterday', 'tomorrow'], default: 'today'
+    method_option :skip_weekend, type: :boolean, default: true
+    method_option :path, type: :string
+    method_option :append_task, type: :string
 
     def todo
       begin
-        result = Worque::Command::Todo.run(options)
+        default_opts = Worque::DefaultConfig.load!.data
+        result = Worque::Command::Todo::Action.run(default_opts.merge options)
       rescue InvalidPath => e
-        abort e.message
+        $stderr.puts e.message
       end
 
       $stdout.puts result
@@ -27,11 +29,13 @@ module Worque
 
     desc 'push', 'Push your notes to Slack channel'
 
-    method_option :for, force: false, type: :string, enum: ['today', 'yesterday'], default: 'today'
-    method_option :channel, force: true, required: true, type: :string, desc: 'Can be channel, private group ID or name. E.g. #daily-report'
+    method_option :path, type: :string
+    method_option :for, type: :string, enum: ['today', 'yesterday', 'tomorrow'], default: 'today'
+    method_option :channel, required: true, type: :string, desc: 'Can be channel, private group ID or name. E.g. #daily-report'
 
     def push
-      $stdout.puts Worque::Command::Push.run(options)
+      default_opts = Worque::DefaultConfig.load!.data
+      $stdout.puts Worque::Command::Push::Action.run(default_opts.merge options)
     end
   end
 end

data/lib/worque/command/push/action.rb

@@ -0,0 +1,55 @@
+require 'worque/utils/slack'
+require 'worque/utils/business_day'
+require 'json'
+
+module Worque
+  module Command
+    module Push
+      class Action
+        REPORT_FILE_PATH_FORMAT = "%<worque_path>s/notes-%<date_for>s.md".freeze
+
+        def initialize(options)
+          @options = options
+        end
+
+        def call
+          slack = Worque::Utils::Slack.new(options.token)
+          JSON.dump(slack.post(options.channel, report_file_content))
+        end
+
+        class << self
+          def run(options)
+            require 'worque/command/push/options'
+
+            new(Worque::Command::Push::Options.new(options)).call()
+          end
+        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, true)
+          end
+        end
+
+        def report_file_content
+          File.open(report_file_path).read
+        end
+
+        def report_file_path
+          REPORT_FILE_PATH_FORMAT % Hash[
+            worque_path: options.path,
+            date_for: date_for
+          ]
+        end
+      end
+    end
+  end
+end
+

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

@@ -4,11 +4,13 @@ module Worque
       attr_reader :channel
       attr_reader :token
       attr_reader :for
+      attr_reader :path
 
       def initialize(options)
         @channel = options[:channel]
+        @path = options[:path]
         @for = options[:for]
-        @token = ENV['SLACK_API_TOKEN']
+        @token = options[:token]
       end
     end
   end

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

@@ -0,0 +1,63 @@
+require 'worque/utils/command'
+require 'worque/utils/business_day'
+require 'date'
+
+module Worque
+  module Command
+    module Todo
+      class Action
+        FILE_PATH_FORMAT = "%<path>s/notes-%<date>s.md".freeze
+
+        def initialize(options)
+          @options = options
+          validate_options!
+        end
+
+        def call
+          Worque::Utils::Command.mkdir(options.path)
+
+          notes_file_path = filename(date_for).tap do |f|
+            Worque::Utils::Command.touch f
+          end
+
+          if options.append_task
+            Worque::Utils::Command.append_text(notes_file_path, options.append_task)
+          end
+
+          notes_file_path
+        end
+
+        class << self
+          def run(options)
+            new(Worque::Command::Todo::Options.new(options)).call()
+          end
+        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?)
+          when :tomorrow
+            Worque::Utils::BusinessDay.next(Date.today, options.skip_weekend?)
+          end
+        end
+
+        def filename(date)
+          FILE_PATH_FORMAT % { path: options.path, date: date }
+        end
+
+        def validate_options!
+          if options.path.to_s.empty?
+            raise InvalidPath, 'Neither --path nor WORQUE_PATH is not set'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/worque/default_config.rb

@@ -0,0 +1,33 @@
+module Worque
+  class Hash < ::Thor::CoreExt::HashWithIndifferentAccess; end
+
+  class DefaultConfig
+    attr_reader :data
+
+    def initialize(data = ::Worque::Hash.new)
+      @data = data
+    end
+
+    class << self
+      def load!
+        new(::Worque::Hash.new(parsed_config))
+      end
+
+      private
+
+      def parsed_config
+        JSON.parse(load_file)
+      rescue Errno::ENOENT
+        {}
+      end
+
+      def load_file
+        File.read(config_file_path)
+      end
+
+      def config_file_path
+        "#{Dir.home}/.worquerc"
+      end
+    end
+  end
+end

data/lib/worque/utils/business_day.rb

@@ -3,8 +3,8 @@ module Worque
     module BusinessDay
       extend self
 
-      def next(date)
-        shift(date, 1)
+      def next(date, skip_weekend = true)
+        shift(date, 1, skip_weekend)
       end
 
       def previous(date, skip_weekend = true)
@@ -18,11 +18,9 @@ module Worque
       private
 
       def shift(date, inc, skip_weekend = true)
-        loop do
-          date += inc
-          break if !skip_weekend || !weekend?(date)
-        end
-        date
+        return date + inc unless skip_weekend && weekend?(date + inc)
+
+        shift(date + inc, inc, skip_weekend)
       end
 
       def weekend?(date)

data/lib/worque/version.rb

@@ -1,3 +1,3 @@
 module Worque
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worque
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Cam Huynh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-27 00:00:00.000000000 Z
+date: 2016-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -108,10 +108,11 @@ files:
 - bin/worque
 - lib/worque.rb
 - lib/worque/cli.rb
-- lib/worque/command/push.rb
+- lib/worque/command/push/action.rb
 - lib/worque/command/push/options.rb
-- lib/worque/command/todo.rb
+- lib/worque/command/todo/action.rb
 - lib/worque/command/todo/options.rb
+- lib/worque/default_config.rb
 - lib/worque/utils/business_day.rb
 - lib/worque/utils/command.rb
 - lib/worque/utils/slack.rb
@@ -137,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Manage your daily working list

data/lib/worque/command/push.rb

@@ -1,48 +0,0 @@
-require 'worque/utils/slack'
-require 'worque/utils/business_day'
-require 'json'
-
-module Worque
-  module Command
-    class Push
-      def initialize(options)
-        @options = options
-      end
-
-      def call
-        slack = Worque::Utils::Slack.new(options.token)
-        JSON.dump(slack.post(options.channel, report_file_content))
-      end
-
-      def self.run(options)
-        require 'worque/command/push/options'
-
-        Worque::Command::Push.new(
-          Worque::Command::Push::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, true)
-        end
-      end
-
-      def report_file_content
-        File.open(report_file_path).read
-      end
-
-      def report_file_path
-        "#{ ENV['WORQUE_PATH'] }/notes-#{date_for}.md"
-      end
-    end
-  end
-end
-

data/lib/worque/command/todo.rb

@@ -1,58 +0,0 @@
-require 'worque/utils/command'
-require 'worque/utils/business_day'
-require 'date'
-
-module Worque
-  module Command
-    class Todo
-      def initialize(options)
-        @options = options
-        validate_options!
-      end
-
-      def call
-        Worque::Utils::Command.mkdir(options.path)
-
-        notes_file_path = filename(date_for)
-        notes_file_path.tap do |f|
-          Worque::Utils::Command.touch f
-        end
-
-        if options.append_task
-          Worque::Utils::Command.append_text(notes_file_path, options.append_task)
-        end
-
-        notes_file_path
-      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
-
-      def validate_options!
-        if options.path.to_s.empty?
-          raise InvalidPath, 'Neither --path nor WORQUE_PATH is not set'
-        end
-      end
-    end
-  end
-end