RubyGems - sequel-reporter - Versions diffs - 0.0.1 - Mend

sequel-reporter 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (34) hide show

data/.gitignore +17 -0
data/Gemfile +4 -0
data/LICENSE.txt +22 -0
data/README.md +66 -0
data/Rakefile +5 -0
data/bin/sequel-reporter +13 -0
data/data/Gemfile +10 -0
data/data/Rakefile.tt +10 -0
data/data/application.rb.tt +17 -0
data/data/config.ru +3 -0
data/data/lib/.gitkeep +0 -0
data/data/migrate/.gitkeep +0 -0
data/data/public/.gitkeep +0 -0
data/data/public/css/bootstrap.css +6307 -0
data/data/public/css/bootstrap.min.css +873 -0
data/data/public/img/glyphicons-halflings-white.png +0 -0
data/data/public/img/glyphicons-halflings.png +0 -0
data/data/public/js/bootstrap.js +2279 -0
data/data/public/js/bootstrap.min.js +7 -0
data/data/public/js/jquery-1.9.1.js +9597 -0
data/data/views/error.erb +5 -0
data/data/views/layout.erb +60 -0
data/data/views/reports/dashboard.erb +5 -0
data/data/views/table.erb +31 -0
data/lib/sequel-reporter/application.rb +51 -0
data/lib/sequel-reporter/cli.rb +28 -0
data/lib/sequel-reporter/helpers.rb +52 -0
data/lib/sequel-reporter/report.rb +171 -0
data/lib/sequel-reporter/version.rb +5 -0
data/lib/sequel-reporter.rb +11 -0
data/sequel-reporter.gemspec +25 -0
data/test/report_spec.rb +63 -0
data/test/spec_helper.rb +16 -0
metadata +161 -0

data/data/views/error.erb ADDED Viewed

@@ -0,0 +1,5 @@
+<div class="page-header">
+<h1>Woops, something went wrong</h1>
+</div>
+<p><%= @error.to_s %></p>
+<p><%= @error.backtrace.join("<br>") %></p>

data/data/views/layout.erb ADDED Viewed

@@ -0,0 +1,60 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>Sequel::Reporter</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="description" content="">
+    <meta name="author" content="">
+    <link href="/css/bootstrap.css" rel="stylesheet">
+    <style>
+      body {
+        padding-top: 60px; /* 60px to make the container go all the way to the bottom of the topbar */
+      }
+    </style>
+    <!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
+    <!--[if lt IE 9]>
+      <script src="../assets/js/html5shiv.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class="navbar navbar-inverse navbar-fixed-top">
+      <div class="navbar-inner">
+        <div class="container">
+          <button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+          </button>
+          <a class="brand" href="/">Sequel::Reporter</a>
+          <div class="nav-collapse collapse">
+            <ul class="nav">
+              <li class="dropdown">
+                <a href="#" class="dropdown-toggle" data-toggle="dropdown">
+                  Reports
+                  <b class="caret"></b>
+                </a>
+                <ul class="dropdown-menu">
+                  <% @reports.each do |report| %>
+                    <li><a href="/reports/<%= report[0] %>"><%= report[1] %></a></li>
+                  <% end %>
+                </ul>
+              </li>
+            </ul>
+          </div><!--/.nav-collapse -->
+        </div>
+      </div>
+    </div>
+    <div class="container">
+      <%= yield %>
+    </div> <!-- /container -->
+    <script src="/js/jquery-1.9.1.js"></script>
+    <script src="/js/bootstrap.js"></script>
+  </body>
+</html>

data/data/views/reports/dashboard.erb ADDED Viewed

@@ -0,0 +1,5 @@
+<h1>Welcome to Sequel::Reporter</h1>
+<p>
+  Replace this file <pre>dashboard.erb</pre> with your first report.
+</p>

data/data/views/table.erb ADDED Viewed

@@ -0,0 +1,31 @@
+<% if report.error %>
+<div class="alert-message block-message warning">
+  <p><%= report.error %></p>
+  <% if report.error.to_s != "No data" %>
+    <p><%= report.error.backtrace %></p>
+  <% end %>
+</div>
+<% else %>
+<table class="table table-striped table-borderd table-hover table-condensed sorted">
+  <thead>
+    <tr>
+      <% report.fields.each do |f| %>
+      <th><span class="<%= f.span_class %>"><%= f.title %></span></th>
+      <% end %>
+    </tr>
+  </thead>
+  <tbody>
+    <% report.each_row do |row| %>
+    <tr>
+      <% row.each do |val| %>
+      <td>
+        <span class="<%= val[1].span_class %>">
+          <%= linkify(links, row, val, (val[1].value_type == 'number' && ! val[0].nil?) ? sprintf("%0.2f", val[0]) : val[0]) %>
+        </span>
+      </td>
+      <% end %>
+    </tr>
+    <% end %>
+  </tbody>
+</table>
+<% end %>

data/lib/sequel-reporter/application.rb ADDED Viewed

@@ -0,0 +1,51 @@
+require 'sinatra/base'
+require 'sinatra/contrib'
+require 'sequel'
+module Sequel::Reporter
+  class Application < Sinatra::Base
+    helpers Sinatra::Capture
+    helpers Sequel::Reporter::Helpers
+    set :render_engine, :erb
+    set :database_url, ENV['DATABASE_URL']
+    attr_reader :db
+    before do
+      Sequel::Reporter::Report.params = params
+      @reports = []
+      Dir.glob(File.join(settings.root, "views", "reports", "*")).each do |report|
+        name = File.basename(report, File.extname(report))
+        @reports << [name, name.capitalize]
+      end
+      @reports = @reports.sort {|a,b| a[0] <=> b[0]}
+    end
+    get '/' do
+      index_report = settings.index_report
+      redirect "/reports/#{index_report.to_s}"
+    end
+    get '/*' do
+      begin
+        render settings.render_engine, params[:splat][0].to_sym
+      rescue Exception => e
+        @error = e
+        render :erb, :error
+      end
+    end
+    def initialize(app=nil)
+      @db = Sequel.connect(self.class.settings.database_url)
+      path = File.join(settings.root, "lib", "**", "*.rb")
+      Dir.glob(path).each do |file|
+        require file
+      end
+      super(app)
+    end
+  end
+end

data/lib/sequel-reporter/cli.rb ADDED Viewed

@@ -0,0 +1,28 @@
+require 'thor'
+module Sequel::Reporter
+  class CLI < Thor
+    include Thor::Actions
+    desc "new NAME","Create a new Sequel::Reporter project"
+    def new(name)
+      @name = name
+      empty_directory(name)
+      self.destination_root = name
+      copy_file("Gemfile")
+      template("Rakefile.tt", "Rakefile")
+      template("application.rb.tt", "application.rb")
+      template("config.ru")
+      directory("lib")
+      directory("migrate")
+      directory("public")
+      directory("views")
+    end
+    def self.source_root
+      File.expand_path("../../../data", __FILE__)
+    end
+  end
+end

data/lib/sequel-reporter/helpers.rb ADDED Viewed

@@ -0,0 +1,52 @@
+require 'rack/utils'
+require 'cgi'
+module Sequel::Reporter
+  module Helpers
+    include Rack::Utils
+    def partial(template, locals = {})
+      render_engine = locals.delete(:render_engine) || settings.render_engine
+      render render_engine, template, :layout => false, :locals => locals
+    end
+    def table(report, options = {})
+      links = options[:links] || {}
+      partial(:table, :report => report, :links => links, :render_engine => :erb)
+    end
+    def query(options={}, &block)
+      q = capture(&block)
+      report = Sequel::Reporter::Report.from_query(@db, q)
+      if options[:pivot]
+        report = report.pivot(options[:pivot], options[:pivot_sort_order])
+      end
+      report
+    end
+    def linkify(links, row, value, display_value)
+      links.each do |key, val|
+        if key.is_a? String
+          key = /^#{key}$/
+        end
+        if key.match(value[1].title.to_s)
+          url = String.new(links[key])
+          row.each_with_index do |v,i|
+            url.gsub!(":#{i}", CGI.escape(v[0].to_s))
+          end
+          url.gsub!(':title', CGI.escape(value[1].title.to_s))
+          url.gsub!(':now', CGI.escape(DateTime.now.strftime('%Y-%m-%d')))
+          display_value = "<a href='#{url}'>#{escape_html(display_value)}</a>"
+        else
+          display_value = escape_html(display_value)
+        end
+      end
+      display_value
+    end
+  end
+end

data/lib/sequel-reporter/report.rb ADDED Viewed

