rspec-tests. many breaking changes.
This commit is contained in:
parent
367e8b6e6b
commit
52f57d4f1f
57
.gitignore
vendored
57
.gitignore
vendored
|
@ -1,49 +1,10 @@
|
|||
# rcov generated
|
||||
coverage
|
||||
coverage.data
|
||||
/.bundle/
|
||||
/.yardoc
|
||||
/_yardoc/
|
||||
/coverage/
|
||||
/doc/
|
||||
/pkg/
|
||||
/spec/reports/
|
||||
/tmp/
|
||||
|
||||
# rdoc generated
|
||||
rdoc
|
||||
|
||||
# yard generated
|
||||
doc
|
||||
.yardoc
|
||||
|
||||
# bundler
|
||||
.bundle
|
||||
|
||||
# jeweler generated
|
||||
pkg
|
||||
|
||||
# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
|
||||
#
|
||||
# * Create a file at ~/.gitignore
|
||||
# * Include files you want ignored
|
||||
# * Run: git config --global core.excludesfile ~/.gitignore
|
||||
#
|
||||
# After doing this, these files will be ignored in all your git projects,
|
||||
# saving you from having to 'pollute' every project you touch with them
|
||||
#
|
||||
# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
|
||||
#
|
||||
# For MacOS:
|
||||
#
|
||||
#.DS_Store
|
||||
|
||||
# For TextMate
|
||||
#*.tmproj
|
||||
#tmtags
|
||||
|
||||
# For emacs:
|
||||
#*~
|
||||
#\#*
|
||||
#.\#*
|
||||
|
||||
# For vim:
|
||||
#*.swp
|
||||
|
||||
# For redcar:
|
||||
#.redcar
|
||||
|
||||
# For rubinius:
|
||||
#*.rbc
|
||||
.*.sw[pq]
|
||||
|
|
15
Gemfile
15
Gemfile
|
@ -1,13 +1,4 @@
|
|||
source "http://rubygems.org"
|
||||
source "https://rubygems.org"
|
||||
|
||||
gem 'ruby-dbus'
|
||||
|
||||
# Add dependencies to develop your gem here.
|
||||
# Include everything needed to run rake, tests, features, etc.
|
||||
group :development do
|
||||
gem "shoulda", ">= 0"
|
||||
gem "rdoc", "~> 3.12"
|
||||
gem "bundler", "~> 1.0"
|
||||
gem "jeweler", "~> 2.0.1"
|
||||
gem "simplecov", ">= 0"
|
||||
end
|
||||
# Specify your gem's dependencies in progress-bar.gemspec
|
||||
gemspec
|
||||
|
|
106
Gemfile.lock
106
Gemfile.lock
|
@ -1,82 +1,36 @@
|
|||
GEM
|
||||
remote: http://rubygems.org/
|
||||
PATH
|
||||
remote: .
|
||||
specs:
|
||||
activesupport (4.2.0)
|
||||
i18n (~> 0.7)
|
||||
json (~> 1.7, >= 1.7.7)
|
||||
minitest (~> 5.1)
|
||||
thread_safe (~> 0.3, >= 0.3.4)
|
||||
tzinfo (~> 1.1)
|
||||
addressable (2.3.6)
|
||||
builder (3.2.2)
|
||||
descendants_tracker (0.0.4)
|
||||
thread_safe (~> 0.3, >= 0.3.1)
|
||||
docile (1.1.5)
|
||||
faraday (0.9.0)
|
||||
multipart-post (>= 1.2, < 3)
|
||||
git (1.2.8)
|
||||
github_api (0.12.2)
|
||||
addressable (~> 2.3)
|
||||
descendants_tracker (~> 0.0.4)
|
||||
faraday (~> 0.8, < 0.10)
|
||||
hashie (>= 3.3)
|
||||
multi_json (>= 1.7.5, < 2.0)
|
||||
nokogiri (~> 1.6.3)
|
||||
oauth2
|
||||
hashie (3.3.2)
|
||||
highline (1.6.21)
|
||||
i18n (0.7.0)
|
||||
jeweler (2.0.1)
|
||||
builder
|
||||
bundler (>= 1.0)
|
||||
git (>= 1.2.5)
|
||||
github_api
|
||||
highline (>= 1.6.15)
|
||||
nokogiri (>= 1.5.10)
|
||||
rake
|
||||
rdoc
|
||||
json (1.8.1)
|
||||
jwt (1.2.0)
|
||||
mini_portile (0.6.1)
|
||||
minitest (5.5.0)
|
||||
multi_json (1.10.1)
|
||||
multi_xml (0.5.5)
|
||||
multipart-post (2.0.0)
|
||||
nokogiri (1.6.5)
|
||||
mini_portile (~> 0.6.0)
|
||||
oauth2 (1.0.0)
|
||||
faraday (>= 0.8, < 0.10)
|
||||
jwt (~> 1.0)
|
||||
multi_json (~> 1.3)
|
||||
multi_xml (~> 0.5)
|
||||
rack (~> 1.2)
|
||||
rack (1.6.0)
|
||||
rake (10.4.2)
|
||||
rdoc (3.12.2)
|
||||
json (~> 1.4)
|
||||
ruby-dbus (0.11.0)
|
||||
shoulda (3.5.0)
|
||||
shoulda-context (~> 1.0, >= 1.0.1)
|
||||
shoulda-matchers (>= 1.4.1, < 3.0)
|
||||
shoulda-context (1.2.1)
|
||||
shoulda-matchers (2.7.0)
|
||||
activesupport (>= 3.0.0)
|
||||
simplecov (0.9.1)
|
||||
docile (~> 1.1.0)
|
||||
multi_json (~> 1.0)
|
||||
simplecov-html (~> 0.8.0)
|
||||
simplecov-html (0.8.0)
|
||||
thread_safe (0.3.4)
|
||||
tzinfo (1.2.2)
|
||||
thread_safe (~> 0.1)
|
||||
progress-bar (0.4.0)
|
||||
ruby-dbus (~> 0.15.0)
|
||||
|
||||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
diff-lcs (1.3)
|
||||
rake (12.3.3)
|
||||
rspec (3.9.0)
|
||||
rspec-core (~> 3.9.0)
|
||||
rspec-expectations (~> 3.9.0)
|
||||
rspec-mocks (~> 3.9.0)
|
||||
rspec-core (3.9.2)
|
||||
rspec-support (~> 3.9.3)
|
||||
rspec-expectations (3.9.2)
|
||||
diff-lcs (>= 1.2.0, < 2.0)
|
||||
rspec-support (~> 3.9.0)
|
||||
rspec-mocks (3.9.1)
|
||||
diff-lcs (>= 1.2.0, < 2.0)
|
||||
rspec-support (~> 3.9.0)
|
||||
rspec-support (3.9.3)
|
||||
ruby-dbus (0.15.0)
|
||||
|
||||
PLATFORMS
|
||||
ruby
|
||||
|
||||
DEPENDENCIES
|
||||
bundler (~> 1.0)
|
||||
jeweler (~> 2.0.1)
|
||||
rdoc (~> 3.12)
|
||||
ruby-dbus
|
||||
shoulda
|
||||
simplecov
|
||||
progress-bar!
|
||||
rake (~> 12.0)
|
||||
rspec (~> 3.2)
|
||||
|
||||
BUNDLED WITH
|
||||
2.0.1
|
||||
|
|
688
LICENSE.txt
688
LICENSE.txt
|
@ -1,20 +1,674 @@
|
|||
Copyright (c) 2014 Denis Knauf
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
Preamble
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. 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
|
||||
them 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 prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. 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.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey 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;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If 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 convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU 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 that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
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.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
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.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
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
|
||||
state 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 3 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, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program 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, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU 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 Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
|
|
66
README.md
66
README.md
|
@ -1,23 +1,55 @@
|
|||
ProgressBar
|
||||
===========
|
||||
|
||||
Usage
|
||||
=====
|
||||
Installation
|
||||
------------
|
||||
|
||||
This example will use your Terminal, if possible.
|
||||
If your program will be started without a Terminal,
|
||||
it will use kdialog for display a window.
|
||||
Add this line to your application's Gemfile:
|
||||
|
||||
pb = ProgressBar.new 100, 'Initial Text...'
|
||||
pb.i += 5
|
||||
pb.inc! 5
|
||||
pb.text = 'Something different'
|
||||
pb.inc! 20
|
||||
pb.text = 'Second phase'
|
||||
pb.inc! 60
|
||||
pb.text = 'Last Steps'
|
||||
pb.inc! 20
|
||||
pb.text = 'Done!'
|
||||
```ruby
|
||||
gem 'progress-bar'
|
||||
```
|
||||
|
||||
If you want to force to use kdialog use ProgressBar::KDialog.new or
|
||||
if you want to use your Console, use ProgressBar::Console.
|
||||
And then execute:
|
||||
|
||||
$ bundle
|
||||
|
||||
Or install it yourself as:
|
||||
|
||||
$ gem install progress-bar
|
||||
|
||||
## Usage
|
||||
|
||||
There exist three different handlers for ProgressBar: `ProgressBar::KDE`, `ProgressBar::KDialog` and `ProgressBar::Console`.
|
||||
These can be used directly, or you can use `ProgressBar.new` to determine the best solution.
|
||||
|
||||
If the process runs in a terminal, the `ProgressBar::Console` would be the best solution.
|
||||
If you run KDE, `ProgressBar::KDE`, which uses JobViewer via DBUS, would be nice.
|
||||
Else `ProgressBar::KDialog` will be tried.
|
||||
Other handlers could be added in future.
|
||||
|
||||
```ruby
|
||||
pb = ProgressBar.new 100, 'Initialization...' # You expect 100 units (eg. percent)
|
||||
pb.i += 5 # 5 units done
|
||||
pb.inc! 5 # additional 5 units done
|
||||
pb.text = "Working..."
|
||||
pb.i += 80
|
||||
pb.text = "Last steps"
|
||||
pb.i += 10
|
||||
pb.text = "Done!"
|
||||
pb.finish
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
|
||||
|
||||
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
||||
|
||||
## Contributing
|
||||
|
||||
Bug reports and pull requests are welcome on [https://git.denkn.at/deac/progress-bar]().
|
||||
|
||||
## License
|
||||
|
||||
The gem is available as open source under the terms of the [LGPL-3.0 License](https://opensource.org/licenses/LGPL-3.0).
|
||||
|
|
53
Rakefile
53
Rakefile
|
@ -1,51 +1,2 @@
|
|||
# encoding: utf-8
|
||||
|
||||
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 is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
|
||||
gem.name = "progress-bar"
|
||||
gem.homepage = "https://git.denkn.at/deac/progress-bar"
|
||||
gem.license = "MIT"
|
||||
gem.summary = %Q{Progress Bar for terminal and KDE}
|
||||
gem.description = %Q{Displays a Progress Bar in terminal, via JobViewer or kdialog}
|
||||
gem.email = %q{#{"de"}nis}+?@+'den'+%Q{kn}+"#{?.}at"
|
||||
gem.authors = ["Denis Knauf"]
|
||||
# dependencies defined in Gemfile
|
||||
end
|
||||
Jeweler::RubygemsDotOrgTasks.new
|
||||
|
||||
require 'rake/testtask'
|
||||
Rake::TestTask.new(:test) do |test|
|
||||
test.libs << 'lib' << 'test'
|
||||
test.pattern = 'test/**/test_*.rb'
|
||||
test.verbose = true
|
||||
end
|
||||
|
||||
desc "Code coverage detail"
|
||||
task :simplecov do
|
||||
ENV['COVERAGE'] = "true"
|
||||
Rake::Task['test'].execute
|
||||
end
|
||||
|
||||
task :default => :test
|
||||
|
||||
require 'rdoc/task'
|
||||
Rake::RDocTask.new do |rdoc|
|
||||
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
||||
|
||||
rdoc.rdoc_dir = 'rdoc'
|
||||
rdoc.title = "progress-bar #{version}"
|
||||
rdoc.rdoc_files.include('README*')
|
||||
rdoc.rdoc_files.include('lib/**/*.rb')
|
||||
end
|
||||
require "bundler/gem_tasks"
|
||||
task :default => :spec
|
||||
|
|
|
@ -1,30 +1,41 @@
|
|||
require 'dbus'
|
||||
require 'pathname'
|
||||
|
||||
#class DBus::Base
|
||||
# def initialize object
|
||||
# @object = object
|
||||
# @object.interfaces.each do |intname|
|
||||
# int = @object[intname]
|
||||
# int.methods do |name, |
|
||||
# meth
|
||||
# end
|
||||
# end
|
||||
# end
|
||||
#end
|
||||
|
||||
module ProgressBar
|
||||
@klasses ||= []
|
||||
class <<self
|
||||
def register klass
|
||||
if klass.possible?
|
||||
@klasses.push klass
|
||||
true
|
||||
else
|
||||
false
|
||||
end
|
||||
@klasses.push klass
|
||||
end
|
||||
|
||||
def new *a, **o
|
||||
klass = @klasses.find &:possible?
|
||||
klass.new *a, **o
|
||||
@klasses.map {|cl| cl.new *a, **o}.find &:possible?
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
class ProgressBar::Base
|
||||
attr_reader :max, :i, :text, :error
|
||||
attr_accessor :start
|
||||
attr_reader :max, :i, :text
|
||||
attr_accessor :startts
|
||||
def initialize max = nil, text = nil, **_options
|
||||
@start, @max, @i, @text, @error = Time.now, max || 100, 0, text || '', nil
|
||||
@startts, @max, @i, @text = nil, max || 100, 0, text || ''
|
||||
end
|
||||
|
||||
def start
|
||||
at_exit {finish}
|
||||
@startts = Time.now
|
||||
end
|
||||
|
||||
def i= x
|
||||
|
@ -41,7 +52,7 @@ class ProgressBar::Base
|
|||
alias to_i i
|
||||
alias inc! increment!
|
||||
def done_rel() 100.0*i/max end
|
||||
def done_dur() Time.now-@start end
|
||||
def done_dur() Time.now-@startts end
|
||||
|
||||
def total_dur
|
||||
done_dur * max / i
|
||||
|
@ -52,25 +63,28 @@ class ProgressBar::Base
|
|||
change_text
|
||||
end
|
||||
|
||||
def error= x
|
||||
@error = x
|
||||
change_error
|
||||
end
|
||||
|
||||
def error( text) end
|
||||
def change_progress() end
|
||||
def change_text() end
|
||||
def change_error() end
|
||||
def finish() end
|
||||
def self.possible?() false end
|
||||
end
|
||||
|
||||
class ProgressBar::Console < ProgressBar::Base
|
||||
def self.possible?
|
||||
STDERR.tty?
|
||||
attr_reader :outfd, :errfd
|
||||
|
||||
def initialize *a, outfd: nil, errfd: nil, **_options
|
||||
@outfd = outfd || STDERR
|
||||
@errfd = errfd || @outfd
|
||||
super *a, **_options
|
||||
end
|
||||
|
||||
def initialize *a
|
||||
super *a
|
||||
def possible?
|
||||
@outfd.tty?
|
||||
end
|
||||
|
||||
def start
|
||||
super
|
||||
change_text
|
||||
end
|
||||
|
||||
|
@ -87,40 +101,56 @@ class ProgressBar::Console < ProgressBar::Base
|
|||
dd, td = done_dur, total_dur
|
||||
b = ?= * l
|
||||
b[-1] = ?> unless 0 == l or 100 == l
|
||||
STDOUT.printf "\r\e[J%s / %s [%-*s] %s", format_time(dd), format_time(td), 100, b, text
|
||||
@outfd.printf "\r\e[J%s / %s [%-*s] %s", format_time(dd), format_time(td), 100, b, text
|
||||
end
|
||||
alias change_progress change_text
|
||||
|
||||
def change_error
|
||||
STDERR.printf "\r\e[J%s\n", error
|
||||
change_text
|
||||
def error text
|
||||
@errfd.printf "\r\e[J%s\n", text
|
||||
@errfd.flush
|
||||
end
|
||||
|
||||
def finish
|
||||
STDERR.puts
|
||||
@outfd.puts
|
||||
@outfd.flush
|
||||
end
|
||||
end
|
||||
|
||||
class ProgressBar::KDE < ProgressBar::Base
|
||||
def self.possible?
|
||||
'KDE' == ENV['XDG_CURRENT_DESKTOP']
|
||||
end
|
||||
attr_reader :bus, :service, :view
|
||||
|
||||
def initialize max, text = nil, title = nil, app_name: nil, app_icon_name: nil, unit: nil, is_cancable: nil, is_suspendable: nil, unit: nil, **_options
|
||||
def initialize max, text = nil, title: nil,
|
||||
app_name: nil,
|
||||
app_icon_name: nil,
|
||||
unit: nil,
|
||||
is_cancable: nil,
|
||||
is_suspendable: nil,
|
||||
**_options
|
||||
|
||||
super max, text
|
||||
text = @text
|
||||
text = nil if text.nil? or text.empty?
|
||||
title = nil if title.nil? or title.empty?
|
||||
@unit = '' if unit.nil? or unit.empty?
|
||||
unit = '' if unit.nil? or unit.empty?
|
||||
@title, @text, @unit, @app_name, @app_icon_name, @is_cancable, @is_suspendable =
|
||||
title, text, unit, app_name || $0, app_icon_name || '', is_cancable, is_suspendable
|
||||
@errors = []
|
||||
end
|
||||
|
||||
def possible?
|
||||
'KDE' == ENV['XDG_CURRENT_DESKTOP']
|
||||
end
|
||||
|
||||
def start
|
||||
@finished = false
|
||||
@bus = DBus::SessionBus.instance
|
||||
@service = @bus['org.kde.JobViewServer']
|
||||
jvs = @service['/JobViewServer']['org.kde.JobViewServer']
|
||||
flags = (is_cancable ? 0x1 : 0) | (is_suspendable ? 0x2 : 0)
|
||||
view_path = jvs.requestView app_name || $0, app_icon_name || '', flags
|
||||
flags = (@is_cancable ? 0x1 : 0) | (@is_suspendable ? 0x2 : 0)
|
||||
view_path = jvs.requestView @app_name, @app_icon_name, flags
|
||||
@view = @service[view_path]['org.kde.JobViewV2']
|
||||
@view.setTotalAmount max, unit
|
||||
super
|
||||
@view.setTotalAmount @max, @unit
|
||||
end
|
||||
|
||||
def change_text
|
||||
|
@ -128,42 +158,61 @@ class ProgressBar::KDE < ProgressBar::Base
|
|||
end
|
||||
|
||||
def change_progress
|
||||
@view.setProcessedAmount i, unit
|
||||
@view.setPercentage done_rel
|
||||
@view.setProcessedAmount i, @unit
|
||||
@view.setPercent done_rel
|
||||
end
|
||||
|
||||
def change_error
|
||||
@view.setError error
|
||||
def error text
|
||||
#STDERR.puts @view.object.introspect
|
||||
#@view.setError text
|
||||
@view.setDescriptionField 0, "Error", text
|
||||
#@view.setInfoMessage "#{text}\nError: #{error}"
|
||||
end
|
||||
|
||||
def finish
|
||||
@view.terminate
|
||||
return if @finished
|
||||
@view.terminate ''
|
||||
@finished = true
|
||||
end
|
||||
|
||||
def max= value
|
||||
super value
|
||||
@view.setTotalAmount value, @unit
|
||||
end
|
||||
end
|
||||
|
||||
class ProgressBar::KDialog < ProgressBar::Base
|
||||
def self.possible?
|
||||
path = Pathname.new `which kdialog`.chomp
|
||||
$?.exitstatus and path.executable?
|
||||
end
|
||||
|
||||
attr_reader :dialog_service_path, :dialog_object_path, :errors, :dialog_object
|
||||
|
||||
def initialize max, text = nil, title = nil, **_options
|
||||
def initialize max, text = nil, title: nil, **_options
|
||||
super max, text
|
||||
text = @text
|
||||
text = nil if text.nil? or text.empty?
|
||||
title = nil if title.nil? or title.empty?
|
||||
@title = title
|
||||
@errors = []
|
||||
args = ['kdialog', title ? ['--title', title] : [], '--progressbar', text || '.', max].flatten.compact.map &:to_s
|
||||
@dialog_service_path, @dialog_object_path = IO.popen( args, 'r', &:readlines).join("\n").split ' '
|
||||
end
|
||||
|
||||
def possible?
|
||||
path = Pathname.new `which kdialog`.chomp
|
||||
$?.exitstatus and path.executable?
|
||||
end
|
||||
|
||||
def start
|
||||
@finished = false
|
||||
args = ['kdialog', @title ? ['--title', @title] : [], '--progressbar', @text || '.', @max].flatten.compact.map &:to_s
|
||||
@dialog_service_path, @dialog_object_path =
|
||||
IO.popen( args, 'r', &:readlines).join( "\n").split ' '
|
||||
@dialog_bus = DBus.session_bus
|
||||
@dialog_service = @dialog_bus[@dialog_service_path]
|
||||
@dialog_object = @dialog_service.object @dialog_object_path
|
||||
@dialog_object.introspect
|
||||
@dialog_object.showCancelButton true
|
||||
@dialog_object = @dialog_service[ @dialog_object_path]
|
||||
#STDERR.puts "%p" %
|
||||
@dialog_object.introspect
|
||||
@dialog_object.showCancelButton 1
|
||||
super
|
||||
change_text if text.nil?
|
||||
change_progress
|
||||
|
||||
rescue DBus::Error
|
||||
raise Interrupt if $!.name == 'org.freedesktop.DBus.Error.ServiceUnknown'
|
||||
raise
|
||||
|
@ -177,8 +226,9 @@ class ProgressBar::KDialog < ProgressBar::Base
|
|||
def kdialog(*a) self.class.kdialog *a end
|
||||
|
||||
def change_progress()
|
||||
@dialog_object.Set '', 'value', i
|
||||
raise Interrupt if @dialog_object.wasCancelled.first
|
||||
#@dialog_object.Set 'org.kde.kdialog.ProgressDialog', 'value', i
|
||||
@dialog_object['value'] = i
|
||||
raise Interrupt if @dialog_object.wasCancelled
|
||||
rescue DBus::Error
|
||||
raise Interrupt if $!.name == 'org.freedesktop.DBus.Error.ServiceUnknown'
|
||||
raise
|
||||
|
@ -186,24 +236,25 @@ class ProgressBar::KDialog < ProgressBar::Base
|
|||
|
||||
def change_text()
|
||||
@dialog_object.setLabelText text
|
||||
raise Interrupt if @dialog_object.wasCancelled.first
|
||||
raise Interrupt if @dialog_object.wasCancelled
|
||||
rescue DBus::Error
|
||||
raise Interrupt if $!.name == 'org.freedesktop.DBus.Error.ServiceUnknown'
|
||||
raise
|
||||
end
|
||||
|
||||
def change_error() @errors.push error end
|
||||
def error text
|
||||
kdialog '--error', text
|
||||
end
|
||||
|
||||
def finish()
|
||||
@dialog_object.close rescue DBus::Error
|
||||
kdialog '--detailederror', "Some errors occured:", errors.join( "<br/>\n") unless errors.empty?
|
||||
return if @finished
|
||||
@dialog_object.close rescue DBus::Error
|
||||
@finished = true
|
||||
end
|
||||
|
||||
def max= val
|
||||
@dialog_object.Set '', 'maximum', val
|
||||
end
|
||||
|
||||
def max
|
||||
@dialog_object.Get '', 'maximum'
|
||||
super val
|
||||
@dialog_object['maximum'] = val
|
||||
end
|
||||
end
|
||||
|
||||
|
|
3
lib/progress-bar/version.rb
Normal file
3
lib/progress-bar/version.rb
Normal file
|
@ -0,0 +1,3 @@
|
|||
module ProgressBar
|
||||
VERSION = "0.4.0"
|
||||
end
|
|
@ -1,65 +1,26 @@
|
|||
# Generated by jeweler
|
||||
# DO NOT EDIT THIS FILE DIRECTLY
|
||||
# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
|
||||
# -*- encoding: utf-8 -*-
|
||||
require_relative "lib/progress-bar/version"
|
||||
|
||||
Gem::Specification.new do |s|
|
||||
s.name = "progress-bar"
|
||||
s.version = "0.3.7"
|
||||
Gem::Specification.new do |spec|
|
||||
spec.name = "progress-bar"
|
||||
spec.version = ProgressBar::VERSION
|
||||
spec.authors = ["Denis Knauf"]
|
||||
spec.email = ["denis+gems@denkn.at"]
|
||||
|
||||
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
||||
s.authors = ["Denis Knauf"]
|
||||
s.date = "2014-12-24"
|
||||
s.description = "Displays a Progress Bar in terminal or via kdialog"
|
||||
s.email = "\#{\"de\"}nis@denkn.at"
|
||||
s.extra_rdoc_files = [
|
||||
"LICENSE.txt",
|
||||
"README.md"
|
||||
]
|
||||
s.files = [
|
||||
".document",
|
||||
"Gemfile",
|
||||
"Gemfile.lock",
|
||||
"LICENSE.txt",
|
||||
"README.md",
|
||||
"Rakefile",
|
||||
"VERSION",
|
||||
"lib/progress-bar.rb",
|
||||
"progress-bar.gemspec",
|
||||
"test/helper.rb",
|
||||
"test/test_progress-bar.rb"
|
||||
]
|
||||
s.homepage = "http://github.com/DenisKnauf/progress-bar"
|
||||
s.licenses = ["MIT"]
|
||||
s.require_paths = ["lib"]
|
||||
s.rubygems_version = "2.0.14"
|
||||
s.summary = "Progress Bar for terminal and KDE"
|
||||
spec.summary = %q{Progress Bar for terminal and KDE}
|
||||
spec.description = %q{Displays a Progress Bar in terminal, via KDE-JobViewer or via kdialog}
|
||||
spec.homepage = "https://git.denkn.at/deac/progress-bar"
|
||||
spec.licenses = ["GPLv3"]
|
||||
|
||||
if s.respond_to? :specification_version then
|
||||
s.specification_version = 4
|
||||
# Specify which files should be added to the gem when it is released.
|
||||
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
||||
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
||||
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
||||
end
|
||||
#spec.bindir = "bin"
|
||||
#spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
||||
spec.require_paths = ["lib"]
|
||||
|
||||
if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
|
||||
s.add_runtime_dependency(%q<ruby-dbus>, [">= 0"])
|
||||
s.add_development_dependency(%q<shoulda>, [">= 0"])
|
||||
s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
|
||||
s.add_development_dependency(%q<bundler>, ["~> 1.0"])
|
||||
s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
|
||||
s.add_development_dependency(%q<simplecov>, [">= 0"])
|
||||
else
|
||||
s.add_dependency(%q<ruby-dbus>, [">= 0"])
|
||||
s.add_dependency(%q<shoulda>, [">= 0"])
|
||||
s.add_dependency(%q<rdoc>, ["~> 3.12"])
|
||||
s.add_dependency(%q<bundler>, ["~> 1.0"])
|
||||
s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
|
||||
s.add_dependency(%q<simplecov>, [">= 0"])
|
||||
end
|
||||
else
|
||||
s.add_dependency(%q<ruby-dbus>, [">= 0"])
|
||||
s.add_dependency(%q<shoulda>, [">= 0"])
|
||||
s.add_dependency(%q<rdoc>, ["~> 3.12"])
|
||||
s.add_dependency(%q<bundler>, ["~> 1.0"])
|
||||
s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
|
||||
s.add_dependency(%q<simplecov>, [">= 0"])
|
||||
end
|
||||
spec.add_development_dependency "rake", "~> 12.0"
|
||||
spec.add_development_dependency "rspec", "~> 3.2"
|
||||
spec.add_dependency "ruby-dbus", '~> 0.15.0'
|
||||
end
|
||||
|
||||
|
|
116
spec/progressbar_spec.rb
Normal file
116
spec/progressbar_spec.rb
Normal file
|
@ -0,0 +1,116 @@
|
|||
require 'progress-bar'
|
||||
|
||||
[ProgressBar::Console, ProgressBar::KDE, ProgressBar::KDialog].each do |klass|
|
||||
describe klass do
|
||||
before do
|
||||
@bar = klass.new 100, 'starting...', title: 'rspec',
|
||||
outfd: STDERR, errfd: STDERR, # ProgressBar::Console
|
||||
app_name: 'rspec', app_icon_name: '' # ProgressBar::KDE
|
||||
@bar.start
|
||||
end
|
||||
|
||||
after do
|
||||
@bar.finish
|
||||
end
|
||||
|
||||
it 'start' do
|
||||
end
|
||||
|
||||
describe '#max' do
|
||||
it 'sets maximum of 5' do
|
||||
@bar.max = 5
|
||||
expect(@bar.max).to eql(5)
|
||||
end
|
||||
|
||||
it 'sets maximum of 100' do
|
||||
@bar.max = 100
|
||||
expect(@bar.max).to eql(100)
|
||||
end
|
||||
end
|
||||
|
||||
it 'is possible to use, if outfd&errfd are a tty' do
|
||||
expect(@bar.possible?).to eql(true)
|
||||
end
|
||||
|
||||
describe '#i=' do
|
||||
it 'has 20 progress' do
|
||||
@bar.i = 20
|
||||
@bar.text = "test: i=20"
|
||||
sleep 1
|
||||
end
|
||||
|
||||
it 'has 3 progress of 6' do
|
||||
@bar.max = 6
|
||||
@bar.text = "test: max=6"
|
||||
sleep 1
|
||||
@bar.i = 3
|
||||
@bar.text = "test: max=6, i=3"
|
||||
sleep 1
|
||||
expect(@bar.done_rel).to eql(50.0)
|
||||
sleep 1
|
||||
end
|
||||
end
|
||||
|
||||
describe '#increment!' do
|
||||
it 'increases progress' do
|
||||
sleep 1
|
||||
@bar.increment!
|
||||
@bar.text = "test: (i+=1) = 1"
|
||||
sleep 1
|
||||
expect(@bar.i).to eql(1)
|
||||
sleep 1
|
||||
end
|
||||
end
|
||||
|
||||
it 'displays text' do
|
||||
@bar.text = 'processing...'
|
||||
end
|
||||
|
||||
it 'displays an error' do
|
||||
sleep 1
|
||||
@bar.error 'failed :('
|
||||
sleep 1
|
||||
@bar.text = '^^ failed? ^^'
|
||||
sleep 1
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
__END__
|
||||
describe ProgressBar::KDE do
|
||||
before do
|
||||
@bar = ProgressBar::KDE.new 100, 'starting...', title: 'rspec', app_name: 'rspec'
|
||||
@bar.start
|
||||
end
|
||||
|
||||
it 'is possible, if XDG_DESKTOP is KDE' do
|
||||
expect(@bar.possible?).to eql(true)
|
||||
end
|
||||
|
||||
it 'start' do
|
||||
@bar.start
|
||||
end
|
||||
|
||||
it 'finish' do
|
||||
@bar.finish
|
||||
end
|
||||
end
|
||||
|
||||
describe ProgressBar::KDialog do
|
||||
before do
|
||||
@bar = ProgressBar::KDE.new 100, 'starting...', title: 'rspec'
|
||||
@bar.start
|
||||
end
|
||||
|
||||
it 'is possible to use, if kdialog found' do
|
||||
expect(@bar.possible?).to eql(true)
|
||||
end
|
||||
|
||||
it 'start' do
|
||||
@bar.start
|
||||
end
|
||||
|
||||
it 'finish' do
|
||||
@bar.finish
|
||||
end
|
||||
end
|
|
@ -1,34 +0,0 @@
|
|||
require 'simplecov'
|
||||
|
||||
module SimpleCov::Configuration
|
||||
def clean_filters
|
||||
@filters = []
|
||||
end
|
||||
end
|
||||
|
||||
SimpleCov.configure do
|
||||
clean_filters
|
||||
load_adapter 'test_frameworks'
|
||||
end
|
||||
|
||||
ENV["COVERAGE"] && SimpleCov.start do
|
||||
add_filter "/.rvm/"
|
||||
end
|
||||
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 'test/unit'
|
||||
require 'shoulda'
|
||||
|
||||
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
|
||||
$LOAD_PATH.unshift(File.dirname(__FILE__))
|
||||
require 'progress-bar'
|
||||
|
||||
class Test::Unit::TestCase
|
||||
end
|
|
@ -1,7 +0,0 @@
|
|||
require 'helper'
|
||||
|
||||
class TestProgressBar < Test::Unit::TestCase
|
||||
should "probably rename this file and start testing for real" do
|
||||
flunk "hey buddy, you should probably rename this file and start testing for real"
|
||||
end
|
||||
end
|
Loading…
Reference in a new issue