pluck_map 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 719535934f95bc4fe3db48d59fb8f8c762f23260c6438763672612d82ea12feb
-  data.tar.gz: ada8d0481118adc7d04f47b3b801e826e4b07a60d07d0d063ef10a652c891568
+  metadata.gz: d6713a4fb63be352fb7c8d54bbbdb7a559fc4b523093f3cff0a72b9507803a8e
+  data.tar.gz: e7f9e9caea6745daeb1beab73c711fd87656309fd3221422ad027072d6fcd8d7
 SHA512:
-  metadata.gz: 9d35814e0ef40d24e7ff441250c692880116540f6668ef79ce047da3424e7ff98203964e013f81c4d32d100d4f29e3e3995beb74f7f166ffa4597e5653e893f3
-  data.tar.gz: c887937585d78ef34a9d44e7fedf9ad7810ba9dd5d54525b90c577ca77eaef9450575986adb43c5f9d97d874903a688bf3f81ab538f03b520d4fa849ce0bef7f
+  metadata.gz: ca03d1e1f7e82934ee018c93ac980b7f35c8d9805782de196cb1941b36992880ef19f193d8d9055ac03a3999cf58168503e65ccd74fd10a59d806178c2d8950f
+  data.tar.gz: 48822bd995380e8a97e5166c94f890b010823b55227884c66f06e6d4d36b6baf22c9b577aa3acf9670d2cca186c4dac3ccb6ee165b8c27e7861f89d31c4ba5ce

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.6.2 (2019 Jun 13)
+
+* FIX: Allow presenting a subclass of the presenter's model (@kobsy)
+
 ## v0.6.1 (2019 May 12)
 
 * FIX: Aliased SQL expressions to work-around a bug with Rails Postgres adapter (@kobsy)

data/README.md

@@ -5,7 +5,19 @@
 
 This library provides a DSL for presenting ActiveRecord::Relations without instantiating ActiveRecord models. It is useful when a Rails controller action does little more than fetch several records from the database and present them in some other data format (like JSON or CSV).
 
-### Why?
+
+### Table of Contents
+
+- [Why PluckMap?](https://github.com/boblail/pluck_map#why-pluckmap)
+- Usage
+  - [Defining attributes to present](https://github.com/boblail/pluck_map#defining-attributes-to-present)
+  - [Presenting Records](https://github.com/boblail/pluck_map#presenting-records)
+- [Installation](https://github.com/boblail/pluck_map#installation)
+- [Requirements](https://github.com/boblail/pluck_map#requirements)
+- [Development & Contributing](https://github.com/boblail/pluck_map#development)
+
+
+## Why PluckMap?
 
 Suppose you have an action like this:
 
@@ -96,7 +108,7 @@ Jbuilder gives you a similar DSL for defining JSON to be presented but it operat
 
 ## Usage
 
-### Attributes
+### Defining Attributes to Present
 
 #### Syntax
 
@@ -196,6 +208,70 @@ end
 ```
 
 
+### Presenting Records
+
+#### `:to_h`
+
+Once you've defined a presenter, pass an `ActiveRecord::Relation` to `to_h` to get an array of hashes:
+
+```ruby
+presenter = PluckMap[Person].define do
+  id
+  type value: "Person"
+end
+
+presenter.to_h(Person.where(id: 1)) # => [{ id: 1, type: "Person" }]
+```
+
+#### `:to_json` and `:to_csv`
+
+You can `.map` that array to construct whatever document you need, but PluckMap implements two methods that are optimized for generating JSON and CSV:
+
+```ruby
+presenter.to_json(Person.where(id: 1)) # => '[{"id":1,"type":"Person"}]'
+presenter.to_csv(Person.where(id: 1)) # => "id,type\n1,Person"
+```
+
+#### Custom Presenters
+
+You can define new (or override existing) presenter methods by mixing modules into `PluckMap::Presenter`. Here's an example of how you might create a presenter that produces an Excel document using an imaginary `Excel::Document` library:
+
+```ruby
+module PluckToXlsxPresenter
+  def to_excel(query)
+    # Every presenter method accepts an ActiveRecord::Relation
+    # and passes it to `pluck` which yields the results.
+    pluck(query) do |results|
+
+      # Use an imaginary Excel gem that has an Excel::Document object
+      spreadsheet = Excel::Document.new
+
+      # Fill in a Header row
+      # `attributes` is a method on `PluckMap::Presenter` that describes
+      # the attributes you defined when you constructed the presenter.
+      attributes.each_with_index do |attribute, i|
+        spreadsheet.cell[0, i] = attribute.name
+      end
+
+      # Results is an array of rows (Rows are an array of values)
+      results.each_with_index do |values, row_number|
+        attributes.each_with_index do |attribute, column_number|
+
+          # `attribute.exec` will pick the right values from the row
+          # and perform any required processing.
+          spreadsheet.cell[row_number + 1, column_number] = attribute.exec(values)
+        end
+      end
+
+      spreadsheet.render # `pluck` returns the result of the block
+    end
+  end
+end
+
+PluckMap::Presenter.send :include, PluckToXlsxPresenter
+```
+
+
 
 ## Installation
 
@@ -214,7 +290,8 @@ Or install it yourself as:
     $ gem install pluck_map
 
 
-### Requirements
+
+## Requirements
 
 The gem's only runtime requirement is:
 

data/lib/pluck_map/presenter.rb

@@ -33,7 +33,7 @@ module PluckMap
   protected
 
     def pluck(query)
-      if model && query.model != model
+      unless model.nil? || query.model <= model
         raise ArgumentError, "Query for #{query.model} but #{model} expected"
       end
 

data/lib/pluck_map/version.rb

@@ -1,3 +1,3 @@
 module PluckMapPresenter
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluck_map
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-13 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord