elefant 0.0.1

data/lib/elefant/stats.rb

@@ -0,0 +1,56 @@
+require "elefant/connection_adapter"
+require "elefant/postgres/stat_queries"
+require "elefant/postgres/size_queries"
+
+module Elefant
+  class Stats
+    include Elefant::Postgres::StatQueries
+    include Elefant::Postgres::SizeQueries
+
+    def initialize
+      @connection = Elefant::ConnectionAdapter.new
+    end
+
+    def db_name
+      @connection.info[:db_name]
+    end
+
+    def version
+      @connection.info[:server_version]
+    end
+
+    def client_version
+      @connection.info[:client_version]
+    end
+
+    def get(name, params)
+      query(name, params)
+    end
+
+    def close!
+      @connection.disconnect
+    end
+
+    def self.check!
+      connection = Elefant::ConnectionAdapter.new
+      raise ArgumentError.new("Could not establish connection") unless connection.alive?
+      connection.disconnect
+    end
+
+    private
+
+    def exec(query, params = [])
+      @connection.execute(query, params)
+    end
+
+    def query(name, params)
+      method = name.to_sym
+
+      if respond_to?(method)
+        send(method, *params)
+      else
+        raise ArgumentError.new("Unknown Stats Query: #{name}")
+      end
+    end
+  end
+end

data/lib/elefant/version.rb

@@ -0,0 +1,3 @@
+module Elefant
+  VERSION = "0.0.1"
+end

data/lib/elefant/web.rb

