signore 0.6.0 → 0.7.0

data/lib/signore/signature.rb

@@ -1,9 +1,13 @@
-# frozen_string_literal: true
-
 require 'lovely_rufus'
 
 module Signore
-  Signature = Struct.new(:text, :author, :source, :subject, :tags) do
+  class Signature < Struct.new(:text, :author, :source, :subject, :tags)
+    class << self
+      def from_h(hash)
+        new(hash.map { |key, value| [key.to_sym, value] }.to_h)
+      end
+    end
+
     def initialize(author: '', source: '', subject: '', tags: [], text: '')
       super text, author, source, subject, tags
     end
@@ -12,20 +16,14 @@ module Signore
       to_s.empty?
     end
 
-    undef text if defined?(:text)
-    def text
-      self[:text] or ''
-    end
-
     def to_h
-      super.map { |key, val| [key.to_s, val] }.to_h.keep_if do |_, value|
-        value and not value.empty?
-      end
+      super.map { |key, val| { key.to_s => val } }.reduce({}, :merge)
+           .compact.reject { |_, val| val.empty? }
     end
 
     def to_s
       spaced   = text.gsub("\n", "\n\n")
-      wrapped  = LovelyRufus.wrap(spaced, width: 80)
+      wrapped  = LovelyRufus.wrap(spaced, width: 50)
       squeezed = wrapped.gsub("\n\n", "\n").chomp
       squeezed + meta_for(squeezed)
     end

data/lib/signore/tags.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Signore
   Tags = Struct.new(:forbidden, :required) do
     def initialize(forbidden: [], required: [])
@@ -11,7 +9,7 @@ module Signore
     end
 
     def to_s
-      (required + forbidden.map { |tag| '~' + tag }).join(' ')
+      (required + forbidden.map { |tag| "~#{tag}" }).join(' ')
     end
   end
 end

data/signore.gemspec

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'English'
 require 'pathname'
 
@@ -12,9 +10,9 @@ Gem::Specification.new do |gem|
   gem.license     = 'AGPL-3.0'
   gem.name        = 'signore'
   gem.summary     = 'signore: an email signature manager/randomiser'
-  gem.version     = '0.6.0'
+  gem.version     = '0.7.0'
 
-  gem.required_ruby_version = '~> 2.3'
+  gem.required_ruby_version = '~> 2.5'
 
   gem.files       = `git ls-files -z`.split "\0"
   gem.executables = gem.files.grep(%r{^bin/}).map { |path| File.basename(path) }
@@ -26,11 +24,13 @@ Gem::Specification.new do |gem|
   end
 
   gem.add_dependency 'lovely_rufus', '~> 1.0'
+  gem.add_dependency 'procto',       '~> 0.0.3'
 
   gem.add_development_dependency 'bogus',          '~> 0.1.3'
   gem.add_development_dependency 'minitest',       '~> 5.6'
   gem.add_development_dependency 'minitest-focus', '~> 1.1'
-  gem.add_development_dependency 'rake',           '~> 11.0'
-  gem.add_development_dependency 'reek',           '~> 4.0'
-  gem.add_development_dependency 'rubocop',        '~> 0.43.0'
+  gem.add_development_dependency 'overcommit',     '~> 0.46.0'
+  gem.add_development_dependency 'rake',           '~> 12.0'
+  gem.add_development_dependency 'reek',           '~> 5.0'
+  gem.add_development_dependency 'rubocop',        '~> 0.60.0'
 end

data/test/fixtures/wrapper.yml

@@ -16,8 +16,9 @@
 - - !ruby/struct:Signore::Signature
     text: It may look like I’m just sitting here doing nothing. But I’m really actively waiting for all my problems to go away.
   - |-
-    It may look like I’m just sitting here doing nothing. But
-    I’m really actively waiting for all my problems to go away.
+    It may look like I’m just sitting here
+    doing nothing. But I’m really actively
+    waiting for all my problems to go away.
 
 # meta info is right-aligned to the longest line
 - - !ruby/struct:Signore::Signature
@@ -37,11 +38,13 @@
     author: M. Edward (Ed) Borasky, Matt Lawrence, Gregory Brown
     source: ruby-talk
   - |-
-    ‘The Ruby community should proceed with all deliberate
-    speed towards ISO standardization of the language.’
+    ‘The Ruby community should proceed
+    with all deliberate speed towards
+    ISO standardization of the language.’
     ‘Yeah, look what it did to Forth.’
-    ‘Don’t just say it, show it. <http://vividpicture.com/aleks/atari/forth.jpg>’
-                [M. Edward (Ed) Borasky, Matt Lawrence, Gregory Brown, ruby-talk]
+    ‘Don’t just say it, show it.
+    <http://vividpicture.com/aleks/atari/forth.jpg>’
+    [M. Edward (Ed) Borasky, Matt Lawrence, Gregory Brown, ruby-talk]
 
 # long meta info is flushed left
 - - !ruby/struct:Signore::Signature
@@ -53,14 +56,18 @@
     author: Spehro Pefhany, CyberCypher, Jess Askin, don groves
     source: alt.usage.english
   - |-
-    ‘The Guardian also had a pre-election column, in which an allegedly
-    “ironic joke” was open to other interpretations: “John Wilkes Booth,
-    Lee Harvey Oswald, John Hinckley Jr., where are you now that we need
-    you?” They removed the column from on-line access and apologized.’
-    ‘They should have. Hinckley missed the vital spot, so who needs him?’
+    ‘The Guardian also had a pre-election column, in
+    which an allegedly “ironic joke” was open to other
+    interpretations: “John Wilkes Booth, Lee Harvey
+    Oswald, John Hinckley Jr., where are you now
+    that we need you?” They removed the column
+    from on-line access and apologized.’
+    ‘They should have. Hinckley missed
+    the vital spot, so who needs him?’
     ‘As everybody knows, Reagan was killed in
     that attack and a lookalike was substituted.’
-    ‘You mean we were governed all those years by an ACTOR!’
+    ‘You mean we were governed
+    all those years by an ACTOR!’
     [Spehro Pefhany, CyberCypher, Jess Askin, don groves, alt.usage.english]
 
 # wrapping doesn’t left one-letter words at the end of lines
@@ -77,10 +84,11 @@
     text: Better to teach a man to fish than to give him a fish. And if he can’t be bothered to learn to fish and starves to death, that’s a good enough outcome for me.
     author: Steve VanDevender
   - |-
-    Better to teach a man to fish than to give him a fish.
-    And if he can’t be bothered to learn to fish and starves
-    to death, that’s a good enough outcome for me.
-                                         [Steve VanDevender]
+    Better to teach a man to fish than to give
+    him a fish. And if he can’t be bothered
+    to learn to fish and starves to death,
+    that’s a good enough outcome for me.
+                           [Steve VanDevender]
 
 # for two-line signatures, first line is considered for hangouts
 - - !ruby/struct:Signore::Signature
@@ -89,6 +97,7 @@
     subject: on subway engines
     source: asr
   - |-
-    Well, the old ones go mmmmmbbbbzzzzttteeeeeep as they start up
-    and the new ones go whupwhupwhupwhooopwhooooopwhooooooommmmmmmmmm.
-                                  [Graham Reed on subway engines, asr]
+    Well, the old ones go mmmmmbbbbzzzzttteeeeeep
+    as they start up and the new ones go
+    whupwhupwhupwhooopwhooooopwhooooooommmmmmmmmm.
+              [Graham Reed on subway engines, asr]

data/test/signore/cli_test.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'pathname'
 require 'stringio'
 require 'tempfile'
@@ -25,25 +23,26 @@ module Signore
         let(:path) { Pathname.new('test/fixtures/signatures.yml') }
 
         it 'prints a signature tagged with the provided tags' do
-          args = %w(prego tech programming)
+          args = %w[prego tech programming]
           out  = capture_io { CLI.new(args, repo: repo).run }.first
-          sig  = "// sometimes I believe compiler ignores all my comments\n"
+          sig  = "// sometimes I believe compiler\n// ignores all my comments\n"
           _(out).must_equal sig
         end
 
         it 'prints a signature based on allowed and forbidden tags' do
-          args = %w(prego ~programming tech ~security)
+          args = %w[prego ~programming tech ~security]
           out  = capture_io { CLI.new(args, repo: repo).run }.first
