signore 0.6.0 → 1.0.0

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.fetch('XDG_DATA_HOME')}/signore/signatures.yml"
+        _(Repo.default_path).must_equal Pathname.new(path)
+      ensure
+        FileUtils.rmtree ENV.fetch('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
@@ -35,6 +53,11 @@ module Signore
         Repo.new(path: path) << sig
         _(path.read).wont_include 'Signore::Signature'
       end
+
+      it 'handles edge cases' do
+        sig = Signature.new(author: '000___000')
+        Repo.new(path: path) << sig
+      end
     end
 
     describe '#empty?' do
@@ -48,43 +71,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 +79,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,48 +1,43 @@
-# 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
   describe SigFinder do
-    verify_contract SigFinder
-
     let(:sigs) do
       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

data/test/signore/sig_from_stream_test.rb

@@ -1,15 +1,14 @@
-# frozen_string_literal: true
-
 require 'stringio'
 require_relative '../test_helper'
 require_relative '../../lib/signore/sig_from_stream'
 
 module Signore
   describe SigFromStream do
-    describe '.sig_from' do
+    describe '.call' do
       it 'asks about signature parts' do
-        io = capture_io { SigFromStream.sig_from StringIO.new("\n\n\n\n") }
-        _(io.first).must_equal <<-end.dedent
+        io = capture_io { SigFromStream.call StringIO.new("\n\n\n\n\n") }
+        _(io.first).must_equal <<~end
+
           text?
 
           author?
@@ -21,7 +20,7 @@ module Signore
       end
 
       it 'asks about signature parts and returns resulting signature' do
-        input = StringIO.new <<-end.dedent
+        input = StringIO.new <<~end
           You do have to be mad to work here, but it doesn’t help.
 
           Gary Barnes
@@ -29,14 +28,14 @@ module Signore
           asr
         end
         sig = nil
-        capture_io { sig = SigFromStream.sig_from input }
+        capture_io { sig = SigFromStream.call input }
         text = 'You do have to be mad to work here, but it doesn’t help.'
         _(sig).must_equal Signature.new(author: 'Gary Barnes', source: 'asr',
                                         text: text)
       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.’
 
@@ -45,8 +44,8 @@ module Signore
 
         end
         sig = nil
-        capture_io { sig = SigFromStream.sig_from input }
-        text = <<-end.dedent.strip
+        capture_io { sig = SigFromStream.call input }
+        text = <<~end.strip
           ‘You’ve got an interesting accent. Subtle. I can’t place it.’
           ‘It’s text-to-speech… I was raised by smartphones.’
         end

data/test/signore/signature_test.rb

@@ -1,17 +1,27 @@
-# frozen_string_literal: true
-
 require 'yaml'
 require_relative '../test_helper'
-require_relative '../../lib/signore/mapper'
 require_relative '../../lib/signore/signature'
 
 module Signore # rubocop:disable Metrics/ModuleLength
   describe Signature do
+    describe '.from_h' do
+      it 'deserializes a Signature from a Hash' do
+        text = 'For the sake of topic titles, I’d rather if Monty saved Python.'
+        sig_hash = { 'author' => 'Anonymous Coward', 'source' => '/.',
+                     'subject' => 'on ‘Monty Wants to Save MySQL’',
+                     'tags' => %w[/. MySQL], 'text' => text }
+        signature = Signature.new(author: 'Anonymous Coward', source: '/.',
+                                  subject: 'on ‘Monty Wants to Save MySQL’',
+                                  tags: %w[/. MySQL], text: text)
+        _(Signature.from_h(sig_hash)).must_equal signature
+      end
+    end
+
     describe '.new' do
       it 'instantiates Signatures via parameters' do
         source = 'A History of Modern Computing'
         text   = 'In 1940 he summarized his work in an influential book, ' \
-          '‘Punched Card Methods in Scientific Computation’.'
+                 '‘Punched Card Methods in Scientific Computation’.'
         sig = Signature.new(author: 'Paul E. Ceruzzi', source: source,
                             subject: 'on Wallace Eckert',
                             tags: ['punched cards'], text: text)
@@ -45,10 +55,10 @@ module Signore # rubocop:disable Metrics/ModuleLength
         text = 'For the sake of topic titles, I’d rather if Monty saved Python.'
         sig  = Signature.new(author: 'Anonymous Coward', source: '/.',
                              subject: 'on ‘Monty Wants to Save MySQL’',
-                             tags: %w(/. MySQL), text: text)
+                             tags: %w[/. MySQL], text: text)
         _(sig.to_h).must_equal 'author' => 'Anonymous Coward', 'source' => '/.',
                                'subject' => 'on ‘Monty Wants to Save MySQL’',
-                               'tags' => %w(/. MySQL), 'text' => text
+                               'tags' => %w[/. MySQL], 'text' => text
       end
 
       it 'removes non-existing keys' do
@@ -62,7 +72,7 @@ module Signore # rubocop:disable Metrics/ModuleLength
       end
 
       it 'does not show meta if there’s nothing to show' do
-        text = '// sometimes I believe compiler ignores all my comments'
+        text = "// sometimes I believe compiler\n// ignores all my comments"
         sig  = Signature.new(text: text)
         _(sig.to_s).must_equal text
       end
@@ -70,7 +80,7 @@ module Signore # rubocop:disable Metrics/ModuleLength
       it 'shows author on its own' do
         sig = Signature.new(author: 'kodz',
                             text: 'stay-at-home executives vs. wallstreet dads')
-        _(sig.to_s).must_equal <<-end.dedent.strip
+        _(sig.to_s).must_equal <<~end.strip
           stay-at-home executives vs. wallstreet dads
                                                [kodz]
         end
