milk-it-databrowser 1.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Carlos Henrique Palhares Moreira
+
+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.rdoc

@@ -0,0 +1,22 @@
+= DataBrowser
+
+To start using Rails DataBrowser, put `map.databrowser` in the your routes.rb file.
+Please, don't forget to require 'data_browser' att he begining of your routes.rb
+
+== Example
+
+  require 'data_browser'
+  ActionController::Routing::Routes.draw do |map|
+    # your routes
+    map.databrowser
+  end
+
+or use:
+
+  map.databrowser if RAILS_ENV.eql?("development")
+
+for development mode only.
+
+See http://trac.milk-it.net/open/wiki/DataBrowser for further information.
+
+Copyright (c) 2008 Milk-it Software House, released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the databrowser plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the databrowser plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Databrowser'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/install.rb

@@ -0,0 +1,3 @@
+STDOUT.puts "*********************************************************************"
+STDOUT.puts "* put `map.databrowser` in the your routes.rb file to make it works *"
+STDOUT.puts "*********************************************************************"

data/lib/data_browser.rb

@@ -0,0 +1,6 @@
+require 'data_browser/data_browser'
+require 'data_browser/data_browser_controller'
+require 'data_browser/routing'
+
+::ActionController::Routing::RouteSet::Mapper.send(:include, DataBrowser::Routing)
+DataBrowser::DataBrowserController.prepend_view_path(File.join(File.dirname(File.expand_path(__FILE__)), "data_browser", "views"))

data/lib/data_browser/data_browser.rb

@@ -0,0 +1,49 @@
+# DataBrowser
+require 'digest/sha1'
+
+module DataBrowser
+  @@user_digest = nil
+  @@models = []
+  @@tables = []
+
+  class << self
+    def should_auth
+      @@user_digest
+    end
+
+    def digest(user, pass)
+      Digest::SHA1.hexdigest(user.to_s + pass.to_s)
+    end
+  
+    def protect(user, pass)
+      @@user_digest = digest(user, pass)
+    end
+
+    def auth(user, pass)
+      return @@user_digest if digest(user, pass) == @@user_digest
+      false
+    end
+
+    def check_digest(digest)
+      @@user_digest == digest
+    end
+
+    # models configuration
+
+    def models
+      @@models
+    end
+
+    def models=(models)
+      @@models = models if models.is_a?(Array)
+    end
+
+    def tables
+      @@tables
+    end
+
+    def tables=(tables)
+      @@tables = tables if tables.is_a?(Array)
+    end
+  end
+end

data/lib/data_browser/data_browser_controller.rb

@@ -0,0 +1,79 @@
+module DataBrowser
+  class DataBrowserController < ::ActionController::Base
+    layout "data_browser"
+    protect_from_forgery :secret => Time.now.to_i.to_s
+    before_filter :load_models, :authenticate
+
+    include DataBrowser::Helpers
+
+    # all the work here is being done by :load_models
+    def index; end
+    def new; end
+    def edit; end
+
+    def browse
+      params[:select] ||= current_model.column_names
+      @objects = current_model.find(:all,
+        :conditions => params[:conditions],
+        :select => params[:select] ? params[:select].join(", ") : nil
+      )
+
+      respond_to do |format|
+        format.html
+        format.js
+      end
+    end
+
+    def empty
+      current_model.delete_all
+      flash[:notice] = "#{current_model.table_name} model was emptied"
+      redirect_to data_browser_home_url()
+    end
+
+    def destroy
+      current_object.delete_all(current_object.attributes)
+      flash[:notice] = "#{current_model.table_name} #{@obj.to_param} successfuly deleted!"
+      redirect_to data_browser_model_url(:model => current_model_id)
+    end
+
+    def update
+      current_model.update_all(data_from_params, current_object.attributes)
+      flash[:notice] = "#{current_model.table_name} #{@obj.to_param} successfuly saved!"
+      redirect_to data_browser_model_url(:model => current_model_id)
+    end
+
+    def create
+      current_model.create(data_from_params)
+      flash[:notice] = "#{current_model.table_name} #{current_object.to_param || "record"} successfuly saved!"
+      redirect_to data_browser_model_url(:model => current_model_id)
+    end
+
+    protected
+
+    def load_models
+      if DataBrowser.models.size == 0
+        (DataBrowser.tables.empty?? ActiveRecord::Base.connection.tables : DataBrowser.tables).each do |table|
+          model_name = "DataBrowser::#{table.classify}"
+          eval("#{model_name} = Class.new(ActiveRecord::Base); DataBrowser.models.push(#{model_name})")
+        end
+      end
+
+      @models = DataBrowser.models
+    end
+
+    def authenticate
+      if DataBrowser::should_auth && !DataBrowser::check_digest(session[:databrowser])
+        authenticate_or_request_with_http_basic("DataBrowser") do |user, pass|
+          session[:databrowser] = DataBrowser::auth(user, pass)
+        end
+      end
+    end
+
+    private
+
+    def data_from_params
+      pos = ActionController::RecordIdentifier.singular_class_name(current_model)
+              current_model.new(params[pos]).attributes # Hum... well, you know..
+    end
+  end
+end

