simple_input 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bc4897e13a98263144b74d7f41c52a5551a5fd82137700fc81f7fef5ca27271
-  data.tar.gz: 111cec79eef33fe0c657f79d42a29020b8764880513df2839d676fc926bf96bf
+  metadata.gz: 067ce86ac266a279491b935536c473fe2b257e9a3cd3556877c7affe2be3311c
+  data.tar.gz: e0f078fa1ee462081ed0d2da0d76f44461b6e90d1d595cf1beea1186574937e6
 SHA512:
-  metadata.gz: f2a86db2a363fdef0d0b75c71b9c9b962af329a171f10ae97879a52950e6a75374ed569645217ec32356ff637f1b34ba085edf242040681be60eeed56635e335
-  data.tar.gz: 6a6b0061f158c692db24a9ab149ad79d71ea0d49adb49f43bef20973299cd40a7b7443962e45bf4ed467418ff1dd1537426362f2ad1031d68124b32f4ef6b803
+  metadata.gz: c488763914f58752e2f230e78df81e55bc88b53587218ddfeee91ac855c35ffb18a4c8260911615652c058803fd36acf2ee64a53840b704245af23d9a01da736
+  data.tar.gz: f165c355abc6a8776b38bdbc47f2b35991cee593c8ccc776304fca1cf60260186a8b361b7b559225cd2a080aebf31f4544c7eaf4e70f8f34146b23e2c8609391

data/README.md

@@ -167,6 +167,92 @@ age = Input.new_input
 
 All methods (except `#run`) return `self` for chaining.
 
+## Complete Example: Area Calculator
+
+Here's a practical example that demonstrates validation, conversion, and dependency injection for testing:
+
+```ruby
+class AreaCalculator
+  def initialize(reader = $stdin, writer = $stdout)
+    @reader = reader
+    @writer = writer
+  end
+
+  # Reusable conversion function
+  def to_number
+    ->(value) do
+      if value.to_i.to_s == value
+        value.to_i
+      elsif value.to_f.to_s == value
+        value.to_f
+      else
+        raise ArgumentError, "Invalid number: #{value}"
+      end
+    end
+  end
+
+  def input_length
+    Input.new_input
+      .send(:with_context, @reader, @writer)
+      .title('What is the length of the room in feet?')
+      .validate { |value| value.to_i > 0 ? nil : 'Length must be a positive number' }
+      .convert_func(to_number)
+      .run
+  end
+
+  def input_width
+    Input.new_input
+      .send(:with_context, @reader, @writer)
+      .title('What is the width of the room in feet?')
+      .validate { |value| value.to_i > 0 ? nil : 'Width must be a positive number' }
+      .convert_func(to_number)
+      .run
+  end
+
+  def calculate_area
+    length = input_length
+    width = input_width
+    area = length * width
+
+    @writer.puts "\nYou entered dimensions of #{length} feet by #{width} feet."
+    @writer.puts "The area is #{area} square feet"
+  end
+end
+```
+
+This example can be tested with RSpec using mocks:
+
+```ruby
+RSpec.describe AreaCalculator do
+  let(:writer) { double('writer') }
+  let(:reader) { double('reader') }
+  subject(:calculator) { AreaCalculator.new(reader, writer) }
+
+  before do
+    allow(writer).to receive(:puts)
+    allow(writer).to receive(:print)
+  end
+
+  it 'returns integer for valid integer input' do
+    allow(reader).to receive(:gets).and_return("10\n")
+
+    result = calculator.input_length
+
+    expect(result).to eq(10)
+  end
+
+  it 'returns float for valid float input' do
+    allow(reader).to receive(:gets).and_return("10.5\n")
+
+    result = calculator.input_length
+
+    expect(result).to eq(10.5)
+  end
+end
+```
+
+See `examples/area_calculator.rb` and `examples/area_calculator_spec.rb` for the complete implementation.
+
 ## Running Examples
 
 ```bash
@@ -184,6 +270,9 @@ ruby examples/validation_patterns.rb
 
 # Error handling and conversion safety
 ruby examples/error_handling.rb
+
+# Area calculator with numeric conversion (practical example)
+ruby examples/area_calculator.rb
 ```
 
 ## Testing

data/examples/area_calculator.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/simple_prompt'
+
+# Example: Area Calculator with Input Validation and Conversion
+# This example demonstrates using Input with:
+# - Custom validation for positive numbers
+# - Value conversion from string to integer/float
+# - Reusable conversion function
+
+class AreaCalculator
+  def initialize(reader = $stdin, writer = $stdout)
+    @reader = reader
+    @writer = writer
+  end
+
+  # Conversion function that converts string to appropriate numeric type
+  def to_number
+    ->(value) do
+      if value.to_i.to_s == value
+        value.to_i
+      elsif value.to_f.to_s == value
+        value.to_f
+      else
+        raise ArgumentError, "Invalid number: #{value}"
+      end
+    end
+  end
+
+  def input_length
+    Input.new_input
+      .send(:with_context, @reader, @writer)
+      .title('What is the length of the room in feet?')
+      .validate { |value| value.to_i > 0 ? nil : 'Length must be a positive number' }
+      .convert_func(to_number)
+      .run
+  end
+
+  def input_width
+    Input.new_input
+      .send(:with_context, @reader, @writer)
+      .title('What is the width of the room in feet?')
+      .validate { |value| value.to_i > 0 ? nil : 'Width must be a positive number' }
+      .convert_func(to_number)
+      .run
+  end
+
+  def calculate_area
+    length = input_length
+    width = input_width
+    area = length * width
+
+    @writer.puts "\nYou entered dimensions of #{length} feet by #{width} feet."
+    @writer.puts "The area is"
+    @writer.puts "#{area} square feet"
+    @writer.puts "#{(area * 0.09290304).round(3)} square meters"
+  end
+end
+
+# Run the calculator if this file is executed directly
+if __FILE__ == $PROGRAM_NAME
+  calculator = AreaCalculator.new
+  calculator.calculate_area
+end

data/examples/area_calculator_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative '../lib/simple_prompt'
+require_relative 'area_calculator'
+
+# Example RSpec tests for area_calculator.rb
+# This demonstrates how to test Input with mocks
+
+RSpec.describe AreaCalculator do
+  let(:writer) { double('writer') }
+  let(:reader) { double('reader') }
+  subject(:calculator) { AreaCalculator.new(reader, writer) }
+
+  before do
+    allow(writer).to receive(:puts)
+    allow(writer).to receive(:print)
+  end
+
+  describe '#input_length' do
+    it 'returns integer for valid integer input' do
+      allow(reader).to receive(:gets).and_return("10\n")
+
+      result = calculator.input_length
+
+      expect(result).to eq(10)
+    end
+
+    it 'returns float for valid float input' do
+      allow(reader).to receive(:gets).and_return("10.5\n")
+
+      result = calculator.input_length
+
+      expect(result).to eq(10.5)
+    end
+  end
+
+  describe '#input_width' do
+    it 'returns integer for valid integer input' do
+      allow(reader).to receive(:gets).and_return("20\n")
+
+      result = calculator.input_width
+
+      expect(result).to eq(20)
+    end
+
+    it 'returns float for valid float input' do
+      allow(reader).to receive(:gets).and_return("20.3\n")
+
+      result = calculator.input_width
+
+      expect(result).to eq(20.3)
+    end
+  end
+end

data/lib/simple_prompt/input.rb

@@ -10,6 +10,7 @@ class Input
 
   ValidatorProc = T.type_alias { T.proc.params(arg0: String).returns(T.nilable(String)) }
   ValidatorType = T.type_alias { T.any(Symbol, ValidatorProc) }
+  ConvertProc = T.type_alias { T.proc.params(arg0: String).returns(T.untyped) }
 
   sig { returns(Input) }
   def self.new_input; new; end
@@ -18,12 +19,13 @@ class Input
 
   sig { void }
   def initialize
-    @reader = T.let($stdin, T.any(IO, StringIO))
-    @writer = T.let($stdout, T.any(IO, StringIO))
+    @reader = T.let($stdin, T.untyped)
+    @writer = T.let($stdout, T.untyped)
     @title = T.let('', String)
     @prompt = T.let('> ', String)
     @validators = T.let([], T::Array[ValidatorProc])
     @validator_provider = T.let(DefaultValidators, T.untyped)
+    @convert_func = T.let(nil, T.nilable(ConvertProc))
   end
 
   sig { params(text: String).returns(T.self_type) }
@@ -35,6 +37,12 @@ class Input
   sig { params(provider: T.untyped).returns(T.self_type) }
   def with_validators(provider); @validator_provider = provider; self; end
 
+  sig { params(converter: T.nilable(ConvertProc), block: T.nilable(ConvertProc)).returns(T.self_type) }
+  def convert_func(converter = nil, &block)
+    @convert_func = block || converter
+    self
+  end
+
   sig { params(validator: T.nilable(ValidatorType), block: T.nilable(ValidatorProc)).returns(T.self_type) }
   def validate(validator = nil, &block)
     if block
@@ -51,7 +59,7 @@ class Input
     self
   end
 
-  sig { returns(String) }
+  sig { returns(T.untyped) }
   def run
     loop do
       @writer.puts "\e[1m#{@title}\e[0m" unless @title.empty?
@@ -64,7 +72,13 @@ class Input
       error = T.let(nil, T.nilable(String))
       @validators.each { |v| break if (error = v.call(val)) }
 
-      return val unless error
+      unless error
+        begin
+          return @convert_func ? @convert_func.call(val) : val
+        rescue StandardError => e
+          error = "Conversion error: #{e.message} (please add validation)"
+        end
+      end
 
       # 視認性のための余白
       @writer.puts ''
@@ -78,6 +92,6 @@ class Input
 
   private
 
-  sig { params(r: T.any(IO, StringIO), w: T.any(IO, StringIO)).returns(T.self_type) }
-  def with_context(r, w); @reader = r; @writer = w; self; end
+  sig { params(reader: T.untyped, writer: T.untyped).returns(T.self_type) }
+  def with_context(reader, writer); @reader = reader; @writer = writer; self; end
 end

data/lib/simple_prompt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimplePrompt
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_input
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Hiroaki Satou
@@ -104,6 +104,8 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- examples/area_calculator.rb
+- examples/area_calculator_spec.rb
 - examples/basic.rb
 - examples/convert.rb
 - examples/custom_validators.rb