twmail 0.0.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9f8387ff67c2e8b5ee9b4061dfa36dddddd26e9b
-  data.tar.gz: 886975f525e024cba8d9d8ec86a55eec4880c70b
+SHA256:
+  metadata.gz: 748e85ed390994cdeddf2c241a5b6335a7e60496d158be94b73964163747cd88
+  data.tar.gz: f07bbac0bd59b9c83f1236573f65532276945c58b8ceb17334fb8087c0cb9b21
 SHA512:
-  metadata.gz: d7236e1a61c4addf575f3625a3195a16fefd2fdbe24baa66d341613fc00d46e52c8a119aea257e1a9a37bd8800174f258debf72eb1c48da14e828298bbdcb849
-  data.tar.gz: 507d2712dc34bdbe418f61b8eeb4d0d69bb28feb75ed05dfe2453add66710b5fac60f652d9d5ffb94984d18fa25f7553beb24ecf353b6ef6463c3d9e1703eb56
+  metadata.gz: d44ef50ea1e6f57ff3d6fb46b78a110e1ef988b04b964cbaa574fec0a129e429b4948e6522163c9991674d0c5b4b9c25e01a85328371dd55072727e9ebb653e8
+  data.tar.gz: 12c9faef4553825b5b5b796041e9345ec437c91a9145e2736f069731b2c2865d4ae3fde6c681b13b6438fce05378051d45ae42f4479bb2a0ecbd9722d34380d3

data/.rubocop.yml

@@ -0,0 +1,43 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/*.rake'
+  Exclude:
+    - vendor/**/*
+    - db/migrations/**/*
+
+  DisplayCopNames:
+    Enabled: true
+
+  DisplayStyleGuide:
+    Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Layout/LineLength:
+  Max: 180
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+2.7.1

data/.travis.yml

@@ -0,0 +1,13 @@
+dist: xenial
+language: ruby
+rvm:
+- 2.7.1
+- 2.6.6
+- 2.5.8
+
+before_script:
+ - mkdir ~/.task
+ - echo data.location=~/.task > ~/.taskrc
+
+before_install:
+ - sudo apt-get install task

data/Gemfile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # use local twtest while developing
-group :development do
-  gem "twtest", :path => "../twtest"
-end
+# group :development do
+#   gem 'twtest', path: '../twtest'
+# end
 
 gemspec

data/Guardfile

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 guard 'bundler' do
   watch('Gemfile')
   watch(/^.+\.gemspec/)
 end
 
-guard :test, :test_paths => ['test/unit'] do
-  watch(%r{^lib/(.+)\.rb$}){|m| "test/#{m[1]}_test.rb"}
+guard :test, test_paths: ['test/unit'] do
+  watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
   watch(%r{^test/unit/test_(.+)\.rb$})
-  watch('test/test_helper.rb'){"test"}
-  watch('test/helpers/**/*'){"test"}
+  watch('test/test_helper.rb') { 'test' }
+  watch('test/helpers/**/*') { 'test' }
 end

data/README.md

@@ -1,5 +1,7 @@
 # twmail
 
