mongoid_document_editor 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 920e9e158e080607e1c9b4f715924505068850f8
-  data.tar.gz: 75281429ff2f04be8ca4f1254246d03afae6eadb
+  metadata.gz: 1a560b84e3fe4da5adc33097334815fc355440e8
+  data.tar.gz: 5701273de9024ce00b415615a6635060b94322ad
 SHA512:
-  metadata.gz: ca5938f12f2c21c5bd61f437d3962169504d3ca92414db3446987aa16763e1715c95995b8b5f6b66cadfdd41d7a6bed56fb4aec6e14e6c73d19cb2cc4e6c61e7
-  data.tar.gz: 77410914726e7158ae2beea4a21e1f30988f1017a6f250aea803d2599d241f0c43adc0c4e95a94d1545c1d2e981e207214aecbe988211500ab59bd40378a52fb
+  metadata.gz: 2e8d01079e509c85715309554cb80d31f09fe5af7b3e3ed198d0b584f084bbad1afa4c18dae1c194caf0db5eaad4070dcd03473e2efc84b98d55a7eb4c5bfa49
+  data.tar.gz: 1ed9e7db517aec84842567ceeb27150c76d0f72667f396e683e4a063ec4a1b81504365d222b7594ad11b65a45eec41e641ae334ad36f4b3743c7b665435b0fe0

data/README.md

@@ -1,29 +1,52 @@
-# MongoidDocumentEditor
+# Mongoid Document Editor
 
-Mongoid
+Mongoid Document Editor is Rails Engine that provides a DSL for setting up simple admin interfaces to edit MongoDB documents.  No configuration is required in order to get a basic form, however you can override any form you want to provide a more custom and usable interface.
 
-## Installation
+### Configuration
+Create an initializer and configure your admin interface.  
 
-Add this line to your application's Gemfile:
+```ruby
+Mongoid::DocumentEditor.configure do
 
-    gem 'mongoid_document_editor'
+  authenticate_with :admin_required
+  
+  mount_at "/admin/documents"
 
-And then execute:
+  form_configuration_for User do
+  	field :first_name
+    field :last_name
+    field :favorite_color, values: User::COLORS
+    field :email, type: :email
+    field :home_city_id, values: -> { City.all }, label: :name, value: :id
+    field :visitied_city_ids: values: ->(user) { user.visited_cities }, label: :name, value: :id
+  end
 
-    $ bundle
+  index_configuration_for User do
+    column :first_name
+    column :last_Name
+    column :email
+    column :city, value: ->(user) { user.city.name }
+  end
 
-Or install it yourself as:
+end
+```
 
-    $ gem install mongoid_document_editor
+### Usage
+In your application visit: **/documents**
 
-## Usage
+### Options
+`authenticate_with`: Provide a controller filter for granting / denying access  
+`form_configuration_for Class`: Allows you to specify the fields that you want on the form for the specified class  
+`index_configuration_for Class`: Allows you to specify the columns that are displayed on the index page
+`mount_at`: Endpoint where editor is mounted (default is **/documents**)
 
-TODO: Write usage instructions here
+### Notes
+In development mode set `preload_models: true`
 
