promethee 0.1.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33e5e071efd89e21816ec9dd45caa7ad47962d25
-  data.tar.gz: fabaf62dc44e7ea200fe22658246cb49d41b1598
+  metadata.gz: 2b518d1f83474f06c099c7714b4696d270cde07b
+  data.tar.gz: 5401b785dce334c87e2c3de4d005b91ee2ec9bb0
 SHA512:
-  metadata.gz: 9a9096871a8d6eedf9114aacb463f7975d1c920b3e3e6ef0276f7469a9587a4152f5f90ab46e0d30172fcb40cc330393753fec91ac4f9bc4a9f6752b736a9cd8
-  data.tar.gz: b4a7010c2a638d203ce65167ab85c82fc0b4f9d2092558b44d56b16b140825dce1eae2d08082a1edf8bd08579f488ddf66c12323a8752a9e13db15eef61800e7
+  metadata.gz: 117e2b926c3eca318925429f13c9013abf32d8f0345774747fbba7a7db084a3e2ef8f3d25b74a82839b9f3d61b85d43cbdceb48de7ebb0c35fa5a7dc8312d270
+  data.tar.gz: 4047603f08cc82901a66db5bd2a13d1f20f9f583668f995e8695d7b8e79fbab65ec7a256828c1fc1d86b8fd168ef7ad2eb53bc91ea7dba4893c4011e50a56d30

data/README.md

@@ -213,7 +213,7 @@ The page can be localized.
 The localization data looks like:
 ```
 @localization.data = {
-  locale: 'fr',
+  version: 1,
   components: [
     {
       id: '9lebjl4j6',

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

@@ -1,12 +1,11 @@
 <%
-data = data.to_json unless data.is_a? String
+promethee_data = Promethee::Data.new master_data
 %>
 
-
 <script>
   var promethee = angular
     .module('Promethee', ['summernote', 'ngAnimate'])
-    .value('data', <%= data.html_safe %>)
+    .value('data', <%= promethee_data.to_json.html_safe %>)
     .value('definitions', [])
     .filter('htmlSafe', ['$sce', function($sce) {
       return function(val) {

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

@@ -1,12 +1,16 @@
 <%
-data = data.to_json unless data.is_a? String
-master = master.to_json unless master.is_a? String
+promethee_data = Promethee::Data.new master_data, localization_data: localization_data
 %>
 
 <script>
   var prometheeLocalizer = angular
     .module('PrometheeLocalizer', ['summernote'])
-    .value('data', <%= data.html_safe %>);
+    .value('data', <%= promethee_data.localization_data_to_json.html_safe %>)
+    .filter('htmlSafe', ['$sce', function($sce) {
+      return function(val) {
+        return $sce.trustAsHtml(val);
+      };
+    }]);
 
   prometheeLocalizer.controller('PrometheeLocalizerController', ['$scope', 'data', function($scope, data) {
 
@@ -20,7 +24,7 @@ master = master.to_json unless master.is_a? String
         ['code', ['codeview']]
       ]
     };
-    
+
   }]);
 
   angular.element(function() {

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

@@ -1,8 +1,7 @@
 <%
-data = Promethee::Data.prepare data
-l = Promethee::Data.prepare l
-Promethee::Localization.localize! data, l unless l.nil?
+promethee_data = Promethee::Data.new master_data, localization_data: localization_data
 %>
+
 <div class="promethee">
-  <%= render 'promethee/components/page', page: data %>
+  <%= render 'promethee/components/page', page: promethee_data.to_h %>
 </div>

data/app/views/promethee/components/_text_edit.html.erb

@@ -19,7 +19,15 @@
 </script>
 
 <script type="text/ng-template" id="promethee/components/text/localize">
-  <summernote config="options" ng-model="component.attributes.body"></summernote>
+  <div class="row">
+    <div class="col-md-6">
+      <summernote config="options" ng-model="component.attributes.body"></summernote>
+    </div>
+    <div class="col-md-6">
+      <b>Master</b>
+      <div class="promethee-editor__wrapper" ng-bind-html="component.master.attributes.body | htmlSafe"></div>
+    </div>
+  </div>
 </script>
 
 <script>

data/lib/promethee.rb

@@ -20,5 +20,4 @@ module Promethee
   require 'promethee/core_ext/form_builder'
 
   require 'promethee/data'
-  require 'promethee/localization'
 end

data/lib/promethee/core_ext/tags.rb

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

data/lib/promethee/data.rb

@@ -1,9 +1,120 @@
-class Promethee::Data 
-  def self.prepare(data)
-    if data.is_a? String
-      JSON.parse data, symbolize_names: true 
-    else
-      data
+# The data class can be used for any level: the page, or one of the components
+module Promethee
+  class Data
+    def initialize(data, options = {})
+      @master_data = convert_if_necessary data
+      @master_data_unlocalized = deep_clone @master_data
+      localization_data = options[:localization_data]
+      unless localization_data.nil?
+        @localization_data = convert_if_necessary localization_data
+        localize!
+      end
+    end
+
+    def localization_data
+      prepare_localization
+      @localization_data
+    end
+
+    def localization_data_to_json
+      localization_data.to_json
+    end
+
+    def to_json
+      @master_data.to_json
+    end
+
+    def to_h
+      @master_data
+    end
+
+    protected
+
+    def convert_if_necessary(string_or_hash)
+      string_or_hash.is_a?(String) ? JSON.parse(string_or_hash, symbolize_names: true) : string_or_hash
+    end
+
+    def deep_clone(hash)
+      JSON.parse(hash.to_json, symbolize_names: true)
+    end
+
+    # This will recursively merge the localization_data into the master_data
+    def localize!
+      merge!
+      localize_children!
+    end
+
+    def merge!
+      @master_data[:attributes].merge! localized_component[:attributes] if localized?
+    end
+
+    # Look for localized component with the same id
+    def localized_component
+      @localized_component ||= components.select { |component| component[:id] == @master_data[:id] }.first
+    end
+
+    def components
+      @components ||= @localization_data.include?(:components) ? @localization_data[:components] : []
+    end
+
+    def localized?
+      !localized_component.nil?
+    end
+
+    def localize_children!
+      children.each do |child_hash|
+        child_data = Promethee::Data.new child_hash, localization_data: @localization_data
+        child_data.localize!
+      end
+    end
+
+    def children
+      return [] if !@master_data.include? :children or @master_data[:children].nil?
+      @master_data[:children]
+    end
+
+    def prepare_localization
+      # TODO extract localizable components from master data, in the correct order, merged with existing ones
+      # TODO update master_version
+
+      # Flattens master data, and select only text components
+      flat_master_data = self.class.flatten_components(@master_data_unlocalized[:children]).select do |component|
+        component[:type].to_sym === :text
+      end
+
+      # We add master reference
+      flat_master_data.each do |data|
+        data[:master] = data.clone
+      end
+
+      if @localization_data
+        # If localization_data has been provided, we merge flat_master_data components with its components
+        @localization_data[:components] = flat_master_data.map do |component|
+          localized_component = @localization_data[:components].find do |localized_component|
+            localized_component[:id] == component[:id]
+          end
+
+          # Update master reference
+          localized_component[:master] = component[:master] unless localized_component.nil?
+
+          localized_component || component
+        end
+      else
+        # In the other case, localization_data components are flat_master_data components
+        @localization_data = {
+          version: @master_data[:version],
+          components: flat_master_data
+        }
+      end
+    end
+
+    # This method take an array of components and puts every components and their children into a unique flat array
+    def self.flatten_components components
+      components.reduce [] do |flat_components, component|
+        flat_components +
+        [component.except(:children)] +
+        flatten_components(component[:children] || [])
+      end
     end
   end
 end

data/lib/promethee/rails/helper.rb

@@ -1,6 +1,6 @@
 module Promethee::Rails::Helper
   def promethee(data, options = {})
-    ApplicationController.renderer.render partial: 'promethee/show', locals: { data: data, l: options[:l] }
+    ApplicationController.renderer.render partial: 'promethee/show', locals: { master_data: data, localization_data: options[:l] }
   end
 
   def promethee_class_for component

data/lib/promethee/rails/version.rb

@@ -1,5 +1,5 @@
 module Promethee
   module Rails
-    VERSION = '0.1.8'
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: promethee
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Julien Dargelos
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-27 00:00:00.000000000 Z
+date: 2017-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -195,6 +195,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: annotate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - contact@juliendargelos.com
@@ -249,7 +263,6 @@ files:
 - 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
@@ -332,7 +345,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Bring fire to your page

data/lib/promethee/localization.rb

@@ -1,7 +0,0 @@
-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