simple_voice_input 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c1663072164f39abd10cae9a211cf93914758fbef274a6bbd171997f2bfed66
+  data.tar.gz: 35bbba9598c9cd710a21b6ef7bf9266e1d9fe3430c19e5ee4dd2479efb40c4c8
+SHA512:
+  metadata.gz: 83e030c0bb56383a601a6cef246bb63b31a55fb1f333d5c510559d3b94ef680be6909c802285db2e9f248f3520d7475c69c8e87c3a9390a01c89f4083b2255e5
+  data.tar.gz: 1366e273a3f006300bffd3a81658a42ae870d073d207ddffc559d17f9d366214d5efc159f721e43f6f8f8f0f5a4ff2c77dd40e64be545f7b10e2772a2a8baa9c

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 orlando
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# SimpleVoiceInput
+
+**SimpleVoiceInput** é uma gem para Ruby on Rails que adiciona suporte a campos de texto com reconhecimento de voz no **SimpleForm**. Com esta gem, você pode criar inputs estilizados que permitem que os usuários insiram texto através de comandos de voz.
+
+## Recursos
+
+- Integração com **SimpleForm**.
+- Suporte ao reconhecimento de voz usando a API de SpeechRecognition do navegador.
+- Interface personalizável com ícone de microfone.
+
+---
+
+## Instalação
+
+Adicione a gem ao seu **Gemfile**:
+
+```ruby
+gem 'simple_voice_input'
+```
+
+Execute o bundle:
+
+```bash
+bundle install
+```
+
+Inclua os assets necessários no seu projeto.
+
+### Estilos CSS
+Adicione o seguinte ao arquivo principal de estilos, como `application.css` ou `application.scss`:
+
+```css
+@import "simple_voice_input";
+```
+
+### JavaScript
+Certifique-se de estar usando **Stimulus** e registre o controlador da gem no seu projeto. No arquivo `app/javascript/controllers/index.js`, adicione:
+
+```javascript
+import SimpleVoiceInputController from "simple_voice_input/controllers/simple_voice_input_controller";
+application.register("simple-voice-input", SimpleVoiceInputController);
+```
+
+---
+
+## Uso
+
+Com **SimpleVoiceInput**, você pode adicionar inputs com reconhecimento de voz facilmente em seus formulários usando **SimpleForm**. Exemplo:
+
+```erb
+<%= simple_form_for @model do |f| %>
+  <%= f.voice_input :campo_de_texto, label: "Comando de voz", input_html: { class: "meu-input-custom" } %>
+  <%= f.submit "Enviar" %>
+<% end %>
+```
+
+### Opções Disponíveis
+
+- **label**: Define o texto do rótulo para o input.
+- **input_html**: Permite personalizar as classes e atributos do campo de entrada.
+
+---
+
+## Requisitos
+
+- Rails 6.0 ou superior.
+- SimpleForm 5.0 ou superior.
+- Navegadores com suporte à API de SpeechRecognition (ex.: Chrome, Edge).
+
+---
+
+## Personalização
+
+### CSS
+Você pode modificar os estilos do ícone de microfone e do contêiner no seu CSS:
+
+```css
+.voice-input-container {
+  position: relative;
+  width: 100%;
+}
+
+.voice-input-container .microphone-icon {
+  position: absolute;
+  right: 10px;
+  top: 50%;
+  transform: translateY(-50%);
+  cursor: pointer;
+  font-size: 20px;
+  color: #555;
+}
+
+.voice-input-container .microphone-icon.active {
+  color: red;
+}
+```
+
+### JavaScript
+Se você deseja alterar o comportamento padrão do reconhecimento de voz, edite o controlador Stimulus fornecido.
+
+---
+
+## Contribuições
+
+Contribuições são bem-vindas! Para reportar problemas ou sugerir melhorias:
+
+1. Fork este repositório.
+2. Crie uma branch para suas alterações:
+   ```bash
+   git checkout -b minha-contribuicao
+   ```
+3. Submeta um pull request.
+
+---
+
+## Licença
+
+Esta gem está disponível sob a licença [MIT](LICENSE).
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/app/assets/stylesheets/simple_voice_input.css