-## Contributing
+### TODO
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+* Rails generator
+* Remove simple_form dependency
+
+
+Styled using [Base](http://matthewhartman.github.io/base/docs/index.html)

data/app/controllers/mongoid/document_editor/application_controller.rb

@@ -2,6 +2,9 @@ module Mongoid
   module DocumentEditor
     class ApplicationController < ::ApplicationController
       include DocumentsHelper
+
+      before_filter Mongoid::DocumentEditor.authentication_filter
+
     end
   end
 end

data/app/controllers/mongoid/document_editor/documents_controller.rb

@@ -1,34 +1,50 @@
 module Mongoid
   module DocumentEditor
     class DocumentsController < ApplicationController
-      include DocumentsHelper
 
       layout "mongoid/document_editor/layouts/application"
 
-      before_filter Mongoid::DocumentEditor.authentication_filter
+      before_filter :setup_klass, except: [:all]
+
+      def all
+      end
 
       def index
+        @documents = @klass.all
       end
 
       def edit
-        @klass    = params[:type].classify.constantize
         @document = @klass.find(params[:id])
       end
 
       def update
-        @klass    = params[:type].classify.constantize
         @document = @klass.find(params[:id])
         @document.update_attributes(document_params)
 
-        redirect_to edit_document_path(params[:type], @document.id)
+        redirect_to document_path(params[:type], @document.id)
+      end
+
+      def show
+        @document = @klass.find(params[:id])
       end
 
-private
+      def destroy
+        @document = @klass.find(params[:id])
+        @document.destroy
+
+        redirect_to documents_path(params[:type])
+      end
+
+    private
 
       def document_params
         params.require(params[:type].to_sym).permit!
       end
 
+      def setup_klass
+        @klass = params[:type].classify.constantize
+      end
+
     end
   end
 end

data/app/helpers/mongoid/document_editor/documents_helper.rb

@@ -31,7 +31,19 @@ module Mongoid
         end
       end
 
-private
+      def cell_value(document, header, config)
+        if config[:value] && config[:value].respond_to?(:call)
+          config[:value].call(document)
+        else
+          document.send(header)
+        end
+      end
+
+      def model_param(model)
+        model.to_s.underscore.downcase
+      end
+
+    private
 
       def private_field?(name)
         return true if name.start_with?("_")

data/app/views/mongoid/document_editor/documents/all.html.erb

@@ -0,0 +1,3 @@
+<% Mongoid.models.each do |model| %>
+  <p><%= link_to model_param(model), documents_path(model_param(model)) %></p>
+<% end %>

data/app/views/mongoid/document_editor/documents/edit.html.erb

@@ -1,6 +1,16 @@
-<%= simple_form_for @document, url: update_document_path(@klass.to_s.downcase, @document) do |f| %>
-  <% Mongoid::DocumentEditor.fields_for(@klass).each_pair do |name, config| %>
-    <p><%= document_edit_field(f, @klass, @document, name, config) %></p>
-  <% end %>
-  <%= f.submit %>
+<div class="section header">
+  <div class="container clear">
+    <h1 class='logo'>Editing: <%= @document.id %></h1>
+  </div>
+</div>
+
+<%= simple_form_for @document, url: update_document_path(model_param(@klass), @document) do |f| %>
+  <fieldset class='row'>
+    <% Mongoid::DocumentEditor.fields_for(@klass).each_pair do |name, config| %>
+      <p><%= document_edit_field(f, @klass, @document, name, config) %></p>
+    <% end %>
+    <%= link_to "Cancel", document_path(model_param(@klass), @document), class: "button orange-button mobile-full" %>
+    <%= f.submit class: "button orange-button mobile-full" %>
+  </fieldset>
 <% end %>
+

data/app/views/mongoid/document_editor/documents/index.html.erb

@@ -1 +1,30 @@
-<h1>Document Editor</h1>
+<div class="section header">
+  <div class="container clear">
+    <h1 class='logo'><%= @klass.name.pluralize %></h1>
+  </div>
+</div>
+
+<table>
+  <thead>
+      <tr>
+        <% Mongoid::DocumentEditor.index_for(@klass).each_pair do |header, config| %>
+          <th><%= header.to_s.humanize %></th>
+        <% end %>
+          <th>Actions</th>
+      </tr>
+  </thead>
+  <tbody>
+    <% @documents.each do |document| %>
+      <tr>
+        <% Mongoid::DocumentEditor.index_for(@klass).each_pair do |header, config| %>
+          <td><%= cell_value(document, header, config) %></td>
+        <% end %>
+        <td>
+          <%= link_to "View", document_path(model_param(@klass), document) %> |
+          <%= link_to "Edit", edit_document_path(model_param(@klass), document) %> |
+          <%= link_to "Destroy", destroy_document_path(model_param(@klass), document), method: :delete, data: {confirm: "Are you sure you want to destroy this record?"} %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/mongoid/document_editor/documents/show.html.erb

@@ -0,0 +1,25 @@
+<div class="section header">
+  <div class="container clear">
+    <h1 class='logo'>Viewing: <%= @document.id %></h1>
+  </div>
+</div>
+<h3><%= link_to "Edit", edit_document_path(model_param(@klass), @document.id) %></h3>
+
+<% @klass.fields.each do |key, value| %>
+  <p><b><%= key %>:</b> <%= @document.send(key) %></p>
+<% end %>
+
+<hr>
+<h2>Relations:</h2>
+<% @klass.relations.each do |key, value| %>
+  <h3><%= key %></h3>
+  <% if [:has_many, :has_and_belongs_to_many].include?(@document.relations[key].macro) %>
+    <% @document.send(key).each do |relation| %>
+      <p><%= link_to relation.send(:id), document_path(model_param(value.class_name), relation.send(:id)) %></p>
+    <% end %>
+  <% elsif [:has_one, :belongs_to].include?(@document.relations[key].macro) %>
+    <% if relation = @document.send(key) %>
+      <p><%= link_to relation.send(:id), document_path(model_param(value.class_name), relation.send(:id)) %></p>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/mongoid/document_editor/layouts/application.html.erb

@@ -2,8 +2,13 @@
 <html>
   <head>
     <%= csrf_meta_tags %>
+    <%= stylesheet_link_tag "base/style", "base/doc" %>
   </head>
   <body>
-    <%= yield %>
+    <div class="container content-inner">
+      <%= link_to "All Documents", document_listing_path %>
+      <%= yield %>
+    </div>
+    <%= javascript_include_tag "jquery", "jquery_ujs" %>
   </body>
 </html>

data/config/routes.rb

@@ -1,7 +1,10 @@
 Mongoid::DocumentEditor::Engine.routes.draw do
 
+  get "/",               to: "documents#all", as: :document_listing
   get "/:type/:id/edit", to: "documents#edit", as: :edit_document
+  get "/:type/:id",      to: "documents#show", as: :document
   put "/:type/:id/edit", to: "documents#update", as: :update_document
-  root                   to: "documents#index"
+  get "/:type",          to: "documents#index", as: :documents
+  delete "/:type/:id",   to: "documents#destroy", as: :destroy_document
 
 end

data/lib/mongoid/document_editor/engine.rb

@@ -3,9 +3,13 @@ module Mongoid
     class Engine < ::Rails::Engine
       isolate_namespace Mongoid::DocumentEditor
 
+      initializer "mongoid-document-editor.assets.precompile" do |app|
+        app.config.assets.precompile += ["base/style.css", "base/doc.css", "jquery.js", "jquery_ujs.js"]
+      end
+
       config.after_initialize do |app|
         app.routes.prepend do
-          mount Mongoid::DocumentEditor::Engine => "/documents"
+          mount Mongoid::DocumentEditor::Engine => Mongoid::DocumentEditor.endpoint
         end
       end
 

data/lib/mongoid/document_editor/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module DocumentEditor
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/mongoid/document_editor.rb

@@ -17,6 +17,9 @@ module Mongoid
     mattr_accessor :authentication_filter
     @@authentication_filter = nil
 
+    mattr_accessor :endpoint
+    @@endpoint = "/documents"
+
     def self.configure(&block)
       instance_eval(&block)
     end
@@ -30,7 +33,12 @@ module Mongoid
     end
 
     def self.index_for(klass)
-      @@index_configuration[klass]
+      default_fields = {}
+      klass.fields.each_pair do |name, options|
+        next if name.start_with?("_")
+        default_fields[name.to_s] = {}
+      end
+      @@index_configuration.fetch(klass, default_fields)
     end
 
     def self.form_configuration_for(document_class, &block)
@@ -49,5 +57,9 @@ module Mongoid
       @@authentication_filter = filter
     end
 
+    def self.mount_at(endpoint)
+      @@endpoint = endpoint
+    end
+
   end
 end

data/mongoid_document_editor.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "simple_form", "~> 2.1.0"
   spec.add_dependency "mongoid", "~> 3.1.0"
   spec.add_dependency "strong_parameters"
+  spec.add_dependency "jquery-rails"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_document_editor
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nick DeSteffen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-13 00:00:00.000000000 Z
+date: 2013-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -111,8 +125,10 @@ files:
 - app/controllers/mongoid/document_editor/application_controller.rb
 - app/controllers/mongoid/document_editor/documents_controller.rb
 - app/helpers/mongoid/document_editor/documents_helper.rb
+- app/views/mongoid/document_editor/documents/all.html.erb
 - app/views/mongoid/document_editor/documents/edit.html.erb
 - app/views/mongoid/document_editor/documents/index.html.erb
+- app/views/mongoid/document_editor/documents/show.html.erb
 - app/views/mongoid/document_editor/layouts/application.html.erb
 - config/routes.rb
 - README.md