Changeset 95

Timestamp:

09/05/08 11:49:25 (3 months ago)

Author:

deveiant

Message:

• Updated build system and license

Location:

branches/rakefile-work

Files:

• INSTALL (modified) (1 prop)
• LICENSE (modified) (1 diff)
• README (modified) (4 diffs, 1 prop)
• Rakefile (modified) (15 diffs)
• Rakefile.local (modified) (2 diffs, 1 prop)
• TODO (modified) (1 prop)
• project.yml (modified) (1 diff)

branches/rakefile-work/LICENSE

@@ -1 @@
-# The Artistic License
+Copyright (c) 2008, Michael Granger
+All rights reserved.
 
-August 15, 1997
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-## Preamble
+  * Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
 
-The intent of this document is to state the conditions under which a Package may
-be copied, such that the Copyright Holder maintains some semblance of artistic
-control over the development of the package, while giving the users of the
-package the right to use and distribute the Package in a more-or-less customary
-fashion, plus the right to make reasonable modifications.
+  * Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
 
-## Definitions
+  * Neither the name of the author/s, nor the names of the project's
+    contributors may be used to endorse or promote products derived from this
+    software without specific prior written permission.
 
-  "Package" refers to the collection of files distributed by the Copyright
-  Holder, and derivatives of that collection of files created through textual
-  modification.
-  
-  "Standard Version" refers to such a Package if it has not been modified, or
-  has been modified in accordance with the wishes of the Copyright Holder as
-  specified below.
-  
-  "Copyright Holder" is whoever is named in the copyright or copyrights for the
-  package.
-  
-  "You" is you, if you're thinking about copying or distributing this Package.
-  
-  "Reasonable copying fee" is whatever you can justify on the basis of media
-  cost, duplication charges, time of people involved, and so on. (You will not
-  be required to justify it to the Copyright Holder, but only to the computing
-  community at large as a market that must bear the fee.)
-  
-  "Freely Available" means that no fee is charged for the item itself, though
-  there may be fees involved in handling the item. It also means that recipients
-  of the item may redistribute it under the same conditions they received it.
-
-1. You may make and give away verbatim copies of the source form of the Standard
-Version of this Package without restriction, provided that you duplicate all of
-the original copyright notices and associated disclaimers.
-
-2. You may apply bug fixes, portability fixes and other modifications derived
-from the Public Domain or from the Copyright Holder. A Package modified in such
-a way shall still be considered the Standard Version.
-
-3. You may otherwise modify your copy of this Package in any way, provided that
-you insert a prominent notice in each changed file stating how and when you
-changed that file, and provided that you do at least ONE of the following:
-
-   1. place your modifications in the Public Domain or otherwise make them
-   Freely Available, such as by posting said modifications to Usenet or an
-   equivalent medium, or placing the modifications on a major archive site such
-   as uunet.uu.net, or by allowing the Copyright Holder to include your
-   modifications in the Standard Version of the Package.
-   
-   2. use the modified Package only within your corporation or organization.
-
-   3. rename any non-standard executables so the names do not conflict with
-   standard executables, which must also be provided, and provide a separate
-   manual page for each non-standard executable that clearly documents how it
-   differs from the Standard Version.
-
-   4. make other distribution arrangements with the Copyright Holder. 
-
-4. You may distribute the programs of this Package in object code or executable
-form, provided that you do at least ONE of the following:
-
-   1. distribute a Standard Version of the executables and library files,
-   together with instructions (in the manual page or equivalent) on where to get
-   the Standard Version.
-
-   2. accompany the distribution with the machine-readable source of the Package
-   with your modifications.
-
-   3. give non-standard executables non-standard names, and clearly document the
-   differences in manual pages (or equivalent), together with instructions on
-   where to get the Standard Version.
-
-   4. make other distribution arrangements with the Copyright Holder. 
-
-5. You may charge a reasonable copying fee for any distribution of this Package.
-You may charge any fee you choose for support of this Package. You may not
-charge a fee for this Package itself. However, you may distribute this Package
-in aggregate with other (possibly commercial) programs as part of a larger
-(possibly commercial) software distribution provided that you do not advertise
-this Package as a product of your own. You may embed this Package's interpreter
-within an executable of yours (by linking); this shall be construed as a mere
-form of aggregation, provided that the complete Standard Version of the
-interpreter is so embedded.
-
-6. The scripts and library files supplied as input to or produced as output from
-the programs of this Package do not automatically fall under the copyright of
-this Package, but belong to whomever generated them, and may be sold
-commercially, and may be aggregated with this Package. If such scripts or
-library files are aggregated with this Package via the so-called "undump" or
-"unexec" methods of producing a binary executable image, then distribution of
-such an image shall neither be construed as a distribution of this Package nor
-shall it fall under the restrictions of Paragraphs 3 and 4, provided that you do
-not represent such an executable image as a Standard Version of this Package.
-
-7. C subroutines (or comparably compiled subroutines in other languages)
-supplied by you and linked into this Package in order to emulate subroutines and
-variables of the language defined by this Package shall not be considered part
-of this Package, but are the equivalent of input as in Paragraph 6, provided
-these subroutines do not change the language in any way that would cause it to
-fail the regression tests for the language.
-
-8. Aggregation of this Package with a commercial distribution is always
-permitted provided that the use of this Package is embedded; that is, when no
-overt attempt is made to make this Package's interfaces visible to the end user
-of the commercial distribution. Such use shall not be construed as a
-distribution of this Package.
-
-9. The name of the Copyright Holder may not be used to endorse or promote
-products derived from this software without specific prior written permission.
-
-10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
-WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-
-The End
-
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

branches/rakefile-work/README

@@ -41 +41 @@
 == Installation
 
-For installation instructions, see the INSTALL file.
+If you use RubyGems, you can install via:
+
+  $ sudo gem install ruby-wordnet
+
+You can also install as a site library via the Rakefile:
+
+  $ wget http://deveiate.org/code/ruby-wordnet-x.y.z.tar.gz
+  $ tar xzvf ruby-wordnet-x.y.z.tar.gz
+  $ cd ruby-wordnet-x.y.z
+  $ sudo rake install
 
 
@@ -47 +56 @@
 
 There is a project page for Ruby-WordNet which can be found at:
-<http://deveiate.org/code/Ruby-WordNet.shtml>.
+<http://deveiate.org/projects/Ruby-WordNet/>.
 
 This library was developed as part of the FaerieMUD Project. For more
@@ -65 +74 @@
 == Legal
 
-Ruby-WordNet is Open Source Software which is Copyright © 2001-2007 by The
+Ruby-WordNet is Open Source Software which is Copyright © 2001-2008 by The
 FaerieMUD Consortium.
 
-You may use, modify, and/or redistribute this software under the terms of the
-Perl Artistic License, a copy of which should have been included in this
-distribution (See the file Artistic). If it was not, a copy of it may be
-obtained from http://language.perl.com/misc/Artistic.html or
-http://www.faeriemud.org/artistic.html).
-
-THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
-INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND
-FITNESS FOR A PARTICULAR PURPOSE.
-
---
+It is licensed under the modified BSD license. See the LICENSE file for details.
 
 WordNet® is a registered trademark of Princeton University. 
-
---
 
 Lingua::Wordnet is code licensed under the following terms:
@@ -93 +90 @@
 
 
-=== Version
-
 $Id$
 

branches/rakefile-work/Rakefile

@@ -35 +35 @@
 ### Config constants
 BASEDIR       = Pathname.new( __FILE__ ).dirname.relative_path_from( Pathname.getwd )
+BINDIR        = BASEDIR + 'bin'
 LIBDIR        = BASEDIR + 'lib'
 EXTDIR        = BASEDIR + 'ext'
 DOCSDIR       = BASEDIR + 'docs'
 PKGDIR        = BASEDIR + 'pkg'
-RAKE_TASKDIR  = BASEDIR + 'rake'
-
-PKG_NAME      = 'wordnet'
-PKG_SUMMARY   = ''
+
+PROJECT_NAME  = 'WordNet'
+PKG_NAME      = PROJECT_NAME.downcase
+PKG_SUMMARY   = 'a Ruby interface to the WordNet Lexical Database'
 VERSION_FILE  = LIBDIR + 'wordnet.rb'
 PKG_VERSION   = VERSION_FILE.read[ /VERSION = '(\d+\.\d+\.\d+)'/, 1 ]
@@ -48 +49 @@
 GEM_FILE_NAME = "#{PKG_FILE_NAME}.gem"
 
-RELEASE_NAME  = "RELEASE_#{PKG_VERSION.gsub(/\./, '_')}"
-
 ARTIFACTS_DIR = Pathname.new( ENV['CC_BUILD_ARTIFACTS'] || 'artifacts' )
 
 TEXT_FILES    = %w( Rakefile ChangeLog README LICENSE ).collect {|filename| BASEDIR + filename }
+BIN_FILES     = Pathname.glob( BINDIR + '*' ).delete_if {|item| item =~ /\.svn/ }
 LIB_FILES     = Pathname.glob( LIBDIR + '**/*.rb' ).delete_if {|item| item =~ /\.svn/ }
 EXT_FILES     = Pathname.glob( EXTDIR + '**/*.{c,h,rb}' ).delete_if {|item| item =~ /\.svn/ }
@@ -62 +62 @@
 TEST_FILES    = Pathname.glob( TESTDIR + '**/*.tests.rb' ).delete_if {|item| item =~ /\.svn/ }
 
-RELEASE_FILES = FileList[ TEXT_FILES + SPEC_FILES + TEST_FILES + LIB_FILES + EXT_FILES ]
+RAKE_TASKDIR  = BASEDIR + 'rake'
+RAKE_TASKLIBS = Pathname.glob( RAKE_TASKDIR + '*.rb' )
+
+LOCAL_RAKEFILE = BASEDIR + 'Rakefile.local'
+
+EXTRA_PKGFILES = []
+EXTRA_PKGFILES.concat Pathname.glob( BASEDIR + 'covertdb.rb' ).delete_if {|item| item =~ /\.svn/ } 
+EXTRA_PKGFILES.concat Pathname.glob( BASEDIR + 'utils.rb' ).delete_if {|item| item =~ /\.svn/ } 
+EXTRA_PKGFILES.concat Pathname.glob( BASEDIR + 'examples/*.rb' ).delete_if {|item| item =~ /\.svn/ } 
+
+RELEASE_FILES = TEXT_FILES + 
+    SPEC_FILES + 
+    TEST_FILES + 
+    BIN_FILES +
+    LIB_FILES + 
+    EXT_FILES + 
+    RAKE_TASKLIBS +
+    EXTRA_PKGFILES
+
+RELEASE_FILES << LOCAL_RAKEFILE if LOCAL_RAKEFILE.exist?
 
 COVERAGE_MINIMUM = ENV['COVERAGE_MINIMUM'] ? Float( ENV['COVERAGE_MINIMUM'] ) : 85.0
@@ -81 +100 @@
 SVN_TAGS_DIR     = 'tags'
 
+SVN_DOTDIR       = BASEDIR + '.svn'
+SVN_ENTRIES      = SVN_DOTDIR + 'entries'
+
+
 ### Load some task libraries that need to be loaded early
 require RAKE_TASKDIR + 'helpers.rb'
@@ -92 +115 @@
 
 # Documentation constants
+RDOCDIR = DOCSDIR + 'api'
 RDOC_OPTIONS = [
     '-w', '4',
@@ -108 +132 @@
 PROJECT_PUBDIR = "/usr/local/www/public/code"
 PROJECT_DOCDIR = "#{PROJECT_PUBDIR}/#{PKG_NAME}"
-PROJECT_SCPURL = "#{PROJECT_HOST}:#{PROJECT_DOCDIR}"
+PROJECT_SCPPUBURL = "#{PROJECT_HOST}:#{PROJECT_PUBDIR}"
+PROJECT_SCPDOCURL = "#{PROJECT_HOST}:#{PROJECT_DOCDIR}"
+
+# Rubyforge stuff
+RUBYFORGE_GROUP = 'deveiate'
+RUBYFORGE_PROJECT = 'wordnet'
 
 # Gem dependencies: gemname => version
 DEPENDENCIES = {
+}
+
+# Developer Gem dependencies: gemname => version
+DEVELOPMENT_DEPENDENCIES = {
+    'amatch'      => '>= 0.2.3',
+    'rake'        => '>= 0.8.1',
+    'rcodetools'  => '>= 0.7.0.0',
+    'rcov'        => '>= 0',
+    'RedCloth'    => '>= 4.0.3',
+    'rspec'       => '>= 0',
+    'rubyforge'   => '>= 0',
+    'termios'     => '>= 0',
+    'text-format' => '>= 1.0.0',
+    'tmail'       => '>= 1.2.3.1',
+    'ultraviolet' => '>= 0.10.2',
+    'libxml-ruby' => '>= 0.8.3',
 }
 
@@ -126 +171 @@
     gem.summary           = PKG_SUMMARY
     gem.description       = <<-EOD
-    A Ruby implementation of the WordNet lexical dictionary
+    A Ruby implementation of the WordNet lexical dictionary an online lexical reference system whose
+    design is inspired by current psycholinguistic theories of human lexical memory.
     EOD
 
@@ -132 +178 @@
     gem.email             = 'ged@FaerieMUD.org'
     gem.homepage          = 'http://deveiate.org/projects/Ruby-WordNet'
-    gem.rubyforge_project = 'deveiate'
+    gem.rubyforge_project = RUBYFORGE_PROJECT
 
     gem.has_rdoc          = true
     gem.rdoc_options      = RDOC_OPTIONS
+
+    gem.bindir            = BINDIR.relative_path_from(BASEDIR).to_s
+    
 
     gem.files             = RELEASE_FILES.
@@ -144 +193 @@
     DEPENDENCIES.each do |name, version|
         version = '>= 0' if version.length.zero?
-        gem.add_dependency( name, version )
+        gem.add_runtime_dependency( name, version )
+    end
+    
+    DEVELOPMENT_DEPENDENCIES.each do |name, version|
+        version = '>= 0' if version.length.zero?
+        gem.add_development_dependency( name, version )
     end
     
@@ -152 +206 @@
 end
 
+# Manual-generation config
+MANUALDIR = DOCSDIR + 'manual'
+
+$trace = Rake.application.options.trace ? true : false
+$dryrun = Rake.application.options.dryrun ? true : false
+
 
 # Load any remaining task libraries
-Pathname.glob( RAKE_TASKDIR + '*.rb' ).each do |tasklib|
-    RELEASE_FILES.include( tasklib )
-
+RAKE_TASKLIBS.each do |tasklib|
     next if tasklib =~ %r{/(helpers|svn|verifytask)\.rb$}
     begin
@@ -171 +229 @@
 end
 
-$trace = Rake.application.options.trace ? true : false
-$dryrun = Rake.application.options.dryrun ? true : false
-
 # Load any project-specific rules defined in 'Rakefile.local' if it exists
-LOCAL_RAKEFILE = BASEDIR + 'Rakefile.local'
-if LOCAL_RAKEFILE.exist?
-    import LOCAL_RAKEFILE 
-    RELEASE_FILES.include( LOCAL_RAKEFILE.to_s )
-end
+import LOCAL_RAKEFILE if LOCAL_RAKEFILE.exist?
 
 
@@ -187 +238 @@
 
 ### Default task
-task :default  => [:clean, :spec, :rdoc, :package]
+task :default  => [:clean, :local, :spec, :rdoc, :package]
+
+### Task the local Rakefile can append to -- no-op by default
+task :local
 
 
@@ -194 +248 @@
 CLOBBER.include 'artifacts', 'coverage.info', PKGDIR
 
-
-### Cruisecontrol task
+# Target to hinge on ChangeLog updates
+file SVN_ENTRIES
+
+### Task: changelog
+file 'ChangeLog' => SVN_ENTRIES.to_s do |task|
+    log "Updating #{task.name}"
+
+    changelog = make_svn_changelog()
+    File.open( task.name, 'w' ) do |fh|
+        fh.print( changelog )
+    end
+end
+
+
+### Task: cruise (Cruisecontrol task)
 desc "Cruisecontrol build"
 task :cruise => [:clean, :spec, :package] do |task|
@@ -202 +269 @@
     artifact_dir.mkpath
     
-    $stderr.puts "Copying coverage stats..."
-    FileUtils.cp_r( 'coverage', artifact_dir )
+    coverage = BASEDIR + 'coverage'
+    if coverage.exist? && coverage.directory?
+        $stderr.puts "Copying coverage stats..."
+        FileUtils.cp_r( 'coverage', artifact_dir )
+    end
     
     $stderr.puts "Copying packages..."
@@ -210 +280 @@
 
 
+desc "Update the build system to the latest version"
+task :update_build do
+    log "Updating the build system"
+    sh 'svn', 'up', RAKE_TASKDIR
+    log "Updating the Rakefile"
+    sh 'rake', '-f', RAKE_TASKDIR + 'Metarakefile'
+end
+

branches/rakefile-work/Rakefile.local

@@ -20 +20 @@
 DATA_DATABASE_FILE = DATA_BUILD_DIR + 'data'
 
-RELEASE_FILES.include( 'examples/*.rb' )
-
 
 ### Tasks
@@ -35 +33 @@
 # Conversion utility
 file CONVERT_UTIL.to_s
-RELEASE_FILES.include( CONVERT_UTIL.to_s )
 
 # Build directory for the database files

branches/rakefile-work/project.yml

@@ -1 +1 @@
 --- 
-project_description: A Ruby implementation of the WordNet lexical dictionary
+rubyforge_project: wordnet
+project_requirements: 
+  bdb: ">= 0.6.5"
+project_description: |-
+  A Ruby implementation of the WordNet lexical dictionary an online lexical reference system whose
+  design is inspired by current psycholinguistic theories of human lexical memory.
+rubyforge_group: deveiate
 author_name: Michael Granger
 project_homepage: http://deveiate.org/projects/Ruby-WordNet
+project_dependencies: {}
+
+project_summary: a Ruby interface to the WordNet Lexical Database
 project_name: WordNet
+version_file: wordnet.rb
+additional_pkgfiles: 
+- convertdb.rb
+- utils.rb
+- examples/*.rb
+dev_dependencies: {}
+
 author_email: ged@FaerieMUD.org
-
-project_dependencies:
-
-project_requirements:
-  bdb: >= 0.6.5
-