active_model_serializer_helpers 0.1.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b596fb3ac4cefc11eec5672f628e096a5a3ab95
+  data.tar.gz: 54842148293feb4e005720592fc47ffa0d9e7838
+SHA512:
+  metadata.gz: 5917b6a9dcaf3a14855ce8d3cfb382566c4dd390b64ce050f1418219c43e7e7d2bd58b971f517a0ecf9dfcab5a3920b802f38dbf6af42a6b46c473019294e649
+  data.tar.gz: 563db597116e2d31b6b8f5416980cb0b3eb78e87c7f3539ea9d0eb2268c49555eea88081633fd5b6d7369de9c7b34fa0389b90f3cbd140ed54356099771936ad

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/CODE_OF_CONDUCT.md

@@ -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 rogerio.alcantara@gmail.com. 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/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rogério Rodrigues de Alcântara
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,121 @@
+# ActiveModelSerializerHelpers
+
+Some Active Model Serializer RSpec Helpers and Matchers
+
+[![CircleCI](https://circleci.com/gh/roalcantara/active_model_serializer_helpers/tree/master.svg?style=shield)](https://circleci.com/gh/roalcantara/active_model_serializer_helpers/tree/master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_model_serializer_helpers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_model_serializer_helpers
+
+## Configuration
+
+On `spec/active_model_serializer_helpers.rb`:
+
+```ruby
+RSpec.configure do |config|
+  config.include ActiveModelSerializerHelpers, type: :serializer
+
+  # set `:type` for serializers directory
+  config.define_derived_metadata(file_path: Regexp.new("/spec/serializers")) do |metadata|
+    metadata[:type] = :serializer
+  end
+end
+```
+
+## Usage
+
+Given the model `app/models/user.rb`:
+
+```ruby
+class User < ApplicationRecord
+end
+```
+
+The serializer `app/serializers/user_serializer.rb`:
+
+```ruby
+class UserSerializer < ActiveModel::Serializer
+  attributes :id, :name
+end
+```
+
+And the controller `app/controllers/user_controller.rb`: 
+
+```ruby
+class UsersController < ApplicationController
+  def show
+    respond_to do |format|
+      format.json do
+        render json: @user, root: false
+      end
+    end
+  end
+end
+```
+
+Then, you can have `spec/serializers/user_serializer_spec.rb`:
+
+```ruby
+require "rails_helper"
+
+RSpec.describe User do
+  it { is_expected.to be_serializable }
+end
+```
+
+And `spec/serializers/user_serializer_spec.rb`:
+
+```ruby
+require "rails_helper"
+
+RSpec.describe UserSerializer do
+  let(:user) { create :user }
+  subject { serialize(user) }
+
+  it { is_expected.to include(id: user.id, name: user.name) }
+end
+```
+
+And `spec/controllers/user_controller_spec.rb`:
+
+```ruby
+require "rails_helper"
+
+RSpec.describe UserController do
+  describe "GET #show" do
+    context "with format :json" do
+      subject { get :show, params: { name: nil }, format: :json }
+
+      it { expect(subject.body).to be_a_serialized(user).with(root: false) }
+    end
+  end  
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_model_serializer_helpers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/active_model_serializer_helpers.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_model_serializer_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_model_serializer_helpers'
+  spec.version       = ActiveModelSerializerHelpers::VERSION
+  spec.authors       = ['Rogério Rodrigues de Alcântara']
+  spec.email         = ['rogerio.alcantara@gmail.com']
+
+  spec.summary       = 'Active Model Serializer Helpers'
+  spec.description   = 'Active Model Serializer RSpec Helpers and Matchers'
+  spec.homepage      = 'https://github.com/roalcantara/active_model_serializer_helpers'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.2.3'
+  spec.add_dependency 'rspec', '~> 3.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'active_model_serializer_helpers'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,17 @@
+general:
+  branches:
+    ignore:
+      - /^(?!master).*$/
+deployment:
+  release:
+    tag: /v*/
+    owner: roalcantara
+    commands:
+      - gem build active_model_serializer_helpers.gemspec
+      - gem push *.gem
+dependencies:
+  pre:
+    - gem install bundler --pre
+  test:
+    override:
+      - RAILS_ENV=test bundle exec rspec -r rspec_junit_formatter --format progress --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml

data/lib/active_model_serializer_helpers.rb

@@ -0,0 +1,11 @@
+require 'active_model_serializer_helpers/version'
+require 'active_model_serializer_helpers/matchers'
+
+module ActiveModelSerializerHelpers
+  def serialize(obj, opts = {})
+    serializer = opts.delete(:serializer_class)
+    serializer = "#{obj.class.name}Serializer".constantize if serializer.nil?
+    serializer = serializer.send(:new, obj)
+    serializer.serializable_hash.with_indifferent_access
+  end
+end

data/lib/active_model_serializer_helpers/matchers.rb

@@ -0,0 +1,11 @@
+require 'active_model_serializer_helpers/matchers/be_serializable'
+require 'active_model_serializer_helpers/matchers/be_a_serialized'
+
+module ActiveModelSerializerHelpers
+  module Matchers
+    class << self
+      # @private
+      attr_accessor :assertion_exception_class
+    end
+  end
+end

data/lib/active_model_serializer_helpers/matchers/be_a_serialized.rb

@@ -0,0 +1,35 @@
+require 'rspec/core'
+
+RSpec::Matchers.define :be_a_serialized do |object|
+  match do |actual|
+    serialized_json(object) == actual
+  end
+
+  chain :with do |options = {}|
+    @options = options
+  end
+
+  description do
+    "be a serialized #{name(object)} using " \
+    "#{ActiveModel::Serializer.serializer_for(model(object))} with #{@options}"
+  end
+
+  def name(object)
+    model(object).model_name.human
+  end
+
+  def model(object)
+    return object.first if object.is_a?(Array)
+    object
+  end
+
+  failure_message do |actual|
+    "expected #{actual} to be_serialized as #{serialized_json(object)}, " \
+    "got #{actual}"
+  end
+
+  def serialized_json(object)
+    adapted = ActiveModelSerializers::SerializableResource.new(object, @options)
+    adapted.serializable_hash.to_json
+  end
+end

data/lib/active_model_serializer_helpers/matchers/be_serializable.rb

@@ -0,0 +1,11 @@
+require 'rspec/core'
+
+RSpec::Matchers.define :be_serializable do
+  match do |actual|
+    ActiveModel::Serializer.serializer_for(actual).present?
+  end
+
+  failure_message do |actual|
+    "#{actual.class.name}Serializer does not exist"
+  end
+end

data/lib/active_model_serializer_helpers/version.rb

@@ -0,0 +1,3 @@
+module ActiveModelSerializerHelpers
+  VERSION = '0.1.0-alpha'.freeze
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: active_model_serializer_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.alpha
+platform: ruby
+authors:
+- Rogério Rodrigues de Alcântara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Active Model Serializer RSpec Helpers and Matchers
+email:
+- rogerio.alcantara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_model_serializer_helpers.gemspec
+- bin/console
+- bin/setup
+- circle.yml
+- lib/active_model_serializer_helpers.rb
+- lib/active_model_serializer_helpers/matchers.rb
+- lib/active_model_serializer_helpers/matchers/be_a_serialized.rb
+- lib/active_model_serializer_helpers/matchers/be_serializable.rb
+- lib/active_model_serializer_helpers/version.rb
+homepage: https://github.com/roalcantara/active_model_serializer_helpers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Active Model Serializer Helpers
+test_files: []