user_query 0.1.0

data/ChangeLog

@@ -0,0 +1,4 @@
+2006-10-29  Kurt Stephens  <kurt@umleta.com>
+
+	* Initial release
+

data/README

@@ -0,0 +1,45 @@
+= UserQuery
+
+This is the rubyforge.com UserQuery package.
+
+== Installation
+
+gem install userquery
+
+== For User Documentation, see
+
+http://rubyforge.org/projects/userquery/
+
+The RubyForge package userquery allows users to do general queries on SQL database table columns using a simple query language. The package parses tokens from the user's query and generates SQL WHERE clauses immune to SQL injection attacks.
+
+For example, if a user wants to search for all entries records on a DATETIME field named date, the user can enter: "11/1/2006" into a text field associated with searching on the date column.
+
+UserQuery will intuitively convert this query into an SQL WHERE clause fragment:
+
+    (
+      (entries.date >= '2006-11-01 00:00:00') 
+    AND 
+      (entries.date <  '2006-11-02 00:00:00')
+    )
+
+The user query syntax includes "NOT", "OR", "AND" operators, grouping with parentheses, well as relational operators like "LESS THAN 5" or ">= $500". Keyword searching, like "foo AND NOT 'bar baz'" using SQL LIKE operators is configurable.This package deals with currencies, conversions between currencies and monetary values in an object-oriented fashion.
+
+== Home page
+
+* {UserQuery Home}[http://userquery.rubyforge.org]
+
+== Additional directories
+
+[./lib/...]      the UserQuery library
+[./test/...]     unit and functional test
+[./examples/...] example programs
+
+== Credits
+
+UserQuery was developed by:
+
+* Kurt Stephens -- ruby-userquery(at)umleta.com
+
+== Contributors
+
+Maybe you?

data/Rakefile

@@ -0,0 +1,359 @@
+# Rakefile for userquery      -*- ruby -*-
+# Adapted from RubyGems/Rakefile
+# upload_package NOT WORKING YET
+
+#################################################################
+
+PKG_Name = 'UserQuery'
+def package_version
+  '0.1.0'
+end
+def package_description
+  %{UserQuery generates SQL WHERE clauses from a simple user query expression.  Can integrate with ActiveRecord or be used stand-alone.
+}
+end
+
+#################################################################
+
+#require 'rubygems'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+
+#################################################################
+
+
+def announce(msg='')
+  STDERR.puts msg
+end
+
+PKG_NAME = PKG_Name.gsub(/[a-z][A-Z]/) {|x| "#{x[0,1]}_#{x[1,1]}"}.downcase
+RUBY_FORGE_PROJECT = PKG_NAME
+
+if ENV['REL']
+  PKG_VERSION = ENV['REL']
+  CURRENT_VERSION = package_version
+else
+  PKG_VERSION = package_version
+  CURRENT_VERSION = PKG_VERSION
+end
+
+CLEAN.include("COMMENTS")
+CLOBBER.include(
+  "test/data",
+  "test/temp",
+  'scripts/*.hieraki',
+  'data__',
+  'html',
+  'pkgs/sources/sources*.gem',
+  '.config',
+  '**/debug.log',
+  '**/development.log',
+  'logs'
+  )
+
+task :default => [:test]
+
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/*test*.rb']
+end
+
+Rake::TestTask.new(:functional) do |t|
+  t.test_files = FileList['test/functional*.rb']
+end
+
+Rake::TestTask.new(:alltests) do |t|
+  t.test_files = FileList['test/{*test,functional}*.rb']
+end
+
+desc "Run the tests for a build"
+task :build_tests do
+  html_dir = ENV['TESTRESULTS'] || 'html/tests'
+  ruby %{-Ilib scripts/buildtests.rb #{html_dir}}
+  open("#{html_dir}/summary.html") do |inf|
+    open("#{html_dir}/summary.new", "w") do |outf|
+      inf.each do |line|
+	if line =~ /td align/
+	  line = "    <td align=\"left\">#{Time.now}</td><td align=\"right\">"
+	end
+	outf.puts line
+      end
+    end
+  end
+  mv "#{html_dir}/summary.html", "#{html_dir}/summary.old"
+  mv "#{html_dir}/summary.new", "#{html_dir}/summary.html"      
+end
+
+# Shortcuts for test targets
+task :tf => [:functional]
+task :tu => [:test]
+task :ta => [:alltests]
+
+task :gemtest do
+  ruby %{-Ilib -rscripts/runtest -e 'run_tests("test/test_gempaths.rb", true)'}
+end
+
+# --------------------------------------------------------------------
+# Creating a release
+
+desc "Make a new release"
+task :release => [
+  :prerelease,
+  :clobber,
+  :alltests,
+  :update_version,
+  :package,
+  :tag] do
+  
+  announce 
+  announce "**************************************************************"
+  announce "* Release #{PKG_VERSION} Complete."
+  announce "* Packages ready to upload."
+  announce "**************************************************************"
+  announce 
+end
+
+# Validate that everything is ready to go for a release.
+task :prerelease do
+  announce 
+  announce "**************************************************************"
+  announce "* Making #{PKG_Name} Release #{PKG_VERSION}"
+  announce "* (current version #{CURRENT_VERSION})"
+  announce "**************************************************************"
+  announce  
+
+  # Is a release number supplied?
+  unless ENV['REL']
+    fail "Usage: rake release REL=x.y.z [REUSE=tag_suffix]"
+  end
+
+  # Is the release different than the current release.
+  # (or is REUSE set?)
+  if PKG_VERSION == CURRENT_VERSION && ! ENV['REUSE']
+    fail "Current version is #{PKG_VERSION}, must specify REUSE=tag_suffix to reuse version"
+  end
+
+  # Are all source files checked in?
+  if ENV['RELTEST']
+    announce "Release Task Testing, skipping checked-in file test"
+  else
+    announce "Checking for unchecked-in files..."
+    data = `set -x; svn status | grep -v '?'`
+    unless data =~ /^$/
+      fail "svn status is not clean ... do you have unchecked-in files?"
+    end
+    announce "No outstanding checkins found ... OK"
+  end
+end
+
+task :update_version => [:prerelease] do
+  if PKG_VERSION == CURRENT_VERSION && ! ENV['FORCE']
+    announce "No version change ... skipping version update"
+  else
+    announce "Updating #{PKG_Name} version to #{PKG_VERSION}"
+    version_rb = "lib/#{PKG_NAME}/#{PKG_NAME}_version.rb"
+    open(version_rb, "w") do |f|
+      f.puts "# DO NOT EDIT"
+      f.puts "# This file is auto-generated by build scripts."
+      f.puts "# See:  rake update_version"
+      f.puts "module #{PKG_Name}"
+      f.puts "  #{PKG_Name}Version = '#{PKG_VERSION}'"
+      f.puts "end"
+    end
+    if ENV['RELTEST']
+      announce "Release Task Testing, skipping commiting of new version"
+    else
+      sh %{svn commit -m "Updated to version #{PKG_VERSION}" #{version_rb}}
+    end
+  end
+end
+
+# FIX ME for SVN
+task :tag => [:prerelease] do
+  reltag = "REL_#{PKG_VERSION.gsub(/\./, '_')}"
+  reltag << ENV['REUSE'].gsub(/\./, '_') if ENV['REUSE']
+  announce "Tagging repo with [#{reltag}]"
+  if ENV['RELTEST']
+    announce "Release Task Testing, skipping repo tagging"
+  else
+    sh %{echo cvs tag #{reltag}}
+  end
+end
+
+# --------------------------------------------------------------------
+# Create a task to build the RDOC documentation tree.
+
+desc "Create the RDOC html files"
+rd = Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'html'
+  rdoc.title    = "#{PKG_Name}"
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
+  rdoc.rdoc_files.include('README', 'TODO', 'Releases')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+#  rdoc.rdoc_files.include('test/**/*.rb')
+}
+
+file "html/index.html" => [:rdoc]
+
+desc "Publish the RDOCs on RubyForge"
+task :publish_rdoc => ["html/index.html"] do
+  # NOTE: This task assumes that you have an SSH alias setup for rubyforge.
+  mkdir_p "emptydir"
+  sh "scp -rq emptydir rubyforge:/var/www/gforge-projects/#{RUBY_FORGE_PROJECT}/rdoc"
+  sh "scp -rq html/* rubyforge:/var/www/gforge-projects/#{RUBY_FORGE_PROJECT}/rdoc"
+  rm_r "emptydir"
+end
+
+# Wiki Doc Targets
+
+desc "Upload the Hieraki Data"
+task :upload => [:upload_gemdoc]
+
+task :upload_gemdoc => ['scripts/gemdoc.hieraki'] do
+  ruby %{scripts/upload_gemdoc.rb}
+end
+
+desc "Build the Hieraki documentation"
+task :hieraki => ['scripts/gemdoc.hieraki', 'scripts/specdoc.hieraki']
+
+file 'scripts/gemdoc.hieraki' => ['scripts/gemdoc.rb', 'scripts/gemdoc.data'] do
+  chdir('scripts') do
+    ruby %{-I../lib gemdoc.rb <gemdoc.data >gemdoc.hieraki}
+  end
+end
+
+file 'scripts/specdoc.hieraki' =>
+  ['scripts/specdoc.rb', 'scripts/specdoc.data', 'scripts/specdoc.yaml'] do
+  chdir('scripts') do
+    ruby %{-I../lib specdoc.rb >specdoc.hieraki}
+  end
+end
+
+# Package tasks
+
+PKG_FILES = FileList[
+  "Rakefile", "ChangeLog", "Releases", "TODO", "README", 
+#  "setup.rb",
+#  "post-install.rb",
+  "bin/*",
+  "doc/*.css", "doc/*.rb",
+  "examples/**/*",
+#  "gemspecs/**/*",
+  "lib/**/*.rb",
+#  "pkgs/**/*",
+  "redist/*.gem",
+  "scripts/*.rb",
+  "test/**/*"
+]
+PKG_FILES.exclude(%r(^(test/temp|examples/.*/*.log)(/|$)))
+
+Rake::PackageTask.new("package") do |p|
+  p.name = PKG_NAME
+  p.version = PKG_VERSION
+  p.need_tar = true
+  p.need_zip = true
+  p.package_files = PKG_FILES
+end
+
+Spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME 
+  s.version = PKG_VERSION
+  s.summary = "#{PKG_Name} GEM"
+  s.description = package_description
+  s.files = PKG_FILES.to_a
+  s.require_path = 'lib'
+  s.author = "Kurt Stephens"
+  s.email = "ruby-#{PKG_NAME}@umleta.com"
+  s.homepage = "http://#{PKG_NAME}.rubyforge.org"
+  s.rubyforge_project = "#{RUBY_FORGE_PROJECT}"
+  #s.bindir = "bin"                               # Use these for applications.
+  #s.executables = ["update_rubygems"]
+  certdir = ENV['CERT_DIR']
+  if certdir
+    s.signing_key = File.join(certdir, 'gem-umleta-private_key.pem')
+    s.cert_chain  = [File.join(certdir, 'gem-umleta-public_cert.pem')]
+  end
+end
+
+# Add console output about signing the Gem
+file "pkg/#{Spec.full_name}.gem" do
+  puts "Signed with certificates in '#{ENV['CERT_DIR']}'" if ENV['CERT_DIR']
+end
+
+Rake::GemPackageTask.new(Spec) do |p| end
+
+GEMSPEC = "pkg/#{PKG_NAME}.gemspec"
+desc "Build the Gem spec file for the #{PKG_NAME} package"
+task :gemspec => GEMSPEC
+file "pkg/#{PKG_NAME}.gemspec" => ["pkg", "Rakefile"] do |t|
+  open(t.name, "w") do |f| f.puts Spec.to_yaml end
+end
+
+# Automated upload to rubyforge.org
+PACKAGE_FILES = FileList["pkg/#{PKG_NAME}-#{PKG_VERSION}.*"]
+task :upload_package do
+# From activesuport/Rakefile, 
+# See: http://dev.rubyonrails.org/svn/rails/tags/rel_1-1-6/activesupport/Rakefile
+  `rubyforge login`
+
+  files = PACKAGE_FILES
+  files.each do |filename|
+    basename  = File.basename(filename)
+    puts "Releasing #{basename}..."
+    
+    release_command = "rubyforge add_release #{RUBY_FORGE_PROJECT} #{RUBY_FORGE_PROJECT} 'REL #{PKG_VERSION}' #{filename}"
+    puts release_command
+    system(release_command)
+  end
+end
+
+
+desc "Install #{PKG_Name}"
+task :install do
+  ruby 'install.rb'
+end
+
+# Run 'gem' (using local bin and lib directories).
+# e.g.
+#     rake rungem -- install -r blahblah --test
+
+desc "Run local 'gem'"
+task :rungem do
+  ARGV.shift
+  exec "ruby -Ilib bin/gem #{ARGV.join(' ')}"
+end
+
+# Misc Tasks ---------------------------------------------------------
+
+def egrep(pattern)
+  Dir['**/*.rb'].each do |fn|
+    count = 0
+    open(fn) do |f|
+      while line = f.gets
+	count += 1
+	if line =~ pattern
+	  puts "#{fn}:#{count}:#{line}"
+	end
+      end
+    end
+  end
+end
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  egrep /#.*(FIXME|TODO|TBD)/
+end
+
+desc "Look for Debugging print lines"
+task :dbg do
+  egrep /\bDBG|\bbreakpoint\b/
+end
+
+desc "List all ruby files"
+task :rubyfiles do 
+  puts Dir['**/*.rb'].reject { |fn| fn =~ /^pkg/ }
+  puts Dir['bin/*'].reject { |fn| fn =~ /CVS|.svn|(~$)|(\.rb$)/ }
+end
+

data/Releases

@@ -0,0 +1,6 @@
+= UserQuery Release History
+
+== Release 0.1.0: 2006/10/30
+
+* Initial Release
+

data/examples/userqueryex/HOWTO.txt

@@ -0,0 +1,5 @@
+# edit config/database.yml
+# Install lib/{currency,currency.rb} from http://rubyforge.org/projects/currency/ into vendor/.
+rake migrate
+script/server
+http://localhost:3000/

data/examples/userqueryex/README

@@ -0,0 +1,183 @@
+== Welcome to Rails
+
+Rails is a web-application and persistence framework that includes everything
+needed to create database-backed web-applications according to the
+Model-View-Control pattern of separation. This pattern splits the view (also
+called the presentation) into "dumb" templates that are primarily responsible
+for inserting pre-built data in between HTML tags. The model contains the
+"smart" domain objects (such as Account, Product, Person, Post) that holds all
+the business logic and knows how to persist themselves to a database. The
+controller handles the incoming requests (such as Save New Account, Update
+Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in 
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in 
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting started
+
+1. Start the web server: <tt>ruby script/server</tt> (run with --help for options)
+2. Go to http://localhost:3000/ and get "Welcome aboard: You’re riding the Rails!"
+3. Follow the guidelines to start developing your application
+
+
+== Web servers
+
+Rails uses the built-in web server in Ruby called WEBrick by default, so you don't
+have to install or configure anything to play around. 
+
+If you have lighttpd installed, though, it'll be used instead when running script/server.
+It's considerably faster than WEBrick and suited for production use, but requires additional
+installation and currently only works well on OS X/Unix (Windows users are encouraged
+to start with WEBrick). We recommend version 1.4.11 and higher. You can download it from
+http://www.lighttpd.net.
+
+If you want something that's halfway between WEBrick and lighttpd, we heartily recommend
+Mongrel. It's a Ruby-based web server with a C-component (so it requires compilation) that
+also works very well with Windows. See more at http://mongrel.rubyforge.org/.
+
+But of course its also possible to run Rails with the premiere open source web server Apache.
+To get decent performance, though, you'll need to install FastCGI. For Apache 1.3, you want
+to use mod_fastcgi. For Apache 2.0+, you want to use mod_fcgid.
+
+See http://wiki.rubyonrails.com/rails/pages/FastCGI for more information on FastCGI.
+
+== Example for Apache conf
+
+  <VirtualHost *:80>
+    ServerName rails
+    DocumentRoot /path/application/public/
+    ErrorLog /path/application/log/server.log
+  
+    <Directory /path/application/public/>
+      Options ExecCGI FollowSymLinks
+      AllowOverride all
+      Allow from all
+      Order allow,deny
+    </Directory>
+  </VirtualHost>
+
+NOTE: Be sure that CGIs can be executed in that directory as well. So ExecCGI
+should be on and ".cgi" should respond. All requests from 127.0.0.1 go
+through CGI, so no Apache restart is necessary for changes. All other requests
+go through FCGI (or mod_ruby), which requires a restart to show changes.
+
+
+== Debugging Rails
+
+Have "tail -f" commands running on both the server.log, production.log, and
+test.log files. Rails will automatically display debugging and runtime
+information to these files. Debugging info will also be shown in the browser
+on requests from 127.0.0.1.
+
+
+== Breakpoints
+
+Breakpoint support is available through the script/breakpointer client. This
+means that you can break out of execution at any point in the code, investigate
+and change the model, AND then resume execution! Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find_all
+      breakpoint "Breaking out from the list"
+    end
+  end
+  
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the breakpointer window. Here you can do things like:
+
+Executing breakpoint "Breaking out from the list" at .../webrick_server.rb:16 in 'breakpoint'
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>, 
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a breakpoint"
+  => "hello from a breakpoint"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first 
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you press CTRL-D
+
+
+== Console
+
+You can interact with the domain model by starting the console through script/console. 
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+
+
+== Description of contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblog_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+  
+app/views
+  Holds the template files for the view that should be named like
+  weblog/index.rhtml for the WeblogController#index action. All views use eRuby
+  syntax. This directory can also be used to keep stylesheets, images, and so on
+  that can be symlinked to public.
+  
+app/helpers
+  Holds view helpers that should be named like weblog_helper.rb.
+
+app/apis
+  Holds API classes for web services.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+components
+  Self-contained mini-applications that can bundle together controllers, models, and views.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+    
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  This directory is in the load path.