mechanize-progressbar 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+  gem 'mechanize', '>= 1.0.0'
+  gem 'progressbar', '>= 0.9.0'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+
+  gem 'webmock', '>= 0'
+end

data/LICENSE.txt

@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                       51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/README.rdoc

@@ -0,0 +1,109 @@
+= mechanize-progressbar
+
+Mechanize-Progressbar provides ProgressBar when you use Mechanize#get.
+HTTP response only. HTTP requests are not supported.
+Mechanize-Progressbar sets proc object to Mechanize#pre_connect_hooks.
+
+== you can do
+
+    require 'mechanize'
+    require 'mechanize/progressbar'
+    agent = Mechanize.new
+    agent.progressbar{ agent.get(large_file) }
+    
+    http://host/large_file.zip
+    15% |ooooooo                        | 135.2KB  21.9KB/s ETA:  00:00:10
+
+== Requirements
+
+- Ruby 1.8.6 or later
+- recent Rubygems
+- Mechanize gem
+- ProgressBar gem
+
+== USAGE
+
+Get file in Mechanize#progressbar block.
+
+    require 'mechanize'
+    require 'mechanize/progressbar'
+    agent = Mechanize.new
+    agent.progressbar{ agent.get(large_file) }
+
+Link#click also works.
+
+    agent = Mechanize.new
+    agent.get(some_page)
+    agent.progressbar do
+      agent.page.link_with(:text => 'download here').click
+    end
+
+If you want to modify ProgressBar object, set options.
+
+    pbar = ProgressBar.new(title, total, out)
+    pbar.format = format
+    pbar.format_arguments = format_arguments
+
+is
+
+    agent = Mechanize.new
+    agent.progressbar(
+      :title => title,
+      :total => total,
+      :out => out,
+      :format => format,
+      :format_arguments => format_arguments
+    ){ agent.get(large_file) }
+
+Mechanize-Progressbar prints the URL to $stderr before progressbar.
+
+    agent.progressbar{ agent.get(large_file) }
+    
+    http://uri.host/large_file.zip
+    15% |ooooo                           | 135.2KB  21.9KB/s ETA:  00:00:10
+
+If you do not want the "two-line mode", set (:single => true).
+
+    agent.progressbar(:single => true){ agent.get(large_file) }
+    
+    uri.host:   15% |ooo                 | 135.2KB  21.9KB/s ETA:  00:00:10
+
+When you use Mechanize Logger and same output(i.e, agent.log=Logger.new($stdout)),
+set (:suppress_logger => true).
+
+    agent.log = Logger.new($stdout)
+    agent.progressbar{ agent.get(large_file) }
+    
+    http://uri.host/large_file.zip
+    D, [...] DEBUG -- : Read 1000 bytes
+    10% |ooo                             | 100.2KB  21.9KB/s ETA:  00:00:11
+    D, [...] DEBUG -- : Read 2000 bytes
+    15% |ooooo                           | 200.1KB  21.9KB/s ETA:  00:00:08
+    ...
+
+    agent.log = Logger.new($stdout)
+    agent.progressbar(:suppress_logger => true){ agent.get(large_file) }
+    
+    http://uri.host/large_file.zip
+    100% |ooooooooooooooooooooooooooooooo| 1024.0KB  21.9KB/s Time:  00:00:20
+    D, [...] DEBUG -- : Read 102400 bytes
+
+LARGE FILE DOWNLOAD NOTE:
+Mechanize keeps all the got files as String object.
+When you get the five 100MB files, Mechanize uses at least 500MB memory.
+
+If you wish to run Mechanize with minimum memory usage, try
+    agent.max_history = 1
+
+
+== Licence
+
+GNU GENERAL PUBLIC LICENSE Version 2
+
+alike Mechanize.
+
+== Author
+
+kitamomonga
+kitamomonga@gmail.com
+http://d.hatena.ne.jp/kitamomonga/ (Japanese)

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "mechanize-progressbar"
+  gem.homepage = "http://github.com/kitamomonga/mechanize-progressbar"
+  gem.license = "GPL-2"
+  gem.summary = "Mechanize-Progressbar provides ProgressBar for Mechanize#get and Link#click. requires 'progressbar' gem."
+  gem.description = "Mechanize-Progressbar shows ProgressBar when HTTP GET access of Mechanize(Mechanize#get, Page::Link#click, response of Form#submit). It requires 'progressbar' gem. HTTP POST is not supported."
+  gem.email = "kitamomonga@gmail.com"
+  gem.authors = ["kitamomonga"]
+  # See ./Gemfile
+  # gem.add_runtime_dependency 'mechanize', '>= 1.0.0'
+  # gem.add_runtime_dependency 'progressbar', '>= 0.9.0'
+  # gem.add_development_dependency 'rspec', '> 1.2.3'
+  # gem.add_development_dependency 'webmock', '> 1.6.1'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mechanize-progressbar #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/mechanize/progressbar.rb

