Skip to content

Commit

Permalink
diff-lcs 1.3
Browse files Browse the repository at this point in the history
- Updated testing and gem infrastructure.
- Cleaning up documentation.
- Modernizing specs.
- Silence Ruby 2.4 Fixnum deprecation warnings. Fixes #36, #38.
- Ensure test dependencies are loaded. Fixes #33, #34 so that specs can be run
  independently.
- Fix issue #1 with incorrect intuition of patch direction. Tentative fix, but
  the failure cases pass now.
  • Loading branch information
halostatue committed Jan 18, 2017
1 parent 32727d6 commit 06ee20e
Show file tree
Hide file tree
Showing 31 changed files with 1,007 additions and 743 deletions.
10 changes: 4 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
Gemfile.lock
spec/ldap.yml
.rvmrc
pkg/
*.pyc
*.rbc
*.swp
*~
.DS_Store
.rake_tasks~
.rvmrc
.source_index
Gemfile.lock
coverage.info
coverage.vim
coverage/
doc/
html/
pkg/
publish/
research/
spec/ldap.yml
website/index.html
pkg/
publish/
.byebug_history
45 changes: 44 additions & 1 deletion .hoerc
Original file line number Diff line number Diff line change
@@ -1,2 +1,45 @@
---
exclude: !ruby/regexp /(tmp|swp)$|CVS|TAGS|\.(svn|git|hg|DS_Store|idea)|Gemfile\.lock|research\/|\.gemspec$/
exclude: !ruby/regexp '/
\.(?:
tmp |
swp
)$
|
\.(?:
autotest |
byebug_history |
gemtest |
gitignore |
hoerc |
minitest.rb |
simplecov-prelude.rb)$
|
\.(?:
coveralls |
pullreview |
travis |
appveyor
)\.yml$
|
(?i:TAGS)$
|
\.(?:
DS_Store|
bundle|
git|
hg|
idea|
svn|
vagrant
)\/
|
[gG]emfile(?:\.lock)?
|
support\/
|
research\/
|
\.gemspec$
|
Vagrantfile
/x'
1 change: 0 additions & 1 deletion .rspec
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
--colour
--format documentation
33 changes: 15 additions & 18 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,35 +1,32 @@
---
language: ruby
rvm:
- 2.1.0
- 2.4.0
- 2.3.3
- 2.2.6
- 2.1.9
- 2.0.0
- 1.9.3
- 1.9.2
- ruby-head
- jruby-19mode
- jruby-head
- rbx
- 1.8.7
- jruby-18mode
- ree
- ruby-head
- jruby-19mode
matrix:
allow_failures:
- rvm: rbx
- rvm: ruby-head
- rvm: 1.8.7
- rvm: ree
gemfile:
- Gemfile
before_script:
- |
case "${TRAVIS_RUBY_VERSION}" in
rbx*)
gem install psych
gem install -v '~> 2.0' rubysl
;;
esac
- rake travis:before -t
script: rake travis
- bundle exec rake travis:before -t
script: bundle exec rake travis
after_script:
- rake travis:after -t
- bundle exec rake travis:after -t
notifications:
email:
recipients:
- [email protected]
on_success: change
on_failure: always
sudo: false
74 changes: 74 additions & 0 deletions Code-of-Conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
83 changes: 83 additions & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
## Contributing

I value any contribution to Diff::LCS you can provide: a bug report, a feature
request, or code contributions. Code contributions to Diff::LCS are especially
<del>welcome</del>encouraged. Because Diff::LCS is a complex codebase, there
are a few guidelines:

* Code changes *will not* be accepted without tests. The test suite is
written with [RSpec][].
* 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

Diff::LCS 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 spec
$ rake travis

will do.

To assist with the installation of the development dependencies, I have
provided a Gemfile pointing to the (generated) `diff-lcs.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 spec: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>/diff-lcs.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/diff-lcs and describe what your
change does and the why you think it should be merged.

### Contributors

* Austin Ziegler created Diff::LCS.

Thanks to everyone else who has contributed to Diff::LCS:

* Kenichi Kamiya
* Michael Granger
* Vít Ondruch
* Jon Rowe
* Koichi Ito
* Josef Strzibny
* Josh Bronson
* Mark Friedgan

[Rspec]: http://rspec.info/documentation/
[quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[Hoe]: https://github.com/seattlerb/hoe
64 changes: 0 additions & 64 deletions Contributing.rdoc

This file was deleted.

23 changes: 11 additions & 12 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
# -*- ruby -*-

# DO NOT EDIT THIS FILE. Instead, edit Rakefile, and run `rake bundler:gemfile`.
# NOTE: This file is present to keep Travis CI happy. Edits to it will not
# be accepted.

source "https://rubygems.org/"

if RUBY_VERSION < '1.9'
gem 'rdoc', '< 4.0'
elsif RUBY_VERSION >= '2.0'
if RUBY_ENGINE == 'ruby'
gem 'simplecov', '~> 0.7'
gem 'coveralls', '~> 0.7'
end
end

gem "rubyforge", ">=2.0.4", :group => [:development, :test]
gem "rdoc", "~>4.0", :group => [:development, :test]
gem "hoe-bundler", "~>1.2", :group => [:development, :test]
gem "hoe-doofus", "~>1.0", :group => [:development, :test]
gem "hoe-gemspec2", "~>1.1", :group => [:development, :test]
gem "hoe-git", "~>1.5", :group => [:development, :test]
gem "hoe-rubygems", "~>1.0", :group => [:development, :test]
gem "hoe-travis", "~>1.2", :group => [:development, :test]
gem "rake", "~>10.0", :group => [:development, :test]
gem "rspec", "~>2.0", :group => [:development, :test]
gem "hoe", "~>3.7", :group => [:development, :test]
gemspec

# vim: syntax=ruby
Loading

0 comments on commit 06ee20e

Please sign in to comment.