Initial commit

cbeer · cbeer · commit 2e34654a2cb5 · 2014-02-06T09:48:41.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+jetty
+spec/internal
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,18 @@
+notifications:
+  email: false
+
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+
+notifications:
+  irc: "irc.freenode.org#blacklight"
+  email:
+      - blacklight-commits@googlegroups.com
+
+env:
+  global:
+    - JRUBY_OPTS="-J-Xms512m -J-Xmx1024m"
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blacklight-table.gemspec
+gemspec
+
+group :test do
+  gem "bootstrap-sass"
+  gem 'turbolinks'
+  gem 'sass-rails'
+end
+
+gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+
+if File.exists?('spec/test_app_templates/Gemfile.extra')
+  eval File.read('spec/test_app_templates/Gemfile.extra'), nil, 'spec/test_app_templates/Gemfile.extra'
+end
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,13 @@
+Copyright 2014 Chris Beer.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/README.md b/README.md
@@ -0,0 +1,33 @@
+# Blacklight::Table
+
+Table views for Blacklight search results
+
+## Installation
+
+Add this line to your Blacklight application's Gemfile:
+
+    gem 'blacklight-table'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blacklight-table
+
+## Usage
+
+Run the table generator:
+
+    $ rails g blacklight_table:install
+
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/blacklight-table/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,44 @@
+require "bundler/gem_tasks"
+
+ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.6.0.zip"
+APP_ROOT = File.dirname(__FILE__)
+
+require 'rspec/core/rake_task'
+require 'engine_cart/rake_task'
+
+require 'jettywrapper'
+require 'blacklight'
+
+task :default => :ci
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+
+end
+
+desc "Load fixtures"
+task :fixtures => ['engine_cart:generate'] do
+  within_test_app do
+      system "rake blacklight:solr:seed RAILS_ENV=test"
+      abort "Error running fixtures" unless $?.success?
+  end
+end
+
+desc "Execute Continuous Integration build"
+task :ci => ['jetty:clean', 'engine_cart:generate'] do
+
+  require 'jettywrapper'
+  jetty_params = {
+    :jetty_home => File.expand_path(File.dirname(__FILE__) + '/jetty'),
+    :quiet => false,
+    :jetty_port => 8888,
+    :solr_home => File.expand_path(File.dirname(__FILE__) + '/jetty/solr'),
+    :startup_wait => 30
+  }
+
+  error = Jettywrapper.wrap(jetty_params) do
+    Rake::Task['fixtures'].invoke
+    Rake::Task['spec'].invoke
+  end
+  raise "test failures: #{error}" if error
+end
diff --git a/app/views/catalog/_document_row.html.erb b/app/views/catalog/_document_row.html.erb
@@ -0,0 +1,12 @@
+<% counter = document_counter_with_offset(document_counter) %>
+
+<tr class="document-row <%= render_document_class document %>" itemscope itemtype="<%= document.itemtype %>">
+  <td class="counter"><%= counter %></td>
+  <td class="index_title"><%= link_to_document document, label:document_show_link_field(document) %></td>
+  <td>
+    <%= render_index_doc_actions document, wrapping_class: "index-document-functions col-sm-3 col-lg-2" %>
+  </td>
+<% fields.each do |key, config| %>
+  <td><%= render_index_field_value document, field: key %></td> 
+<% end %>
+</tr>
diff --git a/app/views/catalog/_document_table.html.erb b/app/views/catalog/_document_table.html.erb
@@ -0,0 +1,15 @@
+<table id="documents" class="table table-striped">
+  <thead>
+    <tr>
+      <th><%= t('blacklight.table.counter') %></th>
+      <th><%= t('blacklight.table.title') %></th>
+      <th><%= t('blacklight.table.document_actions') %></th>
+      <% index_fields.each do |key, field| %>
+        <th><%= render_index_field_label field: key %></th>
+      <% end %>
+    </tr>
+  </thead>
+  <tbody>
+    <%= render partial: "document_row", collection: documents, as: :document, locals: { fields: index_fields } %>
+  </tbody>
+</table>
diff --git a/blacklight-table.gemspec b/blacklight-table.gemspec
@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blacklight/table/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "blacklight-table"
+  spec.version       = Blacklight::Table::VERSION
+  spec.authors       = ["Chris Beer"]
+  spec.email         = ["cabeer@stanford.edu"]
+  spec.summary       = %q{Tabular results view for Blacklight}
+  spec.homepage      = ""
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "blacklight", "~> 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "jettywrapper"
+  spec.add_development_dependency "engine_cart"
+  spec.add_development_dependency "capybara"
+end
diff --git a/config/locales/blacklight-table.en.yml b/config/locales/blacklight-table.en.yml
@@ -0,0 +1,9 @@
+en:
+  blacklight:
+    search:
+      view:
+        table: "Table"
+    table:
+      counter: ""
+      title: "Title"
+      document_actions: ""
diff --git a/lib/blacklight/table.rb b/lib/blacklight/table.rb
@@ -0,0 +1,6 @@
+require "blacklight/table/version"
+module Blacklight
+  module Table
+    require "blacklight/table/engine"
+  end
+end
diff --git a/lib/blacklight/table/engine.rb b/lib/blacklight/table/engine.rb
@@ -0,0 +1,10 @@
+require 'blacklight'
+
+module Blacklight
+  module Table
+    class Engine < Rails::Engine
+      Blacklight::Configuration.default_values[:view].table.icon_class = "glyphicon-calendar"
+      Blacklight::Configuration.default_values[:view].table.partials = []
+    end
+  end
+end
diff --git a/lib/blacklight/table/version.rb b/lib/blacklight/table/version.rb
@@ -0,0 +1,5 @@
+module Blacklight
+  module Table
+    VERSION = "0.0.1"
+  end
+end
diff --git a/lib/generators/blacklight_table/install_generator.rb b/lib/generators/blacklight_table/install_generator.rb
@@ -0,0 +1,9 @@
+require 'rails/generators'
+
+module BlacklightGallery
+  class Install < Rails::Generators::Base
+
+    def assets
+    end
+  end
+end
diff --git a/spec/features/table_spec.rb b/spec/features/table_spec.rb
@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe "Table view" do
+  before { visit catalog_index_path :q => 'medicine', :view => 'table' }
+
+  it "should display results in a galley view" do
+    expect(page).to have_selector("table#documents")
+    expect(page).to have_content("Strong Medicine speaks")
+  end
+end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -0,0 +1,10 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'blacklight'
+require 'blacklight/table'
+
+require 'engine_cart'
+EngineCart.load_application!
+
+require 'rspec/rails'
+require 'capybara/rspec'
diff --git a/spec/test_app_templates/Gemfile.extra b/spec/test_app_templates/Gemfile.extra
@@ -0,0 +1,22 @@
+platforms :jruby do
+  gem 'jdbc-sqlite3'
+  gem 'mediashelf-loggable', '>= 0.4.8'
+  gem 'therubyrhino'
+end
+
+platforms :ruby do
+ gem 'sqlite3'
+end
+
+gem 'jquery-rails'
+
+group :test do
+  gem 'rspec-rails', '~> 2.13'
+  gem 'generator_spec'
+  gem 'poltergeist'
+  gem 'simplecov'
+end
+
+gem 'jettywrapper', '>= 1.2.0'
+
+gem 'blacklight'
diff --git a/spec/test_app_templates/lib/generators/test_app_generator.rb b/spec/test_app_templates/lib/generators/test_app_generator.rb
@@ -0,0 +1,24 @@
+require 'rails/generators'
+
+class TestAppGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../../../test_app_templates", __FILE__)
+
+  def remove_index 
+    remove_file "public/index.html"
+  end
+
+  def run_blacklight_generator
+    say_status("warning", "GENERATING BL", :yellow)       
+
+    Bundler.with_clean_env do
+      run "bundle install"
+    end
+
+    generate 'blacklight:install'
+  end
+
+  def run_gallery_install
+    generate 'blacklight_table:install'
+  end
+
+end