+[![Build Status](https://travis-ci.org/nerab/TaskWarriorMail.svg?branch=master)](https://travis-ci.org/nerab/TaskWarriorMail)
+
 `twmail` allows you to mail new tasks to your TaskWarrior inbox.
 
 ## Installation

data/Rakefile

@@ -1,10 +1,13 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test' << 'test/helpers'
   test.test_files = FileList['test/**/test_*.rb']
 end
 
-task :default => :test
+task default: %i[rubocop test]

data/bin/task-uuid

@@ -1,22 +1,24 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'securerandom'
 require 'optparse'
 require 'twmail'
 
 OptionParser.new do |opts|
-  banner = <<-HERE
-#{opts.program_name} creates a new TaskWarrior task and prints its UUID to STDOUT using the following approach:
+  banner = <<~HERE
+    #{opts.program_name} creates a new TaskWarrior task and prints its UUID to STDOUT using the following approach:
 
-  1. Make up a temporary tag name that is very unlikely to exist yet.
+      1. Make up a temporary tag name that is very unlikely to exist yet.
 
-  2. Create the new task tagged with our temporary tag
+      2. Create the new task tagged with our temporary tag
 
-  3. Use the name of our temporary tag to find the actual UUID generated by TaskWarrior
+      3. Use the name of our temporary tag to find the actual UUID generated by TaskWarrior
 
-  4. Remove the temporary tag from the new task
+      4. Remove the temporary tag from the new task
 
-  5. Print the UUID to STDOUT
-HERE
+      5. Print the UUID to STDOUT
+  HERE
   opts.banner = banner
   opts.version = TaskWarriorMail::VERSION
 end.parse!
@@ -26,13 +28,13 @@ end.parse!
 tag = 'tag_' + SecureRandom.hex.tr('-', '')
 
 # 2. Create the new task tagged with our temporary tag
-%x|task rc.verbose=nothing add +#{tag} #{ARGV.join(' ')}|
+`task rc.verbose=nothing add +#{tag} #{ARGV.join(' ')}`
 
 # 3. Remember the UUID generated by TaskWarrior
-task_uuid = %x|task rc.verbose=nothing +#{tag} _uuid|.chomp
+task_uuid = `task rc.verbose=nothing +#{tag} _uuid`.chomp
 
 # 4. Remove the temporary tag from the new task
-%x|task rc.verbose=nothing #{task_uuid} modify -#{tag.to_s}|
+`task rc.verbose=nothing #{task_uuid} modify -#{tag}`
 
 # 5. Print the UUID to STDOUT
 puts task_uuid

data/bin/twmail

@@ -1,29 +1,30 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'mail'
 require 'optparse'
 require 'twmail'
 
 OptionParser.new do |opts|
-  banner = <<-HERE
-#{opts.program_name} is a simple Mail Delivery Agent (MDA) that parses received mail and creates a new TaskWarrior task from the subject of the mail.
+  banner = <<~HERE
+    #{opts.program_name} is a simple Mail Delivery Agent (MDA) that parses received mail and creates a new TaskWarrior task from the subject of the mail.
 
-USAGE
+    USAGE
 
-Configure fetchmail to use #{opts.program_name} as MDA:
+    Configure fetchmail to use #{opts.program_name} as MDA:
 
-    # ~/.fetchmailrc
-    mda #{opts.program_name}
-HERE
-  opts.banner = banner#.wrap
+        # ~/.fetchmailrc
+        mda #{opts.program_name}
+  HERE
+  opts.banner = banner # .wrap
   opts.version = TaskWarriorMail::VERSION
 end.parse!
 
 mail = Mail.new(ARGF.read)
-task_uuid = %x[task-uuid \"#{mail.subject}\"]
+task_uuid = `task-uuid \"#{mail.subject}\"`
 body = mail.text? ? mail.body.decoded : mail.text_part.body.decoded
 
 SEPARATOR = '-- '
-body = body.split(SEPARATOR)[0] if (body.include?(SEPARATOR))
+body = body.split(SEPARATOR)[0] if body.include?(SEPARATOR)
 
-%x[task '#{task_uuid}' annotate \"#{body}\"]
+`task '#{task_uuid}' annotate \"#{body}\"`

data/bin/twmail-hook

@@ -1,37 +1,39 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'mail'
 require 'optparse'
 require 'twmail'
 
 OptionParser.new do |opts|
-  banner = <<-HERE
-#{opts.program_name} is a simple Mail Delivery Agent (MDA) that that exports the parts of the received email as environment variables and calls a shell script that can make use of these variables to further process the mail.
+  banner = <<~HERE
+    #{opts.program_name} is a simple Mail Delivery Agent (MDA) that that exports the parts of the received email as environment variables and calls a shell script that can make use of these variables to further process the mail.
 
-USAGE
+    USAGE
 
-  Configure fetchmail to use #{opts.program_name} as MDA:
+      Configure fetchmail to use #{opts.program_name} as MDA:
 
-    # ~/.fetchmailrc
-    mda #{opts.program_name}
+        # ~/.fetchmailrc
+        mda #{opts.program_name}
 
-HERE
-  opts.banner = banner#.wrap
+  HERE
+  opts.banner = banner # .wrap
   opts.version = TaskWarriorMail::VERSION
 end.parse!
 
 mail = Mail.new(ARGF.read)
 
 # Expose mail properties as environment variables
-%w[date message_id from to subject body].each{|field|
+%w[date message_id from to subject body].each do |field|
   value = mail.send(field.to_sym)
   value = value.join(',') if value.respond_to?(:join)
   ENV["TWMAIL_#{field.upcase}"] = Shellwords.escape(value.to_s)
-}
+end
 
 # The hook to be executed is read from the environment variable TWMAIL_HOOK
 # If none is set, this script will assume that twmail_on_new_mail is in the
 # $PATH and executable.
-cmd = ENV.fetch("TWMAIL_HOOK", 'twmail-hook')
+cmd = ENV.fetch('TWMAIL_HOOK', 'twmail-hook')
 
 # Call hook script
-%x[#{cmd}]
+`#{cmd}`

data/lib/extensions/string.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 class String
   # http://www.java2s.com/Code/Ruby/String/WordwrappingLinesofText.htm
-  def wrap(width = 78)
+  def wrap(width=78)
     gsub(/(.{1,#{width}})(\s+|\Z)/, "\\1\n")
   end
 end

data/lib/twmail.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'twmail/version'
 require 'extensions/string'
 

data/lib/twmail/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TaskWarriorMail
-  VERSION = '0.0.6'
+  VERSION = '1.0.0'
 end

data/test/test_helper.rb

@@ -1,5 +1,4 @@
-require 'bundler'
-#Bundler.require
+# frozen_string_literal: true
 
 require 'twtest'
 require 'test/unit'

data/test/unit/test_mail.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'mail'
 

data/test/unit/test_task_uuid.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'shellwords'
 require 'open3'
 require 'test/unit'
 
 class Command
-  def exec(cmd = '', args = {})
-    env.each{|k,v| ENV[k.to_s] = v.to_s}
+  def exec(cmd='', args={})
+    env.each { |k, v| ENV[k.to_s] = v.to_s }
     line = build_line(cmd, args)
     Open3.capture3(line)
   end
@@ -23,18 +25,18 @@ class Command
 
   private
 
-  def build_line(cmd = '', args = {})
-    [].tap{|line|
+  def build_line(cmd='', args={})
+    [].tap { |line|
       line << executable
-      line << default_args.merge(args).map{|k,v| "#{Shellwords.escape(k.strip)}=#{Shellwords.escape(v.strip)}"}.join(' ')
+      line << default_args.merge(args).map { |k, v| "#{Shellwords.escape(k.strip)}=#{Shellwords.escape(v.strip)}" }.join(' ')
       line << cmd.strip
-      line.reject!{|part| part.empty?}
+      line.reject!(&:empty?)
     }.join(' ')
   end
 
   def overrides(env)
     intersection = env.keys.to_set & ENV.keys.to_set
-    ENV.select{|k,v| intersection.include?(k)}
+    ENV.select { |k, v| intersection.include?(k) }
   end
 end
 
@@ -51,11 +53,11 @@ class TaskWarriorCommand < Command
 
   def env
     raise "data_dir must not be empty for '#{executable}'" if @data_dir.nil? || data_dir.empty?
-    {TASKDATA: @data_dir}
+    { TASKDATA: @data_dir }
   end
 
   def default_args
-    {'rc.verbose' => 'nothing', 'rc.json.array' => 'on'}
+    { 'rc.verbose' => 'nothing', 'rc.json.array' => 'on' }
   end
 
   def executable
@@ -70,7 +72,7 @@ class TaskUUID < TaskWarriorCommand
 
   def executable
     # The gem version that uses the binstub fails if the script is not Ruby
-    #'task-uuid'
+    # 'task-uuid'
 
     # The local version, called directly, works fine even if it's a Bash script
     File.join(File.dirname(__FILE__), '..', '..', 'bin', 'task-uuid')

data/test/unit/test_twmail.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
-class TestHelpers < TaskWarrior::Test::Integration::TestCase
+class TestHelpers < TaskWarrior::Test::Integration::Test
   def teardown
     ENV['TASKRC'] = nil
     super
@@ -67,8 +69,8 @@ class TestHelpers < TaskWarrior::Test::Integration::TestCase
   def deliver_fixture(status, fixture)
     twmail = File.join(File.dirname(__FILE__), '..', '..', 'bin', 'twmail')
     ENV['TASKRC'] = @taskrc_file
-    output = %x[cat #{fixture} | #{twmail}]
-    assert_equal(status, $?.exitstatus)
+    output = `cat #{fixture} | #{twmail}`
+    assert_equal(status, $CHILD_STATUS.exitstatus)
     output
   end
 

data/twmail.gemspec

@@ -1,25 +1,29 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'English'
 require File.expand_path('../lib/twmail/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Nicholas E. Rabenau"]
-  gem.email         = ["nerab@gmx.net"]
-  gem.description   = %q{Mail new tasks to your TaskWarrior inbox}
-  gem.summary       = %q{Use fetchmail and the scripts in this project to mail tasks to your local TaskWarrior installation}
+  gem.authors       = ['Nicholas E. Rabenau']
+  gem.email         = ['nerab@gmx.net']
+  gem.description   = 'Mail new tasks to your TaskWarrior inbox'
+  gem.summary       = 'Use fetchmail and the scripts in this project to mail tasks to your local TaskWarrior installation'
   gem.homepage      = 'https://github.com/nerab/TaskWarriorMail'
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "twmail"
-  gem.require_paths = ["lib"]
+  gem.name          = 'twmail'
+  gem.require_paths = ['lib']
   gem.version       = TaskWarriorMail::VERSION
 
   gem.add_dependency 'mail'
 
-  gem.add_development_dependency 'twtest', '> 0.0.6'
+  gem.add_development_dependency 'twtest', '~> 1.1.0'
   gem.add_development_dependency 'guard-test'
   gem.add_development_dependency 'guard-bundler'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rubocop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twmail
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Nicholas E. Rabenau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-05 00:00:00.000000000 Z
+date: 2020-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -28,16 +28,16 @@ dependencies:
   name: twtest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: guard-test
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Mail new tasks to your TaskWarrior inbox
 email:
 - nerab@gmx.net
@@ -105,7 +119,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-version"
+- ".travis.yml"
 - CONTRIBUTING.markdown
 - Gemfile
 - Guardfile
@@ -153,8 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Use fetchmail and the scripts in this project to mail tasks to your local