grape-entity 1.0.1 → 1.0.3

data/CONTRIBUTING.md

@@ -1,118 +0,0 @@
-Contributing to Grape-Entity
-============================
-
-Grape-Entity is work of [many of contributors](https://github.com/ruby-grape/grape-entity/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/ruby-grape/grape-entity/pulls), [propose features and discuss issues](https://github.com/ruby-grape/grape-entity/issues). When in doubt, ask a question in the [Grape Google Group](http://groups.google.com/group/ruby-grape).
-
-#### Fork the Project
-
-Fork the [project on Github](https://github.com/ruby-grape/grape-entity) and check out your copy.
-
-```
-git clone https://github.com/contributor/grape-entity.git
-cd grape-entity
-git remote add upstream https://github.com/ruby-grape/grape-entity.git
-```
-
-#### Create a Topic Branch
-
-Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
-
-```
-git checkout master
-git pull upstream master
-git checkout -b my-feature-branch
-```
-
-#### Bundle Install and Test
-
-Ensure that you can build the project and run tests.
-
-```
-bundle install
-bundle exec rake
-```
-
-#### Write Tests
-
-Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [spec/grape-entity](spec/grape-entity).
-
-We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
-
-#### Write Code
-
-Implement your feature or bug fix.
-
-Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop), run `bundle exec rubocop` and fix any style issues highlighted.
-
-Make sure that `bundle exec rake` completes without errors.
-
-#### Write Documentation
-
-Document any external behavior in the [README](README.md).
-
-#### Update Changelog
-
-Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Make it look like every other line, including your name and link to your Github account.
-
-#### Commit Changes
-
-Make sure git knows your name and email address:
-
-```
-git config --global user.name "Your Name"
-git config --global user.email "contributor@example.com"
-```
-
-Writing good commit logs is important. A commit log should describe what changed and why.
-
-```
-git add ...
-git commit
-```
-
-#### Push
-
-```
-git push origin my-feature-branch
-```
-
-#### Make a Pull Request
-
-Go to https://github.com/ruby-grape/grape-entity and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
-
-#### Rebase
-
-If you've been working on a change for a while, rebase with upstream/master.
-
-```
-git fetch upstream
-git rebase upstream/master
-git push origin my-feature-branch -f
-```
-
-#### Update CHANGELOG Again
-
-Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
-
-```
-* [#123](https://github.com/ruby-grape/grape-entity/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
-```
-
-Amend your previous commit and force push the changes.
-
-```
-git commit --amend
-git push origin my-feature-branch -f
-```
-
-#### Check on Your Pull Request
-
-Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
-
-#### Be Patient
-
-It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
-
-#### Thank You
-
-Please do know that we really appreciate and value your time and work. We love you, really.

data/Dangerfile

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-danger.import_dangerfile(gem: 'ruby-grape-danger')

data/Gemfile

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-source 'http://rubygems.org'
-
-gemspec
-
-group :development, :test do
-  gem 'bundler'
-  gem 'maruku'
-  gem 'pry' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
-  gem 'pry-byebug' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
-  gem 'rack-test'
-  gem 'rake'
-  gem 'rspec', '~> 3.9'
-  gem 'rubocop', '~> 1.0'
-  gem 'yard'
-end
-
-group :test do
-  gem 'coveralls_reborn', require: false
-  gem 'growl'
-  gem 'guard'
-  gem 'guard-bundler'
-  gem 'guard-rspec'
-  gem 'rb-fsevent'
-  gem 'ruby-grape-danger', '~> 0.2', require: false
-  gem 'simplecov', require: false
-end

data/Guardfile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'rspec', version: 2 do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^spec/support/shared_versioning_examples.rb$}) { |_m| 'spec/' }
-  watch('spec/spec_helper.rb') { 'spec/' }
-end
-
-guard 'bundler' do
-  watch('Gemfile')
-  watch(/^.+\.gemspec/)
-end

data/RELEASING.md

@@ -1,84 +0,0 @@
-Releasing Grape-Entity
-======================
-
-There're no particular rules about when to release grape-entity. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
-
-### Release
-
-Run tests, check that all tests succeed locally.
-
-```
-bundle install
-rake
-```
-
-Check that the last build succeeded in [Travis CI](https://travis-ci.org/ruby-grape/grape-entity) for all supported platforms.
-
-Increment the version, modify [lib/grape-entity/version.rb](lib/grape-entity/version.rb).
-
-*  Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.5.1` to `0.5.2`).
-*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.5.1` to `0.4.0`).
-
-Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
-
-```
-0.4.0 (2014-01-27)
-==================
-```
-
-Remove the line with "Your contribution here.", since there will be no more contributions to this release.
-
-Commit your changes.
-
-```
-git add CHANGELOG.md lib/grape-entity/version.rb
-git commit -m "Preparing for release, 0.4.0."
-git push origin master
-```
-
-Release.
-
-```
-$ rake release
-
-grape-entity 0.4.0 built to pkg/grape-entity-0.4.0.gem.
-Tagged v0.4.0.
-Pushed git commits and tags.
-Pushed grape-entity 0.4.0 to rubygems.org.
-```
-
-### Prepare for the Next Version
-
-Add the next release to [CHANGELOG.md](CHANGELOG.md).
-
-```
-Next Release
-============
-
-* Your contribution here.
-```
-
-Increment the minor version, modify [lib/grape-entity/version.rb](lib/grape-entity/version.rb).
-
-Comit your changes.
-
-```
-git add CHANGELOG.md lib/grape-entity/version.rb
-git commit -m "Preparing for next release, 0.4.1."
-git push origin master
-```
-
-### Make an Announcement
-
-Make an announcement on the [ruby-grape@googlegroups.com](mailto:ruby-grape@googlegroups.com) mailing list. The general format is as follows.
-
-```
-Grape-entity 0.4.0 has been released.
-
-There were 8 contributors to this release, not counting documentation.
-
-Please note the breaking API change in ...
-
-[copy/paste CHANGELOG here]
-
-```

data/Rakefile

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubygems'
-require 'bundler'
-
-Bundler.setup(:default, :development)
-
-require 'rake'
-
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new(:rubocop)
-
-task default: %i[spec rubocop]

data/UPGRADING.md

@@ -1,40 +0,0 @@
-# Upgrading Grape Entity
-
-
-### Upgrading to >= 0.10.2
-Official support for `FetchableObject` was removed.
-
-See [#352](https://github.com/ruby-grape/grape-entity/pull/369) for more information.
-
-### Upgrading to >= 0.8.2
-
-Official support for ruby < 2.5 removed, ruby 2.5 only in testing mode, but no support.
-
-In Ruby 3.0: the block handling will be changed
-[language-changes point 3, Proc](https://github.com/ruby/ruby/blob/v3_0_0_preview1/NEWS.md#language-changes).
-This:
-```ruby
-expose :that_method_without_args, &:method_without_args
-```
-will be deprecated.
-
-Prefer to use this pattern for simple setting a value
-```ruby
-expose :method_without_args, as: :that_method_without_args
-```
-
-### Upgrading to >= 0.6.0
-
-#### Changes in Grape::Entity#inspect
-
-The `Grape::Entity#inspect` method will no longer serialize the entity presenter with its options and delegator, but the exposed entity itself, using `#serializable_hash`.
-
-See [#250](https://github.com/ruby-grape/grape-entity/pull/250) for more information.
-
-### Upgrading to >= 0.5.1
-
-#### Changes in NestedExposures.delete_if
-
-`Grape::Entity::Exposure::NestingExposure::NestedExposures.delete_if` always returns exposures, regardless of delete result (used to be `nil` in negative case).
-
-See [#203](https://github.com/ruby-grape/grape-entity/pull/203) for more information.

data/bench/serializing.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'grape-entity'
-require 'benchmark'
-
-module Models
-  class School
-    attr_reader :classrooms
-
-    def initialize
-      @classrooms = []
-    end
-  end
-
-  class ClassRoom
-    attr_reader :students
-    attr_accessor :teacher
-
-    def initialize(opts = {})
-      @teacher = opts[:teacher]
-      @students = []
-    end
-  end
-
-  class Person
-    attr_accessor :name
-
-    def initialize(opts = {})
-      @name = opts[:name]
-    end
-  end
-
-  class Teacher < Models::Person
-    attr_accessor :tenure
-
-    def initialize(opts = {})
-      super(opts)
-      @tenure = opts[:tenure]
-    end
-  end
-
-  class Student < Models::Person
-    attr_reader :grade
-
-    def initialize(opts = {})
-      super(opts)
-      @grade = opts[:grade]
-    end
-  end
-end
-
-module Entities
-  class School < Grape::Entity
-    expose :classrooms, using: 'Entities::ClassRoom'
-  end
-
-  class ClassRoom < Grape::Entity
-    expose :teacher, using: 'Entities::Teacher'
-    expose :students, using: 'Entities::Student'
-    expose :size do |model, _opts|
-      model.students.count
-    end
-  end
-
-  class Person < Grape::Entity
-    expose :name
-  end
-
-  class Student < Entities::Person
-    expose :grade
-    expose :failing do |model, _opts|
-      model.grade == 'F'
-    end
-  end
-
-  class Teacher < Entities::Person
-    expose :tenure
-  end
-end
-
-teacher1 = Models::Teacher.new(name: 'John Smith', tenure: 2)
-classroom1 = Models::ClassRoom.new(teacher: teacher1)
-classroom1.students << Models::Student.new(name: 'Bobby', grade: 'A')
-classroom1.students << Models::Student.new(name: 'Billy', grade: 'B')
-
-teacher2 = Models::Teacher.new(name: 'Lisa Barns')
-classroom2 = Models::ClassRoom.new(teacher: teacher2, tenure: 15)
-classroom2.students << Models::Student.new(name: 'Eric', grade: 'A')
-classroom2.students << Models::Student.new(name: 'Eddie', grade: 'C')
-classroom2.students << Models::Student.new(name: 'Arnie', grade: 'C')
-classroom2.students << Models::Student.new(name: 'Alvin', grade: 'F')
-school = Models::School.new
-school.classrooms << classroom1
-school.classrooms << classroom2
-
-iters = 5000
-
-Benchmark.bm do |bm|
-  bm.report('serializing') do
-    iters.times do
-      Entities::School.represent(school, serializable: true)
-    end
-  end
-end

data/grape-entity.gemspec

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.push File.expand_path('lib', __dir__)
-require 'grape_entity/version'
-
-Gem::Specification.new do |s|
-  s.name        = 'grape-entity'
-  s.version     = GrapeEntity::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['LeFnord', 'Michael Bleigh']
-  s.email       = ['pscholz.le@gmail.com', 'michael@intridea.com']
-  s.homepage    = 'https://github.com/ruby-grape/grape-entity'
-  s.summary     = 'A simple facade for managing the relationship between your model and API.'
-  s.description = 'Extracted from Grape, A Ruby framework for rapid API development with great conventions.'
-  s.license     = 'MIT'
-
-  s.required_ruby_version = '>= 3.0'
-
-  s.add_runtime_dependency 'activesupport', '>= 3.0.0'
-  # FIXME: remove dependecy
-  s.add_runtime_dependency 'multi_json', '>= 1.3.2'
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")
-  s.require_paths = ['lib']
-end