sandals 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8706dd760aa94d3533ea6c2fb18bf8d265272a3c49250e1539300e8f2d960740
-  data.tar.gz: 87590e396a533c73abc3eb6689c90481f301d84c885e344bb21148845f602baf
+  metadata.gz: 729bdd148836e2e4876915282f45c5dfb13e5ac040a45ab973a40824d4a02e09
+  data.tar.gz: b4ce94253c0bb8d5a8e7026e2c8dc5f873d748ee572756a98b240ff02e3a1f64
 SHA512:
-  metadata.gz: b5cf4873ca1ebc024b7f45c744b3d7747ace37a867b6a0c9dfb9e85861398e3bf2ff99d7a431c1e7c9d063f1df1b5a65684918fa581ab2bfcf94915e2201fe81
-  data.tar.gz: 1e17469e4cb0a3bdf878ffafc07d45e083e620a8410704c012c2cd524268e2b22d3786a6c7cf0db04e1b28707fea3198b121dbe5e0cc5b6bf7323d6d039a3705
+  metadata.gz: 1298a4d2d07e5ff4d0a09dbc446fa2f32858a043f9ea68bcd76c0be4543aceaa0292e4f469bde1048ce63d4932eee26da0eae88a715f9dffd5a7328832ec8fbf
+  data.tar.gz: e09f3194ff8c72a2c0dbab9f00f73ea7916deaca101427c617b6c5d04a307c50a95563805a2094a895288a7ae6874753f5cf45d61039b4435e216cdaabf5a9c5

data/README.md

@@ -19,12 +19,62 @@ Sandals requires Ruby 3.1 or later.
 
 ```sh
 gem install sandals
-sandals run app.rb
+sandals new hello
+sandals run hello.rb
 ```
 
 The server listens on `127.0.0.1`. All required assets are included in the gem,
 so a local app does not need an internet connection.
 
+## Quickstart
+
+Create your first application:
+
+```sh
+sandals new hello
+```
+
+This creates two files:
+
+```text
+hello.rb
+hello_test.rb
+```
+
+`hello.rb` is a small application with a text field and a greeting. Run it:
+
+```sh
+sandals run hello.rb
+```
+
+Keep Sandals running and open `hello.rb` in your editor. Change:
+
+```ruby
+title "Hello"
+```
+
+to:
+
+```ruby
+title "Hello from Ruby"
+```
+
+Save the file. The browser reloads automatically and shows the change.
+
+If the file contains a syntax or load error, Sandals keeps the last valid
+version running and reports the error with its location. Fix the file and save
+it again; the application recovers automatically.
+
+The generated test interacts with the application through visible labels and
+text. Run it with:
+
+```sh
+ruby hello_test.rb
+```
+
+The test fills in `"Your name"` and verifies that the greeting appears. It uses
+Minitest, which is installed with Sandals.
+
 ## The experience
 
 An application should normally fit in a single file:

data/lib/sandals/cli.rb

@@ -15,9 +15,11 @@ module Sandals
 
     def run
       command = @arguments.shift
-      return usage unless command == "run"
-
-      run_app
+      case command
+      when "run" then run_app
+      when "new" then new_app
+      else usage
+      end
     rescue Interrupt
       0
     rescue StandardError => error
@@ -27,6 +29,42 @@ module Sandals
 
     private
 
+    def new_app
+      name = @arguments.shift
+      raise ArgumentError, "missing app name" unless name
+      raise ArgumentError, "unexpected arguments: #{@arguments.join(' ')}" unless @arguments.empty?
+
+      base_name = name.delete_suffix(".rb")
+      unless base_name.match?(/\A[a-zA-Z0-9][a-zA-Z0-9_-]*\z/)
+        raise ArgumentError, "app name must contain only letters, numbers, underscores, or hyphens"
+      end
+
+      app_path = "#{base_name}.rb"
+      test_path = "#{base_name}_test.rb"
+      existing_path = [app_path, test_path].find { |path| File.exist?(path) }
+      raise ArgumentError, "#{existing_path} already exists" if existing_path
+
+      title = base_name.split(/[_-]+/).map(&:capitalize).join(" ")
+      File.open(app_path, File::WRONLY | File::CREAT | File::EXCL, 0o644) do |file|
+        file.write(app_template(title))
+      end
+      File.open(test_path, File::WRONLY | File::CREAT | File::EXCL, 0o644) do |file|
+        file.write(test_template(base_name))
+      end
+
+      puts "Created #{app_path}"
+      puts "Created #{test_path}"
+      puts
+      puts "Run the app:"
+      puts "  sandals run #{app_path}"
+      puts
+      puts "Run the test:"
+      puts "  ruby #{test_path}"
+      0
+    rescue Errno::EEXIST
+      raise ArgumentError, "could not create app because a generated file already exists"
+    end
+
     def run_app
       options = { open: true, port: 0 }
       parser = OptionParser.new do |opts|
@@ -40,7 +78,7 @@ module Sandals
       server = Server.new(application, port: options[:port], reload_path: path)
 
       trap("INT") { server.stop }
-      puts "Sandals está corriendo #{path}"
+      puts "Sandals is running #{path}"
       puts server.url
       open_browser(server.url) if options[:open]
       server.start
@@ -67,8 +105,51 @@ module Sandals
       system(*command, out: File::NULL, err: File::NULL)
     end
 
+    def app_template(title)
+      <<~RUBY
+        require "sandals"
+
+        Sandals.app title: "#{title}" do
+          @name = ""
+
+          view do
+            stack do
+              title "#{title}"
+
+              text_field "Your name", value: @name do |value|
+                @name = value
+              end
+
+              para "Hello, \#{@name}!" unless @name.empty?
+            end
+          end
+        end
+      RUBY
+    end
+
+    def test_template(base_name)
+      <<~RUBY
+        require "minitest/autorun"
+        require_relative "#{base_name}"
+
+        class GeneratedAppTest < Minitest::Test
+          def test_greets_the_user
+            session = Sandals.test(Sandals.application)
+
+            session.field("Your name").fill("Ada")
+
+            assert session.text?("Hello, Ada!")
+          end
+        end
+      RUBY
+    end
+
     def usage
-      warn "Usage: sandals run APP [--no-open] [--port PORT]"
+      warn <<~USAGE
+        Usage:
+          sandals new NAME
+          sandals run APP [--no-open] [--port PORT]
+      USAGE
       1
     end
   end

data/lib/sandals/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sandals
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sandals
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Benito Serna
@@ -9,6 +9,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement