amalgalite 0.1.0

data/tasks/announce.rake

@@ -0,0 +1,38 @@
+require 'tasks/config'
+#-------------------------------------------------------------------------------
+# announcement methods
+#-------------------------------------------------------------------------------
+
+proj_config = Configuration.for('project')
+namespace :announce do
+  desc "create email for ruby-talk"
+  task :email do
+    info = Utils.announcement
+
+    File.open("email.txt", "w") do |mail|
+      mail.puts "From: #{proj_config.author} <#{proj_config.email}>"
+      mail.puts "To: ruby-talk@ruby-lang.org"
+      mail.puts "Date: #{Time.now.rfc2822}"
+      mail.puts "Subject: [ANN] #{info[:subject]}"
+      mail.puts
+      mail.puts info[:title]
+      mail.puts
+      mail.puts info[:urls]
+      mail.puts 
+      mail.puts info[:description]
+      mail.puts 
+      mail.puts "{{ Release notes for Version #{Amalgalite::VERSION} }}"
+      mail.puts 
+      mail.puts info[:release_notes]
+      mail.puts
+      mail.puts info[:urls]
+    end 
+    puts "Created the following as email.txt:"
+    puts "-" * 72
+    puts File.read("email.txt")
+    puts "-" * 72
+  end 
+
+  CLOBBER << "email.txt"
+end
+

data/tasks/config.rb

@@ -0,0 +1,108 @@
+require 'configuration'
+
+require 'rake'
+require 'tasks/utils'
+
+#-----------------------------------------------------------------------
+# General project configuration
+#-----------------------------------------------------------------------
+Configuration.for('project') {
+  name          "amalgalite"
+  version       Amalgalite::Version.to_s
+  author        "Jeremy Hinegardner"
+  email         "jeremy at copiousfreetime dot org"
+  homepage      "http://www.copiousfreetime.org/projects/amalgalite/"
+  description   Utils.section_of("README", "description")
+  summary       description.split(".").first
+  history       "HISTORY"
+  license       FileList["LICENSE"]
+  readme        "README"
+}
+
+#-----------------------------------------------------------------------
+# Packaging 
+#-----------------------------------------------------------------------
+Configuration.for('packaging') {
+  # files in the project 
+  proj_conf = Configuration.for('project')
+  files {
+    bin       FileList["bin/*"]
+    ext       FileList["ext/*.{c,h,rb}"]
+    lib       FileList["lib/**/*.rb"]
+    test      FileList["spec/**/*.rb", "test/**/*.rb"]
+    data      FileList["data/**/*"]
+    tasks     FileList["tasks/**/*.r{ake,b}"]
+    rdoc      FileList[proj_conf.readme, proj_conf.history,
+                       proj_conf.license] + lib + FileList["ext/amalgalite3*.c"]
+    all       bin + ext + lib + test + data + rdoc + tasks 
+  }
+
+  puts "ext files = #{files.ext}"
+
+  # ways to package the results
+  formats {
+    tgz true
+    zip true
+    gem Configuration::Table.has_key?('gem')
+  }
+}
+
+#-----------------------------------------------------------------------
+# Gem packaging
+#-----------------------------------------------------------------------
+Configuration.for("gem") {
+  spec "gemspec.rb"
+  Configuration.for('packaging').files.all << spec
+}
+
+#-----------------------------------------------------------------------
+# Testing
+#   - change mode to 'testunit' to use unit testing
+#-----------------------------------------------------------------------
+Configuration.for('test') {
+  mode      "spec"
+  files     Configuration.for("packaging").files.test
+  options   %w[ --format specdoc --color ]
+  ruby_opts %w[ ]
+}
+
+#-----------------------------------------------------------------------
+# Rcov 
+#-----------------------------------------------------------------------
+Configuration.for('rcov') {
+  output_dir  "coverage"
+  libs        %w[ lib ]
+  rcov_opts   %w[ --html ]
+  ruby_opts   %w[ ]
+  test_files  Configuration.for('packaging').files.test
+}
+
+#-----------------------------------------------------------------------
+# Rdoc 
+#-----------------------------------------------------------------------
+Configuration.for('rdoc') {
+  files       Configuration.for('packaging').files.rdoc
+  main_page   files.first
+  title       Configuration.for('project').name
+  options     %w[ --line-numbers --inline-source ]
+  output_dir  "doc"
+}
+
+#-----------------------------------------------------------------------
+# Extensions
+#-----------------------------------------------------------------------
+Configuration.for('extension') {
+  configs   Configuration.for('packaging').files.ext.find_all { |x| %w[ mkrf_conf.rb extconf.rb ].include?(File.basename(x)) }
+}
+
+#-----------------------------------------------------------------------
+# Rubyforge 
+#-----------------------------------------------------------------------
+Configuration.for('rubyforge') {
+  project       "copiousfreetime"
+  user          "jjh"
+  host          "rubyforge.org"
+  rdoc_location "#{user}@#{host}:/var/www/gforge-projects/#{project}/amalgalite/"
+}
+
+

