signore 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e60e737742002b39f1c5cc08199c6d254494f44b
-  data.tar.gz: 0c13a2461cd5b9c5c6b981516b0050b63937ff87
+  metadata.gz: b5b9c7abacbf5730fdbadf79e7d5fe61ec37cdd3
+  data.tar.gz: 587a3996c7fabb7e31b3bd27250310749b588f0c
 SHA512:
-  metadata.gz: f880a98957f0312852ef253226f67d3c123832b0efe2f0d4eeeeb8438384b40e03e4a8d8a89f6671bc300ad0f35a839162cce14551002839ed1034323bcbcf4e
-  data.tar.gz: a8427764969f46768ddea7be551f2f3b53c0b4bfdd8085244fe2d8aa4f0d39c221b630dafd6e9261695a0aff5ac1ce74b481292ae2cd0c37e87db8d2c5232da2
+  metadata.gz: 0f04915b49b5d7f3678bd178def6607a7bd20727f2bcf1db2731ee86ef8e058c5107004183d7ac4fd47c5aa418b00ccc5df3f53cee0f0f1de35a8c5ca2c3ad14
+  data.tar.gz: b37a86a56e2309943664de9ad3a5b1934d037fca249d123dcfb82cf6bd05f29357c91fa177c8d0e8bd0eb4ab14571c451dbf6014365c9c50568d17ef8158a1c2

data/.rubocop.yml

@@ -1,20 +1,14 @@
-AccessModifierIndentation:
-  Enabled: false
-
 AndOr:
   Enabled: false
 
 Documentation:
   Enabled: false
 
-EndAlignment:
-  Enabled: false
-
-IndentationWidth:
+Not:
   Enabled: false
 
-MethodDefParentheses:
-  EnforcedStyle: require_no_parentheses
-
 SingleSpaceBeforeFirstArg:
   Enabled: false
+
+TrailingComma:
+  EnforcedStyleForMultiline: comma

data/Gemfile.lock

@@ -2,66 +2,71 @@ PATH
   remote: .
   specs:
     signore (0.2.2)
-      lovely_rufus (~> 0.1.2)
+      lovely_rufus (~> 0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (1.1.0)
-    celluloid (0.15.2)
-      timers (~> 1.1.0)
-    celluloid-io (0.15.0)
-      celluloid (>= 0.15.0)
-      nio4r (>= 0.5.0)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    bogus (0.1.5)
+      dependor (>= 0.0.4)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    dependor (1.0.1)
     ffi (1.9.3)
-    json (1.8.1)
-    listen (2.7.1)
+    hitimes (1.2.2)
+    listen (2.7.9)
       celluloid (>= 0.15.2)
-      celluloid-io (>= 0.15.0)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
-    lovely_rufus (0.1.2)
-    minitest (5.3.2)
-    nio4r (1.0.0)
-    parser (2.1.7)
-      ast (~> 1.1)
+    lovely_rufus (0.2.0)
+    minitest (5.4.1)
+    minitest-focus (1.1.0)
+      minitest (>= 4, < 6)
+    parser (2.2.0.pre.4)
+      ast (>= 1.1, < 3.0)
       slop (~> 3.4, >= 3.4.5)
     powerpack (0.0.9)
     rainbow (2.0.0)
-    rake (10.2.2)
+    rake (10.3.2)
     rb-fsevent (0.9.4)
-    rb-inotify (0.9.3)
+    rb-inotify (0.9.5)
       ffi (>= 0.5.0)
-    reek (1.3.7)
-      rainbow
-      ruby2ruby (~> 2.0.8)
+    reek (1.3.8)
+      rainbow (>= 1.99, < 3.0)
+      ruby2ruby (>= 2.0.8, < 3.0)
       ruby_parser (~> 3.3)
       sexp_processor
-    rerun (0.9.0)
-      listen (~> 2.7)
-    rubocop (0.20.1)
-      json (>= 1.7.7, < 2)
-      parser (~> 2.1.7)
+    rerun (0.10.0)
+      listen (~> 2.7, >= 2.7.3)
+    rubocop (0.26.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.4, < 3.0)
       powerpack (~> 0.0.6)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
-    ruby-progressbar (1.4.2)
-    ruby2ruby (2.0.8)
+    ruby-progressbar (1.5.1)
+    ruby2ruby (2.1.2)
       ruby_parser (~> 3.1)
       sexp_processor (~> 4.0)
-    ruby_parser (3.5.0)
+    ruby_parser (3.6.2)
       sexp_processor (~> 4.1)
-    sexp_processor (4.4.3)
-    slop (3.5.0)
-    timers (1.1.0)
+    sexp_processor (4.4.4)
+    slop (3.6.0)
+    timers (4.0.1)
+      hitimes
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bogus (~> 0.1.3)
   minitest (~> 5.0)
+  minitest-focus (~> 1.1)
   rake (~> 10.1)
   reek (~> 1.3)
-  rerun (~> 0.9.0)
-  rubocop (~> 0.20.0)
+  rerun (~> 0.10.0)
+  rubocop (~> 0.26.0)
   signore!

data/README.md

@@ -68,18 +68,6 @@ Another aproach would be to create a named pipe that your email program reads fr
 
 
 
-Options
--------
-
-signore supports a single option, `--database` (or `-d` for short), which can be used to use a non-default signature database location:
-
-    $ signore prego -d spec/fixtures/signatures.yml
-    Amateur fighter pilot ignores orders, listens to
-    the voices in his head and slaughters thousands.
-                        [Star Wars ending explained]
-
-
-
 Properties
 ----------
 

data/Rakefile

@@ -2,9 +2,9 @@ require 'rake/testtask'
 require 'reek/rake/task'
 require 'rubocop/rake_task'
 
-task default: %i[spec rubocop reek]
+task default: %i(spec rubocop reek)
 
-Rake::TestTask.new :spec do |task|
+Rake::TestTask.new(:spec) do |task|
   task.test_files = FileList['spec/**/*_spec.rb']
   task.warning    = true
 end
@@ -15,4 +15,6 @@ Reek::Rake::Task.new do |task|
   task.reek_opts     = '--quiet'
 end
 
-Rubocop::RakeTask.new
+RuboCop::RakeTask.new do |task|
+  task.options << '--display-cop-names'
+end

data/bin/signore

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require_relative '../lib/signore'
-Signore::Executable.new.run
+Signore::CLI.new.run

data/config/reek.yml

@@ -1,14 +1,17 @@
 DuplicateMethodCall:
   exclude:
-  - Signore::Database#find
+    - Signore::SigFinder#find_tagged
+
+FeatureEnvy:
+  exclude:
+    - Signore::Settings#forbidden
 
 IrresponsibleModule:
   enabled: false
 
 NestedIterators:
-  exclude:
-  - Signore::Database#find
   max_allowed_nesting: 2
 
-UnusedParameters:
-  enabled: false
+UtilityFunction:
+  exclude:
+    - Signore::Settings#db_path

data/lib/signore/cli.rb

@@ -0,0 +1,28 @@
+require_relative 'database'
+require_relative 'settings'
+require_relative 'sig_from_stream'
+
+module Signore
+  class CLI
+    def initialize(args = ARGV, db: Database.new)
+      @settings = Settings.new(args)
+      @db       = db
+    end
+
+    def run(input: $stdin)
+      case settings.action
+      when 'prego'
+        puts db.find(tags: settings.tags)
+      when 'pronto'
+        sig = SigFromStream.sig_from(input, tags: settings.tags)
+        db << sig
+        puts sig
+      else
+        abort 'usage: signore prego|pronto [tag, …]'
+      end
+    end
+
+    attr_reader :db, :settings
+    private     :db, :settings
+  end
+end

data/lib/signore/database.rb

@@ -1,24 +1,37 @@
-module Signore class Database
-  def initialize path
-    @store = YAML::Store.new path
-  end
+require 'fileutils'
+require 'yaml/store'
+require_relative 'settings'
+require_relative 'sig_finder'
+require_relative 'tags'
 
-  def << sig
-    store.transaction do
-      store['signatures'] ||= []
-      store['signatures'] << sig
+module Signore
+  class Database
+    def initialize(path: Settings.new.db_path, sig_finder: SigFinder)
+      @path       = path
+      @sig_finder = sig_finder
+      initialise_store if path.zero? or not path.exist?
+      @store      = YAML::Store.new(path)
     end
-  end
 
-  def find forbidden_tags: [], random: Random.new, required_tags: []
-    store.transaction true do
-      store['signatures']
-        .select { |sig| required_tags.all?  { |tag| sig.tagged_with? tag } }
-        .reject { |sig| forbidden_tags.any? { |tag| sig.tagged_with? tag } }
-        .sample random: random
+    def <<(sig)
+      store.transaction { store['signatures'] << sig }
+      sig
+    end
+
+    def find(tags: Tags.new)
+      sigs = store.transaction(true) { store['signatures'] }
+      sig_finder.find(sigs, tags: tags)
     end
-  end
 
-  attr_reader :store
-  private     :store
-end end
+    attr_reader :path, :sig_finder, :store
+    private     :path, :sig_finder, :store
+
+    private
+
+    def initialise_store
+      FileUtils.mkdir_p path.dirname
+      FileUtils.touch path
+      YAML::Store.new(path).transaction { |store| store['signatures'] = [] }
+    end
+  end
+end

data/lib/signore/settings.rb

@@ -0,0 +1,36 @@
+require 'pathname'
+require_relative 'tags'
+
+module Signore
+  class Settings
+    def initialize(args = [])
+      @args = args
+    end
+
+    def action
+      args.first
+    end
+
+    def db_path
+      db_dir = ENV.fetch('XDG_DATA_HOME') { File.expand_path('~/.local/share') }
+      Pathname.new("#{db_dir}/signore/signatures.yml")
+    end
+
+    def tags
+      Tags.new(forbidden: forbidden, required: required)
+    end
+
+    attr_reader :args
+    private     :args
+
+    private
+
+    def forbidden
+      args[1..-1].select { |tag| tag.start_with?('~') }.map { |tag| tag[1..-1] }
+    end
+
+    def required
+      args[1..-1].reject { |tag| tag.start_with?('~') }
+    end
+  end
+end

data/lib/signore/sig_finder.rb

@@ -0,0 +1,24 @@
+require_relative 'tags'
+
+module Signore
+  class SigFinder
+    def self.find(sigs, random: Random.new, tags: Tags.new)
+      new(sigs, random: random).find_tagged(tags: tags)
+    end
+
+    def initialize(sigs, random: Random.new)
+      @random = random
+      @sigs   = sigs
+    end
+
+    def find_tagged(tags: Tags.new)
+      sigs
+        .select { |sig| tags.required.all?  { |tag| sig.tagged_with?(tag) } }
+        .reject { |sig| tags.forbidden.any? { |tag| sig.tagged_with?(tag) } }
+        .sample(random: random) or Signature.new
+    end
+
+    attr_reader :random, :sigs
+    private     :random, :sigs
+  end
+end

data/lib/signore/sig_from_stream.rb

@@ -0,0 +1,38 @@
+require_relative 'signature'
+require_relative 'tags'
+
+module Signore
+  class SigFromStream
+    Params = Struct.new(*%i(text author subject source))
+
+    def self.sig_from(input, tags: Tags.new)
+      new(input, tags: tags).to_sig
+    end
+
+    def initialize(input, tags: Tags.new)
+      @input = input
+      @tags  = tags
+    end
+
+    def to_sig
+      Signature.new(params.text, author: params.author, source: params.source,
+                                 subject: params.subject, tags: tags.required)
+    end
+
+    attr_reader :input, :tags
+    private     :input, :tags
+
+    private
+
+    def get_param(param)
+      puts "#{param}?"
+      ''.tap do |value|
+        value << input.gets until value.lines.to_a.last == "\n"
+      end.strip
+    end
+
+    def params
+      @params ||= Params.new(*Params.members.map { |name| get_param(name) })
+    end
+  end
+end

data/lib/signore/signature.rb

@@ -1,39 +1,37 @@
-module Signore Signature = Struct.new(*%i(text author source subject tags)) do
-  class << self
-    undef :[]
-  end
-
-  def self.[] author: nil, source: nil, subject: nil, tags: nil, text: nil
-    new text, author, source, subject, tags
-  end
-
-  def tagged_with? tag
-    tags and tags.include? tag
-  end
-
-  def to_s
-    wrapped  = LovelyRufus::TextWrapper.wrap text.gsub("\n", "\n\n"), width: 80
-    squeezed = wrapped.gsub("\n\n", "\n").chomp
-    squeezed + meta_for(squeezed)
-  end
-
-  private
-
-  def indent_size_for text
-    indent = text_width(text) - meta.size - 2
-    indent < 0 ? 0 : indent
-  end
-
-  def meta
-    stem = [author, subject].compact.join ' '
-    stem.empty? ? "#{source}" : [stem, source].compact.join(', ')
-  end
-
-  def meta_for text
-    meta.empty? ? '' : "\n#{' ' * indent_size_for(text)}[#{meta}]"
-  end
-
-  def text_width text
-    text.split("\n").map(&:size).max
-  end
-end end
+require 'lovely_rufus'
+
+module Signore
+  Signature = Struct.new(*%i(text author source subject tags)) do
+    def initialize(text = '', author: nil, source: nil, subject: nil, tags: nil)
+      super text, author, source, subject, tags
+      each_pair { |key, value| self[key] = nil if value and value.empty? }
+    end
+
+    def tagged_with?(tag)
+      tags and tags.include?(tag)
+    end
+
+    def to_s
+      spaced   = text.gsub("\n", "\n\n")
+      wrapped  = LovelyRufus.wrap(spaced, width: 80)
+      squeezed = wrapped.gsub("\n\n", "\n").chomp
+      squeezed + meta_for(squeezed)
+    end
+
+    private
+
+    def indent_size_for(text)
+      indent = text.split("\n").map(&:size).max - meta.size - 2
+      indent < 0 ? 0 : indent
+    end
+
+    def meta
+      stem = [author, subject].compact.join(' ')
+      stem.empty? ? "#{source}" : [stem, source].compact.join(', ')
+    end
+
+    def meta_for(text)
+      meta.empty? ? '' : "\n#{' ' * indent_size_for(text)}[#{meta}]"
+    end
+  end
+end

data/lib/signore/tags.rb

@@ -0,0 +1,7 @@
+module Signore
+  Tags = Struct.new(:forbidden, :required) do
+    def initialize(forbidden: [], required: [])
+      super forbidden, required
+    end
+  end
+end

data/lib/signore.rb

@@ -1,9 +1 @@
-require 'fileutils'
-require 'lovely_rufus'
-require 'optparse'
-require 'ostruct'
-require 'yaml/store'
-
-require_relative 'signore/database'
-require_relative 'signore/executable'
-require_relative 'signore/signature'
+require_relative 'signore/cli'

data/signore.gemspec

@@ -1,22 +1,25 @@
 Gem::Specification.new do |gem|
   gem.author      = 'Piotr Szotkowski'
-  gem.description = 'signore helps manage email signatures and select random ones based on their tags'
+  gem.description = 'signore helps manage email signatures and select ' \
+                    'random ones based on their tags'
   gem.email       = 'chastell@chastell.net'
   gem.homepage    = 'http://github.com/chastell/signore'
   gem.license     = 'AGPL-3.0'
   gem.name        = 'signore'
   gem.summary     = 'signore: an email signature manager/randomiser'
-  gem.version     = '0.2.2'
+  gem.version     = '0.2.3'
 
   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{^spec/.*\.rb$}
+  gem.executables = gem.files.grep(/^bin\//).map { |path| File.basename(path) }
+  gem.test_files  = gem.files.grep(/^spec\/.*\.rb$/)
 
-  gem.add_dependency 'lovely_rufus', '~> 0.1.2'
+  gem.add_dependency 'lovely_rufus', '~> 0.2.0'
 
-  gem.add_development_dependency 'minitest', '~> 5.0'
-  gem.add_development_dependency 'rake',     '~> 10.1'
-  gem.add_development_dependency 'reek',     '~> 1.3'
-  gem.add_development_dependency 'rerun',    '~> 0.9.0'
-  gem.add_development_dependency 'rubocop',  '~> 0.20.0'
+  gem.add_development_dependency 'bogus',          '~> 0.1.3'
+  gem.add_development_dependency 'minitest',       '~> 5.0'
+  gem.add_development_dependency 'minitest-focus', '~> 1.1'
+  gem.add_development_dependency 'rake',           '~> 10.1'
+  gem.add_development_dependency 'reek',           '~> 1.3'
+  gem.add_development_dependency 'rerun',          '~> 0.10.0'
+  gem.add_development_dependency 'rubocop',        '~> 0.26.0'
 end

data/spec/signore/cli_spec.rb

@@ -0,0 +1,92 @@
+require 'pathname'
+require 'stringio'
+require 'tempfile'
+require 'tmpdir'
+require_relative '../spec_helper'
+require_relative '../../lib/signore/cli'
+
+module Signore
+  describe CLI do
+    describe '#run' do
+      it 'prints usage if no command is given' do
+        out = capture_io { -> { CLI.new([]).run }.must_raise SystemExit }.last
+        out.must_include 'usage: signore prego|pronto [tag, …]'
+      end
+
+      it 'prints usage if a bogus command is given' do
+        out = capture_io do
+          -> { CLI.new(['bogus']).run }.must_raise SystemExit
+        end.last
+        out.must_include 'usage: signore prego|pronto [tag, …]'
+      end
+
+      describe 'prego' do
+        let(:db)   { Database.new(path: path)                     }
+        let(:path) { Pathname.new('spec/fixtures/signatures.yml') }
+
+        it 'prints a signature tagged with the provided tags' do
+          args = %w(prego tech programming)
+          out  = capture_io { CLI.new(args, db: db).run }.first
+          sig  = "// sometimes I believe compiler 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)
+          out  = capture_io { CLI.new(args, db: db).run }.first
+          out.must_equal <<-end.dedent
+            You do have to be mad to work here, but it doesn’t help.
+                                                  [Gary Barnes, asr]
+          end
+        end
+      end
+
+      describe 'pronto' do
+        let(:db) { Database.new(path: Pathname.new(Tempfile.new('').path)) }
+
+        it 'asks about signature parts and saves resulting signature' do
+          input = StringIO.new <<-end.dedent
+            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)
+          out  = capture_io { CLI.new(args, db: db).run input: input }.first
+          out.must_equal <<-end.dedent
+            text?
+            author?
+            subject?
+            source?
+            The Wikipedia page on ADHD is like 20 pages long. That’s just cruel.
+                                                                  [Mark Pilgrim]
+          end
+          args = %w(prego Wikipedia ADHD)
+          out  = capture_io { CLI.new(args, db: db).run }.first
+          out.must_equal <<-end.dedent
+            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
+            ‘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'], db: db).run input: input }
+          io.first.must_equal <<-end.dedent
+            text?
+            author?
+            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]
+          end
+        end
+      end
+    end
+  end
+end