data/lib/data_browser/helpers.rb

@@ -0,0 +1,36 @@
+module DataBrowser
+  module Helpers
+    def self.included(base)
+      base.send :helper_method, :current_model, :current_object, :current_model_id, :object_params
+    end
+
+    def current_model
+      @model ||= DataBrowser.models[current_model_id] if current_model_id
+    end
+
+    def current_object
+      @obj ||= if params[:id] && !params[:id].eql?("x")
+        current_model.find(params[:id])
+      elsif params[:object]
+        current_model.first :conditions => params[:object]
+      else
+        current_model.new
+      end
+    end
+
+    def current_model_id
+      params[:model].to_i if params[:model]
+    end
+
+    def object_params(object)
+      params = {:model => current_model_id}
+      if object.to_param
+        params[:id] = object.to_param
+      else
+        params[:id] = "x"
+        params[:object] = object.attributes
+      end
+      params
+    end
+  end
+end

data/lib/data_browser/routing.rb

@@ -0,0 +1,26 @@
+module DataBrowser
+  module Routing
+    def databrowser(root="databrowser")
+      with_options :controller => "data_browser/data_browser" do |db|
+        # Databrowser pages
+        db.data_browser_home    "/#{root}",       :action => "index"
+        db.data_browser_about   "/#{root}/about", :action => "about"
+        # Model manipulation
+        db.with_options :model => /\d+/ do |model|
+          model.data_browser_model  "/#{root}/:model",     :action => "browse", :conditions => {:method => :get}
+          model.data_browser_new    "/#{root}/:model/new", :action => "new",    :conditions => {:method => :get}
+
+          model.connect "/#{root}/:model", :action => "empty",  :conditions => {:method => :delete}
+          model.connect "/#{root}/:model", :action => "create", :conditions => {:method => :post}
+
+          # Object manipulation
+          model.data_browser_object "/#{root}/:model/:id/",     :action => "show", :conditions => {:method => :get}
+          model.data_browser_edit   "/#{root}/:model/:id/edit", :action => "edit", :conditions => {:method => :get}
+
+          model.connect "/#{root}/:model/:id", :action => "update",  :conditions => {:method => :put}
+          model.connect "/#{root}/:model/:id", :action => "destroy", :conditions => {:method => :delete}
+        end
+      end
+    end
+  end
+end

data/lib/data_browser/views/data_browser/data_browser/_form.html.erb

@@ -0,0 +1,25 @@
+<ul>
+  <%
+    current_model.columns_hash.each do |name, column|
+      next if name.eql?("id")
+  %>
+  <li>
+    <label><%= column.human_name %></label>
+    <div>
+        <%= case column.type
+            when :date
+            form.date_select(name)
+            when :datetime
+            form.datetime_select(name)
+            when :text
+            form.text_area(name)
+            when :boolean
+            form.check_box(name)
+            else
+            form.text_field(name)
+            end
+        %>
+    </div>
+  </li>
+  <% end %>
+</ul>

data/lib/data_browser/views/data_browser/data_browser/_obj.rhtml

@@ -0,0 +1,7 @@
+    <tr class="<%= cycle("odd", "") %>">
+      <td><%= link_to("Edit", data_browser_edit_path(object_params(obj))) %></td>
+      <td><%= link_to("Delete", data_browser_object_path(object_params(obj)), :method => :delete, :confirm => "Are you sure?") %></td>
+      <% for column in params[:select] %>
+      <td><%= obj.attributes[column] %></td>
+      <% end %>
+    </tr>

data/lib/data_browser/views/data_browser/data_browser/about.html.erb

@@ -0,0 +1,7 @@
+<h2>About Rails DataBrowser</h2>
+
+<p>Rails DataBrowser is a data browser based on the idea of <a href="http://www.djangoproject.com/documentation/databrowse/">Django's Databrowser</a>.</p>
+<p>Using Rails DataBrowser you can browse, view, edit, crate and delete data through your model classes. It's not a replacement to your DBMS or to your CMS, it's just a helper for developers and WebMasters to manage data without.</p>
+<p>If you find a bug, please report it <a href="http://redmine.milk-it.net/projects/databrowser/issues/new">here</a></p>
+<p />
+<p>Rails DataBrowser plugin is sponsored by <a href="http://milk-it.net">Milk-it Software House</a> and maintained by <%= mail_to "carlos@milk-it.net", "Carlos Júnior", :encode => "hex", :replace_at => " at ", :replace_dot => "dot" %>.</p>

data/lib/data_browser/views/data_browser/data_browser/browse.html.erb

@@ -0,0 +1,31 @@
+<% form_tag(data_browser_model_path(:model => current_model_id), {:id => "search_form"}) do %>
+<div id="search-box" style="display:none">
+<p>
+    <label>Select</label><br />
+    <% for column in current_model.column_names %>
+    <label><%= check_box_tag("select[]", column, params[:select].include?(column)) %><%= column %></label>
+    <% end %>
+</p>
+<p>
+    <label for="conditions">Conditions:</label><br />
+    <%= text_area_tag("conditions", params[:conditions], :style => "width:100%", :rows => "4") %>
+</p>
+<input type="submit" value="Buscar" />
+<% end %>
+</div>
+<a href="javascript:showSearchBox()" id="show-search">Search</a>
+<br />
+<table id="data-table">
+  <thead>
+  <th colspan="2"></th>
+  <% for column in params[:select] %>
+    <th><%= column %></th>
+  <% end %>
+  </thead>
+  <tbody sid="objects_body">
+    <%= render :partial => "obj", :collection => @objects %>
+    <% if @objects.size == 0 %>
+    <td class="empty" colspan="<%=params[:select].size + 2%>">Empty model</td>
+    <% end %>
+  </tbody>
+</table>

data/lib/data_browser/views/data_browser/data_browser/browse.js.rjs

@@ -0,0 +1 @@
+page[:objects_body].innerHTML = render(:partial => "obj", :collection => @objects)

data/lib/data_browser/views/data_browser/data_browser/edit.html.erb

@@ -0,0 +1,6 @@
+<% form_for(current_object, :url => data_browser_object_path(object_params(current_object)), :method => :put) do |f| %>
+  <%= render :partial => "form", :object => f %>
+  <div class="button">
+      <%= submit_tag("Save") %> or <%= link_to("cancel", :action => "browse", :model => @model.to_s) %>
+  </div>
+<% end %>

data/lib/data_browser/views/data_browser/data_browser/index.html.erb

@@ -0,0 +1,8 @@
+<ul>
+  <% @models.each_with_index do |model, i| %>
+  <li>
+    <%= link_to(model.table_name, data_browser_model_path(:model => i)) %> (<%= model.count %> records)
+    <%= link_to("empty", data_browser_model_path(:model => i), :confirm => "Are you sure?", :method => :delete) %>
+  </li>
+  <% end %>
+</ul>

data/lib/data_browser/views/data_browser/data_browser/new.html.erb

@@ -0,0 +1,6 @@
+<% form_for(current_object, :url => data_browser_model_path(:model => current_model_id), :method => :post) do |f| %>
+  <%= render :partial => "form", :object => f %>
+  <div class="button">
+      <%= submit_tag("Create") %> or <%= link_to("cancel", :action => "browse", :model => @model.to_s) %>
+  </div>
+<% end %>

