active_model_serializers 0.10.6 → 0.10.13

data/bin/bench

@@ -1,171 +0,0 @@
-#!/usr/bin/env ruby
-# ActiveModelSerializers Benchmark driver
-# Adapted from
-# https://github.com/ruby-bench/ruby-bench-suite/blob/8ad567f7e43a044ae48c36833218423bb1e2bd9d/rails/benchmarks/driver.rb
-require 'bundler'
-Bundler.setup
-require 'json'
-require 'pathname'
-require 'optparse'
-require 'digest'
-require 'pathname'
-require 'shellwords'
-require 'logger'
-require 'English'
-
-class BenchmarkDriver
-  ROOT = Pathname File.expand_path(File.join('..', '..'), __FILE__)
-  BASE = ENV.fetch('BASE') { ROOT.join('test', 'benchmark') }
-  ESCAPED_BASE = Shellwords.shellescape(BASE)
-
-  def self.benchmark(options)
-    new(options).run
-  end
-
-  def self.parse_argv_and_run(argv = ARGV, options = {})
-    options = {
-      repeat_count: 1,
-      pattern: [],
-      env: 'CACHE_ON=on'
-    }.merge!(options)
-
-    OptionParser.new do |opts|
-      opts.banner = 'Usage: bin/bench [options]'
-
-      opts.on('-r', '--repeat-count [NUM]', 'Run benchmarks [NUM] times taking the best result') do |value|
-        options[:repeat_count] = value.to_i
-      end
-
-      opts.on('-p', '--pattern <PATTERN1,PATTERN2,PATTERN3>', 'Benchmark name pattern') do |value|
-        options[:pattern] = value.split(',')
-      end
-
-      opts.on('-e', '--env <var1=val1,var2=val2,var3=vale>', 'ENV variables to pass in') do |value|
-        options[:env] = value.split(',')
-      end
-    end.parse!(argv)
-
-    benchmark(options)
-  end
-
-  attr_reader :commit_hash, :base
-
-  # Based on logfmt:
-  # https://www.brandur.org/logfmt
-  # For more complete implementation see:
-  # see https://github.com/arachnid-cb/logfmtr/blob/master/lib/logfmtr/base.rb
-  # For usage see:
-  # https://blog.codeship.com/logfmt-a-log-format-thats-easy-to-read-and-write/
-  # https://engineering.heroku.com/blogs/2014-09-05-hutils-explore-your-structured-data-logs/
-  # For Ruby parser see:
-  # https://github.com/cyberdelia/logfmt-ruby
-  def self.summary_logger(device = 'output.txt')
-    require 'time'
-    logger = Logger.new(device)
-    logger.level = Logger::INFO
-    logger.formatter = proc { |severity, datetime, progname, msg|
-      msg = "'#{msg}'"
-      "level=#{severity} time=#{datetime.utc.iso8601(6)} pid=#{Process.pid} progname=#{progname} msg=#{msg}#{$INPUT_RECORD_SEPARATOR}"
-    }
-    logger
-  end
-
-  def self.stdout_logger
-    logger = Logger.new(STDOUT)
-    logger.level = Logger::INFO
-    logger.formatter = proc { |_, _, _, msg| "#{msg}#{$INPUT_RECORD_SEPARATOR}" }
-    logger
-  end
-
-  def initialize(options)
-    @writer       = ENV['SUMMARIZE'] ? self.class.summary_logger : self.class.stdout_logger
-    @repeat_count = options[:repeat_count]
-    @pattern      = options[:pattern]
-    @commit_hash  = options.fetch(:commit_hash) { `git rev-parse --short HEAD`.chomp }
-    @base         = options.fetch(:base) { ESCAPED_BASE }
-    @env          = Array(options[:env]).join(' ')
-    @rubyopt = options[:rubyopt] # TODO: rename
-  end
-
-  def run
-    files.each do |path|
-      next if !@pattern.empty? && /#{@pattern.join('|')}/ !~ File.basename(path)
-      run_single(Shellwords.shellescape(path))
-    end
-  end
-
-  private
-
-  def files
-    Dir[File.join(base, 'bm_*')]
-  end
-
-  def run_single(path)
-    script = "RAILS_ENV=production #{@env} ruby #{@rubyopt} #{path}"
-    environment = `ruby -v`.chomp.strip[/\d+\.\d+\.\d+\w+/]
-
-    runs_output = measure(script)
-    if runs_output.empty?
-      results = { error: :no_results }
-      return
-    end
-
-    results = {}
-    results['commit_hash'] = commit_hash
-    results['version'] = runs_output.first['version']
-    results['rails_version'] = runs_output.first['rails_version']
-    results['benchmark_run[environment]'] = environment
-    results['runs'] = []
-
-    runs_output.each do |output|
-      results['runs'] << {
-        'benchmark_type[category]' => output['label'],
-        'benchmark_run[result][iterations_per_second]' => output['iterations_per_second'].round(3),
-        'benchmark_run[result][total_allocated_objects_per_iteration]' => output['total_allocated_objects_per_iteration']
-      }
-    end
-  ensure
-    results && report(results)
-  end
-
-  def report(results)
-    @writer.info { 'Benchmark results:' }
-    @writer.info { JSON.pretty_generate(results) }
-  end
-
-  def summarize(result)
-    puts "#{result['label']} #{result['iterations_per_second']}/ips; #{result['total_allocated_objects_per_iteration']} objects"
-  end
-
-  # FIXME: ` provides the full output but it'll return failed output as well.
-  def measure(script)
-    results = Hash.new { |h, k| h[k] = [] }
-
-    @repeat_count.times do
-      output = sh(script)
-      output.each_line do |line|
-        next if line.nil?
-        begin
-          result = JSON.parse(line)
-        rescue JSON::ParserError
-          result = { error: line } # rubocop:disable Lint/UselessAssignment
-        else
-          summarize(result)
-          results[result['label']] << result
-        end
-      end
-    end
-
-    results.map do |_, bm_runs|
-      bm_runs.sort_by do |run|
-        run['iterations_per_second']
-      end.last
-    end
-  end
-
-  def sh(cmd)
-    `#{cmd}`
-  end
-end
-
-BenchmarkDriver.parse_argv_and_run if $PROGRAM_NAME == __FILE__

