dbplot 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*.pdf

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jacob Rothstein
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,19 @@
+h1. DBPlot
+
+DBPlot is some ruby glue between MySQL and R.  It generates and runs R based on a SQL-like DSL.  It is still very early in development.  The goal is to make it simpler to get common plots out of a database.  For more complex examples, there will be an export mode, which will let you save the output R source file for further editing.
+
+h2. Installation
+
+<pre><code>sudo gem install dbplot</code></pre>
+
+h2. Example
+
+<pre><code>dbplot -d dbplot -u joe -p password -q "plot yvar vs xvar from tablename"</code></pre>
+
+This would generate and execute a MySQL query (@select yvar, xvar from tablename@), pass it to R, and use ggplot2 to generate the appropriate plot (@qplot(xvar, yvar, data=data.from.mysql)@) and save it to a pdf (by default, out.pdf).
+
+h2. Project Goals:
+
+Support as much of common interactions between a database and ggplot2, including joins, faceting, grouping, coloring, summarization, different geoms, etc.
+
+Lock down the security so this can be run in a sandbox through a web interface; users could type in queries and get plots back against a database.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dbplot"
+    gem.summary = %Q{dbplot provides a sql-like interface to ggplot2}
+    gem.description = %Q{ruby glue between sql and r (ggplot2)}
+    gem.require_path = 'lib'
+    gem.email = "github@jacobrothstein.com"
+    gem.homepage = "http://github.com/jbr/dbplot"
+    gem.authors = ["Jacob Rothstein"]
+    gem.bindir = "bin"
+    gem.executables = %w( dbplot )
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dbplot #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/dbplot

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+ 
+require 'dbplot'
+require 'dbplot/runner'
+ 
+DbPlot::Runner.start

