-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
31 changed files
with
1,371 additions
and
878 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,3 +12,5 @@ html | |
pkg | ||
publish | ||
test/cache.tst | ||
tmp/ | ||
.byebug_history |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,42 @@ | ||
--- | ||
exclude: !ruby/regexp '/ | ||
\.(tmp|swp)$ | ||
| | ||
CVS/ | ||
| | ||
(?i:TAGS) | ||
| | ||
\.(svn|git|hg|DS_Store|idea|vagrant)\/ | ||
| | ||
Gemfile(?:\.lock)? | ||
| | ||
type-lists\/ | ||
| | ||
\.(coveralls|pullreview|travis).yml$ | ||
| | ||
\.gemspec | ||
\.(?: | ||
tmp | | ||
swp | ||
)$ | ||
| | ||
\.(?: | ||
autotest | | ||
byebug_history | | ||
gemtest | | ||
gitignore | | ||
hoerc | | ||
simplecov-prelude.rb | ||
)$ | ||
| | ||
(?: | ||
appveyor | | ||
coveralls | | ||
pullreview | | ||
rubocop | | ||
travis | ||
)\.yml$ | ||
| | ||
\b(?i:TAGS)$ | ||
| | ||
\.(?: | ||
DS_Store | | ||
bundle | | ||
git | | ||
hg | | ||
idea | | ||
svn | | ||
vagrant | ||
)\/ | ||
| | ||
[gG]emfile(?:\.lock)? | ||
| | ||
\.gemspec$ | ||
| | ||
Vagrantfile | ||
/x' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
--- | ||
AllCops: | ||
DisplayCopNames: true | ||
DisplayStyleGuide: true | ||
ExtraDetails: true | ||
Exclude: | ||
- '*.gemspec' | ||
|
||
Style/AlignHash: | ||
EnforcedColonStyle: key | ||
EnforcedHashRocketStyle: key | ||
EnforcedLastArgumentHashStyle: enforce_implicit | ||
|
||
Style/AlignParameters: | ||
EnforcedStyle: with_fixed_indentation | ||
|
||
Style/AndOr: | ||
Enabled: false | ||
|
||
Style/AsciiComments: | ||
Enabled: false | ||
|
||
Style/AsciiIdentifiers: | ||
Enabled: false | ||
|
||
Style/BarePercentLiterals: | ||
EnforcedStyle: percent_q | ||
|
||
Style/BlockDelimiters: | ||
EnforcedStyle: semantic | ||
IgnoredMethods: | ||
- assert_raises | ||
ProceduralMethods: | ||
- spec | ||
|
||
Style/BracesAroundHashParameters: | ||
EnforcedStyle: context_dependent | ||
|
||
Style/ClassAndModuleChildren: | ||
Enabled: false | ||
|
||
Style/ClassCheck: | ||
EnforcedStyle: kind_of? | ||
|
||
Style/CommandLiteral: | ||
EnforcedStyle: percent_x | ||
|
||
Style/CommentAnnotation: | ||
Enabled: true | ||
|
||
Style/Copyright: | ||
Enabled: false | ||
|
||
Style/DotPosition: | ||
EnforcedStyle: trailing | ||
|
||
Style/DoubleNegation: | ||
Enabled: false | ||
|
||
Style/Encoding: # For a gem that is using Ruby 1.9, change this to true. | ||
Enabled: false | ||
|
||
Style/FileName: | ||
Exclude: | ||
- lib/archive-tar-minitar.rb | ||
|
||
Style/FormatString: | ||
EnforcedStyle: percent | ||
|
||
# minitar supports Ruby 1.8, still. Old-style symbol hash literals are | ||
# required. | ||
Style/HashSyntax: | ||
Enabled: false | ||
|
||
# minitar supports Ruby 1.8, still. Old-style symbol lambdas are required. | ||
Style/Lambda: | ||
Enabled: false | ||
|
||
Style/MultilineBlockChain: | ||
Enabled: false | ||
|
||
Style/MultilineOperationIndentation: | ||
EnforcedStyle: indented | ||
|
||
Style/ParallelAssignment: | ||
Enabled: false | ||
|
||
Style/RegexpLiteral: | ||
Enabled: false | ||
|
||
Style/SpaceInsideBrackets: | ||
Enabled: false | ||
|
||
Style/UnneededPercentQ: | ||
Enabled: false | ||
|
||
# This is one of the hobgoblins. | ||
Metrics/AbcSize: | ||
Enabled: false | ||
|
||
Metrics/BlockLength: | ||
Enabled: false | ||
|
||
# This is one of the hobgoblins. | ||
Metrics/ClassLength: | ||
Enabled: false | ||
|
||
Metrics/CyclomaticComplexity: | ||
Enabled: false | ||
|
||
Metrics/LineLength: | ||
Exclude: | ||
- Rakefile | ||
- test/**/* | ||
|
||
# This is one of the hobgoblins. | ||
Metrics/MethodLength: | ||
Enabled: false | ||
|
||
Metrics/ModuleLength: | ||
Enabled: false | ||
|
||
Metrics/PerceivedComplexity: | ||
Enabled: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
require 'psych' if ENV['CI'] | ||
require 'simplecov' | ||
|
||
if ENV['CI'] | ||
require 'coveralls' | ||
SimpleCov.formatter = Coveralls::SimpleCov::Formatter | ||
end | ||
|
||
SimpleCov.start do | ||
command_name 'Minitest' | ||
end | ||
|
||
gem 'minitest' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
## Contributing | ||
|
||
I value any contribution to minitar-cli you can provide: a bug report, a | ||
feature request, or code contributions. There are a few guidelines for | ||
contributing to minitar: | ||
|
||
* Code changes *will not* be accepted without tests. The test suite is | ||
written with [Minitest][]. | ||
* Match my coding style. | ||
* Use a thoughtfully-named topic branch that contains your change. Rebase | ||
your commits into logical chunks as necessary. | ||
* Use [quality commit messages][]. | ||
* Do not change the version number; when your patch is accepted and a release | ||
is made, the version will be updated at that point. | ||
* Submit a GitHub pull request with your changes. | ||
* New or changed behaviours require appropriate documentation. | ||
|
||
### Test Dependencies | ||
|
||
minitar-cli uses Ryan Davis’s [Hoe][] to manage the release process, and it | ||
adds a number of rake tasks. You will mostly be interested in: | ||
|
||
$ rake | ||
|
||
which runs the tests the same way that: | ||
|
||
$ rake test | ||
$ rake travis | ||
|
||
will do. | ||
|
||
To assist with the installation of the development dependencies for | ||
minitar-cli, I have provided the simplest possible Gemfile pointing to the | ||
(generated) `minitar-cli.gemspec` file. This will permit you to do: | ||
|
||
$ bundle install | ||
|
||
to get the development dependencies. If you aleady have `hoe` installed, you | ||
can accomplish the same thing with: | ||
|
||
$ rake newb | ||
|
||
This task will install any missing dependencies, run the tests/specs, and | ||
generate the RDoc. | ||
|
||
You can run tests with code coverage analysis by running: | ||
|
||
$ rake test:coverage | ||
|
||
### Workflow | ||
|
||
Here's the most direct way to get your work merged into the project: | ||
|
||
* Fork the project. | ||
* Clone down your fork (`git clone git://github.com/<username>/minitar-cli.git`). | ||
* Create a topic branch to contain your change (`git checkout -b | ||
my_awesome_feature`). | ||
* Hack away, add tests. Not necessarily in that order. | ||
* Make sure everything still passes by running `rake`. | ||
* If necessary, rebase your commits into logical chunks, without errors. | ||
* Push the branch up (`git push origin my_awesome_feature`). | ||
* Create a pull request against halostatue/minitar-cli and describe what your | ||
change does and the why you think it should be merged. | ||
|
||
### Contributors | ||
|
||
* Austin Ziegler created minitar-cli, extracted from Archive::Tar::Minitar. | ||
|
||
[Minitest]: https://github.com/seattlerb/minitest | ||
[quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html | ||
[Hoe]: https://github.com/seattlerb/hoe |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.