lizarb 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4e73803f6fe207c86ff2e6799e3bdbe50979bbe9fb409750c067ef6ce299c5b
-  data.tar.gz: 46c590ae60a43c0fd0b901f800da5f8761cc70baae0ace96e64a772941c6512f
+  metadata.gz: 53e926fac5423110d8a9468bac9598dbe3a88922c61ac584311dc2b9a49ce81f
+  data.tar.gz: 0a2e15f3cd064944b01d02a8761fca520a3167172c7193c00f7c5d807e0e88ba
 SHA512:
-  metadata.gz: 1c83f9babff78a0487784c8c62bf98cf3dd44e64a01267c57bcb1bd4938c980ec09759f4069ef6819088511e25ef6e29f6acc3920ae950c71d00e43d362970c9
-  data.tar.gz: 043bbe7ac4dc5102f3a2b8b261ff13e7a8784d6217a5474b40d8110005b4060d281cf73f938172e0487564c80427d7f63f3e2c1df6c9a3b252f6fd214052070a
+  metadata.gz: ba9279ab0d31e64b01d41d764542a73465171497950a681119ecc2a2c8f01a66f04172dc67617b03c92a04302c8772c88209f5803053cf1c405216ac5cb003d9
+  data.tar.gz: 5b27e32f1f16dd6c2536c4ad6046bb782a9eb20a8e8c9f68d7b6ab412950a464367193b435e801f9c3b442120414ad0cf7b8f034c3fae40b9050efebcf2cfe17

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.2.0

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.0

data/Gemfile

@@ -25,4 +25,5 @@ group :web do
   gem "rack", "~> 3.0"
   gem "rackup", "~> 0.2.2"
   gem "puma", "~> 5.6"
+  gem "htmlbeautifier", "~> 1.4"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lizarb (1.0.1)
+    lizarb (1.0.3)
       colorize (~> 0.8)
       dotenv (~> 2.8)
       zeitwerk (~> 2.6)
@@ -13,7 +13,9 @@ GEM
     colorize (0.8.1)
     connection_pool (2.3.0)
     dotenv (2.8.1)
+    htmlbeautifier (1.4.2)
     method_source (1.0.0)
+    mini_portile2 (2.8.1)
     nio4r (2.5.8)
     pry (0.14.1)
       coderay (~> 1.1)
@@ -29,16 +31,17 @@ GEM
       redis-client (>= 0.9.0)
     redis-client (0.10.0)
       connection_pool
-    sqlite3 (1.5.3-arm64-darwin)
-    sqlite3 (1.5.3-x86_64-linux)
+    sqlite3 (1.5.4)
+      mini_portile2 (~> 2.8.0)
     webrick (1.7.0)
-    zeitwerk (2.6.1)
+    zeitwerk (2.6.7)
 
 PLATFORMS
   arm64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
+  htmlbeautifier (~> 1.4)
   lizarb!
   pry (~> 0.14.1)
   puma (~> 5.6)

data/README.md

@@ -6,97 +6,56 @@ Liza is a light, experimental framework primarily developed to help study the Ru
 
 Install the gem by executing:
 
-    $ gem install lizarb
+    gem install lizarb
 
 You will get the following three shims:
 
-    $ lizarb version
-    $ liza version
+    lizarb version
+    liza version
+    lrb version
 
-## Try
-
-Try Liza with an interactive prompt
-
-    $ liza dev
-
-## Running Tests
-
-Run your Liza tests
-
-    $ liza test
-
-## Happy
-
-Try Liza and build an ASCII game
+## Create a liza app
 
-    $ liza happy axo
+So you can run your experiments:
 
-## Networking
+    liza new
 
-Try Liza to connect with Sqlite and Redis
+Then enter your automagically generated liza app:
 
-    $ liza net
+    cd app_1
+    bundle install
 
-```ruby
+Now you're ready to go and try some stuff!
 
-NetBox.clients.get :sqlite
-NetBox.clients.get :redis_url
-
-NetBox.databases.sql
-NetBox.databases.sqlite
-NetBox.databases.redis
-
-RedisDb.current
-SqliteDb.current
-
-RedisDb.current.call "TIME"
-SqliteDb.current.call "SELECT name, sql FROM sqlite_master WHERE type = 'table';"
-
-```
-
-## Web Server
+## Try
 
-Try Liza with the Rack Web Server
+Try Liza with an interactive terminal
 
-    $ liza web
+    liza terminal
 
-http://localhost:3000/
-  
-http://localhost:3000/xxxxxxx
-  
-http://localhost:3000/api/xxxxxxx
-  
-http://localhost:3000/api/auth/sign_up
-  
-http://localhost:3000/api/auth/sign_in
-  
-http://localhost:3000/api/auth/account
-  
-http://localhost:3000/api/auth/sign_out
-  
-http://localhost:3000/assets/app.css
-  
-http://localhost:3000/assets/app.js
+## Running Tests
 
-## Usage
+Run your Liza tests
 
-TODO: Write usage instructions here
+    liza test
 
 ## Development
 
 To install dependencies, run this bash script:
 
-    $ bin/setup
+    bin/setup
 
 For development experiments, use the local executable script
 
-    $ exe/lizarb test
+    exe/lizarb test
 
 To build and install lizarb in your local machine
 
-    $ bundle exec rake install
+    bundle exec rake install
+
+For systems in development, see [README_SYSTEMS.md](https://github.com/rubyonrails-brasil/lizarb/blob/master/README_SYSTEMS.md).
 
-## Release    
+## Release
 
 To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/README_SYSTEMS.md

@@ -0,0 +1,80 @@
+# Liza - Systems in Development
+
+These systems operate at a very small capacity, and will be fleshed out in the future.
+
+## Happy
+
+Try Liza and build an ASCII game
+
+    liza happy axo
+
+## Networking
+
+Try Liza to connect with Sqlite and Redis
+
+    liza net
+
+```ruby
+
+NetBox.clients.get :sqlite
+NetBox.clients.get :redis_url
+
+NetBox.databases.sql
+NetBox.databases.sqlite
+NetBox.databases.redis
+
+RedisDb.current
+SqliteDb.current
+
+RedisDb.current.call "TIME"
+SqliteDb.current.call "SELECT name, sql FROM sqlite_master WHERE type = 'table';"
+
+```
+
+## Rack Web Server
+
+Try Liza with the Rack Web Server
+
+    liza rack
+
+http://localhost:3000/
+
+http://localhost:3000/xxxxxxx
+
+http://localhost:3000/api/xxxxxxx
+
+http://localhost:3000/api/auth/sign_up
+
+http://localhost:3000/api/auth/sign_in
+
+http://localhost:3000/api/auth/account
+
+http://localhost:3000/api/auth/sign_out
+
+http://localhost:3000/assets/app.css
+
+http://localhost:3000/assets/app.js
+
+## Web Request
+
+Try Liza with the Rack Web Server
+
+    liza request get /
+
+    liza request post /
+
+    liza request get /xxxxxxx
+
+    liza request get /api/xxxxxxx
+
+    liza request get /api/auth/sign_up
+
+    liza request get /api/auth/sign_in
+
+    liza request get /api/auth/account
+
+    liza request get /api/auth/sign_out
+
+    liza request get /assets/app.css
+
+    liza request get /assets/app.js

data/Rakefile

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+task default: %i[] do
+  system "lizarb test"
+end

data/app/dev/benches/loops_bench.rb

@@ -70,6 +70,24 @@ class LoopsBench < AppBench
     end
   end
 
+  mark "HASH_INT.each_pair do |i, iv|" do
+    HASH_INT.each_pair do |i, iv|
+      a = "1"
+    end
+  end
+
+  mark "HASH_STR.each_pair do |i, iv|" do
+    HASH_STR.each_pair do |i, iv|
+      a = "1"
+    end
+  end
+
+  mark "HASH_SYM.each_pair do |i, iv|" do
+    HASH_SYM.each_pair do |i, iv|
+      a = "1"
+    end
+  end
+
   mark "RANGE.map do |i|" do
     RANGE.map do |i|
       a = "1"
@@ -112,6 +130,17 @@ class LoopsBench < AppBench
     end
   end
 
+  mark "1.upto N next" do
+    it = 1.upto N
+    begin
+      it.next while true
+    rescue StopIteration
+    end
+    #  do |i|
+    #   a = "1"
+    # end
+  end
+
   mark "loop break" do
     i = 0
 
@@ -129,6 +158,12 @@ class LoopsBench < AppBench
     end
   end
 
+  mark "while inline" do
+    i = 0
+
+    a = "1" while (i += 1) <= N
+  end
+
   mark "begin end while" do
     i = 0
 

data/app/dev/commands/calculator_command.rb

@@ -0,0 +1,69 @@
+class CalculatorCommand < NarrativeMethodCommand
+  class Error < Error; end
+
+  def self.sum(a, b)= a + b
+  def self.sub(a, b)= a - b
+  def self.mul(a, b)= a * b
+  def self.div(a, b)= a / b
+
+  # instance methods
+
+  def validate
+    log "Called #{self}.#{__method__}"
+    raise Invalid, "liza calculator 0 + 0" if @args.size != 3
+
+    @a  = @args[0].to_f
+    @op = @args[1].to_sym
+    @b  = @args[2].to_f
+
+    log "@a  = #{@a}"
+    log "@op = #{@op}"
+    log "@b  = #{@b}"
+
+    raise Invalid, "#{@op} is not a valid operator" unless [:+, :-, :*, :/].include? @op
+  end
+
+  def perform
+    log "Called #{self}.#{__method__}"
+    @result = \
+      case @op
+      when :+ then self.class.sum(@a, @b)
+      when :- then self.class.sub(@a, @b)
+      when :* then self.class.mul(@a, @b)
+      when :/ then self.class.div(@a, @b)
+      end
+    log "RESULT: #{@result}"
+    log render "success.txt"
+  end
+
+end
+
+__END__
+
+# help.txt.erb
+
+NAME:
+
+  liza calculator
+
+DESCRIPTION:
+
+  Calculates the result of an arithmetic operation.
+
+USAGE:
+
+  liza calculator <a> <op> <b>
+
+  where <a> and <b> are numbers and <op> is one of the following operators:
+
+  +   addition
+  -   subtraction
+  *   multiplication
+  /   division
+
+EXAMPLES:
+
+  liza calculator 1 + 2
+  liza calculator 3 - 4
+  liza calculator 5 * 6
+  liza calculator 7 / 8

data/app/dev/commands/calculator_command_test.rb

@@ -0,0 +1,58 @@
+class CalculatorCommandTest < NarrativeMethodCommandTest
+
+  test :subject_class do
+    assert subject_class == CalculatorCommand
+  end
+
+  test :settings do
+    assert subject_class.log_level == :normal
+    assert subject_class.log_color == :green
+  end
+
+  test :subject_class, :sum do
+    assert subject_class.sum(1, 2) == 3
+  end
+
+  test :subject_class, :sub do
+    assert subject_class.sub(1, 2) == -1
+  end
+
+  test :subject_class, :mul do
+    assert subject_class.mul(1, 2) == 2
+  end
+
+  test :subject_class, :div do
+    assert subject_class.div(10, 2) == 5
+  end
+
+  test :validate, :valid do
+    subject = subject_class.new
+    subject.instance_variable_set :@args, ["1", "+", "2"]
+    subject.validate
+    assert subject.instance_variable_get(:@a) == 1
+    assert subject.instance_variable_get(:@op) == :+
+    assert subject.instance_variable_get(:@b) == 2
+  end
+
+  test :validate, :invalid do
+    subject = subject_class.new
+    subject.instance_variable_set :@args, ["1", "x", "2"]
+    begin
+      subject.validate
+      assert false
+    rescue CalculatorCommand::Invalid
+      assert true
+    else
+      assert false
+    end
+  end
+
+  test :perform do
+    subject = subject_class.new
+    subject.instance_variable_set :@args, ["1", "+", "2"]
+    subject.validate
+    subject.perform
+    assert subject.instance_variable_get(:@result) == 3
+  end
+
+end

data/app/dev/commands/circle_command.rb

@@ -0,0 +1,70 @@
+class CircleCommand < NarrativeMethodCommand
+  class Error < Error; end
+
+  def self.area(radius)
+    log "Called #{self}.#{__method__} with radius #{radius}"
+    log "The answer is #{radius**2}π"
+    Math::PI * radius**2
+  end
+
+  def self.circumference(radius)
+    log "Called #{self}.#{__method__} with radius #{radius}"
+    log "The answer is #{radius * 2}π"
+    2 * Math::PI * radius
+  end
+
+  # instance methods
+
+  def validate
+    log "Called #{self}.#{__method__}"
+    raise Invalid, "liza circle <formula> <radius>" if @args.size != 2
+    raise Invalid, "liza circle <formula> <radius>" if @args[0] != "area" && @args[0] != "circumference"
+
+    @formula = @args[0].to_sym
+    @radius = @args[1].to_f
+
+    log "@formula = #{@formula}"
+    log "@radius  = #{@radius}"
+
+    raise Invalid, "radius must be greater than 0" if @radius <= 0
+  end
+
+  def perform
+    log "Called #{self}.#{__method__}"
+
+    @result = \
+      case @formula
+      when :area          then self.class.area(@radius)
+      when :circumference then self.class.circumference(@radius)
+      end
+    log "RESULT: #{@result}"
+    log render "success.txt"
+  end
+
+end
+
+__END__
+
+# help.txt.erb
+
+NAME:
+
+  liza circle
+
+DESCRIPTION:
+
+  Calculates a circle formula based on the radius.
+
+USAGE:
+
+  liza circle <formula> <radius>
+
+FORMULAS:
+
+  area          - calculates the area of a circle
+  circumference - calculates the circumference of a circle
+
+EXAMPLES:
+
+  liza circle area 5
+  liza circle circumference 5

data/app/dev/commands/circle_command_test.rb

@@ -0,0 +1,76 @@
+class CircleCommandTest < NarrativeMethodCommandTest
+
+  test :subject_class do
+    assert subject_class == CircleCommand
+  end
+
+  test :settings do
+    assert subject_class.log_level == :normal
+    assert subject_class.log_color == :green
+  end
+
+  test :subject_class, :area do
+    assert subject_class.area(1) == 3.141592653589793
+  end
+
+  test :subject_class, :circumference do
+    assert subject_class.circumference(1) == 6.283185307179586
+  end
+
+  test :validate, :valid, :area do
+    subject = subject_class.new
+    subject.instance_variable_set :@args, ["area", "1"]
+    subject.validate
+    assert subject.instance_variable_get(:@radius) == 1
+  end
+
+  test :validate, :invalid, :area do
+    subject = subject_class.new
+    subject.instance_variable_set :@args, ["area", "0"]
+    begin
+      subject.validate
+      assert false
+    rescue CircleCommand::Invalid
+      assert true
+    else
+      assert false
+    end
+  end
+
+  test :validate, :valid, :circumference do
+    subject = subject_class.new
+    subject.instance_variable_set :@args, ["circumference", "1"]
+    subject.validate
+    assert subject.instance_variable_get(:@radius) == 1
+  end
+
+  test :validate, :invalid, :circumference do
+    subject = subject_class.new
+    subject.instance_variable_set :@args, ["circumference", "0"]
+    begin
+      subject.validate
+      assert false
+    rescue CircleCommand::Invalid
+      assert true
+    else
+      assert false
+    end
+  end
+
+  test :perform, :area do
+    subject = subject_class.new
+    subject.instance_variable_set :@args, ["area", "1"]
+    subject.validate
+    subject.perform
+    assert subject.instance_variable_get(:@result) == 3.141592653589793
+  end
+
+  test :perform, :circumference do
+    subject = subject_class.new
+    subject.instance_variable_set :@args, ["circumference", "1"]
+    subject.validate
+    subject.perform
+    assert subject.instance_variable_get(:@result) == 6.283185307179586
+  end
+
+end

data/app/dev/commands/narrative_method_command.rb

@@ -0,0 +1,60 @@
+class NarrativeMethodCommand < Liza::Command
+  class Error < StandardError; end
+  class Invalid < Error; end
+
+  def self.call(args)
+    log "Called #{self}.#{__method__} with args #{args}"
+    new.call(args)
+  end
+
+  # instance methods
+
+  def call(args)
+    log "Called #{self}.#{__method__} with args #{args}"
+    return help if args.empty?
+
+    @args = args
+    validate
+    perform
+  rescue StandardError => error
+    @error = error
+    handle
+  ensure
+    @result
+  end
+
+  def validate
+    raise NotImplementedError
+  end
+
+  def perform
+    raise NotImplementedError
+  end
+
+  def handle
+    log "Called #{self}.#{__method__}"
+    log render "error.txt"
+  end
+
+  def help
+    log "Called #{self}.#{__method__}"
+    log render "help.txt"
+  end
+end
+
+__END__
+
+# success.txt.erb
+
+RESULT:
+
+class      <%= @result.class %>
+value      <%= @result %>
+
+# error.txt.erb
+
+ERROR:
+
+class      <%= @error.class %>
+message    <%= @error.message %>
+backtrace  <%= @error.backtrace.select { |s| @stop = true if s.include?("/exe/lizarb:"); !defined? @stop }.join "\n           " %>

data/app/dev/commands/narrative_method_command_test.rb

@@ -0,0 +1,36 @@
+class NarrativeMethodCommandTest < Liza::CommandTest
+
+  test :subject_class do
+    assert subject_class == NarrativeMethodCommand
+  end
+
+  test :settings do
+    assert subject_class.log_level == :normal
+    assert subject_class.log_color == :green
+  end
+
+  test :validate, :not_implemented do
+    subject = subject_class.new
+    begin
+      subject.validate
+      assert false
+    rescue NotImplementedError
+      assert true
+    else
+      assert false
+    end
+  end
+
+  test :perform, :not_implemented do
+    subject = subject_class.new
+    begin
+      subject.perform
+      assert false
+    rescue NotImplementedError
+      assert true
+    else
+      assert false
+    end
+  end
+
+end