data/bin/bench_regression

@@ -1,316 +0,0 @@
-#!/usr/bin/env ruby
-require 'fileutils'
-require 'pathname'
-require 'shellwords'
-require 'English'
-
-############################
-# USAGE
-#
-# bundle exec bin/bench_regression <ref1> <ref2>
-#   <ref1> defaults to the current branch
-#   <ref2> defaults to the master branch
-# bundle exec bin/bench_regression current                    # will run on the current branch
-# bundle exec bin/bench_regression revisions 792fb8a90 master # every revision inclusive
-# bundle exec bin/bench_regression           792fb8a90 master --repeat-count 2 --env CACHE_ON=off
-# bundle exec bin/bench_regression vendor
-###########################
-
-class BenchRegression
-  ROOT = Pathname File.expand_path(File.join(*['..', '..']), __FILE__)
-  TMP_DIR_NAME = File.join('tmp', 'bench')
-  TMP_DIR = File.join(ROOT, TMP_DIR_NAME)
-  E_TMP_DIR = Shellwords.shellescape(TMP_DIR)
-  load ROOT.join('bin', 'bench')
-
-  attr_reader :source_stasher
-
-  def initialize
-    @source_stasher = SourceStasher.new
-  end
-
-  class SourceStasher
-    attr_reader :gem_require_paths, :gem_paths
-    attr_writer :vendor
-
-    def initialize
-      @gem_require_paths = []
-      @gem_paths = []
-      refresh_temp_dir
-      @vendor = false
-    end
-
-    def temp_dir_empty?
-      File.directory?(TMP_DIR) &&
-        Dir[File.join(TMP_DIR, '*')].none?
-    end
-
-    def empty_temp_dir
-      return if @vendor
-      return if temp_dir_empty?
-      FileUtils.mkdir_p(TMP_DIR)
-      Dir[File.join(TMP_DIR, '*')].each do |file|
-        if File.directory?(file)
-          FileUtils.rm_rf(file)
-        else
-          FileUtils.rm(file)
-        end
-      end
-    end
-
-    def fill_temp_dir
-      vendor_files(Dir[File.join(ROOT, 'test', 'benchmark', '*.{rb,ru}')])
-      # vendor_file(File.join('bin', 'bench'))
-      housekeeping { empty_temp_dir }
-      vendor_gem('benchmark-ips')
-    end
-
-    def vendor_files(files)
-      files.each do |file|
-        vendor_file(file)
-      end
-    end
-
-    def vendor_file(file)
-      FileUtils.cp(file, File.join(TMP_DIR, File.basename(file)))
-    end
-
-    def vendor_gem(gem_name)
-      directory_name = `bundle exec gem unpack benchmark-ips --target=#{E_TMP_DIR}`[/benchmark-ips.+\d/]
-      gem_paths << File.join(TMP_DIR, directory_name)
-      gem_require_paths << File.join(TMP_DIR_NAME, directory_name, 'lib')
-      housekeeping { remove_vendored_gems }
-    end
-
-    def remove_vendored_gems
-      return if @vendor
-      FileUtils.rm_rf(*gem_paths)
-    end
-
-    def refresh_temp_dir
-      empty_temp_dir
-      fill_temp_dir
-    end
-
-    def housekeeping
-      at_exit { yield }
-    end
-  end
-
-  module RevisionMethods
-    module_function
-    def current_branch
-      @current_branch ||= `cat .git/HEAD | cut -d/ -f3,4,5`.chomp
-    end
-
-    def current_revision
-      `git rev-parse --short HEAD`.chomp
-    end
-
-    def revision_description(rev)
-      `git log --oneline -1 #{rev}`.chomp
-    end
-
-    def revisions(start_ref, end_ref)
-      cmd = "git rev-list --reverse #{start_ref}..#{end_ref}"
-      `#{cmd}`.chomp.split("\n")
-    end
-
-    def checkout_ref(ref)
-      `git checkout #{ref}`.chomp
-      if $CHILD_STATUS
-        STDERR.puts "Checkout failed: #{ref}, #{$CHILD_STATUS.exitstatus}" unless $CHILD_STATUS.success?
-        $CHILD_STATUS.success?
-      else
-        true
-      end
-    end
-
-    def clean_head
-      system('git reset --hard --quiet')
-    end
-  end
-  module ShellMethods
-
-    def sh(cmd)
-      puts cmd
-      # system(cmd)
-      run(cmd)
-      # env = {}
-      # # out = STDOUT
-      # pid = spawn(env, cmd)
-      # Process.wait(pid)
-      # pid = fork do
-      #   exec cmd
-      # end
-      # Process.waitpid2(pid)
-      # puts $CHILD_STATUS.exitstatus
-    end
-
-    require 'pty'
-    # should consider trapping SIGINT in here
-    def run(cmd)
-      puts cmd
-      child_process = ''
-      result = ''
-      # http://stackoverflow.com/a/1162850
-      # stream output of subprocess
-      begin
-        PTY.spawn(cmd) do |stdin, _stdout, pid|
-          begin
-            # Do stuff with the output here. Just printing to show it works
-            stdin.each do |line|
-              print line
-              result << line
-            end
-            child_process = PTY.check(pid)
-          rescue Errno::EIO
-            puts 'Errno:EIO error, but this probably just means ' \
-                  'that the process has finished giving output'
-          end
-        end
-      rescue PTY::ChildExited
-        puts 'The child process exited!'
-      end
-      unless (child_process && child_process.success?)
-        exitstatus = child_process.exitstatus
-        puts "FAILED: #{child_process.pid} exited with status #{exitstatus.inspect} due to failed command #{cmd}"
-        exit exitstatus || 1
-      end
-      result
-    end
-
-    def bundle(ref)
-      system("rm -f Gemfile.lock")
-      # This is absolutely critical for bundling to work
-      Bundler.with_clean_env do
-        system("bundle check ||
-          bundle install --local ||
-          bundle install ||
-          bundle update")
-      end
-
-      # if $CHILD_STATUS
-      #   STDERR.puts "Bundle failed at: #{ref}, #{$CHILD_STATUS.exitstatus}" unless $CHILD_STATUS.success?
-      #   $CHILD_STATUS.success?
-      # else
-      #   false
-      # end
-    end
-  end
-  include ShellMethods
-  include RevisionMethods
-
-  def benchmark_refs(ref1: nil, ref2: nil, cmd:)
-    checking_out = false
-    ref0 = current_branch
-    ref1 ||= current_branch
-    ref2 ||= 'master'
-    p [ref0, ref1, ref2, current_revision]
-
-    run_benchmark_at_ref(cmd, ref1)
-    p [ref0, ref1, ref2, current_revision]
-    run_benchmark_at_ref(cmd, ref2)
-    p [ref0, ref1, ref2, current_revision]
-
-    checking_out = true
-    checkout_ref(ref0)
-  rescue Exception # rubocop:disable Lint/RescueException
-    STDERR.puts "[ERROR] #{$!.message}"
-    checkout_ref(ref0) unless checking_out
-    raise
-  end
-
-  def benchmark_revisions(ref1: nil, ref2: nil, cmd:)
-    checking_out = false
-    ref0 = current_branch
-    ref1 ||= current_branch
-    ref2 ||= 'master'
-
-    revisions(ref1, ref2).each do |rev|
-      STDERR.puts "Checking out: #{revision_description(rev)}"
-
-      run_benchmark_at_ref(cmd, rev)
-      clean_head
-    end
-    checking_out = true
-    checkout_ref(ref0)
-  rescue Exception # rubocop:disable Lint/RescueException
-    STDERR.puts "[ERROR]: #{$!.message}"
-    checkout_ref(ref0) unless checking_out
-    raise
-  end
-
-  def run_benchmark_at_ref(cmd, ref)
-    checkout_ref(ref)
-    run_benchmark(cmd, ref)
-  end
-
-  def run_benchmark(cmd, ref = nil)
-    ref ||= current_revision
-    bundle(ref) &&
-      benchmark_tests(cmd, ref)
-  end
-
-  def benchmark_tests(cmd, ref)
-    base = E_TMP_DIR
-    # cmd.sub('bin/bench', 'tmp/revision_runner/bench')
-    # bundle = Gem.bin('bunle'
-    # Bundler.with_clean_env(&block)
-
-    # cmd = Shellwords.shelljoin(cmd)
-    # cmd = "COMMIT_HASH=#{ref} BASE=#{base} bundle exec ruby  -rbenchmark/ips #{cmd}"
-    # Add vendoring benchmark/ips to load path
-
-    # CURRENT THINKING: IMPORTANT
-    # Pass into require statement as RUBYOPTS i.e. via env rather than command line argument
-    # otherwise, have a 'fast ams benchmarking' module that extends benchmarkings to add the 'ams'
-    # method but doesn't depend on benchmark-ips
-    options = {
-      commit_hash: ref,
-      base: base,
-      rubyopt: Shellwords.shellescape("-Ilib:#{source_stasher.gem_require_paths.join(':')}")
-    }
-    BenchmarkDriver.parse_argv_and_run(ARGV.dup, options)
-  end
-end
-
-if $PROGRAM_NAME == __FILE__
-  benchmarking = BenchRegression.new
-
-  case ARGV[0]
-  when 'current'
-    # Run current branch only
-
-    # super simple command line parsing
-    args = ARGV.dup
-    _    = args.shift # remove 'current' from args
-    cmd  = args
-    benchmarking.run_benchmark(cmd)
-  when 'revisions'
-    # Runs on every revision
-
-    # super simple command line parsing
-    args = ARGV.dup
-    _         = args.shift
-    ref1      = args.shift # remove 'revisions' from args
-    ref2      = args.shift
-    cmd       = args
-    benchmarking.benchmark_revisions(ref1: ref1, ref2: ref2, cmd: cmd)
-  when 'vendor'
-    # Just prevents vendored files from being cleaned up
-    # at exit. (They are vendored at initialize.)
-    benchmarking.source_stasher.vendor = true
-  else
-    # Default: Compare current_branch to master
-    # Optionally: pass in two refs as args to `bin/bench_regression`
-    # TODO: Consider checking across more revisions, to automatically find problems.
-
-    # super simple command line parsing
-    args = ARGV.dup
-    ref1      = args.shift
-    ref2      = args.shift
-    cmd       = args
-    benchmarking.benchmark_refs(ref1: ref1, ref2: ref2, cmd: cmd)
-  end
-end

data/bin/rubocop

@@ -1,38 +0,0 @@
-#!/usr/bin/env bash
-#
-# Usage:
-#   bin/rubocop [-A|-t|-h]
-#   bin/rubocop [file or path] [cli options]
-#
-# Options:
-#  Autocorrect    -A
-#  AutoGenConfig  -t
-#  Usage          -h,--help,help
-
-set -e
-
-case $1 in
-  -A)
-     echo "Rubocop autocorrect is ON" >&2
-     bundle exec rake -f lib/tasks/rubocop.rake rubocop:auto_correct
-     ;;
-
-  -t)
-     echo "Rubocop is generating a new TODO" >&2
-     bundle exec rake -f lib/tasks/rubocop.rake rubocop:auto_gen_config
-     ;;
-
-  -h|--help|help)
-     sed -ne '/^#/!q;s/.\{1,2\}//;1d;p' < "$0"
-     ;;
-
-  *)
-     # with no args, run vanilla rubocop
-     # else assume we're passing in arbitrary arguments
-     if [ -z "$1" ]; then
-       bundle exec rake -f lib/tasks/rubocop.rake rubocop
-     else
-       bundle exec rubocop "$@"
-     fi
-     ;;
-esac

