the_grid 1.1.3 → 1.1.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGE5YjY3ZGZiZjJjOWUxMjBlMDlkMGNmYzRlMGQ0ODEzMTYyODc3Yg==
+    YTM1YzE1MmUxNzZjZTZlNjIyYjNkNjhhYWNiNmY4YWQ2ZGU4YjAzMQ==
   data.tar.gz: !binary |-
-    ZWVmMDM4YTAxOGM3N2Y1NmI2ZmI5YTY0ZTcxMDZhMmQ4MTc0NmRiMQ==
+    NTkyN2FmNTZlMWUxZWM0NDI4YmVkNTYzMjMyODdkYWE5MGVlOWE1Yg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YjEwYWU3Y2E5MGE5YmYwYWZmYmE5MmMyY2YwNjVhNjYxOTBiYWE2NmYwZDk4
-    NjY3MzY5Y2Y4YmU4M2UxNjRhMmNjNDE5NzVlMDNlOTU0YzdlMTgxOWU4Y2Ni
-    Njg4YjUwNjA2NThmNjgwNDYxNjMyOWY5MjI4NmU5Y2Q5MDI3ZGI=
+    NDkyYzc4ZDQ4NjM3YWU3OTNjZDQ2YzQzZTNkYzU1NWJjY2IyYTYzMjQ2ZmEy
+    YjI3YmIyYmM5MzRjZTJkNjE5NDU0YWM1YzFhZTQ5NjljNjdkMGU3NmFlNTlk
+    ZDQyMmEzMjk2ZTkxN2QwM2YxMDIwYmEwM2Q3NzVlNTZhNTEzY2E=
   data.tar.gz: !binary |-
-    YTI3NzIwMTc2MmJiNzY5YTQzZmVjZjU0ODVjYmM0NGQ5N2NmNGEwNDljZWYw
-    MGU4NzhhZmQ5NjAwZjIyMzc4YWY4MDMxZjUyMDllMGQ2MGE1NmMzZDIxYzQx
-    ZTNjMGY3YzQ2Y2I0Y2FjYzM2MWFkNDU1OGIxMmRkNGI0OWE5MGQ=
+    ZTM1YzgyZTYwZjI4MDU2MjUwODRhMDFlNDM0ZGIxNGU3YzI1YjdiZWE0OTE5
+    Nzk1MTc2MGViZDEzN2VhNTFlYjg3NGU1MDg5N2E3MTFhODRkMjc0MTQzODJl
+    ODA0ZDMwZDQwMWI4Nzc4NGE4ZGFjNmYwMWI4ODdiODE2MDJlMzA=

data/lib/the_grid/api/command.rb

@@ -1,6 +1,14 @@
 module TheGrid
   class Api::Command
 
+    autoload :BatchRemove, 'the_grid/api/command/batch_remove'
+    autoload :BatchUpdate, 'the_grid/api/command/batch_update'
+    autoload :Filter,      'the_grid/api/command/filter'
+    autoload :Paginate,    'the_grid/api/command/paginate'
+    autoload :Search,      'the_grid/api/command/search'
+    autoload :Sort,        'the_grid/api/command/sort'
+
+
     def self.find(cmd)
       @@commands ||= {}
       @@commands[cmd] ||= build(cmd)

data/lib/the_grid/api.rb

@@ -36,7 +36,7 @@ module TheGrid
     end
 
     def command_delegated?(cmd)
-      options[:delegated_commands].has_key?(cmd.to_s)
+      options[:delegated_commands] && options[:delegated_commands].has_key?(cmd.to_s)
     end
 
     def configure(params)

data/lib/the_grid/builder/context.rb

@@ -48,6 +48,12 @@ module TheGrid
       end
     end
 
+    def column_titles
+      self.options[:titles] ||= columns.flat_map do |name, options|
+        options[:as].kind_of?(self.class) ? options[:as].column_titles : options.fetch(:title, name.to_s.titleize)
+      end
+    end
+
     def assemble(records)
       records.map{ |record| assemble_row_for(record) }
     end

data/lib/the_grid/builder/csv.rb

@@ -1,49 +1,49 @@
 require 'csv'
 
 module TheGrid
-  class Builder::Csv
-    attr_reader :api, :context
-
+  module Builder::Csv
+    extend self, Builder::Base
     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) if api.relation.respond_to?(:connection)
-      generate_csv_with(options)
-    end
-
-  private
-
-    def generate_csv_with(options)
+    def build(context, options)
+      records, params = options.values_at(:for, :with)
+      options.merge! :per_page => BATCH_SIZE if records.respond_to?(:connection)
+      api = compose(records, options)
       CSV.generate do |csv|
-        csv << headers
-        api.relation.kind_of?(Array) ? put_data_to(csv) : put_relation_to(csv)
+        csv << context.column_titles
+        api.relation.respond_to?(:connection) ? put(context, :to => csv, :with => api) : put_this(context, :to => csv, :with => records)
       end
     end
 
-    def put_data_to(csv)
-      put_records_to(csv, api.relation)
-    end
+  private
 
-    def put_relation_to(csv)
+    def put(context, options)
+      api, csv = options.values_at(:with, :to)
       pages = api.options[:max_page]
       (1..pages).each do |page|
         relation = api.run_command!(:paginate, :page => page, :per_page => BATCH_SIZE, :size => pages * BATCH_SIZE)
-        put_records_to(csv, relation)
+        put_this(context, :to => csv, :with => relation)
       end
     end
 
-    def put_records_to(csv, records)
-      context.assemble(records).each{ |row| csv << row.values }
+    def put_this(context, options)
+      context.assemble(options[:with]).each do |row|
+        flatten(row).each{ |row| options[:to] << row }
+      end
     end
 
-    def headers
-      context.options[:titles] || context.columns.keys.map { |col| col.to_s.titleize }
+    def flatten(row)
+      # TODO: optimize it
+      row_values, row_nested_values = [], []
+      row.each do |field, value|
+        if value.kind_of?(Array)
+          row_nested_values += value.flat_map{ |r| flatten(r) }
+        else
+          row_values << value 
+        end
+      end
+      return [ row_values ] if row_nested_values.empty?
+      row_nested_values.each{ |nested_values| nested_values.unshift(*row_values) }
     end
 
   end

data/lib/the_grid/builder/json.rb

@@ -1,38 +1,22 @@
 module TheGrid
-  class Builder::Json
-    cattr_accessor :prettify_json
-    attr_reader :api, :context
+  module Builder::Json
+    extend self, Builder::Base
+    mattr_accessor :prettify_json
 
-    def initialize(relation, context)
-      @api = TheGrid::Api.new(relation)
-      @context = context
-    end
-
-    def assemble_with(params)
-      options = params.merge context.params
-      api.compose!(options)
-      stringify as_json_with(options)
-    rescue ArgumentError => error
-      stringify as_json_message('error', error.message)
-    end
-
-  private
-
-    def stringify(json_hash)
-      self.class.prettify_json ? JSON.pretty_generate(json_hash) : json_hash.to_json
-    end
-
-    def as_json_with(options)
+    def build(context, params)
+      api, options = compose(params[:for], params[:with]), params[:with]
       json = {:max_page => api.options[:max_page], :items => context.assemble(api.relation)}
       if options[:with_meta]
         json[:meta] = context.options.except(:delegate, :search_over)
         json[:columns] = columns_as_array(context.visible_columns)
       end
-      json
+      stringify json
     end
 
-    def as_json_message(status, message)
-      {:status => status, :message => message}
+  private
+
+    def stringify(json_hash)
+      self.prettify_json ? JSON.pretty_generate(json_hash) : json_hash.to_json
     end
 
     def columns_as_array(columns)

data/lib/the_grid/builder.rb

@@ -2,6 +2,10 @@ module TheGrid
   class Builder
     private_class_method :new
 
+    autoload :Context, 'the_grid/builder/context'
+    autoload :Csv,     'the_grid/builder/csv'
+    autoload :Json,    'the_grid/builder/json'
+
     def self.call(template)
       source = if template.source.empty?
         File.read(template.identifier)
@@ -37,7 +41,7 @@ module TheGrid
 
     def grid_for(relation, options = {}, &block)
       context = Context.new(options.merge(:scope => @_scope), &block)
-      @_view_type.new(relation, context).assemble_with(@_scope.params)
+      @_view_type.assemble(context, :on => relation, :with => @_scope.params)
     end
 
     def method_missing(name, *args, &block)
@@ -55,5 +59,32 @@ module TheGrid
       vars.each{ |name| instance_variable_set(name.to_sym, object.instance_variable_get(name)) }
     end
 
+
+    module Base
+
+      def compose(records, params)
+        api = ::TheGrid::Api.new(records)
+        api.compose!(params)
+        api
+      end
+
+      def assemble(context, options)
+        options.assert_valid_keys(:on, :with)
+        params = options[:with].merge context.params
+        build(context, :for => options[:on], :with => params)
+      rescue ArgumentError => error
+        stringify :status => 'error', :message => error.message
+      end
+
+      def stringify(data)
+        data.inspect
+      end
+
+      def build
+        raise NotImplementedError
+      end
+
+    end
+
   end
 end

data/lib/the_grid/version.rb

@@ -1,3 +1,3 @@
 module TheGrid
-  VERSION = "1.1.3"
+  VERSION = "1.1.4"
 end

data/lib/the_grid.rb

@@ -3,9 +3,6 @@ require 'the_grid/api'
 require 'the_grid/api/command'
 require 'the_grid/builder'
 require 'the_grid/config'
-Dir.chdir(File.dirname(__FILE__)) do
-  Dir['the_grid/builder/**/*.rb', 'the_grid/api/command/**/*.rb'].each{ |f| require f }
-end
 
 module TheGrid
   def self.configure

data/spec/builder/context_spec.rb

@@ -88,6 +88,11 @@ describe TheGrid::Builder::Context do
       context = build_context{ scope_for(:articles, :as => :children, &dsl) }
       context.columns[:children][:as].should be_kind_of subject
     end
+
+    it "returns titles for columns from attributes" do
+      context = build_context{ column(:id, :title => "Name") }
+      context.column_titles.should eql %w{Name}
+    end
   end
 
   context "when collects visible columns" do

data/spec/builder/csv_spec.rb

@@ -2,30 +2,32 @@ require 'spec_helper'
 require_relative 'view_builder_helper'
 
 describe TheGrid::Builder::Csv do
-  subject{ TheGrid::Builder::Csv.new(relation, build_context) }
+  subject{ TheGrid::Builder::Csv }
 
   include_examples "for Grid View Builder"
-  before(:each) { subject.api.stub(:compose!) }
-  before(:each) { 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") }}
+  let(:api_options) {{ :max_page => 1 }}
+  let(:context)  { build_context }
+  let(:relation) { double(:connection => double.as_null_object).as_null_object }
+  let(:params)   {{ :cmd => [:sort], :field => :name, :order => :desc, :per_page => subject.const_get("BATCH_SIZE") }}
 
   it "generates expected csv string" do
-    subject.assemble_with(params).should eql generate_csv(records, subject.context.options[:titles])
+    subject.assemble(context, :on => relation, :with => params).should eql generate_csv(records, context.column_titles)
   end
 
   it "uses titleized column names if titles are not specified" do
-    subject.context.stub(:options => {})
-    titles = record.keys.map{|c| c.to_s.titleize }
-    subject.assemble_with(params).should eql generate_csv(records, titles)
+    context.stub(:options => {})
+    subject.assemble(context, :on => relation, :with => params).should eql generate_csv(records, context.column_titles)
   end
 
   it "generates csv records in batches" do
-    subject.api.should_receive(:run_command!).with(:paginate, :page => 1, :per_page => params[:per_page], :size => subject.api.options[:max_page] * params[:per_page])
-    subject.assemble_with(params);
+    TheGrid::Api.any_instance.should_receive(:run_command!).with(:paginate, :page => 1, :per_page => params[:per_page], :size => api_options[:max_page] * params[:per_page])
+    subject.assemble(context, :on => relation, :with => params)
+  end
+
+  it "generates csv with nested data" do
+    context.stub(:assemble => [ record.merge(:children => [ child_record(1), child_record(2) ]) ])
+    subject.assemble(context, :on => relation, :with => params).should eql generate_csv(2.times.map{ |i| record.merge child_record(i + 1) }, context.column_titles)
   end
 
 
@@ -42,6 +44,10 @@ describe TheGrid::Builder::Csv do
       column :name
       column :status
       column :text
+
+      scope_for :children do
+        column :name
+      end
     end
   end
 

data/spec/builder/json_spec.rb

@@ -2,22 +2,23 @@ require 'spec_helper'
 require_relative 'view_builder_helper'
 
 describe TheGrid::Builder::Json do
-  subject{ TheGrid::Builder::Json.new(Object.new, build_context) }
+  subject{ TheGrid::Builder::Json }
 
   include_examples "for Grid View Builder"
-  before(:each) { subject.api.stub(:compose!){ subject.api.options[:max_page] = 25 } }
 
+  let(:context) { build_context }
   let(:records) {[ 1, 2, 3, 4 ]}
   let(:params)  {{ :cmd => [:sort], :field => :name, :order => :desc }}
 
-  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)) }
+  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(records) }}
+  let(:assembled_result) { JSON.parse(subject.assemble(context, :on => Object.new, :with => params)) }
+
 
   it "merges params with context options" do
-    subject.api.should_receive(:compose!).with(params.merge subject.context.options)
-    subject.assemble_with params
+    TheGrid::Api.any_instance.should_receive(:compose!).with(params.merge context.options)
+    subject.assemble(context, :on => Object.new, :with => params)
   end
 
   it "generates json with meta information" do
@@ -30,7 +31,7 @@ describe TheGrid::Builder::Json do
   end
 
   it "generates json notification when get wrong argument" do
-    subject.api.stub(:compose!) { raise ArgumentError, "my message" }
+    TheGrid::Api.any_instance.stub(:compose!) { raise ArgumentError, "my message" }
     assembled_result.should eql "status" => "error", "message" => "my message"
   end
 

data/spec/builder/view_builder_helper.rb

@@ -1,10 +1,18 @@
 shared_examples "for Grid View Builder" do
-  before(:each) { subject.context.stub(:assemble => records) }
+  before(:each) { context.stub(:assemble => records) }
+  before(:each) { TheGrid::Api.any_instance.stub(:compose!) }
+  before(:each) { TheGrid::Api.any_instance.stub(:options => api_options) }
 
-  it { should respond_to(:assemble_with) }
+  let(:records)  {[ record, record, record ]}
+  let(:api_options){{ :max_page => 25 }}
 
-  it "merges context with params" do
-    subject.api.should_receive(:compose!).with(params.merge subject.context.options)
-    subject.assemble_with(params)
+  it { should respond_to(:assemble) }
+
+  def child_record(id)
+  	{ :child_id => id, :child_name => "Child Name #{id}" }
+  end
+
+  def record(id = nil)
+  	{ :id => id || 1, :name => "Name #{id}", :status => "Active", :text => "Text" }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_grid
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Sergiy Stotskiy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-27 00:00:00.000000000 Z
+date: 2013-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord