panda-editor 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a96fbed654e5115930ed44a6e5561c732a36c27be96d10888989570ec4c6a705
-  data.tar.gz: 0efd2b485067e1f83d59e2903cab40279dc8830fdbe073b5ae3ae5d31346ff29
+  metadata.gz: c4aceae2a319683face212a6ab1cb17cf0796ac0d0ce5f10ccfe4adaf1ff3a76
+  data.tar.gz: 440839d76811382db14f860ed4529ea6672148a815459c817423ef734bc0a81d
 SHA512:
-  metadata.gz: 7961ae1af4bddbdd37543d7c73cffd3aaf3962cd75815c1206c6023cebc1e2e1095ac1d5de218132f4041e94eb1a3a48a02b4bc8d17f4b92655ba74c33a88427
-  data.tar.gz: '0602738109c87304058c6fd0c52cfc87f71ab19ed3fcc1b6766da150687c2bab232358395c31dbfc9e41f402377944039590defb03e3b4c0aa4ccf05e78a8298'
+  metadata.gz: ab408175021676d37abd0a62b37181cda6830c5e09324056d4bd112bee796bca5a61f5ae3c8dfdc64e9ea5134e55729b16b8343b0a57cb9b78ecb2229104d0cd
+  data.tar.gz: d6142f7cd742a6efb0f3fd810a517361cfcd5446ae8014c1699376a857b65acb388635f40f1063116baa3ab659b2cdac8e60f23c57cb19bacd8ef27287b8b43e

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format progress
+--color

data/.yamllint

@@ -0,0 +1,73 @@
+---
+extends: default
+
+rules:
+  brackets:
+    level: error
+    max-spaces-inside: 1
+  commas:
+    level: error
+    max-spaces-after: 1
+  comments:
+    level: error
+    min-spaces-from-content: 2
+  comments-indentation:
+    level: error
+  document-end:
+    level: error
+    present: false
+  document-start:
+    level: error
+    present: true
+  empty-lines:
+    level: error
+    max: 2
+    max-end: 0
+    max-start: 0
+  empty-values:
+    level: error
+    forbid-in-block-mappings: true
+    forbid-in-flow-mappings: true
+  hyphens:
+    level: error
+    max-spaces-after: 1
+  indentation:
+    level: error
+    spaces: 2
+    indent-sequences: true
+  key-duplicates:
+    level: error
+  key-ordering: disable
+  line-length:
+    level: warning
+    max: 120
+    allow-non-breakable-words: true
+    allow-non-breakable-inline-mappings: true
+  new-line-at-end-of-file:
+    level: error
+  new-lines:
+    level: error
+    type: unix
+  octal-values:
+    level: error
+    forbid-implicit-octal: true
+    forbid-explicit-octal: true
+  quoted-strings:
+    level: error
+    quote-type: double
+    required: only-when-needed
+  trailing-spaces:
+    level: error
+  truthy:
+    level: error
+    allowed-values: ["true", "false"]
+    check-keys: true
+
+ignore: |
+  vendor/
+  spec/dummy/tmp/
+  spec/dummy/log/
+  coverage/
+  node_modules/
+  .bundle/
+  tmp/

data/CHANGELOG.md

@@ -0,0 +1,69 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2025-08-12
+
+### Added
+- Full CI/CD pipeline with GitHub Actions
+  - Automated testing across Ruby 3.2, 3.3 and Rails 7.1, 7.2, 8.0
+  - StandardRB linting integration
+  - YAML validation for workflow files
+  - Security auditing with bundle-audit
+  - Code coverage reporting with Codecov
+- Automatic gem release workflow
+  - Triggers on version changes after CI passes
+  - Publishes to RubyGems automatically
+  - Creates GitHub releases with changelogs
+- Comprehensive test suite setup
+  - RSpec configuration for Rails engine testing
+  - Test helpers for HTML normalization
+  - Support for EditorJS block testing
+  - Rails view helpers integration in tests
+- Development dependencies
+  - Added rspec-rails for testing
+  - Added standard gem for code linting
+  - Added bundle-audit for security scanning
+  - Added erb_lint for template linting
+
+### Fixed
+- Test infrastructure issues
+  - Fixed Rails initialization for engine specs without dummy app
+  - Improved HTML whitespace normalization in tests
+  - Added missing ActionView helpers to test environment
+- CI/CD pipeline issues
+  - Fixed StandardRB version conflicts
+  - Resolved YAML validation errors in workflows
+  - Fixed missing test dependencies
+  - Corrected workflow trigger dependencies
+
+### Changed
+- Improved test helper methods for better HTML comparison
+- Simplified Rails test setup without requiring Sprockets
+- Updated CI matrix to include Rails 8.0 support
+
+## [0.1.0] - 2025-08-12
+
+### Initial Release
+- Extracted EditorJS functionality from Panda CMS into standalone gem
+- Core editor blocks support:
+  - Paragraph
+  - Header
+  - List (ordered and unordered)
+  - Quote
+  - Table
+  - Image
+  - Alert
+  - Embed
+- EditorJS renderer for converting block data to HTML
+- Rails engine integration
+- Importmap configuration for EditorJS assets
+- Configurable custom block renderers
+- HTML sanitization for security
+- Asset pipeline integration
+
+[0.2.0]: https://github.com/tastybamboo/panda-editor/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/tastybamboo/panda-editor/releases/tag/v0.1.0

