mongo_browser 0.1.0

data/lib/mongo_browser/middleware/sprockets_sinatra.rb

@@ -0,0 +1,24 @@
+module MongoBrowser
+  module Middleware
+    class SprocketsSinatra
+      def initialize(app, options = {})
+        @app = app
+        @root = options[:root]
+        path =  options[:path] || "assets"
+        @matcher = /^\/#{path}\/*/
+        @environment = ::Sprockets::Environment.new(@root)
+        @environment.append_path "assets/javascripts"
+        @environment.append_path "assets/javascripts/vendor"
+        @environment.append_path "assets/stylesheets"
+        @environment.append_path "assets/stylesheets/vendor"
+        @environment.append_path "assets/images"
+      end
+
+      def call(env)
+        return @app.call(env) unless @matcher =~ env["PATH_INFO"]
+        env["PATH_INFO"].sub!(@matcher, "")
+        @environment.call(env)
+      end
+    end
+  end
+end

data/lib/mongo_browser/version.rb

@@ -0,0 +1,3 @@
+module MongoBrowser
+  VERSION = "0.1.0"
+end

data/mongo_browser.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/mongo_browser/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Lukasz Bandzarewicz"]
+  gem.email         = ["lucassus@gmail.com"]
+  gem.description   = %q{Simple but powerful tool for managing mongodb databases}
+  gem.summary       = %q{Web-based application for managing mongodb databases}
+  gem.homepage      = "https://github.com/lucassus/mongo_browser"
+
+  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.name          = "mongo_browser"
+  gem.require_paths = ["lib"]
+  gem.version       = MongoBrowser::VERSION
+
+  gem.add_development_dependency("rdoc")
+  gem.add_development_dependency("aruba")
+  gem.add_development_dependency("rake", "~> 0.9.2")
+
+  gem.add_dependency("mongo", "~> 1.7.0")
+  gem.add_dependency("bson_ext", "~> 1.7.0")
+  gem.add_dependency("methadone", "~> 1.2.2")
+  gem.add_dependency("foreverb", "~> 0.3.2")
+  gem.add_dependency("sinatra", "~> 1.3.3")
+  gem.add_dependency("sinatra-contrib", "~> 1.3.2")
+  gem.add_dependency("sinatra-flash", "~> 0.3.0")
+  gem.add_dependency("will_paginate-bootstrap", "~> 0.2.1")
+  gem.add_dependency("json", "~> 1.7.5")
+  gem.add_dependency("awesome_print", "~> 1.1.0")
+end

data/spec/features/collections_list_spec.rb

@@ -0,0 +1,105 @@
+require "spec_helper"
+
+describe "Collections list", type: :request do
+  before do
+    visit "/"
+
+    within("table.databases") { click_link "first_database" }
+  end
+
+  it "displays the breadcrumb" do
+    within ".breadcrumb" do
+      within "li:nth-child(1)" do
+        expect(page).to have_link("Databases")
+      end
+
+      within "li:nth-child(2)" do
+        expect(page).to have_content("db: first_database")
+      end
+    end
+  end
+
+  it "displays all available collections for the selected database" do
+    within "table" do
+      expect(page).to have_link("first_collection")
+      expect(page).to have_link("second_collection")
+      expect(page).to have_link("third_collection")
+    end
+  end
+
+  it "displays information about the database", js: true do
+    click_link "Stats"
+
+    within "table" do
+      %w(db collection objects avgObjSize dataSize storageSize numExtents indexes indexSize nsSizeMB ok).each do |field|
+        expect(page).to have_content(field)
+      end
+    end
+  end
+
+  describe "filtering", js: true do
+    it "filters collections by name" do
+      fill_in_filter("second")
+
+      within "table.collections" do
+        expect(page).to have_link("second_collection")
+        expect(page).to_not have_link("first_collection")
+        expect(page).to_not have_link("third_collection")
+      end
+    end
+
+    it "displays a notification when nothing has been found" do
+      fill_in_filter("fifth")
+
+      expect(page).to_not have_css("table.collections")
+      expect(page).to have_content("Nothing has been found.")
+    end
+  end
+
+  describe "click on delete collection button", js: true do
+    it "deletes a collection" do
+      click_delete_button_for("second_collection")
+      confirm_dialog
+
+      expect(page).to have_flash_message("Collection second_collection has been deleted.")
+
+      within "table.collections" do
+        expect(page).to have_link("first_collection")
+        expect(page).to_not have_link("second_collection")
+        expect(page).to have_link("third_collection")
+      end
+
+      click_delete_button_for("first_collection")
+      confirm_dialog
+      expect(page).to have_flash_message("Collection first_collection has been deleted.")
+
+      within "table.collections" do
+        expect(page).to_not have_link("first_collection")
+        expect(page).to_not have_link("second_collection")
+        expect(page).to have_link("third_collection")
+      end
+
+      click_delete_button_for("third_collection")
+      confirm_dialog
+      expect(page).to have_flash_message("Collection third_collection has been deleted.")
+
+      should_hide_the_table_and_display_a_notification
+    end
+
+    it "displays error message when the collection cannot be deleted" do
+      click_delete_button_for("system.indexes")
+      confirm_dialog
+
+      expect(page).to have_flash_message("Database command 'drop' failed")
+
+      within "table.collections" do
+        expect(page).to have_link("system.indexes")
+      end
+    end
+
+    def click_delete_button_for(collection_name)
+      collection_row = find(:xpath, %Q{//table//tr//*[contains(text(), "#{collection_name}")]/../..})
+      within(collection_row) { click_link "Delete" }
+    end
+  end
+end

data/spec/features/databases_list_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+describe "Databases list", type: :request do
+  before { visit "/" }
+
+  it "hides the breadcrumb" do
+    expect(page).not_to have_css(".breadcrumb")
+  end
+
+  it "displays list with available databases" do
+    expect(page).to have_content("Available databases")
+
+    within "table" do
+      expect(page).to have_link("first_database")
+      expect(page).to have_link("second_database")
+    end
+  end
+
+  describe "filtering", js: true do
+    it "filters databases by name" do
+      fill_in_filter("first")
+
+      within "table.databases" do
+        expect(page).to have_link("first_database")
+        expect(page).to_not have_link("second_database")
+      end
+    end
+
+    it "displays a notification when nothing has been found" do
+      fill_in_filter("third")
+      should_hide_the_table_and_display_a_notification
+    end
+  end
+
+  describe "click on delete database button", js: true do
+    it "deletes a database" do
+      click_delete_button_for("second_database")
+      confirm_dialog
+
+      expect(page).to have_flash_message("Database second_database has been deleted.")
+
+      within "table.databases" do
+        expect(page).to have_link("first_database")
+        expect(page).to_not have_link("second_database")
+      end
+
+      click_delete_button_for("first_database")
+      confirm_dialog
+
+      expect(page).to have_flash_message("Database first_database has been deleted.")
+
+      should_hide_the_table_and_display_a_notification
+    end
+
+    def click_delete_button_for(database_name)
+      database_row = find(:xpath, %Q{//table//tr//*[contains(text(), "#{database_name}")]/../..})
+      within(database_row) { click_link "Delete" }
+    end
+  end
+end

data/spec/features/documents_list_spec.rb

@@ -0,0 +1,136 @@
+require "spec_helper"
+
+describe "Documents list", type: :request do
+  let(:connection) { MongoTestServer.connection }
+
+  before do
+    visit "/"
+
+    within("table.databases") { click_link "first_database" }
+    within("table.collections") { click_link current_collection_name }
+  end
+
+  shared_examples "breadcrumbs for documents list" do
+    it "displays the breadcrumb" do
+      within ".breadcrumb" do
+        within "li:nth-child(1)" do
+          expect(page).to have_link("Databases")
+        end
+
+        within "li:nth-child(2)" do
+          expect(page).to have_link("db: first_database")
+        end
+
+        within "li:nth-child(3)" do
+          expect(page).to have_content("collection: #{current_collection_name}")
+        end
+      end
+    end
+  end
+
+  context "with small number for documents" do
+    let(:current_collection_name) { "first_collection" }
+
+    include_examples "breadcrumbs for documents list"
+
+    it "displays all documents for the selected collection" do
+      expect(page).to have_css("tr.document", count: 2)
+
+      within "table" do
+        expect(page).to have_content("This is a sample record")
+        expect(page).to have_content("This is the second sample record")
+      end
+    end
+
+    it "displays information about the collection", js: true do
+      click_link "Stats"
+
+      within "table" do
+        %w(ns count size avgObjSize storageSize numExtents nindexes lastExtentSize paddingFactor systemFlags userFlags totalIndexSize indexSizes ok).each do |field|
+          expect(page).to have_content(field)
+        end
+      end
+    end
+
+    describe "click on delete document button", js: true do
+      let(:document) do
+        database = connection.db("first_database")
+        collection = database.collection(current_collection_name)
+        collection.find_one(name: "This is the second sample record")
+      end
+
+      it "removes a document from the collection" do
+        click_delete_button_for(document)
+        confirm_dialog
+
+        expect(page).to have_flash_message("Document #{document["_id"]} has been deleted.")
+
+        expect(page).to have_css("tr.document", count: 1)
+
+        within "table" do
+          expect(page).to have_content("This is a sample record")
+          expect(page).not_to have_content(document["name"])
+        end
+      end
+
+      def click_delete_button_for(document)
+        database_row = find(:xpath, %Q{//table//tr/td[1][contains(text(), "#{document["_id"]}")]/..})
+        within(database_row) { click_link "Delete" }
+      end
+    end
+  end
+
+  context "with large number of documents" do
+    let(:current_collection_name) { "second_collection" }
+
+    before do
+      database = connection.db("first_database")
+      collection = database.collection(current_collection_name)
+
+      70.times do |n|
+        collection.insert(name: "Document #{n}", position: n)
+      end
+
+      visit current_path
+    end
+
+    include_examples "breadcrumbs for documents list"
+
+    it "displays a pagination" do
+      expect(page).to have_css("div.pagination", count: 2)
+      within "div.pagination" do
+        (1..3).each do |n|
+          expect(page).to have_link(n.to_s)
+        end
+      end
+    end
+
+    it "paginates documents" do
+      within "table.documents" do
+        (0...25).each do |n|
+          expect(page).to have_content("Document #{n}")
+        end
+      end
+
+      within "div.pagination" do
+        click_link "2"
+      end
+
+      within "table.documents" do
+        (25...50).each do |n|
+          expect(page).to have_content("Document #{n}")
+        end
+      end
+
+      within "div.pagination" do
+        click_link "3"
+      end
+
+      within "table.documents" do
+        (50...70).each do |n|
+          expect(page).to have_content("Document #{n}")
+        end
+      end
+    end
+  end
+end

data/spec/features/server_info_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe "Server info", type: :request do
+  before do
+    visit "/"
+
+    within(".navbar") { click_link "Server Info" }
+  end
+
+  it "displays information about the server" do
+    within "table" do
+      %w(version gitVersion sysInfo versionArray bits debug maxBsonObjectSize ok).each do |field|
+        expect(page).to have_content(field)
+      end
+    end
+  end
+end

data/spec/fixtures/databases.json

@@ -0,0 +1,40 @@
+[
+  {
+    "name": "first_database",
+    "collections": [
+      {
+        "name": "first_collection",
+        "documents": [
+          {
+            "name": "This is a sample record",
+            "position": {
+              "x": 123,
+              "y": "135"
+            }
+          },
+          {
+            "name": "This is the second sample record",
+            "position": {
+              "x": 567,
+              "y": "246"
+            }
+          }
+        ]
+      },
+      {
+        "name": "second_collection"
+      },
+      {
+        "name": "third_collection"
+      }
+    ]
+  },
+  {
+    "name": "second_database",
+    "collections": [
+      {
+        "name": "first_collection"
+      }
+    ]
+  }
+]

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+$:.unshift(File.dirname(__FILE__))
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "simplecov"
+SimpleCov.start do
+  add_group "Application", "lib"
+end
+
+require "mongo_browser"
+
+require "debugger"
+require "rspec"
+require "capybara"
+require "capybara/rspec"
+require "socket"
+
+def find_available_port
+  server = TCPServer.new("127.0.0.1", 0)
+  server.addr[1]
+ensure
+  server.close if server
+end
+
+MongoBrowser.mongodb_host = "localhost"
+MongoBrowser.mongodb_port = find_available_port
+
+require "capybara/webkit"
+Capybara.javascript_driver = :webkit
+
+Capybara.ignore_hidden_elements = true
+Capybara.app = MongoBrowser::Application
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# from spec/support/ and its subdirectories.
+Dir[File.expand_path("spec/support/**/*.rb")].each { |f| require f }
+
+RSpec.configure do |config|
+  config.include Integration
+
+  config.before do
+    MongoTestServer.ensure_test_server_is_running
+    MongoTestServer.load_fixtures
+  end
+
+  config.after do
+    # Take a screenshot when the scenario has failed
+    if example.metadata[:js] and example.exception
+      file_name = example.full_description.downcase.gsub(/\s/, "-")
+      page.driver.render("/tmp/#{file_name}.png", full: true)
+    end
+  end
+end
+
+at_exit do
+  MongoTestServer.clean_up
+end