signore 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 574592e64de19564735c0cb34ed8176d4a2c2ef2
-  data.tar.gz: e2c9d9a4e3ca171b214f936865fabbaf675a1786
+  metadata.gz: eba6ae8ca7d28dd0e9ab1ba802d3c123cac60ea8
+  data.tar.gz: 863b5bf72e37a144dab17cbb4f4e0b81b993471a
 SHA512:
-  metadata.gz: 7789db08a85ae9121a8764d677297c3f165b163804edf4819fe60619e5614c5c36709ef9bedf469d613294d4ffc5e9f8251a0f1c7874a0395520cd8a0d4dd242
-  data.tar.gz: ec717cbde5846a0aea3dc693b76edbfee3f2f85bece044452c9eec4b39acb92be1e9a5d021c6c3cf3dc7af58a35c4a99f1854735b60e23a57c4f3d4fd5e9e31e
+  metadata.gz: 33ec2292285973a2bf1b2e906088b593005108d38dcbc6217ff4e7e8b961303fdc99109d2c63ad099f89cddd9276c59e4280f44a7e4a10ed9da59f4b786a494c
+  data.tar.gz: a9eca84ec42b8cbc4a9790c2e30a0f815d54f18955f92e4675e08feb1761da4ed1d9088cff407fe6c833c8f6fe5aeed221b76496ec35eeef9cbf0332283fbfba

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    signore (0.2.4)
+    signore (0.3.0)
       lovely_rufus (~> 0.2.0)
 
 GEM
@@ -25,7 +25,7 @@ GEM
     minitest (5.4.2)
     minitest-focus (1.1.0)
       minitest (>= 4, < 6)
-    parser (2.2.0.pre.5)
+    parser (2.2.0.pre.7)
       ast (>= 1.1, < 3.0)
       slop (~> 3.4, >= 3.4.5)
     powerpack (0.0.9)
@@ -41,13 +41,13 @@ GEM
       sexp_processor
     rerun (0.10.0)
       listen (~> 2.7, >= 2.7.3)
-    rubocop (0.26.1)
+    rubocop (0.27.0)
       astrolabe (~> 1.3)
-      parser (>= 2.2.0.pre.4, < 3.0)
+      parser (>= 2.2.0.pre.6, < 3.0)
       powerpack (~> 0.0.6)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
-    ruby-progressbar (1.6.0)
+    ruby-progressbar (1.7.0)
     ruby2ruby (2.1.3)
       ruby_parser (~> 3.1)
       sexp_processor (~> 4.0)
@@ -68,5 +68,5 @@ DEPENDENCIES
   rake (~> 10.1)
   reek (~> 1.3)
   rerun (~> 0.10.0)
-  rubocop (~> 0.26.0)
+  rubocop (~> 0.27.0)
   signore!

data/bin/signore

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

data/config/reek.yml

@@ -4,6 +4,8 @@ DuplicateMethodCall:
 
 FeatureEnvy:
   exclude:
+    - Signore::Mapper#from_h
+    - Signore::Mapper#to_h
     - Signore::Settings#forbidden
 
 IrresponsibleModule:
@@ -14,4 +16,5 @@ NestedIterators:
 
 UtilityFunction:
   exclude:
+    - Signore::Mapper#from_h
     - Signore::Settings#db_path

data/lib/signore/cli.rb

@@ -15,7 +15,6 @@ module Signore
     end
 
     def run(input: $stdin)
-      trap(:INT) { exit }
       case action
       when 'prego'  then puts retrieve_sig
       when 'pronto' then puts create_sig_from(input)

data/lib/signore/database.rb

@@ -1,7 +1,9 @@
 require 'fileutils'
 require 'yaml/store'
+require_relative 'mapper'
 require_relative 'settings'
 require_relative 'sig_finder'
+require_relative 'signature'
 require_relative 'tags'
 
 module Signore
@@ -14,14 +16,20 @@ module Signore
     end
 
     def <<(sig)
-      store.transaction { store['signatures'] << sig }
+      sigs << sig
+      persist
     end
 
     def find(tags: Tags.new)
-      sigs = store.transaction(true) { store['signatures'] }
       sig_finder.find(sigs, tags: tags)
     end
 
+    def sigs
+      @sigs ||= store.transaction(true) { store['signatures'] }.map do |elem|
+        elem.is_a?(Signature) ? elem : Mapper.from_h(elem)
+      end
+    end
+
     attr_reader :path, :sig_finder, :store
     private     :path, :sig_finder, :store
 
@@ -32,5 +40,10 @@ module Signore
       FileUtils.touch path
       YAML::Store.new(path).transaction { |store| store['signatures'] = [] }
     end
+
+    def persist
+      hashes = sigs.map { |sig| Mapper.to_h(sig) }
+      store.transaction { store['signatures'] = hashes }
+    end
   end
 end

data/lib/signore/mapper.rb

@@ -0,0 +1,15 @@
+require_relative 'signature'
+
+module Signore
+  module Mapper
+    module_function
+
+    def from_h(hash)
+      Signature.new(hash.map { |key, value| [key.to_sym, value] }.to_h)
+    end
+
+    def to_h(signature)
+      signature.to_h
+    end
+  end
+end

data/lib/signore/sig_from_stream.rb

@@ -15,8 +15,9 @@ module Signore
     end
 
     def to_sig
-      Signature.new(params.text, author: params.author, source: params.source,
-                                 subject: params.subject, tags: tags.required)
+      Signature.new(author: params.author, source: params.source,
+                    subject: params.subject, tags: tags.required,
+                    text: params.text)
     end
 
     attr_reader :input, :tags

data/lib/signore/signature.rb

@@ -1,9 +1,9 @@
 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
+  Signature = Struct.new(*%i(author source subject tags text)) do
+    def initialize(author: nil, source: nil, subject: nil, tags: nil, text: nil)
+      super author, source, subject, tags, text
       each_pair { |key, value| self[key] = nil if value and value.empty? }
     end
 
@@ -11,6 +11,10 @@ module Signore
       tags and tags.include?(tag)
     end
 
+    def to_h
+      super.map { |key, val| [key.to_s, val] }.to_h.keep_if { |_, value| value }
+    end
+
     def to_s
       spaced   = text.gsub("\n", "\n\n")
       wrapped  = LovelyRufus.wrap(spaced, width: 80)

data/signore.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.license     = 'AGPL-3.0'
   gem.name        = 'signore'
   gem.summary     = 'signore: an email signature manager/randomiser'
-  gem.version     = '0.2.4'
+  gem.version     = '0.3.0'
 
   gem.files       = `git ls-files -z`.split "\0"
   gem.executables = gem.files.grep(/^bin\//).map { |path| File.basename(path) }
@@ -21,5 +21,5 @@ Gem::Specification.new do |gem|
   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'
+  gem.add_development_dependency 'rubocop',        '~> 0.27.0'
 end

data/spec/fixtures/signatures.legacy.yml

@@ -0,0 +1,23 @@
+signatures:
+- !ruby/struct:Signore::Signature
+  text: She was good at playing abstract confusion in the same way a midget is good at being short.
+  author: Clive James
+  subject: on Marilyn Monroe
+- !ruby/struct:Signore::Signature
+  text: You do have to be mad to work here, but it doesn’t help.
+  author: Gary Barnes
+  source: asr
+  tags: [tech, work]
+- !ruby/struct:Signore::Signature
+  text: // sometimes I believe compiler ignores all my comments
+  tags: [programming, tech]
+- !ruby/struct:Signore::Signature
+  text: Bruce Schneier knows Alice and Bob’s shared secret.
+  source: Bruce Schneier Facts
+  tags: [security, tech]
+- !ruby/struct:Signore::Signature
+  text: stay-at-home executives vs. wallstreet dads
+  author: kodz
+- !ruby/struct:Signore::Signature
+  text: Amateur fighter pilot ignores orders, listens to the voices in his head and slaughters thousands.
+  subject: Star Wars ending explained

data/spec/fixtures/signatures.yml

@@ -1,23 +1,17 @@
 signatures:
-- !ruby/struct:Signore::Signature
-  text: She was good at playing abstract confusion in the same way a midget is good at being short.
+- text: She was good at playing abstract confusion in the same way a midget is good at being short.
   author: Clive James
   subject: on Marilyn Monroe
-- !ruby/struct:Signore::Signature
-  text: You do have to be mad to work here, but it doesn’t help.
+- text: You do have to be mad to work here, but it doesn’t help.
   author: Gary Barnes
   source: asr
   tags: [tech, work]
-- !ruby/struct:Signore::Signature
-  text: // sometimes I believe compiler ignores all my comments
+- text: // sometimes I believe compiler ignores all my comments
   tags: [programming, tech]
-- !ruby/struct:Signore::Signature
-  text: Bruce Schneier knows Alice and Bob’s shared secret.
+- text: Bruce Schneier knows Alice and Bob’s shared secret.
   source: Bruce Schneier Facts
   tags: [security, tech]
-- !ruby/struct:Signore::Signature
-  text: stay-at-home executives vs. wallstreet dads
+- text: stay-at-home executives vs. wallstreet dads
   author: kodz
-- !ruby/struct:Signore::Signature
-  text: Amateur fighter pilot ignores orders, listens to the voices in his head and slaughters thousands.
+- text: Amateur fighter pilot ignores orders, listens to the voices in his head and slaughters thousands.
   subject: Star Wars ending explained

data/spec/signore/database_spec.rb

@@ -10,20 +10,27 @@ require_relative '../../lib/signore/tags'
 module Signore
   describe Database do
     describe '#<<' do
+      let(:path) { Pathname.new(Tempfile.new('').path)                     }
+      let(:sig)  { Signature.new(text: text)                               }
+      let(:text) { 'Normaliser Unix c’est comme pasteuriser le camembert.' }
+
       it 'saves the provided signature to disk' do
-        text = 'Normaliser Unix c’est comme pasteuriser le camembert.'
-        sig  = Signature.new(text)
-        path = Pathname.new(Tempfile.new('').path)
         Database.new(path: path) << sig
         path.read.must_include text
       end
+
+      it 'rewrites legacy YAML files on save' do
+        FileUtils.cp Pathname.new('spec/fixtures/signatures.legacy.yml'), path
+        Database.new(path: path) << sig
+        path.read.wont_include 'Signore::Signature'
+      end
     end
 
     describe '#find' do
       let(:database)   { Database.new(path: path, sig_finder: sig_finder) }
       let(:path)       { Pathname.new('spec/fixtures/signatures.yml')     }
       let(:sig_finder) { fake(:sig_finder, as: :class)                    }
-      let(:sigs)       { store.transaction(true) { store['signatures'] }  }
+      let(:sigs)       { database.sigs                                    }
       let(:store)      { YAML::Store.new(path)                            }
 
       it 'returns a random signature by default' do
@@ -46,6 +53,23 @@ module Signore
           FileUtils.rmtree tempdir
         end
       end
+
+      it 'keeps working with legacy YAML files' do
+        path = Pathname.new('spec/fixtures/signatures.legacy.yml')
+        database = Database.new(path: path, sig_finder: sig_finder)
+        stub(sig_finder).find(sigs, tags: Tags.new) { sigs.last }
+        database.find.must_equal sigs.last
+      end
+    end
+
+    describe '#sigs' do
+      it 'returns all the Signatures from the Database' do
+        path = Pathname.new('spec/fixtures/signatures.yml')
+        sigs = Database.new(path: path).sigs
+        sigs.size.must_equal 6
+        sigs.first.author.must_equal 'Clive James'
+        sigs.last.subject.must_equal 'Star Wars ending explained'
+      end
     end
   end
 end

data/spec/signore/mapper_spec.rb

@@ -0,0 +1,37 @@
+require_relative '../spec_helper'
+require_relative '../../lib/signore/mapper'
+require_relative '../../lib/signore/signature'
+
+module Signore
+  describe Mapper do
+    let(:sig_hash) do
+      {
+        'author'  => 'Anonymous Coward',
+        'source'  => '/.',
+        'subject' => 'on ‘Monty Wants to Save MySQL’',
+        'tags'    => %w(/. MySQL),
+        'text'    => text,
+      }
+    end
+    let(:signature) do
+      Signature.new(author: 'Anonymous Coward', source: '/.',
+                    subject: 'on ‘Monty Wants to Save MySQL’',
+                    tags: %w(/. MySQL), text: text)
+    end
+    let(:text) do
+      'For the sake of topic titles, I’d rather if Monty saved Python.'
+    end
+
+    describe '.from_h' do
+      it 'deserializes a Signature from a Hash' do
+        Mapper.from_h(sig_hash).must_equal signature
+      end
+    end
+
+    describe '.to_h' do
+      it 'serialises a Signature to a Hash' do
+        Mapper.to_h(signature).must_equal sig_hash
+      end
+    end
+  end
+end

data/spec/signore/sig_finder_spec.rb

@@ -6,8 +6,7 @@ require_relative '../../lib/signore/tags'
 module Signore
   describe SigFinder do
     let(:sigs) do
-      store = YAML::Store.new('spec/fixtures/signatures.yml')
-      store.transaction(true) { store['signatures'] }
+      Database.new(path: Pathname.new('spec/fixtures/signatures.yml')).sigs
     end
 
     let(:sig_finder) { SigFinder.new(sigs) }

data/spec/signore/sig_from_stream_spec.rb

@@ -30,7 +30,8 @@ module Signore
         sig = nil
         capture_io { sig = SigFromStream.sig_from input }
         text = 'You do have to be mad to work here, but it doesn’t help.'
-        sig.must_equal Signature.new(text, author: 'Gary Barnes', source: 'asr')
+        sig.must_equal Signature.new(author: 'Gary Barnes', source: 'asr',
+                                     text: text)
       end
 
       it 'handles multi-line signatures' do
@@ -47,7 +48,7 @@ module Signore
           ‘You’ve got an interesting accent. Subtle. I can’t place it.’
           ‘It’s text-to-speech… I was raised by smartphones.’
         end
-        sig.must_equal Signature.new(text, author: 'Patrick Ewing')
+        sig.must_equal Signature.new(author: 'Patrick Ewing', text: text)
       end
     end
   end

data/spec/signore/signature_spec.rb

@@ -9,9 +9,9 @@ module Signore
         source = 'A History of Modern Computing'
         text   = 'In 1940 he summarized his work in an influential book, ' \
           '‘Punched Card Methods in Scientific Computation’.'
-        sig = Signature.new(text, author: 'Paul E. Ceruzzi', source: source,
-                                  subject: 'on Wallace Eckert',
-                                  tags: ['punched cards'])
+        sig = Signature.new(author: 'Paul E. Ceruzzi', source: source,
+                            subject: 'on Wallace Eckert',
+                            tags: ['punched cards'], text: text)
         sig.author.must_equal 'Paul E. Ceruzzi'
         sig.source.must_equal source
         sig.subject.must_equal 'on Wallace Eckert'
@@ -20,15 +20,16 @@ module Signore
       end
 
       it 'nils empty parameters' do
-        new = Signature.new('', author: '', source: '', subject: '', tags: [])
-        new.must_equal Signature.new(nil, author: nil, source: nil,
-                                          subject: nil, tags: nil)
+        new = Signature.new(author: '', source: '', subject: '', tags: [],
+                            text: '')
+        new.must_equal Signature.new(author: nil, source: nil, subject: nil,
+                                     tags: nil, text: nil)
       end
     end
 
     describe '#tagged_with?' do
       it 'says whether a tagged signature is tagged with a given tag' do
-        sig = Signature.new('', tags: %w(programming tech))
+        sig = Signature.new(tags: %w(programming tech), text: '')
         refute sig.tagged_with?('fnord')
         assert sig.tagged_with?('programming')
         assert sig.tagged_with?('tech')
@@ -39,16 +40,33 @@ module Signore
       end
     end
 
+    describe '#to_h' do
+      it 'returns a String-keyed Hash representation of the Signature' do
+        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)
+        sig.to_h.must_equal 'author' => 'Anonymous Coward', 'source' => '/.',
+                            'subject' => 'on ‘Monty Wants to Save MySQL’',
+                            'tags' => %w(/. MySQL), 'text' => text
+
+      end
+
+      it 'removes non-existing keys' do
+        assert Signature.new.to_h.empty?
+      end
+    end
+
     describe '#to_s' do
       it 'does not show meta if there’s nothing to show' do
         text = '// sometimes I believe compiler ignores all my comments'
-        sig  = Signature.new(text)
+        sig  = Signature.new(text: text)
         sig.to_s.must_equal text
       end
 
       it 'shows author on its own' do
-        sig = Signature.new('stay-at-home executives vs. wallstreet dads',
-                            author: 'kodz')
+        sig = Signature.new(author: 'kodz',
+                            text: 'stay-at-home executives vs. wallstreet dads')
         sig.to_s.must_equal <<-end.dedent.strip
           stay-at-home executives vs. wallstreet dads
                                                [kodz]
@@ -57,7 +75,7 @@ module Signore
 
       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(text, author: 'Gary Barnes', source: 'asr')
+        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]
@@ -66,7 +84,7 @@ module Signore
 
       it 'shows source on its own' do
         text = 'Bruce Schneier knows Alice and Bob’s shared secret.'
-        sig  = Signature.new(text, source: 'Bruce Schneier Facts')
+        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]
@@ -76,8 +94,8 @@ module Signore
       it 'shows author and subject, space separated' do
         text = 'She was good at playing abstract confusion ' \
         'in the same way a midget is good at being short.'
-        sig = Signature.new(text, author: 'Clive James',
-                                  subject: 'on Marilyn Monroe')
+        sig = Signature.new(author: 'Clive James', subject: 'on Marilyn Monroe',
+                            text: text)
         sig.to_s.must_equal <<-end.dedent.strip
           She was good at playing abstract confusion in
           the same way a midget is good at being short.
@@ -88,7 +106,7 @@ module Signore
       it 'shows subject on its own' do
         text = 'Amateur fighter pilot ignores orders, listens ' \
           'to the voices in his head and slaughters thousands.'
-        sig = Signature.new(text, subject: 'Star Wars ending explained')
+        sig = Signature.new(subject: 'Star Wars ending explained', text: text)
         sig.to_s.must_equal <<-end.dedent.strip
           Amateur fighter pilot ignores orders, listens to
           the voices in his head and slaughters thousands.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signore
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Piotr Szotkowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-18 00:00:00.000000000 Z
+date: 2014-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lovely_rufus
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: 0.27.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: 0.27.0
 description: signore helps manage email signatures and select random ones based on
   their tags
 email: chastell@chastell.net
@@ -142,16 +142,19 @@ files:
 - lib/signore.rb
 - lib/signore/cli.rb
 - lib/signore/database.rb
+- lib/signore/mapper.rb
 - lib/signore/settings.rb
 - lib/signore/sig_finder.rb
 - lib/signore/sig_from_stream.rb
 - lib/signore/signature.rb
 - lib/signore/tags.rb
 - signore.gemspec
+- spec/fixtures/signatures.legacy.yml
 - spec/fixtures/signatures.yml
 - spec/fixtures/wrapper.yml
 - spec/signore/cli_spec.rb
 - spec/signore/database_spec.rb
+- spec/signore/mapper_spec.rb
 - spec/signore/settings_spec.rb
 - spec/signore/sig_finder_spec.rb
 - spec/signore/sig_from_stream_spec.rb
@@ -184,6 +187,7 @@ summary: 'signore: an email signature manager/randomiser'
 test_files:
 - spec/signore/cli_spec.rb
 - spec/signore/database_spec.rb
+- spec/signore/mapper_spec.rb
 - spec/signore/settings_spec.rb
 - spec/signore/sig_finder_spec.rb
 - spec/signore/sig_from_stream_spec.rb