data/tasks/distribution.rake

@@ -0,0 +1,38 @@
+require 'tasks/config'
+
+#-------------------------------------------------------------------------------
+# Distribution and Packaging
+#-------------------------------------------------------------------------------
+if pkg_config = Configuration.for_if_exist?("packaging") then
+
+  require 'gemspec'
+  require 'rake/gempackagetask'
+  require 'rake/contrib/sshpublisher'
+
+  namespace :dist do
+
+    Rake::GemPackageTask.new(Amalgalite::GEM_SPEC) do |pkg|
+      pkg.need_tar = pkg_config.formats.tgz
+      pkg.need_zip = pkg_config.formats.zip
+    end
+
+    desc "Install as a gem"
+    task :install => [:clobber, :package] do
+      sh "sudo gem install -y pkg/#{Amalgalite::GEM_SPEC.full_name}.gem"
+    end
+
+    desc "Uninstall gem"
+    task :uninstall do 
+      sh "sudo gem uninstall -i #{Amalgalite::GEM_SPEC.name} -x"
+    end
+
+    desc "dump gemspec"
+    task :gemspec do
+      puts Amalgalite::GEM_SPEC.to_ruby
+    end
+
+    desc "reinstall gem"
+    task :reinstall => [:uninstall, :repackage, :install]
+
+ end
+end

data/tasks/documentation.rake

@@ -0,0 +1,31 @@
+require 'tasks/config'
+
+#-----------------------------------------------------------------------
+# Documentation
+#-----------------------------------------------------------------------
+
+if rdoc_config = Configuration.for_if_exist?('rdoc') then
+
+  namespace :doc do
+
+    require 'rake/rdoctask'
+
+    # generating documentation locally
+    Rake::RDocTask.new do |rdoc|
+      rdoc.rdoc_dir   = rdoc_config.output_dir
+      rdoc.options    = rdoc_config.options
+      rdoc.rdoc_files = rdoc_config.files
+      rdoc.title      = rdoc_config.title
+      rdoc.main       = rdoc_config.main_page
+    end 
+
+    if rubyforge_config = Configuration.for_if_exist?('rubyforge') then
+      desc "Deploy the RDoc documentation to #{rubyforge_config.rdoc_location}"
+      task :deploy => :rerdoc do
+        sh "rsync -zav --delete #{rdoc_config.output_dir}/ #{rubyforge_config.rdoc_location}"
+      end 
+    end 
+
+  end 
+end
+

data/tasks/extension.rake

@@ -0,0 +1,45 @@
+require 'tasks/config'
+require 'pathname'
+
+#-----------------------------------------------------------------------
+# Extensions
+#-----------------------------------------------------------------------
+
+if ext_config = Configuration.for_if_exist?('extension') then
+  namespace :ext do  
+    desc "Build the extension(s)"
+    task :build do
+      ext_config.configs.each do |extension|
+        path  = Pathname.new(extension)
+        parts = path.split
+        conf  = parts.last
+        Dir.chdir(path.dirname) do |d| 
+          ruby conf.to_s
+          sh "rake default"
+        end
+      end
+    end
+
+    task :clean do
+      ext_config.configs.each do |extension|
+        path  = Pathname.new(extension)
+        parts = path.split
+        conf  = parts.last
+        Dir.chdir(path.dirname) do |d| 
+          sh "rake clean"
+        end
+      end
+    end
+
+    task :clobber do
+      ext_config.configs.each do |extension|
+        path  = Pathname.new(extension)
+        parts = path.split
+        conf  = parts.last
+        Dir.chdir(path.dirname) do |d| 
+          sh "rake clobber"
+        end
+      end
+    end
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,32 @@
+
+require 'tasks/config'
+
+#--------------------------------------------------------------------------------
+# configuration for running rspec.  This shows up as the test:default task
+#--------------------------------------------------------------------------------
+if spec_config = Configuration.for_if_exist?("test") then
+  if spec_config.mode == "spec" then
+    namespace :test do
+
+      task :default => :spec
+
+      require 'spec/rake/spectask'
+      Spec::Rake::SpecTask.new do |r| 
+        r.ruby_opts   = spec_config.ruby_opts
+        r.libs        = [ Amalgalite::Paths.lib_path, 
+                          Amalgalite::Paths.ext_path,
+                          Amalgalite::Paths.root_dir ]
+        r.spec_files  = spec_config.files 
+        r.spec_opts   = spec_config.options
+
+        if rcov_config = Configuration.for_if_exist?('rcov') then
+          r.rcov      = true
+          r.rcov_dir  = rcov_config.output_dir
+          r.rcov_opts = rcov_config.rcov_opts
+        end
+      end
+
+      task :spec => 'ext:build'
+    end
+  end
+end

