helpyr 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7b158b0a5d9b79256e1c404874b1891eb49ef25c693cdae21aa989bc99136dd
-  data.tar.gz: 38054bb356242af31ae4873c51cf4c850d51b8d3d6076d59655cd436918cf83b
+  metadata.gz: 86d4399373dd70928d6d29765c2c22a7443894b166b2212c5c5adc50310c83f9
+  data.tar.gz: c1a2e9d4629e54ee11276dafede156d2e5fd9b20a03955b37383b887c15f8708
 SHA512:
-  metadata.gz: 66e44e2b4dca701b22a72d78230345a490d90748a39f36efeca8f5d7bcf69c0fd857bad7ccbf7ca8eb9ddba7219f09111368f9f59237f4836695e9de82e70d64
-  data.tar.gz: 27d2bcda46b6a31a6f14a148d168206be5cecb36d7f9eb109d3a50d018e17f940b94c31cbac5ae715f706d9cc22961f9c90b0ee0dc807e6f637ab586ef16f59d
+  metadata.gz: 68d849bb9f0ed2dffb9d2914d857bd8394ec2935f5f5ff820911de81f775d9de4e157290b373bf718bc111110dccb5b80ddc7a2b4d22c3619e1ace20c9260813
+  data.tar.gz: c1a774b9f1863f942d50938947014ef778e87f22415916f0f45daf051a771d49516cbaef938d6f6490fb56e2d219b554060e9c1e3845a59c7d6cf22b697e4a09

data/lib/helpyr/engine.rb

@@ -0,0 +1,10 @@
+module Helpyr
+  class Engine < ::Rails::Engine
+    initializer "helpyr.helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include Helpyr::Translation
+        include Helpyr::PageTitle
+      end
+    end
+  end
+end

data/lib/helpyr/locales/en.yml

@@ -0,0 +1,23 @@
+en:
+  helpyr:
+    boolean:
+      true: "Yes"
+      false: "No"
+    alerts:
+      not_found:
+        male: "No %{model} found."
+        female: "No %{model} found."
+    form:
+      button:
+        create: "Create %{model}"
+        update: "Update %{model}"
+    alerts:
+      create:
+        success: "Record created successfully."
+      update:
+        success: "Record updated successfully."
+      destroy:
+        success: "Record deleted successfully."
+      not_found:
+        male: "No %{model} found."
+        female: "No %{model} found."

data/lib/helpyr/locales/pt-BR.yml

@@ -0,0 +1,23 @@
+pt-BR:
+  helpyr:
+    boolean:
+      true: "Sim"
+      false: "Não"
+    alerts:
+      not_found:
+        male: "Nenhum %{model} foi encontrado."
+        female: "Nenhuma %{model} foi encontrada."
+    form:
+      button:
+        create: "Criar %{model}"
+        update: "Atualizar %{model}"
+    alerts:
+      create:
+        success: "Registro criado com sucesso."
+      update:
+        success: "Registro atualizado com sucesso."
+      destroy:
+        success: "Registro apagado com sucesso."
+      not_found:
+        male: "Nenhum %{model} foi encontrado."
+        female: "Nenhuma %{model} foi encontrada."

data/lib/helpyr/page_title.rb

@@ -0,0 +1,12 @@
+module Helpyr
+  module PageTitle
+    def page_title(*segments)
+      [
+        content_for(:turbo_native_title).presence ||
+          content_for(:page_title).presence ||
+          content_for(:title).presence,
+        *segments.compact_blank
+      ].compact.join(" » ")
+    end
+  end
+end

data/lib/helpyr/translation.rb

