c-editables 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67000a4ed5bf174a0cbfea51e09694da68e2d872d5692b93782f71fb20eb1201
+  data.tar.gz: 855f0a4fc11b87402f36e2b2130971774626037225bbb02ddac413a58602ff6f
+SHA512:
+  metadata.gz: 62d9f9027f5ca653c5ea06cb0b23934c7b7e0bb2fe556839b760777922c8476b0b95f10963856ba4fbd85a34f506487bf84db34d2ff82840e858cd2ff3c07b85
+  data.tar.gz: 2e2ccab7b63877cab2ede40bc7648455871bf18c706f53113937e1470d86eb6bebb8feb87520d7ade27765e5a2cb98c034f017974f2c4868bc31069dd6d23529

data/README.md

@@ -0,0 +1,31 @@
+# Editables
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'editables'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install editables
+```
+
+rails editables:install:migrations to run the engine's migration
+bundle exec rake editables:create_from_config to create editable objects from your config file
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Editables'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/controllers/editables/application_controller.rb

@@ -0,0 +1,5 @@
+module Editables
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/editables/fields_controller.rb

@@ -0,0 +1,28 @@
+require_dependency "editables/application_controller"
+
+module Editables
+  class FieldsController < ApplicationController
+     protect_from_forgery unless: -> { request.format.json? }, only: [:update]
+    def update
+      puts("in engine's controller")
+      respond_to do |format|
+        @field = Editables::Field.find(params[:id])
+        if @field.update(editable_fields_params)
+          # this should be changed
+          if @field.image?
+            puts("in fields.image")
+            format.js
+          else
+            format.json { render json: {}, status: 200 }
+          end
+        end
+      end
+    end
+
+    private
+
+    def editable_fields_params
+      params.require(:field).permit(:value, :image)
+    end
+  end
+end

data/app/helpers/editables/application_helper.rb

@@ -0,0 +1,25 @@
+module Editables
+  module ApplicationHelper
+    def editable_text_class
+      'editable editable-text' if current_admin
+    end
+
+    def editable_image_class
+      'editable-image' if current_admin
+    end
+
+    def url_for_image(field, image_method = :image)
+      return url_for(field.send(image_method)) if field.send(image_method).attached?
+      "https://res.cloudinary.com/dockcyr0z/image/upload/v1598369435/vb13pcfoit64mylb2zzob0pzbt1n.jpg"
+    end
+
+    def cloudinary_path(field, image_method = :image)
+      return cl_image_path(field.send(image_method).key) if field.send(image_method).attached?
+      "https://res.cloudinary.com/dockcyr0z/image/upload/v1598369435/vb13pcfoit64mylb2zzob0pzbt1n.jpg"
+    end
+
+    def data_editables(data_editable, editable_kind = :text)
+      "data-editablemodel=#{data_editable.model} data-editableroute=#{data_editable.route} data-editableparam=#{data_editable.param} data-editablekind=#{editable_kind}" if current_admin
+    end
+  end
+end

data/app/models/editables/field.rb

@@ -0,0 +1,9 @@
+module Editables
+  class Field < ApplicationRecord
+    self.table_name = "editable_fields"
+
+    belongs_to :page, class_name: "Editables::Page", foreign_key: "editable_page_id"
+    validates :label, :kind, presence: true
+    validates :label, uniqueness: { scope: :editable_page_id }
+  end
+end

data/app/models/editables/page.rb

@@ -0,0 +1,6 @@
+module Editables
+  class Page < ApplicationRecord
+    self.table_name = "editable_pages"
+    has_many :fields, class_name: "::Editables::Field", foreign_key: "editable_page_id"
+  end
+end

data/app/views/editables/fields/update.js.erb

@@ -0,0 +1,6 @@
+var target = document.querySelector('[data-editableroute="<%= field_path @field %>"]');
+<% if @field.is_image? %>
+  target.querySelector('img').src = "<%= cloudinary_path @field %>"
+<% elsif @field.is_background_image? %>
+  target.setAttribute("style", "background-image: url('<%= cloudinary_path @field  %>')")
+<% end %>

data/app/views/layouts/editables/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Editables</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "editables/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+
+Editables::Engine.routes.draw do
+  resources :fields, only: [:update]
+end

data/db/migrate/20200919073703_create_editable_pages.rb

@@ -0,0 +1,10 @@
+class CreateEditablePages < ActiveRecord::Migration[6.0]
+  def change
+    create_table :editable_pages do |t|
+      t.string :name
+      t.text :description
+      t.string :kind
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200920082203_create_editable_fields.rb

@@ -0,0 +1,11 @@
+class CreateEditableFields < ActiveRecord::Migration[6.0]
+  def change
+    create_table :editable_fields do |t|
+      t.string :label
+      t.string :kind
+      t.text :value
+      t.references :editable_page, foreign_key: true
+      t.timestamps
+    end
+  end
+end

data/lib/editables.rb

@@ -0,0 +1,7 @@
+require "editables/engine"
+require('editables/generators/editables/install_generator')
+module Editables
+
+  autoload :DataEditable, 'editables/data_editable'
+  autoload :FieldsCollection, 'editables/fields_collection'
+end

data/lib/editables/data_editable.rb

@@ -0,0 +1,13 @@
+module Editables
+  class DataEditable
+    attr_accessor :route, :model, :param, :value, :instance
+    #format :json should be dealt by the frontend api
+    def initialize(field, param = :value)
+      @route ="/#{field.class.to_s.underscore.pluralize}/#{field.id}"
+      @model = field.class.to_s.underscore.split('/').last
+      @param = param
+      @value = field.send(param)
+      @instance = field
+    end
+  end
+end

data/lib/editables/engine.rb

@@ -0,0 +1,20 @@
+module Editables
+  class Engine < Rails::Engine
+    isolate_namespace Editables
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: 'spec/factories'
+    end
+    config.before_initialize do
+      ActiveSupport.on_load(:action_view) do
+         include ApplicationHelper
+      end
+    end
+    config.after_initialize do
+      Dir.glob(Rails.root + "app/overrides/**/*_override*.rb").each do |c|
+        require_dependency(c)
+      end
+    end
+  end
+end

data/lib/editables/fields_collection.rb

@@ -0,0 +1,29 @@
+module Editables
+  class FieldsCollection
+    attr_reader :collection
+    def initialize(editables_config)
+      @collection = to_hash(editables_config)
+    end
+
+    def [](key)
+      begin
+        collection.fetch(key)
+      rescue
+        collection.fetch("editables/field").fetch(key)
+      end
+    end
+
+    private
+
+    def to_hash(editables_config)
+      hash = {}
+      editables_config.each do |param, editables|
+        hash[editables&.first&.class&.to_s&.underscore] ||= {}
+        editables.each do |editable|
+          hash[editable.class.to_s.underscore][editable.label] = ::Editables::DataEditable.new(editable, param)
+        end
+      end
+      return hash
+    end
+  end
+end

data/lib/editables/generators/editables/install_generator.rb

@@ -0,0 +1,46 @@
+require 'rails/generators'
+module Editables
+  class InstallGenerator <  Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    include Rails::Generators::Migration
+    desc "This generator creates all necessary config models and routes"
+
+    def create_page_and_editable_fields_migration
+      migration_template "migration.rb", "db/migrate/create_pages_and_fields.rb"
+    end
+
+    def create_config_file
+      config_dir_path = "config/editable"
+      Dir.mkdir(config_dir_path) unless File.exist?(config_dir_path)
+      template "config.yml", "#{config_dir_path}/config.yml"
+    end
+
+    def create_model_files
+      model_dir_path = "app/models/editables"
+      Dir.mkdir(model_dir_path) unless File.exist?(model_dir_path)
+      template "field.rb", "#{model_dir_path}/field.rb"
+      template "page.rb", "#{model_dir_path}/page.rb"
+    end
+
+    def add_editable_routes
+     editable_route  = "namespace :editables do\n\tresources :fields, only: [:update]\nend\n"
+     route editable_route
+    end
+
+    def rails5_and_up?
+      Rails::VERSION::MAJOR >= 5
+    end
+
+    def migration_version
+      if rails5_and_up?
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+    end
+    private
+
+    def self.next_migration_number(dirname)
+      next_migration_number = current_migration_number(dirname) + 1
+      ActiveRecord::Migration.next_migration_number(next_migration_number)
+    end
+  end
+end

data/lib/editables/generators/editables/templates/config.yml

@@ -0,0 +1,162 @@
+# this file is an example edit it as you wish
+pages:
+  home:
+    description: the root page of zedental
+    kind: static
+    fields:
+      hero_title:
+        kind: text
+        value: Un catalogue incisif de formations décisives pour votre carrière.
+      hero_subtitle:
+        kind: text
+        value: Masterclass, DPC, attestations universitaires, le meilleur pour votre parcours professionnel.
+      hero_background_image:
+        kind: background_image
+        value: /assets/home-hero.jpg
+      training_category_section_title:
+        kind: text
+        value: Nos formations
+      featured_trainings_section_title:
+        kind: text
+        value: Nos formations à la une
+      value_section_title:
+        kind: text
+        value: Nos valeurs
+      scientific_comity_image:
+        kind: image
+        value: /assets/card-image.jpg
+      scientific_comity_title:
+        kind: text
+        value: Comité scientifique
+      scientific_comity_description:
+        kind: text
+        value: Description du comité scientifique
+      value_1_description:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam non dictum dui. Vivamus dictum purus in mollis pretium.
+      value_1_title:
+        kind: text
+        value: value 1
+      value_2_title:
+        kind: text
+        value: value 2
+      value_2_description:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam non dictum dui. Vivamus dictum purus in mollis pretium.
+      value_3_title:
+        kind: text
+        value: value 3
+      value_3_description:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam non dictum dui. Vivamus dictum purus in mollis pretium.
+      value_4_title:
+        kind: text
+        value: value 4
+      value_4_description:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam non dictum dui. Vivamus dictum purus in mollis pretium
+  about:
+    description: page describing who we are
+    fields:
+      about_title:
+        kind: text
+        value: Qui sommes-nous ?
+      about_subtitle:
+        kind: text
+        value: Nous sommes
+      about_description:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      about_image:
+        kind: image
+        value: /assets/home-hero.jpg
+      values_title:
+        kind: text
+        value: Nos valeurs
+      value_1_title:
+        kind: text
+        value: Value 1
+      value_1_description:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      value_2_title:
+        kind: text
+        value: Value 2
+      value_2_description:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      value_3_title:
+        kind: text
+        value: Value 3
+      value_3_description:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      value_4_title:
+        kind: text
+        value: Value 4
+      value_4_description:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      story_section_title:
+        kind: text
+        value: Notre histoire
+      chapter_1_title:
+        kind: text
+        value: chapter 1
+      chapter_1_image:
+        kind: image
+        value: /assets/home-hero.jpg
+      chapter_1_description:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      chapter_2_title:
+        kind: text
+        value: Chapter 2
+      chapter_2_image:
+        kind: image
+        value: /assets/home-hero.jpg
+      chapter_2_description:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      training_categories_title:
+        kind: text
+        value: Les différentes catégories de formation
+  contact:
+    description: Contact pages
+    fields:
+      page_title:
+        kind: text
+        value: Contactez-nous
+      page_subtitle_1:
+        kind: text
+        value: Une équipe à votre écoute
+      page_description_1:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      socials_subtitle:
+        kind: text
+        value: Suivez-nous sur les réseaux sociaux
+      facebook_subtitle:
+        kind: text
+        value: Sur Facebook, trouvez ceci.
+      facebook_description:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      youtube_subtitle:
+        kind: text
+        value: Sur Youtube, trouvez ceci.
+      youtube_description:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      twitter_subtitle:
+        kind: text
+        value: Sur Youtube, trouvez ceci.
+      twitter_description:
+        kind: text
+        value: Lorem ipsum
+      contact_subtitle:
+        kind: text
+        value: Formulaire de contact
+      contact_description:
+        kind: text
+        value: Lorem ipsum dolor sit amet, consectetur adipiscing elit.