cambium 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 151475ac069e0a44ad489ab9340b9041d3c3ba20
-  data.tar.gz: 2fd26503a744a7dd999eed2a40a72617b5f46323
+  metadata.gz: ff5677f58125f1cad2a98e1904ca8047bdf37252
+  data.tar.gz: 8316b5eb6d5bae1ef353b24cea093c9898de9412
 SHA512:
-  metadata.gz: eed0446889aa382fcd3eb124c23622bb6757e0e7e0ef1693edc51ba10dae9797050f91152bd2abc49095bdab0bf2641380ccf147857ecb2ded8c9c8db2d4d8d2
-  data.tar.gz: f53a44e5a2cd9cd47ca57c69a0186208a8397e7e5404c69f3af6d4be533bf9feab67e1d20d58a0ef57aadf6201776fc9ecada8a65240dbefefbaa7a51fc44f4a
+  metadata.gz: 22120069c0f33717fd8a4348c43b42d4ab9af23ae1631709abbd33c96f67e41833ef1e87bffed5e1ab47ce18d5a063e8507533e602843a4c7afb4222147e1e90
+  data.tar.gz: 537b2a2e28c4e62643100babeb1f41e03962acf5466f1c89f9138c9706270399cd7cd1b20abfca78166c1387123b79a1c5168e251ea2fec218485617600207f0

data/README.md

@@ -231,6 +231,7 @@ form:
         type: string
       email:
         type: string
+        readonly: true
       password:
         type: password
       password_confirmation:
@@ -271,13 +272,42 @@ Every setting plays a role. Let's step through each one.
 * `form:[new/edit]:fields:[field]`: Each form field gets its own unique key to
   set it apart from the others.
 * `form:[new/edit]:fields:[field]:type`: The type of the HTML field to render,