@@ -0,0 +1,2 @@
+require 'progressbar'
+require 'mechanize/progressbar/mech_progressbar'

data/lib/mechanize/progressbar/mech_progressbar.rb

@@ -0,0 +1,149 @@
+module MechanizeProgressBarAPI
+  ### Usage:
+  ###   require 'mechanize'
+  ###   require 'mechanize/progressbar'
+  ###   agent = Mechanize.new
+  ###   agent.progressbar{ agent.get(large_file) }
+  ###   agent.get(some_page)
+  ###   agent.progressbar{ agent.page.link_with(:text => 'download here').click }
+  ###
+  ### If you want to set parameters to ProgressBar object,
+  ###   agent.progressbar(:title => 'large_file', :format_arguments => @fmt) do
+  ###     agent.get(large_file)
+  ###   end
+  ### ProgressBar is gem lib. Please install with 'gem install progressbar'.
+  ###
+  ### options:
+  ### [:single] enables single line mode, original ProgressBar gem behavior. default is false
+  ### [:title] ProgressBar.new(*title*, total, out), default is empty
+  ### [:total] ProgressBar.new(title, *total*, out), default is 'Content-Length' response header
+  ### [:out] ProgressBar.new(title, total, *out*), default is $stderr
+  ### [:format] ProgressBar.new(*args).format=*format*, default is nil
+  ### [:format_arguments]  ProgressBar.new(*args).format_arguments=*format_arguments*, default is nil
+  ### [:reversed] ReversedProgressBar.new(*args), default is false
+  ### [:file_transfer_mode] enables ProgressBar#file_transfer_mode, default is true
+  ### [:suppress_logger] makes Logger's output and Progressbar's output independent
+  def progressbar(agent_or_pbar_opts = self, pbar_opts = {})
+    if agent_or_pbar_opts.kind_of?(Hash) then
+      agent, pbar_opts = self, agent_or_pbar_opts
+    else
+      agent = agent_or_pbar_opts
+    end
+    MechanizeProgressBar.register(agent, pbar_opts)
+    if block_given?
+      begin
+        yield agent
+      rescue Exception, Mechanize::ResponseCodeError
+        MechanizeProgressBar.unregister(agent)
+        raise
+      end
+      MechanizeProgressBar.unregister(agent)
+    else
+      MechanizeProgressBar.reserve_pseudo_unregisteration(agent)
+    end
+    agent
+  end
+end
+
+module MechanizeProgressBar
+  def self.pbar_hooks ; @pbar_hooks ||= []; end
+  def self.default_out ; @default_out ||= $stderr; end
+  def self.default_out=(out); @default_out = out; end
+
+  def self.build(chain_params)
+    pbar_opts = chain_params[:progressbar]
+
+    out = pbar_opts[:out] || pbar_opts[:output] || self.default_out
+    if pbar_opts[:single] then
+      title = pbar_opts[:title] || chain_params[:uri].host
+      format = pbar_opts[:format]
+      format_arguments = pbar_opts[:format_arguments]
+    else
+      title = pbar_opts[:title] || ""
+      format = pbar_opts[:format] || "%3d%% %s %s"
+      format_arguments = pbar_opts[:format_arguments] || [:percentage, :bar, :stat_for_file_transfer]
+      out.print "#{pbar_opts[:title]||chain_params[:uri]}\n"
+    end
+    total = pbar_opts[:total] || filesize(chain_params)
+    pbar_class = pbar_opts[:reversed] ? ReversedProgressBar : ProgressBar
+
+    progressbar = pbar_class.new(title, total, out)
+    progressbar.file_transfer_mode unless pbar_opts[:file_transfer_mode]
+    progressbar.format = format if format
+    progressbar.format_arguments = format_arguments if format_arguments
+    return progressbar
+  end
+
+  def self.filesize(chain_params)
+    content_length = chain_params[:response]['content-length']
+    content_length ? content_length.to_i : 0
+  end
+
+  def self.register(agent, pbar_opts)
+    pre_hook = lambda{|options| options[:progressbar] = pbar_opts}
+    self.pbar_hooks << pre_hook
+    agent.pre_connect_hooks << pre_hook
+  end
+
+  def self.unregister(agent)
+    agent.pre_connect_hooks.each do |pr|
+      agent.pre_connect_hooks.delete_if{ self.pbar_hooks.delete(pr)}
+    end
+  end
+
+  def self.reserve_pseudo_unregisteration(agent)
+    agent.post_connect_hooks << lambda{|options|
+      MechanizeProgressBar.unregister(agent) if options[:agent] && options[:progressbar]
+    }
+  end
+
+  def self.http_ok?(params)
+    params[:progressbar] && params[:response].code == '200'
+  end
+
+  def self.suppress_logger?(params)
+    params[:progressbar] && params[:progressbar][:suppress_logger]
+  end
+end
+
+
+
+class Mechanize   # has 6 added/modified lines
+  include MechanizeProgressBarAPI # (1of6)a
+  class Chain
+    class ResponseReader
+      def handle(ctx, params)
+        params[:response] = @response
+        body = StringIO.new
+        total = 0
+        pbar = MechanizeProgressBar.build(params) if MechanizeProgressBar.http_ok?(params) # (2of6)a
+        @response.read_body { |part|
+          total += part.length
+          body.write(part)
+#         Mechanize.log.debug("Read #{total} bytes") if Mechanize.log
+          Mechanize.log.debug("Read #{total} bytes") if Mechanize.log && !MechanizeProgressBar.suppress_logger?(params) # (3of6)m
+          pbar.inc(part.length) if MechanizeProgressBar.http_ok?(params) # (4of6)a
+        }
+        body.rewind
+        pbar.finish if MechanizeProgressBar.http_ok?(params) # (5of6)a
+        Mechanize.log.debug("Read #{total} bytes") if Mechanize.log && MechanizeProgressBar.suppress_logger?(params) # (6of6)a
+
+        res_klass = Net::HTTPResponse::CODE_TO_OBJ[@response.code.to_s]
+        raise ResponseCodeError.new(@response) unless res_klass
+
+        # Net::HTTP ignores EOFError if Content-length is given, so we emulate it here.
+        unless res_klass <= Net::HTTPRedirection
+          raise EOFError if (!params[:request].is_a?(Net::HTTP::Head)) && @response.content_length() && @response.content_length() != total
+        end
+
+        @response.each_header { |k,v|
+          Mechanize.log.debug("response-header: #{ k } => #{ v }")
+        } if Mechanize.log
+
+        params[:response_body] = body
+        params[:res_klass] = res_klass
+        super
+      end
+    end
+  end
+end

data/spec/mechanize/progressbar/mech_progressbar_spec.rb

@@ -0,0 +1,192 @@
+require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
+
+### NOTE: On MechanizeProgressBarAPI - "accepts agent as agent" spec, we swap $stderr.
+
+describe MechanizeProgressBarAPI do
+
+  before :all do
+    @url = 'http://uri.host/uri.path'
+    @headers_and_body = {
+      :headers => {'Content-Length' => 1000},
+      :body => 'a'*1000
+    }
+  end
+
+  before :each do
+    WebMock.stub_request(:get, @url).to_return(@headers_and_body)
+  end
+
+  describe "#progressbar" do
+
+    def progressbar
+      @output.string
+    end
+
+    RSpec::Matchers.define :work_fine do
+      match do |actual|
+        /oooooooo+/ =~ actual
+      end
+    end
+
+    before :each do
+      @agent = Mechanize.new
+      @output = StringIO.new
+    end
+    it "accepts Hash as ProgressBar option" do
+      @agent.progressbar(:out => @output){@agent.get(@url)}
+      progressbar.should work_fine
+    end
+
+    it "accepts agent as agent" do
+      o = Object.new
+      o.extend(MechanizeProgressBarAPI)
+      backup = $stderr
+      $stderr = @output
+      o.progressbar(@agent){@agent.get(@url)}
+      $stderr = backup
+      progressbar.should work_fine
+    end
+
+    it "accepts (agent, pbar_opt) arguments" do
+      o = Object.new
+      o.extend(MechanizeProgressBarAPI)
+      o.progressbar(@agent, :out => @output){@agent.get(@url)}
+      progressbar.should work_fine
+    end
+
+    it "with block" do
+      @agent.progressbar(:out => @output){@agent.get(@url)}
+      progressbar.should work_fine
+      @agent.pre_connect_hooks.should be_empty
+      @agent.post_connect_hooks.should be_empty
+    end
+
+    it "method chain leaves a proc on post_connect_hooks" do
+      @agent.progressbar(:out => @output).get(@url)
+      progressbar.should work_fine
+      @agent.pre_connect_hooks.should be_empty
+      @agent.post_connect_hooks.should_not be_empty
+    end
+
+    it "default ProgressBar title is uri.host" do
+      @agent.progressbar(:out => @output){@agent.get(@url)}
+      progressbar.should work_fine
+      progressbar.should match(/uri.host/)
+    end
+
+    it "agent.progressbar(:title => 'new title') changes title" do
+      new_title = 'new title'
+      @agent.progressbar(:title => new_title, :out => @output){@agent.get(@url)}
+      progressbar.should work_fine
+      progressbar.should match(/#{new_title}/)
+    end
+
+    it "single mode title is 13 bytes" do
+      str15 = '123456789012345'
+      @agent.progressbar(:title => str15, :out => @output, :single => true){@agent.get(@url)}
+      progressbar.should match(/1234567890123:/)
+    end
+
+    it "default ProgressBar total is response['content-length']" do
+      @agent.progressbar(:out => @output){@agent.get(@url)}
+      progressbar.should work_fine
+      progressbar.should match(/1000B/)
+    end
+
+    it "agent.progressbar(:total => 999) changes total filesize" do
+      # TODO:
+      @agent.progressbar(:total => 999, :out => @output){
+        lambda{@agent.get(@url)}.should_not raise_error
+      }
+      progressbar.should work_fine
+      progressbar.should match(/999B/)
+    end
+
+    it "default ProgressBar out is $stderr" do
+      # TODO:
+    end
+
+    it "agent.progressbar(:out => io) changes output to io object" do
+      @agent.progressbar(:out => @output){
+        lambda{@agent.get(@url)}.should_not raise_error
+      }
+      progressbar.should work_fine
+    end
+
+    it "agent.progressbar(:format => fmtstr) changes output format" do
+      fmt = "%-14s!%3d%% %s %s"
+      str15 = '123456789012345'
+      @agent.progressbar(:title => str15, :format => fmt, :out => @output, :single => true){@agent.get(@url)}
+      progressbar.should match(/1234567890123:!/)
+    end
+
+    it "agent.progressbar(:format_arguments => fmtarg) changes bar view" do
+      stat = "uri.host:      100% |oooooooooooooooooooooooooooooooooooooooooo| Time: 00:00:00"
+      @agent.progressbar(:out => @output, :single => true){@agent.get(@url)}
+      progressbar.should_not be_include(stat)
+
+      fmtarg = [:title, :percentage, :bar, :stat]
+      @agent.progressbar(:format_arguments => fmtarg, :out => @output, :single => true){@agent.get(@url)}
+      progressbar.should be_include(stat)
+    end
+
+    it "when HTTP status error occurs in Mechanize, rescue unregister" do
+      url_404 = 'http://host/404'
+      WebMock.stub_request(:get, url_404).to_return(:status => ['404', 'Not Found'])
+      lambda{
+        @agent.progressbar(:output => @output) do
+          @agent.pre_connect_hooks[0].should be_kind_of(Proc)
+          @agent.get(url_404)
+        end
+      }.should raise_error(Mechanize::ResponseCodeError)
+      @agent.pre_connect_hooks.should be_empty
+      progressbar.should be_empty
+    end
+
+    it "when Exception occurs in Mechanize, rescue unregister" do
+      WebMock.stub_request(:get, @url).to_timeout
+      @agent.progressbar(:output => @output) do
+        @agent.pre_connect_hooks[0].should be_kind_of(Proc)
+        lambda{@agent.get(@url)}.should raise_error(Timeout::Error)
+      end
+      @agent.pre_connect_hooks.should be_empty
+      progressbar.should be_empty
+    end
+
+    it "Mechanize Logger output to $stderr crashes ProgressBar" do
+      require 'logger'
+      out = StringIO.new
+      @agent.log = Logger.new(out)
+      @agent.progressbar(:output => out){@agent.get(@url)}
+
+      # matches:
+      ### http://uri.host/uri.path
+      ### D, [(date+time)] DEBUG -- : Read 1000 bytes ETA:  --:--:--
+      ### 100% |ooooooooooooooooooooooooooooooooooooooo|   1000B nnn.nKB/s Time: 00:00:00
+      re = /http:\/\/uri\.host\/uri\.path\s+D, \[.+?\] DEBUG -- : Read 1000 bytes\s+100% |o+|\s+1000B/
+      out.string.should match(re)
+    end
+
+    it "(:suppress_logger => true) make ProgressBar and Mechanize Logger output independent" do
+      require 'logger'
+      out = StringIO.new
+      @agent.log = Logger.new(out)
+      @agent.progressbar(:output => out, :suppress_logger => true){@agent.get(@url)}
+
+      # matches:
+      ### request-header: keep-alive => 300\n
+      ### http://uri.host/uri.path
+      before_progressbar = /request-header: (.+?) => (.+?)\s+http:\/\/uri\.host\/uri\.path/
+      out.string.should match(before_progressbar)
+
+      # matches:
+      ### 100% |ooooooooooooooooooooooooooooooooooooooo|   1000B 151.5KB/s Time: 00:00:00
+      ### D, [(date+time)] DEBUG -- : Read 1000 bytes
+      after_progressbar = /100%\s*\|o+\|\s+1000B (.+?)B\/s Time: \d\d:\d\d:\d\d\s+D, \[.+?\] DEBUG -- : Read 1000 bytes/
+      out.string.should match(after_progressbar)
+    end
+
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  require 'mechanize'
+  require 'webmock'
+  require 'mechanize/progressbar'
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification 
+name: mechanize-progressbar
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- kitamomonga
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-07 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: mechanize
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id001
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: progressbar
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 9
+        - 0
+        version: 0.9.0
+  requirement: *id002
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rspec
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id004
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id005
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: webmock
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+  type: :development
+description: Mechanize-Progressbar shows ProgressBar when HTTP GET access of Mechanize(Mechanize#get, Page::Link#click, response of Form#submit). It requires 'progressbar' gem. HTTP POST is not supported.
+email: kitamomonga@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mechanize/progressbar.rb
+- lib/mechanize/progressbar/mech_progressbar.rb
+- spec/mechanize/progressbar/mech_progressbar_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kitamomonga/mechanize-progressbar
+licenses: 
+- GPL-2
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Mechanize-Progressbar provides ProgressBar for Mechanize#get and Link#click. requires 'progressbar' gem.
+test_files: 
+- spec/mechanize/progressbar/mech_progressbar_spec.rb
+- spec/spec_helper.rb