promethee 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 713537989be982b85b811ad216982e6f8fe8b381
-  data.tar.gz: 4ce491f4b51ec1e55e66e096061a63648caf4f72
+  metadata.gz: 14fcd1ec2bd76b0e5a05757927c5fb38b292638c
+  data.tar.gz: 2fb7d856837d11869f7390ef44fc97985fa7da22
 SHA512:
-  metadata.gz: 9d3c1a3f84b077d64559f399577b642ab2f792ceddb944ed3963f071d3eb8b18840f98faa6bbc3aa98eaf6d138cb2102b3340593a980aaf56859e3ef5f3bc8af
-  data.tar.gz: b83effefd44a2d04dde64173b458a01171809747490b4b447b75d5e5861f51927877ed3c6d0ef48e30555b7431e7bd16bb2ced012ad62b0409ecaf421badd11d
+  metadata.gz: a2c4c4b361aa1e2e6a938127cfaa83c43a89adbee44969d3452b1e8ec9b110d386454671a35278c2c4910976578d59c4e083c563c141501cdef51334ed3d44fb
+  data.tar.gz: '0219cf7aa0bbc9f06c677966db46c4bfcf86c282731ecb9700f8abf02f196aafb281ebf30232271b499131368a3f7641c63cd48be40d8dcf75c5dc9c94b9c1f1'

data/README.md

@@ -63,26 +63,36 @@ The data is:
 
 ```ruby
 @page.data = {
+  id: 'ero342ezr',
   type: 'page',
+  version: 1,
   children: [
     {
+      id: '7lebjl4j6',
       type: 'row',
+      version: 1,
       children: [
         {
-          type: 'col',
+          id: '8lebjl4j6',
+          type: 'column',
+          version: 1,
           attributes: {
             size: 4,
             offset: 0
           },
           children: [
             {
+              id: '9lebjl4j6',
               type: 'text',
+              version: 1,
               attributes: {
                 body: '<p><b>This</b> is a text</p>'
               }
             },
             {
+              id: '12lebjl4j6',
               type: 'image',
+              version: 1,
               attributes: {
                 src: 'https://c1.staticflickr.com/5/4089/4975306844_f849232195_b.jpg',
                 alt: 'Prométhée'
@@ -159,7 +169,7 @@ With stylesheets set:
 #### The editor has components
 
 The component is made of a show and and edit.
-
+The component has to be registered in order to be addable to the page.
 In the edit, the component description looks like:
 ```
 {
@@ -173,6 +183,21 @@ In the edit, the component description looks like:
   }
 }
 ```
+The name and thumbs are used in the list of components, whereas the data is what will be injected in the page when component is added.
+
+To register a component, the code is:
+```javascript
+  angular.injector(['ng', 'Promethee']).get('definitions').push({
+    name: 'Image',
+    thumb: 'http://via.placeholder.com/300x200',
+    data: {
+      type: 'image',
+      attributes: {
+        src: 'https://source.unsplash.com/random/1920x1080'
+      }
+    }
+  });
+```
 
 #### The editor previews in an iframe
 
@@ -181,6 +206,70 @@ When you send your data, it renders the page in the default layout.
 
 This is used to generate a live responsive preview.
 
+### Render localized (l10n)
+
+The page can be localized.
+
+The localization data looks like:
+```
+@localization.data = {
+  locale: 'fr',
+  components: [
+    {
+      id: '9lebjl4j6',
+      type: 'text',
+      version: 1,
+      master_version: 1,
+      attributes: {
+        body: '<p><b>Ceci</b> est un texte</p>'
+      }
+    }
+  ]
+}
+```
+
+The view is:
+
+```erb
+<%= promethee @page.data, l: @localization.data %>
+```
+
+Which renders to:
+
+```html
+<div class="promethee">
+  <div class="row promethee__component promethee__component--row">
+    <div class="col-md-4 promethee__component promethee__component--col">
+      <div class="promethee__component promethee__component--text">
+        <p><b>Ceci</b> est un texte</p>
+      </div>
+      <div class="promethee__component promethee__component--image">
+        <img src="https://c1.staticflickr.com/5/4089/4975306844_f849232195_b.jpg" alt="Prométhée">
+      </div>
+    </div>
+  </div>
+</div>
+```
+
+### Edit localization
+
+```erb
+<%= form_for @localization do |f| %>
+  <%= f.promethee_localizer :data, master: @page.data %>
+  <%= f.submit %>
+<% end %>
+```
+
+This would do quite the same thing:
+
+```erb
+<form action="/localization" method="post">
+  <%= promethee_localizer :localization, :data, localization_data: @localization.data, master_data: @page.data %>
+  <input type="submit">
+</form>
+```
+
+
 ### Roadmap
 - ~~Gem setup~~
 - ~~renderer helper~~

data/app/views/promethee/_edit.html.erb

@@ -29,14 +29,13 @@ data = data.to_json unless data.is_a? String
     // Data (TODO use Adder and probably page definition to init)
     if (data === null || data === '') {
       data = {
+        id: '',
         type: 'page', 
+        version: 1,
         children: []
       };
     }
     $scope.data = data;
-    // $scope.component = {
-    //   children: data
-    // };
 
     // Preview modes
     $scope.fullscreen = false;

data/app/views/promethee/_show.html.erb

@@ -1,5 +1,7 @@
 <%
-data = JSON.parse data, symbolize_names: true if data.is_a? String
+master_data = Promethee::Data.prepare data
+l = Promethee::Data.prepare l
+Promethee::Localization.localize! master_data, l unless l.nil?
 %>
 <div class="promethee">
   <%= render 'promethee/components/page', page: data %>

data/lib/promethee.rb

@@ -18,4 +18,7 @@ module Promethee
   require 'promethee/core_ext/tags'
   require 'promethee/core_ext/form_helper'
   require 'promethee/core_ext/form_builder'
+
+  require 'promethee/data'
+  require 'promethee/localization'
 end

data/lib/promethee/core_ext/tags.rb

@@ -6,7 +6,8 @@ module ActionView
       # https://github.com/rails/rails/blob/bdc581616b760d1e2be3795c6f0f3ab4b1e125a5/actionview/lib/action_view/helpers/tags/text_field.rb
       class PrometheeEditor < Base
         def render
-          data = @options[:value]
+          data = object.send @method_name unless object.nil?
+          data = @options[:value] if @options.include? :value
           ApplicationController.renderer.render partial: 'promethee/edit', locals: { data: data }
         end
       end

data/lib/promethee/data.rb

@@ -0,0 +1,9 @@
+class Promethee::Data 
+  def self.prepare(data)
+    if data.is_a? String
+      JSON.parse data, symbolize_names: true 
+    else
+      data
+    end
+  end
+end

data/lib/promethee/localization.rb

@@ -0,0 +1,7 @@
+class Promethee::Localization 
+  def self.localize!(master_data, localization_data)
+    localized_components = localization_data[:components].select { |component| component[:id] == master_data[:id] }.first
+    master_data[:attributes].merge! localized_components[:attributes] unless localized_components.nil?
+    master_data[:children].each { |d| localize! d, localization_data } unless master_data[:children].nil?
+  end
+end

data/lib/promethee/rails/helper.rb

@@ -1,26 +1,9 @@
 module Promethee::Rails::Helper
-  def promethee(data)
-    ApplicationController.renderer.render partial: 'promethee/show', locals: { data: data }
-  end
-
-  def promethee_template(type)
-    render "/promethee/#{'components/' unless [:component, :components].include? type.to_s.to_sym }#{type}_edit"
-  end
-
-  def promethee_templates
-    Promethee::Component.types.map{ |type| promethee_template type }.join.html_safe
+  def promethee(data, options = {})
+    ApplicationController.renderer.render partial: 'promethee/show', locals: { data: data, l: options[:l] }
   end
 
   def promethee_class_for component
     "promethee__component promethee__component--#{component[:type]}"
   end
-
-  def promethee_editor_for(type)
-    component_class = type.to_s.classify
-    component = type[0].downcase + type[1..-1]
-
-    content_tag :div, 'ng-controller': "#{component_class} as #{component}", 'ng-init': "#{component}.data = data" do
-      concat yield(Promethee::Component.as(type))
-    end
-  end
 end

data/lib/promethee/rails/version.rb

@@ -1,5 +1,5 @@
 module Promethee
   module Rails
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: promethee
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Julien Dargelos
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-22 00:00:00.000000000 Z
+date: 2017-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -247,6 +247,8 @@ files:
 - lib/promethee/core_ext/form_builder.rb
 - lib/promethee/core_ext/form_helper.rb
 - lib/promethee/core_ext/tags.rb
+- lib/promethee/data.rb
+- lib/promethee/localization.rb
 - lib/promethee/rails/engine.rb
 - lib/promethee/rails/helper.rb
 - lib/promethee/rails/version.rb
@@ -271,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Bring fire to your page