atrium 0.0.1.alpha

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

@@ -0,0 +1,15 @@
+class CreateAtriumShowcaseFacetSelections < ActiveRecord::Migration
+  def self.up
+    create_table :atrium_showcase_facet_selections do |t|
+      t.integer :atrium_showcase_id
+      t.string :solr_facet_name
+      t.string :value
+    end
+    add_index :atrium_showcase_facet_selections, :id
+    add_index :atrium_showcase_facet_selections, :atrium_showcase_id, :name =>'atrium_facet_showcase_index'
+  end
+
+  def self.down
+    drop_table :atrium_showcase_facet_selections
+  end
+end

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

@@ -0,0 +1,17 @@
+class CreateAtriumShowcaseItems < ActiveRecord::Migration
+  def self.up
+    create_table :atrium_showcase_items do |t|
+      t.string :solr_doc_id, :null=>false
+      t.string :type
+      t.integer :atrium_showcase_id, :null=>false
+    end
+
+    add_index :atrium_showcase_items, :solr_doc_id
+    add_index :atrium_showcase_items, :id
+    add_index :atrium_showcase_items, :atrium_showcase_id
+  end
+
+  def self.down
+    drop_table :atrium_showcase_items
+  end
+end

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

@@ -0,0 +1,16 @@
+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
+    end
+    add_index :atrium_showcases, :id
+    #add_index :atrium_showcases, :atrium_parent_id, :atrium_parent_type
+  end
+
+  def self.down
+    drop_table :atrium_showcases
+  end
+end

data/lib/generators/atrium/templates/themes/example.html.erb

@@ -0,0 +1,21 @@
+<%#
+  Theming in Atrium isn't very sophisticated.  When a collection is given a
+  theme it renders all the atrium views using a different layout file.
+
+  A custom layout file can be as simple as this one. It simply fills in the
+  content blocks present in the default layout. For a greater degree of freedom
+  you can copy the default layout from within the gem to the 'atrium_layouts'
+  directory in this application and make whatever changes you want to it.
+
+  For more information about nesting layouts see:
+    http://guides.rubyonrails.org/layouts_and_rendering.html#using-nested-layouts
+%>
+<% content_for :theme_styles do %>
+  <style type="text/css">
+    /* Theme-specific styles */
+    body {background: #497EC9;}
+  </style>
+<% end %>
+<%# content_for :main_header do %>
+<%# end %>
+<%= render :template => 'layouts/atrium' %>

data/lib/railties/all_tests.rake

@@ -0,0 +1,23 @@
+namespace :atrium do
+  begin
+    require 'cucumber/rake/task'
+    require 'rspec/core'
+    require 'rspec/core/rake_task'
+
+    desc "Run Atrium cucumber and rspec, with test solr"
+    task :all_tests => ['atrium:spec:with_solr', 'atrium:cucumber:with_solr']
+    
+    namespace :all_tests do
+      desc "Run Atrium rspec and cucumber tests with rcov"
+      rm "atrium-coverage.data" if File.exist?("atrium-coverage.data")
+      task :rcov => ['atrium:spec:rcov', 'atrium:cucumber:rcov']
+    end
+    
+  rescue LoadError
+    desc "Not available! (cucumber and rspec not avail)"
+    task :all_tests do
+      abort 'Not available. Both cucumber and rspec need to be installed to run atrium:all_tests'
+    end
+  end
+end
+

data/lib/railties/atrium_cucumber.rake

@@ -0,0 +1,121 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a
+# newer version of cucumber-rails. Consider adding your own code to a new file
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+# Atrium customization, trick Cucumber into looking in our current
+# location for Rails.root, even though we're going to give it features
+# from elsewhere.
+#ENV['RAILS_ROOT'] = Rails.root.to_s
+#ENV['RAILS_ENV'] = 'test'
+
+# atrium_features, where to find features inside atrium source?
+atrium_features = File.expand_path("../test_support/features",File.dirname(__FILE__))
+unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
+
+vendored_cucumber_bin = Dir[File.expand_path("../vendor/{gems,plugins}/cucumber*/bin/cucumber",File.dirname(__FILE__))].first
+$LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
+
+begin
+  require 'cucumber/rake/task'
+
+  namespace :atrium do
+    desc 'Alias for atrium:cucumber:ok'
+    task :cucumber => 'atrium:cucumber:ok'
+    namespace :cucumber do
+      Cucumber::Rake::Task.new({:ok => ['atrium:test:prepare', 'db:seed']}, 'Run features that should pass') do |t|
+        # Atrium customization, call features from external location, pass
+        # in feature location wtih cucumber_opts, yeah it's weird but that's how.
+        t.cucumber_opts = atrium_features
+
+        t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'default'
+      end
+
+      Cucumber::Rake::Task.new({:wip => 'db:test:prepare'}, 'Run features that are being worked on') do |t|
+        # Atrium customization, call features from external location, pass
+        # in feature location wtih cucumber_opts, yeah it's weird but that's how.
+        t.cucumber_opts = atrium_features
+        t.binary = vendored_cucumber_bin
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'wip'
+      end
+
+      Cucumber::Rake::Task.new({:rerun => 'db:test:prepare'}, 'Record failing features and run only them if any exist') do |t|
+        # Atrium customization, call features from external location, pass
+        # in feature location wtih cucumber_opts, yeah it's weird but that's how.
+        t.cucumber_opts = atrium_features
+
+        t.binary = vendored_cucumber_bin
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'rerun'
+      end
+
+      if (RUBY_VERSION.to_f < 1.9)  then
+      Cucumber::Rake::Task.new({:rcov => 'db:test:prepare'}, 'Run features with rcov') do |t|
+        # Atrium customization, call features from external location, pass
+        # in feature location wtih cucumber_opts, yeah it's weird but that's how.
+        t.cucumber_opts = atrium_features
+
+
+        t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'default'
+
+      end
+      end
+
+      desc 'Run all features'
+      task :all => [:ok]
+
+
+      # Solr wrapper. for now just for atrium:cucumber, plan to
+      # provide it for all variants eventually.
+      # if you would like to see solr startup messages on STDERR
+      # when starting solr test server during functional tests use:
+      #
+      #    rake SOLR_CONSOLE=true
+      require File.expand_path('../jetty_solr_server.rb', __FILE__)
+      desc "atrium:cucumber with jetty/solr launch"
+      task :with_solr do
+        # wrap tests with a test-specific Solr server
+        # Need to look  up where the test jetty is located
+        # from solr.yml, we don't hardcode it anymore.
+
+        solr_yml_path = locate_path("config", "solr.yml")
+        jetty_path = if ( File.exists?( solr_yml_path ))
+            solr_config = YAML::load(File.open(solr_yml_path))
+            solr_config["test"]["jetty_path"] if solr_config["test"]
+        end
+        raise Exception.new("Can't find jetty path to start test jetty. Expect a jetty_path key in config/solr.yml for test environment.") unless jetty_path
+
+        JettySolrServer.new(
+          :jetty_home => File.expand_path(jetty_path, Rails.root),
+          :sleep_after_start => 2).wrap do
+            Rake::Task["atrium:cucumber"].invoke
+        end
+      end
+
+    end
+
+
+  end
+
+
+  task :features => :cucumber do
+    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+  end
+
+  # In case we don't have ActiveRecord, append a no-op task that we can depend upon.
+  task 'db:test:prepare' do
+  end
+rescue LoadError
+  desc 'cucumber rake task not available (cucumber not installed)'
+  task :cucumber do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+end

data/lib/railties/index.rake

@@ -0,0 +1,37 @@
+namespace :solr do
+  namespace :index do
+
+    desc "Index all description records WITHOUT commiting changes to the index."
+    task :description => :environment do
+      puts "Desc: #{Atrium::Description.find(:all).inspect}"
+      Atrium::Description.all.each do |desc|
+        puts "Indexing Description ID:#{desc.id}"
+        Blacklight.solr.add desc.as_solr
+      end
+    end
+
+    desc "Index all description records AND commit changes to the index"
+    task :all => :environment do
+      Rake::Task['solr:index:description'].execute
+      Rake::Task['solr:index:commit'].execute
+      Rake::Task['solr:index:optimize'].execute
+    end
+
+    desc "Commit changes to solr index"
+    task :commit => :environment do
+      puts "Commiting Solr index."
+      start = Time.now
+      Blacklight.solr.commit
+      puts "Commiting took #{Time.now - start}s"
+    end
+
+    desc "Optimize solr index"
+    task :optimize => :environment do
+      puts "Optimizing Solr index."
+      start = Time.now
+      Blacklight.solr.optimize
+      puts "Optimization took #{Time.now - start}s"
+    end
+
+  end
+end

data/tasks/atrium.rake

@@ -0,0 +1,268 @@
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'thor/core_ext/file_binary_read'
+require 'jettywrapper'
+
+namespace :atrium do
+
+  desc "Execute Continuous Integration build (docs, tests with coverage)"
+  task :ci do
+    Rake::Task["atrium:doc"].invoke
+
+    jetty_params = {
+      :jetty_home   => File.expand_path(File.dirname(__FILE__) + '/../jetty'),
+      :quiet        => false,
+      :jetty_port   => 8983,
+      :solr_home    => File.expand_path(File.dirname(__FILE__) + '/../jetty/solr'),
+      :startup_wait => 30
+    }
+    error = Jettywrapper.wrap(jetty_params) do
+      Rake::Task['atrium:setup_test_app'].invoke
+      Rake::Task['atrium:test'].invoke
+    end
+    raise "test failures: #{error}" if error
+  end
+
+
+  desc "Easiest way to run rspec tests. Copies code to host plugins dir, loads fixtures, then runs specs - need to have jetty running."
+  #task :spec => "rspec:setup_and_run"
+
+  namespace :rspec do
+
+    desc "Run the atrium specs - need to have jetty running, test host set up and fixtures loaded."
+    task :run => :use_test_app do
+      puts "Running rspec tests"
+      puts Rake::Task["atrium:spec"].invoke
+      FileUtils.cd('../../')
+    end
+
+    desc "Sets up test host, loads fixtures, then runs specs - need to have jetty running."
+    task :setup_and_run => ["atrium:setup_test_app"] do
+      puts "Reloading fixtures"
+      Rake::Task["atrium:rspec:run"].invoke
+
+    end
+
+  end
+
+
+  # The following is a task named :doc which generates documentation using yard
+  begin
+    require 'yard'
+    require 'yard/rake/yardoc_task'
+    project_root = File.expand_path("#{File.dirname(__FILE__)}/../")
+    doc_destination = File.join(project_root, 'doc')
+    if !File.exists?(doc_destination)
+      FileUtils.mkdir_p(doc_destination)
+    end
+
+    YARD::Rake::YardocTask.new(:doc) do |yt|
+      readme_filename = 'README.textile'
+      textile_docs = []
+      Dir[File.join(project_root, "*.textile")].each_with_index do |f, index|
+        unless f.include?("/#{readme_filename}") # Skip readme, which is already built by the --readme option
+          textile_docs << '-'
+          textile_docs << f
+        end
+      end
+      yt.files   = Dir.glob(File.join(project_root, '*.rb')) +
+                   Dir.glob(File.join(project_root, 'app', '**', '*.rb')) +
+                   Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) +
+                   textile_docs
+      yt.options = ['--output-dir', doc_destination, '--readme', readme_filename]
+    end
+  rescue LoadError
+    desc "Generate YARD Documentation"
+    task :doc do
+      abort "Please install the YARD gem to generate rdoc."
+    end
+  end
+
+   #
+  # Cucumber
+  #
+
+
+  desc "Run cucumber tests for atrium - need to have jetty running, test host set up and fixtures loaded."
+  task :cucumber => ['test:prepare'] do
+    within_test_app do
+      puts "Running cucumber features in test host app #{Dir.pwd}"
+      puts Rake::Task["atrium:cucumber:cmd"].invoke
+    end
+  end
+
+
+  namespace :cucumber do
+    # atrium_features, where to find features inside atrium source?
+    atrium_features = File.expand_path("../test_support/features",File.dirname(__FILE__))
+    vendored_cucumber_bin = Dir[File.expand_path("../vendor/{gems,plugins}/cucumber*/bin/cucumber",File.dirname(__FILE__))].first
+    $LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
+    require 'cucumber/rake/task'
+    ### Don't call this directly, use atrium:cucumber
+    #Cucumber::Rake::Task.new(:cmd => 'atrium:db:seed') do |t|
+    Cucumber::Rake::Task.new(:cmd => 'atrium:db:seed') do |t|
+      t.cucumber_opts = atrium_features
+      t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+    end
+  end
+
+  #
+  # Misc Tasks
+  #
+
+  desc "Creates a new test app"
+  task :setup_test_app => [:set_test_host_path] do
+    path = TEST_HOST_PATH
+    errors = []
+    puts "Cleaning out test app path #{path}"
+    puts %x[rm -fr #{path}]
+    errors << 'Error removing test app' unless $?.success?
+
+    ###puts "Freezing gems to project vendor/cache"
+    ###puts %x[bundle package]
+    ###errors << 'Bundle package failed' unless $?.success?
+
+    puts "Creating test app directory"
+    FileUtils.mkdir_p(path)
+
+    puts "Installing rails, bundler and devise"
+    %x[gem install --no-rdoc --no-ri 'rails' -v "<4"]
+    %x[gem install --no-rdoc --no-ri 'bundler']
+
+    #puts "Copying over .rvmrc file"
+    #FileUtils.cp("./test_support/etc/rvmrc",File.join(path,".rvmrc"))
+    FileUtils.cd("tmp")
+    #system("source ./test_app/.rvmrc")
+
+    puts "Generating new rails app"
+    %x[bundle exec rails new test_app]
+    errors << 'Error generating new rails test app' unless $?.success?
+    FileUtils.cd('test_app')
+    FileUtils.rm('public/index.html')
+
+    puts "Copying Gemfile from test_support/etc"
+    FileUtils.cp('../../test_support/etc/Gemfile','./Gemfile')
+
+    #puts "Creating local vendor/cache dir and copying gems from atrium gemset"
+    #FileUtils.cp_r(File.join('..','..','vendor','cache'), './vendor')
+
+    #puts "Configure bundler to only look at the local vendor/cache"
+    #FileUtils.mkdir_p( File.expand_path('./.bundle') )
+    #FileUtils.cp_r(File.expand_path('../../test_support/etc/bundle_config'), File.expand_path('./.bundle/config'))
+
+    puts "Copying fixtures into test app spec/fixtures directory"
+    FileUtils.mkdir_p( File.join('.','test_support') )
+    FileUtils.cp_r(File.join('..','..','test_support','fixtures'), File.join('.','test_support','fixtures'))
+
+    puts "Executing bundle install"
+    puts %x[bundle install]
+    errors << 'Error running bundle install in test app' unless $?.success?
+
+    puts "Installing jQuery UJS in test app"
+    puts %x[bundle exec rails g jquery:install]
+    errors << 'Error installing jquery-rails in test app' unless $?.success?
+
+    puts "Installing cucumber in test app"
+    puts %x[bundle exec rails g cucumber:install]
+    errors << 'Error installing cucumber in test app' unless $?.success?
+
+    puts "Generating default blacklight install"
+    puts %x[bundle exec rails g blacklight --devise]
+    errors << 'Error generating default blacklight install' unless $?.success?
+
+    puts "Generating default atrium install"
+    puts %x[bundle exec rails g atrium -df] # using -f to force overwriting of solr.yml
+    errors << 'Error generating default atrium install' unless $?.success?
+
+    after = 'TestApp::Application.configure do'
+    replace!( "#{path}/config/environments/test.rb",  /#{after}/, "#{after}\n    config.log_level = :warn\n")
+
+    puts FileUtils.cp('../../lib/generators/atrium/templates/db/seeds.rb','db/seeds.rb')
+
+    #puts "Loading blacklight marc test data into Solr"
+    #%x[bundle exec rake solr:marc:index_test_data]
+
+    puts "Running rake db:migrate"
+    puts %x[bundle exec rake db:migrate]    
+    errors << 'Error running db:migrate in test app' unless $?.success?
+
+    puts %x[bundle exec rake db:migrate RAILS_ENV=test]
+    errors << 'Error running db:migrate RAILS_ENV=test in test app' unless $?.success?
+
+	  #raise "Errors: #{errors.join("; ")}" unless errors.empty?
+	
+    FileUtils.cd('../../')
+  end 
+  
+
+  task :set_test_host_path do
+    TEST_HOST_PATH = File.join(File.expand_path(File.dirname(__FILE__)),'..','tmp','test_app')
+    puts "Test app path:\n#{TEST_HOST_PATH}"
+  end
+
+  #
+  # Test
+  #
+
+  desc "Run tests against test app"
+  task :test => [:use_test_app]  do
+
+    puts "Running rspec tests"
+    puts  %x[bundle exec rake atrium:spec:rcov]
+    puts  %x[bundle exec rake atrium:rspec:run]
+
+    puts "Running cucumber tests"
+    puts %x[bundle exec rake atrium:cucumber]
+
+    FileUtils.cd(File.expand_path(File.dirname(__FILE__)))
+    puts "Completed test suite"
+  end
+
+  namespace :test do
+
+    desc "run db:test:prepare in the test app"
+    task :prepare => :test_app_exists do
+      within_test_app do
+        %x[rake db:test:prepare]
+      end
+    end
+
+    desc "Make sure the test app is installed"
+    task :test_app_exists => [:set_test_host_path] do
+      Rake::Task['atrium:setup_test_app'].invoke unless File.exist?(TEST_HOST_PATH)
+    end
+
+  end
+
+  namespace :db do
+    desc "Seed the database with once/ and always/ fixtures."
+    task :seed => ["atrium:test:test_app_exists"] do
+      within_test_app do
+          puts %x[bundle exec rake db:seed RAILS_ENV=test]
+      end
+    end
+  end
+
+  desc "Make sure the test app is installed, then run the tasks from its root directory"
+  task :use_test_app => [:set_test_host_path] do
+    Rake::Task['atrium:setup_test_app'].invoke unless File.exist?(TEST_HOST_PATH)
+    FileUtils.cd(TEST_HOST_PATH)
+  end
+end
+
+
+
+
+# Adds the content to the file.
+#
+def replace!(destination, regexp, string)
+  content = File.binread(destination)
+  content.gsub!(regexp, string)
+  File.open(destination, 'wb') { |file| file.write(content) }
+end
+
+def within_test_app
+  FileUtils.cd(TEST_HOST_PATH)
+  yield
+  FileUtils.cd('../../')
+end