blacklight-sitemap 0.0.5 → 1.0.0

data/README.rdoc

@@ -4,16 +4,17 @@ Rake task for creating a sitemap from a Blacklight Solr index.
 
 == Installation
 
-* In config/environment.rb add:
-    config.gem 'blacklight-sitemap'
+* This version only works with Rails 3/Blacklight 3. For Blacklight versions 2.x, try v0.0.5
+  of this gem.
+
+* In Gemfile
+    gem 'blacklight-sitemap'
 
 * Install the gem:
-    rake gems:install
-or
-    gem install blacklight-sitemap
+    bundle install
 
 * Run the generator:
-    script/generate blacklight_sitemap
+    rails g blacklight:sitemap
 
 * Open your Rakefile and edit the BlacklightSitemapTask to your liking using the
 provided documentation.

data/VERSION

@@ -1 +1 @@
-0.0.5
+1.0.0

data/lib/blacklight-sitemap.rb

@@ -31,6 +31,9 @@ module Rake
 
     # Solr sort option
     attr_accessor :sort
+    
+    # pick a request handler. 
+    attr_accessor :qt
 
     def initialize
       @url = 'http://localhost:3000/catalog'
@@ -41,6 +44,7 @@ module Rake
       @lastmod_field = 'timestamp'
       @priority_field = nil
       @sort = '_docid_ asc' # http://osdir.com/ml/solr-user.lucene.apache.org/2010-03/msg01371.html
+      @qt = 'standard'
       yield self if block_given?
       define
     end
@@ -61,7 +65,7 @@ module Rake
 
             puts 'Creating a sitemap...'
             fl = ['id', @lastmod_field, @priority_field].compact.join(',')
-            base_solr_parameters = {:qt => 'standard', :q => 'id:[* TO *]', :fl => fl}
+            base_solr_parameters = {:qt => @qt, :fq => 'id:[* TO *]', :fl => fl}
             number_of_resources = Blacklight.solr.find(base_solr_parameters.merge(:rows => 1))['response']['numFound']
             puts 'Number of resources: ' + number_of_resources.to_s
             batches = (number_of_resources / @max.to_f).ceil

data/lib/rails/generators/blacklight/sitemap/sitemap_generator.rb

@@ -0,0 +1,22 @@
+module Blacklight
+  module Generators
+    class SitemapGenerator < Rails::Generators::Base
+      desc 'Creates a configurable new rake task within Rakefile'
+
+      def self.source_root
+        @_blacklight_source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+
+      def create_blacklight_sitemap_task
+        rakefile_path = File.join(Rails.root,'Rakefile')
+        rakefile = File.read(rakefile_path)
+        if rakefile.scan('Rake::BlacklightSitemapTask.new').empty?
+          append_to_file(rakefile_path, File.read(File.join(File.dirname(__FILE__),'templates/default_rake_task.rb')))
+        end
+      end
+      
+    end
+  end
+end
+

data/{generators/blacklight_sitemap/blacklight_sitemap_generator.rb → lib/rails/generators/blacklight/sitemap/templates/default_rake_task.rb}

@@ -1,11 +1,3 @@
-class BlacklightSitemapGenerator < Rails::Generator::Base
-  def initialize(*runtime_args)
-    super
-  end
-
-  def manifest
-    record do |m|
-      sitemap_task = <<EOF
 require 'blacklight-sitemap'
 Rake::BlacklightSitemapTask.new do |sm|
   # below are configuration options with their default values shown.
@@ -36,21 +28,8 @@ Rake::BlacklightSitemapTask.new do |sm|
 
   # Solr query sort parameter
   # sm.sort = '_docid_ asc'
-end
-EOF
-      rakefile = File.read('Rakefile')
-      if rakefile.scan('Rake::BlacklightSitemapTask.new').empty?
-        rakefile << "\n" << sitemap_task
-        File.open('Rakefile', 'w'){|f| f.puts rakefile}
-      end
-    end
-  end
-
-  protected
-
-  def banner
-    %{Usage: #{$0} #{spec.name}\nCopies OpenURL.js public/javascripts/}
-  end
-
-end
-
+  
+  # Solr request handler. This can be useful when your Solr configuration already has
+  # a filter query appended.
+  # sm.qt = 'standard'
+end

data/spec/blacklight-sitemap_spec.rb

@@ -94,6 +94,13 @@ describe "BlacklightSitemap" do
     end
     task.sort.should eq('timestamp asc')
   end
+  
+  it 'should be able to set a new value for qt' do
+    task = Rake::BlacklightSitemapTask.new do |sm|
+      sm.qt = 'bozart'
+    end
+    task.qt.should eq('bozart')
+  end
 
   it 'should create the sitemap clobber task' do
     Rake::BlacklightSitemapTask.new

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: blacklight-sitemap
 version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
+  - 1
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors: 
 - Jason Ronallo
@@ -15,11 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-05 00:00:00 -05:00
+date: 2011-06-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -28,12 +29,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id001
-  prerelease: false
-  type: :runtime
   name: nokogiri
+  version_requirements: *id001
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -44,12 +45,12 @@ dependencies:
         - 1
         - 0
         version: 2.1.0
-  requirement: *id002
-  prerelease: false
-  type: :development
   name: rspec
+  version_requirements: *id002
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -60,12 +61,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id003
-  prerelease: false
-  type: :development
   name: bundler
+  version_requirements: *id003
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -76,12 +77,12 @@ dependencies:
         - 5
         - 1
         version: 1.5.1
-  requirement: *id004
-  prerelease: false
-  type: :development
   name: jeweler
+  version_requirements: *id004
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -90,10 +91,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id005
-  prerelease: false
-  type: :development
   name: rcov
+  version_requirements: *id005
+  prerelease: false
 description: Blacklight sitemap rake task.
 email: jronallo@gmail.com
 executables: []
@@ -110,8 +110,9 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- generators/blacklight_sitemap/blacklight_sitemap_generator.rb
 - lib/blacklight-sitemap.rb
+- lib/rails/generators/blacklight/sitemap/sitemap_generator.rb
+- lib/rails/generators/blacklight/sitemap/templates/default_rake_task.rb
 - spec/blacklight-sitemap_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -144,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Blacklight sitemap rake task.