mongoid_scribe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1589a51bcfcc3ef3e9fb957353e132e0f925450b
+  data.tar.gz: 01b1cbee0553e66b3828e69afcb0682d0ec5e8b6
+SHA512:
+  metadata.gz: 37b5260974b8330a98a8db17206e8ff2f4d049b2d298037b8967fdfa8014b4b0f948c6ae01b50de7c751c32dce6b25f9a9ea91aaa57286f08ac2ef1c883ce95f
+  data.tar.gz: 25da9b12f09eb54592c08303577ae19be422a0d39c9cbfa6d5338be12c26f0904928470ff361595de8d9d3108bbd0a07080ba063ce5e34d191a6084fb3c8679c

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nick DeSteffen
+
+MIT License
+
+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.md

@@ -0,0 +1,53 @@
+# Mongoid Scribe
+
+Mongoid Scribe is a 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.
+
+### Generator
+To generate an initializer:  
+
+`bundle exec rails generate mongoid_scribe:install`
+
+### Configuration
+
+```ruby
+Mongoid::Scribe.configure do
+
+  authenticate_with :admin_required
+  
+  mount_at "/admin/documents"
+  
+  resources exclude: [:user_roles]
+
+  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
+    field :visitied_city_ids: values: ->(user) { user.visited_cities }, label: :name, value: :id
+  end
+
+  index_configuration_for User do
+    column :first_name
+    column :last_Name
+    column :email
+    column :city, value: ->(user) { user.city.name }
+  end
+
+end
+```
+
+### Usage
+In your application visit: **/documents**
+
+### 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**)  
+`resources`: Include or exclude specific models from the editor interface
+
+### Notes
+In development mode set `preload_models: true`
+
+Styled using [Base](http://matthewhartman.github.io/base/docs/index.html)

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

@@ -0,0 +1,10 @@
+module Mongoid
+  module Scribe
+    class ApplicationController < ::ApplicationController
+      include DocumentsHelper
+
+      before_filter Mongoid::Scribe.authentication_filter
+
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module Mongoid
+  module Scribe
+    class DocumentsController < ApplicationController
+
+      layout "mongoid/scribe/layouts/application"
+
+      before_filter :setup_klass, except: [:all]
+
+      def all
+      end
+
+      def index
+        @documents = @klass.all
+      end
+
+      def edit
+        @document = @klass.find(params[:id])
+      end
+
+      def update
+        @document = @klass.find(params[:id])
+        @document.update_attributes(document_params)
+
+        redirect_to document_path(params[:type], @document.id)
+      end
+
+      def show
+        @document = @klass.find(params[:id])
+      end
+
+      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/scribe/documents_helper.rb

@@ -0,0 +1,19 @@
+module Mongoid
+  module Scribe
+    module DocumentsHelper
+
+      def model_param(model)
+        model.to_s.underscore.downcase
+      end
+
+      def relation_label(relation)
+        if relation.respond_to?(:slug)
+          return relation.slug
+        else
+          return relation.id
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+<div class="section header">
+  <div class="container clear">
+    <h1 class='logo'>All Documents</h1>
+  </div>
+</div>
+
+<table>
+  <thead>
+      <tr>
+        <th>Type</th>
+        <th>Count</th>
+      </tr>
+  </thead>
+  <tbody>
+    <% Mongoid::Scribe.models.each do |model| %>
+      <tr>
+        <td><%= link_to model_param(model), documents_path(model_param(model)) %></td>
+        <td><%= model.count %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

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

@@ -0,0 +1,22 @@
+<% content_for :navigation do %>
+    <%= link_to "All Documents", document_listing_path, class: "button orange-button mobile-full" %>
+    <%= link_to @klass.to_s.pluralize, documents_path(model_param(@klass)), class: "button orange-button mobile-full" %>
+    <%= link_to @document.id, document_path(model_param(@klass), @document.id), class: "button orange-button mobile-full" %>
+<% end %>
+
+<div class="section header">
+  <div class="container clear">
+    <h1 class='logo'>Editing: <%= @document.id %></h1>
+  </div>
+</div>
+
+<%= form_for @document, url: update_document_path(model_param(@klass), @document) do |form| %>
+  <fieldset class='row'>
+    <% Mongoid::Scribe.fields_for(@klass).each_pair do |name, config| %>
+      <%= Mongoid::Scribe::Builders::Field.new(form, @klass, @document, name, config).field %>
+    <% end %>
+    <%= link_to("Cancel", document_path(model_param(@klass), @document), class: "button orange-button mobile-full") %>
+    <%= form.submit("Update #{@klass}", class: "button orange-button mobile-full") %>
+  </fieldset>
+<% end %>
+

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

@@ -0,0 +1,34 @@
+<% content_for :navigation do %>
+  <%= link_to "All Documents", document_listing_path, class: "button orange-button mobile-full" %>
+<% end %>
+
+<div class="section header">
+  <div class="container clear">
+    <h1 class='logo'><%= @klass.name.pluralize %></h1>
+  </div>
+</div>
+
+<table>
+  <thead>
+    <tr>
+      <% Mongoid::Scribe.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::Scribe.index_for(@klass).each_pair do |header, config| %>
+          <td><%= Mongoid::Scribe::Builders::Table.new(document, header, config).cell %></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/scribe/documents/show.html.erb

@@ -0,0 +1,25 @@
+<% content_for :navigation do %>
+  <%= link_to "All Documents", document_listing_path, class: "button orange-button mobile-full" %>
+  <%= link_to @klass.to_s.pluralize, documents_path(model_param(@klass)), class: "button orange-button mobile-full" %>
+<% end %>
+
+<div class="section header">
+  <div class="container clear">
+    <h1 class='logo'>Viewing: <%= @document.id %></h1>
+  </div>
+</div>
+<%= link_to "Edit", edit_document_path(model_param(@klass), @document.id), class: "button orange-button mobile-full" %>
+
+<table>
+  <% @klass.fields.each do |attribute, meta| %>
+    <tr>
+      <td class='key'><%= attribute %></td>
+      <td><%= @document.send(attribute) %></td>
+    </tr>
+  <% end %>
+</table>
+
+<h3>Relations:</h3>
+<% @klass.relations.each do |relation, meta| %>
+  <%= Mongoid::Scribe::Builders::Relation.new(@document, relation).listing %>
+<% end %>

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <%= csrf_meta_tags %>
+    <%= stylesheet_link_tag "base/style", "base/doc", "base/custom" %>
+  </head>
+  <body>
+    <div class="container content-inner">
+      <%= yield :navigation %>
+      <%= yield %>
+    </div>
+    <%= javascript_include_tag "jquery", "jquery_ujs" %>
+  </body>
+</html>

data/config/routes.rb

@@ -0,0 +1,10 @@
+Mongoid::Scribe::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
+  get "/:type",          to: "documents#index",   as: :documents
+  delete "/:type/:id",   to: "documents#destroy", as: :destroy_document
+
+end

data/lib/generators/mongoid_scribe/install_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+module MongoidScribe
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Generate Mongoid Scribe Initializer"
+
+      def generate_initializer
+        copy_file "config/initializers/mongoid_scribe.rb", "config/initializers/mongoid_scribe.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/mongoid_scribe/templates/config/initializers/mongoid_scribe.rb

@@ -0,0 +1,23 @@
+Mongoid::Scribe.configure do
+
+##  authenticate_with :admin_required
+
+##  mount_at "/documents"
+
+##  resources include: [:user]
+
+##  form_configuration_for User do
+##    field :first_name
+##    field :last_name
+##    field :email, type: :email
+##    field :city_id, values: -> { City.all }, label: :name, value: :id
+##    field :favorite_color, values: User::COLORS
+##  end
+
+##  index_configuration_for User do
+##    column :first_name
+##    column :last_name
+##    column :email, value: ->(user) { "<a href='mailto:#{user.email}'>#{user.email}</a>".html_safe }
+##  end
+
+end

data/lib/mongoid/scribe/builders/field.rb

@@ -0,0 +1,85 @@
+module Mongoid
+  module Scribe
+    module Builders
+      class Field
+        include ActionView::Helpers::FormHelper
+        include ActionView::Context
+
+        def initialize(form, klass, document, name, config)
+          @form         = form
+          @klass        = klass
+          @document     = document
+          @name         = name.to_s
+          @config       = config
+          @label_method = @config.fetch(:label, :id)
+          @value_method = @config.fetch(:value, :id)
+          @type         = @config.fetch(:type, nil)
+        end
+
+        def field
+          return nil if private_field?
+
+          if @klass.fields[@name].type == Boolean
+            form_field = @form.check_box(@name)
+          elsif @klass.fields[@name].type == Integer
+            form_field = @form.number_field(@name)
+          elsif @type == :textarea
+            form_field = @form.text_area(@name)
+          elsif (@name =~ /email/) || (@type == :email)
+            form_field = @form.email_field(@name)
+          elsif @klass.fields[@name].type == Array && values
+            form_field = checkbox_array
+          elsif values && values.is_a?(Mongoid::Criteria)
+            form_field = @form.collection_select(@name, values, @value_method, @label_method)
+          elsif values
+            form_field = @form.select(@name, values)
+          else
+            form_field = @form.text_field(@name)
+          end
+
+          return content_tag(:div, (label + form_field).html_safe, class: 'control-group')
+        end
+
+      private
+
+        def values
+          return @values if @values
+          @values = @config.fetch(:values, nil)
+          if @values.respond_to?(:call) && @values.arity == 1
+            @values = @values.call(@document)
+          elsif @values.respond_to?(:call)
+            @values = @values.call
+          elsif class_name = @document.relations.values.detect{ |data| data.key == @name }.try(:class_name)
+            @values = class_name.constantize.all
+          end
+        end
+
+        def label
+          @form.label(@name, class: "stacked")
+        end
+
+        def private_field?
+          return true if @name.start_with?("_")
+          return true if ["created_at", "updated_at"].include?(@name)
+          return false
+        end
+
+        def field_name(model)
+          model.to_s.underscore.downcase
+        end
+
+        def checkbox_array
+          values.each_with_index.map do |record, index|
+            dom_id  = "#{field_name(record.class.name)}_#{index}"
+            checked = @document.send(@name).include?(record.send(@value_method))
+            label_tag(record.send(@label_method), nil, for: dom_id, class: "stacked") do
+              check_box_tag("#{field_name(@klass)}[#{@name}][]", record.send(@value_method), checked, id: dom_id) +
+              content_tag(:span, record.send(@label_method))
+            end
+          end.join("\n").html_safe
+        end
+
+      end
+    end
+  end
+end

data/lib/mongoid/scribe/builders/relation.rb

@@ -0,0 +1,40 @@
+module Mongoid
+  module Scribe
+    module Builders
+      class Relation
+        include ActionView::Helpers::TagHelper
+        include ActionView::Helpers::UrlHelper
+        include ActionView::Context
+
+        def initialize(document, relation)
+          @document = document
+          @relation = relation
+        end
+
+        def listing
+          output = content_tag(:h4, @relation)
+          Array(@document.send(@relation)).sort_by(&:created_at).each do |record|
+            link = link_to(relation_label(record), Mongoid::Scribe::Engine.routes.url_helpers.document_path(model_param(record.class.name), record.send(:id)))
+            output += content_tag(:p, link)
+          end
+          return output.html_safe
+        end
+
+      private
+
+        def relation_label(relation)
+          if relation.respond_to?(:slug)
+            return relation.slug
+          else
+            return relation.id
+          end
+        end
+
+        def model_param(model)
+          model.to_s.underscore.downcase
+        end
+
+      end
+    end
+  end
+end

data/lib/mongoid/scribe/builders/table.rb

@@ -0,0 +1,26 @@
+module Mongoid
+  module Scribe
+    module Builders
+      class Table
+
+        def initialize(document, header, config)
+          @document = document
+          @header   = header
+          @config   = config
+        end
+
+        def header
+        end
+
+        def cell
+          if @config[:value] && @config[:value].respond_to?(:call)
+            return @config[:value].call(@document)
+          else
+            return @document.send(@header)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/mongoid/scribe/configuration/form_configuration.rb

@@ -0,0 +1,11 @@
+module Mongoid
+  module Scribe
+
+    class FormConfiguration < Configuration
+      def field(name, options={})
+        @configuration[name] = options
+      end
+    end
+
+  end
+end

data/lib/mongoid/scribe/configuration/index_configuration.rb

@@ -0,0 +1,11 @@
+module Mongoid
+  module Scribe
+
+    class IndexConfiguration < Configuration
+      def column(name, options={})
+        @configuration[name] = options
+      end
+    end
+
+  end
+end

data/lib/mongoid/scribe/configuration.rb

@@ -0,0 +1,21 @@
+module Mongoid
+  module Scribe
+    class Configuration
+
+      def initialize(document_class, configuration, &block)
+        @document_class = document_class
+        @configuration  = configuration
+      end
+
+      def evaluate(&block)
+        @self_before_instance_eval = eval("self", block.binding)
+        instance_eval(&block)
+      end
+
+      def method_missing(method, *args, &block)
+        @self_before_instance_eval.send(method, *args, &block)
+      end
+
+    end
+  end
+end

data/lib/mongoid/scribe/engine.rb

@@ -0,0 +1,18 @@
+module Mongoid
+  module Scribe
+    class Engine < ::Rails::Engine
+      isolate_namespace Mongoid::Scribe
+
+      initializer :assets, group: :all do |app|
+        app.config.assets.precompile += ["base/style.css", "base/doc.css", "base/custom.css", "jquery.js", "jquery_ujs.js"]
+      end
+
+      config.after_initialize do |app|
+        app.routes.prepend do
+          mount Mongoid::Scribe::Engine => Mongoid::Scribe.endpoint
+        end
+      end
+
+    end
+  end
+end

data/lib/mongoid/scribe/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Scribe
+    VERSION = "0.1.0"
+  end
+end

data/lib/mongoid/scribe.rb

@@ -0,0 +1,82 @@
+require "mongoid/scribe/version"
+require "mongoid/scribe/engine"
+require "mongoid/scribe/configuration"
+require "mongoid/scribe/configuration/form_configuration"
+require "mongoid/scribe/configuration/index_configuration"
+require "mongoid/scribe/builders/field"
+require "mongoid/scribe/builders/table"
+require "mongoid/scribe/builders/relation"
+
+module Mongoid
+  module Scribe
+    extend ActiveSupport::Autoload
+
+    mattr_accessor :form_configuration
+    @@form_configuration  = {}
+
+    mattr_accessor :index_configuration
+    @@index_configuration = {}
+
+    mattr_accessor :authentication_filter
+    @@authentication_filter = nil
+
+    mattr_accessor :endpoint
+    @@endpoint = "/documents"
+
+    mattr_accessor :models
+    @@models = Mongoid.models
+
+    def self.configure(&block)
+      instance_eval(&block)
+    end
+
+    def self.fields_for(klass)
+      default_fields = {}
+      klass.fields.each_pair do |name, options|
+        default_fields[name.to_s] = {}
+      end
+      @@form_configuration.fetch(klass, default_fields)
+    end
+
+    def self.index_for(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)
+      @@form_configuration[document_class] = {}
+      config = FormConfiguration.new(document_class, @@form_configuration[document_class])
+      config.evaluate(&block)
+    end
+
+    def self.index_configuration_for(document_class, &block)
+      @@index_configuration[document_class] = {}
+      config = IndexConfiguration.new(document_class, @@index_configuration[document_class])
+      config.evaluate(&block)
+    end
+
+    def self.authenticate_with(filter)
+      @@authentication_filter = filter
+    end
+
+    def self.mount_at(endpoint)
+      @@endpoint = endpoint
+    end
+
+    def self.resources(options={})
+      ::Rails::Mongoid.load_models(Rails.application)
+      if options[:include]
+        @@models = Mongoid.models.select{ |model| Array(options[:include]).include?(model.to_s.underscore.downcase.to_sym) }
+      elsif options[:exclude]
+        @@models = Mongoid.models.reject{ |model| Array(options[:exclude]).include?(model.to_s.underscore.downcase.to_sym) }
+      else
+        @@models = Mongoid.models
+      end
+    end
+
+  end
+end

data/lib/mongoid_scribe.rb

@@ -0,0 +1 @@
+require 'mongoid/scribe'