@@ -79,18 +89,20 @@ module Signore # rubocop:disable Metrics/ModuleLength
       it 'shows author and source, comma-separated' do
         text = 'You do have to be mad to work here, but it doesn’t help.'
         sig  = Signature.new(author: 'Gary Barnes', source: 'asr', text: text)
-        _(sig.to_s).must_equal <<-end.dedent.strip
-          You do have to be mad to work here, but it doesn’t help.
-                                                [Gary Barnes, asr]
+        _(sig.to_s).must_equal <<~end.strip
+          You do have to be mad to work
+          here, but it doesn’t help.
+                     [Gary Barnes, asr]
         end
       end
 
       it 'shows source on its own' do
         text = 'Bruce Schneier knows Alice and Bob’s shared secret.'
         sig  = Signature.new(source: 'Bruce Schneier Facts', text: text)
-        _(sig.to_s).must_equal <<-end.dedent.strip
-          Bruce Schneier knows Alice and Bob’s shared secret.
-                                       [Bruce Schneier Facts]
+        _(sig.to_s).must_equal <<~end.strip
+          Bruce Schneier knows Alice
+          and Bob’s shared secret.
+              [Bruce Schneier Facts]
         end
       end
 
@@ -98,7 +110,7 @@ module Signore # rubocop:disable Metrics/ModuleLength
         text = 'More gangland camp than neo-noir.'
         sig = Signature.new(author: 'Nicholas Christopher',
                             subject: 'on Pulp Fiction', text: text)
-        _(sig.to_s).must_equal <<-end.dedent.strip
+        _(sig.to_s).must_equal <<~end.strip
           More gangland camp than neo-noir.
           [Nicholas Christopher on Pulp Fiction]
         end
@@ -106,9 +118,9 @@ module Signore # rubocop:disable Metrics/ModuleLength
 
       it 'shows subject on its own' do
         text = 'Amateur fighter pilot ignores orders, listens ' \
-          'to the voices in his head and slaughters thousands.'
+               'to the voices in his head and slaughters thousands.'
         sig = Signature.new(subject: 'Star Wars ending explained', text: text)
-        _(sig.to_s).must_equal <<-end.dedent.strip
+        _(sig.to_s).must_equal <<~end.strip
           Amateur fighter pilot ignores orders, listens to
           the voices in his head and slaughters thousands.
                               [Star Wars ending explained]
@@ -116,8 +128,10 @@ module Signore # rubocop:disable Metrics/ModuleLength
       end
 
       it 'handles edge cases properly' do
-        YAML.load_file('test/fixtures/wrapper.yml').each do |sig, wrapped|
-          _(Mapper.from_h(sig.to_h).to_s).must_equal wrapped
+        wrappings = YAML.load_file('test/fixtures/wrapper.yml',
+                                   permitted_classes: [Signature, Symbol])
+        wrappings.each do |sig, wrapped|
+          _(Signature.from_h(sig.to_h).to_s).must_equal wrapped
         end
       end
     end

data/test/signore/tags_test.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require_relative '../test_helper'
 require_relative '../../lib/signore/tags'
 
@@ -7,24 +5,24 @@ module Signore
   describe Tags do
     describe '#match?' do
       it 'is a predicate whether the Tags match the given list of tags' do
-        tags = %w(programming tech)
+        tags = %w[programming tech]
         assert Tags.new.match?([])
-        assert Tags.new(forbidden: %w(fnord)).match?([])
+        assert Tags.new(forbidden: %w[fnord]).match?([])
         assert Tags.new.match?(tags)
-        assert Tags.new(required: %w(programming)).match?(tags)
-        assert Tags.new(required: %w(programming tech)).match?(tags)
-        refute Tags.new(required: %w(programming tech Ruby)).match?(tags)
-        refute Tags.new(forbidden: %w(programming)).match?(tags)
-        refute Tags.new(forbidden: %w(tech), required: %w(tech)).match?(tags)
+        assert Tags.new(required: %w[programming]).match?(tags)
+        assert Tags.new(required: %w[programming tech]).match?(tags)
+        refute Tags.new(required: %w[programming tech Ruby]).match?(tags)
+        refute Tags.new(forbidden: %w[programming]).match?(tags)
+        refute Tags.new(forbidden: %w[tech], required: %w[tech]).match?(tags)
       end
     end
 
     describe '#to_s' do
       it 'returns a CLI-like representation of the Tags' do
         _(Tags.new.to_s).must_equal ''
-        _(Tags.new(required: %w(tech)).to_s).must_equal 'tech'
-        _(Tags.new(forbidden: %w(fnord)).to_s).must_equal '~fnord'
-        _(Tags.new(forbidden: %w(fnord), required: %w(tech)).to_s)
+        _(Tags.new(required: %w[tech]).to_s).must_equal 'tech'
+        _(Tags.new(forbidden: %w[fnord]).to_s).must_equal '~fnord'
+        _(Tags.new(forbidden: %w[fnord], required: %w[tech]).to_s)
           .must_equal 'tech ~fnord'
       end
     end

data/test/test_helper.rb

@@ -1,17 +1,4 @@
-# frozen_string_literal: true
-
 ENV['MT_NO_EXPECTATIONS'] = 'true'
-require 'bundler/setup'
 require 'minitest/autorun'
 require 'minitest/focus'
 require 'minitest/pride'
-require 'bogus/minitest/spec'
-require 'signore'
-
-Bogus.configure { |config| config.search_modules << Signore }
-
-class String
-  def dedent
-    gsub(/^#{scan(/^ +/).min}/, '')
-  end
-end