-  which uses [SimpleForm](https://github.com/plataformatec/simple_form).
+  which uses [SimpleForm](https://github.com/plataformatec/simple_form). *You
+  can use `heading` here to break up your fields.*
+* `form:[new/edit]:fields:[field]:readonly`: If set to `true`, it will add the
+  `readonly` attribute to the input field. *Not supported for markdown fields*.
 
 > Note: Aside from the usual form field types, Cambium uses [Mark It
 > Zero!](https://github.com/seancdavis/mark_it_zero) to render markdown
 > editors. You can pass `markdown` as the `type` option and it will give you a
 > markdown editor.
 
+### Overriding the Base Controller
+
+I've rearranged Cambium's CMS controllers so there is a blank `BaseController`
+from which it inherits. You can manually override this in your app by creating
+a `Cambium::BaseController` and loading the appropriate files.
+
+First, generate the controller.
+
+```text
+$ bundle exec rails g controller cambium/base
+```
+
+That controller can inherit from any other controller in your app. The only
+thing you need to ensure is that it loads the `CambiumHelper` from the
+`Cambium` namespace. So, the base file should look like this:
+
+```ruby
+class Cambium::BaseController < ApplicationController
+  helper Cambium::CambiumHelper
+end
+```
+
+You can change `ApplicationController` to any other controller in your
+application.
+
+
 Model Options
 ----------
 

data/app/assets/stylesheets/cambium/admin/partials/components.scss

@@ -37,8 +37,8 @@ div.status{
   }
 }
 
-.button {
-  &.new, &.export {
+a {
+  &.new, &.export, &.file {
     &:before {
       font-family: 'icomoon';
       font-size: inherit;
@@ -48,6 +48,7 @@ div.status{
   }
   &.new:before { content: "\e702"; }
   &.export:before { content: "\e65e"; }
+  &.file:before { content: "\e622"; }
 }
 
 .avatar-container {

data/app/assets/stylesheets/cambium/admin/partials/forms.scss

@@ -1,9 +1,31 @@
 section.form {
   form {
 
+    h2 {
+      margin: 10px 0;
+      font-size: 22px;
+      line-height: 28px;
+      color: $color-dark-lightest;
+      font-weight: 400;
+    }
+
     div.input {
       font-size: 0;
       padding: 20px 0;
+      &.file {
+        padding: 20px 0 0 0;
+        & + a.file {
+          display: block;
+          width: 100%;
+          padding: 5px 0 20px 0;
+          font-size: 14px;
+          line-height: 14px;
+          text-align: right;
+        }
+        & + div.input {
+          padding-top: 40px;
+        }
+      }
       label {
         position: relative;
         display: inline-block;
@@ -35,6 +57,11 @@ section.form {
         vertical-align: bottom;
         font-size: 16px;
         border: none;
+        @include box-sizing(border-box);
+        &[readonly=readonly] {
+          background-color: $color-light-dark;
+          border-bottom-color: $color-light-dark;
+        }
       }
       input {
         border-bottom: 1px solid $color-light-darker;

data/app/controllers/cambium/admin/dashboard_controller.rb

@@ -1,12 +1,10 @@
-module Cambium
-  class Admin::DashboardController < AdminController
+class Cambium::Admin::DashboardController < Cambium::AdminController
 
-    def index
-      redirect_to admin_dashboard_path
-    end
-
-    def show
-    end
+  def index
+    redirect_to admin_dashboard_path
+  end
 
+  def show
   end
+
 end

data/app/controllers/cambium/admin/search_controller.rb

@@ -1,9 +1,7 @@
-module Cambium
-  class Admin::SearchController < AdminController
-
-    def index
-      @collection = PgSearch.multisearch(params[:q]).includes(:searchable)
-    end
+class Cambium::Admin::SearchController < Cambium::AdminController
 
+  def index
+    @collection = PgSearch.multisearch(params[:q]).includes(:searchable)
   end
-end
+
+end

data/app/controllers/cambium/admin/users_controller.rb

@@ -1,30 +1,28 @@
-module Cambium
-  class Admin::UsersController < AdminController
+class Cambium::Admin::UsersController < Cambium::AdminController
 
-    def update
-      set_object
-      # To make this run smoothly, we remove the password
-      # fields from the update_params if they are both
-      # missing, that way we don't try to set a blank
-      # password.
-      p = update_params
-      if p[:password].blank? && p[:password_confirmation].blank?
-        p = p.except('password','password_confirmation')
-      end
-      # Now we use the cleansed params `p` and we're ready
-      # to try to save the user
-      if @object.update(p)
-        # If we have successfully saved the user, we're
-        # going to sign them back in automatically.
-        if @object == current_user
-          sign_in(@object, :bypass => true)
-        end
-        # And then we oome back to regular behavior
-        redirect_to(admin_routes.index, :notice => "#{admin_model.to_s} updated!")
-      else
-        render 'edit'
+  def update
+    set_object
+    # To make this run smoothly, we remove the password
+    # fields from the update_params if they are both
+    # missing, that way we don't try to set a blank
+    # password.
+    p = update_params
+    if p[:password].blank? && p[:password_confirmation].blank?
+      p = p.except('password','password_confirmation')
+    end
+    # Now we use the cleansed params `p` and we're ready
+    # to try to save the user
+    if @object.update(p)
+      # If we have successfully saved the user, we're
+      # going to sign them back in automatically.
+      if @object == current_user
+        sign_in(@object, :bypass => true)
       end
+      # And then we oome back to regular behavior
+      redirect_to(admin_routes.index, :notice => "#{admin_model.to_s} updated!")
+    else
+      render 'edit'
     end
-
   end
+
 end

data/app/controllers/cambium/admin_controller.rb

@@ -1,90 +1,90 @@
-module Cambium
-  class AdminController < ActionController::Base
-
-    before_filter :authenticate_admin!
-    before_filter :set_activities
-
-    layout "admin"
-
-    include CambiumHelper
-
-    def index
-      respond_to do |format|
-        format.html do
-          @collection = admin_model.send(admin_table.scope)
-            .page(params[:page] || 1).per(15)
-        end
-        format.csv do
-          @collection = admin_model.send(admin_table.scope)
-          send_data admin.to_csv(@collection)
-        end
-      end
-    end
+class Cambium::AdminController < Cambium::BaseController
 
-    def show
-      set_object
-      redirect_to(admin_routes.edit)
-    end
+  before_filter :authenticate_admin!
+  before_filter :set_activities
 
-    def new
-      @object = admin_model.new
-    end
+  layout "admin"
 
-    def create
-      set_object
-      @object = admin_model.new(create_params)
-      if @object.save
-        redirect_to(admin_routes.index, :notice => "#{admin_model.to_s} created!")
-      else
-        render 'new'
+  include Cambium::CambiumHelper
+
+  def index
+    respond_to do |format|
+      format.html do
+        @collection = admin_model.send(admin_table.scope)
+          .page(params[:page] || 1).per(15)
+      end
+      format.csv do
+        @collection = admin_model.send(admin_table.scope)
+        send_data admin.to_csv(@collection)
       end
     end
+  end
 
-    def edit
-      set_object
+  def show
+    set_object
+    redirect_to(admin_routes.edit)
+  end
+
+  def new
+    @object = admin_model.new
+  end
+
+  def create
+    set_object
+    @object = admin_model.new(create_params)
+    if @object.save
+      redirect_to(admin_routes.index, :notice => "#{admin_model.to_s} created!")
+    else
+      render 'new'
     end
+  end
 
-    def update
-      set_object
-      if @object.update(update_params)
-        redirect_to(admin_routes.index, :notice => "#{admin_model.to_s} updated!")
-      else
-        render 'edit'
-      end
+  def edit
+    set_object
+  end
+
+  def update
+    set_object
+    if @object.update(update_params)
+      redirect_to(admin_routes.index, :notice => "#{admin_model.to_s} updated!")
+    else
+      render 'edit'
     end
+  end
 
-    private
+  private
 
-      def set_object
-        if @object.respond_to?(:slug) && params[:slug]
-          @object = admin_model.find_by_slug(params[:slug])
-        else
-          @object = admin_model.find_by_id(params[:id])
-        end
-        @obj = @object
+    def set_object
+      if admin_model.new.respond_to?(:slug) && params[:slug]
+        slug = params[:"#{admin_model.to_s.underscore}_slug"] || params[:slug]
+        @object = admin_model.find_by_slug(slug)
+      else
+        id = params[:"#{admin_model.to_s.underscore}_id"] || params[:id]
+        @object = admin_model.find_by_id(id.to_i)
       end
+      @obj = @object
+    end
 
-      def authenticate_admin!
-        authenticate_user!
-        not_found unless current_user.is_admin?
-      end
+    def authenticate_admin!
+      authenticate_user!
+      not_found unless current_user.is_admin?
+    end
 
-      def create_params
-        params
-          .require(admin_model.to_s.humanize.downcase.to_sym)
-          .permit(admin_form.fields.to_h.keys)
-      end
+    def create_params
+      params
+        .require(admin_model.to_s.humanize.downcase.to_sym)
+        .permit(admin_form.fields.to_h.keys)
+    end
 
-      def update_params
-        create_params
-      end
+    def update_params
+      create_params
+    end
 
-      def set_activities
-        @activities = PaperTrail::Version.order(:created_at => :desc)
-          .includes(:item).limit(20)
-        @users = User.where(:id => @activities.collect(&:whodunnit)
-          .reject(&:blank?).map(&:to_i))
-      end
+    def set_activities
+      @activities = PaperTrail::Version.order(:created_at => :desc)
+        .includes(:item).limit(20)
+      @users = User.where(:id => @activities.collect(&:whodunnit)
+        .reject(&:blank?).map(&:to_i))
+    end
 
-  end
 end

data/app/controllers/cambium/base_controller.rb

@@ -0,0 +1,2 @@
+class Cambium::BaseController < ActionController::Base
+end

data/app/helpers/cambium/cambium_helper.rb

@@ -107,92 +107,139 @@ module Cambium
 
     def cambium_form(obj, fields)
       content_tag(:section, :class => 'form') do
-        simple_form_for [:admin, obj] do |f|
-          o = ''
-          fields.to_h.each do |data|
-            attr = data.first.to_s
-            options = data.last
-            if ['select','check_boxes','radio_buttons'].include?(options.type)
-              o += f.input(
-                attr.to_sym,
-                :as => options.type,
-                :collection => options.options
-              )
-            elsif ['date','time'].include?(options.type)
-              if obj.send(attr).present?
-                val = (options.type == 'date') ?
-                  obj.send(attr).strftime("%d %B, %Y") :
-                  obj.send(attr).strftime("%l:%M %p")
-              end
-              o += f.input(
-                attr.to_sym,
-                :as => :string,
-                :input_html => {
-                  :class => "picka#{options.type}",
-                  :value => val.nil? ? nil : val
-                }
-              )
-            elsif options.type == 'datetime'
-              o += content_tag(:div, :class => 'input string pickadatetime') do
-                o2 = content_tag(:label, attr.to_s.humanize.titleize)
-                o2 += content_tag(
-                  :input,
-                  '',
-                  :placeholder => 'Date',
-                  :type => 'text',
-                  :class => 'pickadatetime-date',
-                  :value => obj.send(attr).present? ?
-                    obj.send(attr).strftime("%d %B, %Y") : ''
-                )
-                o2 += content_tag(
-                  :input,
-                  '',
-                  :placeholder => 'Time',
-                  :type => 'text',
-                  :class => 'pickadatetime-time',
-                  :value => obj.send(attr).present? ?
-                    obj.send(attr).strftime("%l:%M %p") : ''
-                )
-                o2 += f.input(
-                  attr.to_sym,
-                  :as => :hidden,
-                  :wrapper => false,
-                  :label => false,
-                  :input_html => { :class => 'pickadatetime' }
-                )
-              end
-            elsif options.type == 'markdown'
-              o += content_tag(:div, :class => "input text optional #{attr}") do
-                o2  = content_tag(:label, attr.titleize, :for => attr)
-                o2 += content_tag(
-                  :div,
-                  f.markdown(attr.to_sym),
-                  :class => 'markdown'
-                )
-              end
-            else
-              o += f.input(
-                attr.to_sym,
-                :as => options.type
-              )
-            end
+        case action_name
+        when 'edit', 'update'
+          url = cambium_route(:show, obj)
+        else
+          url = cambium_route(:index, obj)
+        end
+        simple_form_for obj, :url => url do |f|
+          cambium_form_fields(f, obj, fields)
+        end
+      end
+    end
+
+    def cambium_form_fields(f, obj, fields)
+      o = ''
+      fields.to_h.each do |data|
+        attr = data.first.to_s
+        options = data.last
+        readonly = options.readonly || false
+        label = options.label || attr.titleize
+        if options.type == 'heading'
+          o += content_tag(:h2, options.label || attr.titleize)
+        elsif ['select','check_boxes','radio_buttons'].include?(options.type)
+          o += f.input(
+            attr.to_sym,
+            :as => options.type,
+            :collection => options.options,
+            :label => label,
+            :readonly => readonly
+          )
+        elsif ['date','time'].include?(options.type)
+          if obj.send(attr).present?
+            val = (options.type == 'date') ?
+              obj.send(attr).strftime("%d %B, %Y") :
+              obj.send(attr).strftime("%l:%M %p")
           end
-          o += f.submit
-          o.html_safe
+          o += f.input(
+            attr.to_sym,
+            :as => :string,
+            :label => label,
+            :input_html => {
+              :class => "picka#{options.type}",
+              :value => val.nil? ? nil : val
+            },
+            :readonly => readonly
+          )
+        elsif options.type == 'datetime'
+          o += content_tag(:div, :class => 'input string pickadatetime') do
+            o2 = content_tag(:label, attr.to_s.humanize.titleize)
+            o2 += content_tag(
+              :input,
+              '',
+              :label => label,
+              :placeholder => 'Date',
+              :type => 'text',
+              :class => 'pickadatetime-date',
+              :value => obj.send(attr).present? ?
+                obj.send(attr).strftime("%d %B, %Y") : '',
+              :readonly => readonly
+            )
+            o2 += content_tag(
+              :input,
+              '',
+              :label => label,
+              :placeholder => 'Time',
+              :type => 'text',
+              :class => 'pickadatetime-time',
+              :value => obj.send(attr).present? ?
+                obj.send(attr).strftime("%l:%M %p") : '',
+              :readonly => readonly
+            )
+            o2 += f.input(
+              attr.to_sym,
+              :as => :hidden,
+              :wrapper => false,
+              :label => false,
+              :input_html => { :class => 'pickadatetime' }
+            )
+          end
+        elsif options.type == 'markdown'
+          o += content_tag(:div, :class => "input text optional #{attr}") do
+            o2  = content_tag(:label, attr.titleize, :for => attr)
+            o2 += content_tag(
+              :div,
+              f.markdown(attr.to_sym),
+              :class => 'markdown'
+            )
+          end
+        elsif options.type == 'file'
+          o += f.input(
+            attr.to_sym,
+            :as => options.type,
+            :label => label,
+            :readonly => readonly
+          )
+          o += link_to(
+            obj.send(attr).name,
+            obj.send(attr).url,
+            :class => 'file',
+            :target => :blank
+          ) unless obj.send(attr).blank?
+        else
+          o += f.input(
+            attr.to_sym,
+            :as => options.type,
+            :label => label,
+            :readonly => readonly
+          )
         end
       end
+      o += f.submit
+      o.html_safe
     end
 
-    def cambium_edit_route(obj)
-      controller = obj.class.to_s.humanize.singularize.downcase
-      path = "admin_#{controller}_path"
-      begin
-        cambium.send(path, obj)
-      rescue
+    def cambium_route(action, obj = nil)
+      case action
+      when :index
+        begin
+          main_app
+            .polymorphic_path [:admin, obj.class.to_s.downcase.pluralize.to_sym]
+        rescue
+          polymorphic_path [:admin, obj.class.to_s.downcase.pluralize.to_sym]
+        end
+      when :edit
+        begin
+          main_app.polymorphic_path [:edit, :admin, obj]
+        rescue
+          polymorphic_path [:edit, :admin, obj]
+        end
+      else
         begin
-          main_app.send(path, obj)
+          main_app.polymorphic_path [:admin, obj]
         rescue
-          nil
+          polymorphic_path [:admin, obj]
         end
       end
     end

data/app/views/cambium/admin/paper_trail/versions/_version.html.erb

@@ -10,12 +10,12 @@
         <%= content_tag(:strong, user.name.present? ? user.name : user.email) %>
         <%= "#{version.event}d" %>
         <%= version.item_type.downcase %>
-        <% if cambium_edit_route(version.item).nil? %>
+        <% if cambium_route(:edit, version.item).nil? %>
           <%= content_tag(:strong, version.item.to_s) %>
         <% else %>
           <%= content_tag(
             :strong,
-            link_to(version.item.to_s, cambium_edit_route(version.item))
+            link_to(version.item.to_s, cambium_route(:edit, version.item))
           ) %>
         <% end %>
       </p>

data/app/views/cambium/admin/search/index.html.erb

@@ -20,7 +20,7 @@
               <%= content_tag(:td, item.searchable.to_s) %>
               <%= content_tag(
                 :td,
-                link_to('', cambium_edit_route(item.searchable)),
+                link_to('', cambium_route(:edit, item.searchable)),
                 :class => 'actions'
               ) %>
             </tr>

data/lib/cambium/version.rb

@@ -1,3 +1,3 @@
 module Cambium
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cambium
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Sean C Davis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-30 00:00:00.000000000 Z
+date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -200,6 +200,7 @@ files:
 - app/controllers/cambium/admin/search_controller.rb
 - app/controllers/cambium/admin/users_controller.rb
 - app/controllers/cambium/admin_controller.rb
+- app/controllers/cambium/base_controller.rb
 - app/helpers/cambium/cambium_helper.rb
 - app/models/concerns/idx.rb
 - app/models/concerns/image_cropper.rb