data/tasks/rubyforge.rake

@@ -0,0 +1,48 @@
+require 'tasks/config'    
+
+#-----------------------------------------------------------------------
+# Rubyforge additions to the task library
+#-----------------------------------------------------------------------
+if rf_conf = Configuration.for_if_exist?("rubyforge") then
+
+  abort("rubyforge gem not installed 'gem install rubyforge'") unless Utils.try_require('rubyforge')
+  
+  proj_conf = Configuration.for('project')
+
+  namespace :dist do
+    desc "Release files to rubyforge"
+    task :rubyforge => [:clean, :package] do
+
+      rubyforge = RubyForge.new
+
+      # make sure this release doesn't already exist
+      releases = rubyforge.autoconfig['release_ids']
+      if releases.has_key?(Amalgalite::GEM_SPEC.name) and releases[Amalgalite::GEM_SPEC.name][Amalgalite::VERSION] then
+        abort("Release #{Amalgalite::VERSION} already exists! Unable to release.")
+      end
+
+      config = rubyforge.userconfig
+      config["release_notes"]     = proj_conf.description
+      config["release_changes"]   = Utils.release_notes_from(proj_conf.history)[Amalgalite::VERSION]
+      config["Prefomatted"]       = true
+
+      puts "Uploading to rubyforge..."
+      files = FileList[File.join("pkg","#{Amalgalite::GEM_SPEC.name}-#{Amalgalite::VERSION}*.*")].to_a
+      rubyforge.login
+      rubyforge.add_release(Amalgalite::GEM_SPEC.rubyforge_project, Amalgalite::GEM_SPEC.name, Amalgalite::VERSION, *files)
+      puts "done."
+    end
+  end
+
+  namespace :announce do
+    desc "Post news of #{proj_conf.name} to #{rf_conf.project} on rubyforge"
+    task :rubyforge do
+      info = Utils.announcement
+      rubyforge = RubyForge.new
+      rubyforge.login
+      rubyforge.post_news(rf_conf.project, info[:subject], "#{info[:title]}\n\n#{info[:urls]}\n\n#{info[:release_notes]}")
+      puts "Posted to rubyforge"
+    end
+
+  end
+end

data/tasks/utils.rb

@@ -0,0 +1,80 @@
+require 'amalgalite/version'
+
+#-------------------------------------------------------------------------------
+# Additions to the Configuration class that are useful
+#-------------------------------------------------------------------------------
+class Configuration
+  class << self
+    def exist?( name )
+      Configuration::Table.has_key?( name )
+    end
+
+    def for_if_exist?( name )
+      if self.exist?( name ) then
+        self.for( name )
+      end
+    end
+  end
+end
+
+#-------------------------------------------------------------------------------
+# some useful utilitiy methods for the tasks
+#-------------------------------------------------------------------------------
+module Utils
+  class << self
+
+    # Try to load the given _library_ using the built-in require, but do not
+    # raise a LoadError if unsuccessful. Returns +true+ if the _library_ was
+    # successfully loaded; returns +false+ otherwise.
+    #
+    def try_require( lib ) 
+      require lib
+      true 
+    rescue LoadError 
+      false 
+    end 
+
+    # partition an rdoc file into sections, and return the text of the section
+    # given.  
+    def section_of(file, section_name) 
+      File.read(file).split(/^(?==)/).each do |section|
+        lines = section.split("\n")
+        return lines[1..-1].join("\n").strip if lines.first =~ /#{section_name}/i
+      end
+      nil
+    end
+
+    # Get an array of all the changes in the application for a particular
+    # release.  This is done by looking in the history file and grabbing the
+    # information for the most recent release.  The history file is assumed to
+    # be in RDoc format and version release are 2nd tier sections separated by
+    # '== Version X.Y.Z'
+    #
+    # returns:: A hash of notes keyed by version number
+    #
+    def release_notes_from(history_file)
+      releases = {}
+      File.read(history_file).split(/^(?==)/).each do |section|
+        lines = section.split("\n")
+        md = %r{Version ((\w+\.)+\w+)}.match(lines.first)
+        next unless md
+        releases[md[1]] = lines[1..-1].join("\n").strip
+      end
+      return releases
+    end
+
+    # return a hash of useful information for the latest release
+    # urls, subject, title, description and latest release notes
+    #
+    def announcement
+      cfg = Configuration.for("project") 
+      { 
+        :subject        => "#{cfg.name} #{Amalgalite::VERSION} Released",
+        :title          => "#{cfg.name} version #{Amalgalite::VERSION} has been released.",
+        :urls           => "#{cfg.homepage}",
+        :description    => "#{cfg.description.rstrip}",
+        :release_notes  => Utils.release_notes_from(cfg.history)[Amalgalite::VERSION].rstrip 
+      }
+    end
+  end
+end # << self

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification 
+name: amalgalite
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeremy Hinegardner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-20 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: configuration
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: arrayfields
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 4.5.0
+    version: 
+description: Amalgalite embeds the SQLite database engine in a ruby extension.  Scroll through Amalgalite::Database for a quick example, and a general overview of the API.
+email: jeremy@hinegardner.org
+executables: []
+
+extensions: 
+- ext/mkrf_conf.rb
+extra_rdoc_files: 
+- README
+- HISTORY
+- LICENSE
+- lib/amalgalite/blob.rb
+- lib/amalgalite/boolean.rb
+- lib/amalgalite/column.rb
+- lib/amalgalite/database.rb
+- lib/amalgalite/index.rb
+- lib/amalgalite/paths.rb
+- lib/amalgalite/profile_tap.rb
+- lib/amalgalite/schema.rb
+- lib/amalgalite/sqlite3/constants.rb
+- lib/amalgalite/sqlite3/version.rb
+- lib/amalgalite/sqlite3.rb
+- lib/amalgalite/statement.rb
+- lib/amalgalite/table.rb
+- lib/amalgalite/taps/console.rb
+- lib/amalgalite/taps/io.rb
+- lib/amalgalite/trace_tap.rb
+- lib/amalgalite/type_map.rb
+- lib/amalgalite/type_maps/default_map.rb
+- lib/amalgalite/type_maps/storage_map.rb
+- lib/amalgalite/type_maps/text_map.rb
+- lib/amalgalite/version.rb
+- lib/amalgalite/view.rb
+- lib/amalgalite.rb
+- ext/amalgalite3.c
+- ext/amalgalite3_constants.c
+- ext/amalgalite3_database.c
+- ext/amalgalite3_statement.c
+files: 
+- ext/amalgalite3.c
+- ext/amalgalite3_constants.c
+- ext/amalgalite3_database.c
+- ext/amalgalite3_statement.c
+- ext/sqlite3.c
+- ext/amalgalite3.h
+- ext/sqlite3.h
+- ext/sqlite3_options.h
+- ext/sqlite3ext.h
+- ext/gen_constants.rb
+- ext/mkrf_conf.rb
+- lib/amalgalite/blob.rb
+- lib/amalgalite/boolean.rb
+- lib/amalgalite/column.rb
+- lib/amalgalite/database.rb
+- lib/amalgalite/index.rb
+- lib/amalgalite/paths.rb
+- lib/amalgalite/profile_tap.rb
+- lib/amalgalite/schema.rb
+- lib/amalgalite/sqlite3/constants.rb
+- lib/amalgalite/sqlite3/version.rb
+- lib/amalgalite/sqlite3.rb
+- lib/amalgalite/statement.rb
+- lib/amalgalite/table.rb
+- lib/amalgalite/taps/console.rb
+- lib/amalgalite/taps/io.rb
+- lib/amalgalite/trace_tap.rb
+- lib/amalgalite/type_map.rb
+- lib/amalgalite/type_maps/default_map.rb
+- lib/amalgalite/type_maps/storage_map.rb
+- lib/amalgalite/type_maps/text_map.rb
+- lib/amalgalite/version.rb
+- lib/amalgalite/view.rb
+- lib/amalgalite.rb
+- spec/amalgalite_spec.rb
+- spec/boolean_spec.rb
+- spec/database_spec.rb
+- spec/default_map_spec.rb
+- spec/integeration_spec.rb
+- spec/paths_spec.rb
+- spec/schema_spec.rb
+- spec/spec_helper.rb
+- spec/sqlite3/constants_spec.rb
+- spec/sqlite3/version_spec.rb
+- spec/sqlite3_spec.rb
+- spec/statement_spec.rb
+- spec/storage_map_spec.rb
+- spec/tap_spec.rb
+- spec/text_map_spec.rb
+- spec/type_map_spec.rb
+- spec/version_spec.rb
+- README
+- HISTORY
+- LICENSE
+- tasks/announce.rake
+- tasks/distribution.rake
+- tasks/documentation.rake
+- tasks/extension.rake
+- tasks/rspec.rake
+- tasks/rubyforge.rake
+- tasks/config.rb
+- tasks/utils.rb
+- gemspec.rb
+has_rdoc: true
+homepage: http://copiousfreetime.rubyforge.org/amalgalite/
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README
+require_paths: 
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: copiousfreetime
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: Amalgalite embeds the SQLite database engine in a ruby extension
+test_files: []
+