-          _(out).must_equal <<-end.dedent
-            You do have to be mad to work here, but it doesn’t help.
-                                                  [Gary Barnes, asr]
+          _(out).must_equal <<~end
+            You do have to be mad to work
+            here, but it doesn’t help.
+                       [Gary Barnes, asr]
           end
         end
 
         it 'tells the user if no signatures are found' do
           path = Pathname.new('test/fixtures/nosignatures.yml')
           repo = Repo.new(path: path)
-          args = %w(prego)
+          args = %w[prego]
           out = capture_io { CLI.new(args, repo: repo).run }.first
           _(out).must_include 'No signatures found.'
         end
@@ -51,24 +50,25 @@ module Signore
         it 'tells the user if no signatures with selected tag are found' do
           path = Pathname.new('test/fixtures/signatures.yml')
           repo = Repo.new(path: path)
-          args = %w(prego esse ~percipi)
+          args = %w[prego esse ~percipi]
           out = capture_io { CLI.new(args, repo: repo).run }.first
           _(out).must_include 'Sadly no signatures are tagged esse ~percipi.'
         end
       end
 
       describe 'pronto' do
-        let(:repo) { Repo.new(path: Pathname.new(Tempfile.new('').path)) }
+        let(:repo) { Repo.new(path: Pathname.new(Tempfile.new.path)) }
 
         it 'asks about signature parts and saves resulting signature' do
-          input = StringIO.new <<-end.dedent
+          input = StringIO.new <<~end
             The Wikipedia page on ADHD is like 20 pages long. That’s just cruel.
 
             Mark Pilgrim\n\n\n
           end
-          args = %w(pronto Wikipedia ADHD)
+          args = %w[pronto Wikipedia ADHD]
           out  = capture_io { CLI.new(args, repo: repo).run input: input }.first
-          _(out).must_equal <<-end.dedent
+          _(out).must_equal <<~end
+
             text?
 
             author?
@@ -76,26 +76,29 @@ module Signore
             subject?
 
             source?
-            The Wikipedia page on ADHD is like 20 pages long. That’s just cruel.
-                                                                  [Mark Pilgrim]
+            The Wikipedia page on ADHD is like
+            20 pages long. That’s just cruel.
+                                [Mark Pilgrim]
           end
-          args = %w(prego Wikipedia ADHD)
+          args = %w[prego Wikipedia ADHD]
           out  = capture_io { CLI.new(args, repo: repo).run }.first
-          _(out).must_equal <<-end.dedent
-            The Wikipedia page on ADHD is like 20 pages long. That’s just cruel.
-                                                                  [Mark Pilgrim]
+          _(out).must_equal <<~end
+            The Wikipedia page on ADHD is like
+            20 pages long. That’s just cruel.
+                                [Mark Pilgrim]
           end
         end
 
         it 'handles multi-line signatures' do
-          input = StringIO.new <<-end.dedent
+          input = StringIO.new <<~end
             ‘You’ve got an interesting accent. Subtle. I can’t place it.’
             ‘It’s text-to-speech… I was raised by smartphones.’
 
             Patrick Ewing\n\n\n
           end
           io = capture_io { CLI.new(['pronto'], repo: repo).run input: input }
-          _(io.first).must_equal <<-end.dedent
+          _(io.first).must_equal <<~end
+
             text?
 
             author?
@@ -103,9 +106,11 @@ module Signore
             subject?
 
             source?
-            ‘You’ve got an interesting accent. Subtle. I can’t place it.’
-            ‘It’s text-to-speech… I was raised by smartphones.’
-                                                          [Patrick Ewing]
+            ‘You’ve got an interesting accent.
+            Subtle. I can’t place it.’
+            ‘It’s text-to-speech…
+            I was raised by smartphones.’
+                               [Patrick Ewing]
           end
         end
       end

data/test/signore/repo_test.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'fileutils'
 require 'pathname'
 require 'tempfile'
@@ -11,7 +9,27 @@ require_relative '../../lib/signore/tags'
 
 module Signore
   describe Repo do