@@ -0,0 +1,18 @@
+.voice-input-container {
+    position: relative;
+    width: 100%;
+}
+
+.voice-input-container .microphone-icon {
+    position: absolute;
+    right: 10px;
+    top: 50%;
+    transform: translateY(-50%);
+    cursor: pointer;
+    font-size: 20px;
+    color: #555;
+}
+
+.voice-input-container .microphone-icon.active {
+    color: red;
+}

data/app/javascript/controllers/simple_voice_input_controller.js

@@ -0,0 +1,52 @@
+import { Controller } from "@hotwired/stimulus";
+
+export default class extends Controller {
+    static targets = ["voiceInput"];
+
+    connect() {
+        if (!("SpeechRecognition" in window || "webkitSpeechRecognition" in window)) {
+            console.error("Reconhecimento de voz não é suportado neste navegador.");
+            return;
+        }
+
+        const SpeechRecognition = window.SpeechRecognition || window.webkitSpeechRecognition;
+        this.recognition = new SpeechRecognition();
+
+        this.recognition.lang = "pt-BR";
+        this.recognition.interimResults = false;
+        this.recognition.maxAlternatives = 1;
+
+        this.recognition.onresult = this.onResult.bind(this);
+        this.recognition.onend = this.onEnd.bind(this);
+        this.recognition.onerror = this.onError.bind(this);
+    }
+
+    start(event) {
+        const icon = event.currentTarget;
+        if (icon.classList.contains("active")) {
+            this.recognition.stop();
+        } else {
+            this.targetInput = document.querySelector(`[data-target="${icon.dataset.target}"]`);
+            icon.classList.add("active");
+            this.recognition.start();
+        }
+    }
+
+    onResult(event) {
+        const transcript = event.results[0][0].transcript;
+        if (this.targetInput) {
+            this.targetInput.value = transcript;
+        }
+    }
+
+    onEnd() {
+        document.querySelectorAll(".microphone-icon.active").forEach((icon) => {
+            icon.classList.remove("active");
+        });
+    }
+
+    onError(event) {
+        console.error("Erro no reconhecimento de voz:", event.error);
+        this.onEnd();
+    }
+}

data/lib/simple_voice_input/version.rb

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

data/lib/simple_voice_input/voice_input_helper.rb

@@ -0,0 +1,18 @@
+module SimpleVoiceInput
+  module VoiceInputHelper
+    def voice_input(method, options = {})
+      input_html_options = options[:input_html] || {}
+      input_html_options[:class] = Array(input_html_options[:class]) << 'voice-input'
+      input_html_options[:placeholder] ||= 'Diga algo...'
+
+      @template.content_tag(:div, class: 'voice-input-container') do
+        self.input(method, options.merge(input_html: input_html_options)) +
+            @template.content_tag(:span, '🎤', class: 'microphone-icon', data: { target: "voice-input-#{method}" })
+      end
+    end
+  end
+end
+
+# Extende o SimpleForm
+SimpleForm::FormBuilder.include SimpleVoiceInput::VoiceInputHelper
+

data/lib/simple_voice_input.rb

@@ -0,0 +1,8 @@
+require "simple_voice_input/version"
+require "simple_voice_input/voice_input_helper"
+
+module SimpleVoiceInput
+  class Engine < ::Rails::Engine
+    # Configura a gem como uma Engine Rails para carregar assets e helpers automaticamente
+  end
+end

data/sig/simple_voice_input.rbs

@@ -0,0 +1,4 @@
+module SimpleVoiceInput
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: simple_voice_input
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- orlando
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Essa gem permite adicionar campos de texto com funcionalidade de reconhecimento
+  de voz ao SimpleForm.
+email:
+- orlandocn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/stylesheets/simple_voice_input.css
+- app/javascript/controllers/simple_voice_input_controller.js
+- lib/simple_voice_input.rb
+- lib/simple_voice_input/version.rb
+- lib/simple_voice_input/voice_input_helper.rb
+- sig/simple_voice_input.rbs
+homepage: https://github.com/orlandocn/simple_voice_input
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/orlandocn/simple_voice_input
+  source_code_uri: https://github.com/orlandocn/simple_voice_input
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Adiciona inputs com reconhecimento de voz ao SimpleForm
+test_files: []