atrium 0.0.1 → 0.1.1

data/config/routes.rb

@@ -1,12 +1,42 @@
-Rails.application.routes.draw do
+Atrium::Engine.routes.draw do
+  resources :collections do
+    resources :exhibits do
+      member do
+        get :include_filter
+        get :exclude_filer
+      end
+    end
+    resources :showcases
+  end
+  resources :exhibits do
+    resources :showcases
+  end
 
-  # Routes for the Atrium application are defined in Atrium::Routes
-  #
-  # These routes can be injected into your Rails application by adding
-  #     Atrium.add_routes(self)
-  # to the application's ./config/routes.rb. The injected routes can be 
-  # customized as well, e.g.:
-  #     Atrium.add_routes(self, :only => [:collection]) # will only load collection routes
-  #     Atrium.add_routes(self, :except => [:catalog]) # will not load catalog routes
-end
+  resources :showcases, only: [:show]
+  resources :showcases do
+    resources :descriptions do
+      resources :essays
+    end
+  end
+  root to: "collections#index"
 
+  match 'collections/:id/exhibit_order/update',
+    to: 'order#update_collection_exhibits_order',
+    as: 'update_collection_exhibit_order',
+    via: :post
+  match 'collections/:id/showcase_order/update',
+    to: 'order#update_collection_showcases_order',
+    as: 'update_collection_showcase_order',
+    via: :post
+  match 'exhibits/:id/facet_order/update',
+    to: 'order#update_exhibit_facets_order',
+    as: 'update_exhibit_facet_order',
+    via: :post
+  match 'exhibits/:id/showcase_order/update',
+    to: 'order#update_exhibit_showcases_order',
+    as: 'update_exhibit_showcase_order',
+    via: :post
+  match 'showcase/browse_level_showcase/exhibit_id',
+    to: 'showcases#add_or_update',
+    as: 'get_browse_level_showcase'
+end

data/{lib/generators/atrium/templates/migrations/create_atrium_collections.rb → db/migrate/20120730170406_create_atrium_collections.rb}

@@ -4,13 +4,14 @@ class CreateAtriumCollections < ActiveRecord::Migration
       t.string :title
       t.string :url_slug
       t.string :filter_query_params
+      t.string :exclude_query_params
       t.string :theme
       t.text :title_markup
       t.text :collection_description
       t.text :search_instructions
       t.text :collection_items
+      t.timestamps
     end
-    add_index :atrium_collections, :id
     add_index :atrium_collections, :url_slug
   end
 

data/{lib/generators/atrium/templates/migrations/create_atrium_showcases.rb → db/migrate/20120731134846_create_atrium_showcases.rb}

@@ -2,12 +2,11 @@ class CreateAtriumShowcases < ActiveRecord::Migration
   def self.up
     create_table :atrium_showcases do |t|
       t.text :showcase_items
-      #t.integer :atrium_parent_id
-      #t.string  :atrium_parent_type
       t.references :showcases,  :polymorphic=>true
+      t.string :tag
+      t.integer :sequence
+      t.timestamps
     end
-    add_index :atrium_showcases, :id
-    #add_index :atrium_showcases, :atrium_parent_id, :atrium_parent_type
   end
 
   def self.down

data/{lib/generators/atrium/templates/migrations/create_atrium_exhibits.rb → db/migrate/20120731134856_create_atrium_exhibits.rb}

@@ -5,8 +5,9 @@ class CreateAtriumExhibits < ActiveRecord::Migration
       t.integer :set_number, :null=>false
       t.string :label
       t.string :filter_query_params
+      t.string :exclude_query_params
+      t.timestamps
     end
-    add_index :atrium_exhibits, :id
     add_index :atrium_exhibits, :atrium_collection_id
   end
 

data/{lib/generators/atrium/templates/migrations/create_atrium_descriptions.rb → db/migrate/20120731134904_create_atrium_descriptions.rb}

@@ -5,12 +5,13 @@ class CreateAtriumDescriptions < ActiveRecord::Migration
       t.string :page_display
       t.string :title
       t.string :description_solr_id
+      t.timestamps
     end
-    add_index :atrium_descriptions, :id
     add_index :atrium_descriptions, :atrium_showcase_id
   end
 
   def self.down
     drop_table :atrium_descriptions
   end
+
 end

data/{lib/generators/atrium/templates/migrations/create_atrium_essays.rb → db/migrate/20120731135534_create_atrium_essays.rb}

@@ -4,12 +4,13 @@ class CreateAtriumEssays < ActiveRecord::Migration
       t.integer :atrium_description_id, :null=>false
       t.string :content_type
       t.text :content
+      t.timestamps
     end
-    add_index :atrium_essays, :id
     add_index :atrium_essays, :atrium_description_id
   end
 
   def self.down
-    drop_table :atrium_contents
+    drop_table :atrium_essays
   end
