signore 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 89502aa06cad37d7834baf70be3c8721f2836819
-  data.tar.gz: 0b1eff879e6481e1b6a9fe5d649c8bffc07ac355
+SHA256:
+  metadata.gz: 53a6bf3a2bc72020cf26754484238b4efb83028f771c395386e857a1916aea59
+  data.tar.gz: 278acaae1aee55674c1b736367f77b848bdad91d70d9fd47ba103d1fd55a19be
 SHA512:
-  metadata.gz: 7b63d9935c384eb27522c0759f1bd380a24ae3c06590a2561b2cc36345015603925710de79007065a4bf59b19fc15f04eb79cb402505bb6ee628b678100f2035
-  data.tar.gz: 3d1df2ec0ba886c86c0d06231bb001931009ee442aa944b152b84044ae0e195a373ac055a5e3f8225a0660043a1646dd3851b8ac6cba94308d50d1386f0f8aa2
+  metadata.gz: 3e5cce22deca6ff0ff82cda5297a301075a7549059849f26d993caf97c7cca1e265f89d02307ef90c748f0c390d78e07f7b70080e64810095caa196e3eab9c37
+  data.tar.gz: 15abbffeb0e9cd013381dfc273c451c9630738d459dd1fab35d0268aa94ccbfba207676ecb04f2532e3fafc01d5aa4c9f234df6d478264b7cabe551efc8efde9

data/.overcommit.yml

@@ -0,0 +1,4 @@
+PreCommit:
+  RakeTarget:
+    enabled: true
+    targets: [default]

data/.reek.yml

@@ -0,0 +1,3 @@
+detectors:
+  IrresponsibleModule:
+    enabled: false

data/.rubocop.yml

@@ -1,17 +1,30 @@
-Style/AndOr:
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+
+Bundler/GemFilename:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Metrics/BlockLength:
+  AllowedMethods: describe
+
+Naming/HeredocDelimiterCase:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
   Enabled: false
 
 Style/Documentation:
   Enabled: false
 
-Style/EmptyCaseCondition:
+Style/FrozenStringLiteralComment:
   Enabled: false
 
 Style/Not:
   Enabled: false
 
-Style/TrailingCommaInArguments:
-  EnforcedStyleForMultiline: comma
-
-Style/TrailingCommaInLiteral:
-  EnforcedStyleForMultiline: comma
+Style/StructInheritance:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.1

data/.travis.yml

@@ -1,10 +1,12 @@
-cache: bundler
-fast_finish: true
+before_install:
+  - gem update --system
+  - gem install bundler
+  - bundle
 language: ruby
 matrix:
   allow_failures:
     - rvm: ruby-head
 rvm:
-  - ruby-2.3.0
+  - 2.5
+  - 2.6
   - ruby-head
-sudo: false

data/README.md

