libis-tools 0.9.56 → 0.9.57

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97d3c16d53f3b37947752b8efa13d313265c569b
-  data.tar.gz: 7fab21f7cad512ed195ea01937fb60d0b5b5b8af
+  metadata.gz: f41609527ad591aacb554d78427bd483c72c3e98
+  data.tar.gz: d8c7b2d1a9df6ed014844cad0d4789e4b0a8da91
 SHA512:
-  metadata.gz: e1543c8b2515dac9c1c8704e6453e972638233c771dcddcdc0443aaf739c1441dfd80e56b918c9c520667af1e294f9e8c836de71dd9d0ceff7ed4fa81a051839
-  data.tar.gz: 4935cdd72ec551e872ca26d7c6036c98524d34b4149296ac7572c484a034537fcce0901477d6f4199307996620a379d2d311bca3fe2857e2766355cc3a9027aa
+  metadata.gz: e9ac55598115c0ded4f4212a2a27b21cc2809ad56a98bd1e3d0ba933845d9d9e372cf0e1f52744419525f36f929a8b4c721b9504f7e467c4d66da9744e822e4e
+  data.tar.gz: 9d69b719ca4432dad3b7709ec872ad949d720f21030434a8959077c05b966ae64fc1126c454067d317bcb7d25f0b7a9a9fe4beb1f8a80e4aef86d75be655471a

data/README.md

@@ -99,7 +99,34 @@ The code will strip namespaces from the input in order to greatly simplify worki
 The class {::Libis::Tools::Parameter} and the {::Libis::Tools::ParameterContainer} module provide a simple framework for
 instance variables that are type-safe and can easily be documented and provide defaults.
 
-### {::Libis::Tools::XmlDocument}
+## {::Libis::Tools::TempFile}
+
+A small and simple module that provides some convenience methods to deal with temp files. Random file names are generated
+in a similar way as the standard Ruby Tempfile class does. It has the form:
+```
+    <Optional prefix with '_' appended>_<YYYYMMDD>_<process id>_<random base36 number><optional suffix>
+```
+
+The #name method creates a random file name. Optional parameters are the prefix and suffix (including '.' character if
+needed) for the temp file name and the directory part of the file path. Without directory option the file path will be
+located in the standard folder for temporary files (e.g. /tmp on Linux).
+
+The #file method creates a random file name as above, but immediately opens it for writing. If a block is given, the open
+file pointer (IO object) will be passed as argument to the block and the file will automatically be closed and deleted
+when the block ends. In that case the return value will be whatever the block returns.
+
+Without a block, the method still creates and opens the file, but it will return the open file pointer to the caller. The
+caller is responsible to #close and #unlink or #delete the file. The #unlink and #delete methods are injected into the
+returned IO object for your convenience, but it calling the corresponding File methods instead is equally valid.
+
+## {::Libis::Tools::ThreadSafe}
+
+A convenience method that embeds the mutex implementation. Just include this module whenever you need a thread-save
+implementation and use the mutex instance variable without any concerns regarding initialization. Your class will have
+access to an instance variable 'mutex' as well as a class variable 'class_mutex'. The mutexes (Montor instance) are created
+in a thread-safe way.
+
+## {::Libis::Tools::XmlDocument}
 
 Class that embodies most used features of Nokogiri, Nori and Gyoku in one convenience class. The Nokogiri document is
 stored in the class variable 'document' and can be accessed and manipulated directly - if required. The class supports

data/lib/libis/tools.rb

@@ -13,6 +13,7 @@ module Libis
     autoload :MetsFile, 'libis/tools/mets_file'
     autoload :Parameter, 'libis/tools/parameter'
     autoload :Spreadsheet, 'libis/tools/spreadsheet'
+    autoload :TempFile, 'libis/tools/temp_file'
     autoload :ThreadSafe, 'libis/tools/thread_safe'
     autoload :XmlDocument, 'libis/tools/xml_document'
 

data/lib/libis/tools/temp_file.rb

@@ -0,0 +1,42 @@
+require 'libis/tools/extend/empty'
+
+module Libis
+  module Tools
+
+    module TempFile
+
+      def self.dir
+        Dir.tmpdir
+      end
+
+      def self.name(prefix = '', suffix = '', _dir = nil)
+        _dir ||= dir
+        t = Time.now.strftime('%Y%m%d')
+        t = '_' + t unless prefix.empty?
+        File.join(_dir, "#{prefix}#{t}_#{$$}_#{rand(0x100000000).to_s(36)}#{suffix}".freeze)
+      end
+
+      def self.file(prefix = '', suffix = '', dir = nil)
+        f = File.open(name(prefix, suffix, dir), 'w')
+
+        def f.unlink
+          File.unlink self
+        end
+
+        def f.delete
+          File.delete self
+        end
+
+        if block_given?
+          x = yield(f)
+          f.close
+          f.delete
+          return x
+        else
+          return f
+        end
+      end
+    end
+
+  end
+end

data/lib/libis/tools/version.rb

@@ -1,5 +1,5 @@
 module Libis
   module Tools
-    VERSION = '0.9.56'
+    VERSION = '0.9.57'
   end
 end

data/libis-tools.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 10.3'
   spec.add_development_dependency 'rspec', '~> 3.1'
-  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'term-ansicolor', '~> 1.6'
   spec.add_development_dependency 'equivalent-xml', '~> 0.5'
   spec.add_development_dependency 'awesome_print', '~> 1.6'
 

data/spec/metadata/marc21_spec.rb

@@ -138,7 +138,7 @@ STR
     let(:xml) { Libis::Tools::XmlDocument.open(File.join(File.dirname(__FILE__), '123456789.marc')) }
 
     it 'load from xml' do
-      puts record.marc_dump
+      # puts record.marc_dump
       expect(record.marc_dump).to eq <<-STR.align_left
         LDR:'01068nam 2200241u 4500'
         005:'20150701153710.0'
@@ -167,7 +167,7 @@ STR
   <dc:language>la</dc:language>
 </dc:record>
 STR
-      puts puts record.to_dc.to_xml
+      # puts puts record.to_dc.to_xml
       record.to_dc.root.elements.each_with_index do |element, i|
         expect(element).to be_equivalent_to(xml_doc.root.elements[i])
       end

data/spec/temp_file_spec.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+require_relative 'spec_helper'
+require 'libis/tools/temp_file'
+
+describe 'TempFile' do
+
+  context 'name' do
+
+    it 'without arguments' do
+      fname = Libis::Tools::TempFile.name()
+      expect(File.basename(fname)).to match(/^\d{8}_\d+_\w+$/)
+    end
+
+    it 'with prefix' do
+      fname = Libis::Tools::TempFile.name('abc')
+      expect(File.basename(fname)).to match(/^abc_\d{8}_\d+_\w+$/)
+    end
+
+    it 'with suffix' do
+      fname = Libis::Tools::TempFile.name(nil, '.xyz')
+      expect(File.basename(fname)).to match(/^\d{8}_\d+_\w+\.xyz$/)
+    end
+
+    it 'with prefix and suffix' do
+      fname = Libis::Tools::TempFile.name('abc', '.xyz')
+      expect(File.basename(fname)).to match(/^abc_\d{8}_\d+_\w+\.xyz$/)
+    end
+
+    it 'not in temp dir' do
+      fname = Libis::Tools::TempFile.name(nil, nil, '/abc/xyz/')
+      expect(File.dirname(fname)).to match('/abc/xyz')
+    end
+
+  end
+
+  context 'file' do
+
+    it 'created' do
+      f = Libis::Tools::TempFile.file
+      expect(File.exists?(f.path)).to be_truthy
+      f.close
+      f.delete
+    end
+
+    it 'is open' do
+      f = Libis::Tools::TempFile.file
+      expect(f.closed?).to be_falsey
+      f.close
+      f.delete
+    end
+
+    it 'can be closed' do
+      f = Libis::Tools::TempFile.file
+      expect(f.closed?).to be_falsey
+      f.close
+      expect(f.closed?).to be_truthy
+      f.delete
+    end
+
+    it 'can be unlinked' do
+      f = Libis::Tools::TempFile.file
+      f.close
+      f.unlink
+      expect(File.exists?(f.path)).to be_falsey
+    end
+
+    it 'can be deleted' do
+      f = Libis::Tools::TempFile.file
+      f.close
+      f.delete
+      expect(File.exists?(f.path)).to be_falsey
+    end
+
+  end
+
+end

data/spec/thread_safe_spec.rb

@@ -0,0 +1,64 @@
+require_relative 'spec_helper'
+require 'awesome_print'
+require 'libis/tools/thread_safe'
+
+describe 'ThreadSafe' do
+
+  class Foo
+    include Libis::Tools::ThreadSafe
+
+    def self.bar
+      self.class_mutex.synchronize {
+        @bar ||= get_number
+      }
+    end
+
+    def self.get_number
+      nr = rand(1000000)
+      sleep 1
+      nr
+    end
+  end
+
+  it 'protects class variable' do
+    mutex = Monitor.new
+    result = []
+    1000.times.map do
+      Thread.new do
+        a = Foo.bar
+        mutex.synchronize {result << a}
+      end
+    end.each(&:join)
+    result.uniq!
+    # ap result
+    expect(result.size).to be 1
+  end
+
+  class Bar
+
+    def self.bar
+      @bar ||= get_number
+    end
+
+    def self.get_number
+      nr = rand(1000000)
+      sleep 1
+      nr
+    end
+  end
+
+  it 'without not thread safe' do
+    mutex = Monitor.new
+    result = []
+    1000.times.map do
+      Thread.new do
+        a = Bar.bar
+        mutex.synchronize {result << a}
+      end
+    end.each(&:join)
+    result.uniq!
+    # ap result
+    expect(result.size).not_to be 1
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libis-tools
 version: !ruby/object:Gem::Version
-  version: 0.9.56
+  version: 0.9.57
 platform: ruby
 authors:
 - Kris Dekeyser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-09 00:00:00.000000000 Z
+date: 2017-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
@@ -320,6 +320,7 @@ files:
 - lib/libis/tools/mets_objects.rb
 - lib/libis/tools/parameter.rb
 - lib/libis/tools/spreadsheet.rb
+- lib/libis/tools/temp_file.rb
 - lib/libis/tools/thread_safe.rb
 - lib/libis/tools/version.rb
 - lib/libis/tools/xml_document.rb
@@ -358,7 +359,9 @@ files:
 - spec/parameter_spec.rb
 - spec/spec_helper.rb
 - spec/spreadsheet_spec.rb
+- spec/temp_file_spec.rb
 - spec/test.xsd
+- spec/thread_safe_spec.rb
 - spec/xmldocument_spec.rb
 - test.rb
 - test/test_helper.rb
@@ -423,7 +426,9 @@ test_files:
 - spec/parameter_spec.rb
 - spec/spec_helper.rb
 - spec/spreadsheet_spec.rb
+- spec/temp_file_spec.rb
 - spec/test.xsd
+- spec/thread_safe_spec.rb
 - spec/xmldocument_spec.rb
 - test/test_helper.rb
 - test/webservices/test_ca_item_info.rb