promethee 1.5.4 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 344cfab642c4920d60f0c4f01ebc2c458d8c4315
-  data.tar.gz: c318a24462dad5f1d862d67da7eed55993619179
+SHA256:
+  metadata.gz: 3f3343da331244a830c57574312d5182f16b7f7d2329096250a4eec41f091e50
+  data.tar.gz: 34226a84dc47694fcce5e4738c0a2ef2fa6261e486f3048fd40570b134bad428
 SHA512:
-  metadata.gz: 3915d82040366a905af0e492163dfd4e383345dd652863ac6c83052208ddf029a6c1310085f21099851a136c5a6230d02ff4f8f6406043a9bc78c935a1946981
-  data.tar.gz: 064c728027dfd29262cda10402799cabb1db98de24dc3df8e1b28555f81b05a3dc92207393277671394200179a1f96b62337b4a6aaf32b30c536d6296a3d4f67
+  metadata.gz: 74df3572cd23faf57a5257891238828623944e5c5a5f5af3027f4ac05128264d2bd6bd928992b62774104b4feea17230fc0cc2313c1066e452cfbbddd74fa227
+  data.tar.gz: 0ddcbaf0a569b29a6f432713348260b6030eac55300b02d49ff9fbc6793111e623557703a062c4efbf32bc7863fa410395ac34e912faaf59ac1f0df39f91b24c

data/README.md

@@ -129,6 +129,19 @@ You can specify a back link url to go to when closing the editor without saving:
 <% end %>
 ```
 
+> In these examples, the `Page` model would need a migration adding a `data` column:
+>
+> ```ruby
+> class AddDataToPages < ActiveRecord::Migration[5.2]
+>   def change
+>     add_column :pages, :data, :jsonb
+>
+>     # Or, if jsonb isn't supported by your storage strategy:
+>     # add_column :pages, :data, :string
+>   end
+> end
+> ```
+
 With javascript set:
 ```
 //= require jquery
@@ -150,6 +163,8 @@ With stylesheets set:
 @import 'promethee-edit'
 ```
 
+> These require/import statements are quite flexible: if you already use gems or packages which include bootstrap, jquery, summernote... you're likely to be able to use them in place of those included in Prométhée.
+
 #### The editor has components
 
 The component is made of a show and and edit.
@@ -183,6 +198,42 @@ To register a component, the code is:
   });
 ```
 
+#### The editor needs routes to be defined
+
+To provide preview and active storage management features, **Prométhée use a controller which have to be targeted by routes**. The gem provide a shortcut helper to achieve that:
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  promethee
+  # Equivalent to:
+  # namespace :promethee do
+  #   post 'preview' => 'promethee#preview', as: :preview
+  #   post 'blob' => 'promethee#blob_create'
+  #   get 'blob/:id' => 'promethee#blob_show'
+  # end
+end
+```
+
+Since it's just a shortcut calling Rails native methods, this helper consider the route priority order (higher priority at the top, lower at the bottom).
+
+You can specify the namespace path by providing a value to the `path` option:
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  promethee path: 'admin/promethee'
+  # Equivalent to:
+  # namespace :promethee, path: 'admin/promethee', module: nil do
+  #   post 'preview' => 'promethee#preview', as: :preview
+  #   post 'blob' => 'promethee#blob_create'
+  #   get 'blob/:id' => 'promethee#blob_show'
+  # end
+end
+```
+
 #### The editor previews in an iframe
 
 To be able to preview responsivity, there is a POST "promethee/preview" route.

data/lib/promethee.rb

@@ -16,10 +16,10 @@ module Promethee
     require 'promethee/rails/version'
   end
 
-  require 'promethee/core_ext/tags'
   require 'promethee/core_ext/form_helper'
   require 'promethee/core_ext/form_builder'
+  require 'promethee/core_ext/mapper'
+  require 'promethee/core_ext/tags'
 
-  require 'promethee/configuration'
   require 'promethee/data'
 end

data/lib/promethee/core_ext/mapper.rb

@@ -0,0 +1,9 @@
+ActionDispatch::Routing::Mapper.class_eval do
+  def promethee path: :promethee
+    namespace :promethee, path: path.to_s, module: nil  do
+      post 'preview' => 'promethee#preview', as: :preview
+      post 'blob' => 'promethee#blob_create'
+      get 'blob/:id' => 'promethee#blob_show'
+    end
+  end
+end

data/lib/promethee/rails/version.rb

@@ -1,5 +1,5 @@
 module Promethee
   module Rails
-    VERSION = '1.5.4'
+    VERSION = '1.6.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: promethee
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.6.0
 platform: ruby
 authors:
 - Julien Dargelos
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-25 00:00:00.000000000 Z
+date: 2018-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -259,11 +259,10 @@ files:
 - app/views/promethee/utils/_text-content-from-html.html.erb
 - app/views/promethee/utils/_url-safe.html.erb
 - config/initializers/assets.rb
-- config/routes.rb
 - lib/promethee.rb
-- lib/promethee/configuration.rb
 - lib/promethee/core_ext/form_builder.rb
 - lib/promethee/core_ext/form_helper.rb
+- lib/promethee/core_ext/mapper.rb
 - lib/promethee/core_ext/tags.rb
 - lib/promethee/data.rb
 - lib/promethee/rails/engine.rb
@@ -359,7 +358,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Bring fire to your page

data/config/routes.rb

@@ -1,7 +0,0 @@
-Rails.application.routes.draw do
-  namespace :promethee, path: Promethee.configuration.route_scope, module: nil  do
-    post 'preview' => 'promethee#preview', as: :preview
-    post 'blob' => 'promethee#blob_create'
-    get 'blob/:id' => 'promethee#blob_show'
-  end
-end

data/lib/promethee/configuration.rb

@@ -1,17 +0,0 @@
-module Promethee
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.configure
-    yield configuration
-  end
-
-  class Configuration
-    attr_accessor :route_scope
-
-    def initialize
-      @route_scope = 'promethee'
-    end
-  end
-end