grape-entity-include 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 388d153790f67d185d5f1fc9296a8f555d441bc027b6787c99bdccf2f9f961ae
-  data.tar.gz: 50273b099a0bf619605d84728af8d3bcf737e5ea56b0bd84b37a305b2a082793
+  metadata.gz: 8f94b97387b74c936a9de7b562ea2c3442e54410ef30e533fe18c2af29a4d11c
+  data.tar.gz: d3839ff29d4602764d0059ef3a50197d9dba9d83277266a946eb93e75bd0424e
 SHA512:
-  metadata.gz: 58a92c4de0996a254522e132be9c49e3179f7cc7c22657ae9d2c2c29b7e147b51528e8d02cf0f4d711759c67c23d8996451fd543c50318a1d40548d43ac63951
-  data.tar.gz: 0fdeae85c239c92cf4cf2c25f517ee1420c1e1960e9f4fc209c9710fb463a4e66aa59ac7030365c525eefd6fd751e091dba6bde59fe9b77cafbdd1ba60a4937f
+  metadata.gz: 94c539753884d9b41b96a95507812cc18dbb065a8f203daf0c20c38e53340f4d6008f6b288e175673dcae07baf40224c9ae772baf1a0c581717d1789f50074f3
+  data.tar.gz: 9352f477bfceac7a98ce7944c106c44067e99c24d354171664b4e6cb599d12c8c4a845ba158682ec87a9b2ec6856c6d240f86cb26174a45772e58cac65c96d7f

data/README.md

@@ -1,8 +1,6 @@
 # GrapeEntityInclude
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/grape/entity/include`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+An include option for grape-entity, expose attributes if matching with attr_path option by using `include_attr_path?` method
 
 ## Installation
 
@@ -22,7 +20,36 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Assume that you already had grape entities that sit on top of object models.
+
+### Example
+```ruby
+UserEntity.represent(user_model, include: [:friends, { posts: [:comments, :photos] }])
+
+class UserEntity < Grape::Entity
+    expose :name
+    expose :email
+    expose :friends, using: UserEntity, if: include_attr_path?
+    expose :posts, using: PostEntity, if: include_attr_path?
+end
+
+class PostEntity < Grape::Entity
+    expose :title
+    expose :content
+    expose :comments, using: CommentEntity, if: include_attr_path?
+    expose :photos, using: PhotoEntity, if: include_attr_path?
+end
+
+class CommentEntity < Grape::Entity
+    expose :content
+end
+
+class PhotoEntity < Grape::Entity
+    expose :caption
+    expose :url
+end
+
+```
 
 ## Development
 
@@ -32,7 +59,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grape-entity-include. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/grape-entity-include/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/ntd63t/grape-entity-include. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ntd63t/grape-entity-include/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -41,4 +68,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the GrapeEntityInclude project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/grape-entity-include/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the GrapeEntityInclude project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ntd63t/grape-entity-include/blob/master/CODE_OF_CONDUCT.md).

data/grape-entity-include.gemspec

@@ -5,11 +5,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Dzung Nguyen"]
   spec.email         = ["ntd63t@gmail.com"]
 
-  spec.summary       = %q{grape-entity-include}
-  spec.description   = %q{grape-entity-include}
+  spec.summary       = %q{An include option for grape-entity, expose attributes if matching with attr_path option}
+  spec.description   = %q{An include option for grape-entity, expose attributes if matching with attr_path option}
   spec.homepage      = "https://github.com/ntd63t/grape-entity-include.git"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 

data/lib/grape_entity_include/version.rb

@@ -1,3 +1,3 @@
 module GrapeEntityInclude
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-entity-include
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dzung Nguyen
@@ -38,7 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: grape-entity-include
+description: An include option for grape-entity, expose attributes if matching with
+  attr_path option
 email:
 - ntd63t@gmail.com
 executables: []
@@ -73,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -83,5 +84,6 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: grape-entity-include
+summary: An include option for grape-entity, expose attributes if matching with attr_path
+  option
 test_files: []