nacelle 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22e80566ff4a1407bd07ac2519ceb84f45c354e7
-  data.tar.gz: 129e8cbbdf6c777549d17c55ae0bb0141fbdd681
+  metadata.gz: c31812f7e6de7f7be944bb8601f3a9bceb0343a2
+  data.tar.gz: c2606339159163faee9c275a2c5dd74de1292672
 SHA512:
-  metadata.gz: 4c59cebe992329fc4bb80659005da6867fe1a9241d68b44d8a2f08747edff8401562dec8f3518307222cfdeb0ae52d5faae03324998c83e9fc2f1a56914a5c53
-  data.tar.gz: 6f85b7a28a057fce45eaae53dd818f0a09d252573b6cdfbb834b4cd004dd54f8ac5e760c059414c94f9c3a20538b6eff28a5cd802a7b85377c5aba38f5998fbe
+  metadata.gz: af7d8964d04d74242f7e6687b8a5a55d9bc16b1ebb6b1f42f9f07b12b7595ad25250b3a7abdef6e8900c5b18463bbf82f5a76e3c5527cd5df017c9b4b9b4585c
+  data.tar.gz: 38a819ab94884465e6ab9e561942a10eec0473ce5fc2bddab0fea8b107cb9f2f0b6eee598535bc965c10642f740c8f6e5c48cedc1676fb2c663754208cb5a0da

data/README.md

@@ -1,8 +1,13 @@
 # Nacelle
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nacelle`. To experiment with that code, run `bin/console` for an interactive prompt.
+Rails engine for inserting magic blocks into CMS content via cells.
 
-TODO: Delete this and the text above, and describe your gem
+In your CMS content:
+```html
+<cell name="my_account/form" />
+```
+
+The Nacelle middleware will replace this with the result of MyAccountCell#form.
 
 ## Installation
 
@@ -12,17 +17,19 @@ Add this line to your application's Gemfile:
 gem 'nacelle'
 ```
 
-And then execute:
+# Optional CKEditor integration
 
-    $ bundle
+Cells you want to show up in the cell selection menu must inherit from Nacelle::Cell.
 
-Or install it yourself as:
+```javascript
+// ckeditor/config.js
 
-    $ gem install nacelle
+//= require nacelle/ckeditor
+...
+config.extraPlugins = 'cells';
 
-## Usage
-
-TODO: Write usage instructions here
+// finally, add 'InsertCell' to your toolbar config
+```
 
 ## Development
 
@@ -32,7 +39,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/nacelle/fork )
+1. Fork it ( https://github.com/botandrose/nacelle/fork )
 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`)

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/app/assets/javascripts/ckeditor/plugins/cells.js

@@ -0,0 +1,2 @@
+//= require ./cells/plugin
+//= require ./cells/dialogs/cells

data/app/assets/javascripts/ckeditor/plugins/cells/dialogs/cells.js.coffee

@@ -0,0 +1,25 @@
+CKEDITOR.dialog.add "cellDialog", (editor) ->
+  title: "Insert Cell"
+  minWidth: 400
+  minHeight: 200
+  contents: [
+    id: "main"
+    elements: [
+      type: "select"
+      id: "cellName"
+      label: "Select Cell"
+      items: []
+    ]
+  ]
+
+  onShow: ->
+    $.getJSON "/nacelle/cells.json", (data) =>
+      select = @getContentElement("main", "cellName")
+      for item in data.cells
+        select.add item.name, item.id
+
+  onOk: ->
+    cell = editor.document.createElement("cell")
+    cell.setAttribute "name", @getValueOf("main", "cellName")
+    editor.insertElement cell
+

data/app/assets/javascripts/ckeditor/plugins/cells/plugin.js.coffee

@@ -0,0 +1,15 @@
+CKEDITOR.plugins.add "cells",
+  icons: "insertcell"
+  init: (editor) ->
+    editor.addCommand "insertCellDialog", new CKEDITOR.dialogCommand("cellDialog")
+
+    CKEDITOR.dialog.add "cellDialog", "#{@path}dialogs/cells.js"
+
+    editor.ui.addButton "InsertCell",
+      label: "Insert Cell"
+      command: "insertCellDialog"
+
+CKEDITOR.dtd.$empty.cell = 1
+CKEDITOR.dtd.$nonEditable.cell = 1
+CKEDITOR.dtd.$object.cell = 1
+

data/app/assets/javascripts/nacelle/ckeditor.js

@@ -0,0 +1 @@
+//= require ../ckeditor/plugins/cells.js

data/app/controllers/nacelle/cells_controller.rb

@@ -0,0 +1,9 @@
+require "nacelle/cells_serializer"
+
+module Nacelle
+  class CellsController < ApplicationController
+    def index
+      render json: CellsSerializer.new
+    end
+  end
+end

data/config/routes.rb

@@ -1,6 +1,6 @@
 Rails.application.routes.draw do
-  namespace :admin do
-    get "cells" => "cells#index"
+  namespace :nacelle do
+    resources :cells, only: :index
   end
 end
 

data/lib/nacelle.rb

@@ -1,8 +1,7 @@
-require "rails/all"
-require "cells"
 require "nacelle/version"
+require "action_controller/railtie"
+require "nacelle/cell"
 require "nacelle/middleware"
-require "nacelle/cells_ext"
 
 module Nacelle
   class Engine < ::Rails::Engine

data/lib/nacelle/cell.rb

@@ -0,0 +1,6 @@
+require "cells"
+
+module Nacelle
+  class Cell < Cell::Base
+  end
+end

data/lib/nacelle/cells_serializer.rb

@@ -0,0 +1,33 @@
+class Nacelle::CellsSerializer
+  def as_json(*)
+    { cells: cell_classes.flat_map(&method(:serialize)) }
+  end
+
+  private
+
+  def serialize klass
+    cell = klass.to_s.sub("Cell", "").underscore
+    cell_name = cell.humanize
+
+    klass.action_methods.map do |action|
+      action_name = action.to_s.humanize
+      {
+        id:   "#{cell}/#{action}",
+        name: "#{cell_name} #{action_name}",
+      }
+    end
+  end
+
+  def cell_classes
+    @all ||= begin
+      require_all_cells
+      Nacelle::Cell.subclasses
+    end
+  end
+
+  def require_all_cells
+    # TODO pull in cells from engines, too
+    cell_files = Dir[::Rails.root.join('app/cells/*.rb')]
+    cell_files.each(&method(:require))
+  end
+end

data/lib/nacelle/version.rb

@@ -1,3 +1,3 @@
 module Nacelle
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nacelle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Micah Geisel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,12 +125,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/controllers/admin/cells_controller.rb
+- app/assets/javascripts/ckeditor/plugins/cells.js
+- app/assets/javascripts/ckeditor/plugins/cells/dialogs/cells.js.coffee
+- app/assets/javascripts/ckeditor/plugins/cells/icons/insertcell.png
+- app/assets/javascripts/ckeditor/plugins/cells/plugin.js.coffee
+- app/assets/javascripts/nacelle/ckeditor.js
+- app/controllers/nacelle/cells_controller.rb
 - bin/console
 - bin/setup
 - config/routes.rb
 - lib/nacelle.rb
-- lib/nacelle/cells_ext.rb
+- lib/nacelle/cell.rb
+- lib/nacelle/cells_serializer.rb
 - lib/nacelle/middleware.rb
 - lib/nacelle/version.rb
 - nacelle.gemspec

data/app/controllers/admin/cells_controller.rb

@@ -1,10 +0,0 @@
-class Admin::CellsController < Admin::BaseController
-  def index
-    @cells = Cell.all
-
-    respond_to do |format|
-      format.xml  { render :xml => @cells.to_xml(:root => 'cells', :skip_types => true) }
-      format.json { render :json => { cells: @cells.map(&:to_json).flatten } }
-    end
-  end
-end

data/lib/nacelle/cells_ext.rb

@@ -1,28 +0,0 @@
-module Cell
-  class << self
-    def to_json
-      cell_name = self.to_s.sub("Cell", "").underscore
-      action_methods.map do |state|
-        {
-          id:   "#{cell_name}/#{state.to_s}",
-          name: "#{cell_name.humanize} #{state.to_s.humanize}",
-        }
-      end
-    end
-
-    def all
-      @all ||= begin
-        require_all_cells
-        BaseCell.subclasses
-      end
-    end
-
-    private
-
-    def require_all_cells
-      # TODO pull in cells from engines, too
-      cell_files = Dir[::Rails.root.join('app/cells/*.rb')]
-      cell_files.each { |cell_file| require cell_file }
-    end
-  end
-end