@@ -86,4 +86,4 @@ signore stores the signatures in a YAML file (for ease of editing, if such a nee
 
 ---
 
-© MMIX-MMXV Piotr Szotkowski <chastell@chastell.net>, licensed under AGPL-3.0 (see LICENCE)
+© MMIX-MMXIX Piotr Szotkowski <chastell@chastell.net>, licensed under AGPL-3.0 (see LICENCE)

data/Rakefile

@@ -1,10 +1,9 @@
-# frozen_string_literal: true
-
+require 'bundler/setup'
 require 'rake/testtask'
 require 'reek/rake/task'
 require 'rubocop/rake_task'
 
-task default: %i(test rubocop reek)
+task default: %i[test rubocop reek]
 
 Rake::TestTask.new do |task|
   task.pattern = 'test/**/*_test.rb'
@@ -13,7 +12,6 @@ end
 
 Reek::Rake::Task.new do |task|
   task.fail_on_error = false
-  task.reek_opts     = '--no-wiki-links'
 end
 
 RuboCop::RakeTask.new do |task|

data/bin/signore

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 
 require_relative '../lib/signore'
 trap(:INT) { exit }

data/gems.locked

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    signore (0.7.0)
+      lovely_rufus (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    bigdecimal (3.1.9)
+    concurrent-ruby (1.3.5)
+    dry-configurable (1.3.0)
+      dry-core (~> 1.1)
+      zeitwerk (~> 2.6)
+    dry-core (1.1.0)
+      concurrent-ruby (~> 1.0)
+      logger
+      zeitwerk (~> 2.6)
+    dry-inflector (1.2.0)
+    dry-initializer (3.2.0)
+    dry-logic (1.6.0)
+      bigdecimal
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.1)
+      zeitwerk (~> 2.6)
+    dry-schema (1.14.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      dry-core (~> 1.1)
+      dry-initializer (~> 3.2)
+      dry-logic (~> 1.5)
+      dry-types (~> 1.8)
+      zeitwerk (~> 2.6)
+    dry-types (1.8.2)
+      bigdecimal (~> 3.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    json (2.12.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    lovely_rufus (1.3.0)
+    minitest (5.25.5)
+    minitest-focus (1.4.0)
+      minitest (>= 4, < 6)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    reek (6.5.0)
+      dry-schema (~> 1.13)
+      logger (~> 1.6)
+      parser (~> 3.3.0)
+      rainbow (>= 2.0, < 4.0)
+      rexml (~> 3.1)
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rubocop (1.75.6)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    zeitwerk (2.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.6)
+  minitest-focus (~> 1.1)
+  rake (~> 13.0)
+  reek (~> 6.0)
+  rubocop (~> 1.0)
+  signore!
+
+BUNDLED WITH
+   2.6.9

data/{Gemfile → gems.rb}

@@ -1,4 +1,2 @@
-# frozen_string_literal: true
-
 source 'https://rubygems.org'
 gemspec

data/lib/signore/cli.rb

@@ -1,15 +1,14 @@
-# frozen_string_literal: true
-
 require 'forwardable'
 require_relative 'repo'
 require_relative 'settings'
+require_relative 'sig_finder'
 require_relative 'sig_from_stream'
 
 module Signore
   class CLI
     extend Forwardable
 
-    delegate %i(action tags) => :settings
+    delegate %i[action tags] => :settings
 
     def initialize(args = ARGV, repo: Repo.new)
       @settings = Settings.new(args)
@@ -29,7 +28,7 @@ module Signore
     attr_reader :repo, :settings
 
     def prego
-      sig = repo.find(tags: tags)
+      sig = SigFinder.find(repo.sigs, tags: tags)
       puts case
            when repo.empty? then 'No signatures found.'
            when sig.empty?  then "Sadly no signatures are tagged #{tags}."
@@ -38,7 +37,7 @@ module Signore
     end
 
     def create_sig_from(input)
-      SigFromStream.sig_from(input, tags: tags).tap { |sig| repo << sig }
+      SigFromStream.call(input, tags: tags).tap { |sig| repo << sig }
     end
   end
 end

data/lib/signore/repo.rb

@@ -1,53 +1,55 @@
-# frozen_string_literal: true
-
 require 'forwardable'
+require 'pathname'
 require 'yaml/store'
-require_relative 'mapper'
-require_relative 'settings'
-require_relative 'sig_finder'
+require_relative 'signature'
 require_relative 'tags'
 
 module Signore
   class Repo
+    class << self
+      def default_path
+        dir = ENV.fetch('XDG_DATA_HOME') { File.expand_path('~/.local/share') }
+        Pathname.new(dir) / 'signore' / 'signatures.yml'
+      end
+    end
+
     extend Forwardable
 
-    def initialize(path: Settings.new.repo_path, sig_finder: SigFinder.new)
-      @path       = path
-      @sig_finder = sig_finder
+    def initialize(path: self.class.default_path)
+      @path = path
       convert if legacy?
     end
 
-    def <<(sig)
-      store.transaction { (store['signatures'] ||= []) << Mapper.to_h(sig) }
+    def <<(signature)
+      self.hashes = hashes + [signature.to_h]
     end
 
-    delegate empty?: :sigs
-
-    def find(tags: Tags.new)
-      sig_finder.find(sigs, tags: tags)
-    end
+    delegate empty?: :hashes
 
     def sigs
-      @sigs ||= begin
-        hashes = store.transaction(true) { store.fetch('signatures', []) }
-        hashes.map(&Mapper.method(:from_h))
-      end
+      hashes.map(&Signature.method(:from_h))
     end
 
     private
 
-    attr_reader :path, :sig_finder
+    attr_reader :path
 
     def convert
-      store.transaction do
-        store['signatures'] = store.fetch('signatures', []).map(&:to_h)
-      end
+      self.hashes = hashes.map(&:to_h)
     end
 
     def legacy?
       path.exist? and path.read.include?('Signore::Signature')
     end
 
+    def hashes
+      store.transaction(true) { store.fetch('signatures', []) }
+    end
+
+    def hashes=(hashes)
+      store.transaction { store['signatures'] = hashes }
+    end
+
     def store
       @store ||= begin
         path.dirname.mkpath

data/lib/signore/settings.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'pathname'
 require_relative 'tags'
 
@@ -13,15 +11,9 @@ module Signore
       args.first
     end
 
-    # :reek:UtilityFunction
-    def repo_path
-      dir = ENV.fetch('XDG_DATA_HOME') { File.expand_path('~/.local/share') }
-      Pathname.new("#{dir}/signore/signatures.yml")
-    end
-
     def tags
       negated, required = tag_names.partition { |name| name.start_with?('~') }
-      Tags.new(forbidden: negated.map { |neg| neg[1..-1] }, required: required)
+      Tags.new(forbidden: negated.map { |neg| neg[1..] }, required: required)
     end
 
     private
@@ -29,7 +21,7 @@ module Signore
     attr_reader :args
 
     def tag_names
-      args[1..-1] or []
+      args.empty? ? [] : args[1..]
     end
   end
 end

data/lib/signore/sig_finder.rb

@@ -1,21 +1,13 @@
-# frozen_string_literal: true
-
 require_relative 'signature'
 require_relative 'tags'
 
 module Signore
-  class SigFinder
-    def initialize(random: Random.new)
-      @random = random
-    end
+  module SigFinder
+    module_function
 
-    def find(sigs, tags: Tags.new)
+    def find(sigs, random: Random.new, tags: Tags.new)
       shuffled = sigs.shuffle(random: random)
       shuffled.find(-> { Signature.new }) { |sig| tags.match?(sig.tags) }
     end
-
-    private
-
-    attr_reader :random
   end
 end

data/lib/signore/sig_from_stream.rb

@@ -1,12 +1,10 @@
-# frozen_string_literal: true
-
 require_relative 'signature'
 require_relative 'tags'
 
 module Signore
   class SigFromStream
-    def self.sig_from(input, tags: Tags.new)
-      new(input, tags: tags).to_sig
+    def self.call(input, tags: Tags.new)
+      new(input, tags: tags).call
     end
 
     def initialize(input, tags: Tags.new)
@@ -14,31 +12,22 @@ module Signore
       @tags  = tags
     end
 
-    def to_sig
+    def call
       Signature.new(author: params.author, source: params.source,
                     subject: params.subject, tags: tags.required,
                     text: params.text)
     end
 
+    Params = Struct.new(:text, :author, :subject, :source)
+
     private
 
     attr_reader :input, :tags
 
-    Params = Struct.new(:text, :author, :subject, :source)
-
     def get_param(param)
-      return get_text if param == :text
-      puts
-      puts "#{param}?"
-      input.gets.strip
-    end
-
-    # :reek:FeatureEnvy
-    def get_text # rubocop:disable AccessorMethodName
-      puts 'text?'
-      value = ''
-      value += input.gets until value.lines.to_a.last == "\n"
-      value.strip
+      puts "\n#{param}?"
+      separator = param == :text ? "\n\n" : "\n"
+      input.gets(separator).strip
     end
 
     def params

data/lib/signore/signature.rb

@@ -1,31 +1,29 @@
-# 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.transform_keys(&:to_sym))
+      end
+    end
+
     def initialize(author: '', source: '', subject: '', tags: [], text: '')
-      super text, author, source, subject, tags
+      super(text, author, source, subject, tags)
     end
 
     def empty?
       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,17 +1,15 @@
-# frozen_string_literal: true
-
 module Signore
   Tags = Struct.new(:forbidden, :required) do
     def initialize(forbidden: [], required: [])
-      super forbidden, required
+      super(forbidden, required)
     end
 
     def match?(sig_tags)
-      (required & sig_tags) == required and (forbidden & sig_tags).empty?
+      (required & sig_tags) == required and not forbidden.intersect?(sig_tags) # rubocop:disable Style/BitwisePredicate
     end
 
     def to_s
-      (required + forbidden.map { |tag| '~' + tag }).join(' ')
+      (required + forbidden.map { |tag| "~#{tag}" }).join(' ')
     end
   end
 end

data/lib/signore.rb

@@ -1,3 +1 @@
-# frozen_string_literal: true
-
 require_relative 'signore/cli'

data/signore.gemspec

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'English'
 require 'pathname'
 
@@ -9,28 +7,23 @@ Gem::Specification.new do |gem|
                     'random ones based on their tags'
   gem.email       = 'chastell@chastell.net'
   gem.homepage    = 'http://github.com/chastell/signore'
-  gem.license     = 'AGPL-3.0'
+  gem.license     = 'AGPL-3.0-or-later'
   gem.name        = 'signore'
   gem.summary     = 'signore: an email signature manager/randomiser'
-  gem.version     = '0.6.0'
+  gem.version     = '1.0.0'
 
-  gem.required_ruby_version = '~> 2.3'
+  gem.required_ruby_version = '~> 3.2'
 
   gem.files       = `git ls-files -z`.split "\0"
   gem.executables = gem.files.grep(%r{^bin/}).map { |path| File.basename(path) }
-  gem.test_files  = gem.files.grep(%r{^test/.*\.rb$})
-
-  gem.cert_chain  = ['certs/chastell.pem']
-  if Pathname.new($PROGRAM_NAME).basename == Pathname.new('gem')
-    gem.signing_key = Pathname.new('~/.ssh/gem-private_key.pem').expand_path
-  end
 
   gem.add_dependency 'lovely_rufus', '~> 1.0'
 
-  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 'rake',           '~> 13.0'
+  gem.add_development_dependency 'reek',           '~> 6.0'
+  gem.add_development_dependency 'rubocop',        '~> 1.0'
+
+  gem.metadata['rubygems_mfa_required'] = 'true'
 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]