diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..26d333f --- /dev/null +++ b/.travis.yml @@ -0,0 +1,13 @@ +language: ruby +rvm: + - 1.9.3 + - 2.0.0 + - 2.1 + - 2.2 + +gemfile: + - gemfiles/rails_3.2.gemfile + - gemfiles/rails_4.0.gemfile + - gemfiles/rails_4.1.gemfile + - gemfiles/rails_4.2.gemfile + - gemfiles/mongoid_3.1.gemfile diff --git a/CHANGELOG b/CHANGELOG index 796b116..51e7236 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,15 @@ +1.6.1 (unreleased) + - Running specs on Rails dependencies(ActiveRecord, ActiveSupport, ActionView) +on versions 3.2, 4.0, 4.1 and 4.2 (Mauro George) + - Running specs on mongid 3.0 and 3.1 (Mauro George) + - Remove the Gemfile.lock (Mauro George) + - Move the content from Gemfile to gemspec (Mauro George) + - Make all specs pass on all gemfiles (Mauro George) + - Add Travis (Mauro George) + - Create a CONTRIBUTING file (Mauro George) + - Add badges on the README (Mauro George) + - Add Semantic Version on the README (Mauro George) + 1.6.0 semi-major release since it's been a while, and there are several improvements. @@ -93,7 +105,7 @@ 0.1.3 - Added support for setting custom defaults in ~/.aprc - + 0.1.2 - Correctly handle empty arrays and hashes - Use alias_method instead of alias (fixes non-tty method aliasing) @@ -102,7 +114,7 @@ 0.1.1 - Added support for tableless ActiveRecord models - Left align hash keys if @options[:indent] is negative - + 0.1.0 - Initial Release. - + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c8d01dc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing + +We love pull requests. Here's a quick guide: + +1. Fork the repo. + +1. Create your feature branch (`git checkout -b my-new-feature`) + +1. Update [CHANGELOG.md](https://github.com/michaeldv/awesome_print/blob/master/CHANGELOG.md) with a brief description of your changes under the `unreleased` heading. + +1. Commit your changes (`git commit -am 'Added some feature'`) + +1. Push to the branch (`git push origin my-new-feature`) + +1. Create new Pull Request + +At this point you're waiting on us. We like to at least comment on, if not +accept, pull requests within three business days (and, typically, one business +day). We may suggest some changes or improvements or alternatives. + +Some things that will increase the chance that your pull request is accepted is to follow the practices described on [Ruby style guide](https://github.com/bbatsov/ruby-style-guide), [Rails style guide](https://github.com/bbatsov/rails-style-guide) and [Better Specs](http://betterspecs.org/). + +## Specs + +To run all the specs in all gemfiles just run: + +``` +$ rake +``` + +To run specs of a single gemfile run: + +``` +$ appraisal rails-3.2 rake +``` + +If you want to run a specific spec in a gemfile run: + +``` +$ appraisal rails-3.2 rspec spec/colors_spec.rb +``` diff --git a/README.md b/README.md index d30dbc0..c8e9850 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,12 @@ ## Awesome Print ## +[![RubyGems][gem_version_badge]][ruby_gems] +[![Travis CI][travis_ci_badge]][travis_ci] +[![Code Climate][code_climate_badge]][code_climate] +[![RubyGems][gem_downloads_badge]][ruby_gems] [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/michaeldv/awesome_print?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + Awesome Print is a Ruby library that pretty prints Ruby objects in full color exposing their internal structure with proper indentation. Rails ActiveRecord objects and usage within Rails templates are supported via included mixins. @@ -307,6 +312,10 @@ AwesomePrint.defaults = { } ``` +## Versioning + +AwesomePrint follows the [Semantic Versioning](http://semver.org/) standard. + ### Running Specs ### $ gem install rspec # RSpec 2.x is the requirement. @@ -367,3 +376,11 @@ http://www.dvorkin.net %w(mike dvorkin.net) * "@" || "twitter.com/mid" Released under the MIT license. See LICENSE file for details. + +[gem_version_badge]: https://img.shields.io/gem/v/awesome_print.svg?style=flat +[gem_downloads_badge]: http://img.shields.io/gem/dt/awesome_print.svg?style=flat +[ruby_gems]: http://rubygems.org/gems/awesome_print +[travis_ci]: http://travis-ci.org/michaeldv/awesome_print +[travis_ci_badge]: https://img.shields.io/travis/michaeldv/awesome_print.svg?style=flat +[code_climate]: https://codeclimate.com/github/michaeldv/awesome_print +[code_climate_badge]: http://img.shields.io/codeclimate/github/michaeldv/awesome_print.svg?style=flat