@@ -0,0 +1,182 @@
+module Helpyr
+  module Translation
+    ##
+    # Public: Translate a model name.
+    #
+    # model: Model class.
+    # count: Count.
+    #
+    # Examples:
+    #
+    #   <%= tm(Post) %>
+    #   # => "Artigo"
+    #
+    #   <%= tm(Post, 2) %>
+    #   # => "Artigos"
+    #
+    # Returns translated model.
+    def translate_model_name(model, ...)
+      model.model_name.human(...)
+    end
+    alias_method :tm, :translate_model_name
+
+    ##
+    # Public: Translate a model name pluralized.
+    #
+    # model: Model class.
+    #
+    # Examples:
+    #
+    #   <%= tmp(Post) %>
+    #   # => "Artigos"
+    #
+    # Returns translated model pluralized.
+    def translate_model_name_pluralized(model, **)
+      translate_model_name(model, count: 2, **)
+    end
+    alias_method :tmp, :translate_model_name_pluralized
+
+    ##
+    # Public: Translate a model submit button.
+    #
+    # model: Model class.
+    #
+    # Examples:
+    #
+    #   <%= tmb(Post, :create) %>
+    #   => <button name="button" type="submit" class="btn btn-primary">
+    #   =>   <i class="bi bi-save2"> </i>Criar Artigo
+    #   => </button>
+    #
+    #   <%= tmb(Post, :update) %>
+    #   => <button name="button" type="submit" class="btn btn-primary">
+    #   =>   <i class="bi bi-save2"> </i>Atualizar Artigo
+    #   => </button>
+    #
+    # Returns translated model pluralized.
+    def translate_model_button(model, kind)
+      I18n.t("helpyr.form.button.#{kind}", model: tm(model))
+    end
+    alias_method :tmb, :translate_model_button
+
+    ##
+    # Public: Translate a model attribute.
+    #
+    # model: Model class.
+    # attribute: Attribute name.
+    # count: Count.
+    #
+    # Examples
+    #
+    #   <%= ta(Post, :title) %>
+    #   # => "Titulo"
+    #
+    #   <%= ta(Post, :title, 2) %>
+    #   # => "Títulos"
+    #
+    # Returns translated model's attribute.
+    def translate_model_attribute(model, attribute, ...)
+      model.human_attribute_name(attribute, ...)
+    end
+    alias_method :ta, :translate_model_attribute
+
+    ##
+    # Public: Translate a model enum.
+    #
+    # model: Model class.
+    # count: Count.
+    #
+    # Examples:
+    #
+    #   <%= teo(Order, :statuses) %>
+    #   # => [["Rascunho", "draft"], ["Pendente", "pending"], ["Em processamento", "processing"]]
+    #
+    #   <%= teo(Order, :statuses, only: ["draft", "pending"]) %>
+    #   # => [["Rascunho", "draft"], ["Pendente", "pending"]]
+    #
+    #   <%= teo(Order, :statuses, except: ["pending"]) %>
+    #   # => [["Rascunho", "draft"], ["Em processamento", "processing"]]
+    #
+    # Returns translated model's enum names.
+    def translate_model_enum_names(model, enum, only: [], except: [])
+      model.send(enum).keys.filter_map do |key|
+        next if only.present? && only.exclude?(key.to_s)
+        next if only.blank? && except.include?(key.to_s)
+
+        [model.human_attribute_name("#{enum}.#{key}"), key]
+      end
+    end
+    alias_method :teo, :translate_model_enum_names
+
+    ##
+    # Public: Translate a boolean attribute.
+    #
+    # value: TrueClass or FalseClass.
+    #
+    # Examples
+    #
+    #   <%= tb true %>
+    #   # => "Sim"
+    #
+    #   <%= tb false %>
+    #   # => "Não"
+    #
+    # Returns translated boolean's attribute.
+    def translate_boolean(value)
+      I18n.t("helpyr.boolean.#{value}")
+    end
+    alias_method :tb, :translate_boolean
+
+    ##
+    # Public: Translate a not found message.
+    #
+    # model: Model class.
+    # gender: Gender of the model.
+    #
+    # Examples:
+    #
+    #   <%= tnf(Post, gender: :male) %>
+    #   # => "Nenhum artigo foi encontrado."
+    #
+    #   <%= tnf(Company, gender: :female) %>
+    #   # => "Nenhuma empresa foi encontrada."
+    #
+    # Returns translated not found message.
+    def translate_not_found(model, gender:)
+      I18n.t("helpyr.alerts.not_found.#{gender}", model: tm(model).downcase)
+    end
+    alias_method :tnf, :translate_not_found
+
+    ##
+    # Public: Translate a not found message for male model.
+    #
+    # model: Model class.
+    #
+    # Examples:
+    #
+    #   <%= tnfm(Post) %>
+    #   # => "Nenhum artigo foi encontrado."
+    #
+    # Returns translated not found message for male model.
+    def translate_not_found_male(model)
+      tnf(model, gender: :male)
+    end
+    alias_method :tnfm, :translate_not_found_male
+
+    ##
+    # Public: Translate a not found message for female model.
+    #
+    # model: Model class.
+    #
+    # Examples:
+    #
+    #   <%= tnff(Company) %>
+    #   # => "Nenhuma empresa foi encontrada."
+    #
+    # Returns translated not found message for female model.
+    def translate_not_found_female(model)
+      tnf(model, gender: :female)
+    end
+    alias_method :tnff, :translate_not_found_female
+  end
+end

data/lib/helpyr/version.rb

@@ -1,3 +1,3 @@
 module Helpyr
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/helpyr.rb

@@ -1,6 +1,10 @@
 require_relative "helpyr/version"
+require_relative "helpyr/engine"
+require_relative "helpyr/translation"
+require_relative "helpyr/page_title"
 
 module Helpyr
+  I18n.load_path += Dir[File.join(__dir__, "helpyr/locales/*.yml")]
+
   class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: helpyr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Lavenda Software
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
 email:
 - lavenda@lavenda.com.br
 executables: []
@@ -23,6 +37,11 @@ files:
 - README.md
 - Rakefile
 - lib/helpyr.rb
+- lib/helpyr/engine.rb
+- lib/helpyr/locales/en.yml
+- lib/helpyr/locales/pt-BR.yml
+- lib/helpyr/page_title.rb
+- lib/helpyr/translation.rb
 - lib/helpyr/version.rb
 - sig/helpyr.rbs
 homepage: https://github.com/LavendaSoftware/helpyr
@@ -40,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.4.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="