rack-r 0.1.0 → 0.1.1

data/README.md

@@ -11,13 +11,13 @@ simple as rendering R code into your output. E.g.
     </script>
 
 RackR will pick this up on its way out and replace it with an empty
-container and some JavaScript code to perform an immediate async
-request for processing the R code.
+container and some JavaScript code to perform an immediate
+asynchronous request for processing the R code.
 
-RackR will answer to this reqyest with processing the R code in a temp
-directory, then searching this directory for displayable content and
-finally return the html code for display. So the example above will
-eventually turn into something like this.
+RackR will answer to this request with processing the R code in a
+temporary directory, then searching this directory for displayable
+content, and finally return the html code for display. So the example
+above will eventually turn into something like this:
 
     <div>
      <img src='/path/to/sinus.png' />
@@ -26,9 +26,9 @@ eventually turn into something like this.
      </pre>
     </div>
 
-Almost everything can conveniently be configured in a YAML file. RackR
-will create a sample config file in `config/rack-r.yml` or any other
-path given.
+**Almost everything can conveniently be configured in a YAML file.**
+RackR will create a sample config file in `config/rack-r.yml` or any
+other path given.
 
 
 Install in Rails
@@ -51,6 +51,30 @@ Using RackR outside of Rails
     use RackR::Middleware, :config => 'path/to/config/rack-r.yml'
 
 
+The RackR-Header
+----------------
+
+The RackR-Header is a piece of R code that gets prepended to every R
+script, which is processed by RackR. Ideally it will read your
+database config and provide a seperate connection to your database via
+a DBI compatible object. This is currently provided by a R function
+called `connect`.
+
+If you want RackR to automatically connect R scripts to your Rails
+database it is a good idea to install Jeremy Stephens' YAML for R, as
+mentioned in Dependencies.
+
+Additionally there is a function `getPapertrail` which takes a
+classname and an id, and retrieves previous versions of database entries
+(stored by the popular versioning library
+[Papertrail](https://github.com/airblade/paper_trail/)) in form of a
+proper R dataframe.
+
+The whole RackR-Header is a work in progress, if you have to adjust it
+to your database config and/or end up writing helper functions like
+`getPapertrail`, please consider to contribute your additions.
+
+
 Dependencies
 ------------
 
@@ -58,17 +82,11 @@ These instructions are for Debian Squeeze. Install R.
 
     apt-get install r-base r-cran-dbi
 
-Alternatively you can use the `rodbc` package.
+Alternatively to `dbi` you can use the `rodbc` package.
 
     apt-get install r-cran-rodbc 
 
-The RackR-Header is a pice of R code that gets prepended to every R
-script which is processed by RackR. Idealy it will read you database
-config and provide a seperate connection to your database via a DBI
-compatible `con` object.
-
-If you want RackR to automatically connect R script to yoyr Rails
-database it is a good idea to install Jeremy Stephens' YAML for R.
+### YAML
 
     wget http://cran.r-project.org/src/contrib/yaml_2.1.4.tar.gz
     R CMD INSTALL yaml_2.1.4.tar.gz
@@ -82,9 +100,6 @@ database it is a good idea to install Jeremy Stephens' YAML for R.
 
     apt-get install r-cran-rmysql
 
-The whole RackR-Header is a work in progress, if you have to adjust it
-to your database config, please consider to contribute your addition.
-
 
 Trouble shooting
 ----------------
@@ -103,4 +118,4 @@ a line.
 License
 -------
 
-RackR is released under MIT License, see LICENSE.
+RackR is released under MIT License, see LICENSE.

data/RECEIPES.md

@@ -0,0 +1,30 @@
+Receipes
+========
+
+Boxplot the ages of users
+-------------------------
+
+    svg('0_user_age.svg')
+    users <- dbReadTable(con, 'users')
+    users$age <- round(as.numeric(as.Date(users$birth_date) - Sys.Date()) / -365.25)
+    boxplot(users$age)
+
+
+Output a html table of data
+---------------------------
+
+    some_data <- dbReadTable(con, 'some_table')
+    write.csv(some_data, file='some_data.csv')
+
+
+Control the order of content
+----------------------------
+
+The resulting files are processed/included aplhabetically. So if you
+name you output devices accordingly, you can control the order. E.g.
+
+    svg('1st_graphic_is_a_sinus.svg')
+    plot(sin)
+    svg('2nd_graphic_is_a_cosinus.svg')
+    plot(cos)
+

data/lib/rack_r/middleware.rb

@@ -10,6 +10,8 @@ module RackR
     def call(env)
       @env = env
       return call_app unless config.enabled
+      return call_app if config.skip_pattern &&
+        path_info.match(config.skip_pattern)
       if get? and md = match_path
         key = md.to_a.last
         return [200, {}, ['RackR OK.']] if key.empty?
@@ -160,21 +162,34 @@ r_header: |
   # modify this header in rack-r config file
   library(yaml)
   library(DBI)
-  library(RSQLite)
-  root <- '<%= Rails.root %>'
-  dbconf <- yaml.load_file(paste(root, '/config/database.yml', sep=''))
-  dbfile <- paste(root, '/', dbconf$development$database, sep='')
-  drv <- dbDriver("SQLite")
-  con <- dbConnect(drv, dbname=dbfile)
+  root <- '/home/phil/src/controlling'
+  dbconf <- yaml.load_file(paste(root, '/config/database.yml', sep=''))$development
+  connect <- function() {
+    if(dbconf$adapter=='sqlite3') {
+      library(RSQLite)
+      dbfile <- paste(root, '/', dbconf$database, sep='')
+      drv <- dbDriver("SQLite")
+      return(dbConnect(drv, dbname=dbfile))
+    } else if (dbconf$adapter=='mysql') {
+      library(RMySQL)
+      return(dbConnect(MySQL(), user=dbconf$username, dbname=dbconf$database))
+    }
+  }
+  getPapertrail <- function(model, id) {
+    sql <- paste("SELECT object FROM versions WHERE ",
+                 "item_type='", model, "' AND item_id='",
+                 id, "' AND event='update'", sep='')
+    connection <- connect()
+    result <- dbSendQuery(connection, sql)
+    rows <- fetch(result)
+    lapply(rows$object, yaml.load)
+  }
 ajaxer: |
   <div class='rack_r' id='<%= key %>'>Processing R...</div>
   <script type='text/javascript'>
     var url = '<%= config.url_scope %>/<%= key %>';
     $.ajax(url, { success: function(data) { $('#<%= key %>').html(data); } });
   </script>
-html:
-  prefix:    <div class='rack_r_out'>
-  suffix:    </div>
 templates:
   - pattern: .svg$
     process: |
@@ -189,15 +204,18 @@ templates:
       url = "#{config.public_url}/#{file}"
     template: |
       <img src='<%= url %>' />
-  - pattern: .csv$
+  - pattern: .download.csv$
     process: |
-      table = CSV.read(src)
       # TODO build dst with key, otherwise may lead to undesired results
       dst = File.join(public_path, file)
       FileUtils.cp(src, dst)
       url = "#{config.public_url}/#{file}"
     template: |
       <a href='<%= url %>'><%= file %></a>
+  - pattern: .table.csv$
+    process: |
+      table = CSV.read(src)
+    template: |
       <table>
         <% table.each do |row| %>
           <tr>
@@ -207,12 +225,23 @@ templates:
           </tr>
         <% end %>
       </table>
+  - pattern: .lazy.csv$
+    process: |
+      table = CSV.read(src)
+    template: |
+      <pre class="lazycsv"><%= table %></pre>
   - pattern: .Rout$
     process: |
       rout = File.read(src)
     template: |
       <pre><%= rout %></pre>
-node_regex:  <script\s+type=['"]text/r['"]\s*>(.*?)</script>
+node_regex: <script\s+type=['"]text/r['"]\s*>(.*?)</script>
+node_stanza:
+  prefix: <script type='text/r'>
+  suffix: </script>
+html:
+  prefix: <div class='rack_r_out'>
+  suffix: </div>
 #
 # uncomment the following two lines, if your project
 # doesn't use jquery already

data/lib/rack_r/template_handler.rb

@@ -0,0 +1,19 @@
+module RackR
+  class TemplateHandler
+    def call(template)
+      [ "'<script type=\\'text/r\\'>",
+        escape_text(template.source),
+        "</script>'.html_safe" ].join
+    end
+
+    private
+
+    # stolen from erubis
+    def escape_text(text)
+      text.gsub(/['\\]/, '\\\\\&')   # "'" => "\\'",  '\\' => '\\\\'
+    end
+
+  end
+end
+
+ActionView::Template.register_template_handler :rackr, RackR::TemplateHandler.new

data/lib/rack_r/version.rb

@@ -1,3 +1,3 @@
 module RackR
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/rack_r.rb

@@ -1,2 +1,4 @@
-require "rack_r/railtie" if defined? Rails
-
+if defined? Rails
+  require "rack_r/railtie"
+  require 'rack_r/template_handler'
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rack-r
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
+  prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Phil Hofmann
@@ -15,7 +14,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-23 00:00:00 Z
+date: 2013-05-20 00:00:00 +02:00
+default_executable: 
 dependencies: []
 
 description: Use R in your Rack stack
@@ -33,16 +33,19 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- RECEIPES.md
 - Rakefile
 - TODO
 - lib/rack_r.rb
 - lib/rack_r/middleware.rb
 - lib/rack_r/railtie.rb
+- lib/rack_r/template_handler.rb
 - lib/rack_r/version.rb
 - rack-r.gemspec
 - test/example.r
 - test/helper.rb
 - test/test_rack_r.rb
+has_rdoc: true
 homepage: http://branch14.org/rack-r
 licenses: []
 
@@ -53,27 +56,23 @@ require_paths:
 - lib
 - rails
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Use R in your Rack stack