revelry_content 0.0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d57f008f016c584fc60768a5c49a53ebdb5ba404
-  data.tar.gz: ff49d78be60b93f65f80bddad50fd5d3831349fe
+  metadata.gz: 1edfd315b91ca9459b3b4fb2c45284ff3c743bb4
+  data.tar.gz: 80fa83be18d2fa4261428e0884ce48509911c2c9
 SHA512:
-  metadata.gz: e61ebb2af92ac13c2054557738082162d8e1066b43f81e32d63a6566955de141b3ed86cf79f7b8e07559d202f26bc2d9d33af901c50d25b534a949490eeb8014
-  data.tar.gz: 21387b6aaf8c2c34d83585636742bc8fab9991f8447d715357c5d02b64b6800638c0a8b67a25180feed669d2d2360f9d98ae1643309205a866dad6d24a782647
+  metadata.gz: ff18e8f7c22f942f0f0033008f41e8acc8713fde1dca49db3cac536cc0d625cba0877f4a1f4034358165381e0ac06d77e1296441bae1aafd3033bc3c89fccbaf
+  data.tar.gz: 821b40f62d9248c323ca8309a601e40e90fd31ab3b49f0e6f9ef310ef302e5616f2a03e0b2549fbce94c0a46070130dd1ef17a452afb73dcbdc0f6314cc13dce

data/README.md

@@ -1,19 +1,14 @@
-RevelryContent
+Revelry::Content
 ===
 
-RevelryContent is a gem for managing admin-editable content within Rails applications.
+Revelry::Content is a gem for managing admin-editable content within Rails and React applications.
 
 # Installation
 
-Either install from a rails template:
-
-```shell
-rails new APPNAME -m https://raw.githubusercontent.com/revelrylabs/revelry_content/master/template.rb
-```
-
-Or add it to your gemfile:
+Add it to your gemfile:
 
 ```ruby
+gem 'revelry_core'
 gem 'revelry_content'
 ```
 
@@ -21,112 +16,54 @@ and install it:
 
 ```shell
 bundle
-rails g revelry_content:install
+rails g revelry:core:install
+rails g revelry:content:install
 ```
 
 # Configuration
 
 The installer makes an initializer in `config/initializer.rb`. You can edit it
-to customize authenticiation, authorization or javascript export settings.
+to customize authentication, authorization or javascript export settings.
 
 ## Configuring file uploads
 
