peak_flow_utils 0.0.1 → 0.1.6

data/app/handlers/peak_flow_utils/rails_handler.rb

@@ -0,0 +1,206 @@
+class PeakFlowUtils::RailsHandler < PeakFlowUtils::ApplicationHandler
+  def groups
+    ArrayEnumerator.new do |yielder|
+      groups = %w[date_time errors helpers numbers support]
+
+      groups.each do |group|
+        yielder << PeakFlowUtils::GroupService.new(
+          id: group,
+          handler: self,
+          data: {
+            name: group.humanize
+          }
+        )
+      end
+    end
+  end
+
+  def translations_for_group(group)
+    ArrayEnumerator.new do |yielder|
+      dir = Rails.root.join("config", "locales", "awesome_translations", group.id).to_s
+      __send__("translations_for_#{group.id}", dir, group, yielder)
+    end
+  end
+
+private
+
+  def translations_for_errors(dir, group, yielder) # rubocop:disable Metrics/MethodLength
+    add_translations_for_hash(
+      dir,
+      group,
+      yielder,
+      translations: {
+        errors: {
+          format: "%{attribute} %{message}",
+          messages: {
+            accepted: "must be accepted",
+            blank: "can't be blank",
+            confirmation: "doesn't match %{attribute}",
+            empty: "can't be empty",
+            equal_to: "must be equal to %{count}",
+            even: "must be even",
+            exclusion: "is reserved",
+            greater_than: "must be greater than %{count}",
+            greater_than_or_equal_to: "must be greater than or equal to %{count}",
+            inclusion: "is not included in the list",
+            invalid: "is invalid",
+            less_than: "must be less than %{count}",
+            less_than_or_equal_to: "must be less than or equal to %{count}",
+            not_a_number: "is not a number",
+            not_an_integer: "must be an integer",
+            odd: "must be odd",
+            record_invalid: "Validation failed: %{errors}",
+            restrict_dependent_destroy: {
+              one: "Cannot delete record because a dependent %{record} exists",
+              other: "Cannot delete record because dependent %{record} exist"
+            },
+            taken: "has already been taken",
+            too_long: {
+              one: "is too long (maximum is 1 character)",
+              other: "is too long (maximum is %{count} characters)"
+            },
+            too_short: {
+              one: "is too short (minimum is 1 character)",
+              other: "is too short (minimum is %{count} characters)"
+            },
+            wrong_length: {
+              one: "is the wrong length (should be 1 character)",
+              other: "is the wrong length (should be %{count} characters)"
+            }
+          },
+          template: {
+            body: "There were problems with the following fields:",
+            header: {
+              one: "1 error prohibited this %{model} from being saved",
+              other: "%{count} errors prohibited this %{model} from being saved"
+            }
+          }
+        }
+      }
+    )
+  end
+
+  def translations_for_date_time(dir, group, yielder)
+    add_translations_for_hash(
+      dir,
+      group,
+      yielder,
+      translations: {
+        date: {
+          formats: {
+            default: "%Y-%m-%d",
+            short: "%b %d",
+            long: "%B %d, %Y"
+          },
+          day_names: [0, 1, 2, 3, 4, 5, 6],
+          abbr_day_names: [0, 1, 2, 3, 4, 5, 6],
+          month_names: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12],
+          abbr_month_names: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12],
+          order: [0, 1, 2]
+        },
+        time: {
+          formats: {
+            default: "%a, %d %b %Y %H:%M:%S %z",
+            short: "%d %b %H:%M",
+            long: "%B %d, %Y %H:%M"
+          },
+          am: "am",
+          pm: "pm"
+        }
+      }
+    )
+  end
+
+  def translations_for_helpers(dir, group, yielder)
+    add_translations_for_hash(
+      dir,
+      group,
+      yielder,
+      translations: {
+        helpers: {
+          select: {
+            prompt: "Please select"
+          },
+          submit: {
+            create: "Create %{model}",
+            submit: "Save %{model}",
+            update: "Update %{model}"
+          }
+        }
+      }
+    )
+  end
+
+  def translations_for_support(dir, group, yielder)
+    add_translations_for_hash(
+      dir,
+      group,
+      yielder,
+      translations: {
+        array: {
+          last_word_connector: " and ",
+          two_words_connector: " and ",
+          word_connector: ", "
+        }
+      }
+    )
+  end
+
+  def translations_for_numbers(dir, group, yielder) # rubocop:disable Metrics/MethodLength
+    add_translations_for_hash(
+      dir,
+      group,
+      yielder,
+      translations: {
+        number: {
+          currency: {
+            format: {
+              delimiter: ",",
+              format: "%n %u",
+              separator: ".",
+              unit: "$"
+            }
+          },
+          format: {
+            delimiter: ",",
+            separator: "."
+          },
+          human: {
+            decimal_units: {
+              format: "%n %u",
+              units: {
+                billion: "Billion",
+                million: "Million",
+                quadrillion: "Quadrillion",
+                thousand: "Thousand",
+                trillion: "Trillion",
+                unit: ""
+              }
+            },
+            format: {
+              delimiter: ""
+            },
+            storage_units: {
+              format: "%n %u",
+              units: {
+                byte: {
+                  one: "Byte",
+                  other: "Bytes"
+                },
+                gb: "GB",
+                kb: "KB",
+                mb: "MB",
+                tb: "TB"
+              }
+            }
+          },
+          percentage: {
+            format: {
+              delimiter: ""
+            }
+          }
+        }
+      }
+    )
+  end
+end

