active_model_serializers 0.8.3 → 0.10.0

data/Rakefile

@@ -1,18 +1,103 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
-require "rake/testtask"
+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
+
+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'
+  require 'rubocop/rake_task'
+rescue LoadError
+else
+  Rake::Task[:rubocop].clear if Rake::Task.task_defined?(:rubocop)
+  require 'rbconfig'
+  # https://github.com/bundler/bundler/blob/1b3eb2465a/lib/bundler/constants.rb#L2
+  windows_platforms = /(msdos|mswin|djgpp|mingw)/
+  if RbConfig::CONFIG['host_os'] =~ windows_platforms
+    desc 'No-op rubocop on Windows-- unsupported platform'
+    task :rubocop do
+      puts 'Skipping rubocop on Windows'
+    end
+  elsif defined?(::Rubinius)
+    desc 'No-op rubocop to avoid rbx segfault'
+    task :rubocop do
+      puts 'Skipping rubocop on rbx due to segfault'
+      puts 'https://github.com/rubinius/rubinius/issues/3499'
+    end
+  else
+    Rake::Task[:rubocop].clear if Rake::Task.task_defined?(:rubocop)
+    desc 'Execute rubocop'
+    RuboCop::RakeTask.new(:rubocop) do |task|
+      task.options = ['--rails', '--display-cop-names', '--display-style-guide']
+      task.fail_on_error = true
+    end
+  end
+end
+
+require 'rake/testtask'
 
-desc 'Run tests'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
   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 'Benchmark'
-task :bench do
-  load 'bench/perf.rb' 
+desc 'Run isolated tests'
+task isolated: ['test:isolated']
+namespace :test do
+  task :isolated do
+    desc 'Run isolated tests for Railtie'
+    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)
+      end or fail 'Failures' # rubocop:disable Style/AndOr
+    end
+  end
+end
+
+if ENV['RAILS_VERSION'].to_s > '4.0' && RUBY_ENGINE == 'ruby'
+  task default: [:isolated, :test, :rubocop]
+else
+  task default: [:test, :rubocop]
 end
 
-task :default => :test
+desc 'CI test task'
+task :ci => [:default]

data/active_model_serializers.gemspec

@@ -1,24 +1,66 @@
-# -*- encoding: utf-8 -*-
-
-$:.unshift File.expand_path("../lib", __FILE__)
-require "active_model/serializers/version"
-
-Gem::Specification.new do |gem|
-  gem.authors       = ["José Valim", "Yehuda Katz"]
-  gem.email         = ["jose.valim@gmail.com", "wycats@gmail.com"]
-  gem.description   = %q{Making it easy to serialize models for client-side use}
-  gem.summary       = %q{Bringing consistency and object orientation to model serialization. Works great for client-side MVC frameworks!}
-  gem.homepage      = "https://github.com/rails-api/active_model_serializers"
-
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.name          = "active_model_serializers"
-  gem.require_paths = ["lib"]
-  gem.version       = ActiveModel::Serializer::VERSION
-
-  gem.add_dependency 'activemodel', '>= 3.0'
-  gem.add_development_dependency "rails", ">= 3.0"
-  gem.add_development_dependency "pry"
-  gem.add_development_dependency "minitest"
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_model/serializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_model_serializers'
+  spec.version       = ActiveModel::Serializer::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ['Steve Klabnik']
+  spec.email         = ['steve@steveklabnik.com']
+  spec.summary       = 'Conventions-based JSON generation for Rails.'
+  spec.description   = 'ActiveModel::Serializers allows you to generate your JSON in an object-oriented and convention-driven manner.'
+  spec.homepage      = 'https://github.com/rails-api/active_model_serializers'
+  spec.license       = 'MIT'
+
+  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'
+
+  rails_versions = '>= 4.0'
+  spec.add_runtime_dependency 'activemodel', rails_versions
+    # 'activesupport', rails_versions
+    # 'builder'
+
+  spec.add_runtime_dependency 'actionpack', rails_versions
+    # 'activesupport', rails_versions
+    # 'rack'
+    # 'rack-test', '~> 0.6.2'
+
+  spec.add_runtime_dependency 'railties', rails_versions
+    # 'activesupport', rails_versions
+    # 'actionpack', rails_versions
+    # 'rake', '>= 0.8.7'
+
+  # 'activesupport', rails_versions
+    # 'i18n,
+    # 'tzinfo'
+    # 'minitest'
+    # 'thread_safe'
+
+  spec.add_development_dependency 'activerecord', rails_versions
+    # arel
+    # activesupport
+    # activemodel
+
+  # Soft dependency for pagination
+  spec.add_development_dependency 'kaminari', ' ~> 0.16.3'
+  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 '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_transforms.md
+for more information on configuring this behavior.
+EOF
 end

data/appveyor.yml

@@ -0,0 +1,24 @@
+version: '{build}'
+
+skip_tags: true
+
+environment:
+  JRUBY_OPTS: "--dev -J-Xmx1024M --debug"
+  matrix:
+    - ruby_version: "Ruby21"
+    - ruby_version: "Ruby21-x64"
+    - ruby_version: "jruby-9.0.0.0"
+
+cache:
+  - vendor/bundle
+
+install:
+  - SET PATH=C:\%ruby_version%\bin;%PATH%
+  - gem install bundler
+  - bundle env
+  - bundle install --path=vendor/bundle --retry=3 --jobs=3
+
+test_script:
+  - bundle exec rake ci
+
+build: off

data/bin/bench

@@ -0,0 +1,171 @@
+#!/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__