atrium 0.0.1.alpha

data/lib/atrium/version.rb

@@ -0,0 +1,3 @@
+module Atrium
+  VERSION = "0.0.1.alpha"
+end

data/lib/generators/atrium/assets_generator.rb

@@ -0,0 +1,44 @@
+# -*- encoding : utf-8 -*-
+# Copy Atrium assets to public folder in current app.
+# If you want to do this on application startup, you can
+# add this next line to your one of your environment files --
+# generally you'd only want to do this in 'development', and can
+# add it to environments/development.rb:
+#       require File.join(Atrium.root, "lib", "generators", "atrium", "assets_generator.rb")
+#       Atrium::Assets.start(["--force", "--quiet"])
+
+
+# Need the requires here so we can call the generator from environment.rb
+# as suggested above.
+require 'rails/generators'
+require 'rails/generators/base'
+module Atrium
+  class Assets < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def assets
+      unless IO.read("app/assets/stylesheets/application.css").include?("Atrium")
+        insert_into_file "app/assets/stylesheets/application.css", :before => "*/" do
+  %q{
+  * Required by Atrium:
+  *= require 'colorbox'
+  *= require 'atrium/chosen'
+  *= require 'atrium/atrium'
+  }
+      end
+    end
+
+      unless IO.read("app/assets/javascripts/application.js").include?('atrium/atrium')
+        insert_into_file "app/assets/javascripts/application.js", :after => "//= require jquery_ujs" do
+%q{
+//
+// Required by Atrium
+//= require atrium/atrium}
+        end
+      end
+
+      directory("../../../../app/assets/images/atrium", "app/assets/images/atrium")
+    end
+  end
+end
+

data/lib/generators/atrium/atrium_generator.rb

@@ -0,0 +1,149 @@
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+require 'rails/generators/migration'
+
+# require "generators/blacklight/blacklight_generator"
+
+module Atrium
+  class AtriumGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :model_name, :type => :string , :default => "user"
+
+    desc """
+  This generator makes the following changes to your application:
+    1. Creates several database migrations if they do not exist in /db/migrate
+    2. Adds additional mime types to you application in the file '/config/initializers/mime_types.rb'
+    3. Creates config/solr.yml which you may need to modify to tell atrium where to find fedora & solr
+    6. Creates a number of role_map config files that are used in the placeholder user roles implementation
+  Enjoy!
+
+    """
+    #
+    # Config Files & Initializers
+    #
+    # Copy all files in templates/config directory to host config
+    def create_configuration_files
+      # Role Mappings
+      copy_file "config/role_map_cucumber.yml", "config/role_map_cucumber.yml"
+      copy_file "config/role_map_development.yml", "config/role_map_development.yml"
+      copy_file "config/role_map_production.yml", "config/role_map_production.yml"
+      copy_file "config/role_map_test.yml", "config/role_map_test.yml"
+
+      # Solr config
+      copy_file "config/solr.yml", "config/solr.yml"
+
+      # Themes
+      copy_file "themes/example.html.erb", "app/views/layouts/atrium_themes/example.html.erb"
+    end
+
+    # Copy all files in templates/public/ directory to public/
+    # Call external generator in AssetsGenerator, so we can
+    # leave that callable seperately too.
+    def copy_public_assets
+      generate "atrium:assets"
+    end
+
+    # Register mimetypes required by hydra-head
+    def add_mime_types
+      puts "Updating Mime Types"
+      insert_into_file "config/initializers/mime_types.rb", :before => 'Mime::Type.register_alias "text/plain", :refworks_marc_txt' do <<EOF
+Mime::Type.register_alias "text/html", :textile
+Mime::Type.register_alias "text/html", :inline
+
+EOF
+      end
+    end
+
+    #
+    # Migrations
+    #
+
+    # Implement the required interface for Rails::Generators::Migration.
+    # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+    def self.next_migration_number(dirname)
+      unless @previous_migration_nr
+        if ActiveRecord::Base.timestamped_migrations
+          @previous_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @previous_migration_nr = "%.3d" % (current_migration_number(dirname) + 1).to_i
+        end
+      else
+        @previous_migration_nr +=1
+      end
+      @previous_migration_nr.to_s
+    end
+
+    # Add Atrium behaviors and Filters to ApplicationHelper
+    def inject_atrium_helper_behavior
+      insert_into_file "app/helpers/application_helper.rb", :after => 'module ApplicationHelper' do
+      "\n  # Adds a atrium collections behaviors into the application helper \n " +
+        "  include Atrium::ApplicationHelper\n" +
+        "  include Atrium::CollectionsHelper\n" +
+        "  include CatalogHelper\n"
+      end
+    end
+
+    # Add Atrium behaviors and Filters to CatalogController
+    def inject_atrium_catalog_behavior
+      puts "Adding Atrium behaviors to CatalogController"
+      controller_name = "catalog_controller"
+      file_path = "app/controllers/#{controller_name.underscore}.rb"
+      if File.exists?(file_path)
+        insert_into_file file_path, :after => "require 'blacklight/catalog'" do
+          "\nrequire 'atrium/catalog'"
+        end
+        insert_into_file file_path, :after => 'include Blacklight::Catalog' do
+          "\n  # Extend Blacklight::Catalog with Atrium behaviors (primarily editing)." +
+          "\n  include Atrium::Catalog"
+        end
+      else
+        puts " \e[31mFailure\e[0m Could not find #{model_name.underscore}.rb. To add Atrium behaviors to your Blacklight::Catalog Controllers, you must include the Atrium::Controller module in the Controller class definition."
+      end
+    end
+
+    # Add Atrium to the application controller
+    def inject_atrium_controller_behavior
+      inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
+        "  # Adds Atrium behaviors into the application controller \n " +
+        "  include Atrium::Controller\n\n"
+      end
+    end
+
+    # Inject call to Atrium.add_routes in config/routes.rb
+    def inject_atrium_routes
+      puts "here"
+      insert_into_file "config/routes.rb", :after => 'Blacklight.add_routes(self)' do
+        "\n  # Add Atrium routes."
+        "\n  Atrium.add_routes(self)"
+      end
+    end
+
+    # Setup the database migrations
+    def copy_migrations
+      # Can't get this any more DRY, because we need this order.
+      better_migration_template "create_atrium_collections.rb"
+      better_migration_template "create_atrium_search_facets.rb"
+      better_migration_template "create_atrium_exhibits.rb"
+      better_migration_template "create_atrium_showcases.rb"
+      better_migration_template "create_atrium_showcase_items.rb"
+      better_migration_template "create_atrium_showcase_facet_selections.rb"
+      better_migration_template "create_atrium_browse_levels.rb"
+      better_migration_template "create_atrium_descriptions.rb"
+      better_migration_template "create_atrium_essays.rb"
+    end
+
+    private
+
+    def better_migration_template(file)
+      begin
+        migration_template "migrations/#{file}", "db/migrate/#{file}"
+        sleep 1 # ensure scripts have different time stamps
+      rescue
+        puts "  \e[1m\e[34mMigrations\e[0m  " + $!.message
+      end
+    end
+  end # AtriumGenerator
+end # Atrium

data/lib/generators/atrium/cucumber_support_generator.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+require 'rails/generators/migration'     
+
+module Atrium
+class CucumberSupportGenerator < Rails::Generators::Base
+  
+  source_root File.expand_path('../../../../test_support/features', __FILE__)
+  
+  argument :features_dir, :type => :string , :default => "features"
+        
+  desc """
+  This Generator copies Hydra's cucumber step definitions and paths into your application's features directory.
+  We have plans to provide the step definitions directly through the hydra-head gem without requiring this step of copying the files.
+  In the meantime, you need to copy the files in order to use them. 
+  
+  Defaults to assuming that your cucumber features live in a directory called \"features\".  To pass in an alternative path to your features directory,
+  
+  rails generate atrium:cucumber_support test_support/features
+  
+  """
+  
+  def cucumber_support
+    directory("step_definitions", "#{features_dir}/step_definitions")
+    copy_file("support/paths.rb", "#{features_dir}/support/paths.rb")
+  end
+  
+end
+end

data/lib/generators/atrium/templates/config/role_map_cucumber.yml

@@ -0,0 +1,2 @@
+admin:
+  - test@test.com

data/lib/generators/atrium/templates/config/role_map_development.yml

@@ -0,0 +1,2 @@
+admin:
+  - test@test.com

data/lib/generators/atrium/templates/config/role_map_production.yml

@@ -0,0 +1,2 @@
+admin:
+  - test@test.com

data/lib/generators/atrium/templates/config/role_map_test.yml

@@ -0,0 +1,2 @@
+admin:
+  - test@test.com

data/lib/generators/atrium/templates/config/solr.yml

@@ -0,0 +1,10 @@
+# This is a sample config file that does not have multiple solr instances. You will also need to be sure to
+# edit the fedora.yml file to match the solr URL for active-fedora. 
+development:
+  url: http://localhost:8983/solr
+test: &TEST
+  url: http://127.0.0.1:8983/solr
+cucumber:
+  <<: *TEST
+production:
+  url: http://your.production.server:8080/bl_solr/core0 

data/lib/generators/atrium/templates/db/seeds.rb

@@ -0,0 +1,87 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+#
+# Examples:
+#
+#   cities = City.create([{ :name => 'Chicago' }, { :name => 'Copenhagen' }])
+#   Mayor.create(:name => 'Emanuel', :city => cities.first)
+
+#############################################
+# User Configuration
+#############################################
+email= "test@test.com"
+if User.find_by_email(email).nil?
+  user= User.create(:email => email, :password => "password", :password_confirmation => "password")
+else
+  user=  User.find_by_email(email)
+end
+puts "user created: #{user.inspect}"
+
+#############################################
+# Collection Configuration
+#############################################
+
+collection= Atrium::Collection.create
+search_facet= Atrium::Search::Facet.create([{:name=> "format", :atrium_collection_id=> collection.id}])
+puts "collection created: #{collection.inspect}, search_facet: #{search_facet.inspect}"
+collection2=Atrium::Collection.create
+
+#############################################
+# Exhibit Configuration
+#############################################
+exhibit= Atrium::Exhibit.create([{:set_number=> 1, :atrium_collection_id=> collection.id, :label=> "Exhibit 1"}])
+exhibit2= Atrium::Exhibit.create([{:set_number=> 1, :atrium_collection_id=> collection2.id, :label=> "Exhibit 1"}])
+puts "exhibit created: #{exhibit.inspect}"
+facet1=Atrium::BrowseLevel.create([{:atrium_exhibit_id=>1, :level_number=>1, :solr_facet_name=>'pub_date', :label=>'Publication Year'}])
+facet2=Atrium::BrowseLevel.create([{:atrium_exhibit_id=>1, :level_number=>2, :solr_facet_name=>'language_facet', :label=>'Language'}])
+
+########################################################################
+# Add some description to solr which can be used to link to collection
+########################################################################
+Blacklight.solr.delete_by_id("desc_solr:1")
+Blacklight.solr.delete_by_id("desc_solr:2")
+Blacklight.solr.delete_by_id("desc_solr:3")
+Blacklight.solr.commit
+
+doc1= {
+      :id                          => "desc_solr:1",
+      :format                      => "Description",
+      :active_fedora_model_s       => "Description",
+      :title_t                     => "Land Office Bank Currency",
+      :title_facet                 => "Land Office Bank Currency",
+      :title_s                     => "Land Office Bank Currency",
+      :page_display_s              => "newpage",
+      :page_display_t              => "newpage",
+      :description_content_s       => "<p style=\"margin-top: 0px; margin-right: 0px; margin-bottom: 1em; margin-left: 0px; padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; \"><span class=\"Apple-style-span\" style=\"color: rgb(51, 51, 51); font-family: Verdana, 'Lucida Grande', 'Lucida Sans Unicode', Arial, sans-serif; font-size: 11px; line-height: 15px; \">Very few colonists had liquid assets as most settlers were small farmers or local merchants holding their wealth as land or in the form of perishable commodities. This situation inhibited investment and economic development. In order to assist people in obtaining liquidity several colonies instituted &quot;Land Office Banks.&quot; The bank was operated by the colony with the consent of the Governor and the Board of Trade in London. Basically, a colony would print emissions of currency called &quot;Land Office&quot; notes. In several colonies the notes were allotted to local town or county boards. Property owners could then apply to their local board for a loan, usually up to &pound;100 offering as collateral a portion of their property that was assessed at twice the value of the loan. The individual was required to pay off the loan with interest over a prescribed period of time.</span></p>"
+    }
+
+
+doc2= {
+      :id                          => "desc_solr:2",
+      :format                      => "Description",
+      :active_fedora_model_s       => "Description",
+      :title_t                     => "Description 2",
+      :title_facet                 => "Description 2",
+      :title_s                     => "Description 2",
+      :page_display_s              => "samepage",
+      :page_display_t              => "samepage",
+      :description_content_s       => "this is the actually description of the essay"
+    }
+
+
+doc3= {
+      :id                          => "desc_solr:3",
+      :format                      => "Description",
+      :active_fedora_model_s       => "Description",
+      :title_t                     => "Description 3",
+      :title_facet                 => "Description 3",
+      :title_s                     => "Description 3",
+      :page_display_s              => "newpage",
+      :page_display_t              => "newpage",
+      :description_content_s       => "this is the actually description of the essay"
+    }
+
+Blacklight.solr.add doc1
+Blacklight.solr.add doc2
+Blacklight.solr.add doc3
+Blacklight.solr.commit

data/lib/generators/atrium/templates/migrations/create_atrium_browse_levels.rb

@@ -0,0 +1,18 @@
+class CreateAtriumBrowseLevels < ActiveRecord::Migration
+  def self.up
+    create_table :atrium_browse_levels do |t|
+      t.integer :atrium_exhibit_id, :null=>false
+      t.integer :level_number, :null=>false
+      t.string :filter_query_params
+      t.string :solr_facet_name
+      t.string :label
+      t.string :exclude_query_params
+    end
+    add_index :atrium_browse_levels, :id
+    add_index :atrium_browse_levels, :atrium_exhibit_id
+  end
+
+  def self.down
+    drop_table :atrium_browse_levels
+  end
+end

data/lib/generators/atrium/templates/migrations/create_atrium_collections.rb

@@ -0,0 +1,20 @@
+class CreateAtriumCollections < ActiveRecord::Migration
+  def self.up
+    create_table :atrium_collections do |t|
+      t.string :title
+      t.string :url_slug
+      t.string :filter_query_params
+      t.string :theme
+      t.text :title_markup
+      t.text :collection_description
+      t.text :search_instructions
+      t.text :collection_items
+    end
+    add_index :atrium_collections, :id
+    add_index :atrium_collections, :url_slug
+  end
+
+  def self.down
+    drop_table :atrium_collections
+  end
+end

data/lib/generators/atrium/templates/migrations/create_atrium_descriptions.rb

@@ -0,0 +1,16 @@
+class CreateAtriumDescriptions < ActiveRecord::Migration
+  def self.up
+    create_table :atrium_descriptions do |t|
+      t.integer :atrium_showcase_id, :null=>false
+      t.string :page_display
+      t.string :title
+      t.string :description_solr_id
+    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

@@ -0,0 +1,15 @@
+class CreateAtriumEssays < ActiveRecord::Migration
+  def self.up
+    create_table :atrium_essays do |t|
+      t.integer :atrium_description_id, :null=>false
+      t.string :content_type
+      t.text :content
+    end
+    add_index :atrium_essays, :id
+    add_index :atrium_essays, :atrium_description_id
+  end
+
+  def self.down
+    drop_table :atrium_contents
+  end
+end

data/lib/generators/atrium/templates/migrations/create_atrium_exhibits.rb

@@ -0,0 +1,16 @@
+class CreateAtriumExhibits < ActiveRecord::Migration
+  def self.up
+    create_table :atrium_exhibits do |t|
+      t.integer :atrium_collection_id, :null=>false
+      t.integer :set_number, :null=>false
+      t.string :label
+      t.string :filter_query_params
+    end
+    add_index :atrium_exhibits, :id
+    add_index :atrium_exhibits, :atrium_collection_id
+  end
+
+  def self.down
+    drop_table :atrium_exhibits
+  end
+end

data/lib/generators/atrium/templates/migrations/create_atrium_search_facets.rb

@@ -0,0 +1,14 @@
+class CreateAtriumSearchFacets < ActiveRecord::Migration
+  def self.up
+    create_table :atrium_search_facets do |t|
+      t.integer :atrium_collection_id, :null=>false
+      t.string :name
+    end
+    add_index :atrium_search_facets, :id
+    add_index :atrium_search_facets, :atrium_collection_id
+  end
+
+  def self.down
+    drop_table :atrium_search_facets
+  end
+end