blueprinter 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3d1968ce7648f29d301d61dd92a016b0a6ca65a515ad7ee196a4b6958634d3d
-  data.tar.gz: b8abfa3db3801439ff6405ec695863913081cdb0c339f983279cfad75812d867
+  metadata.gz: e0063edea4645668b9ed423eca8e3ebd926227084216a795f34e4d7c1c4aaf65
+  data.tar.gz: d0cb833cbc3cae7fd7290560e170dc21825179f2a268a81de216cc8ad2bb42d2
 SHA512:
-  metadata.gz: 41f969a27e181dd1a6e7534223eb5419e7a5c279c97a4f2da4e775c0ec05b4cfac30aa2a102891331b29ef4b644424fefece493abf90b743cca9b9ebbaff1390
-  data.tar.gz: 187e6c5af1f43aab7b5043cb86dc3bea9dd705397eaae0888747a429ea7a4d903a6631eb35940a43960c7070b9a8297ecf236795ddaad4ecacae09b59c1735d4
+  metadata.gz: 72eca578378f6c66306e48e790332321141b31c07c66d40e3faac6da513ea6e43a19c8b56a062c3b92c320903956ba7211bb97d2fd32fa18c2dd1cd2b302cfef
+  data.tar.gz: 2946724076faa04dd6a0aabd85c1b2e92ff5f9bba4466c3c06de419ad7c11b50c48591d336e6e5aa19a66c23e9fd791b53aa48fe9aa6c243da6b0402845e0728

data/CHANGELOG.md

@@ -1,5 +1,8 @@
+## 0.16.0  - 2019/04/3
+* 🚀 [FEATURE] Add ability to exclude multiple fields inline using `excludes`. [#141](https://github.com/procore/blueprinter/pull/141). Thanks to [@pabhinaya](https://github.com/pabhinaya).
+
 ## 0.15.0  - 2019/04/1
-* 🚀 [FEATURE] Add ability to pass in `datetime_format` field option as either a string representing the strptime format, or a Proc which takes in the Date or DateTime object and returns the formatted date. [#145](https://github.com/procore/blueprinter/pull/145). Thanks to [@mcclayton](https://github.com/mcclayton).
+* 🚀 [FEATURE] Add ability to pass in `datetime_format` field option as either a string representing the strftime format, or a Proc which takes in the Date or DateTime object and returns the formatted date. [#145](https://github.com/procore/blueprinter/pull/145). Thanks to [@mcclayton](https://github.com/mcclayton).
 
 ## 0.14.0  - 2019/04/01
 * 🚀 [FEATURE] Added a global `datetime_format` option. [#135](https://github.com/procore/blueprinter/pull/143). Thanks to [@ritikesh](https://github.com/ritikesh).

data/README.md

@@ -13,7 +13,11 @@ It heavily relies on the idea of `views` which, similar to Rails views, are ways
 Docs can be found [here](http://www.rubydoc.info/gems/blueprinter).
 
 ## Usage
-### Basic
+<details open>
+<summary>Basic</summary>
+
+---
+
 If you have an object you would like serialized, simply create a blueprint. Say, for example, you have a User record with the following attributes `[:uuid, :email, :first_name, :last_name, :password, :address]`.
 
 You may define a simple blueprint like so:
@@ -42,7 +46,14 @@ And the output would look like:
 }
 ```
 
-### Collections
+---
+</details>
+
+
+<details>
+<summary>Collections</summary>
+
+---
 
 You can also pass a collection object or an array to the render method.
 
@@ -69,7 +80,14 @@ This will result in JSON that looks something like this:
 ]
 ```
 
-### Renaming
+---
+</details>
+
+
+<details>
+<summary>Renaming</summary>
+
+---
 
 You can rename the resulting JSON keys in both fields and associations by using the `name` option.
 
@@ -93,7 +111,15 @@ This will result in JSON that looks something like this:
 }
 ```
 
-### Views
+---
+</details>
+
+
+<details>
+<summary>Views</summary>
+
+---
+
 You may define different outputs by utilizing views:
 ```ruby
 class UserBlueprint < Blueprinter::Base
@@ -128,7 +154,15 @@ Output:
 }
 ```
 
-### Root
+---
+</details>
+
+
+<details>
+<summary>Root</summary>
+
+---
+
 You can also optionally pass in a root key to wrap your resulting json in:
 ```ruby
 class UserBlueprint < Blueprinter::Base
@@ -158,7 +192,15 @@ Output:
 }
 ```
 
-### Meta attributes
+---
+</details>
+
+
+<details>
+<summary>Meta Attributes</summary>
+
+---
+
 You can additionally add meta-data to the json as well:
 ```ruby
 class UserBlueprint < Blueprinter::Base
@@ -199,7 +241,15 @@ Output:
 ```
 _NOTE:_ For meta attributes, a [root](#root) is mandatory.
 
-### Exclude fields
+---
+</details>
+
+
+<details>
+<summary>Exclude Fields</summary>
+
+---
+
 You can specifically choose to exclude certain fields for specific views
 ```ruby
 class UserBlueprint < Blueprinter::Base
@@ -233,7 +283,34 @@ Output:
 }
 ```
 
-### Associations
+Use `excludes` to exclude multiple fields at once inline.
+
+```ruby
+class UserBlueprint < Blueprinter::Base
+  identifier :uuid
+  field :email, name: :login
+
+  view :normal do
+    fields :age, :first_name, :last_name,
+  end
+
+  view :extended do
+    include_view :normal
+    field :address
+    excludes :age, :last_name
+  end
+end
+```
+
+---
+</details>
+
+
+<details>
+<summary>Associations</summary>
+
+---
+
 You may include associated objects. Say for example, a user has projects:
 ```ruby
 class ProjectBlueprint < Blueprinter::Base
