Change to rename formatter format method to call

README.md

@@ -614,16 +614,16 @@ class TimeFormatter
 end
 ```
 
-Next, add `format` method that will substitute the matched token with an actual value. For example, to see the time elapsed since the start do:
+Next, add `call` method that will substitute the matched token with an actual value. For example, to see the time elapsed since the start do:
 
 ```ruby
 class TimeFormatter
   include TTY::ProgressBar::Formatter[/:time/i]
 
-  def format(value)  # specify how display string is formatted
+  def call(value)  # specify how display string is formatted
     # access current progress bar instance to read start time
-    transformed = (Time.now - @progress.start_at).to_s
-    value.gsub(/:time/, transformed)   # replace :time token with a value
+    transformed = (Time.now - progress.start_at).to_s
+    value.gsub(matcher, transformed)   # replace :time token with a value
   end
 end
 ```

lib/tty/progressbar/formatter/bar.rb

@@ -16,7 +16,7 @@ class BarFormatter
       #  the value being formatted
       #
       # @api public
-      def format(value)
+      def call(value)
         without_bar = value.gsub(/:bar/, "")
         available_space = [0, ProgressBar.max_columns -
                               ProgressBar.display_columns(without_bar) -

lib/tty/progressbar/formatter/byte_rate.rb

@@ -17,7 +17,7 @@ class ByteRateFormatter
       #  the value to format
       #
       # @api public
-      def format(value)
+      def call(value)
         formatted = Converter.to_bytes(@progress.rate)
         value.gsub(matcher, formatted)
       end

lib/tty/progressbar/formatter/current.rb

@@ -14,7 +14,7 @@ class CurrentFormatter
       #  the value to format
       #
       # @api public
-      def format(value)
+      def call(value)
         value.gsub(matcher, @progress.current.to_s)
       end
     end # CurrentFormatter

lib/tty/progressbar/formatter/current_byte.rb

@@ -17,7 +17,7 @@ class ByteFormatter
       #  the value to format
       #
       # @api public
-      def format(value)
+      def call(value)
         bytes = Converter.to_bytes(@progress.current)
         value.gsub(matcher, bytes)
       end

lib/tty/progressbar/formatter/elapsed.rb

@@ -17,7 +17,7 @@ class ElapsedFormatter
       #  the value to format
       #
       # @api public
-      def format(value)
+      def call(value)
         elapsed = (Time.now - @progress.start_at)
         value.gsub(matcher, Converter.to_time(elapsed))
       end

lib/tty/progressbar/formatter/estimated.rb

@@ -17,7 +17,7 @@ class EstimatedFormatter
       #  the value to format
       #
       # @api public
-      def format(value)
+      def call(value)
         if @progress.indeterminate?
           return value.gsub(matcher, "--s")
         end

lib/tty/progressbar/formatter/estimated_time.rb

@@ -14,7 +14,7 @@ class EstimatedTimeFormatter
       #   the value to format
       #
       # @api public
-      def format(value)
+      def call(value)
         if @progress.indeterminate?
           return value.gsub(matcher, "--:--:--")
         end

lib/tty/progressbar/formatter/mean_byte.rb

@@ -17,7 +17,7 @@ class MeanByteFormatter
       #  the value being formatted
       #
       # @api public
-      def format(value)
+      def call(value)
         formatted = Converter.to_bytes(@progress.mean_rate)
         value.gsub(matcher, formatted)
       end

lib/tty/progressbar/formatter/mean_rate.rb

@@ -17,7 +17,7 @@ class MeanRateFormatter
       #  the value being formatted
       #
       # @api public
-      def format(value)
+      def call(value)
         formatted = Converter.to_seconds(@progress.mean_rate)
         value.gsub(matcher, formatted)
       end

lib/tty/progressbar/formatter/percent.rb

@@ -16,7 +16,7 @@ class PercentFormatter
       #  the value to format
       #
       # @api public
-      def format(value)
+      def call(value)
         percent = @progress.width == 0 ? 100 : (@progress.ratio * 100).to_i
         display = @progress.indeterminate? ? "-" : percent.to_s
         value.gsub(matcher, "#{display}%")

lib/tty/progressbar/formatter/rate.rb

@@ -17,7 +17,7 @@ class RateFormatter
       #  the value being formatted
       #
       # @api public
-      def format(value)
+      def call(value)
         formatted = Converter.to_seconds(@progress.rate)
         value.gsub(matcher, formatted)
       end

lib/tty/progressbar/formatter/total.rb

@@ -16,7 +16,7 @@ class TotalFormatter
       #  the value to format
       #
       # @api public
-      def format(value)
+      def call(value)
         display = @progress.indeterminate? ? "-" : @progress.total.to_s
         value.gsub(matcher, display)
       end

lib/tty/progressbar/formatter/total_byte.rb

@@ -17,7 +17,7 @@ class TotalByteFormatter
       #  the value to format
       #
       # @api public
-      def format(value)
+      def call(value)
         bytes = if @progress.indeterminate?
                   "-B"
                 else

lib/tty/progressbar/pipeline.rb

@@ -41,7 +41,7 @@ def decorate(tokenized)
         base = tokenized.dup
         formatters.inject(base) do |formatted, formatter|
           if formatter.respond_to?(:matches?) && formatter.matches?(formatted)
-            formatter.format(formatted)
+            formatter.(formatted)
           else
             formatted
           end

spec/unit/custom_formatter_spec.rb

@@ -15,7 +15,7 @@ def matches?(value)
         value.to_s =~ /:hi/
       end
 
-      def format(value)
+      def call(value)
         value.gsub(/:hi/, "Hello")
       end
     end)