data/app/handlers/peak_flow_utils/simple_form_handler.rb

@@ -0,0 +1,76 @@
+class PeakFlowUtils::SimpleFormHandler < PeakFlowUtils::ApplicationHandler
+  def enabled?
+    ::Object.const_defined?(:SimpleForm)
+  end
+
+  def groups
+    ArrayEnumerator.new do |yielder|
+      PeakFlowUtils::ModelInspector.model_classes.each do |model_inspector|
+        yielder << PeakFlowUtils::GroupService.new(
+          id: model_inspector.clazz.name,
+          handler: self
+        )
+      end
+    end
+  end
+
+  def translations_for_group(group)
+    ArrayEnumerator.new do |yielder|
+      model_inspector = PeakFlowUtils::ModelInspector.model_classes.find { |model_inspector_i| model_inspector_i.clazz.name == group.name }
+      raise "No inspector by that name: #{group.name}" unless model_inspector
+
+      simple_form_translations(model_inspector).each { |translation| yielder << translation }
+    end
+  end
+
+private
+
+  def dir_path(model_inspector)
+    class_name = model_inspector.clazz.name
+    class_name = class_name.gsub("::", "_")
+    class_name = class_name.underscore
+
+    dir_path = Rails.root.join("config", "locales", "awesome_translations", "simple_form", class_name)
+    dir_path.to_s
+  end
+
+  def simple_form_translations(model_inspector)
+    result = []
+
+    model_inspector.attributes.each do |attribute|
+      translations = {}
+
+      I18n.available_locales.each do |locale|
+        translations[locale] = I18n.t(attribute.i18n_key, locale: locale)
+      end
+
+      result << PeakFlowUtils::TranslationService.new(
+        key: attribute.simple_form_label_key,
+        key_show: "#{attribute.name}.label",
+        dir: dir_path(model_inspector)
+      )
+      result << PeakFlowUtils::TranslationService.new(
+        key: attribute.simple_form_hint_key,
+        key_show: "#{attribute.name}.hint",
+        dir: dir_path(model_inspector)
+      )
+      result << PeakFlowUtils::TranslationService.new(
+        key: attribute.simple_form_placeholder_key,
+        key_show: "#{attribute.name}.placeholder",
+        dir: dir_path(model_inspector)
+      )
+      result << PeakFlowUtils::TranslationService.new(
+        key: attribute.simple_form_include_blank_key,
+        key_show: "#{attribute.name}.include_blank",
+        dir: dir_path(model_inspector)
+      )
+      result << PeakFlowUtils::TranslationService.new(
+        key: attribute.simple_form_prompt_key,
+        key_show: "#{attribute.name}.prompt",
+        dir: dir_path(model_inspector)
+      )
+    end
+
+    result
+  end
+end

data/app/handlers/peak_flow_utils/validations_handler.rb

