magick_pen 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 633f6dc50ae8a1927437fbe609c6a69105a583c9f88fd47f9d872ed87dc73089
-  data.tar.gz: e8589f1d2ed84ce8aa1c7a390c29e55e7a2bafcd59c0c6f4b85b873a5697a535
+  metadata.gz: 32614dd059b38a9b63ee71f8391bf21ad1837229cb1a79c5d83ba2b096eb5403
+  data.tar.gz: 370cbce68f3ca3b3b018c90d55fa00bff353bb04806870f3e14b427d4b7e91b8
 SHA512:
-  metadata.gz: eb464568e6ff3dd9b71a12f7302ed8b6beb58efff5f9b2a7f98b268cb20da8e344e0dacad205d79b9734c9bbd5aef9c1b05eb8809a6af43e910345e73a5f117a
-  data.tar.gz: 644b6ffa0e3092d150a01f865e14282b6e22cb2c31036105d87d84fb83bffd336a506a55f48fa10d70daee3c2af96577a45e5a8c5db74c39d555f3ad2d33c83c
+  metadata.gz: 38c47aa9006a5c72788ce31152a6aed7f4f9a601b8186fb88fdebe89223c5d51997062ef57671697121f42e9f9cf843711744fd57e2d75850772700260e14a35
+  data.tar.gz: ce52ad0fa26bae252f8c60b9a76f5f072dfcf2c4944f3f483dad0e3b24c797175c0a83ba1dcf78f9f01b335f26ceb48288e37b2f127ce1cf51cd7e8cdc118e5a

data/README.md

@@ -1,7 +1,7 @@
 # Magick Pen
 
 Magick Penは、Railsプロジェクトに組み込んで利用できるGemのプラグインです。 
-テンプレートファイル(.erbファイル)の任意の部分を <vue-magick-pen> 〜 </vue-magick-pen> で囲むだけで、Webページから直接変更ができるようになります。
+テンプレートファイル(.erbファイル)の任意の部分を ```<vue-magick-pen> 〜 </vue-magick-pen>``` で囲むだけで、Webページから直接変更ができるようになります。
 
 また、変更内容を履歴管理していますので、過去の内容に戻すことも簡単です。
 
@@ -27,7 +27,7 @@ $ rails g magick_pen:install --with-migrate
 
 ここでは、Rails Sprocketsを使ってアセットコンパイルして利用する方法を説明します。
 
-### app/assets/stylesheets/application.css
+#### app/assets/stylesheets/application.css
 
 nodeモジュールからmagick penのcssを読み込みます。
 
@@ -41,7 +41,7 @@ nodeモジュールからmagick penのcssを読み込みます。
  */
  ```
 
-### app/assets/javascript/application.js
+#### app/assets/javascript/application.js
 
 nodeモジュールからvue.jsと magick penのVueコンポーネントを読み込みます。
 
@@ -56,7 +56,7 @@ nodeモジュールからvue.jsと magick penのVueコンポーネントを読
  ```
 
 
-### app/views/layouts/application.html.erb
+#### app/views/layouts/application.html.erb
 
 ```html
   <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %>
@@ -67,7 +67,7 @@ layouts/application.html.erb から application.jsと application.cssを読み
 
 # ページを作成する
 
-### app/views/xxxxx/index.html.erb
+#### app/views/xxxxx/index.html.erb
 
 任意のコントローラー、アクションを作成し、テンプレートファイルをマークアップします。
 
@@ -97,20 +97,17 @@ layouts/application.html.erb から application.jsと application.cssを読み
 
 マークアップのルールは以下の通りです。
 - id="magick-pen" で 囲った部分が有効になります。この範囲内であれば、何か所でも Magick Pen を埋め込めます。
-- magick penを埋め込みたい部分を <vue-magick-pen> 〜 </vue-magick-pen> で囲みます。
+- Magick Penを埋め込みたい部分を ```<vue-magick-pen> 〜 </vue-magick-pen>``` で囲みます。
 - この時、キーとなる文字列を pen-key属性に設定して下さい。
 - pen-key は (コントローラー名＋アクション名) のスコープでユニークとなるようにして下さい。別コントローラー、別アクションであれば、同じpen-keyでも別物として扱われます。
-- ページフッターやサイドバーなどサイト全体で共通に扱いたい部分でMagick Penを埋め込みたい場合は、pen-keyにプレフィックス 'g-' を付けて下さい (例：g-snippet-1)。
-- ファイルの最後に  <%= render partial: 'magick_pen/load', locals: { editable: true } %>  を記述します。
+- ページフッターやサイドバーなどサイト全体で共通に扱いたい部分にMagick Penを埋め込みたい場合は、pen-keyにプレフィックス 'g-' を付けて下さい (例：g-snippet-1)。
+- ファイルの最後に  ```<%= render partial: 'magick_pen/load', locals: { editable: true } %>```  を記述します。
 - editableが falseであれば、何もなかったように普通にページが表示されます。trueであれば編集可能になります。ユーザー権限などに応じてeditableの値をコントロールして下さい。
 - id="magick-pen" の値を変更したい場合は、'magick_pen/load' の locals に、elementを渡すことができます。
 
 ```html
 <div id="page">
-    :
-    :
-    :
-    
+    <!- your markup -->
 </div>
 <%= render partial: 'magick_pen/load', locals: { editable: true, element: '#page" } %>
 ```
@@ -131,13 +128,56 @@ Magick Penは多言語対応になっていますので、ボタン名に日本
 
 # デザインの適用
 
-FontAwesome 5 を導入することをお奨めします。FontAwesomeが利用できる環境であればそのままボタン等にアイコンが表示されます。
+[FontAwesome 5](https://fontawesome.com) を導入することをお奨めします。FontAwesomeが利用できる環境であればそのままボタン等にアイコンが表示されます。
 
-Bootstrap 4、または、Bulma を適用した場合は、各CSSフレームワークのデザインに準じて表示されます。独自デザインを適用する場合は、CSSの調整が必要になります。
+[Bootstrap 4](https://getbootstrap.com/docs/4.6/getting-started/introduction/) 、または、[Bulma](https://bulma.io) を採用している場合は、各CSSフレームワークのデザインに準じて表示されます。独自デザインを適用する場合はCSSの調整が必要になります。
 
-gemバンドル内の magick_pen/app/models/magick_pen/snippet.rb を プロジェクトにコピーして適宜変更をして下さい。snippet.rbには、
-Magick Pen内で使用するボタンのクラス名やラベル名、アイコンのクラス名が定義されています。
+デザインを修正するには、app/magick_pen/config.rb を適宜変更をして下さい。config.rbには、 Magick Pen内で使用するボタンのクラス名やラベル名、アイコンのクラス名が定義されています。
 
+```ruby
+module MagickPen
+  class Config
+    def self.default
+      {
+          date_format: "YYYY/MM/DD HH:mm",
+          select: {
+              class: "magick-pen-select",
+              label: {
+                  version: I18n.t('magick_pen.version'),
+                  original: I18n.t('magick_pen.original'),
+                  current: I18n.t('magick_pen.current'),
+              }
+          },
+          buttons: {
+              # Button Class - compatible width Bootstrap and  Bulma)
+              # Icon Class - compatible with Fontawesome 5
+              edit: {
+                  class: "btn btn-primary btn-sm button is-primary is-small",
+                  icon: "fas fa-edit",
+                  label: I18n.t('magick_pen.buttons.edit')
+              },
+              update: {
+                  class: "btn btn-primary btn-sm button is-primary is-small",
+                  icon: "fas fa-upload",
+                  label:I18n.t('magick_pen.buttons.update')
+              },
+              cancel: {
+                  class: "btn btn-secondary btn-sm button is-light is-small",
+                  icon: "fas fa-times",
+                  label: I18n.t('magick_pen.buttons.cancel')
+              },
+              preview: {
+                  class: "btn btn-primary btn-sm button is-primary is-small",
+                  icon: "fas fa-eye",
+                  label: I18n.t('magick_pen.buttons.preview')
+              }
+          }
+      }
+    end
+  end
+end
+
+```
 
 
 # サンプルプロジェクト

data/app/models/magick_pen/config.rb

@@ -0,0 +1,41 @@
+module MagickPen
+  class Config
+    def self.default
+      {
+          date_format: "YYYY/MM/DD HH:mm",
+          select: {
+              class: "magick-pen-select",
+              label: {
+                  version: I18n.t('magick_pen.version'),
+                  original: I18n.t('magick_pen.original'),
+                  current: I18n.t('magick_pen.current'),
+              }
+          },
+          buttons: {
+              # Button Class - compatible width Bootstrap and  Bulma)
+              # Icon Class - compatible with Fontawesome 5
+              edit: {
+                  class: "btn btn-primary btn-sm button is-primary is-small",
+                  icon: "fas fa-edit",
+                  label: I18n.t('magick_pen.buttons.edit')
+              },
+              update: {
+                  class: "btn btn-primary btn-sm button is-primary is-small",
+                  icon: "fas fa-upload",
+                  label:I18n.t('magick_pen.buttons.update')
+              },
+              cancel: {
+                  class: "btn btn-secondary btn-sm button is-light is-small",
+                  icon: "fas fa-times",
+                  label: I18n.t('magick_pen.buttons.cancel')
+              },
+              preview: {
+                  class: "btn btn-primary btn-sm button is-primary is-small",
+                  icon: "fas fa-eye",
+                  label: I18n.t('magick_pen.buttons.preview')
+              }
+          }
+      }
+    end
+  end
+end

data/app/models/magick_pen/snippet.rb

@@ -1,49 +1,16 @@
-class MagickPen::Snippet < ApplicationRecord
+module MagickPen
+  class Snippet < ApplicationRecord
+    has_paper_trail on: [:create, :update]
+    validates :pen_key, presence: true
+    validates_uniqueness_of :pen_key, conditions: -> { where(is_global: true) }
+    validates :action_name, presence: true, if:  ->  { is_global == false }
+    validates :controller_name, presence: true, if: -> { is_global == false }
+    validates_uniqueness_of :pen_key, scope:[ :action_name, :controller_name ], conditions: -> { where(is_global: false) }
+    validates :content, presence: true
+    validates :original_content, presence: true
 
-  has_paper_trail on: [:create, :update]
-  validates :pen_key, presence: true
-  validates_uniqueness_of :pen_key, conditions: -> { where(is_global: true) }
-  validates :action_name, presence: true, if:  ->  { is_global == false }
-  validates :controller_name, presence: true, if: -> { is_global == false }
-  validates_uniqueness_of :pen_key, scope:[ :action_name, :controller_name ], conditions: -> { where(is_global: false) }
-  validates :content, presence: true
-  validates :original_content, presence: true
-
-  class << self
-    def config
-      {
-          "date_format": "YYYY/MM/DD HH:mm",
-          "select": {
-              "class": "magick-pen-select",
-              "label": {
-                  "version": I18n.t('magick_pen.version'),
-                  "original": I18n.t('magick_pen.original'),
-                  "current": I18n.t('magick_pen.current'),
-              }
-          },
-          "buttons": {
-              "edit": {
-                  "class": "btn btn-primary btn-sm button is-primary is-small",
-                  "icon": "fas fa-edit",
-                  "label": I18n.t('magick_pen.buttons.edit')
-              },
-              "update": {
-                  "class": "btn btn-primary btn-sm button is-primary is-small",
-                  "icon": "fas fa-upload",
-                  "label":I18n.t('magick_pen.buttons.update')
-              },
-              "cancel": {
-                  "class": "btn btn-secondary btn-sm button is-light is-small",
-                  "icon": "fas fa-times",
-                  "label": I18n.t('magick_pen.buttons.cancel')
-              },
-              "preview": {
-                  "class": "btn btn-primary btn-sm button is-primary is-small",
-                  "icon": "fas fa-eye",
-                  "label": I18n.t('magick_pen.buttons.preview')
-              }
-          }
-      }
+    def self.config
+      Config.default
     end
   end
 end

data/lib/generators/magick_pen/install_generator.rb

@@ -2,6 +2,9 @@ require "rails/generators"
 
 module MagickPen
   class InstallGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../../../../app/models/magick_pen', __FILE__)
+
     class_option "with-migrate", type: :boolean
 
     def start
@@ -23,6 +26,11 @@ module MagickPen
       end
     end
 
+    def copy_config
+      file = File.join(Rails.root,'app','models','magick_pen', 'config.rb')
+      template 'config.rb', file
+    end
+
     def run_migrations
       return unless options["with-migrate"]
       puts "Running rake db:migrate"

data/lib/magick_pen/version.rb

@@ -1,3 +1,3 @@
 module MagickPen
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magick_pen
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Kazuo Matsunaga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-05 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -55,6 +55,7 @@ files:
 - README.md
 - Rakefile
 - app/controllers/magick_pen/snippets_controller.rb
+- app/models/magick_pen/config.rb
 - app/models/magick_pen/snippet.rb
 - app/views/magick_pen/_config.html.erb
 - app/views/magick_pen/_load.html.erb
@@ -82,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="