the_grid 1.0.10 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTE1YjBhNmMwMmNiZTk4MjJiYTAzYmM4ZTc3Nzk3ZWM1NmRkOGUxNw==
+    Y2YyOTU4N2Y4MWQ1NDcxZTZmNmZiZTIxOTE4M2JkNGUwMTNjZDUyNA==
   data.tar.gz: !binary |-
-    YzZkNGM1ZDMxOTZkZjg5YmMzMmExZDg1N2Q5YTEzYjNkOWJmOTNjYg==
+    ZDJkZThhYjEzYjBjYTc0YmM4NjU3NzkxZWM2NTgwMDFiZGM4ZWMzNQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YWE1NDcwMTYwZDAzOWRiMTAwN2M2ZmIzYzBhOGVlZjYzZjI4ZDcyOTZjOGMy
-    NDY1MjgyNGE4ZmU2ZDhkOTk4MTE3NTJhYWIxNzdjZTMyMzE2ZGJhYmIzZTBk
-    ODk2OWUxNjFjNTMxMmViYTExMDI3MmE0ZTE2MzU2NWFiM2UzNzg=
+    NGFhZjQ2NTJjMzhkYTFmMzJkNGY4ZTA5NzQ0MWU5YzMwMGRiYzA4ODMwY2U0
+    YzAxZWM2ZDgwMDBiMTE3OTRkOGUxYTg5YzBhMTQ5MGE1MDg5NTM4YWUwMDk3
+    ODQwOTJlZWM1MmQ1NmJhYzViOWQ2OWFiZWFmMTI1NGFhMTNhYmI=
   data.tar.gz: !binary |-
-    NDEyMWRjYjUxNmM5MzUwYzA1YWJmZDM1NDBkMzIzZDY4MzllOTlkZDJkZGM3
-    NTc1MDU5MzI4YjdhMzM3ZjljYWRmZTMxZjVlMmQ1NGM1NDQ3NjM4MjBkYTQ0
-    MWY5YzBlMTY1NjM0N2ZjNmY5NTU5YmY4NTg0YjlmNzhkNDYwMzg=
+    YjViYzJjMWZhZmMzMTY4YmE2YzVlOTQ3YzU3YTBiOWZiY2I3NDU0MDU4MTY0
+    ZDJlYjY4MzkyYmUwNzhhYmE2MjllMWZlODJhYWY1NTExNjFjMzE4YmE4MjNi
+    MDAyN2FjNTA1YTQ4NmUzZThjY2FmNjkwZTU2YzZmMWQzOWUwNTQ=

data/README.md

@@ -1,13 +1,13 @@
 Yet Another Grid
 =========
 
-This plugin is designed to provide API for building json response based on `ActiveRecord::Relation` objects.
+This plugin is designed to provide API for building response based on `ActiveRecord::Relation` objects (json, csv, even using custom view builder).
 It makes much easier to fetch information from database for displaying it using JavaScript MV* based frameworks such as Knockout, Backbone, Angular, etc.
 
 ## Getting started
 
 First of all specify grid in your Gemfile and run `bundle install`.
-After gem is installed you need to run `rails generate grid:install`. This will generate grid initializer file with basic configuration.
+After gem is installed you need to run `rails generate the_grid:install`. This will generate grid initializer file with basic configuration.
 
 ## Usage
 
@@ -37,6 +37,8 @@ grid_for @articles, :per_page => 25 do
 end
 ```
 
+The same grid defenition can be used with different formats.
+
 ## API
 
 The API is based on commands. Term *command* describes client's action which can be simple or complicated as well.
@@ -422,6 +424,38 @@ grid_for @groups, :per_page => 2 do
   end
 end
 ```
+#### CSV builder
+
+It's possible to generate csv using grid views.
+The main power is that this view builder also responds to also the api request parameters except pagination.
+So, it's possible to filter records for output csv. All what you need is just create a simple view:
+```ruby
+# app/views/products/index.csv.grid_builder
+grid_for @products do
+  column :title
+  column :qty
+  column :created_at
+end
+```
+And in your controller
+```ruby
+# app/controllers/products_controller.rb
+class ProductsController < ApplicationController
+  respond_to :csv, :html
+
+  def index
+    @products = Product.active
+    respond_with @products
+  end
+end
+```
+
+Then you can send requests like:
+```
+http://your.domain.com/route.csv?cmd[]=filter&filters[is_active]=1
+```
+and will get csv file which contains only filtered active products.
+
 ## License
 
 Released under the [MIT License](http://www.opensource.org/licenses/MIT)

data/lib/generators/the_grid/install/templates/the_grid.rb

@@ -6,5 +6,5 @@ TheGrid.configure do |config|
   config.default_max_per_page = 25
 
   # Print json response with new lines and tabs
-  config.prettify_json = ActionView::Base.pretty_print_json
-end
+  config.prettify_json = Rails.env.development?
+end

data/lib/the_grid/builder/csv.rb

@@ -0,0 +1,45 @@
+require 'csv'
+
+module TheGrid
+  class Builder::Csv
+    attr_reader :api, :context
+
+    BATCH_SIZE = 1000
+
+    def initialize(relation, context)
+      @api = TheGrid::Api.new(relation)
+      @context = context
+    end
+
+    def assemble_with(params)
+      options = params.merge context.params
+      api.compose!(options.merge :per_page => BATCH_SIZE)
+      generate_csv_with(options)
+    end
+
+  private
+
+    def generate_csv_with(options)
+      CSV.generate do |csv|
+        csv << headers
+        put_relation_to(csv)
+      end
+    end
+
+    def put_relation_to(csv)
+      (1..api.options[:max_page]).each do |page|
+        relation = api.run_command!(:paginate, :page => page, :per_page => BATCH_SIZE)
+        put_records_to(csv, relation)
+      end
+    end
+
+    def put_records_to(csv, records)
+      context.assemble(records).each{ |row| csv << row.values }
+    end
+
+    def headers
+      context.options[:headers] || context.columns.keys.map { |col| col.to_s.titleize }
+    end
+
+  end
+end

data/lib/the_grid/builder.rb

@@ -10,21 +10,26 @@ module TheGrid
       end
 
       %{
-        ::TheGrid::Builder.assemble(:view_type => ::TheGrid::Builder::Json, :scope => self) {
+        ::TheGrid::Builder.assemble(:format => #{template.formats.first.inspect}, :scope => self) {
           #{source}
         }
       }
     end
 
+    def self.detect_view(format)
+      @@view_types ||= {}
+      @@view_types[format] ||= "the_grid/builder/#{format}".camelize.constantize
+    end
+
     def self.assemble(options, &block)
-      new(options, &block)
+      new(options, &block).instance_eval(&block)
     end
 
     def initialize(options, &block)
-      options.assert_valid_keys(:scope, :view_type)
+      options.assert_valid_keys(:scope, :format)
 
       @_scope = options.delete(:scope)
-      @_view_type = options.delete(:view_type)
+      @_view_type = self.class.detect_view(options.delete(:format))
 
       copy_instance_variables_from(@_scope) if @_scope
       self.instance_eval(&block)
@@ -32,11 +37,7 @@ module TheGrid
 
     def grid_for(relation, options = {}, &block)
       context = Context.new(options.merge(:scope => @_scope), &block)
-      @_view_handler = @_view_type.new(relation, context)
-    end
-
-    def assemble(&block)
-      @_view_handler.assemble_with(@_scope.params, &block)
+      @_view_type.new(relation, context)
     end
 
     def method_missing(name, *args, &block)
@@ -47,14 +48,11 @@ module TheGrid
       end
     end
 
-    def to_s; assemble;end
-    def to_str; assemble;end
-
   private
 
     def copy_instance_variables_from(object)
       vars = object.instance_variables.map(&:to_s)
-      vars.each { |name| instance_variable_set(name.to_sym, object.instance_variable_get(name)) }
+      vars.each{ |name| instance_variable_set(name.to_sym, object.instance_variable_get(name)) }
     end
 
   end

data/lib/the_grid/version.rb

@@ -1,3 +1,3 @@
 module TheGrid
-  VERSION = "1.0.10"
+  VERSION = "1.1.0"
 end

data/spec/builder/csv_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require_relative 'view_builder_helper'
+
+describe TheGrid::Builder::Csv do
+  subject{ TheGrid::Builder::Csv.new(relation, build_context) }
+
+  include_examples "for Grid View Builder"
+  before(:each) { subject.api.stub(:compose!){ subject.api.options[:max_page] = 1 } }
+
+  let(:relation) { double.as_null_object }
+  let(:record)   {{ :id => 1, :name => "Name", :status => "Active", :text => "Text" }}
+  let(:records)  {[ record, record, record ]}
+  let(:params)   {{ :cmd => [:sort], :field => :name, :order => :desc, :per_page => subject.class.const_get("BATCH_SIZE") }}
+
+  it "generates expected csv string" do
+    subject.assemble_with(params).should eql generate_csv(records, subject.context.options[:headers])
+  end
+
+  it "uses titleized column names if headers are not specified" do
+    subject.context.stub(:options => {})
+    headers = record.keys.map{|c| c.to_s.titleize }
+    subject.assemble_with(params).should eql generate_csv(records, headers)
+  end
+
+  it "generates csv records in batches" do
+    subject.api.should_receive(:run_command!).with(:paginate, :page => 1, :per_page => params[:per_page])
+    subject.assemble_with(params);
+  end
+
+
+  def generate_csv(records, headers)
+    CSV.generate do |csv|
+      csv << headers
+      records.each{ |item| csv << item.values }
+    end
+  end
+
+  def build_context
+    TheGrid::Builder::Context.new do
+      headers "Id", "Title", "Status", "Description"
+      column :name
+      column :status
+      column :text
+    end
+  end
+
+end

data/spec/builder/json_spec.rb

@@ -1,21 +1,22 @@
 require 'spec_helper'
+require_relative 'view_builder_helper'
 
 describe TheGrid::Builder::Json do
-  subject { TheGrid::Builder::Json.new(relation, context) }
+  subject{ TheGrid::Builder::Json.new(Object.new, build_context) }
 
-  before(:each) { subject.api.stub(:compose!) { subject.api.options[:max_page] = 25 } }
+  include_examples "for Grid View Builder"
+  before(:each) { subject.api.stub(:compose!){ subject.api.options[:max_page] = 25 } }
 
-  let(:relation) { double('Relation').as_null_object }
-  let(:context) { create_context.tap { |c| c.stub(:assemble => [1,2,3,4]) } }
-  let(:params) {{  :cmd => [:sort], :field => :name, :order => :desc }}
+  let(:records) {[ 1, 2, 3, 4 ]}
+  let(:params)  {{ :cmd => [:sort], :field => :name, :order => :desc }}
 
-  let(:meta) {{ "meta" => {"api_key" => context.options[:api_key]}, "columns" => columns }}
-  let(:columns) { context.visible_columns.stringify_keys.map{ |n, o| o.merge "name" => n } }
-  let(:json_schema) {{ "max_page" => 25, "items" => context.assemble }}
+  let(:meta) {{ "meta" => {"api_key" => subject.context.options[:api_key]}, "columns" => columns }}
+  let(:columns) { subject.context.visible_columns.stringify_keys.map{ |n, o| o.merge "name" => n } }
+  let(:json_schema) {{ "max_page" => 25, "items" => subject.context.assemble }}
   let(:assembled_result) { JSON.parse(subject.assemble_with(params)) }
 
   it "merges params with context options" do
-    subject.api.should_receive(:compose!).with(params.merge context.options)
+    subject.api.should_receive(:compose!).with(params.merge subject.context.options)
     subject.assemble_with params
   end
 
@@ -29,16 +30,13 @@ describe TheGrid::Builder::Json do
   end
 
   it "generates json notification when get wrong argument" do
-    subject.api.stub(:compose!) { raise ArgumentError, "123" }
-    assembled_result.should eql({"status" => "error", "message" => "123"})
+    subject.api.stub(:compose!) { raise ArgumentError, "my message" }
+    assembled_result.should eql "status" => "error", "message" => "my message"
   end
 
-
-  def create_context
+  def build_context
     TheGrid::Builder::Context.new do
-      api_key "hello_world"
-      delegate  :sort => :articles, :filter => :articles
-
+      api_key 1234567
       column :name
       column :is_active
     end

data/spec/builder/view_builder_helper.rb

@@ -0,0 +1,10 @@
+shared_examples "for Grid View Builder" do
+  before(:each) { subject.context.stub(:assemble => records) }
+
+  it { should respond_to(:assemble_with) }
+
+  it "merges context with params" do
+    subject.api.should_receive(:compose!).with(params.merge subject.context.options)
+    subject.assemble_with(params)
+  end
+end

data/the_grid.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.description = <<-EOF
 Provides json API for building ActiveRecord::Relation's.  It makes much easier to fetch information from database for displaying it using JavaScript MV* based frameworks such as Knockout, Backbone, Angular, etc.
 
-Tags: json, grid, api, grid builder, activerecord relation builder, relation
+Tags: json, csv, grid, api, grid builder, activerecord relation builder, relation
 EOF
 
   s.post_install_message = <<-_MSG_

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_grid
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.1.0
 platform: ruby
 authors:
 - Sergiy Stotskiy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-17 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -72,7 +72,7 @@ description: ! 'Provides json API for building ActiveRecord::Relation''s.  It ma
   MV* based frameworks such as Knockout, Backbone, Angular, etc.
 
 
-  Tags: json, grid, api, grid builder, activerecord relation builder, relation
+  Tags: json, csv, grid, api, grid builder, activerecord relation builder, relation
 
 '
 email: sergiy.stotskiy@gmail.com
@@ -97,6 +97,7 @@ files:
 - lib/the_grid/api/command/sort.rb
 - lib/the_grid/builder.rb
 - lib/the_grid/builder/context.rb
+- lib/the_grid/builder/csv.rb
 - lib/the_grid/builder/json.rb
 - lib/the_grid/config.rb
 - lib/the_grid/version.rb
@@ -109,7 +110,9 @@ files:
 - spec/api/command_spec.rb
 - spec/api_spec.rb
 - spec/builder/context_spec.rb
+- spec/builder/csv_spec.rb
 - spec/builder/json_spec.rb
+- spec/builder/view_builder_helper.rb
 - spec/config_spec.rb
 - spec/spec_helper.rb
 - the_grid.gemspec