data/bin/serve_benchmark

@@ -1,39 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-case "$1" in
-
-  start)
-  config="${CONFIG_RU:-test/benchmark/config.ru}"
-  bundle exec ruby -Ilib -S rackup "$config" --daemonize --pid tmp/benchmark_app.pid --warn --server webrick
-  until [ -f 'tmp/benchmark_app.pid' ]; do
-    sleep 0.1 # give it time to start.. I don't know a better way
-  done
-  cat tmp/benchmark_app.pid
-  true
-  ;;
-
-  stop)
-  if [ -f 'tmp/benchmark_app.pid' ]; then
-    kill -TERM $(cat tmp/benchmark_app.pid)
-  else
-    echo 'No pidfile'
-    false
-  fi
-  ;;
-
-  status)
-  if [ -f 'tmp/benchmark_app.pid' ]; then
-    kill -0 $(cat tmp/benchmark_app.pid)
-    [ "$?" -eq 0 ]
-  else
-    echo 'No pidfile'
-    false
-  fi
-  ;;
-
-  *)
-  echo "Usage: $0 [start|stop|status]"
-  ;;
-
-esac

data/docs/README.md

@@ -1,41 +0,0 @@
-# Docs - ActiveModel::Serializer 0.10.x
-
-This is the documentation of ActiveModelSerializers, it's focused on the **0.10.x version.**
-
------
-
-## General
-
-- [Getting Started](general/getting_started.md)
-- [Configuration Options](general/configuration_options.md)
-- [Serializers](general/serializers.md)
-- [Adapters](general/adapters.md)
-- [Rendering](general/rendering.md)
-- [Caching](general/caching.md)
-- [Logging](general/logging.md)
-- [Deserialization](general/deserialization.md)
-- [Instrumentation](general/instrumentation.md)
-- JSON API
-  - [Schema](jsonapi/schema.md)
-  - [Errors](jsonapi/errors.md)
-
-## How to
-
-- [How to add root key](howto/add_root_key.md)
-- [How to add pagination links](howto/add_pagination_links.md)
-- [How to add relationship links](howto/add_relationship_links.md)
-- [Using ActiveModelSerializers Outside Of Controllers](howto/outside_controller_use.md)
-- [Testing ActiveModelSerializers](howto/test.md)
-- [Passing Arbitrary Options](howto/passing_arbitrary_options.md)
-- [How to serialize a Plain-Old Ruby Object (PORO)](howto/serialize_poro.md)
-- [How to upgrade from `0.8` to `0.10` safely](howto/upgrade_from_0_8_to_0_10.md)
-
-## Integrations
-
-| Integration | Supported ActiveModelSerializers versions |  Gem name and/or link
-|----|-----|----
-| Ember.js | 0.9.x | [active-model-adapter](https://github.com/ember-data/active-model-adapter)
-| Ember.js | 0.10.x + |  [docs/integrations/ember-and-json-api.md](integrations/ember-and-json-api.md)
-| Grape | 0.10.x + | [docs/integrations/grape.md](integrations/grape.md)  |
-| Grape | 0.9.x | https://github.com/jrhe/grape-active_model_serializers/ |
-| Sinatra | 0.9.x | https://github.com/SauloSilva/sinatra-active-model-serializers/

data/docs/STYLE.md

@@ -1,58 +0,0 @@
-# STYLE
-
-## 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.
-
-
-## 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)
-
-- [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/)
-
-## 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).
-