@@ -0,0 +1,171 @@
+module Sequel::Reporter
+  class Field
+    attr_reader :title, :value_type, :span_class
+    def initialize(title, value_type, span_class)
+      @title = title
+      @value_type = value_type
+      @span_class = span_class
+    end
+    def ==(other)
+      self.title == other.title && \
+      self.value_type == other.value_type && \
+      self.span_class == other.span_class
+    end
+  end
+  class NumberField < Field
+    def initialize(title)
+      super(title, 'number', 'pull-right')
+    end
+  end
+  class StringField < Field
+    def initialize(title)
+      super(title, 'string', 'pull-left')
+    end
+  end
+  class Value
+    def initialize(val)
+      @val = val
+    end
+    def to_s
+      @val
+    end
+  end
+  class NumericValue < Value
+    def to_s
+      sprintf("%0.2f", @val)
+    end
+  end
+  class Report
+    attr_accessor :error, :fields, :rows
+    @@params = {}
+    def self.params=(params)
+      @@params = params
+    end
+    def self.params
+      @@params
+    end
+    def self.from_query(db, query)
+      @@params.each do |key, val|
+        params[key.to_sym] = val
+      end
+      ds = db.fetch(query, params)
+      report = self.new
+      begin
+        row = ds.first
+        if row.nil?
+          raise "No data"
+        end
+        ds.columns.each do |col|
+          value = row[col]
+          if value.is_a? Numeric
+            report.add_field NumberField.new(col.to_s)
+          else
+            report.add_field StringField.new(col.to_s)
+          end
+        end
+        ds.each do |row|
+          vals = []
+          ds.columns.each do |col|
+            vals << row[col]
+          end
+          report.add_row(vals)
+        end
+      rescue Exception => e
+        report.error = e
+      end
+      return report
+    end
+    def initialize
+      @fields = []
+      @rows = []
+    end
+    def add_field(field)
+      @fields << field
+    end
+    def add_row(row)
+      if row.length != @fields.length
+        raise "row length not equal to fields length"
+      end
+      @rows << row
+    end
+    def each_row
+      @rows.each do |row|
+        yield row.zip(@fields)
+      end
+    end
+    def pivot(column, sort_order)
+      new_report = self.class.new
+      bucket_column_index = 0
+      self.fields.each_with_index do |f, i|
+        if f.title == column
+          bucket_column_index = i
+          break
+        else
+          new_report.add_field(f)
+        end
+      end
+      buckets = {}
+      new_rows = {}
+      self.each_row do |row|
+        key = row[0, bucket_column_index].map { |r| r[0] }
+        bucket_name = row[bucket_column_index][0]
+        bucket_value = row[bucket_column_index + 1][0]
+        if not buckets.has_key? bucket_name
+          field = bucket_value.is_a?(Numeric) ? NumberField.new(bucket_name) : StringField.new(bucket_name)
+          buckets[bucket_name] = field
+        end
+        new_rows[key] ||= {}
+        new_rows[key][bucket_name] = bucket_value
+      end
+      bucket_keys = buckets.keys.sort
+      if sort_order && sort_order == 'desc'
+        bucket_keys = bucket_keys.reverse
+      end
+      bucket_keys.each do |bucket|
+        new_report.add_field(buckets[bucket])
+      end
+      new_rows.each do |key, value|
+        row = key
+        bucket_keys.each do |b|
+          row << value[b]
+        end
+        new_report.add_row(row)
+      end
+      return new_report
+    end
+  end
+end

data/lib/sequel-reporter/version.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module Sequel
+  module Reporter
+    VERSION = "0.0.1"
+  end
+end

data/lib/sequel-reporter.rb ADDED Viewed

@@ -0,0 +1,11 @@
+require "sequel-reporter/version"
+require "sequel-reporter/cli"
+require "sequel-reporter/report"
+require "sequel-reporter/helpers"
+require "sequel-reporter/application"
+module Sequel
+  module Reporter
+    # Your code goes here...
+  end
+end

data/sequel-reporter.gemspec ADDED Viewed

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequel-reporter/version'
+Gem::Specification.new do |gem|
+  gem.name          = "sequel-reporter"
+  gem.version       = Sequel::Reporter::VERSION
+  gem.authors       = ["Pete Keen"]
+  gem.email         = ["peter.keen@bugsplat.info"]
+  gem.description   = %q{An opinionated framework for writing reporting applications}
+  gem.summary       = %q{An opinionated framework for writing reporting applications}
+  gem.homepage      = "https://github.com/peterkeen/sequel-reporter"
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency('sqlite3')
+  gem.add_dependency('rspec')
+  gem.add_dependency('sinatra')
+  gem.add_dependency('sinatra-contrib')
+  gem.add_dependency('sequel')
+end