+
 end

data/{lib/generators/atrium/templates/migrations/create_atrium_search_facets.rb → db/migrate/20120731135721_create_atrium_search_facets.rb}

@@ -3,8 +3,8 @@ class CreateAtriumSearchFacets < ActiveRecord::Migration
     create_table :atrium_search_facets do |t|
       t.integer :atrium_collection_id, :null=>false
       t.string :name
+      t.timestamps
     end
-    add_index :atrium_search_facets, :id
     add_index :atrium_search_facets, :atrium_collection_id
   end
 

data/{lib/generators/atrium/templates/migrations/create_atrium_showcase_facet_selections.rb → db/migrate/20120731140621_create_atrium_showcase_facet_selections.rb}

@@ -4,9 +4,13 @@ class CreateAtriumShowcaseFacetSelections < ActiveRecord::Migration
       t.integer :atrium_showcase_id
       t.string :solr_facet_name
       t.string :value
+      t.timestamps
     end
-    add_index :atrium_showcase_facet_selections, :id
-    add_index :atrium_showcase_facet_selections, :atrium_showcase_id, :name =>'atrium_facet_showcase_index'
+    add_index(
+      :atrium_showcase_facet_selections,
+      :atrium_showcase_id,
+      name: 'atrium_facet_showcase_index'
+    )
   end
 
   def self.down

data/{lib/generators/atrium/templates/migrations/create_atrium_browse_levels.rb → db/migrate/20120801145241_create_atrium_browse_levels.rb}

@@ -7,8 +7,8 @@ class CreateAtriumBrowseLevels < ActiveRecord::Migration
       t.string :solr_facet_name
       t.string :label
       t.string :exclude_query_params
+      t.timestamps
     end
-    add_index :atrium_browse_levels, :id
     add_index :atrium_browse_levels, :atrium_exhibit_id
   end
 

data/db/migrate/20120820183808_create_selected_items.rb

@@ -0,0 +1,16 @@
+class CreateSelectedItems < ActiveRecord::Migration
+  def self.up
+    create_table :selected_items do |t|
+      t.integer :user_id, :null=>false
+      t.text :url
+      t.string :document_id
+      t.string :title
+      t.text :notes
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :selected_items
+  end
+end

data/db/migrate/20120823135716_update_atrium_collection_indices.rb

@@ -0,0 +1,13 @@
+class UpdateAtriumCollectionIndices < ActiveRecord::Migration
+  def up
+    remove_index :atrium_collections, :url_slug
+    add_index :atrium_collections, :url_slug, unique: true
+    add_index :atrium_collections, :title, unique: true
+  end
+
+  def down
+    remove_index :atrium_collections, :title, unique: true
+    remove_index :atrium_collections, :url_slug
+    add_index :atrium_collections, :url_slug
+  end
+end

data/db/migrate/20120823143315_add_lookup_indices_as_required.rb

@@ -0,0 +1,11 @@
+class AddLookupIndicesAsRequired < ActiveRecord::Migration
+  def change
+    add_index :atrium_showcases, [:showcases_type, :showcases_id]
+    add_index :atrium_descriptions, :description_solr_id
+    add_index :atrium_descriptions,
+      [:atrium_showcase_id,:description_solr_id],
+      name: 'index_atrium_descriptions_showcase_and_solr_id'
+    add_index :atrium_essays, :content_type
+    add_index :atrium_essays, [:atrium_description_id, :content_type]
+  end
+end

data/lib/atrium.rb

@@ -1,42 +1,46 @@
-require "blacklight"
+require 'atrium/engine'
+require 'atrium/exceptions'
 module Atrium
-  require 'atrium/engine' if defined?(Rails)
-  require 'application_controller'
-
-  require 'atrium/version'
-  require 'atrium/routes'
-
   require 'ckeditor-rails'
-  require 'devise'
-  require 'loggable'
-
-  include Loggable
-
-  def self.version
-    Atrium::VERSION
-  end
 
-  def self.root
-    @root ||= File.expand_path(File.dirname(File.dirname(__FILE__)))
-  end
+  class << self
+
+    # Atrium interacts with Blacklight and we are hoping we will get a
+    # Blacklight::Configuration for the .configure method.
+    def configure(main_app_config, &block)
+      @config = Atrium::Configuration.new(main_app_config, &block)
+    end
+
+    def config
+      @config || configure(OpenStruct.new)
+    end
+
+    delegate(
+      :application_name,
+      :query_param_beautifier,
+      :query_param_beautifier=,
+      :saved_search_class,
+      :saved_search_class=,
+      :saved_items_class,
+      :saved_items_class=,
+      to: :config
+    )
+
+    def saved_searches_for(user)
+      if user
+        saved_search_class.where(user_id: user[:id])
+      else
+        []
+      end
+    end
+
+    def saved_items_for(user)
+      if user
+        saved_items_class.where(user_id: user[:id])
+      else
+        []
+      end
+    end
 
-  # If you put this in your application's routes.rb, it will add the Atrium routes to the app.
-  # The atrium generator puts this in routes.rb for you by default.
-  # See {Atrium::Routes} for information about how to modify which routes are generated.
-  # @example
-  #   # in config/routes.rb
-  #   MyAppName::Application.routes.draw do
-  #     Blacklight.add_routes(self)
-  #     HydraHead.add_routes(self)
-  #     Atrium.add_routes(self)
-  #   end
-  def self.add_routes(router, options = {})
-    Atrium::Routes.new(router, options).draw
   end
-
 end
-
-require 'atrium/application_helper.rb'
-require 'atrium/collections_helper.rb'
-require 'atrium/descriptions_helper.rb'
-require 'atrium/solr_helper.rb'

data/lib/atrium/engine.rb

@@ -1,12 +1,8 @@
-require "atrium"
-require "rails"
 module Atrium
-  class Engine < Rails::Engine
-
-    # AtriumHelper is needed by all helpers, so we inject it
-    # into action view base here.
-    initializer 'atrium.helpers' do |app|
-      ActionView::Base.send :include, Atrium::BaseHelper
+  class Engine < ::Rails::Engine
+    isolate_namespace Atrium
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
     end
   end
 end

data/lib/atrium/exceptions.rb

@@ -0,0 +1,10 @@
+module Atrium
+  class ConfigurationExpectation < RuntimeError
+  end
+
+  class ConfigurationNotSet < StandardError
+    def initialize(method_name)
+      super("Please define #{method_name} in config/initializer/atrium.rb")
+    end
+  end
+end

data/lib/atrium/version.rb

@@ -1,3 +1,3 @@
 module Atrium
-  VERSION = "0.0.1"
-end
+  VERSION = "0.1.1"
+end

data/lib/generators/atrium/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/atrium/install/install_generator.rb

@@ -0,0 +1,86 @@
+class Atrium::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_initializer
+    template(
+      'atrium_initializer.rb',
+      'config/initializers/atrium.rb'
+    )
+  end
+
+  def update_routes
+    route(%q{mount Atrium::Engine => '/atrium', as: 'atrium'})
+    route(%q{resources :collections, only: [:show] do
+      get 'browse', on: :member
+    end})
+    route(%q{resources :exhibits, only: [:show]})
+    route(%q{resources :descriptions})
+    route(%q{match 'selected_items/save',
+      to: 'selected_items#save',
+      as: 'save_selected_items',
+      via: :post})
+  end
+
+  def update_controllers
+    inject_into_class(
+      'app/controllers/application_controller.rb',
+      'ApplicationController'
+    ) do
+      [
+        "",
+        "  def blacklight_config",
+        "    CatalogController.blacklight_config",
+        "  end",
+        "  helper_method :blacklight_config",
+        "  protected :blacklight_config",
+        ""
+      ].join("\n")
+    end
+  end
+
+  def update_user_model
+    inject_into_file 'app/models/user.rb',
+      :before => "def to_s" do
+      [
+          "",
+          " has_many     :selected_items, :class_name => 'SelectedItem',   :dependent => :destroy",
+          "",
+          " def selected_document_ids",
+          "   self.selected_items.map{|item|item.document_id}",
+          " end",
+          "",
+          ""
+      ].join("\n")
+    end
+  end
+
+  def create_controllers
+    raw_install('controllers')
+  end
+
+  def create_models
+    raw_install('models')
+  end
+
+  def create_helpers
+    raw_install('helpers')
+  end
+
+  def create_views
+    raw_install('views')
+  end
+
+  private
+  def raw_install(context)
+    container_directory = File.join(source_paths.first, '/')
+    directory_pattern = File.join(container_directory, context, '/**/*.*')
+    Dir.glob(directory_pattern).each do |file_name|
+      relative_filename = file_name.sub(container_directory, "")
+      copy_file(
+        relative_filename,
+        File.join('app', relative_filename)
+      )
+    end
+
+  end
+end

data/lib/generators/atrium/install/templates/atrium_initializer.rb

@@ -0,0 +1,21 @@
+Atrium.configure(CatalogController.blacklight_config) do |config|
+  config.saved_search_class = "Search"
+  config.saved_items_class = "SelectedItem"
+
+  config.query_param_beautifier = lambda {|context,ugly_params|
+    context.extend(Blacklight::SearchFields)
+    context.extend(Blacklight::SearchHistoryConstraintsHelperBehavior)
+
+    def context.blacklight_config
+      CatalogController.blacklight_config
+    end
+
+    if context.respond_to?(:render_search_to_s)
+      context.render_search_to_s(ugly_params)
+    else
+      ugly_params.inspect
+    end
+  }
+
+  config.application_name = "An Atrium Application"
+end