lolcommits-term_output 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.simplecov +9 -0
- data/.travis.yml +35 -0
- data/CODE_OF_CONDUCT.md +50 -0
- data/CONTRIBUTING.md +37 -0
- data/Gemfile +2 -0
- data/LICENSE +165 -0
- data/README.md +104 -0
- data/Rakefile +31 -0
- data/bin/console +14 -0
- data/bin/setup +10 -0
- data/lib/lolcommits/plugin/term_output.rb +105 -0
- data/lib/lolcommits/term_output/version.rb +5 -0
- data/lib/lolcommits/term_output.rb +2 -0
- data/lolcommits-term_output.gemspec +40 -0
- data/test/lolcommits/plugin/term_output_test.rb +135 -0
- data/test/test_helper.rb +22 -0
- data/vendor/fonts/Impact.ttf +0 -0
- metadata +163 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: ee955ca3bc5396444fdaa77cc95b6ccfc645da68
|
4
|
+
data.tar.gz: 8ebffc15931c0d2832dcd283058da57e24bcf74a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: d9c6513b50ca73744511b333e7a0362e04d050ac3b270324db3669c5e41e77b1bf02471265e6f01a8d9c58a388dec289665bfffa263d9f2530d6c74afdddf7b1
|
7
|
+
data.tar.gz: 4a44c40f5b291ecbb4b123070a8232c52d4cfee81f95b2e3667ad0a4d5c9bbbedcd39afa74113efab397c9ad18c0bb2054dcfa599777ab20f59fe4f8501dd118
|
data/.gitignore
ADDED
data/.simplecov
ADDED
data/.travis.yml
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
sudo: false
|
2
|
+
language: ruby
|
3
|
+
cache: bundler
|
4
|
+
rvm:
|
5
|
+
- 2.0.0
|
6
|
+
- 2.1.10
|
7
|
+
- 2.2.8
|
8
|
+
- 2.3.5
|
9
|
+
- 2.4.2
|
10
|
+
- ruby-head
|
11
|
+
|
12
|
+
before_install:
|
13
|
+
- gem install bundler -v 1.13.7
|
14
|
+
- git --version
|
15
|
+
- git config --global user.email "lol@commits.org"
|
16
|
+
- git config --global user.name "Lolcommits"
|
17
|
+
|
18
|
+
matrix:
|
19
|
+
allow_failures:
|
20
|
+
- rvm: ruby-head
|
21
|
+
|
22
|
+
branches:
|
23
|
+
except:
|
24
|
+
- gh-pages
|
25
|
+
|
26
|
+
env:
|
27
|
+
global:
|
28
|
+
- CC_TEST_REPORTER_ID=eb8c60bf77e0ed78453285e1d9c0aa4c9c248a4945f077615edb042db7753fb9
|
29
|
+
- GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
|
30
|
+
before_script:
|
31
|
+
- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
|
32
|
+
- chmod +x ./cc-test-reporter
|
33
|
+
- ./cc-test-reporter before-build - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
|
34
|
+
after_script:
|
35
|
+
- ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
|
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
# Contributor Code of Conduct
|
2
|
+
|
3
|
+
As contributors and maintainers of this project, and in the interest of
|
4
|
+
fostering an open and welcoming community, we pledge to respect all people who
|
5
|
+
contribute through reporting issues, posting feature requests, updating
|
6
|
+
documentation, submitting pull requests or patches, and other activities.
|
7
|
+
|
8
|
+
We are committed to making participation in this project a harassment-free
|
9
|
+
experience for everyone, regardless of level of experience, gender, gender
|
10
|
+
identity and expression, sexual orientation, disability, personal appearance,
|
11
|
+
body size, race, ethnicity, age, religion, or nationality.
|
12
|
+
|
13
|
+
Examples of unacceptable behavior by participants include:
|
14
|
+
|
15
|
+
* The use of sexualized language or imagery
|
16
|
+
* Personal attacks
|
17
|
+
* Trolling or insulting/derogatory comments
|
18
|
+
* Public or private harassment
|
19
|
+
* Publishing other's private information, such as physical or electronic
|
20
|
+
addresses, without explicit permission
|
21
|
+
* Other unethical or unprofessional conduct
|
22
|
+
|
23
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
24
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
25
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
26
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
27
|
+
threatening, offensive, or harmful.
|
28
|
+
|
29
|
+
By adopting this Code of Conduct, project maintainers commit themselves to
|
30
|
+
fairly and consistently applying these principles to every aspect of managing
|
31
|
+
this project. Project maintainers who do not follow or enforce the Code of
|
32
|
+
Conduct may be permanently removed from the project team.
|
33
|
+
|
34
|
+
This code of conduct applies both within project spaces and in public spaces
|
35
|
+
when an individual is representing the project or its community.
|
36
|
+
|
37
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
38
|
+
reported by contacting a project maintainer via [GitHub][maintainer]. All
|
39
|
+
complaints will be reviewed and investigated and will result in a response that
|
40
|
+
is deemed necessary and appropriate to the circumstances. Maintainers are
|
41
|
+
obligated to maintain confidentiality with regard to the reporter of an
|
42
|
+
incident.
|
43
|
+
|
44
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
45
|
+
version 1.3.0, available at
|
46
|
+
[http://contributor-covenant.org/version/1/3/0/][version]
|
47
|
+
|
48
|
+
[maintainer]: https://github.com/matthutchinson
|
49
|
+
[homepage]: http://contributor-covenant.org
|
50
|
+
[version]: http://contributor-covenant.org/version/1/3/0/
|
data/CONTRIBUTING.md
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
### Contributing
|
2
|
+
|
3
|
+
Pull Requests are welcome! To start helping out:
|
4
|
+
|
5
|
+
[Fork](https://guides.github.com/activities/forking) then clone the repository:
|
6
|
+
|
7
|
+
git clone git@github.com:your-username/lolcommits-term_output.git
|
8
|
+
|
9
|
+
Create your feature branch:
|
10
|
+
|
11
|
+
git checkout -b my-new-feature
|
12
|
+
|
13
|
+
When you are happy with your change, run the full test suite:
|
14
|
+
|
15
|
+
bundle exec rake
|
16
|
+
|
17
|
+
With a passing test suite, commit your changes, push and submit a new [Pull
|
18
|
+
Request](https://github.com/lolcommits/lolcommits-term_output/compare):
|
19
|
+
|
20
|
+
git commit -am 'Added some feature'
|
21
|
+
git push origin my-new-feature
|
22
|
+
|
23
|
+
At this point you'll be waiting for one of our maintainers to review it. We will
|
24
|
+
try to reply to new Pull Requests within a few days. We might suggest some
|
25
|
+
changes, improvements or alternatives. To increase the chance that your pull
|
26
|
+
request gets accepted:
|
27
|
+
|
28
|
+
* Explain what your are doing (and why) in your Pull Request description.
|
29
|
+
* If you are fixing an
|
30
|
+
[issue](https://github.com/lolcommits/lolcommits-term_output/issues), link to
|
31
|
+
it in your description and [mention
|
32
|
+
it](https://help.github.com/articles/closing-issues-via-commit-messages) in
|
33
|
+
the commit message.
|
34
|
+
* Write a good [commit
|
35
|
+
message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
|
36
|
+
* Write tests.
|
37
|
+
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,165 @@
|
|
1
|
+
GNU LESSER GENERAL PUBLIC LICENSE
|
2
|
+
Version 3, 29 June 2007
|
3
|
+
|
4
|
+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
5
|
+
Everyone is permitted to copy and distribute verbatim copies
|
6
|
+
of this license document, but changing it is not allowed.
|
7
|
+
|
8
|
+
|
9
|
+
This version of the GNU Lesser General Public License incorporates
|
10
|
+
the terms and conditions of version 3 of the GNU General Public
|
11
|
+
License, supplemented by the additional permissions listed below.
|
12
|
+
|
13
|
+
0. Additional Definitions.
|
14
|
+
|
15
|
+
As used herein, "this License" refers to version 3 of the GNU Lesser
|
16
|
+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
17
|
+
General Public License.
|
18
|
+
|
19
|
+
"The Library" refers to a covered work governed by this License,
|
20
|
+
other than an Application or a Combined Work as defined below.
|
21
|
+
|
22
|
+
An "Application" is any work that makes use of an interface provided
|
23
|
+
by the Library, but which is not otherwise based on the Library.
|
24
|
+
Defining a subclass of a class defined by the Library is deemed a mode
|
25
|
+
of using an interface provided by the Library.
|
26
|
+
|
27
|
+
A "Combined Work" is a work produced by combining or linking an
|
28
|
+
Application with the Library. The particular version of the Library
|
29
|
+
with which the Combined Work was made is also called the "Linked
|
30
|
+
Version".
|
31
|
+
|
32
|
+
The "Minimal Corresponding Source" for a Combined Work means the
|
33
|
+
Corresponding Source for the Combined Work, excluding any source code
|
34
|
+
for portions of the Combined Work that, considered in isolation, are
|
35
|
+
based on the Application, and not on the Linked Version.
|
36
|
+
|
37
|
+
The "Corresponding Application Code" for a Combined Work means the
|
38
|
+
object code and/or source code for the Application, including any data
|
39
|
+
and utility programs needed for reproducing the Combined Work from the
|
40
|
+
Application, but excluding the System Libraries of the Combined Work.
|
41
|
+
|
42
|
+
1. Exception to Section 3 of the GNU GPL.
|
43
|
+
|
44
|
+
You may convey a covered work under sections 3 and 4 of this License
|
45
|
+
without being bound by section 3 of the GNU GPL.
|
46
|
+
|
47
|
+
2. Conveying Modified Versions.
|
48
|
+
|
49
|
+
If you modify a copy of the Library, and, in your modifications, a
|
50
|
+
facility refers to a function or data to be supplied by an Application
|
51
|
+
that uses the facility (other than as an argument passed when the
|
52
|
+
facility is invoked), then you may convey a copy of the modified
|
53
|
+
version:
|
54
|
+
|
55
|
+
a) under this License, provided that you make a good faith effort to
|
56
|
+
ensure that, in the event an Application does not supply the
|
57
|
+
function or data, the facility still operates, and performs
|
58
|
+
whatever part of its purpose remains meaningful, or
|
59
|
+
|
60
|
+
b) under the GNU GPL, with none of the additional permissions of
|
61
|
+
this License applicable to that copy.
|
62
|
+
|
63
|
+
3. Object Code Incorporating Material from Library Header Files.
|
64
|
+
|
65
|
+
The object code form of an Application may incorporate material from
|
66
|
+
a header file that is part of the Library. You may convey such object
|
67
|
+
code under terms of your choice, provided that, if the incorporated
|
68
|
+
material is not limited to numerical parameters, data structure
|
69
|
+
layouts and accessors, or small macros, inline functions and templates
|
70
|
+
(ten or fewer lines in length), you do both of the following:
|
71
|
+
|
72
|
+
a) Give prominent notice with each copy of the object code that the
|
73
|
+
Library is used in it and that the Library and its use are
|
74
|
+
covered by this License.
|
75
|
+
|
76
|
+
b) Accompany the object code with a copy of the GNU GPL and this license
|
77
|
+
document.
|
78
|
+
|
79
|
+
4. Combined Works.
|
80
|
+
|
81
|
+
You may convey a Combined Work under terms of your choice that,
|
82
|
+
taken together, effectively do not restrict modification of the
|
83
|
+
portions of the Library contained in the Combined Work and reverse
|
84
|
+
engineering for debugging such modifications, if you also do each of
|
85
|
+
the following:
|
86
|
+
|
87
|
+
a) Give prominent notice with each copy of the Combined Work that
|
88
|
+
the Library is used in it and that the Library and its use are
|
89
|
+
covered by this License.
|
90
|
+
|
91
|
+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
92
|
+
document.
|
93
|
+
|
94
|
+
c) For a Combined Work that displays copyright notices during
|
95
|
+
execution, include the copyright notice for the Library among
|
96
|
+
these notices, as well as a reference directing the user to the
|
97
|
+
copies of the GNU GPL and this license document.
|
98
|
+
|
99
|
+
d) Do one of the following:
|
100
|
+
|
101
|
+
0) Convey the Minimal Corresponding Source under the terms of this
|
102
|
+
License, and the Corresponding Application Code in a form
|
103
|
+
suitable for, and under terms that permit, the user to
|
104
|
+
recombine or relink the Application with a modified version of
|
105
|
+
the Linked Version to produce a modified Combined Work, in the
|
106
|
+
manner specified by section 6 of the GNU GPL for conveying
|
107
|
+
Corresponding Source.
|
108
|
+
|
109
|
+
1) Use a suitable shared library mechanism for linking with the
|
110
|
+
Library. A suitable mechanism is one that (a) uses at run time
|
111
|
+
a copy of the Library already present on the user's computer
|
112
|
+
system, and (b) will operate properly with a modified version
|
113
|
+
of the Library that is interface-compatible with the Linked
|
114
|
+
Version.
|
115
|
+
|
116
|
+
e) Provide Installation Information, but only if you would otherwise
|
117
|
+
be required to provide such information under section 6 of the
|
118
|
+
GNU GPL, and only to the extent that such information is
|
119
|
+
necessary to install and execute a modified version of the
|
120
|
+
Combined Work produced by recombining or relinking the
|
121
|
+
Application with a modified version of the Linked Version. (If
|
122
|
+
you use option 4d0, the Installation Information must accompany
|
123
|
+
the Minimal Corresponding Source and Corresponding Application
|
124
|
+
Code. If you use option 4d1, you must provide the Installation
|
125
|
+
Information in the manner specified by section 6 of the GNU GPL
|
126
|
+
for conveying Corresponding Source.)
|
127
|
+
|
128
|
+
5. Combined Libraries.
|
129
|
+
|
130
|
+
You may place library facilities that are a work based on the
|
131
|
+
Library side by side in a single library together with other library
|
132
|
+
facilities that are not Applications and are not covered by this
|
133
|
+
License, and convey such a combined library under terms of your
|
134
|
+
choice, if you do both of the following:
|
135
|
+
|
136
|
+
a) Accompany the combined library with a copy of the same work based
|
137
|
+
on the Library, uncombined with any other library facilities,
|
138
|
+
conveyed under the terms of this License.
|
139
|
+
|
140
|
+
b) Give prominent notice with the combined library that part of it
|
141
|
+
is a work based on the Library, and explaining where to find the
|
142
|
+
accompanying uncombined form of the same work.
|
143
|
+
|
144
|
+
6. Revised Versions of the GNU Lesser General Public License.
|
145
|
+
|
146
|
+
The Free Software Foundation may publish revised and/or new versions
|
147
|
+
of the GNU Lesser General Public License from time to time. Such new
|
148
|
+
versions will be similar in spirit to the present version, but may
|
149
|
+
differ in detail to address new problems or concerns.
|
150
|
+
|
151
|
+
Each version is given a distinguishing version number. If the
|
152
|
+
Library as you received it specifies that a certain numbered version
|
153
|
+
of the GNU Lesser General Public License "or any later version"
|
154
|
+
applies to it, you have the option of following the terms and
|
155
|
+
conditions either of that published version or of any later version
|
156
|
+
published by the Free Software Foundation. If the Library as you
|
157
|
+
received it does not specify a version number of the GNU Lesser
|
158
|
+
General Public License, you may choose any version of the GNU Lesser
|
159
|
+
General Public License ever published by the Free Software Foundation.
|
160
|
+
|
161
|
+
If the Library as you received it specifies that a proxy can decide
|
162
|
+
whether future versions of the GNU Lesser General Public License shall
|
163
|
+
apply, that proxy's public statement of acceptance of any version is
|
164
|
+
permanent authorization for you to choose that version for the
|
165
|
+
Library.
|
data/README.md
ADDED
@@ -0,0 +1,104 @@
|
|
1
|
+
# Lolcommits Term Output
|
2
|
+
|
3
|
+
[![Gem Version](https://img.shields.io/gem/v/lolcommits-term_output.svg?style=flat)](http://rubygems.org/gems/lolcommits-term_output)
|
4
|
+
[![Travis Build Status](https://travis-ci.org/lolcommits/lolcommits-term_output.svg?branch=master)](https://travis-ci.org/lolcommits/lolcommits-term_output)
|
5
|
+
[![Test Coverage](https://codeclimate.com/github/lolcommits/lolcommits-term_output/badges/coverage.svg)](https://codeclimate.com/github/lolcommits/lolcommits-term_output/coverage)
|
6
|
+
[![Code Climate](https://codeclimate.com/github/lolcommits/lolcommits-term_output/badges/gpa.svg)](https://codeclimate.com/github/lolcommits/lolcommits-term_output)
|
7
|
+
[![Gem Dependency Status](https://gemnasium.com/badges/github.com/lolcommits/lolcommits-term_output.svg)](https://gemnasium.com/github.com/lolcommits/lolcommits-term_output)
|
8
|
+
|
9
|
+
[lolcommits](https://lolcommits.github.io/) takes a snapshot with your webcam
|
10
|
+
every time you git commit code, and archives a lolcat style image with it. Git
|
11
|
+
blame has never been so much fun!
|
12
|
+
|
13
|
+
This plugin uses the [inline image](http://iterm2.com/documentation-images.html)
|
14
|
+
feature available in [iTerm2](http://iterm2.com/index.html) to display each
|
15
|
+
lolcommit image in your terminal (after committing). For example:
|
16
|
+
|
17
|
+
![iterm inline sample screenshot](./assets/images/sample.png)
|
18
|
+
|
19
|
+
## Requirements
|
20
|
+
|
21
|
+
* Ruby >= 2.0.0
|
22
|
+
* A webcam
|
23
|
+
* [iTerm2](http://iterm2.com/index.html)
|
24
|
+
* [ImageMagick](http://www.imagemagick.org)
|
25
|
+
* [ffmpeg](https://www.ffmpeg.org) (optional) for animated gif capturing
|
26
|
+
|
27
|
+
## Installation
|
28
|
+
|
29
|
+
After installing the lolcommits gem, install this plugin with:
|
30
|
+
|
31
|
+
$ gem install lolcommits-term_output
|
32
|
+
|
33
|
+
Then configure to enable and set the remote endpoint:
|
34
|
+
|
35
|
+
$ lolcommits --config -p term_output
|
36
|
+
# set enabled to `true`
|
37
|
+
|
38
|
+
That's it! Your next lolcommit will be displayed within your terminal. To
|
39
|
+
disable use:
|
40
|
+
|
41
|
+
$ lolcommits --config -p term_output
|
42
|
+
# and set enabled to `false`
|
43
|
+
|
44
|
+
## Development
|
45
|
+
|
46
|
+
Check out this repo and run `bin/setup`, this will install all dependencies and
|
47
|
+
generate docs. Use `bundle exec rake` to run all tests and generate a coverage
|
48
|
+
report.
|
49
|
+
|
50
|
+
You can also run `bin/console` for an interactive prompt that will allow you to
|
51
|
+
experiment with the gem code.
|
52
|
+
|
53
|
+
## Tests
|
54
|
+
|
55
|
+
MiniTest is used for testing. Run the test suite with:
|
56
|
+
|
57
|
+
$ rake test
|
58
|
+
|
59
|
+
## Docs
|
60
|
+
|
61
|
+
Generate docs for this gem with:
|
62
|
+
|
63
|
+
$ rake rdoc
|
64
|
+
|
65
|
+
## Troubles?
|
66
|
+
|
67
|
+
If you think something is broken or missing, please raise a new
|
68
|
+
[issue](https://github.com/lolcommits/lolcommits-term_output/issues). Take
|
69
|
+
a moment to check it hasn't been raised in the past (and possibly closed).
|
70
|
+
|
71
|
+
## Contributing
|
72
|
+
|
73
|
+
Bug [reports](https://github.com/lolcommits/lolcommits-term_output/issues) and [pull
|
74
|
+
requests](https://github.com/lolcommits/lolcommits-term_output/pulls) are welcome on
|
75
|
+
GitHub.
|
76
|
+
|
77
|
+
When submitting pull requests, remember to add tests covering any new behaviour,
|
78
|
+
and ensure all tests are passing on [Travis
|
79
|
+
CI](https://travis-ci.org/lolcommits/lolcommits-term_output). Read the
|
80
|
+
[contributing
|
81
|
+
guidelines](https://github.com/lolcommits/lolcommits-term_output/blob/master/CONTRIBUTING.md)
|
82
|
+
for more details.
|
83
|
+
|
84
|
+
This project is intended to be a safe, welcoming space for collaboration, and
|
85
|
+
contributors are expected to adhere to the [Contributor
|
86
|
+
Covenant](http://contributor-covenant.org) code of conduct. See
|
87
|
+
[here](https://github.com/lolcommits/lolcommits-term_output/blob/master/CODE_OF_CONDUCT.md)
|
88
|
+
for more details.
|
89
|
+
|
90
|
+
## License
|
91
|
+
|
92
|
+
The gem is available as open source under the terms of
|
93
|
+
[LGPL-3](https://opensource.org/licenses/LGPL-3.0).
|
94
|
+
|
95
|
+
## Links
|
96
|
+
|
97
|
+
* [Travis CI](https://travis-ci.org/lolcommits/lolcommits-term_output)
|
98
|
+
* [Code Climate](https://codeclimate.com/github/lolcommits/lolcommits-term_output)
|
99
|
+
* [Test Coverage](https://codeclimate.com/github/lolcommits/lolcommits-term_output/coverage)
|
100
|
+
* [RDoc](http://rdoc.info/projects/lolcommits/lolcommits-term_output)
|
101
|
+
* [Issues](http://github.com/lolcommits/lolcommits-term_output/issues)
|
102
|
+
* [Report a bug](http://github.com/lolcommits/lolcommits-term_output/issues/new)
|
103
|
+
* [Gem](http://rubygems.org/gems/lolcommits-term_output)
|
104
|
+
* [GitHub](https://github.com/lolcommits/lolcommits-term_output)
|
data/Rakefile
ADDED
@@ -0,0 +1,31 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
2
|
+
require "rake/testtask"
|
3
|
+
require "rdoc/task"
|
4
|
+
|
5
|
+
# generate docs
|
6
|
+
RDoc::Task.new do |rd|
|
7
|
+
rd.main = "README.md"
|
8
|
+
rd.title = "Lolcommits Term Output"
|
9
|
+
rd.rdoc_dir = "doc"
|
10
|
+
rd.options << "--all"
|
11
|
+
rd.rdoc_files.include("README.md", "LICENSE", "lib/**/*.rb")
|
12
|
+
end
|
13
|
+
|
14
|
+
# run tests
|
15
|
+
Rake::TestTask.new(:test) do |t|
|
16
|
+
t.libs << "test"
|
17
|
+
t.libs << "lib"
|
18
|
+
t.test_files = FileList["test/**/*_test.rb"]
|
19
|
+
end
|
20
|
+
|
21
|
+
# run tests with code coverage (default)
|
22
|
+
namespace :test do
|
23
|
+
desc "Run all tests and features and generate a code coverage report"
|
24
|
+
task :coverage do
|
25
|
+
ENV['COVERAGE'] = 'true'
|
26
|
+
Rake::Task['test'].execute
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
|
31
|
+
task :default => ['test:coverage']
|
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "lolcommits/term_output"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
@@ -0,0 +1,105 @@
|
|
1
|
+
require 'base64'
|
2
|
+
require 'lolcommits/plugin/base'
|
3
|
+
|
4
|
+
module Lolcommits
|
5
|
+
module Plugin
|
6
|
+
class TermOutput < Base
|
7
|
+
|
8
|
+
##
|
9
|
+
# Returns the name of the plugin to identify it to lolcommits.
|
10
|
+
#
|
11
|
+
# @return [String] the plugin name
|
12
|
+
#
|
13
|
+
def self.name
|
14
|
+
'term_output'
|
15
|
+
end
|
16
|
+
|
17
|
+
##
|
18
|
+
# Returns position(s) of when this plugin should run during the capture
|
19
|
+
# process. The image is presented to the terminal when the capture is
|
20
|
+
# ready.
|
21
|
+
#
|
22
|
+
# @return [Array] the position(s) (:capture_ready)
|
23
|
+
#
|
24
|
+
def self.runner_order
|
25
|
+
[:capture_ready]
|
26
|
+
end
|
27
|
+
|
28
|
+
## Prompts the user to configure the plugin's options. The default
|
29
|
+
#superclass method will ask for the `enabled` option to be set.
|
30
|
+
#
|
31
|
+
# @return [Hash] hash of configured options `{ enabled: true/false }`
|
32
|
+
# @return [Nil] if this terminal does not support this plugin
|
33
|
+
#
|
34
|
+
def configure_options!
|
35
|
+
if terminal_supported?
|
36
|
+
super
|
37
|
+
else
|
38
|
+
puts "Sorry, this terminal does not support the #{self.class.name} plugin (requires iTerm2)"
|
39
|
+
nil
|
40
|
+
end
|
41
|
+
end
|
42
|
+
|
43
|
+
##
|
44
|
+
# Post-capture hook, runs after lolcommits captures a snapshot. If the
|
45
|
+
# terminal is supported (and we have commits) the lolcommit image is
|
46
|
+
# rendered inline to the terminal output (with the commit message).
|
47
|
+
#
|
48
|
+
# See here for more details: https://iterm2.com/documentation-images.html
|
49
|
+
#
|
50
|
+
def run_capture_ready
|
51
|
+
if terminal_supported?
|
52
|
+
if !runner.vcs_info || runner.vcs_info.repo.empty?
|
53
|
+
debug 'repo is empty, skipping term output'
|
54
|
+
else
|
55
|
+
base64 = Base64.encode64(open(runner.main_image, &:read).to_s)
|
56
|
+
puts "#{begin_escape}1337;File=inline=1:#{base64};alt=#{runner.message};#{end_escape}\n"
|
57
|
+
end
|
58
|
+
else
|
59
|
+
debug 'Terminal not supported (requires iTerm2)'
|
60
|
+
end
|
61
|
+
end
|
62
|
+
|
63
|
+
private
|
64
|
+
|
65
|
+
##
|
66
|
+
# Generate starting escape character sequence. Terminals running Tmux
|
67
|
+
# sessions require a different escape code.
|
68
|
+
#
|
69
|
+
# @return [String] escape char sequence for inline images
|
70
|
+
#
|
71
|
+
def begin_escape
|
72
|
+
tmux? ? "\033Ptmux;\033\033]" : "\033]"
|
73
|
+
end
|
74
|
+
|
75
|
+
##
|
76
|
+
# Generate ending escape character sequence. Terminals running Tmux
|
77
|
+
# sessions require a different escape code.
|
78
|
+
#
|
79
|
+
# @return [String] escape char sequence for inline images
|
80
|
+
#
|
81
|
+
def end_escape
|
82
|
+
tmux? ? "\a\033\\" : "\a"
|
83
|
+
end
|
84
|
+
|
85
|
+
##
|
86
|
+
# Determine if the terminal is running a Tmux session (checks for the TMUX
|
87
|
+
# env var to be set).
|
88
|
+
#
|
89
|
+
# @return [Boolan] true when running within a Tmux session
|
90
|
+
#
|
91
|
+
def tmux?
|
92
|
+
!ENV['TMUX'].nil?
|
93
|
+
end
|
94
|
+
|
95
|
+
##
|
96
|
+
# Determine if the terminal is supported by this plugin.
|
97
|
+
#
|
98
|
+
# @return [Boolan] true when terminal identifies as iTerm
|
99
|
+
#
|
100
|
+
def terminal_supported?
|
101
|
+
ENV['TERM_PROGRAM'] =~ /iTerm/
|
102
|
+
end
|
103
|
+
end
|
104
|
+
end
|
105
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'lolcommits/term_output/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "lolcommits-term_output"
|
8
|
+
spec.version = Lolcommits::TermOutput::VERSION
|
9
|
+
spec.authors = ["Matthew Hutchinson"]
|
10
|
+
spec.email = ["matt@hiddenloop.com"]
|
11
|
+
spec.summary = "Display lolcommits within your iTerm terminal"
|
12
|
+
spec.description = "Display lolcommits within your iTerm terminal"
|
13
|
+
spec.homepage = "https://github.com/lolcommits/lolcommits-term_output"
|
14
|
+
spec.license = "LGPL-3"
|
15
|
+
|
16
|
+
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
|
17
|
+
# to allow pushing to a single host or delete this section to allow pushing to any host.
|
18
|
+
if spec.respond_to?(:metadata)
|
19
|
+
spec.metadata['allowed_push_host'] = "https://rubygems.org"
|
20
|
+
else
|
21
|
+
raise "RubyGems 2.0 or newer is required to protect against " \
|
22
|
+
"public gem pushes."
|
23
|
+
end
|
24
|
+
|
25
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(assets|test|features)/}) }
|
26
|
+
spec.test_files = `git ls-files -- {test,features}/*`.split("\n")
|
27
|
+
spec.bindir = "bin"
|
28
|
+
spec.executables = []
|
29
|
+
spec.require_paths = ["lib"]
|
30
|
+
|
31
|
+
spec.required_ruby_version = ">= 2.0.0"
|
32
|
+
|
33
|
+
spec.add_development_dependency "lolcommits", ">= 0.9.8"
|
34
|
+
spec.add_development_dependency "bundler"
|
35
|
+
spec.add_development_dependency "webmock"
|
36
|
+
spec.add_development_dependency "pry"
|
37
|
+
spec.add_development_dependency "rake"
|
38
|
+
spec.add_development_dependency "minitest"
|
39
|
+
spec.add_development_dependency "simplecov"
|
40
|
+
end
|
@@ -0,0 +1,135 @@
|
|
1
|
+
require "test_helper"
|
2
|
+
require 'webmock/minitest'
|
3
|
+
|
4
|
+
describe Lolcommits::Plugin::TermOutput do
|
5
|
+
|
6
|
+
include Lolcommits::TestHelpers::GitRepo
|
7
|
+
include Lolcommits::TestHelpers::FakeIO
|
8
|
+
|
9
|
+
# initialize and reset env vars before tests run
|
10
|
+
before do
|
11
|
+
@old_tmux = ENV['TMUX']
|
12
|
+
@old_term_program = ENV['TERM_PROGRAM']
|
13
|
+
ENV['TERM_PROGRAM'] = "iTerm"
|
14
|
+
ENV['TMUX'] = nil
|
15
|
+
end
|
16
|
+
|
17
|
+
after do
|
18
|
+
ENV['TERM_PROGRAM'] = @old_term_program
|
19
|
+
ENV['TMUX'] = @old_tmux
|
20
|
+
end
|
21
|
+
|
22
|
+
def plugin_name
|
23
|
+
"term_output"
|
24
|
+
end
|
25
|
+
|
26
|
+
it "should have a name" do
|
27
|
+
::Lolcommits::Plugin::TermOutput.name.must_equal plugin_name
|
28
|
+
end
|
29
|
+
|
30
|
+
it "should run on capture ready" do
|
31
|
+
::Lolcommits::Plugin::TermOutput.runner_order.must_equal [:capture_ready]
|
32
|
+
end
|
33
|
+
|
34
|
+
describe "with a runner" do
|
35
|
+
def runner
|
36
|
+
# a simple lolcommits runner with an empty configuration Hash
|
37
|
+
@runner ||= Lolcommits::Runner.new(
|
38
|
+
main_image: Tempfile.new('main_image.jpg'),
|
39
|
+
config: OpenStruct.new(
|
40
|
+
read_configuration: {},
|
41
|
+
loldir: File.expand_path("#{__dir__}../../../images")
|
42
|
+
)
|
43
|
+
)
|
44
|
+
end
|
45
|
+
|
46
|
+
def plugin
|
47
|
+
@plugin ||= Lolcommits::Plugin::TermOutput.new(runner: runner)
|
48
|
+
end
|
49
|
+
|
50
|
+
def valid_enabled_config
|
51
|
+
@config ||= OpenStruct.new(
|
52
|
+
read_configuration: { plugin_name => { "enabled" => true } }
|
53
|
+
)
|
54
|
+
end
|
55
|
+
|
56
|
+
describe "#enabled?" do
|
57
|
+
it "is false by default" do
|
58
|
+
plugin.enabled?.must_equal false
|
59
|
+
end
|
60
|
+
|
61
|
+
it "is true when configured" do
|
62
|
+
plugin.config = valid_enabled_config
|
63
|
+
plugin.enabled?.must_equal true
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
67
|
+
describe "run_capture_ready" do
|
68
|
+
before { commit_repo_with_message("first commit!") }
|
69
|
+
after { teardown_repo }
|
70
|
+
|
71
|
+
def check_plugin_output(matching_regex)
|
72
|
+
in_repo do
|
73
|
+
plugin.config = valid_enabled_config
|
74
|
+
output = fake_io_capture { plugin.run_capture_ready }
|
75
|
+
output.must_match matching_regex
|
76
|
+
end
|
77
|
+
end
|
78
|
+
|
79
|
+
it "outputs lolcommits image inline to terminal" do
|
80
|
+
check_plugin_output(/^\e\]1337;File=inline=1\:.*\n;alt=first commit!;\a\n$/)
|
81
|
+
end
|
82
|
+
|
83
|
+
describe "when running in a Tmux session" do
|
84
|
+
before do
|
85
|
+
ENV['TMUX'] = 'true'
|
86
|
+
end
|
87
|
+
|
88
|
+
it "outputs lolcommits image inline to terminal with Tmux escape sequence" do
|
89
|
+
check_plugin_output(/^\ePtmux;\e\e\]1337;File=inline=1\:.*\n;alt=first commit!;\a\e\\\n$/)
|
90
|
+
end
|
91
|
+
end
|
92
|
+
|
93
|
+
describe "when using an unsupported terminal" do
|
94
|
+
before do
|
95
|
+
ENV['TERM_PROGRAM'] = "konsole"
|
96
|
+
end
|
97
|
+
|
98
|
+
it "outputs nothing to the terminal" do
|
99
|
+
check_plugin_output ""
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
describe "configuration" do
|
105
|
+
it "allows plugin options to be configured" do
|
106
|
+
inputs = %w( true ) # enabled option
|
107
|
+
configured_plugin_options = {}
|
108
|
+
|
109
|
+
fake_io_capture(inputs: inputs) do
|
110
|
+
configured_plugin_options = plugin.configure_options!
|
111
|
+
end
|
112
|
+
|
113
|
+
configured_plugin_options.must_equal({ "enabled" => true })
|
114
|
+
end
|
115
|
+
|
116
|
+
describe "when terminal not supported" do
|
117
|
+
before do
|
118
|
+
ENV['TERM_PROGRAM'] = "konsole"
|
119
|
+
end
|
120
|
+
|
121
|
+
it "does not allow options to be configured" do
|
122
|
+
inputs = %w( true ) # enabled option
|
123
|
+
configured_plugin_options = {}
|
124
|
+
|
125
|
+
output = fake_io_capture(inputs: inputs) do
|
126
|
+
configured_plugin_options = plugin.configure_options!
|
127
|
+
end
|
128
|
+
|
129
|
+
assert_nil configured_plugin_options
|
130
|
+
output.must_match(/Sorry, this terminal does not support the term_output plugin/)
|
131
|
+
end
|
132
|
+
end
|
133
|
+
end
|
134
|
+
end
|
135
|
+
end
|
data/test/test_helper.rb
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
|
2
|
+
|
3
|
+
# necessary libs from lolcommits (allowing plugin to run)
|
4
|
+
require 'git'
|
5
|
+
require 'lolcommits/runner'
|
6
|
+
require 'lolcommits/vcs_info'
|
7
|
+
require 'lolcommits/backends/git_info'
|
8
|
+
|
9
|
+
# lolcommit test helpers
|
10
|
+
require 'lolcommits/test_helpers/git_repo'
|
11
|
+
require 'lolcommits/test_helpers/fake_io'
|
12
|
+
|
13
|
+
if ENV['COVERAGE']
|
14
|
+
require 'simplecov'
|
15
|
+
end
|
16
|
+
|
17
|
+
# plugin gem test libs
|
18
|
+
require 'lolcommits/term_output'
|
19
|
+
require 'minitest/autorun'
|
20
|
+
|
21
|
+
# swallow all debug output during test runs
|
22
|
+
def debug(msg); end
|
Binary file
|
metadata
ADDED
@@ -0,0 +1,163 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: lolcommits-term_output
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Matthew Hutchinson
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-12-05 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: lolcommits
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 0.9.8
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 0.9.8
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: webmock
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: pry
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rake
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: minitest
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: simplecov
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
description: Display lolcommits within your iTerm terminal
|
112
|
+
email:
|
113
|
+
- matt@hiddenloop.com
|
114
|
+
executables: []
|
115
|
+
extensions: []
|
116
|
+
extra_rdoc_files: []
|
117
|
+
files:
|
118
|
+
- ".gitignore"
|
119
|
+
- ".simplecov"
|
120
|
+
- ".travis.yml"
|
121
|
+
- CODE_OF_CONDUCT.md
|
122
|
+
- CONTRIBUTING.md
|
123
|
+
- Gemfile
|
124
|
+
- LICENSE
|
125
|
+
- README.md
|
126
|
+
- Rakefile
|
127
|
+
- bin/console
|
128
|
+
- bin/setup
|
129
|
+
- lib/lolcommits/plugin/term_output.rb
|
130
|
+
- lib/lolcommits/term_output.rb
|
131
|
+
- lib/lolcommits/term_output/version.rb
|
132
|
+
- lolcommits-term_output.gemspec
|
133
|
+
- test/lolcommits/plugin/term_output_test.rb
|
134
|
+
- test/test_helper.rb
|
135
|
+
- vendor/fonts/Impact.ttf
|
136
|
+
homepage: https://github.com/lolcommits/lolcommits-term_output
|
137
|
+
licenses:
|
138
|
+
- LGPL-3
|
139
|
+
metadata:
|
140
|
+
allowed_push_host: https://rubygems.org
|
141
|
+
post_install_message:
|
142
|
+
rdoc_options: []
|
143
|
+
require_paths:
|
144
|
+
- lib
|
145
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
146
|
+
requirements:
|
147
|
+
- - ">="
|
148
|
+
- !ruby/object:Gem::Version
|
149
|
+
version: 2.0.0
|
150
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
151
|
+
requirements:
|
152
|
+
- - ">="
|
153
|
+
- !ruby/object:Gem::Version
|
154
|
+
version: '0'
|
155
|
+
requirements: []
|
156
|
+
rubyforge_project:
|
157
|
+
rubygems_version: 2.6.13
|
158
|
+
signing_key:
|
159
|
+
specification_version: 4
|
160
|
+
summary: Display lolcommits within your iTerm terminal
|
161
|
+
test_files:
|
162
|
+
- test/lolcommits/plugin/term_output_test.rb
|
163
|
+
- test/test_helper.rb
|