active_model_serializers 0.10.0.rc4 → 0.10.0.rc5

data/CONTRIBUTING.md

@@ -1,187 +1,80 @@
-First of all, **thank you**!
+## Have an issue?
 
-![Commit Strip
-http://www.commitstrip.com/en/2014/05/07/the-truth-behind-open-source-apps/](docs/how-open-source-maintained.jpg)
+Before opening an issue, try the following:
 
-## Common issues and resolutions
+##### Consult the documentation
 
-- Using `grape-active_model_serializers`, or any non-Rails server. See
-    [issue](https://github.com/rails-api/active_model_serializers/issues/1258).
+See if your issue can be resolved by information in the documentation.
 
-## How can I help?
+- [0.10 (master) Documentation](https://github.com/rails-api/active_model_serializers/tree/master/docs)
+  - [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/v0.10.0.rc5)
+  - [Guides](docs)
+- [0.9 (0-9-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-9-stable)
+- [0.8 (0-8-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-8-stable)
 
-- [Filing an issue](CONTRIBUTING.md#filing-an-issue)
-- [Writing code and comments](CONTRIBUTING.md#writing-code-and-comments)
+##### Check for an existing issue
 
-### Filing an issue
+Take a look at the issues to see if a similar one has already been created. If
+one exists, please add any additional information that might expedite
+resolution.
 
-Everyone is encouraged to open issues that are affecting them:
-bugs, ideas, documentation (`/docs`), performance problems – everything helps!
+#### Open an issue
 
-#### Before
+If the documentation wasn't able to help resolve the issue and no issue already
+exists, please open a new issue with the following in mind:
 
-1. Start by looking at our [GitHub Issues](https://github.com/rails-api/active_model_serializers/issues).
+- Please make sure only to include one issue per report. If you encounter
+  multiple, unrelated issues, please report them as such.
+- Be detailed. Provide backtraces and example code when possible. Provide
+  information about your environment. e.g., Ruby version, rails version, etc.
+- Own your issue. Actively participate in the discussion and help drive the
+  issue to closure.
+- If you resolve your own issue, please share the details on the issue and close
+  it out. Others might have the same issue and sharing solutions is helpful.
 
-  - Check if your issue has already been reported.
-  - If you find an existing issue report, feel free to add further information to that report.
+## Contributing
 
-#### Writing
+Contributing can be done in many ways and is not exclusive to code. If you have
+thoughts on a particular issue or feature, we encourage you to open new issues
+for discussion or add your comments to existing ones.
 
-If possible, please include the following information when [reporting an
-issue](https://github.com/rails-api/active_model_serializers/issues/new):
+#### Pull requests
 
-- ActiveModelSerializers version (0.8.x, 0.9.x, 0.10.x, commit ref).
-- What are you using ActiveModelSerializers with? Rails? Grape? Other? Which versions?
-- If you are not running the latest version (please check), and you cannot update it,
-  please specify in your report why you can't update to the latest version.
-- Operating system type + version.
-- Ruby version with patch level.  And whether you're using rvm, rbenv, etc.
-  - Include `ruby -e "puts RUBY_DESCRIPTION"`.
-- Clearly-written steps to reproduce the issue (i.e. "Show me how to show myself." ), including:
-  - What were you doing? Include code if possible.
-    - Command line parameters used, if any.
-    - RubyGems code in your Gemfile, if any. Gemfile.lock, if possible.
-    - Any configuration you've made.
-  - What did you expect to happen?
-  - What happened? Include as much information as possible.
-    - Nature of reported defect (e.g. user name missing, not "It doesn't work."). Is it intermittent?
-    - The best help here is a failing test. Even better if it's a PR.
-    - Then the steps to reproduce and/or a gist or repository that demonstrates the defect.
-    - Then examples of the code you were using.
-    - Any error messages (including stacktrace, i.e. "Show me the error.")
-  - Things you've tried.
-  - A pull request for your fix would be great.  Code should have tests.
-  - Link to source code, if available.
+We also gladly welcome pull requests. When preparing to work on pull request,
+please adhere to these standards:
 
-Please make sure only to include one issue per report.
-If you encounter multiple, unrelated issues, please report them as such.
+- Base work on the master branch unless fixing an issue with
+  [0.9-stable](https://github.com/rails-api/active_model_serializers/tree/0-9-stable)
+  or
+  [0.8-stable](https://github.com/rails-api/active_model_serializers/tree/0-8-stable)
+- Squash your commits and regularly rebase off master.
+- Provide a description of the changes contained in the pull request.
+- Note any specific areas that should be reviewed.
+- Include tests.
+- The test suite must pass on [supported Ruby versions](.travis.yml)
+- Include updates to the [documentation](https://github.com/rails-api/active_model_serializers/tree/master/docs)
+  where applicable.
+- Update the
+  [CHANGELOG](https://github.com/rails-api/active_model_serializers/blob/master/CHANGELOG.md)
+  to the appropriate sections with a brief description of the changes.
+- Do not change the VERSION file.
 
-Simon Tatham has written an excellent on article on
-[How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html)
-which is [well worth reading](http://yourbugreportneedsmore.info/), although it is not specific to ActiveModelSerializers.
+#### Running tests
 
-Include as much sample code as you can to help us reproduce the issue. (Inline, repo link, or gist, are fine. A failing test would help the most.)
+Run all tests
 
-This is extremely important for narrowing down the cause of your problem.
+`$ rake test`
 
-Thanks!
+Run a single test suite
 
-Sometimes an issue will be closed by a maintainer for various reasons.  In some cases, this is
-an invitation to make a better case for your issue or be able to reproduce a bug, and
-its being close is just an opportunity to help out some more, and then re-open.
-
-#### After
-
-Thanks to everyone involved!
-
-If you get help, sharing it back in the form of a pull-request or making an issue to document
-what you've found is *extremely* helpful.
-
-If you solve your issue, stop working on it, or realize the problem was something else,
-please share that in a comment to an issue and close it.  That way, everyone can learn and
-we don't have closed issues without a clear resolution. Even if it's just a stackoverflow link :)
-And please don't forget to stay involved in the issue until it is closed! Thanks to all!
-
-### Writing code and comments
-
-- We are actively working to identify tasks under the label [**Good for New
-  Contributors**](https://github.com/rails-api/active_model_serializers/labels/Good%20for%20New%20Contributors).
-  - [Changelog
-      Missing](https://github.com/rails-api/active_model_serializers/issues?q=label%3A%22Changelog+Missing%22+is%3Aclosed) is
-    an easy way to help out.
-
-- [Fix a bug](https://github.com/rails-api/active_model_serializers/labels/Ready%20for%20PR).
-  - Ready for PR - A well defined bug, needs someone to PR a fix.
-  - Bug - Anything that is broken.
-  - Regression - A bug that did not exist in previous versions and isn't a new feature (applied in tandem with Bug).
-  - Performance - A performance related issue. We could track this as a bug, but usually these would have slightly lower priority than standard bugs.
-
-- [Develop new features](https://github.com/rails-api/active_model_serializers/labels/Feature).
-
-- [Improve code quality](https://codeclimate.com/github/rails-api/active_model_serializers/code?sort=smell_count&sort_direction=desc).
-
-- [Improve amount of code exercised by tests](https://codeclimate.com/github/rails-api/active_model_serializers/coverage?sort=covered_percent&sort_direction=asc).
-
-- [Fix RuboCop (Style) TODOS](https://github.com/rails-api/active_model_serializers/blob/master/.rubocop_todo.yml).
-  - Delete and offsense, run `rake rubocop` (or possibly `rake rubocop:auto_correct`),
-    and [submit a PR](CONTRIBUTING.md#submitting-a-pull-request-pr).
-
-- We are also encouraging comments to substantial changes (larger than bugfixes and simple features) under an
-  "RFC" (Request for Comments) process before we start active development.
-   Look for the [**RFC**](https://github.com/rails-api/active_model_serializers/labels/RFC) label.
-
-#### Submitting a pull request (PR)
-
-1. The vast majority of development is happening under the `master` branch.
-  This is where we would suggest you start.
-1. Fixing bugs is extraordinarily helpful and requires the least familiarity with ActiveModelSerializers.
-  Look for issues labeled [**Needs Bug Verification**](https://github.com/rails-api/active_model_serializers/labels/Needs%20Bug%20Verification) and [**Bug**](https://github.com/rails-api/active_model_serializers/labels/bug).
-1. Adding or fixing documentation is also fantastic!
-
-To fetch & test the library for development, do:
-
-1. Fork the repository ( https://github.com/rails-api/active_model_serializers/fork )
-1. `git clone https://github.com/{whoami}/active_model_serializers.git`
-1. `cd active_model_serializers`
-1. `bundle`
-  - To test against a particular rails version-- 4.0 is usually the most buggy-- set then
-      RAILS_VERSION environment variable as described in the [.travis.yml](.travis.yml).
-      e.g. `export RAILS_VERSION=4.0`.
-1. Create your PR branch (`git checkout -b my-helpful-pr`)
-1. Write tests for your feature, or regression tests highlighting a bug.
-  This is important so ActiveModelSerializers doesn't break it in a future version unintentionally.
-1. Write the feature itself, or fix your bug
-1. `bundle exec rake`
-1. Commit your changes (`git commit -am 'Add some feature'`)
-  - Use well-described, small (atomic) commits.
-1. Push to the branch (`git push origin my-helpful-pr`)
-1. Create a new Pull Request
-  - Include links to any relevant github issues.
-  - *Don't* change the VERSION file.
-  - Update `/docs` to include, whenever possible, a new, suitable recommendation about how to use
-    the feature.
-  - Extra Credit: [Confirm it runs and tests pass on the rubies specified in the travis
-    config](.travis.yml). A maintainer will otherwise confirm it runs on these.
-
-1. *Bonus Points* Update [CHANGELOG.md](https://github.com/rails-api/active_model_serializers/blob/master/CHANGELOG.md)
-  with a brief description of any breaking changes, fixes, features, or
-  miscellaneous changes under the proper version section.
-1. Iterate on feedback given by the community (fix syntax, modify bits of code, add
-tests), pushing the new commits to the PR each time
-
-Remember to [squash your commits](CONTRIBUTING.md#about-pull-requests-prs) and rebase off `master`.
-
-#### How maintainers handle pull requests:
-
-- If the tests pass and the pull request looks good, a maintainer will merge it.
-- If the pull request needs to be changed,
-  - you can change it by updating the branch you generated the pull request from
-    - either by adding more commits, or
-    - by force pushing to it
-  - A maintainer can make any changes themselves and manually merge the code in.
-
-#### Commit Messages
-
-- [A Note About Git Commit Messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
-- [http://stopwritingramblingcommitmessages.com/](http://stopwritingramblingcommitmessages.com/)
-- [ThoughtBot style guide](https://github.com/thoughtbot/guides/tree/master/style#git)
-
-#### About Pull Requests (PR's)
+`$ rake test TEST=path/to/test.rb`
 
-- [Using Pull Requests](https://help.github.com/articles/using-pull-requests)
-- [Github pull requests made easy](http://www.element84.com/github-pull-requests-made-easy.html)
-- [Exercism Git Workflow](http://help.exercism.io/git-workflow.html).
-- [Level up your Git](http://rakeroutes.com/blog/deliberate-git/)
-- [All Your Open Source Code Are Belong To Us](http://www.benjaminfleischer.com/2013/07/30/all-your-open-source-code-are-belong-to-us/)
+Run a single test
 
-## Issue Labeling
-
-ActiveModelSerializers uses a subset of [StandardIssueLabels](https://github.com/wagenet/StandardIssueLabels) for Github Issues. You can [see our labels here](https://github.com/rails-api/active_model_serializers/labels).
-
-## Running tests
+`$ rake test TEST=path/to/test.rb TESTOPTS="--name=test_something"`
 
 Run tests against different Rails versions by setting the RAILS_VERSION variable
-and bundling gems.  To test against all versions, you can do something like:
+and bundling gems.
 
 ```bash
 for version in 4.0 4.1 4.2 master; do
@@ -200,21 +93,3 @@ for version in 4.0 4.1 4.2 master; do
 done
 ```
 
-
-### Running with Rake
-
-The easiest way to run the unit tests is through Rake. The default task runs
-the entire test suite for all classes. For more information, checkout the
-full array of rake tasks with "rake -T"
-
-Rake can be found at http://docs.seattlerb.org/rake/.
-
-To run a single test suite
-
-`$ rake test TEST=path/to/test.rb`
-
-Which can be further narrowed down to one test:
-
-`$ rake test TEST=path/to/test.rb TESTOPTS="--name=test_something"`
-
-:heart: :sparkling_heart: :heart:

data/Gemfile

@@ -36,14 +36,19 @@ end
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem 'tzinfo-data', platforms: (@windows_platforms + [:jruby])
 
+group :bench do
+  # https://github.com/rails-api/active_model_serializers/commit/cb4459580a6f4f37f629bf3185a5224c8624ca76
+  gem 'benchmark-ips', require: false, group: :development
+end
+
 group :test do
   gem 'sqlite3',                          platform: (@windows_platforms + [:ruby])
   gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
 
   gem 'codeclimate-test-reporter', require: false
-  gem 'simplecov', '~> 0.10', require: false, group: :development
 end
 
 group :development, :test do
-  gem 'rubocop', '~> 0.34.0', require: false
+  gem 'rubocop', '~> 0.36', require: false
+  gem 'yard', require: false
 end

data/README.md

@@ -1,17 +1,39 @@
 # ActiveModelSerializers
 
-[![Build Status](https://travis-ci.org/rails-api/active_model_serializers.svg?branch=master)](https://travis-ci.org/rails-api/active_model_serializers)
-(Windows: [![Build status](https://ci.appveyor.com/api/projects/status/x6xdjydutm54gvyt/branch/master?svg=true)](https://ci.appveyor.com/project/joaomdmoura/active-model-serializers/branch/master))
-[![Code Quality](https://codeclimate.com/github/rails-api/active_model_serializers/badges/gpa.svg)](https://codeclimate.com/github/rails-api/active_model_serializers)
-[![Test Coverage](https://codeclimate.com/github/rails-api/active_model_serializers/badges/coverage.svg)](https://codeclimate.com/github/rails-api/active_model_serializers/coverage)
+<table>
+  <tr>
+    <td>Build Status</td>
+    <td>
+      <a href="https://travis-ci.org/rails-api/active_model_serializers"><img src="https://travis-ci.org/rails-api/active_model_serializers.svg?branch=master" alt="Build Status" ></a>
+      <a href="https://ci.appveyor.com/project/joaomdmoura/active-model-serializers/branch/master"><img src="https://ci.appveyor.com/api/projects/status/x6xdjydutm54gvyt/branch/master?svg=true" alt="Build status"></a>
+    </td>
+  </tr>
+  <tr>
+    <td>Code Quality</td>
+    <td>
+      <a href="https://codeclimate.com/github/rails-api/active_model_serializers"><img src="https://codeclimate.com/github/rails-api/active_model_serializers/badges/gpa.svg" alt="Code Quality"></a>
+      <a href="https://codebeat.co/projects/github-com-rails-api-active_model_serializers"><img src="https://codebeat.co/badges/a9ab35fa-8b5a-4680-9d4e-a81f9a55ebcd" alt="codebeat" ></a>
+      <a href="https://codeclimate.com/github/rails-api/active_model_serializers/coverage"><img src="https://codeclimate.com/github/rails-api/active_model_serializers/badges/coverage.svg" alt="Test Coverage"></a>
+    </td>
+  </tr>
+  <tr>
+    <td>Issue Stats</td>
+    <td>
+      <a href="https://github.com/rails-api/active_model_serializers/pulse/monthly">Pulse</a>
+    </td>
+  </tr>
+</table>
+
 
 ## Documentation
 
 - [0.10 (master) Documentation](https://github.com/rails-api/active_model_serializers/tree/master)
-  - [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers)
+  - [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/v0.10.0.rc5)
   - [Guides](docs)
 - [0.9 (0-9-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-9-stable)
+  - [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/0-9-stable)
 - [0.8 (0-8-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-8-stable)
+  - [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/0-8-stable)
 
 ## About
 

data/Rakefile

@@ -1,9 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
 begin
   require 'simplecov'
 rescue LoadError
 end
 
-require 'bundler/gem_tasks'
+Bundler::GemHelper.install_tasks
+
+require 'yard'
+
+namespace :yard do
+  YARD::Rake::YardocTask.new(:doc) do |t|
+    t.stats_options = ['--list-undoc']
+  end
+
+  desc 'start a gem server'
+  task :server do
+    sh 'bundle exec yard server --gems'
+  end
+
+  desc 'use Graphviz to generate dot graph'
+  task :graph do
+    output_file = 'doc/erd.dot'
+    sh "bundle exec yard graph --protected --full --dependencies > #{output_file}"
+    puts 'open doc/erd.dot if you have graphviz installed'
+  end
+end
 
 begin
   require 'rubocop'
@@ -37,30 +62,33 @@ end
 
 require 'rake/testtask'
 
-Rake::TestTask.new do |t|
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
   t.libs << 'test'
-  t.test_files = FileList['test/**/*_test.rb']
+  t.pattern = 'test/**/*_test.rb'
   t.ruby_opts = ['-r./test/test_helper.rb']
+  t.ruby_opts << ' -w' unless ENV['NO_WARN'] == 'true'
   t.verbose = true
 end
 
 desc 'Run isolated tests'
-task isolated: ['test:isolated:railtie']
+task isolated: ['test:isolated']
 namespace :test do
-  namespace :isolated do
+  task :isolated do
     desc 'Run isolated tests for Railtie'
-    task :railtie do
-      dir = File.dirname(__FILE__)
-      file = "#{dir}/test/active_model_serializers/railtie_test_isolated.rb"
-
-      # https://github.com/rails/rails/blob/3d590add45/railties/lib/rails/generators/app_base.rb#L345-L363
-      _bundle_command = Gem.bin_path('bundler', 'bundle')
-      require 'bundler'
-      Bundler.with_clean_env do
-        command = "-w -I#{dir}/lib -I#{dir}/test #{file}"
+    require 'shellwords'
+    dir = File.dirname(__FILE__)
+    dir = Shellwords.shellescape(dir)
+    isolated_test_files = FileList['test/**/*_test_isolated.rb']
+    # https://github.com/rails/rails/blob/3d590add45/railties/lib/rails/generators/app_base.rb#L345-L363
+    _bundle_command = Gem.bin_path('bundler', 'bundle')
+    require 'bundler'
+    Bundler.with_clean_env do
+      isolated_test_files.all? do |test_file|
+        command = "-w -I#{dir}/lib -I#{dir}/test #{Shellwords.shellescape(test_file)}"
         full_command = %("#{Gem.ruby}" #{command})
-        system(full_command) or fail 'Failures' # rubocop:disable Style/AndOr
-      end
+        system(full_command)
+      end or fail 'Failures' # rubocop:disable Style/AndOr
     end
   end
 end

data/active_model_serializers.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0")
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
+  spec.executables   = []
 
   spec.required_ruby_version = '>= 2.0.0'
 
@@ -51,8 +52,15 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'will_paginate', '~> 3.0', '>= 3.0.7'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
   spec.add_development_dependency 'timecop', '~> 0.7'
-  spec.add_development_dependency 'minitest-reporters'
   spec.add_development_dependency 'grape', ['>= 0.13', '< 1.0']
   spec.add_development_dependency 'json_schema'
+  spec.add_development_dependency 'rake', ['>= 10.0', '< 12.0']
+
+  spec.post_install_message = <<-EOF
+NOTE: The default key case for the JsonApi adapter has changed to dashed.
+See https://github.com/rails-api/active_model_serializers/blob/master/docs/general/key_transform.md
+for more information on configuring this behavior.
+EOF
 end

data/appveyor.yml

@@ -8,6 +8,7 @@ environment:
     - ruby_version: "200-x64"
     - ruby_version: "21"
     - ruby_version: "21-x64"
+    - ruby_version: "jruby-9.0.4.0"
 
 cache:
   - vendor/bundle