reactionview 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b1821e30ed4e900360afea835cd5f11ce6c2f5bd36da5d5d0463c9805d0fb42
-  data.tar.gz: 370e23cf0377bffa8bf1a6e7ab4c5a476eae69efae7af0ae6ad1bd28c3136c3f
+  metadata.gz: 52984f3f284100d4b253bb060dd9cb87e86a43787a24dbac2a2641e3179c11ff
+  data.tar.gz: ab65023e55f476db753414fb77fb9b7a371c3fac6efe1b853602bb1d352f0545
 SHA512:
-  metadata.gz: 93fddc7f378a43d49a31b7b5f423e5d0617092d682dace850be0c43e560c606bc376263efa2ad9c7b10a530de79472c10dbf33b6a58c4adc08ee1365a93070f5
-  data.tar.gz: c8a64c04d6fdab62bd44d8b5055bb37d5dd085a3a8e1da550af331815e98223fed819fbe8e92d29fcd45ec5d7b0db5a71ab45d5e704f781377bb06cea40e4230
+  metadata.gz: 0c1956ec57530be50b225422ee7c738c6dd9afbe01ee684efba60f8527cc8d6ec0c009835d32fe8b39d83634e49d74dec18fc0c05899574f2fa9d43402af2217
+  data.tar.gz: 0f0aedfda8745ba7500df6b7ecfc6cd793ce89673c259a6d5e7d2b009e1b254dac1dd6ba5693077fa2daa7a5196984dd184c2ad38340c2a2682696a2c11a3cc6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Marco Roth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,25 +1,51 @@
-# ReActionView
+<div align="center">
+  <img alt="ReActionView - Enhanced Rails templates" style="height: 256px" height="256px" src="https://github.com/marcoroth/reactionview/blob/main/assets/reactionview.png?raw=true">
+</div>
 
-Reactive ActionView.
+<h2 align="center">ReActionView</h2>
+
+<h4 align="center">A new ActionView-compatible ERB engine with modern DX - re-imagined with <a href="https://github.com/marcoroth/herb"><code>Herb::Engine</code></a>.</h4>
+
+<div align="center">Seamless integration of Herb's HTML-aware ERB rendering engine into Rails applications. <br>Compatible with <code>.html.erb</code>, but with modern enhancements:  
+HTML validation, better error feedback, a developer-friendly debug mode, and more!</div><br/>
+
+<p align="center">
+  <a href="https://rubygems.org/gems/reactionview"><img alt="Gem Version" src="https://img.shields.io/gem/v/reactionview"></a>
+  <a href="https://reactionview.dev"><img alt="Documentation" src="https://img.shields.io/badge/documentation-available-green"></a>
+  <a href="https://github.com/marcoroth/reactionview/blob/main/LICENSE.txt"><img alt="License" src="https://img.shields.io/github/license/marcoroth/reactionview"></a>
+  <a href="https://github.com/marcoroth/reactionview/issues"><img alt="Issues" src="https://img.shields.io/github/issues/marcoroth/reactionview"></a>
+</p>
+
+<br/><br/><br/>
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Add to your Rails application:
 
 ```bash
 bundle add reactionview
+rails generate reactionview:install
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Usage
 
-```bash
-gem install reactionview
-```
+ReActionView provides two ways to use enhanced template processing:
 
-## Usage
+1. **Native `.html.herb` templates** - Automatically processed with `Herb::Engine`.
+2. **Intercept `.html.erb` templates** - Enable in config to process all HTML+ERB templates with Herb.
+
+### Configuration
 
 ```ruby
-# TODO
+# config/initializers/reactionview.rb
+
+ReActionView.configure do |config|
+  # Intercept .html.erb templates to use Herb::Engine
+  # config.intercept_erb = true
+
+  # Enable debug mode
+  config.debug_mode = Rails.env.development?
+end
 ```
 
 ## Development
@@ -35,3 +61,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/marcor
 ## Code of Conduct
 
 Everyone interacting in the ReActionView project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/reactionview/blob/main/CODE_OF_CONDUCT.md).
+
+## License 
+
+This project is available as open source under the terms of the [MIT License](https://github.com/marcoroth/reactionview/blob/main/LICENSE.txt).

data/Rakefile

@@ -3,8 +3,14 @@
 require "bundler/gem_tasks"
 require "minitest/test_task"
 require "rubocop/rake_task"
+require "rake/testtask"
 
-Minitest::TestTask.create
 RuboCop::RakeTask.new
 
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
 task default: %i[test rubocop]