micro_cms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30b5c1e55c3ca21195b3f9564e0d2b5a56b499450b349167469f345aa5a49485
+  data.tar.gz: bf95432f342ceedff1dfe24da3eeda9d41e24d7bd2874172bce099a4c836e903
+SHA512:
+  metadata.gz: bf74071bb121573869b82a8c90dc6f8ef13feb0fdd26394f8e53dbe66a17cf2d9b76f10bedb4b2787f073dca0828334f91e80bfeb379f66d4a9891e5c7e042bb
+  data.tar.gz: 51db9356c673799b72531e960520ae7b9c86747a41e28224ef438f2dca2fdca873fc350e424089b2caa2efb0206f864fc5659f4ba1001609100ae5920f7bcf05

data/README.md

@@ -0,0 +1,74 @@
+# MicroCms
+Provides editable inline content blocks to modify your content on the fly.
+
+## Dependencies
+* [`ckeditor`](https://github.com/galetahub/ckeditor) gem.
+* jQuery 
+
+## Usage
+To provide an editable content block, use the `cms_block` helper method in your view, e.g.:
+```slim
+= cms_block 'my.unique.block.identifier'
+  h1 Default
+  p This is my default content
+```
+
+To print the content in readonly mode, use the `cms_content` helper method in your view, e.g:
+```slim
+= cms_content 'my.unique.block.identifier'
+  p My content if there's no content block yet
+```
+
+It's best to write an own helper method which also does authentication like
+```ruby
+def cms(path, &block)
+  if current_user&.write_cms?
+    cms_block(path, &block)
+  else
+    cms_content(path, &block)
+  end
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'micro_cms'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install micro_cms
+```
+
+In your app, run 
+```bash
+bin/bundle exec rake micro_cms:install:migrations
+bin/rails db:migrate
+```
+to copy the migrations.
+
+Require the JavaScript (e.g. `//= require micro_cms`) and all styles (e.g. `@import 'micro_cms';'`).
+
+Mount the engine routes in you `config/routes.rb` file:
+```ruby
+mount MicroCms::Engine => '/micro_cms'
+```
+
+## Configuration
+`app/config/initializers/micro_cms.rb`:
+
+```ruby
+MicroCms.configure do |config|
+  config.ckeditor_configuration_file = 'ckeditor/config.js' # Custom ckeditor config. Optional
+end
+```
+
+## 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,24 @@
+# frozen_string_literal: true
+
+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    = 'MicroCms'
+  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'

data/app/assets/config/micro_cms_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/micro_cms .css

data/app/assets/javascripts/micro_cms.js

@@ -0,0 +1,51 @@
+(function($) {
+  CKEDITOR.disableAutoInline = true;
+
+  var setupMicroCms = function() {
+    for (var instance in CKEDITOR.instances) {
+      if (!CKEDITOR.instances.hasOwnProperty(instance)) {
+        break;
+      }
+
+      CKEDITOR.instances[instance].on('blur', function(event) {
+        event.editor.updateElement();
+        var element = event.editor.element.$;
+        var updateUrl = element.getAttribute('data-update-url');
+        var authorizationToken = element.getAttribute('data-authorization-token');
+        window.e = event;
+
+        var data = new FormData();
+        data.append('micro_cms_content_block[content]', event.editor.getData());
+        data.append('micro_cms_content_block[authorization_token]', authorizationToken);
+
+        function blink(className) {
+          $(element).addClass(className);
+          setTimeout(function () {
+            $(element).removeClass(className);
+          }, 1000);
+        }
+
+        Rails.ajax({
+          type: 'PATCH',
+          url: updateUrl,
+          dataType: 'json',
+          contentType: 'multipart/form-data',
+          data: data,
+          success: function(e) {
+            blink('successful');
+          },
+          error: function(e) {
+            console.error(e);
+            blink('error');
+          },
+        })
+      });
+    }
+  };
+
+  window.addEventListener('load', setupMicroCms);
+
+  if ('Turbolinks' in window && Turbolinks.supported) {
+    $(document).on('turbolinks:load', setupMicroCms);
+  }
+})(jQuery);

data/app/assets/stylesheets/micro_cms/micro_cms.css

@@ -0,0 +1,30 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+@keyframes blinkGreen {
+  from {
+    background: #66ff66
+  }
+  to {
+    background: transparent
+  }
+}
+
+@keyframes blinkRed {
+  from {
+    background: #ff6666
+  }
+  to {
+    background: transparent
+  }
+}
+
+.content-block.successful {
+  animation: 1s blinkGreen ease-in;
+}
+
+.content-block.error {
+  animation: 1s blinkRed ease-in;
+}

data/app/controllers/micro_cms/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module MicroCms
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/micro_cms/content_block_controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_dependency 'micro_cms/application_controller'
+
+module MicroCms
+  class ContentBlockController < ApplicationController
+    def update
+      check_authorization_token
+
+      respond_to do |format|
+        format.js do
+          ContentBlock.find_by!(path: params[:path]).update(content: content_block_params[:content])
+
+          head :no_content
+        end
+      end
+    end
+
+    private
+
+    def check_authorization_token
+      token = content_block_params[:authorization_token]
+
+      raise ActiveRecord::RecordNotFound unless token == MicroCms.authorization_token
+    end
+
+    def content_block_params
+      params.require(:micro_cms_content_block).permit(:content, :authorization_token)
+    end
+  end
+end

data/app/helpers/micro_cms/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MicroCms
+  module ApplicationHelper
+  end
+end

data/app/helpers/micro_cms/cms_block_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MicroCms
+  module CmsBlockHelper
+    def cms_block(path, default = nil, &block)
+      content_block = content_block_for_path(path, default: capture_default(default, &block))
+
+      render partial: 'micro_cms/content_block', locals: { content_block: content_block }
+    end
+
+    def cms_content(path, default = nil, &block)
+      content_block = content_block_for_path(path, default: capture_default(default, &block))
+
+      content_tag :div, content_block.content, nil, false
+    end
+
+    private
+
+    def content_block_for_path(path, default:)
+      MicroCms::ContentBlock.content_block_for_path path, content: default || ''
+    end
+
+    def capture_default(default)
+      default = capture { yield } if block_given? && default.nil?
+      default
+    end
+  end
+end

data/app/models/micro_cms/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module MicroCms
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/micro_cms/content_block.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module MicroCms
+  class ContentBlock < ApplicationRecord
+    validates :path, presence: true
+    validates :content, exclusion: { in: [nil] }
+
+    def self.table_name_prefix
+      'micro_cms_'
+    end
+
+    def self.format_path(i18n_key)
+      "#{i18n_key.parameterize}-#{I18n.locale}"
+    end
+
+    def self.content_block_for_path(path, content: '')
+      ContentBlock.find_or_create_by(path: format_path(path)) do |content_block|
+        content_block.content = content
+      end
+    end
+
+    def to_param
+      path
+    end
+  end
+end

data/app/views/micro_cms/_content_block.html.erb

@@ -0,0 +1,19 @@
+<div
+  class="content-block"
+  contenteditable="true"
+  id="<%= content_block.path %>"
+  data-update-url="<%= MicroCms::Engine.routes.url_helpers.content_block_path(content_block) %>"
+  data-authorization-token="<%= MicroCms.authorization_token %>"
+>
+  <%= raw content_block.content %>
+</div>
+
+<script type="text/javascript" charset="utf-8">
+  <% if MicroCms.ckeditor_configuration_file.present? %>
+    var config = { customConfig: "<%= asset_path(MicroCms.ckeditor_configuration_file) %>" };
+  <% else %>
+    var config = undefined;
+  <% end %>
+
+  CKEDITOR.inline('<%= content_block.path %>', config);
+</script>

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+MicroCms::Engine.routes.draw do
+  resources :content_block, only: :update, param: :path
+end

data/db/migrate/20190923103919_create_micro_cms_content_blocks.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class CreateMicroCmsContentBlocks < ActiveRecord::Migration[5.2]
+  def change
+    create_table :micro_cms_content_blocks do |t|
+      t.string :path, null: false
+      t.text :content, null: false, default: ''
+
+      t.timestamps
+    end
+  end
+end

data/lib/micro_cms.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'micro_cms/engine'
+
+module MicroCms
+  mattr_accessor :ckeditor_configuration_file
+  @ckeditor_configuration_file = nil
+
+  mattr_accessor :authorization_token
+  @authorization_token = nil
+
+  def self.configure
+    yield self
+  end
+end

data/lib/micro_cms/engine.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MicroCms
+  class Engine < ::Rails::Engine
+    isolate_namespace MicroCms
+
+    config.generators do |generators|
+      generators.test_framework :rspec
+      generators.fixture_replacement :factory_bot
+      generators.factory_bot dir: 'spec/factories'
+    end
+
+    initializer 'micro_cms.include_view_helpers' do |_app|
+      ActiveSupport.on_load :action_view do
+        ActionView::Base.public_send :include, MicroCms::CmsBlockHelper
+      end
+    end
+
+    initializer 'micro_cms.configure_authorization_token' do |_app|
+      MicroCms.configure do |config|
+        config.authorization_token = SecureRandom.urlsafe_base64
+      end
+    end
+  end
+end

data/lib/micro_cms/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MicroCms
+  VERSION = '0.1.0'
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link micro_cms_manifest.js

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end