data/lib/data_browser/views/layouts/data_browser.html.erb

@@ -0,0 +1,237 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>Rails DataBrowser</title>
+<style type="text/css">
+/* -------------------------------------------------------------- 
+  
+   reset.css
+   * Resets default browser CSS.
+   
+   Based on work by Eric Meyer:
+   * meyerweb.com/eric/thoughts/2007/05/01/reset-reloaded/
+   
+   - Part of Blueprint CSS Framework
+   
+-------------------------------------------------------------- */
+
+html, body, div, span, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, code,
+del, dfn, em, img, q, dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td {
+	margin: 0;
+	padding: 0;
+	border: 0;
+	font-weight: inherit;
+	font-style: inherit;
+	font-size: 100%;
+	font-family: inherit;
+	vertical-align: baseline;
+}
+
+
+body { line-height: 1.5; background: #fff; margin:1.5em 0; }
+
+/* Tables still need 'cellspacing="0"' in the markup. */
+table { border-collapse: separate; border-spacing: 0; }
+caption, th, td { text-align: left; font-weight:400; }
+
+/* Remove possible quote marks (") from <q>, <blockquote>. */
+blockquote:before, blockquote:after, q:before, q:after { content: ""; }
+blockquote, q { quotes: "" ""; }
+
+a img { border: none; }
+
+/* ====== Databrowser ====== */
+
+body {font-family:Arial, Helvetica, sans-serif; font-size:80%; padding:1%; margin:0; border-top:2px solid #e6646c; }
+
+a:link, a:visited { color:#09C; text-decoration:underline; }
+a:hover { text-decoration: none; color: #007EA8; }
+a:active { color:orange; }
+
+h1 {
+font-family:Georgia, "Times New Roman", Times, serif;
+color:#B6343C;
+font-size:150%;
+text-align:right;
+}
+
+h1 a b { color:#E6646C; }
+
+h1 a {color:#B6343C !important; text-decoration:none !important;}
+h1 a:hover { color: #8B272D }
+
+h2 {
+font-family:Georgia, "Times New Roman", Times, serif;
+font-size:140%;
+color:#444;
+}
+
+h3 {
+font-size:100%;
+color:#666;
+}
+
+table {
+width:100%;
+margin:1% auto;
+font-size:90%;
+border-collapse:collapse;
+}
+
+table th, table td {
+padding:1px 0 1px 3px;
+}
+
+table th {
+background-color:#EEF8FB;
+color:#B6343C;
+border:1px solid #DEF1F8;
+border-width:1px 0 1px 1px;
+font-weight:bold;
+padding:1px 4px 1px 4px;
+}
+
+table td {
+border-bottom:1px dotted #E5E5E5;
+}
+
+table td.empty {text-align:center}
+
+table tr.odd td {
+background-color:#F9F9FF;
+}
+
+div#content ul {
+list-style:circle inside;
+font-size:80%;
+color:#999;
+}
+
+div#content {
+padding-left:13%;
+}
+
+div#content ul a {
+font-size:125%;
+}
+
+ul#models {
+float:left;
+border:1px solid #ddd;
+-moz-border-radius:6px;
+padding:1%;
+margin-right:15px;
+list-style:circle inside;
+line-height: 1.6;
+background:#fff;
+width:10%;
+}
+
+li {
+
+}
+
+/* Forms */
+
+input, textarea, select {
+color:#333;
+border:1px solid #BBB;
+}
+
+select { padding:0 0 0 1px;}
+
+form ul {
+list-style:none;
+margin:6px 0 10px 0;
+clear:none;
+float:left;
+list-style:none !important;
+text-align:left;
+}
+
+form li {
+clear:both;
+float:left;
+padding: 5px 0 5px 0;
+width:100%;
+background:none;
+line-height:normal;
+margin:0;
+}
+
+form li div li {float:none;border:none;}
+form li div ul {float:none;margin:none;border:0;}
+form label {
+float:left;
+display:block;
+width:190px;
+}
+
+form label.inline {
+display:inline !important;
+float:none !important;
+margin-top:-2px;
+width:auto;
+}
+
+form li div {
+margin-left:10px;
+float:left;
+}
+
+form li div div { margin-left:0 !important; float:none !important; }
+
+div.button {margin-top:6px; padding-left:200px;clear:both}
+div.button input { color:#069; font-weight:bold; background: #F9F0C4; border:2px solid #F6E69F; padding-left:10px; padding-right:10px; }
+div.button input.imagem { background:none !important; border:0 !important;}
+
+div#footer {border-top:1px solid;
+clear:both;
+color:#BBBBBB;
+font-size:10px;
+height:31px;
+padding:0.25em 0pt;}
+div#footer p.left {float:left;}
+div#footer p.right {float:right;text-align:right;}
+p {margin:4px 0 0 0}
+</style>
+<script>
+function showSearchBox()
+{
+document.getElementById("search-box").style.display = "block";
+document.getElementById("show-search").style.display = "none";
+}
+</script>
+</head>
+<body id="home">
+    <h1><%= link_to("<b>Rails</b>DataBrowser", data_browser_home_path()) %></h1>
+    <ul id="models">
+	<% @models.each_with_index do |model, i| %>
+        <li><%= link_to(model.table_name, data_browser_model_path(:model => i)) %></li>
+	<% end %>
+    </ul>
+    <div id="content">
+        <% if current_model %>
+        <h2><%= current_model.table_name %> <%= link_to("new", data_browser_new_path(:model => current_model_id)) %></h2>
+        <% end %>
+        <%= content_tag(:h3, flash[:notice], :class => "notice") if flash[:notice] %>
+        <%= yield %>
+    </div>
+    <div style="clear:both">&nbsp;</div>
+    <div id="footer">
+        <p class="left">
+        Powered by <%= link_to("DataBrowser", data_browser_about_path()) %><br />
+        by <a href="http://milk-it.net">Milk-it</a>
+        </p>
+        <p class="right">
+            Visit Rails DataBrowser Official WebSite.<br />
+            <a href="http://redmine.milk-it.net/projects/show/databrowser">redmine.milk-it.net/projects</a>
+        </p>
+    </div>
+</body>
+</html>

data/test/databrowser_test.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+class DatabrowserTest < Test::Unit::TestCase
+  def test_databrowser
+    assert true
+  end
+end

data/uninstall.rb

@@ -0,0 +1,3 @@
+STDOUT.puts "******************************************************************"
+STDOUT.puts "* Don't forget to remove DataBrowser routes from your routes.rb! *"
+STDOUT.puts "******************************************************************"

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: milk-it-databrowser
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Carlos Junior
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-06 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+description: Rails DataBrowser helps you in development providing an easy to use interface to access your database. This can be also used in production mode, as an interface to your data.
+email: 
+- carlos@milk-it.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE
+files: 
+- README
+- Rakefile
+- MIT-LICENSE
+- install.rb
+- uninstall.rb
+- lib/data_browser.rb
+- lib/data_browser/data_browser.rb
+- lib/data_browser/data_browser_controller.rb
+- lib/data_browser/routing.rb
+- lib/data_browser/helpers.rb
+- lib/data_browser/views/data_browser/data_browser/about.html.erb
+- lib/data_browser/views/data_browser/data_browser/browse.html.erb
+- lib/data_browser/views/data_browser/data_browser/browse.js.rjs
+- lib/data_browser/views/data_browser/data_browser/edit.html.erb
+- lib/data_browser/views/data_browser/data_browser/_form.html.erb
+- lib/data_browser/views/data_browser/data_browser/index.html.erb
+- lib/data_browser/views/data_browser/data_browser/new.html.erb
+- lib/data_browser/views/data_browser/data_browser/_obj.rhtml
+- lib/data_browser/views/layouts/data_browser.html.erb
+- README.rdoc
+has_rdoc: false
+homepage: http://redmine.milk-it.net/projects
+post_install_message: |
+  
+  Access http://redmine.milk-it.net/projects to learn how to use DataBrowser.
+  It's simple as add 2 lines in your routes.rb!
+
+rdoc_options: []
+
+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: databrowser
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Rails DataBrowser helps you in development providing an easy to use interface to access your database. This can be also used in production mode, as an interface to your data.
+test_files: 
+- test/databrowser_test.rb