data/config/importmap.rb

@@ -12,4 +12,4 @@ pin "@editorjs/nested-list", to: "https://cdn.jsdelivr.net/npm/@editorjs/nested-
 pin "@editorjs/quote", to: "https://cdn.jsdelivr.net/npm/@editorjs/quote@2.6.0/+esm"
 pin "@editorjs/simple-image", to: "https://cdn.jsdelivr.net/npm/@editorjs/simple-image@1.6.0/+esm"
 pin "@editorjs/table", to: "https://cdn.jsdelivr.net/npm/@editorjs/table@2.3.0/+esm"
-pin "@editorjs/embed", to: "https://cdn.jsdelivr.net/npm/@editorjs/embed@2.7.0/+esm"
+pin "@editorjs/embed", to: "https://cdn.jsdelivr.net/npm/@editorjs/embed@2.7.0/+esm"

data/lib/panda/editor/asset_loader.rb

@@ -37,8 +37,8 @@ module Panda
         private
 
         def use_compiled_assets?
-          Rails.env.production? || 
-            Rails.env.test? || 
+          Rails.env.production? ||
+            Rails.env.test? ||
             ENV["PANDA_EDITOR_USE_COMPILED_ASSETS"] == "true"
         end
 
@@ -86,7 +86,7 @@ module Panda
 
         def download_assets_from_github
           Rails.logger.info "[Panda Editor] Downloading assets from GitHub releases..."
-          
+
           begin
             release_data = fetch_latest_release
             download_release_assets(release_data["assets"])
@@ -99,7 +99,7 @@ module Panda
         def fetch_latest_release
           uri = URI(GITHUB_RELEASES_URL)
           response = Net::HTTP.get_response(uri)
-          
+
           if response.code == "200"
             JSON.parse(response.body)
           else
@@ -110,7 +110,7 @@ module Panda
         def download_release_assets(assets)
           assets.each do |asset|
             next unless asset["name"].match?(/panda-editor.*\.(js|css)$/)
-            
+
             download_asset(asset)
           end
         end
@@ -118,7 +118,7 @@ module Panda
         def download_asset(asset)
           uri = URI(asset["browser_download_url"])
           response = Net::HTTP.get_response(uri)
-          
+
           if response.code == "200"
             save_asset(asset["name"], response.body)
           end
@@ -127,7 +127,7 @@ module Panda
         def save_asset(filename, content)
           dir = Rails.root.join("public", "panda-editor-assets")
           FileUtils.mkdir_p(dir)
-          
+
           File.write(dir.join(filename), content)
           Rails.logger.info "[Panda Editor] Downloaded #{filename}"
         end
@@ -141,11 +141,11 @@ module Panda
         def copy_embedded_assets
           source_dir = Panda::Editor::Engine.root.join("public", "panda-editor-assets")
           dest_dir = Rails.root.join("public", "panda-editor-assets")
-          
+
           FileUtils.mkdir_p(dest_dir)
           FileUtils.cp_r(Dir.glob(source_dir.join("*")), dest_dir)
         end
       end
     end
   end
-end
+end

data/lib/panda/editor/engine.rb

@@ -14,7 +14,7 @@ module Panda
 
       # Allow applications to configure editor tools
       config.editor_js_tools = []
-      
+
       # Custom block renderers
       config.custom_renderers = {}
 
@@ -31,4 +31,4 @@ module Panda
       end
     end
   end
-end
+end

data/lib/panda/editor/version.rb

@@ -2,6 +2,6 @@
 
 module Panda
   module Editor
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
-end
+end

data/lib/panda/editor.rb

@@ -10,7 +10,7 @@ module Panda
     # Autoload components
     autoload :Renderer, "panda/editor/renderer"
     autoload :Content, "panda/editor/content"
-    
+
     module Blocks
       autoload :Base, "panda/editor/blocks/base"
       autoload :Alert, "panda/editor/blocks/alert"
@@ -22,4 +22,4 @@ module Panda
       autoload :Table, "panda/editor/blocks/table"
     end
   end
-end
+end

data/lib/tasks/assets.rake

@@ -3,64 +3,64 @@
 namespace :panda_editor do
   namespace :assets do
     desc "Compile Panda Editor assets for production"
-    task :compile => :environment do
+    task compile: :environment do
       require "fileutils"
-      
+
       puts "Compiling Panda Editor assets..."
-      
+
       # Create temporary directory for assets
       tmp_dir = Rails.root.join("tmp", "panda_editor_assets")
       FileUtils.mkdir_p(tmp_dir)
-      
+
       # Get version from gem
       version = Panda::Editor::VERSION
-      
+
       # Compile JavaScript
       compile_javascript(tmp_dir, version)
-      
+
       # Compile CSS
       compile_css(tmp_dir, version)
-      
+
       # Copy to public directory
       public_dir = Rails.root.join("public", "panda-editor-assets")
       FileUtils.mkdir_p(public_dir)
       FileUtils.cp_r(Dir.glob(tmp_dir.join("*")), public_dir)
-      
+
       puts "✅ Assets compiled successfully"
     end
 
     desc "Download Panda Editor assets from GitHub"
-    task :download => :environment do
+    task download: :environment do
       require "panda/editor/asset_loader"
-      
+
       puts "Downloading Panda Editor assets from GitHub..."
       Panda::Editor::AssetLoader.send(:download_assets_from_github)
       puts "✅ Assets downloaded successfully"
     end
 
     desc "Upload compiled assets to GitHub release"
-    task :upload => :environment do
+    task upload: :environment do
       require "net/http"
       require "json"
-      
+
       puts "Uploading Panda Editor assets to GitHub release..."
-      
+
       # This task would be run in CI to upload compiled assets
       # to the GitHub release when a new version is tagged
-      
+
       version = ENV["GITHUB_REF_NAME"] || "v#{Panda::Editor::VERSION}"
       token = ENV["GITHUB_TOKEN"]
-      
+
       unless token
         puts "❌ GITHUB_TOKEN environment variable required"
         exit 1
       end
-      
+
       # Find compiled assets
       assets_dir = Rails.root.join("public", "panda-editor-assets")
       js_file = Dir.glob(assets_dir.join("panda-editor-*.js")).first
       css_file = Dir.glob(assets_dir.join("panda-editor-*.css")).first
-      
+
       if js_file && css_file
         upload_to_release(js_file, version, token)
         upload_to_release(css_file, version, token)
@@ -75,28 +75,28 @@ namespace :panda_editor do
 
     def compile_javascript(tmp_dir, version)
       puts "  Compiling JavaScript..."
-      
+
       js_files = Dir.glob(Panda::Editor::Engine.root.join("app/javascript/panda/editor/**/*.js"))
-      
+
       output = js_files.map { |file| File.read(file) }.join("\n\n")
-      
+
       # Add version marker
       output = "/* Panda Editor v#{version} */\n#{output}"
-      
+
       # Write compiled file
       File.write(tmp_dir.join("panda-editor-#{version}.js"), output)
     end
 
     def compile_css(tmp_dir, version)
       puts "  Compiling CSS..."
-      
+
       css_files = Dir.glob(Panda::Editor::Engine.root.join("app/assets/stylesheets/panda/editor/**/*.css"))
-      
+
       output = css_files.map { |file| File.read(file) }.join("\n\n")
-      
+
       # Add version marker
       output = "/* Panda Editor v#{version} */\n#{output}"
-      
+
       # Write compiled file
       File.write(tmp_dir.join("panda-editor-#{version}.css"), output)
     end
@@ -107,4 +107,4 @@ namespace :panda_editor do
       puts "  Uploading #{File.basename(file)}..."
     end
   end
-end
+end

data/panda-editor.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
       (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile]) ||
+        f.end_with?(".gem")
     end
   end
   spec.bindir = "exe"
@@ -32,9 +33,9 @@ Gem::Specification.new do |spec|
   # Rails dependencies
   spec.add_dependency "rails", ">= 7.1"
   spec.add_dependency "sanitize", "~> 6.0"
-  
+
   # Development dependencies
   spec.add_development_dependency "rspec-rails", "~> 6.0"
   spec.add_development_dependency "factory_bot_rails", "~> 6.2"
-  spec.add_development_dependency "standardrb", "~> 1.0"
-end
+  spec.add_development_dependency "standard", ">= 1.35.1"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panda-editor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Panda CMS Team
@@ -66,19 +66,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6.2'
 - !ruby/object:Gem::Dependency
-  name: standardrb
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.35.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.35.1
 description: A modular, extensible rich text editor using EditorJS for Rails applications.
   Extracted from Panda CMS.
 email:
@@ -87,6 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
+- ".yamllint"
+- CHANGELOG.md
 - LICENSE
 - README.md
 - app/javascript/panda/editor/application.js
@@ -113,6 +116,7 @@ files:
 - lib/panda/editor/renderer.rb
 - lib/panda/editor/version.rb
 - lib/tasks/assets.rake
+- log/test.log
 - panda-editor.gemspec
 homepage: https://github.com/tastybamboo/panda-editor
 licenses: