clapton 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 412ab8109c5fd546ff0bc9a48546fc0bec121e7d8f8239aebd40f970d552e275
-  data.tar.gz: f041c1a17ad5651a1d90404086f0f225492f1cfe2a7f3557fb0f5862fe835d99
+  metadata.gz: '00186fb4222527f33913e8cb95ceff617bff3da3de2ffcf8f460e2b6bfa0b650'
+  data.tar.gz: f6d46d7d1a833dea7fe9720b740fcf23f012a523193c16439b398bcb2f65b842
 SHA512:
-  metadata.gz: 419b8d916d31b1b0460f960fb739a49b9f6e5ec5d5014f7089eaeb8cad9cc5ffd6cdffe255b83be07d141642ee167db00720d7537d31fffb7a614d41b46c2270
-  data.tar.gz: 4ba17a68785e298a67681ade8d6ef368340e08eea877684e368360b714af30ae660bc997f1f885af5131149a153a666d18126c1838841055a01063c6aeda079b
+  metadata.gz: d05d1b054991b838e9ed03daea64f2c99e65dea75fea16eb0f5ada880f537ebfd5ce0198524d8bf19ef3bded8e037b1325943a0228d1e85b0ee628f69358f419
+  data.tar.gz: 2c941d1d8bbd0170503a3b19b0af35f08ee983673c45ff10c77d8198e795c89d53fbea43321d80a696c8e16806d274271c8e8c33932398268d68bca1bb59b42c

data/README.md

@@ -1,7 +1,13 @@
 # Clapton
 Clapton is a Ruby on Rails gem for building web apps with pure Ruby only (no JavaScript and no HTML templates).
 
-# Installation
+## Stack
+
+- Ruby on Rails
+- Action Cable (WebSocket)
+- [Ruby2JS](https://www.ruby2js.com/) (for compiling Ruby to JavaScript)
+
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -125,6 +131,17 @@ mount Clapton::Engine => "/clapton"
 
 ![TODO APP DEMO](./docs/todo-app-demo.gif)
 
+### Generate Component and State
+
+```bash
+rails generate clapton TaskList
+```
+
+After running the generator, you will see the following files:
+
+- `app/components/task_list_component.rb`
+- `app/states/task_list_state.rb`
+
 ### Preset Components
 
 ```ruby
@@ -277,6 +294,16 @@ end
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/dev` to start the development server.
 
+### Testing
+
+Run `bundle exec rake test` to run the test suite.
+
+Run `cd test/dummy && bundle exec rake test` to run the test suite for the dummy app.
+
+Run `cd test/dummy && bundle exec rspec` to run the test suite for the dummy app with RSpec.
+
+Run `cd lib/clapton/javascripts && npm run test` to run the test suite for the JavaScript part.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/kawakamimoeki/clapton. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/kawakamimoeki/clapton/blob/main/CODE_OF_CONDUCT.md).

data/lib/clapton/version.rb

@@ -1,3 +1,3 @@
 module Clapton
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/clapton.rb

@@ -5,6 +5,7 @@ require "clapton/engine"
 require "clapton/state"
 require "clapton/test_helper/rspec"
 require "clapton/test_helper/minitest"
+require "rails/generators/clapton_generator"
 
 module Clapton
 end

data/lib/rails/generators/clapton_generator.rb

@@ -0,0 +1,23 @@
+require "rails/generators"
+
+module Rails
+  module Generators
+    class ClaptonGenerator < Rails::Generators::NamedBase
+      def create_component_file
+        create_file "app/components/#{file_name}_component.rb" do
+          <<~RUBY
+          class #{class_name}Component < Clapton::Component
+          end
+          RUBY
+        end
+
+        create_file "app/states/#{file_name}_state.rb" do
+          <<~RUBY
+          class #{class_name}State < Clapton::State
+          end
+          RUBY
+        end
+      end 
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clapton
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Moeki Kawakami
@@ -104,7 +104,6 @@ files:
 - lib/clapton/engine.rb
 - lib/clapton/javascripts/dist/client.js
 - lib/clapton/javascripts/dist/components.js
-- lib/clapton/javascripts/dist/index.js
 - lib/clapton/javascripts/node_modules/@adobe/css-tools/LICENSE
 - lib/clapton/javascripts/node_modules/@adobe/css-tools/Readme.md
 - lib/clapton/javascripts/node_modules/@adobe/css-tools/dist/index.cjs
@@ -6696,6 +6695,7 @@ files:
 - lib/clapton/test_helper/minitest.rb
 - lib/clapton/test_helper/rspec.rb
 - lib/clapton/version.rb
+- lib/rails/generators/clapton_generator.rb
 - lib/tasks/clapton_tasks.rake
 homepage: https://github.com/kawakamimoeki/clapton
 licenses: