apotomo-datatable 0.0.1

data/spec/widget/apotomo_datatable_widget_spec.rb

@@ -0,0 +1,107 @@
+puts "APOTOMO DATATABLE TEST"
+require 'spec_helper'
+require 'widget_helper'
+
+@test_controller_options={}
+
+describe Apotomo::DatatableWidget, "apotomo-datatable widget" do
+  rspecify(self)
+
+  before :each do
+    # The test_controller is not created here since we're testing sending different params to that method
+    num_items=15
+    (1..num_items).each {|n| FactoryGirl.create(:item)}
+  end
+
+  it "should be an instance of Apotomo::DatatableWidget" do
+    @test_controller=test_controller(:widget=>{:name=>'test_datatable_widget'},:template=>{:id=>'test_datatable'},:plugin=>{:iDisplayStart=>10})
+    @widget=@test_controller.apotomo_root.childrenHash[:datatable]
+    @widget.should be_an_instance_of(Apotomo::DatatableWidget)
+  end
+
+  describe "after_initialize without controller_options provided" do
+    before :each do
+      @test_controller=test_controller()
+      @widget=@test_controller.apotomo_root.childrenHash[:datatable]
+    end
+
+    it "should be using the default model" do
+      @widget.merged_options[:widget][:model].should == Item
+    end
+
+    it "should merge default options with options passed by the controller into @options" do
+      options=@widget.merged_options
+      options[:widget][:name].should == 'ItemDatatableWidget'
+      options[:template][:id].should == 'ItemDatatable'
+      options[:plugin][:iDisplayStart].should == 0
+    end
+  end
+
+  describe "after_initialize with controller_options provided" do
+    before :each do
+      @test_controller=test_controller(:widget=>{:name=>'test_datatable_widget'},:template=>{:id=>'test_datatable'},:plugin=>{:iDisplayStart=>10})
+      @widget=@test_controller.apotomo_root.childrenHash[:datatable]
+    end
+
+    it "should merge default options with options passed by the controller into @options" do
+      options=@widget.merged_options
+      options[:widget][:name].should == 'test_datatable_widget'
+      options[:template][:id].should == 'test_datatable'
+      options[:plugin][:iDisplayStart].should == 10
+    end
+  end
+
+  it "should respond to method calls" do
+    @test_controller=test_controller(:widget=>{:name=>'test_datatable_widget'},:template=>{:id=>'test_datatable'},:plugin=>{:iDisplayStart=>10})
+    @widget=@test_controller.apotomo_root.childrenHash[:datatable]
+
+    lambda{@widget.increment_test_val}.should change(@widget,:test_val).by(1)
+  end
+
+  it "should respond to event triggers" do
+    @test_controller=test_controller()
+    @widget=@test_controller.apotomo_root.childrenHash[:datatable]
+    @widget.instance_eval do
+      def data
+        render text: 'result'
+      end
+    end 
+    @test_controller.render_widget(:datatable,:data).should == 'result'
+  end
+
+  it "should raise an exception without a model to use" do
+    class OrphanController < MockController
+    end
+    OrphanController.has_widget_with_params()
+    @test_controller=OrphanController.new
+    @test_controller.request=::ActionController::TestRequest.new
+    @test_controller.response=::ActionController::TestResponse.new
+    @test_controller.params={}
+    lambda {@widget=@test_controller.apotomo_root.childrenHash[:datatable]}.should raise_error
+  end
+
+  it "should raise an exception when provided an invalid model from the controller options" do
+    class OrphanController < MockController
+    end
+    OrphanController.has_widget_with_params(:widget=>{:model=>nil})
+    @test_controller=OrphanController.new
+    @test_controller.request=::ActionController::TestRequest.new
+    @test_controller.response=::ActionController::TestResponse.new
+    @test_controller.params={}
+    lambda {@widget=@test_controller.apotomo_root.childrenHash[:datatable]}.should raise_error
+  end
+
+end
+
+def msg(o,m)
+# for brute-force debugging
+#    @controller.response.methods.sort.each do |m|
+#      puts "#{m}=#{msg(@controller.response, m)}"
+#    end
+
+  begin
+    o.send m
+  rescue
+    ""
+  end
+end

data/spec/widget/data_event_spec.rb

@@ -0,0 +1,24 @@
+puts "DATA EVENT TEST"
+require 'spec_helper'
+require 'widget_helper'
+
+describe Apotomo::DatatableWidget, "apotomo-datatable widget" do
+  rspecify(self)
+
+  before :each do
+    @test_controller=test_controller(:widget=>{},:template=>{},:plugin=>{})
+    @widget=@test_controller.apotomo_root.childrenHash[:datatable]
+    num_items=15
+    (1..num_items).each {|n| FactoryGirl.create(:item)}
+  end
+
+  describe ":data event" do
+    it "should render a json string with data when the :data event is triggered" do
+      #This triggers the :data event, which queries the database returns a json string of the data
+      @test_controller.render_widget(:datatable,:data).should include("\"iTotalRecords\":15")
+    end
+  end
+
+end
+
+

data/spec/widget/display_event_spec.rb

@@ -0,0 +1,45 @@
+puts "DISPLAY EVENT TEST"
+require 'spec_helper'
+require 'widget_helper'
+
+describe Apotomo::DatatableWidget, "apotomo-datatable widget" do
+  rspecify(self)
+
+  before :each do
+    @controller=test_controller(:widget=>{},:template=>{},:plugin=>{})
+    @widget=@controller.apotomo_root.childrenHash[:datatable]
+    num_items=15
+    (1..num_items).each {|n| FactoryGirl.create(:item)}
+  end
+
+  describe ":display event" do
+
+    it "should respond to the triggering of the :display event"
+
+    it "should convert boolean values in @merged_options to the appropriate defaults"
+
+    it "should generate and render a json string from @merged_options[:plugin]"
+
+    it "should generate javascript to merge client-side plugin options when @merged_options[:template][:plugin_options] != nil"
+
+    it "should render display_html from the gem's path to a single-line, html_safe string when @options[:params][:format]=='js' and app/widgets/apotomo/datatable/display_html* is not present" #check for presence of "default apotomo-datatable view" in the string. Better test would be to find out which file is being used
+
+    it "should render display_html from the app's path to a single-line, html_safe string when @options[:params][:format]=='js' and app/widgets/apotomo/datatable/display_html* is present" #check for non-presence of "default apotomo-datatable view" in the string. Better test would be to find out which file is being used
+
+    it "should render display_js from the gem's path when @options[:params][:format]=='js' and app/widgets/apotomo/datatable/display_js* is not present"
+
+    it "should render display_js from the app's path when @options[:params][:format]=='js' and app/widgets/apotomo/datatable/display_js* is present"
+
+    it "should render display_html from the gem's path when @options[:params][:format]!='js' and app/widgets/apotomo/datatable/display_js* is not present"
+
+    it "should render display_html from the app's path when @options[:params][:format]!='js' and app/widgets/apotomo/datatable/display_js* is present"
+
+    describe "head_foot template" do
+
+      it "should include the approprate elements as defined by @options[:template][:header]and @options[:template][:footer]"
+
+    end
+  end
+
+end
+

data/spec/widget/included_excluded_columns_spec.rb

@@ -0,0 +1,38 @@
+puts "INCLUDED/EXCLUDED COLUMNS TEST"
+require 'spec_helper'
+require 'widget_helper'
+
+describe Apotomo::DatatableWidget, "apotomo-datatable widget" do
+  rspecify(self)
+
+  describe ":display event" do
+    it "should exclude :id, :created_at and :updated_at by default" do
+      @test_controller=test_controller(:widget=>{},:template=>{},:plugin=>{})
+      @widget=@test_controller.apotomo_root.childrenHash[:datatable]
+      @test_controller.render_widget(:datatable,:display).should_not include("<th>id</th>")
+      @test_controller.render_widget(:datatable,:display).should_not include("<th>created_at</th>")
+      @test_controller.render_widget(:datatable,:display).should_not include("<th>updated_at</th>")
+    end
+    it "should include non-rails-default columns default" do
+      @test_controller=test_controller(:widget=>{},:template=>{},:plugin=>{})
+      @widget=@test_controller.apotomo_root.childrenHash[:datatable]
+      @test_controller.render_widget(:datatable,:display).should include("<th>name</th>")
+      @test_controller.render_widget(:datatable,:display).should include("<th>value</th>")
+    end
+    it "should include an excluded column when added to [:template][:included_columns] option" do
+      @test_controller=test_controller(:widget=>{},:template=>{:included_columns=>[:id]},:plugin=>{})
+      @widget=@test_controller.apotomo_root.childrenHash[:datatable]
+      @test_controller.render_widget(:datatable,:display).should include("<th>id</th>")
+    end
+    it "should exclude additional columns passed in the [:template][:excluded_columns] option" do
+      @test_controller=test_controller(:widget=>{},:template=>{:included_columns=>[:id]},:plugin=>{})
+      @widget=@test_controller.apotomo_root.childrenHash[:datatable]
+      @test_controller.render_widget(:datatable,:display).should include("<th>id</th>")
+    end
+
+
+  end
+
+end
+
+

data/spec/widget/merge_options_spec.rb

@@ -0,0 +1,35 @@
+puts "MERGE OPTIONS TESTS"
+require 'spec_helper'
+require 'widget_helper'
+
+describe Apotomo::DatatableWidget, "apotomo-datatable widget" do
+  rspecify(self)
+
+  before :each do
+    @test_controller=test_controller(:widget=>{},:template=>{},:plugin=>{})
+    @widget=@test_controller.apotomo_root.childrenHash[:datatable]
+  end
+
+  describe "display method" do
+    it "should merge view_options into @merged_options if provided" do
+      @widget.display(:widget=>{:test_option=>'view'},:template=>{:test_option=>'view'},:plugin=>{:test_option=>'view'})
+      merged_options=@widget.merged_options
+      merged_options[:widget][:test_option].should == 'view'
+      merged_options[:template][:test_option].should == 'view'
+      merged_options[:plugin][:test_option].should == 'view'
+    end
+
+    it "should merge url_param_options into @merged_options" do
+      @test_controller.params={:widget=>{:test_option=>'url'},:template=>{:test_option=>'url'},:plugin=>{:test_option=>'url'}}.with_indifferent_access
+      @widget.display(:widget=>{:test_option=>'view'},:template=>{:test_option=>'view'},:plugin=>{:test_option=>'view'})
+      merged_options=@widget.merged_options
+      #widget options should not be overridden by URL params
+      merged_options[:widget][:test_option].should == 'view'
+      #template and plugin options should be overridden by url params
+      merged_options[:template][:test_option].should == 'url'
+      merged_options[:plugin][:test_option].should == 'url'
+    end
+  end
+end
+
+

metadata

@@ -0,0 +1,359 @@
+--- !ruby/object:Gem::Specification
+name: apotomo-datatable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jason Van Pelt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: apotomo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-apotomo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-instafail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A jQuery Datatable widget built on Apotomo. Render a jQuery datatable
+  for a model/controller using as little as a couple lines of code.
+email:
+- jasonpvp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/apotomo-datatable/version.rb
+- lib/apotomo-datatable/railtie.rb
+- lib/apotomo-datatable.rb
+- lib/tasks/apotomo-datatable_tasks.rake
+- lib/apotomo/datatable/head_foot.html.haml
+- lib/apotomo/datatable/display_html.html.haml
+- lib/apotomo/datatable/display_js.html.haml
+- lib/apotomo/datatable_widget.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+- spec/widget/apotomo_datatable_widget_spec.rb
+- spec/widget/merge_options_spec.rb
+- spec/widget/data_event_spec.rb
+- spec/widget/included_excluded_columns_spec.rb
+- spec/widget/display_event_spec.rb
+- spec/features/load_datatable_in_various_ways_spec.rb
+- spec/features/server_side_processing_spec.rb.log
+- spec/features/load_datatable_in_various_ways_spec.rb.log
+- spec/features/server_side_processing_spec.rb
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/config.ru
+homepage: https://github.com/jasonpvp/apotomo-datatable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1594184290050969788
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1594184290050969788
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A jQuery Datatable widget built on Apotomo
+test_files:
+- spec/widget/apotomo_datatable_widget_spec.rb
+- spec/widget/merge_options_spec.rb
+- spec/widget/data_event_spec.rb
+- spec/widget/included_excluded_columns_spec.rb
+- spec/widget/display_event_spec.rb
+- spec/features/load_datatable_in_various_ways_spec.rb
+- spec/features/server_side_processing_spec.rb.log
+- spec/features/load_datatable_in_various_ways_spec.rb.log
+- spec/features/server_side_processing_spec.rb
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/config.ru