data/test/report_spec.rb ADDED Viewed

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+describe Sequel::Reporter::Report do
+  before :each do
+    @things.insert(:id => 1, :something => "hi", :other => "2013-02-18")
+    @things.insert(:id => 2, :something => "ho", :other => "2013-02-19")
+  end
+  describe "#from_query" do
+    it "should run a query" do
+      report = Sequel::Reporter::Report.from_query(@db, "select count(1) as foo from things")
+      rows = []
+      report.each_row do |row|
+        rows << row
+      end
+      rows[0][0][0].should eq(2)
+      rows[0][0][1].should eq(Sequel::Reporter::NumberField.new('foo'))
+    end
+    it "should use params" do
+      Sequel::Reporter::Report.params = {:blah => "hi"}
+      report = Sequel::Reporter::Report.from_query(@db, "select count(1) as foo from things where something = :blah")
+      rows = []
+      report.each_row do |row|
+        rows << row
+      end
+      rows[0][0][0].should eq(1)
+    end
+  end
+  describe "#pivot" do
+    before :each do
+      @things.insert(:id => 1, :something => "hi", :other => "2013-02-18")
+      @things.insert(:id => 2, :something => "ho", :other => "2013-02-19")
+    end
+    it "should create the correct fields" do
+      report = Sequel::Reporter::Report.from_query(@db, "select other, something, count(1) from things group by other, something")
+      report = report.pivot("something", "asc")
+      report.fields.should eq([
+        Sequel::Reporter::StringField.new('other'),
+        Sequel::Reporter::NumberField.new('hi'),
+        Sequel::Reporter::NumberField.new('ho'),
+      ])
+    end
+    it "should put the values in the right place" do
+      report = Sequel::Reporter::Report.from_query(@db, "select other, something, count(1) from things group by other, something")
+      report = report.pivot("something", "asc")
+      report.rows.should eq([
+        [Date.new(2013,2,18), 2, nil],
+        [Date.new(2013,2,19), nil, 2]
+      ])
+    end
+  end
+end

data/test/spec_helper.rb ADDED Viewed

@@ -0,0 +1,16 @@
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require 'rspec'
+require 'sequel-reporter/application'
+require 'sequel-reporter/report'
+require 'sequel-reporter/helpers'
+require 'sequel'
+require 'sqlite3'
+RSpec.configure do |config|
+  config.before(:each) do
+    @db = Sequel.sqlite
+    @db.run("create table things (id integer, something text, other date)")
+    @things = @db[:things]
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: sequel-reporter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease:
+platform: ruby
+authors:
+- Pete Keen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An opinionated framework for writing reporting applications
+email:
+- peter.keen@bugsplat.info
+executables:
+- sequel-reporter
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/sequel-reporter
+- data/Gemfile
+- data/Rakefile.tt
+- data/application.rb.tt
+- data/config.ru
+- data/lib/.gitkeep
+- data/migrate/.gitkeep
+- data/public/.gitkeep
+- data/public/css/bootstrap.css
+- data/public/css/bootstrap.min.css
+- data/public/img/glyphicons-halflings-white.png
+- data/public/img/glyphicons-halflings.png
+- data/public/js/bootstrap.js
+- data/public/js/bootstrap.min.js
+- data/public/js/jquery-1.9.1.js
+- data/views/error.erb
+- data/views/layout.erb
+- data/views/reports/dashboard.erb
+- data/views/table.erb
+- lib/sequel-reporter.rb
+- lib/sequel-reporter/application.rb
+- lib/sequel-reporter/cli.rb
+- lib/sequel-reporter/helpers.rb
+- lib/sequel-reporter/report.rb
+- lib/sequel-reporter/version.rb
+- sequel-reporter.gemspec
+- test/report_spec.rb
+- test/spec_helper.rb
+homepage: https://github.com/peterkeen/sequel-reporter
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.23
+signing_key:
+specification_version: 3
+summary: An opinionated framework for writing reporting applications
+test_files:
+- test/report_spec.rb
+- test/spec_helper.rb