Turn the app into a mountable Rails engine

samvera · Oct 2, 2013 · 7f67159 · 7f67159
1 parent ddfd5cf
commit 7f67159
Show file tree

Hide file tree

Showing 93 changed files with 385 additions and 782 deletions.
diff --git a/.gitignore b/.gitignore
@@ -16,4 +16,6 @@
 /tmp
 Gemfile.lock
 Gemfile.lock
-coverage
+coverage
+pkg
+spec/internal
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -78,8 +78,6 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
 
 ### Submitting Changes
 
-[Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
-
 * Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub.
 * Make sure your branch is up to date with its parent branch (i.e. master)
   * `git checkout master`

diff --git a/Gemfile b/Gemfile
@@ -1,51 +1,6 @@
-source 'https://rubygems.org'
-
-# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '4.0.0'
-
-# Use sqlite3 as the database for Active Record
-gem 'sqlite3'
-
-# Use SCSS for stylesheets
-gem 'sass-rails', '~> 4.0.0'
-
-# Use Uglifier as compressor for JavaScript assets
-gem 'uglifier', '>= 1.3.0'
-
-# Use CoffeeScript for .js.coffee assets and views
-gem 'coffee-rails', '~> 4.0.0'
-
-# Use jquery as the JavaScript library
-gem 'jquery-rails'
-
-# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
-gem 'turbolinks'
-
-# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
-gem 'jbuilder', '~> 1.2'
-
-# For bulk data imports
-gem 'activerecord-import', '>= 0.4.0'
-
-group :doc do
-  # bundle exec rake doc:rails generates the API under doc/api.
-  gem 'sdoc', require: false
-end
-
-gem 'curb'
-gem 'nokogiri', '~> 1.6.0'
-
-group :development, :test do
-  gem 'rspec'
-  gem 'rspec-rails'
-  gem 'debugger'
-  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
-  gem 'therubyracer', platforms: :ruby
-end 
-group :test do
-  gem 'rspec'
-  gem 'rspec-rails'
-  gem 'webmock'
-  gem 'simplecov', require: false
-end
+source "https://rubygems.org"
 
+# Declare your gem's dependencies in qa.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,15 @@
+##########################################################################
+# Copyright 2013 Rock and Roll Hall of Fame and Museum
+# Additional copyright may be held by others, as reflected in the commit log
+#
+# 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
@@ -22,25 +22,37 @@ results from a given vocabulary in the JSON format.  The controller does three t
 
 ### Sub-Authorities
 
-Some authorties, such as Library of Congress, allow sub-authorties which is an additional parameter that
+Some authorities, such as Library of Congress, allow sub-authorities which is an additional parameter that
 further defines the kind of authority to use with the context of a larger one.
 
+## How do use this?
+
+Add the gem to your Gemfile
+
+    gem 'qa'
+
+Add the engine to your config/routes.rb file
+
+    mount Qa::Engine => '/qa'
+
+Start questioning your authorities!
+
 ### Examples
 
 Return a complete list of terms:
 
-    /terms/:vocab
-    /terms/:vocab/:sub_authority
+    /qa/terms/:vocab
+    /qa/terms/:vocab/:sub_authority
 
 Return a set of terms matching a given query
 
-    /search/:vocab?q=search_term
-    /search/:vocab/:sub_authority?q=search_term
+    /qa/search/:vocab?q=search_term
+    /qa/search/:vocab/:sub_authority?q=search_term
 
 Return the complete information for a specific term given its identifier
 
-    /show/:vocab/:id
-    /show/:vocab/:sub_authority/:id
+    /qa/show/:vocab/:id
+    /qa/show/:vocab/:sub_authority/:id
 
 ### JSON Results
 
@@ -55,7 +67,7 @@ Results are returned in JSON in this format:
 
 Results for specific terms may vary according to the term.  For example:
 
-    /show/mesh/D000001
+    /qa/show/mesh/D000001
 
 Might return:
 
@@ -65,7 +77,7 @@ Might return:
       "synonyms" : ["A-23187", "A23187", "Antibiotic A23187", "A 23187", "A23187, Antibiotic"]
     }
 
-This is due to the varing nature of each authority source.  However, results for multiple terms, such as a search, we
+This is due to the varying nature of each authority source.  However, results for multiple terms, such as a search, we
 should always use the above id and label structure to ensure interoperability at the GUI level.
 
 # Authority Sources information
@@ -131,11 +143,20 @@ This may take a few minutes to finish.
 
 # TODOs
 
-* Make this an engine
 * Provide show method to TermsController to return individual terms
 
 check the issue list for more...
 
+# Developer Notes
+
+To develop this gem, clone the repository, then run:
+
+    bundle install
+    rake
+
+This will install the gems, create a dummy application under spec/internal and run the tests.  After you've made changes, remove the entire spec/internal
+directory so that further tests and run against a new dummy application.
+
 # Authors
 
 * Stephen Anderson

diff --git a/Rakefile b/Rakefile
@@ -1,6 +1,10 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
 
-require File.expand_path('../config/application', __FILE__)
+Dir.glob('tasks/*.rake').each { |r| import r }
 