@@ -0,0 +1,85 @@
+class PeakFlowUtils::ValidationsHandler < PeakFlowUtils::ApplicationHandler
+  def groups
+    ArrayEnumerator.new do |yielder|
+      PeakFlowUtils::ModelInspector.model_classes.each do |model_inspector|
+        yielder << PeakFlowUtils::GroupService.new(
+          id: model_inspector.clazz.name,
+          handler: self
+        )
+      end
+    end
+  end
+
+  def translations_for_group(group)
+    ArrayEnumerator.new do |yielder|
+      model_inspector = PeakFlowUtils::ModelInspector.model_classes.find { |model_inspector_i| model_inspector_i.clazz.name == group.name }
+      raise "No inspector by that name: #{group.name}" unless model_inspector
+
+      model_inspector.clazz._validators.each do |attribute_name, validators|
+        validators.each do |validator|
+          if validator.is_a?(ActiveModel::Validations::LengthValidator)
+            translations_for_length_validator(validator, model_inspector, attribute_name, yielder)
+          elsif validator.is_a?(ActiveModel::Validations::FormatValidator)
+            translations_for_format_validator(validator, model_inspector, attribute_name, yielder)
+          elsif validator.is_a?(ActiveRecord::Validations::UniquenessValidator)
+            translations_for_uniqueness_validator(validator, model_inspector, attribute_name, yielder)
+          elsif validator.class.name == "ActiveRecord::Validations::PresenceValidator"
+            translations_for_presence_validator(validator, model_inspector, attribute_name, yielder)
+          elsif validator.class.name == "EmailValidator"
+            translations_for_email_validator(validator, model_inspector, attribute_name, yielder)
+          elsif validator.class.name == "ActiveModel::Validations::ConfirmationValidator"
+            translations_for_confirmation_validator(validator, model_inspector, attribute_name, yielder)
+          else
+            Rails.logger.error "Unhandeled validator: #{validator.class.name}"
+          end
+        end
+      end
+    end
+  end
+
+private
+
+  def translations_for_length_validator(validator, model_inspector, attribute_name, yielder)
+    if validator.options[:minimum].present?
+      add_translation("too_short", model_inspector, attribute_name, yielder) # "is too short. The minimum is %{count}"
+    end
+
+    if validator.options[:maximum].present?
+      add_translation("too_long", model_inspector, attribute_name, yielder) # "is too long. The maximum is %{count}"
+    end
+
+    if validator.options[:is].present?
+      add_translation("wrong_length", model_inspector, attribute_name, yielder) # "is not the correct length: %{count}"
+    end
+  end
+
+  def translations_for_format_validator(_validator, model_inspector, attribute_name, yielder)
+    add_translation("invalid", model_inspector, attribute_name, yielder) # "is invalid"
+  end
+
+  def translations_for_uniqueness_validator(_validator, model_inspector, attribute_name, yielder)
+    add_translation("taken", model_inspector, attribute_name, yielder) # "has already been taken"
+  end
+
+  def translations_for_presence_validator(_validator, model_inspector, attribute_name, yielder)
+    add_translation("blank", model_inspector, attribute_name, yielder) # "cannot be blank"
+  end
+
+  def translations_for_email_validator(_validator, model_inspector, attribute_name, yielder)
+    add_translation("invalid", model_inspector, attribute_name, yielder) # "is invalid"
+  end
+
+  def translations_for_confirmation_validator(_validator, model_inspector, attribute_name, yielder)
+    add_translation("confirmation", model_inspector, "#{attribute_name}_confirmation", yielder)
+  end
+
+  def add_translation(key, model_inspector, attribute_name, yielder)
+    snake_clazz_name = model_inspector.clazz.name.underscore
+
+    yielder << PeakFlowUtils::TranslationService.new(
+      key: "activerecord.errors.models.#{snake_clazz_name}.attributes.#{attribute_name}.#{key}",
+      key_show: "#{attribute_name}.#{key}",
+      dir: "#{Rails.root}/config/locales/awesome_translations/models/#{snake_clazz_name}"
+    )
+  end
+end

data/app/handlers/peak_flow_utils/will_paginate_handler.rb

@@ -0,0 +1,59 @@
+class PeakFlowUtils::WillPaginateHandler < PeakFlowUtils::ApplicationHandler
+  def enabled?
+    ::Object.const_defined?(:WillPaginate)
+  end
+
+  def groups
+    ArrayEnumerator.new do |yielder|
+      groups = ["will_paginate"]
+
+      groups.each do |group|
+        yielder << PeakFlowUtils::GroupService.new(
+          id: group,
+          handler: self,
+          data: {
+            name: group.humanize
+          }
+        )
+      end
+    end
+  end
+
+  def translations_for_group(group)
+    ArrayEnumerator.new do |yielder|
+      dir = Rails.root.join("config", "locales", "awesome_translations", group.id).to_s
+      __send__("translations_for_#{group.id}", dir, group, yielder)
+    end
+  end
+
+private
+
+  def translations_for_will_paginate(dir, group, yielder)
+    add_translations_for_hash(
+      dir,
+      group,
+      yielder,
+      translations: {
+        will_paginate: {
+          previous_label: "&#8592; Previous",
+          next_label: "Next &#8594;",
+          page_gap: "&hellip;",
+          page_entries_info: {
+            single_page: {
+              zero: "No %{model} found",
+              one: "Displaying 1 %{model}",
+              other: "Displaying all %{count} %{model}"
+            },
+            single_page_html: {
+              zero: "No %{model} found",
+              one: "Displaying <b>1</b> %{model}",
+              other: "Displaying <b>all&nbsp;%{count}</b> %{model}"
+            },
+            multi_page: "Displaying %{model} %{from} - %{to} of %{count} in total",
+            multi_page_html: "Displaying %{model} <b>%{from}&nbsp;-&nbsp;%{to}</b> of <b>%{count}</b> in total"
+          }
+        }
+      }
+    )
+  end
+end

data/app/helpers/peak_flow_utils/application_helper.rb

@@ -0,0 +1,2 @@
+module PeakFlowUtils::ApplicationHelper
+end

data/app/jobs/peak_flow_utils/application_job.rb

@@ -0,0 +1,2 @@
+class PeakFlowUtils::ApplicationJob < ActiveJob::Base
+end

data/app/mailers/peak_flow_utils/application_mailer.rb

@@ -0,0 +1,4 @@
+class PeakFlowUtils::ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+end

data/app/migrations/20150902155200_create_translation_keys.rb

@@ -0,0 +1,8 @@
+class CreateTranslationKeys < PeakFlowUtils::ApplicationMigration
+  def change
+    create_table :peak_flow_utils_translation_keys do |t|
+      t.string :key, index: true, null: false
+      t.timestamps
+    end
+  end
+end