data/dbplot.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dbplot}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jacob Rothstein"]
+  s.date = %q{2009-10-27}
+  s.default_executable = %q{dbplot}
+  s.description = %q{ruby glue between sql and r (ggplot2)}
+  s.email = %q{github@jacobrothstein.com}
+  s.executables = ["dbplot"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "bin/dbplot",
+     "dbplot.gemspec",
+     "lib/dbplot.rb",
+     "lib/dbplot/runner.rb",
+     "test/dbplot_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jbr/dbplot}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{dbplot provides a sql-like interface to ggplot2}
+  s.test_files = [
+    "test/dbplot_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/dbplot.rb

@@ -0,0 +1,103 @@
+require 'rubygems'
+require 'mysql'
+require 'enumerable_proxy'
+require 'readline'
+
+class DbPlot
+  attr_accessor :settings, :debug, :data, :string
+
+  def self.version
+    "DbPlot v" + File.instance_eval { read(expand_path(join(dirname(__FILE__), '..', "VERSION"))) }
+  end
+
+  def initialize(options = {})
+    @settings = {
+      :host => 'localhost',
+      :username => 'root',
+      :password => 'password',
+      :database => ''
+    }
+    
+    %w(host database username password).map.to_sym.each do |setting|
+      settings[setting] = options[setting] if options[setting]
+    end
+  end
+  
+  def execute
+    return unless complete?
+    
+    column_string = @needed_columns.map do |col, col_alias|
+      "#{col}#{" AS #{col_alias}" if col_alias}"
+    end.join(", ")
+    
+    @query = %{SELECT #{column_string} FROM #{@table}}
+    
+    template = %{
+      require(ggplot2);
+      require(RMySQL);
+      
+      con <- dbConnect(MySQL(), user="#{settings[:username]}",
+          password="#{settings[:password]}", dbname="#{settings[:database]}",
+          host="localhost");
+        
+        data <- dbGetQuery(con, "#{@query}")
+        
+        pdf('#{@file}', width = 11, height = 8.5);
+        
+        qplot(#{@qplot.join(", ")}, data=data);
+        
+        dev.off()
+      }
+    puts template if debug
+    unless settings[:dry_run]
+      `echo \"#{template.gsub('"', '\\"')}\" | r --no-save #{"2>&1 > /dev/null" unless debug}`
+    end
+  end
+  
+  def parse
+    name_regex = /[a-z_]+/
+    
+    if string =~ /plot (#{name_regex})(?: as (#{name_regex}))? vs (#{name_regex})(?: as (#{name_regex}))? from (#{name_regex})(?: into ([a-z._]+))?/i
+      @ordinate, @ordinate_alias, @abscissa, @abscissa_alias, @table, @file = $1, $2, $3, $4, $5, $6
+
+      @file ||= "out.pdf"
+
+      @needed_columns = {@ordinate => @ordinate_alias, @abscissa => @abscissa_alias}
+      
+      @qplot = [
+        @abscissa_alias || @abscissa,
+        @ordinate_alias || @ordinate
+      ]
+      
+      if string =~ /color by (#{name_regex})(?: as (#{name_regex}))?/i
+        @needed_columns[$1] = $2
+        @qplot << "colour = #{$2 || $1}"
+      end
+    else
+      puts "\ncould not parse: \"#{string}\"\n\n"
+      @string = nil
+    end
+    
+    return self
+  end
+
+  def parse_line(string)
+    return self if string.strip == ""
+    @string ||= ""
+    @string += " #{string}"
+    parse if complete?
+    return self
+  end
+
+  def complete?
+    @string =~ /;/
+  end
+  
+  def strip_comments
+    @string.gsub /#.+$/, ''
+  end
+  
+  def prompt
+    @string.nil? ? 'dbplot> ' : '     -> '
+  end
+end

data/lib/dbplot/runner.rb

@@ -0,0 +1,41 @@
+class DbPlot
+  module Runner
+    def self.start
+      d = DbPlot.new
+
+      begin
+        OptionParser.new do |opts|
+          opts.banner = "Usage: #{$0} [options]"
+          opts.instance_eval do
+            on("--help", "This message") {puts opts; exit}
+            on("-v", "--verbose", "Run verbosely") {|v| d.debug = !!v }
+            on("-h", "--host HOST", "MySQL Host") {|h| d.settings[:host] = h }
+            on("-u", "--user USER", "MySQL User") {|u| d.settings[:username] = u }
+            on("-p", "--password PASSWORD", "MySQL Password") {|p| d.settings[:password] = p }
+            on("-d", "--database DATABASE", "MySQL Database") {|db| d.settings[:database] = db }
+            on("-q", "--query QUERY", "dbplot query") {|q| d.string = q.gsub(/;?$/, ";") }
+            on("--version", "Print version info and exit") {puts DbPlot.version;exit}
+            on "--dry-run", "Print but do not execute. Implies -v." do |dry|
+              d.debug = d.settings[:dry_run] = true
+            end
+          end
+        end.parse!
+      rescue => e
+        puts e.message
+        exit
+      end
+
+      if d.complete?
+        d.parse.execute
+      else
+        while line = Readline.readline(d.prompt, true)
+          case line
+          when /^(exit|quit)$/ then exit
+          when 'help' then puts "help message goes here\n\n "
+          else d.parse_line(line)
+          end
+        end
+      end
+    end
+  end
+end

data/test/dbplot_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class DbplotTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'dbplot'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: dbplot
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jacob Rothstein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-27 00:00:00 -07:00
+default_executable: dbplot
+dependencies: []
+
+description: ruby glue between sql and r (ggplot2)
+email: github@jacobrothstein.com
+executables: 
+- dbplot
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- bin/dbplot
+- dbplot.gemspec
+- lib/dbplot.rb
+- lib/dbplot/runner.rb
+- test/dbplot_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jbr/dbplot
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: dbplot provides a sql-like interface to ggplot2
+test_files: 
+- test/dbplot_test.rb
+- test/test_helper.rb