-RevelryContent uses [carrierwave](https://github.com/carrierwaveuploader/carrierwave) to store image uploads. You'll want to configure carrierwave appropriately for your app.
-
-# Use in ERB Templates
-
-RevelryContent provides helpers for setting up edit controls:
-
-### Adding the RevelryContent menus and edit mode button
-
-Add the `revelry_content/contents/menus` partial to the page to place the edit button and top bar on the page. The top bar will be invisible unless we are in edit mode.
-
-```erb
-<%= render 'revelry_content/contents/menus' %>
-```
-
-### Editable text
-
-```erb
-<%= revelry_content_text('home.title', default: 'Hello, World!') %>
-```
-
-`lookup` is a lookup hash of the available content. If you have included `RevelryContent::WithRevelryContent` in your controller, `@revelry_content_contents` is the default lookup with all content.
-
-In this case `'home.headline'` is the content key of the content, which is just a unique string for each piece of changeable content.
-
-The `default` param is what is shown if know one has set any content yet.
-(Think brand-new sites.)
-
-### Editable images
-
-Editable images work in a similar manner to editable text:
-
-```erb
-<%= revelry_content_image('home.image', default: 'http://placehold.it/200x200') %>
-```
-
-Here, `home.image` is the content key for the image to display, and `default` provides a placeholder image URL.
-
-# Using in JavaScript (including React)
-
-## Making content available to JavaScript
-
-You can configure RevelryContent to export all of your content into javascript.
+Revelry::Content uses [carrierwave](https://github.com/carrierwaveuploader/carrierwave) to store image uploads. You'll want to configure carrierwave appropriately for your app.
 
-```ruby
-RevelryContent.configure do |config|
-  config.js_export = true
-end
-```
-
-Then run the export task:
-
-```shell
-rake revelry_content:export_js
-```
-
-And include the exported js in your application.js:
-
-```javascript
-//= require revelry_content/content
-```
-
-and access it like this:
-
-```javascript
-RevelryContent.Content.home.headline
-```
-
-The JavaScript export will automatically update whenever content is updated.
+# Using with React
 
 ## Adding Editable Sections with React
 
-RevelryContent is built on React, so you can also directly invoke the React components:
+Revelry::Content is built on React, so you can also directly invoke the React
+components:
 
 ```coffeescript
-<RevelryContent.EditableText canEdit={ true } content={ RevelryContent.Content.home.headline } />
+<Rev.Content.EditableText canEdit={true} contentKey="home.headline" />
 ```
 
 or
 
 ```coffeescript
-<RevelryContent.EditableImage canEdit={ true } content={ RevelryContent.Content.home.image } />
+<Rev.Content.EditableImage canEdit={true} contentKey="home.image" />
 ```
 
 [More details are availble here](https://github.com/revelrylabs/revelry_content/blob/master/react-components.md)
 
+There component will present ONLY the content (with no editor chrome) if out of
+edit mode, and can be clicked to edit in edit mode (see below).
+
+## Adding the admin controls
 
-## Adding the top bar and buttons with React
+For admin users, you can present edit buttons and an edit mode top bar to allow
+entry to edit mode and provide feedback during editing:
 
 ```coffeescript
-<RevelryContent.TopBar />
+<Rev.Content.TopBar />
 ```
 
 and
 
 ```coffeescript
-<RevelryContent.EditModeButton />
+<Rev.Content.EditModeButton />
 ```
 
 These do not require any props.

data/Rakefile

@@ -8,7 +8,7 @@ require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'RevelryContent'
+  rdoc.title    = 'Revelry::Content'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')

data/app/assets/javascripts/revelry_content.js.coffee

@@ -1,21 +1,9 @@
-# @cjsx
-#= require ./revelry_content/utilities
-#= require ./revelry_content/config
-#= require ./vendor/react_ujs
-#= require jquery
-#= require underscore
-#= require backbone
+#= require revelry_content/setup
+#= require revelry_content/config
 #= require moment
 #= require moment-timezone-with-data-2010-2020
 #= require_tree ./revelry_content/mixins
 #= require_tree ./revelry_content/models
 #= require_tree ./revelry_content/components
 
-RevelryContent.dispatcher = new Backbone.Model();
-
-$ ->
-  RevelryContent.Utilities.rev_script_loader React?, 'https://cdnjs.cloudflare.com/ajax/libs/react/0.12.2/react-with-addons.js', =>
-    RevelryContent.Utilities.exportLazyComponents()
-    RevelryContent.load_react_ujs()
-
-window.RevelryContent = RevelryContent
+Rev.Content.dispatcher = new Backbone.Model()

data/app/assets/javascripts/revelry_content/components/Admin.js.cjsx

@@ -1,90 +1,94 @@
-RevelryContent.Utilities.lazyComponentDefinition ->
-  RevelryContent.AdminTopBar = React.createClass
-    render: ->
-      <nav className="topBar">
-        <ul className="inline-list right">
-          <li onClick={ @makePageButton('history') }>
-            <span className="icon-loop2"></span>
-            History
-          </li>
-          <a href={ RevelryContent.base_path + 'contents/export.json' }>
-          <li>
-            Export
-          </li>
-          </a>
-          <li onClick={ @makePageButton('import') }>
-            Import
-          </li>
-        </ul>
-        <div className="topBar-container">
-          <div className="topBar-items">
-            Content Admin
-          </div>
+Rev.Content.AdminTopBar = React.createClass
+  render: ->
+    <nav className="topBar">
+      <ul className="inline-list right">
+        <li onClick={ @makePageButton('history') }>
+          <span className="icon-loop2"></span>
+          History
+        </li>
+        <a href={ Rev.Content.base_path + 'contents/export.json' }>
+        <li>
+          Export
+        </li>
+        </a>
+        <li onClick={ @makePageButton('import') }>
+          Import
+        </li>
+      </ul>
+      <div className="topBar-container">
+        <div className="topBar-items">
+          Content Admin
         </div>
-      </nav>
+      </div>
+    </nav>
 
-    makePageButton: (page)->
-      return (e)->
-        RevelryContent.dispatcher.trigger 'pageChange', page
+  makePageButton: (page)->
+    return (e)->
+      Rev.Content.dispatcher.trigger 'pageChange', page
 
-  RevelryContent.AdminTabbedArea = React.createClass
-    getInitialState: ->
-      state =
-        page: @firstChildPage()
+Rev.Content.AdminTabbedArea = React.createClass
+  getInitialState: ->
+    state =
+      page: @firstChildPage()
 
-    render: ->
-      @findChildByPage(@state.page)
+  render: ->
+    @findChildByPage(@state.page)
 
-    findChildByPage: (page)->
-      return null unless @props.children
-      if React.Children.count == 1
-        if React.Children.only.props.adminTabPage == page
-          return React.Children.only
-        else
-          return null
+  findChildByPage: (page)->
+    return null unless @props.children
+    if React.Children.count == 1
+      if React.Children.only.props.adminTabPage == page
+        return React.Children.only
       else
-        for child in @props.children
-          if child.props.adminTabPage == page
-            return child
-      return null
+        return null
+    else
+      for child in @props.children
+        if child.props.adminTabPage == page
+          return child
+    return null
 
-    firstChildPage: ->
-      return null unless @props.children
-      if React.Children.count == 1
-        return React.Children.only.props.adminTabPage
-      else
-        return @props.children[0].props.adminTabPage
+  firstChildPage: ->
+    return null unless @props.children
+    if React.Children.count == 1
+      return React.Children.only.props.adminTabPage
+    else
+      return @props.children[0].props.adminTabPage
 
-    componentDidMount: ->
-      RevelryContent.dispatcher.on 'pageChange', @onPageChange
+  componentDidMount: ->
+    Rev.Content.dispatcher.on 'pageChange', @onPageChange
 
-    componentWillUnmount: ->
-      RevelryContent.dispatcher.off 'pageChange', @onPageChange
+  componentWillUnmount: ->
+    Rev.Content.dispatcher.off 'pageChange', @onPageChange
 
-    onPageChange: (page)->
-      @setState page: page
+  onPageChange: (page)->
+    @setState page: page
 
-  RevelryContent.ImportTab = React.createClass
-    render: ->
-      <form action="import" method="POST" enctype="multipart/form-data" className="EditablePages">
-        <input type="hidden" name="authenticity_token" value={ RevelryContent.Utilities.getAuthenticityToken() } />
-        <h2>Import</h2>
-        <label>
-          <div>
-            <input type="file" name="import" />
-          </div>
-        </label>
-        <button className="Button">
-          Import
-        </button>
-      </form>
+Rev.Content.ImportTab = React.createClass
+  render: ->
+    <Rev.Components.Form action="import" method="POST" enctype="multipart/form-data" className="EditablePages">
+      <h2>Import</h2>
+      <label>
+        <div>
+          <input type="file" name="import" />
+        </div>
+      </label>
+      <button className="Button">
+        Import
+      </button>
+    </Rev.Components.Form>
 
-  RevelryContent.AdminPage = React.createClass
-    render: ->
-      <div>
-        <RevelryContent.AdminTopBar />
-        <RevelryContent.AdminTabbedArea>
-          <RevelryContent.VersionHistory adminTabPage="history" />
-          <RevelryContent.ImportTab adminTabPage="import" />
-        </RevelryContent.AdminTabbedArea>
-      </div>
+Rev.Content.AdminPage = React.createClass
+  componentDidMount: ->
+    App.props = @props
+
+  componentDidUnmount: ->
+    App.props = null
+
+  render: ->
+    <div>
+      <Rev.Content.AdminTopBar />
+      <Rev.Content.AdminTabbedArea>
+        <Rev.Content.VersionHistory adminTabPage="history" />
+        <Rev.Content.ImportTab adminTabPage="import" />
+      </Rev.Content.AdminTabbedArea>
+    </div>

data/app/assets/javascripts/revelry_content/components/EditModeButton.js.cjsx

@@ -1,16 +1,15 @@
-RevelryContent.Utilities.lazyComponentDefinition ->
-  RevelryContent.EditModeButton = React.createClass
-    render: ->
-      <button className="EditModeButton" onClick={ @toggleEdit }>
-        {
-          if RevelryContent.inEditMode
-            "Preview this page"
-          else
-            "Edit this page"
-        }
-      </button>
+Rev.Content.EditModeButton = React.createClass
+  render: ->
+    <button className="EditModeButton" onClick={@toggleEdit}>
+      {
+        if Rev.Content.inEditMode
+          "Preview this page"
+        else
+          "Edit this page"
+      }
+    </button>
 
-    toggleEdit: ->
-      RevelryContent.inEditMode = !RevelryContent.inEditMode
-      RevelryContent.dispatcher.trigger 'didChangeEditMode'
-      @forceUpdate()
+  toggleEdit: ->
+    Rev.Content.inEditMode = !Rev.Content.inEditMode
+    Rev.Content.dispatcher.trigger 'didChangeEditMode'
+    @forceUpdate()

data/app/assets/javascripts/revelry_content/components/Loader.js.cjsx

@@ -1,10 +1,9 @@
-RevelryContent.Utilities.lazyComponentDefinition ->
-  RevelryContent.Loader = React.createClass
-    render: ->
-      <div className="RevelryContent-loader">
-        <div></div>
-        <div></div>
-        <div></div>
-        <div></div>
-        <div></div>
-      </div>
+Rev.Content.Loader = React.createClass
+  render: ->
+    <div className="Rev.Content-loader">
+      <div></div>
+      <div></div>
+      <div></div>
+      <div></div>
+      <div></div>
+    </div>

data/app/assets/javascripts/revelry_content/components/Time.js.cjsx

@@ -1,15 +1,14 @@
-RevelryContent.Utilities.lazyComponentDefinition ->
-  RevelryContent.Timestamp = React.createClass
-    getDefaultProps: ->
-      props =
-        format: 'YYYY-MM-DD'
+Rev.Content.Timestamp = React.createClass
+  getDefaultProps: ->
+    props =
+      format: 'YYYY-MM-DD'
 
-    render: ->
-      datetime_moment = moment(@props.datetime)
-      <span {..._(@props).omit('datetime')} className="TimeAgo #{ @props.className or '' }">
-        { datetime_moment.format(@props.format) }
-        {
-          if @props.withTimeAgo? && @props.withTimeAgo
-            <span>&nbsp;({ datetime_moment.fromNow() })</span>
-        }
-      </span>
+  render: ->
+    datetime_moment = moment(@props.datetime)
+    <span {..._(@props).omit('datetime')} className="TimeAgo #{ @props.className or '' }">
+      { datetime_moment.format(@props.format) }
+      {
+        if @props.withTimeAgo? && @props.withTimeAgo
+          <span>&nbsp;({ datetime_moment.fromNow() })</span>
+      }
+    </span>