@@ -0,0 +1,86 @@
+require "sinatra"
+require "sinatra/partial"
+require "i18n"
+require "i18n/backend/fallbacks"
+require "elefant"
+
+module Elefant
+  class Web < Sinatra::Base
+    register Sinatra::Partial
+
+    dir = File.expand_path(File.dirname(__FILE__) + "/../../web")
+
+    set :public_folder, "#{dir}/public"
+    set :views, "#{dir}/views"
+    set :root, "#{dir}/public"
+    set :locales, "#{dir}/locales"
+
+    set :partial_template_engine, :erb
+    set :layout_engine, :erb
+
+    configure do
+      Elefant::Stats.check!
+      I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
+      I18n.load_path = Dir[File.join(settings.locales, '*.yml')]
+      I18n.backend.load_translations
+    end
+
+    before do
+      @stats ||= Elefant::Stats.new
+    end
+
+    after do
+      @stats.close!
+    end
+
+    helpers do
+
+      def stats
+        @stats ||= Elefant::Stats.new
+      end
+
+      def get_stats(name, params = [])
+        stats.get(name, params)
+      end
+
+      def css_for(field)
+        I18n.t(field, scope: "css", default: "")
+      end
+
+      def t(*args, options)
+        options.merge!(locale: :en)
+        I18n.t(*args, options)
+      end
+
+      def link(name, target, params = {})
+        extra = params.any? ? "?" + params.map {|k, v| "#{k}=#{v}" }.join("&") : ""
+        css = target == current_path ? 'active' : ''
+        %Q{<a href="#{root_path}#{target}#{extra}" class="#{css}">#{name}</a>}
+      end
+
+      def root_path
+        %Q{#{env['SCRIPT_NAME']}/}
+      end
+
+      def current_path
+        @current_path ||= request.path_info.gsub(/^\//,'')
+      end
+    end
+
+    get "/" do
+      redirect "#{root_path}summary", 302
+    end
+
+    get "/:name" do
+      name = params[:name]
+      if %w(activity indices size summary tables).include?(name)
+        erb name.to_sym
+      else
+        not_found do
+          "Page not found! Sorry."
+        end
+      end
+    end
+
+  end
+end

data/test/ar_connection_test.rb

@@ -0,0 +1,55 @@
+require "test_helper"
+
+describe "ActiveRecord being loaded" do
+
+  fork do
+    before do
+      @db_url = ENV.delete("DATABASE_URL")
+      config_file = File.expand_path("config.yml", File.dirname(__FILE__))
+
+      require "active_record"
+
+      unless File.exist?(config_file)
+        puts "Please copy test/config.yml to test/config.yml.example and edit accordingly"
+        abort
+      end
+
+      ActiveRecord::Base.establish_connection(YAML::load(File.open(config_file)))
+      ActiveRecord::Base.connection.execute("SELECT 1")
+
+      @old_ar_config_value = Elefant.configuration.disable_ar
+    end
+
+    after do
+      ENV["DATABASE_URL"] = @db_url
+
+      Elefant.configure do |c|
+        c.disable_ar = @old_ar_config_value
+      end
+    end
+
+    it "connects to the test database using AR" do
+      connection = Elefant::ConnectionAdapter.new
+
+      assert connection.alive?, "Connection must be alive"
+      assert connection.active_record?, "Connection must be active record"
+    end
+
+    it "does not use active record when disabled in the configuration" do
+      Elefant.configure do |c|
+        c.disable_ar = true
+      end
+
+      assert_raises ArgumentError do
+        Elefant::ConnectionAdapter.new
+      end
+    end
+  end
+
+  it "runs the ar specs successfully" do
+    Process.wait
+    exit_status = $?.to_i
+
+    assert_equal 0, exit_status
+  end
+end

data/test/config.yml.example

@@ -0,0 +1,4 @@
+adapter: postgresql
+database: elefant_test
+user: postgres
+password:

data/test/fixtures/teardown.sql

@@ -0,0 +1,4 @@
+-- SET client_min_messages TO WARNING;
+
+drop table if exists elefant_test_models;
+drop sequence if exists elefant_id_seq;

data/test/fixtures/test_models.sql

@@ -0,0 +1,11 @@
+CREATE SEQUENCE elefant_id_seq;
+
+CREATE TABLE elefant_test_models (
+    id integer not null default nextval('elefant_id_seq'::regclass) PRIMARY KEY,
+    name character varying(255),
+    number integer,
+    created_at timestamp without time zone,
+    updated_at timestamp without time zone
+);
+
+CREATE INDEX elefant_index ON elefant_test_models USING btree (name);

data/test/pg_connection_test.rb

@@ -0,0 +1,12 @@
+require "test_helper"
+
+describe "when connecting via DATABASE_URL" do
+
+  it "connects to the test database using the pg driver directly" do
+    connection = Elefant::ConnectionAdapter.new
+
+    assert connection.alive?, "Connection must be alive"
+    refute connection.active_record?, "Connection must not be active record"
+  end
+end
+

data/test/stats_test.rb

@@ -0,0 +1,32 @@
+require "test_helper"
+require "elefant/stats"
+
+class StatsTest < PGTest
+
+  def setup
+    super
+    @stats = Elefant::Stats.new
+  end
+
+  def test_retrieves_activity
+    result = @stats.get("activity", [])
+
+    assert_instance_of Array, result
+    refute_empty result
+  end
+
+  def test_retrieves_user_indices
+    result = @stats.get("user_indexes", [])
+
+    assert_instance_of Array, result
+    refute_empty result
+    assert_equal "elefant_test_models", result[0]["rel_name"]
+  end
+
+  def test_raises_for_unknown
+    assert_raises ArgumentError do
+      @stats.get("totallyweirdunknownstatname")
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,37 @@
+$: << File.expand_path("lib")
+$: << File.expand_path("test")
+
+require "bundler"
+Bundler.setup :default, :test
+
+ENV["DATABASE_URL"] ||= "postgres:///elefant_test"
+
+require "elefant"
+require "minitest/autorun"
+
+Elefant.configure do |c|
+  c.disable_ar = false
+end
+
+class PGTest < Minitest::Test
+
+  def setup
+    init_db
+  end
+
+  def teardown
+    reset_db
+  end
+
+  def init_db
+    c = Elefant::ConnectionAdapter.new
+    c.execute(File.read('./test/fixtures/test_models.sql'))
+    c.disconnect
+  end
+
+  def reset_db
+    c = Elefant::ConnectionAdapter.new
+    c.execute(File.read('./test/fixtures/teardown.sql'))
+    c.disconnect
+  end
+end

data/test/webapp_test.rb

@@ -0,0 +1,46 @@
+require "test_helper"
+require "rack/test"
+require "elefant/web"
+
+ENV["RACK_ENV"] = "test"
+
+describe "the elefant web interface" do
+  include Rack::Test::Methods
+
+  def app
+    Elefant::Web
+  end
+
+  it "redirects to the summary on the index page" do
+    get "/"
+
+    assert last_response.redirect?
+    assert last_response.location.match("/summary")
+  end
+
+  it "shows a database summary" do
+    get "/summary"
+    assert last_response.ok?
+  end
+
+  it "shows activity info" do
+    get "/activity"
+    assert last_response.ok?
+  end
+
+  it "shows info about indices" do
+    get "/indices"
+    assert last_response.ok?
+  end
+
+  it "shows table info" do
+    get "/tables"
+    assert last_response.ok?
+  end
+
+  it "shows size info" do
+    get "/size"
+    assert last_response.ok?
+  end
+
+end

data/watchr.rb

@@ -0,0 +1,34 @@
+# Run me with:
+#   $ watchr watchr.rb
+
+# --------------------------------------------------
+# Rules
+# --------------------------------------------------
+watch( '^test.*/*_test.*\.rb'                )  { rake } # or run specific one { |m| ruby m[0] }
+watch( '^lib/(.*)\.rb'                       )  { rake } # { |m| ruby "test/test_#{m[1]}.rb" }
+watch( '^test/test_helper\.rb'               )  { rake }
+watch( '^web/views/(.*)\.(.*)'               )  { rake }
+watch( '^web/public/css/(.*)\.scss'          )  { sass }
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+Signal.trap('QUIT') { rake  } # Ctrl-\
+Signal.trap('INT' ) { abort("\n") } # Ctrl-C
+
+# --------------------------------------------------
+# Helpers
+# --------------------------------------------------
+def rake
+  run "clear"
+  run "bundle exec rake"
+end
+
+def sass
+  run "bundle exec sass --style compressed --scss -I web/public/css/ web/public/css/elefant.scss web/public/css/elefant.css"
+end
+
+def run( cmd )
+  puts   cmd
+  system cmd
+end

data/web/locales/en.yml

@@ -0,0 +1,33 @@
+en:
+  db:
+    db_name: "database"
+    db_time: "time"
+    dbsize:  "total size"
+    num_rels: "total relations"
+    commits: "commits"
+    rollbks: "rollbacks"
+    blksrd:  "blocks read"
+    blkshit: "blocks hit"
+    bkends:  "backends"
+    seqscan: "sequential scans"
+    seqtprd: "sequential tupels read"
+    idxscn:  "index scans"
+    idxtrd:  "index tupel fetches"
+    ins:     "inserts"
+    upd:     "updates"
+    del:     "deletes"
+    locks:   "locks"
+    activeq: "max active queries"
+    kind:
+      i: "index"
+      t: "toast"
+      r: "table"
+      S: "sequence"
+  css:
+    idx_scn:      "numeric"
+    idx_tup_rd:   "numeric"
+    idx_tup_ftch: "numeric"
+    heap_blks_rd: "numeric"
+    heap_blks_ht: "numeric"
+    idx_blks_rd:  "numeric"
+    idx_blks_ht:  "numeric"

data/web/public/css/_fonts.scss

@@ -0,0 +1,36 @@
+/*!
+ * Clear Sans Webfont
+ *
+ * Webfont conversion of the Clear Sans typeface, designed by the
+ * Intel Open Source Technology Center <https://01.org/clear-sans>
+ *
+ * Original font file released under the Apache 2.0 License
+ * <http://www.apache.org/licenses/LICENSE-2.0.html>
+ *
+ * Webfont version by Resi Respati <resir014@gmail.com>
+ * Released under the MIT License.
+ */
+
+@font-face {
+  font-family: 'Clear Sans';
+  font-style: normal;
+  font-weight: 300;
+  src: local('ClearSans-Light'), local('Clear Sans Light'),
+  url('../fonts/ClearSans-Light.eot'),
+  url('../fonts/ClearSans-Light.eot?#iefix') format('embedded-opentype'),
+  url('../fonts/ClearSans-Light.woff') format('woff'),
+  url('../fonts/ClearSans-Light.ttf') format('truetype'),
+  url('../fonts/ClearSans-Light.svg') format('svg');
+}
+
+@font-face {
+  font-family: 'Clear Sans';
+  font-style: normal;
+  font-weight: 700;
+  src: local('ClearSans-Bold'), local('Clear Sans Bold'),
+  url('../fonts/ClearSans-Bold.eot'),
+  url('../fonts/ClearSans-Bold.eot?#iefix') format('embedded-opentype'),
+  url('../fonts/ClearSans-Bold.woff') format('woff'),
+  url('../fonts/ClearSans-Bold.ttf') format('truetype'),
+  url('../fonts/ClearSans-Bold.svg') format('svg');
+}