-QuestioningAuthority::Application.load_tasks
+ENV["RAILS_ROOT"] ||= 'spec/internal'
+
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
diff --git a/app/assets/images/.keep → app/assets/images/qa/.keep b/app/assets/images/.keep → app/assets/images/qa/.keep
diff --git a/app/assets/javascripts/application.js → app/assets/javascripts/qa/application.js b/app/assets/javascripts/application.js → app/assets/javascripts/qa/application.js
@@ -10,7 +10,4 @@
 // Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
 // about supported directives.
 //
-//= require jquery
-//= require jquery_ujs
-//= require turbolinks
 //= require_tree .
diff --git a/app/assets/stylesheets/application.css → app/assets/stylesheets/qa/application.css b/app/assets/stylesheets/application.css → app/assets/stylesheets/qa/application.css
diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
diff --git a/app/controllers/concerns/.keep b/app/controllers/concerns/.keep
diff --git a/app/controllers/qa/application_controller.rb b/app/controllers/qa/application_controller.rb
@@ -0,0 +1,4 @@
+module Qa
+  class ApplicationController < ActionController::Base
+  end
+end
diff --git a/app/controllers/terms_controller.rb → app/controllers/qa/terms_controller.rb b/app/controllers/terms_controller.rb → app/controllers/qa/terms_controller.rb
@@ -2,7 +2,7 @@
 # which class to instantiate based on the "vocab" param. All the authotirty classes inherit from a
 # super class so they implement the same methods.
 
-class TermsController < ApplicationController
+class Qa::TermsController < ApplicationController
 
   before_action :check_search_params, only:[:search]
   before_action :check_vocab_param, :check_authority, :check_sub_authority
@@ -70,7 +70,7 @@ def check_sub_authority
   private
 
   def authority_class
-    "Authorities::"+params[:vocab].capitalize
+    "Qa::Authorities::"+params[:vocab].capitalize
   end
 
 end
diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rb
diff --git a/app/helpers/qa/application_helper.rb b/app/helpers/qa/application_helper.rb
@@ -0,0 +1,2 @@
+module Qa::ApplicationHelper
+end
diff --git a/app/mailers/.keep b/app/mailers/.keep
diff --git a/app/models/.keep b/app/models/.keep
diff --git a/app/models/concerns/.keep b/app/models/concerns/.keep
diff --git a/app/models/mesh_tree.rb → app/models/qa/mesh_tree.rb b/app/models/mesh_tree.rb → app/models/qa/mesh_tree.rb
@@ -1,4 +1,4 @@
-class MeshTree < ActiveRecord::Base
+class Qa::MeshTree < ActiveRecord::Base
   belongs_to :subject_mesh_term , :foreign_key => "term_id"
 
   def self.classify_all_trees

diff --git a/app/models/subject_mesh_term.rb → app/models/qa/subject_mesh_term.rb b/app/models/subject_mesh_term.rb → app/models/qa/subject_mesh_term.rb
@@ -1,12 +1,12 @@
-class SubjectMeshTerm < ActiveRecord::Base
+class Qa::SubjectMeshTerm < ActiveRecord::Base
   has_many :mesh_trees, :foreign_key => "term_id"
 
   def self.from_tree_number(tree_id)
-    SubjectMeshTerm.joins('INNER JOIN mesh_trees ON subject_mesh_terms.term_id = mesh_trees.term_id').where('mesh_trees.tree_number = ?', tree_id)
+    Qa::SubjectMeshTerm.joins('INNER JOIN qa_mesh_trees ON qa_subject_mesh_terms.term_id = qa_mesh_trees.term_id').where('qa_mesh_trees.tree_number = ?', tree_id)
   end
 
   def trees
-    MeshTree.where(term_id: self.term_id).map { |t| t.tree_number }
+    Qa::MeshTree.where(term_id: self.term_id).map { |t| t.tree_number }
   end
 
   def synonyms
@@ -25,7 +25,7 @@ def synonyms=(syn_list)
 
   def parents
     t = self.trees
-    t.map { |tn| initial_segements_of(tn) }.flatten.uniq.map { |tn| SubjectMeshTerm.from_tree_number(tn) }
+    t.map { |tn| initial_segements_of(tn) }.flatten.uniq.map { |tn| Qa::SubjectMeshTerm.from_tree_number(tn) }
   end
 
   private

diff --git a/app/views/layouts/application.html.erb b/app/views/layouts/application.html.erb
diff --git a/app/views/layouts/qa/application.html.erb b/app/views/layouts/qa/application.html.erb
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Qa</title>
+  <%= stylesheet_link_tag    "qa/application", media: "all" %>
+  <%= javascript_include_tag "qa/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>
diff --git a/bin/bundle b/bin/bundle
diff --git a/bin/rails b/bin/rails
diff --git a/bin/rake b/bin/rake
diff --git a/config.ru b/config.ru
diff --git a/config/application.rb b/config/application.rb
diff --git a/config/boot.rb b/config/boot.rb
diff --git a/config/database.yml b/config/database.yml
diff --git a/config/environment.rb b/config/environment.rb