zold 0.15.0 → 0.16.0

data/lib/zold/node/nodup_entrance.rb

@@ -54,13 +54,13 @@ module Zold
       raise 'Id can\'t be nil' if id.nil?
       raise 'Id must be of type Id' unless id.is_a?(Id)
       raise 'Body can\'t be nil' if body.nil?
-      Tempfile.open(['', Wallet::EXTENSION]) do |f|
-        File.write(f, body)
+      Tempfile.open(['', Wallet::EXT]) do |f|
+        IO.write(f, body)
         wallet = Wallet.new(f.path)
         wallet.refurbish
-        after = File.read(wallet.path)
+        after = IO.read(wallet.path)
         before = @wallets.find(id) do |w|
-          w.exists? ? File.read(w.path).to_s : ''
+          w.exists? ? IO.read(w.path).to_s : ''
         end
         if before == after
           @log.info(

data/lib/zold/node/safe_entrance.rb

@@ -58,8 +58,8 @@ module Zold
       raise 'Id can\'t be nil' if id.nil?
       raise 'Id must be of type Id' unless id.is_a?(Id)
       raise 'Body can\'t be nil' if body.nil?
-      Tempfile.open(['', Wallet::EXTENSION]) do |f|
-        File.write(f, body)
+      Tempfile.open(['', Wallet::EXT]) do |f|
+        IO.write(f, body)
         wallet = Wallet.new(f.path)
         wallet.refurbish
         unless wallet.protocol == Zold::PROTOCOL

data/lib/zold/node/spread_entrance.rb

@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 require 'concurrent'
+require 'concurrent/set'
 require 'tempfile'
 require_relative 'emission'
 require_relative '../log'
@@ -40,17 +41,10 @@ module Zold
   # The entrance
   class SpreadEntrance
     def initialize(entrance, wallets, remotes, address, log: Log::Quiet.new, ignore_score_weakeness: false)
-      raise 'Entrance can\'t be nil' if entrance.nil?
       @entrance = entrance
-      raise 'Wallets can\'t be nil' if wallets.nil?
-      raise 'Wallets must implement the contract of Wallets: method #find is required' unless wallets.respond_to?(:find)
       @wallets = wallets
-      raise 'Remotes can\'t be nil' if remotes.nil?
-      raise 'Remotes must be of type Remotes' unless remotes.is_a?(Remotes)
       @remotes = remotes
-      raise 'Address can\'t be nil' if address.nil?
       @address = address
-      raise 'Log can\'t be nil' if log.nil?
       @log = log
       @ignore_score_weakeness = ignore_score_weakeness
     end
@@ -64,7 +58,7 @@ module Zold
 
     def start
       @entrance.start do
-        @seen = Set.new
+        @seen = Concurrent::Set.new
         @modified = Queue.new
         @push = Thread.start do
           Thread.current.abort_on_exception = true
@@ -95,13 +89,15 @@ module Zold
       end
     end
 
+    # This method is thread-safe
     def push(id, body)
       mods = @entrance.push(id, body)
+      return mods if @remotes.all.empty?
       (mods + [id]).each do |m|
         next if @seen.include?(m)
         @seen << m
         @modified.push(m)
-        @log.debug("Push scheduled for #{m}, queue size is #{@modified.size}")
+        @log.debug("Spread-push scheduled for #{m}, queue size is #{@modified.size}")
       end
       mods
     end

data/lib/zold/node/sync_entrance.rb

@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 require 'concurrent'
+require 'futex'
 require_relative '../log'
 require_relative '../id'
 require_relative '../verbose_thread'
@@ -33,12 +34,9 @@ module Zold
   # The entrance that makes sure only one thread works with a wallet
   class SyncEntrance
     def initialize(entrance, dir, timeout: 30, log: Log::Quiet.new)
-      raise 'Entrance can\'t be nil' if entrance.nil?
       @entrance = entrance
-      raise 'Dir can\'t be nil' if dir.nil?
       @dir = dir
       @timeout = timeout
-      raise 'Log can\'t be nil' if log.nil?
       @log = log
     end
 
@@ -54,26 +52,7 @@ module Zold
 
     # Always returns an array with a single ID of the pushed wallet
     def push(id, body)
-      f = File.join(@dir, "#{id}.lock")
-      FileUtils.mkdir_p(File.dirname(f))
-      File.open(f, File::RDWR | File::CREAT) do |lock|
-        start = Time.now
-        cycles = 0
-        loop do
-          break if lock.flock(File::LOCK_EX | File::LOCK_NB)
-          sleep 0.1
-          cycles += 1
-          delay = Time.now - start
-          if delay > @timeout
-            raise "##{Process.pid}/#{Thread.current.name} can't get exclusive access to the wallet #{id}/e \
-because of the lock at #{lock.path}: #{File.read(lock)}"
-          end
-          if (cycles % 20).zero? && delay > 10
-            @log.info("##{Process.pid}/#{Thread.current.name} still waiting for \
-exclusive access to #{id}/e, #{delay.round}s already")
-          end
-        end
-        File.write(lock, "##{Process.pid}/#{Thread.current.name}/#{Time.now.utc.iso8601}")
+      Futex.new(File.join(@dir, id), log: @log).open do
         @entrance.push(id, body)
       end
     end

data/lib/zold/patch.rb

@@ -119,7 +119,7 @@ among #{payer.txns.count} transactions: #{txn.to_text}")
     def save(file, overwrite: false)
       raise 'You have to join at least one wallet in' if @id.nil?
       before = ''
-      before = File.read(file) if File.exist?(file)
+      before = IO.read(file) if File.exist?(file)
       wallet = Wallet.new(file)
       wallet.init(@id, @key, overwrite: overwrite, network: @network)
       File.open(file, 'a') do |f|
@@ -128,7 +128,7 @@ among #{payer.txns.count} transactions: #{txn.to_text}")
         end
       end
       wallet.refurbish
-      after = File.read(file)
+      after = IO.read(file)
       before != after
     end
   end

data/lib/zold/remotes.rb

@@ -25,6 +25,7 @@ require 'csv'
 require 'uri'
 require 'net/http'
 require 'time'
+require 'futex'
 require 'fileutils'
 require 'backtrace'
 require_relative 'age'
@@ -52,10 +53,13 @@ module Zold
     attribute :file, Types::Strict::String
     attribute :network, Types::Strict::String.optional.default('test')
     attribute :timeout, Types::Strict::Integer.optional.default(16)
-    attribute :mutex, Types::Object.optional.default(Mutex.new)
 
     # Empty, for standalone mode
-    class Empty < Remotes
+    class Empty
+      def initialize
+        # Nothing to init here
+      end
+
       def all
         []
       end
@@ -131,7 +135,7 @@ module Zold
     end
 
     def defaults
-      other = Remotes.new(file: File.join(File.dirname(__FILE__), '../../resources/remotes'))
+      other = Remotes.new(file: File.expand_path(File.join(File.dirname(__FILE__), '../../resources/remotes')))
       other.all.each do |r|
         add(r[:host], r[:port])
       end
@@ -220,13 +224,13 @@ module Zold
     end
 
     def mtime
-      File.mtime(file)
+      File.exist?(file) ? File.mtime(file) : Time.now
     end
 
     private
 
     def modify
-      mutex.synchronize do
+      Futex.new(file).open do
         save(yield(load))
       end
     end
@@ -261,7 +265,7 @@ module Zold
 
     def save(list)
       FileUtils.mkdir_p(File.dirname(file))
-      File.write(
+      IO.write(
         file,
         list.uniq { |r| "#{r[:host]}:#{r[:port]}" }.map do |r|
           [

data/lib/zold/sync_wallets.rb

@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require 'futex'
 require_relative 'log'
 
 # Sync collection of wallets.
@@ -29,9 +30,8 @@ require_relative 'log'
 module Zold
   # Synchronized collection of wallets
   class SyncWallets
-    def initialize(wallets, dir = Dir.tmpdir, timeout: 30, log: Log::Quiet.new)
+    def initialize(wallets, timeout: 30, log: Log::Quiet.new)
       @wallets = wallets
-      @dir = dir
       @log = log
       @timeout = timeout
     end
@@ -50,26 +50,7 @@ module Zold
 
     def find(id)
       @wallets.find(id) do |wallet|
-        f = File.join(@dir, id)
-        FileUtils.mkdir_p(File.dirname(f))
-        File.open(f, File::RDWR | File::CREAT) do |lock|
-          start = Time.now
-          cycles = 0
-          loop do
-            break if lock.flock(File::LOCK_EX | File::LOCK_NB)
-            sleep 0.1
-            cycles += 1
-            delay = (Time.now - start).round(2)
-            if delay > @timeout
-              raise "##{Process.pid}/#{Thread.current.name} can't get exclusive access to the wallet #{id} \
-because of the lock at #{lock.path}, after #{delay}s of waiting: #{File.read(lock)}"
-            end
-            if (cycles % 20).zero? && delay > 10
-              @log.info("##{Process.pid}/#{Thread.current.name} still waiting for \
-exclusive access to #{id}, #{delay.round}s already: #{File.read(lock)}")
-            end
-          end
-          File.write(lock, "##{Process.pid}/#{Thread.current.name}")
+        Futex.new(wallet.path, log: @log).open do
           yield wallet
         end
       end

data/lib/zold/tree_wallets.rb

@@ -22,6 +22,7 @@
 require 'pathname'
 require_relative 'id'
 require_relative 'wallet'
+require_relative 'dir_items'
 
 # The local collection of wallets.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -45,19 +46,23 @@ module Zold
 
     # Returns the list of their IDs (as plain text)
     def all
-      Dir.glob("#{path}/**/*#{Wallet::EXTENSION}").select do |f|
-        basename = File.basename(f, Wallet::EXTENSION)
-        File.file?(f) &&
-          !File.directory?(f) &&
+      DirItems.new(path).fetch.select do |f|
+        next unless f.end_with?(Wallet::EXT)
+        basename = File.basename(f, Wallet::EXT)
+        file = File.join(path, f)
+        File.file?(file) &&
+          !File.directory?(file) &&
           basename =~ /^[0-9a-fA-F]{16}$/ &&
           Id.new(basename).to_s == basename
-      end.map { |w| Id.new(File.basename(w, Wallet::EXTENSION)) }
+      end.map { |w| Id.new(File.basename(w, Wallet::EXT)) }
     end
 
     def find(id)
       raise 'Id can\'t be nil' if id.nil?
       raise 'Id must be of type Id' unless id.is_a?(Id)
-      yield Zold::Wallet.new(File.join(path, (id.to_s.split('', 5).take(4) + [id.to_s]).join('/')))
+      yield Wallet.new(
+        File.join(path, (id.to_s.split('', 5).take(4) + [id.to_s]).join('/') + Wallet::EXT)
+      )
     end
   end
 end

data/lib/zold/txns.rb

@@ -39,7 +39,7 @@ module Zold
 
     def fetch
       raise "Wallet file '#{@file}' is absent" unless File.exist?(@file)
-      lines = File.read(@file).split(/\n/)
+      lines = IO.read(@file).split(/\n/)
       raise "Not enough lines in #{@file}, just #{lines.count}" if lines.count < 4
       lines.drop(5)
         .each_with_index

data/lib/zold/version.rb

@@ -25,6 +25,6 @@
 # Copyright:: Copyright (c) 2018 Yegor Bugayenko
 # License:: MIT
 module Zold
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
   PROTOCOL = 2
 end

data/lib/zold/wallet.rb

@@ -27,6 +27,7 @@ require_relative 'key'
 require_relative 'id'
 require_relative 'txn'
 require_relative 'tax'
+require_relative 'copies'
 require_relative 'amount'
 require_relative 'hexnum'
 require_relative 'signature'
@@ -50,10 +51,13 @@ module Zold
     MAIN_NETWORK = 'zold'
 
     # The extension of the wallet files
-    EXTENSION = '.z'
+    EXT = '.z'
 
     def initialize(file)
-      @file = File.absolute_path(File.extname(file).empty? ? "#{file}#{EXTENSION}" : file)
+      unless file.end_with?(Wallet::EXT, Copies::EXT)
+        raise "Wallet file must end with #{Wallet::EXT} or #{Copies::EXT}: #{file}"
+      end
+      @file = File.absolute_path(file)
       @txns = Txns::Cached.new(Txns.new(@file))
       @head = Head::Cached.new(Head.new(@file))
     end
@@ -90,7 +94,7 @@ module Zold
       raise "File '#{@file}' already exists" if File.exist?(@file) && !overwrite
       raise "Invalid network name '#{network}'" unless network =~ /^[a-z]{4,16}$/
       FileUtils.mkdir_p(File.dirname(@file))
-      File.write(@file, "#{network}\n#{PROTOCOL}\n#{id}\n#{pubkey.to_pub}\n\n")
+      IO.write(@file, "#{network}\n#{PROTOCOL}\n#{id}\n#{pubkey.to_pub}\n\n")
       @txns.flush
       @head.flush
     end
@@ -173,7 +177,7 @@ module Zold
     end
 
     def digest
-      OpenSSL::Digest::SHA256.new(File.read(@file)).hexdigest
+      OpenSSL::Digest::SHA256.new(IO.read(@file)).hexdigest
     end
 
     # Age of wallet in hours
@@ -187,13 +191,18 @@ module Zold
     end
 
     def refurbish
-      File.write(
+      IO.write(
         @file,
         "#{network}\n#{protocol}\n#{id}\n#{key.to_pub}\n\n#{txns.map { |t| t.to_s + "\n" }.join}"
       )
       @txns.flush
     end
 
+    def flush
+      @head.flush
+      @txns.flush
+    end
+
     private
 
     def max

data/lib/zold/wallets.rb

@@ -22,6 +22,7 @@
 require 'pathname'
 require_relative 'id'
 require_relative 'wallet'
+require_relative 'dir_items'
 
 # The local collection of wallets.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -50,20 +51,20 @@ module Zold
 
     # Returns the list of their IDs (as plain text)
     def all
-      Dir.new(path).select do |f|
+      DirItems.new(path).fetch(recursive: false).select do |f|
         file = File.join(@dir, f)
-        basename = File.basename(f, Wallet::EXTENSION)
+        basename = File.basename(f, Wallet::EXT)
         File.file?(file) &&
           !File.directory?(file) &&
           basename =~ /^[0-9a-fA-F]{16}$/ &&
           Id.new(basename).to_s == basename
-      end.map { |w| Id.new(File.basename(w, Wallet::EXTENSION)) }
+      end.map { |w| Id.new(File.basename(w, Wallet::EXT)) }
     end
 
     def find(id)
       raise 'Id can\'t be nil' if id.nil?
       raise "Id must be of type Id, #{id.class.name} instead" unless id.is_a?(Id)
-      yield Zold::Wallet.new(File.join(path, id.to_s))
+      yield Wallet.new(File.join(path, id.to_s + Wallet::EXT))
     end
   end
 end

data/test/commands/routines/test_spread.rb

@@ -34,7 +34,7 @@ require_relative '../../../lib/zold/node/entrance.rb'
 # License:: MIT
 class TestSpread < Minitest::Test
   def test_spread_wallets
-    FakeHome.new.run do |home|
+    FakeHome.new(log: test_log).run do |home|
       5.times { home.create_wallet }
       opts = {
         'routine-immediately' => true

data/test/commands/test_alias.rb

@@ -11,7 +11,7 @@ class TestAlias < Minitest::Test
   #  The syntax is already documented in the alias command in the help.
   def test_set_writes_alias_to_the_alias_file
     skip
-    FakeHome.new.run do |home|
+    FakeHome.new(log: test_log).run do |home|
       wallet = home.create_wallet
       Zold::Alias.new(wallets: home.wallets, log: test_log).run(%W[set #{wallet.id} my-alias])
       assert_equal read_alias_file(home), %W[my-alias #{wallet.id}]
@@ -23,7 +23,7 @@ class TestAlias < Minitest::Test
   #  The syntax is already documented in the alias command in the help.
   def test_remove_removes_the_alias_from_the_alias_file
     skip
-    FakeHome.new.run do |home|
+    FakeHome.new(log: test_log).run do |home|
       wallet = home.create_wallet
       cmd = Zold::Alias.new(wallets: home.wallets, log: test_log)
       cmd.run(%W[set #{wallet.id} my-alias])
@@ -38,7 +38,7 @@ class TestAlias < Minitest::Test
   #  The syntax is already documented in the alias command in the help.
   def test_show_prints_out_the_aliased_wallet_id
     skip
-    FakeHome.new.run do |home|
+    FakeHome.new(log: test_log).run do |home|
       wallet = home.create_wallet
       cmd = Zold::Alias.new(wallets: home.wallets, log: test_log)
       cmd.run(%W[set #{wallet.id} my-alias])
@@ -51,6 +51,6 @@ class TestAlias < Minitest::Test
   private
 
   def read_alias_file(home)
-    File.read(File.join(home.dir, 'aliases')).split(' ')
+    IO.read(File.join(home.dir, 'aliases')).split(' ')
   end
 end