decisive 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d28c31cc0299732df3599ea1902bfa2d6586ae70
-  data.tar.gz: 5002e3b395a7fb0f56ff77ec1bab7e9280fa9016
+  metadata.gz: 4f0269f515fd1e730866f0d198e2f65af1006e15
+  data.tar.gz: 1c6961707b95dbc84f71ccb77c8d5f33aac1cb0b
 SHA512:
-  metadata.gz: f413f05a6292d19c47d716f8792ff58ee5f3715d13105b1823b450e32b99f696c86cd65f529a6d10a90f2aeef74dec45aaaf64193e65db195095a226de79fb86
-  data.tar.gz: 4ed224da57a64802dbaeb0126a98ffbc472c33a28b833eb3d69728ada9f5c690a5723ae62a574b45879a49cedada464b7025abd7a4e65e69195210e59b51345d
+  metadata.gz: 06c93c1c33a9f0b291fa598de426e6d5fe8372668944c0bdbdceb578d8f6703ed6695c016559176de2dc697c2967e21094bb8032b01d7e4115b278b750e26e45
+  data.tar.gz: c675a9f1d1b242bfe0cd4f3badcd0cdac7df8d4d256c5a2bbf49947e3ba7793546d57acd4b448debeb760c1924e4c855d6790bc8015404f5a85e3f0ed8bc0841

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    decisive (0.3.0)
+    decisive (0.4.0)
       actionview
 
 GEM

data/README.md

@@ -1,18 +1,20 @@
 # Decisive
 
-DSL for rendering CSVs in Rails apps
+DSL for rendering and streaming CSVs in Rails apps
 
 [![Build Status](https://travis-ci.org/botandrose/decisive.svg?branch=master)](https://travis-ci.org/botandrose/decisive)
 [![Code Climate](https://codeclimate.com/github/botandrose/decisive/badges/gpa.svg)](https://codeclimate.com/github/botandrose/decisive)
 
 ## Usage
 
-Example usage:
+### Example usage:
 
 ```ruby
 # app/controllers/users_controller.rb
 
 class UsersController < ApplicationController
+  include ActionController::Live # required to stream; decisive will fall back to rendering without it
+
   def index
     @users = User.all
   end
@@ -22,20 +24,52 @@ end
 ```ruby
 # app/views/users/index.csv.decisive
 
-csv @users, filename: "users-#{Time.zone.now.strftime("%Y_%m_%d")}.csv" do |user|
+csv @users, filename: "users-#{Time.zone.now.strftime("%Y_%m_%d")}.csv" do
   column "Email" # omitted accessor field gets inferred: user.email
   column "Full name", :name # explicit accessor field: user.name
-  column "Signed up", user.created_at.to_date # other values get passed straight through
+  column "Signed up" do |user| # accepts a block for doing something special
+    user.created_at.to_date
+  end
 end
 ```
 
-Then visit /users.csv to get file named "users-2010_01_01.csv" with the following contents:
+Then visit /users.csv to stream a file named "users-2010_01_01.csv" with the following contents:
 
 | Email             | Full name      | Signed up  |
 | ----------------- | -------------- | ---------- |
 | frodo@example.com | Frodo Baggins  | 2002-06-19 |
 | sam@example.com   | Samwise Gamgee | 2008-10-13 |
 
+### Non-streaming usage for non-deterministic headers:
+
+Sometimes, we don't know exactly what the headers will be until we've iterated through every record.
+
+For example, lets say that the Frodo record has a #faqs attribute of `{ "Riddles?" => "Yes" }`, while Sam's is `{ "Hero?" => "Frodo" }`.
+
+In this case, you can pass `stream: false` to #csv, and the method will yield each record to the block:
+
+```ruby
+# app/views/users/index.csv.decisive
+
+csv @users, filename: "users-#{Time.zone.now.strftime("%Y_%m_%d")}.csv", stream: false do |user|
+  column "Email"
+  column "Full name"
+
+  user.faqs.favorite_questions_and_answers.each do |question, answer|
+    column question, answer
+  end
+
+  column "Signed up", user.created_at.to_date # we have access to the user record directly
+end
+```
+
+Visiting /users.csv will render a file named "users-2010_01_01.csv" with the following contents:
+
+| Email             | Full name      | Riddles? | Hero? | Signed up  |
+| ----------------- | -------------- | -------- | ----- | ---------- |
+| frodo@example.com | Frodo Baggins  | Yes      |       | 2002-06-19 |
+| sam@example.com   | Samwise Gamgee |          | Frodo | 2008-10-13 |
+
 ## 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.

data/lib/decisive/template_handler.rb

@@ -12,19 +12,84 @@ module Decisive
       <<~RUBY
         extend Decisive::DSL
         context = (#{template.source})
+
+        response.headers["Content-Type"] = "text/csv"
+        response.headers["Content-Transfer-Encoding"] = "binary"
         response.headers["Content-Disposition"] = %(attachment; filename="\#{context.filename}")
-        context.to_csv
+
+        if controller.respond_to?(:new_controller_thread) # has AC::Live mixed in
+          begin
+            context.each do |row|
+              response.stream.write row.to_csv
+            end
+          ensure
+            response.stream.close
+          end
+          ""
+        else
+          context.to_csv
+        end
       RUBY
     end
   end
 
+  class StreamIncompatibleBlockArgumentError < StandardError
+    def message
+      "#csv cannot take a block with a record argument while streaming, because the headers have to be known in advance. Either disable streaming by passing `stream: false` to #csv, or convert the template to yield the record to the block passed to each #column call."
+    end
+  end
+
+  class StreamingNotEnabledByControllerError < StandardError
+    def message
+      "the controller does not have ActionController::Live included, and thus cannot stream this csv. Either disable streaming by passing `stream: false` to #csv, or include ActionController::Live into the controller."
+    end
+  end
+
   module DSL
-    def csv records, filename:, &block
-      Context.new(records, filename, block)
+    def csv records, filename:, stream: true, &block
+      if stream
+        raise StreamingNotEnabledByControllerError unless controller.respond_to?(:new_controller_thread) # has AC::Live mixed in
+        raise StreamIncompatibleBlockArgumentError if block.arity != 0
+        StreamContext.new([], records, filename, &block)
+      else
+        RenderContext.new(records, filename, block)
+      end
     end
   end
 
-  class Context < Struct.new(:records, :filename, :block)
+  class StreamContext < Struct.new(:columns, :records, :filename)
+    class Column < Struct.new(:label, :block); end
+
+    def initialize *args, &block
+      super
+      instance_eval &block
+    end
+
+    def column label, value=nil, &block # field, label: field.to_s.humanize, &block
+      value ||= label.parameterize.underscore.to_sym
+      block ||= ->(record) { record.send(value) }
+      columns << Column.new(label, block)
+    end
+
+    def each
+      yield header
+
+      records.map do |record|
+        row = columns.map do |column|
+          column.block.call(record).to_s
+        end
+        yield row
+      end
+    end
+
+    private
+
+    def header
+      columns.map(&:label)
+    end
+  end
+
+  class RenderContext < Struct.new(:records, :filename, :block)
     def to_csv
       (header + body).map(&:to_csv).join
     end
@@ -50,27 +115,27 @@ module Decisive
         Row.new(record, block).to_hash
       end
     end
-  end
 
-  class Row < Struct.new(:record, :block)
-    def to_hash
-      @hash = {}
-      instance_exec record, &block
-      @hash
-    end
+    class Row < Struct.new(:record, :block)
+      def to_hash
+        @hash = {}
+        instance_exec record, &block
+        @hash
+      end
 
-    private
+      private
 
-    def column key, value=nil, &block
-      @hash[key] = if block_given?
-        block.call(record)
-      elsif value.is_a?(Symbol)
-        record.send(value)
-      elsif value.nil?
-        record.send(key.parameterize.underscore.to_sym)
-      else
-        value
-      end.to_s
+      def column key, value=nil, &block
+        @hash[key] = if block_given?
+          block.call(record)
+        elsif value.is_a?(Symbol)
+          record.send(value)
+        elsif value.nil?
+          record.send(key.parameterize.underscore.to_sym)
+        else
+          value
+        end.to_s
+      end
     end
   end
 end

data/lib/decisive/version.rb

@@ -1,3 +1,3 @@
 module Decisive
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decisive
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Micah Geisel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-08 00:00:00.000000000 Z
+date: 2019-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview