better_input 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bf1091645c1a560391ce297d8782434ef4cab23082ace9dd66130713ba444c8
-  data.tar.gz: 887189e5e74a48ba84004c097964af27cd8558b8ee45c2a66dc3888e6fadf376
+  metadata.gz: 91f6acc7fd325931d683a59962503b1f3fc6dec3a829bb1752b88dcac0e27032
+  data.tar.gz: 17f6a25540c3643f6bf1173db8189489327286749b221accbcbee451cff4cbc3
 SHA512:
-  metadata.gz: 38f8acda9933caa9d733c9b9e109fd39dd58b2ad75f4825cb38501eb642a46af66a6767fa1a4a990a2dc73ca76cb3608a309595f7eb84cc7baeccb3f8a2a2e79
-  data.tar.gz: cd5675272a7f21a79c493375af3185221eada8c2b474c3570487885ae637e93dfcecf2ebe23870c319dc79d6b97524d8220d8934ed85176e45c3bb47af4ecfed
+  metadata.gz: 475f4143667b67e376c2188641d217fde1f3afdca6b14694c4ae51dd3ab226b805ef1753f29ac2297d0a93a681d322d35e7eca1ba242d55d9647d0fa219fbce4
+  data.tar.gz: c49f044e3f1799a619f0d15771a6084d9a8fb2a3ad6692cf1ab520079d124c43474a2d703e1f9ff81b2b0bd15b1f51371ae4bf0d7bf2be9607554154572b7e58

data/README.md

@@ -1,31 +1,101 @@
-# BetterInput
+# Ruby Better Input
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/better_input`. To experiment with that code, run `bin/console` for an interactive prompt.
+Whenever I tried to make an application that would be based on a command line interface (CLI) I found myself having to do some of the things included in this gem, especially when it came to "verbose", when I wanted to display a question to the user or even check if he entered the input I expected. Tired of always coding the same function I decided to make this gem.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+To install this gem just use:
+
+```shell
+gem install better_input
+```
 
-Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+## Usage
+Normally to handle user input in ruby ​you would do something like this:
+```ruby
+puts "What is your age?"
+age = gets.chomp
+```
+and then if you wanted a "verbose" input you would have to do another PUTS. And it gets even worse if you want to check if the input is of the expected type:
+```ruby
+puts "What is your age?"
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+age = nil
+loop do
+  input = gets.chomp
+  if input.match?(/^\d+$/)
+    age = input.to_i
+    break
+  else
+    puts "Please enter a valid integer for your age."
+  end
+end
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+puts "User response: #{age}"
+```
+Although it requires other approaches like the one I did in the gem. here are some examples of how it works with inputs in ruby ​​using the gem:
+```ruby
+require 'better_input'
 
-## Usage
+age = Bi.input("Digite um número: ", type: "int", show_response: true)
+# In a single line we asked the question and stored it in a variable,
+# we made sure it was the type we wanted and we even made the answer appear!
+```
+```ruby
+#Another examples:
 
-TODO: Write usage instructions here
+noquestion = Bi.input()
+retype = Bi.input(show_response: true)
+onlyfloat = Bi.input(type: float)
 
-## Development
+name = Bi.input("What is your name?")
+puts "Your name is #{name}"
+```
+Anyway, use your creativity, now receiving constant user input for CLI has become less laborious!
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Function before becoming a gem
+This was more or less the base that I ended up making, I made some small improvements that you can find in the files present in this repository before turning it into a gem.
+```ruby
+def input(question = nil, show_response: false, type: "string")
+  unless question.nil?
+    puts question
+  end
 
-To install this gem onto your local machine, run `bundle exec rake install`. 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).
+  loop do
+    var = gets.chomp
 
-## Contributing
+    if type == "int"
+      begin
+        var = Integer(var)
+      rescue ArgumentError
+        puts "Err: Please, type a (integer) number."
+        next
+      end
+    elsif type == "float"
+      begin
+        var = Float(var)
+      rescue ArgumentError
+        puts "Err: Please, type a (float) number."
+        next
+      end
+    elsif type == "bool"
+      if var.downcase == "true"
+        var = true
+      elsif var.downcase == "false"
+        var = false
+      else
+        puts "Err: Please, type 'true' or 'false'."
+        next
+      end
+    else
+      var = var
+    end
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/better_input.
+    if show_response
+      puts "User Response: #{var}"
+    end
+    return var
+  end
+end
+```

data/lib/better_input/version.rb

@@ -1,3 +1,3 @@
-module BetterInput
-  VERSION = "0.1.0"
+module Bi
+  VERSION = "0.1.2"
 end

data/lib/better_input.rb

@@ -1,4 +1,4 @@
-module BetterInput
+module Bi
   def self.input(question = nil, show_response: false, type: "string")
     unless question.nil?
       puts question
@@ -31,6 +31,10 @@ module BetterInput
           puts "Err: Please, type 'true' or 'false'."
           next
         end
+      when "string"
+        var = String(var)
+      else
+        puts "Err: Undefined type."
       end
 
       if show_response
@@ -40,3 +44,4 @@ module BetterInput
     end
   end
 end
+

metadata

@@ -1,17 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: better_input
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
-- Barros FLavio
+- Barros Flavio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-06 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies: []
-description: When working with CLI I found myself doing things that could be summarized
-  as this function, so I did it!
+description: |
+  This is an improved input function for Ruby.
+
+  Using this gem, you can easily get user input with real-time type validation, ensuring that the data provided is as expected, among other things.
+
+  If you have any questions, check the documentation: https://github.com/barrosflavio/ruby_better_input
+
+  Features:
+    - Ask, receive and check input in a single line
+    - Support for types such as integer, float and boolean.
+    - Input validation with clear error messages.
+    - Intuitive and easy-to-use function.
 email:
 - flaviomarbs@gmail.com
 executables: []
@@ -21,6 +31,8 @@ files:
 - CHANGELOG.md
 - README.md
 - Rakefile
+- better_input-0.1.0.gem
+- better_input-0.1.1.gem
 - lib/better_input.rb
 - lib/better_input/version.rb
 - sig/better_input.rbs