-    let(:path) { Pathname.new(Tempfile.new('').path) }
+    let(:path) { Pathname.new(Tempfile.new.path) }
+
+    describe '.default_path' do
+      it 'honours XDG_DATA_HOME if it’s set' do
+        old_xdg = ENV.delete('XDG_DATA_HOME')
+        ENV['XDG_DATA_HOME'] = Dir.mktmpdir
+        path = "#{ENV['XDG_DATA_HOME']}/signore/signatures.yml"
+        _(Repo.default_path).must_equal Pathname.new(path)
+      ensure
+        FileUtils.rmtree ENV['XDG_DATA_HOME']
+        old_xdg ? ENV['XDG_DATA_HOME'] = old_xdg : ENV.delete('XDG_DATA_HOME')
+      end
+
+      it 'defaults XDG_DATA_HOME to ~/.local/share if it’s not set' do
+        old_xdg = ENV.delete('XDG_DATA_HOME')
+        path    = File.expand_path('~/.local/share/signore/signatures.yml')
+        _(Repo.default_path).must_equal Pathname.new(path)
+      ensure
+        ENV['XDG_DATA_HOME'] = old_xdg if old_xdg
+      end
+    end
 
     describe '.new' do
       it 'rewrites legacy file to hashes on first access' do
@@ -48,43 +66,6 @@ module Signore
       end
     end
 
-    describe '#find' do
-      let(:path)       { Pathname.new('test/fixtures/signatures.yml') }
-      let(:repo)       { Repo.new(path: path, sig_finder: sig_finder) }
-      let(:sig_finder) { fake(SigFinder)                              }
-      let(:sigs)       { repo.sigs                                    }
-      let(:store)      { YAML::Store.new(path)                        }
-
-      it 'returns a random signature by default' do
-        stub(sig_finder).find(sigs, tags: Tags.new) { sigs.last }
-        _(repo.find).must_equal sigs.last
-      end
-
-      it 'returns a random signature based on required and forbidden tags' do
-        tags = Tags.new(forbidden: %w(programming security), required: %w(tech))
-        stub(sig_finder).find(sigs, tags: tags) { sigs.first }
-        _(repo.find(tags: tags)).must_equal sigs.first
-      end
-
-      it 'doesn’t blow up if the path is missing' do
-        begin
-          tempdir = Dir.mktmpdir
-          path = Pathname.new("#{tempdir}/some_intermediate_dir/sigs.yml")
-          _(Repo.new(path: path).find(tags: Tags.new)).must_equal Signature.new
-        ensure
-          FileUtils.rmtree tempdir
-        end
-      end
-
-      it 'keeps working with legacy YAML files' do
-        path = Pathname.new(Tempfile.new('').path)
-        FileUtils.cp Pathname.new('test/fixtures/signatures.legacy.yml'), path
-        repo = Repo.new(path: path, sig_finder: sig_finder)
-        stub(sig_finder).find(sigs, tags: Tags.new) { sigs.last }
-        _(repo.find).must_equal sigs.last
-      end
-    end
-
     describe '#sigs' do
       it 'returns all the Signatures from the Repo' do
         path = Pathname.new('test/fixtures/signatures.yml')
@@ -93,6 +74,23 @@ module Signore
         _(sigs.first.author).must_equal 'Gary Barnes'
         _(sigs.last.subject).must_equal 'Star Wars ending explained'
       end
+
+      it 'keeps working with legacy YAML files' do
+        legacy_path = Pathname.new('test/fixtures/signatures.legacy.yml')
+        temp_path   = Pathname.new(Tempfile.new.path)
+        FileUtils.cp legacy_path, temp_path
+        legacy_repo = Repo.new(path: temp_path)
+        new_repo = Repo.new(path: Pathname.new('test/fixtures/signatures.yml'))
+        _(legacy_repo.sigs).must_equal new_repo.sigs
+      end
+
+      it 'doesn’t blow up if the path is missing' do
+        tempdir = Dir.mktmpdir
+        path = Pathname.new("#{tempdir}/some_intermediate_dir/sigs.yml")
+        _(Repo.new(path: path).sigs).must_equal []
+      ensure
+        FileUtils.rmtree tempdir
+      end
     end
   end
 end

data/test/signore/settings_test.rb

@@ -1,5 +1,4 @@
-# frozen_string_literal: true
-
+require 'fileutils'
 require 'pathname'
 require 'tmpdir'
 require_relative '../test_helper'
@@ -14,34 +13,10 @@ module Signore
       end
     end
 
-    describe '#repo_path' do
-      it 'honours XDG_DATA_HOME if it’s set' do
-        begin
-          old_xdg = ENV.delete('XDG_DATA_HOME')
-          ENV['XDG_DATA_HOME'] = Dir.mktmpdir
-          path = "#{ENV['XDG_DATA_HOME']}/signore/signatures.yml"
-          _(Settings.new.repo_path).must_equal Pathname.new(path)
-        ensure
-          FileUtils.rmtree ENV['XDG_DATA_HOME']
-          old_xdg ? ENV['XDG_DATA_HOME'] = old_xdg : ENV.delete('XDG_DATA_HOME')
-        end
-      end
-
-      it 'defaults XDG_DATA_HOME to ~/.local/share if it’s not set' do
-        begin
-          old_xdg = ENV.delete('XDG_DATA_HOME')
-          path    = File.expand_path('~/.local/share/signore/signatures.yml')
-          _(Settings.new.repo_path).must_equal Pathname.new(path)
-        ensure
-          ENV['XDG_DATA_HOME'] = old_xdg if old_xdg
-        end
-      end
-    end
-
     describe '#tags' do
       it 'returns the forbidden and required tags' do
-        tags = Tags.new(forbidden: %w(tech), required: %w(en))
-        _(Settings.new(%w(prego ~tech en)).tags).must_equal tags
+        tags = Tags.new(forbidden: %w[tech], required: %w[en])
+        _(Settings.new(%w[prego ~tech en]).tags).must_equal tags
       end
 
       it 'doesn’t blow up on empty args' do

data/test/signore/sig_finder_test.rb

@@ -1,8 +1,7 @@
-# frozen_string_literal: true
-
 require 'yaml/store'
 require_relative '../test_helper'
 require_relative '../../lib/signore/sig_finder'
+require_relative '../../lib/signore/signature'
 require_relative '../../lib/signore/tags'
 
 module Signore
@@ -13,36 +12,34 @@ module Signore
       Repo.new(path: Pathname.new('test/fixtures/signatures.yml')).sigs
     end
 
-    let(:sig_finder) { SigFinder.new }
-
     describe '#find' do
       it 'returns a random Signature by default' do
-        _(SigFinder.new(random: Random.new(0)).find(sigs).text)
+        _(SigFinder.find(sigs, random: Random.new(0)).text)
           .must_include 'Amateur fighter pilot ignores orders'
-        _(SigFinder.new(random: Random.new(1)).find(sigs).text)
+        _(SigFinder.find(sigs, random: Random.new(1)).text)
           .must_equal '// sometimes I believe compiler ignores all my comments'
       end
 
       it 'returns a random signature if the tags are empty' do
-        _(SigFinder.new(random: Random.new(0)).find(sigs, tags: Tags.new).text)
+        _(SigFinder.find(sigs, random: Random.new(0), tags: Tags.new).text)
           .must_include 'Amateur fighter pilot ignores orders'
       end
 
       it 'returns a random signature based on provided tags' do
-        _(sig_finder.find(sigs, tags: Tags.new(required: %w(programming))).text)
+        _(SigFinder.find(sigs, tags: Tags.new(required: %w[programming])).text)
           .must_equal '// sometimes I believe compiler ignores all my comments'
-        _(sig_finder.find(sigs, tags: Tags.new(required: %w(work))).text)
+        _(SigFinder.find(sigs, tags: Tags.new(required: %w[work])).text)
           .must_equal 'You do have to be mad to work here, but it doesn’t help.'
       end
 
       it 'returns a random signature based on required and forbidden tags' do
-        tags = Tags.new(forbidden: %w(programming security), required: %w(tech))
-        _(sig_finder.find(sigs, tags: tags).text)
+        tags = Tags.new(forbidden: %w[programming security], required: %w[tech])
+        _(SigFinder.find(sigs, tags: tags).text)
           .must_equal 'You do have to be mad to work here, but it doesn’t help.'
       end
 
       it 'returns a null object if there are no results' do
-        _(sig_finder.find([])).must_equal Signature.new
+        _(SigFinder.find([])).must_equal Signature.new
       end
     end
   end