@@ -277,7 +354,15 @@ Output:
 }
 ```
 
-### Default Association/Field Option
+---
+</details>
+
+
+<details>
+<summary>Default Association/Field Option</summary>
+
+---
+
 By default, an association or field that evaluates to `nil` is serialized as `nil`. A default serialized value can be specified as an option on the association or field for cases when the association/field could potentially evaluate to `nil`. You can also specify a global `field_default` or `association_default` in the Blueprinter config which will be used for all fields/associations that evaluate to nil.
 
 #### Global Config Setting
@@ -300,7 +385,15 @@ class UserBlueprint < Blueprinter::Base
 end
 ```
 
-### Supporting Dynamic Blueprints for associations
+---
+</details>
+
+
+<details>
+<summary>Supporting Dynamic Blueprints For Associations</summary>
+
+---
+
 When defining an association, we can dynamically evaluate the blueprint. This comes in handy when adding polymorphic associations, by allowing reuse of existing blueprints.
 ```ruby
 class Task < ActiveRecord::Base
@@ -326,7 +419,14 @@ end
 ```
 _NOTE:_ `taskable.blueprint` should return a valid Blueprint class. Currently, `has_many` is not supported because of the very nature of polymorphic associations.
 
-### Defining a field directly in the Blueprint
+---
+</details>
+
+
+<details>
+<summary>Defining A Field Directly In The Blueprint</summary>
+
+---
 
 You can define a field directly in the Blueprint by passing it a block. This is especially useful if the object does not already have such an attribute or method defined, and you want to define it specifically for use with the Blueprint. This is done by passing `field` a block. The block also yields the object and any options that were passed from `render`. For example:
 
@@ -354,7 +454,14 @@ Output:
 }
 ```
 
-#### Defining an identifier directly in the Blueprint
+---
+</details>
+
+
+<details>
+<summary>Defining An Identifier Directly In The Blueprint</summary>
+
+---
 
 You can also pass a block to an identifier:
 
@@ -380,7 +487,14 @@ Output:
 }
 ```
 
-#### Defining an association directly in the Blueprint
+---
+</details>
+
+
+<details>
+<summary>Defining An Association Directly In The Blueprint</summary>
+
+---
 
 You can also pass a block to an association:
 
@@ -418,7 +532,14 @@ Output:
 }
 ```
 
-### Passing additional properties to `render`
+---
+</details>
+
+
+<details>
+<summary>Passing Additional Properties To #render</summary>
+
+---
 
 `render` takes an options hash which you can pass additional properties, allowing you to utilize those additional properties in the `field` block. For example:
 
@@ -446,43 +567,14 @@ Output:
 }
 ```
 
-### render_as_hash
-Same as `render`, returns a Ruby Hash.
-
-Usage:
-
-```ruby
-puts UserBlueprint.render_as_hash(user, company: company)
-```
-
-Output:
-
-```ruby
-{
-  uuid: "733f0758-8f21-4719-875f-262c3ec743af",
-  company_name: "My Company LLC"
-}
-```
-
-### render_as_json
-Same as `render`, returns a Ruby Hash JSONified. This will call JSONify all keys and values.
-
-Usage:
-
-```ruby
-puts UserBlueprint.render_as_json(user, company: company)
-```
+---
+</details>
 
-Output:
 
-```ruby
-{
-  "uuid" => "733f0758-8f21-4719-875f-262c3ec743af",
-  "company_name" => "My Company LLC"
-}
-```
+<details>
+<summary>Conditional Fields</summary>
 
-### Conditional fields
+---
 
 Both the `field` and the global Blueprinter Configuration supports `:if` and `:unless` options that can be used to serialize fields conditionally.
 
@@ -505,16 +597,24 @@ end
 
 _NOTE:_ The field-level setting overrides the global config setting (for the field) if both are set.
 
-### Custom formatting for dates and times
+---
+</details>
+
+
+<details>
+<summary>Custom Formatting for Dates and Times</summary>
+
+---
+
 To define a custom format for a Date or DateTime field, include the option `datetime_format`.
-This global or field-level option can be either a string representing the associated `strptime` format,
+This global or field-level option can be either a string representing the associated `strftime` format,
 or a Proc which receives the original Date/DateTime object and returns the formatted value.
 When using a Proc, it is the Proc's responsibility to handle any errors in formatting.
 
 
 #### Global Config Setting
 If a global datetime_format is set (either as a string format or a Proc), this option will be
-invoked and used to format all fields that respond to `strptime`.
+invoked and used to format all fields that respond to `strftime`.
 ```ruby
 Blueprinter.configure do |config|
   config.datetime_format = ->(datetime) { datetime.nil? ? datetime : datetime.strftime("%s").to_i }
@@ -556,26 +656,15 @@ Output:
 
 _NOTE:_ The field-level setting overrides the global config setting (for the field) if both are set.
 
-## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'blueprinter'
-```
+---
+</details>
 
-And then execute:
-```bash
-$ bundle
-```
 
-Or install it yourself as:
-```bash
-$ gem install blueprinter
-```
+<details>
+<summary>Sorting Fields</summary>
 
-You should also have `require 'json'` already in your project if you are not using Rails or if you are not using Oj.
+---
 
-## Sorting
 By default the response sorts the keys by name. If you want the fields to be sorted in the order of definition, use the below configuration option.
 
 Usage:
@@ -603,6 +692,81 @@ Output:
 }
 ```
 
+---
+</details>
+
+
+<details>
+<summary>render_as_hash</summary>
+
+---
+
+Same as `render`, returns a Ruby Hash.
+
+Usage:
+
+```ruby
+puts UserBlueprint.render_as_hash(user, company: company)
+```
+
+Output:
+
+```ruby
+{
+  uuid: "733f0758-8f21-4719-875f-262c3ec743af",
+  company_name: "My Company LLC"
+}
+```
+
+---
+</details>
+
+
+<details>
+<summary>render_as_json</summary>
+
+---
+
+Same as `render`, returns a Ruby Hash JSONified. This will call JSONify all keys and values.
+
+Usage:
+
+```ruby
+puts UserBlueprint.render_as_json(user, company: company)
+```
+
+Output:
+
+```ruby
+{
+  "uuid" => "733f0758-8f21-4719-875f-262c3ec743af",
+  "company_name" => "My Company LLC"
+}
+```
+
+---
+</details>
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blueprinter'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install blueprinter
+```
+
+You should also have `require 'json'` already in your project if you are not using Rails or if you are not using Oj.
+
 ## OJ
 
 By default, Blueprinter will be calling `JSON.generate(object)` internally and it expects that you have `require 'json'` already in your project's code. You may use `Oj` to generate in place of `JSON` like so:
@@ -637,14 +801,6 @@ end
 
 _NOTE:_ You should be doing this only if you aren't using `yajl-ruby` through the JSON API by requiring `yajl/json_gem`. More details [here](https://github.com/brianmario/yajl-ruby#json-gem-compatibility-api). In this case, `JSON.generate` is patched to use `Yajl::Encoder.encode` internally.
 
-## How to Document
-
-We use [Yard](https://yardoc.org/) for documentation. Here are the following
-documentation rules:
-
-- Document all public methods we expect to be utilized by the end developers.
-- Methods that are not set to private due to ruby visibility rule limitations should be marked with `@api private`.
-
 ## Contributing
 Feel free to browse the issues, converse, and make pull requests. If you need help, first please see if there is already an issue for your problem. Otherwise, go ahead and make a new issue.
 
@@ -657,6 +813,14 @@ We use Yard for documentation. Here are the following documentation rules:
 - Document all public methods we expect to be utilized by the end developers.
 - Methods that are not set to private due to ruby visibility rule limitations should be marked with `@api private`.
 
+## How to Document
+
+We use [Yard](https://yardoc.org/) for documentation. Here are the following
+documentation rules:
+
+- Document all public methods we expect to be utilized by the end developers.
+- Methods that are not set to private due to ruby visibility rule limitations should be marked with `@api private`.
+
 ### Releasing a New Version
 To release a new version, change the version number in `version.rb`, and update the `CHANGELOG.md`. Finally, maintainers need to run `bundle exec rake release`, which will automatically create a git tag for the version, push git commits and tags to Github, and push the `.gem` file to rubygems.org.
 

data/lib/blueprinter/base.rb

@@ -313,6 +313,29 @@ module Blueprinter
     def self.exclude(field_name)
       current_view.exclude_field(field_name)
     end
+    
+    # When mixing multiple views under a single view, some fields may required to be excluded from
+    # current view
+    # 
+    # @param [Array<Symbol>] the fields to exclude from the current view.
+    #
+    # @example Excluding mutiple fields from being included into the current view.
+    #   view :normal do
+    #     fields :name,:address,:position, 
+    #           :company, :contact
+    #   end
+    #   view :special do
+    #     include_view :normal
+    #     fields :birthday,:joining_anniversary
+    #     excludes :position,:address
+    #   end
+    #   => [:name, :company, :contact, :birthday, :joining_anniversary]
+    #
+    # @return [Array<Symbol>] an array of field names
+    
+    def self.excludes(*field_names)
+      current_view.exclude_fields(field_names)
+    end
 
     # Specify a view and the fields it should have.
     # It accepts a view name and a block. The block should specify the fields.

data/lib/blueprinter/version.rb

@@ -1,3 +1,3 @@
 module Blueprinter
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
 end

data/lib/blueprinter/view.rb

@@ -31,6 +31,12 @@ module Blueprinter
     def exclude_field(field_name)
       excluded_field_names << field_name
     end
+    
+    def exclude_fields(field_names)
+      field_names.each do |field_name|
+        excluded_field_names << field_name
+      end
+    end
 
     def <<(field)
       fields[field.name] = field

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Adam Hess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2019-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot