micro_cms 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30b5c1e55c3ca21195b3f9564e0d2b5a56b499450b349167469f345aa5a49485
-  data.tar.gz: bf95432f342ceedff1dfe24da3eeda9d41e24d7bd2874172bce099a4c836e903
+  metadata.gz: 9c07cc5c21d44d0bde6dfa7bde4e7b5688e7b91d89dde60cf0bdd0fd6e9f9968
+  data.tar.gz: fc83030b2ec6e131e1e06c7973cc310646494ebcdcc000e1445502231123a721
 SHA512:
-  metadata.gz: bf74071bb121573869b82a8c90dc6f8ef13feb0fdd26394f8e53dbe66a17cf2d9b76f10bedb4b2787f073dca0828334f91e80bfeb379f66d4a9891e5c7e042bb
-  data.tar.gz: 51db9356c673799b72531e960520ae7b9c86747a41e28224ef438f2dca2fdca873fc350e424089b2caa2efb0206f864fc5659f4ba1001609100ae5920f7bcf05
+  metadata.gz: dc5e6115395ff2ecf1f73cf4858eebd16278577d4e6429abd1ed3588c1ed48bf6ee8e0294b45e5ab4d83d688f5b6ec9986133b8c20a6378b785ffbb9f881e4ab
+  data.tar.gz: e4a8ddbfd248205257603b2da075bebf683f7eaa4fee68e458ba3e63c969aa81a08444d81fd88d566219afcd6eb7b8c77528a6fd121154a568461604c5f36612

data/README.md

@@ -54,13 +54,46 @@ 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'
 ```
 
+### Usage with Sprockets
+
+Require the JavaScript (e.g. `//= require micro_cms`) and all styles (e.g. `@import 'micro_cms';'`).
+
+### Usage with Webpacker
+
+Make sure that you import `rails/ujs` like that in your `application.js`:
+
+```js
+import Rails from '@rails/ujs';
+Rails.start();
+...
+window.Rails = Rails;
+```
+
+The last line makes the Rails scope global (since we inline the script, this is needed).
+
+Now you have to include the helper to your ApplicationHelper:
+
+```rb
+module ApplicationHelper
+  include MicroCms::ApplicationHelper
+  ...
+end
+```
+
+Now you can use the helper to inline the needed scripts via `app/views/layouts/application.html.slim`. It's strongly
+recommended to check first, if the user is allowed to edit (but this is not part of this gem):
+
+```rb
+- if user_signed_in? # not part of this gem!
+  = micro_cms_asset_tags
+```
+
+
 ## Configuration
 `app/config/initializers/micro_cms.rb`:
 

data/app/assets/javascripts/micro_cms.js

@@ -31,6 +31,7 @@
           dataType: 'json',
           contentType: 'multipart/form-data',
           data: data,
+          beforeSend: function() { return true; },
           success: function(e) {
             blink('successful');
           },

data/app/helpers/micro_cms/application_helper.rb

@@ -2,5 +2,19 @@
 
 module MicroCms
   module ApplicationHelper
+    # rubocop:disable Rails/OutputSafety
+    def micro_cms_asset_tags
+      js = load_gem_file 'micro_cms', 'app/assets/javascripts/micro_cms.js'
+      css = load_gem_file 'micro_cms', 'app/assets/stylesheets/micro_cms/micro_cms.css'
+      tag.script(js.html_safe) + tag.style(css)
+    end
+    # rubocop:enable Rails/OutputSafety
+
+    private
+
+    def load_gem_file(gem_name, assets_path)
+      path = File.join(Gem.loaded_specs[gem_name].full_gem_path, assets_path)
+      File.read(path)
+    end
   end
 end

data/lib/micro_cms/engine.rb

@@ -1,8 +1,16 @@
 # frozen_string_literal: true
 
+begin
+  require 'factory_bot_rails'
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+end
+
 module MicroCms
   class Engine < ::Rails::Engine
+    FACTORIES = File.expand_path('../../spec/factories', __dir__).freeze
+
     isolate_namespace MicroCms
+    config.autoload_once_paths << "#{root}/app/helpers"
 
     config.generators do |generators|
       generators.test_framework :rspec
@@ -12,7 +20,7 @@ module MicroCms
 
     initializer 'micro_cms.include_view_helpers' do |_app|
       ActiveSupport.on_load :action_view do
-        ActionView::Base.public_send :include, MicroCms::CmsBlockHelper
+        include MicroCms::CmsBlockHelper
       end
     end
 
@@ -21,5 +29,11 @@ module MicroCms
         config.authorization_token = SecureRandom.urlsafe_base64
       end
     end
+
+    if defined? FactoryBotRails
+      initializer 'mirco_cms.set_factory_paths', after: 'factory_bot.set_factory_paths' do |_app|
+        FactoryBot.definition_file_paths << FACTORIES
+      end
+    end
   end
 end

data/lib/micro_cms/version.rb

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

data/spec/dummy/log/development.log

@@ -1 +0,0 @@
-   (1.7ms)  SELECT sqlite_version(*)