peak_flow_utils 0.0.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2717441d565b367b1449347e1d910ef7b970e5e1
-  data.tar.gz: 77e3e9b897ff94d066d2fbe8ac9add5575936d28
+SHA256:
+  metadata.gz: 8331268ab7ca65fe644bc7c0cb9e883117c99b01fe6e3d34daf9dec4af27d06b
+  data.tar.gz: 34e18fd3e3ce075b58bbc1c2fdec0609f129a66be36c56a6e8b1505440af24a4
 SHA512:
-  metadata.gz: 89c6b42adc519119dbc83b9d2c5d766b9e768e30ad553ff0cdd882ff37f039911fdf0017be8a1e4993d99462fcf3fe3d57fada0e1792ed7365569f7411a05082
-  data.tar.gz: f71a689bd0372ee257cdd4f6ba6d6004ea5214469c3b544127458872a9cfa52bc034bffea37143705b8ce8511ee6f476fe74a2217098b17e3185e0540a79754d
+  metadata.gz: 0edc2059a781d7ae3f826a798961b324a72dde0d82e509416b6088c4536b91d19fddfce6eeae9a7fd486db8a472941ac479d861ff34e1b97220ff7597fa9dd37
+  data.tar.gz: 5178465585583b4c21cf76ab9c1cd7d928e08fcfe564df2a35a81543ec26a6650f8f5af10dd8987e00242bdacc63125bcf95f3d6afc74c7d94e30e5b0026a25e

data/{LICENSE.txt → MIT-LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2016 kaspernj
+Copyright 2018 kaspernj
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,19 +1,28 @@
-# peak_flow_utils
+# PeakFlowUtils
+Short description and motivation.
 
-Description goes here.
+## Usage
+How to use my plugin.
 
-## Contributing to peak_flow_utils
+## Installation
+Add this line to your application's Gemfile:
 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+```ruby
+gem 'peak_flow_utils'
+```
 
-## Copyright
+And then execute:
+```bash
+$ bundle
+```
 
-Copyright (c) 2016 kaspernj. See LICENSE.txt for
-further details.
+Or install it yourself as:
+```bash
+$ gem install peak_flow_utils
+```
 
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,37 +1,27 @@
-# encoding: utf-8
-
-require "rubygems"
-require "bundler"
 begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
-require "rake"
 
-require "jeweler"
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = "peak_flow_utils"
-  gem.homepage = "http://github.com/kaspernj/peak_flow_utils"
-  gem.license = "MIT"
-  gem.summary = %(Various utilities to help with building on PeakFlow)
-  gem.description = %(Various utilities to help with building on PeakFlow)
-  gem.email = "k@spernj.org"
-  gem.authors = ["kaspernj"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
+require "rdoc/task"
 
-require "rspec/core"
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList["spec/**/*_spec.rb"]
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "PeakFlowUtils"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-require "best_practice_project"
-BestPracticeProject.load_tasks
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
 
-task default: :spec
+require "bundler/gem_tasks"
+
+if Rails.env.development? || Rails.env.test?
+  require "best_practice_project"
+  BestPracticeProject.load_tasks
+end

data/app/assets/config/peak_flow_utils_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/peak_flow_utils .js
+//= link_directory ../stylesheets/peak_flow_utils .css

data/app/assets/javascripts/peak_flow_utils/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require activestorage
+//= require_tree .

data/app/assets/stylesheets/peak_flow_utils/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/peak_flow_utils/application_controller.rb

@@ -0,0 +1,13 @@
+class PeakFlowUtils::ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+
+  before_action :authenticate
+
+private
+
+  def authenticate
+    authenticate_or_request_with_http_basic do |username, password|
+      username == ENV.fetch("PEAK_FLOW_PINGS_USERNAME") && password == ENV.fetch("PEAK_FLOW_PINGS_PASSWORD")
+    end
+  end
+end

data/app/controllers/peak_flow_utils/pings/sidekiq_pings_controller.rb

@@ -0,0 +1,10 @@
+class PeakFlowUtils::Pings::SidekiqPings < PeakFlowUtils::ApplicationController
+  def create
+    sidekiq_queue = Sidekiq::Queue.new
+
+    render json: {
+      latency: sidekiq_queue.latency,
+      queue_size: sidekiq_queue.size
+    }
+  end
+end

data/app/handlers/peak_flow_utils/application_handler.rb

@@ -0,0 +1,36 @@
+class PeakFlowUtils::ApplicationHandler
+  def add_translations_for_hash(dir, _group, yielder, hash)
+    translations_for_hash_recursive(dir, hash[:translations], yielder, [])
+  end
+
+  def translations_for_hash_recursive(dir, hash, yielder, current_keys)
+    hash.each do |key, value|
+      current_keys << key
+
+      if value.is_a?(Hash)
+        translations_for_hash_recursive(dir, value, yielder, current_keys)
+      elsif value.is_a?(Array)
+        value.each_index do |index|
+          yielder << PeakFlowUtils::TranslationService.new(
+            dir: dir,
+            key: "#{current_keys.join('.')}[#{index}]",
+            key_show: "#{current_keys.join('.')}[#{index}]"
+          )
+        end
+      else
+        yielder << PeakFlowUtils::TranslationService.new(
+          dir: dir,
+          key: current_keys.join("."),
+          key_show: current_keys.join("."),
+          default: value
+        )
+      end
+
+      current_keys.pop
+    end
+  end
+
+  def enabled?
+    true
+  end
+end

data/app/handlers/peak_flow_utils/devise_handler.rb

@@ -0,0 +1,126 @@
+# rubocop:disable Metrics/LineLength
+class PeakFlowUtils::DeviseHandler < PeakFlowUtils::ApplicationHandler
+  def enabled?
+    ::Object.const_defined?(:Devise)
+  end
+
+  def groups
+    ArrayEnumerator.new do |yielder|
+      groups = ["devise"]
+
+      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_devise(dir, group, yielder)
+    add_translations_for_hash(
+      dir,
+      group,
+      yielder,
+      translations: {
+        devise: {
+          confirmations: {
+            confirmed: "Your email address has been successfully confirmed.",
+            send_instructions: "You will receive an email with instructions for how to confirm your email address in a few minutes.",
+            send_paranoid_instructions: "If your email address exists in our database, you will receive an email with instructions for how to confirm your email address in a few minutes."
+          },
+          failure: failure,
+          mailer: {
+            confirmation_instructions: {
+              subject: "Confirmation instructions"
+            },
+            reset_password_instructions: {
+              subject: "Reset password instructions"
+            },
+            unlock_instructions: {
+              subject: "Unlock instructions"
+            }
+          },
+          omniauth_callbacks: {
+            failure: "Could not authenticate you from %{kind} because \"%{reason}\".",
+            success: "Successfully authenticated from %{kind} account."
+          },
+          passwords: {
+            no_token: "You can't access this page without coming from a password reset email. If you do come from a password reset email, please make sure you used the full URL provided.",
+            send_instructions: "You will receive an email with instructions on how to reset your password in a few minutes.",
+            send_paranoid_instructions: "If your email address exists in our database, you will receive a password recovery link at your email address in a few minutes.",
+            updated: "Your password has been changed successfully. You are now signed in.",
+            updated_not_active: "Your password has been changed successfully."
+          },
+          registrations: registrations,
+          sessions: {
+            signed_in: "Signed in successfully.",
+            signed_out: "Signed out successfully.",
+            already_signed_out: "Signed out successfully."
+          },
+          unlocks: {
+            send_instructions: "You will receive an email with instructions for how to unlock your account in a few minutes.",
+            send_paranoid_instructions: "If your account exists, you will receive an email with instructions for how to unlock it in a few minutes.",
+            unlocked: "Your account has been unlocked successfully. Please sign in to continue."
+          }
+        },
+        errors: errors
+      }
+    )
+  end
+
+  def failure
+    {
+      already_authenticated: "You are already signed in.",
+      inactive: "Your account is not activated yet.",
+      invalid: "Invalid %{authentication_keys} or password.",
+      locked: "Your account is locked.",
+      last_attempt: "You have one more attempt before your account is locked.",
+      not_found_in_database: "Invalid %{authentication_keys} or password.",
+      timeout: "Your session expired. Please sign in again to continue.",
+      unauthenticated: "You need to sign in or sign up before continuing.",
+      unconfirmed: "You have to confirm your email address before continuing."
+    }
+  end
+
+  def registrations
+    {
+      destroyed: "Bye! Your account has been successfully cancelled. We hope to see you again soon.",
+      signed_up: "Welcome! You have signed up successfully.",
+      signed_up_but_inactive: "You have signed up successfully. However, we could not sign you in because your account is not yet activated.",
+      signed_up_but_locked: "You have signed up successfully. However, we could not sign you in because your account is locked.",
+      signed_up_but_unconfirmed: "A message with a confirmation link has been sent to your email address. Please follow the link to activate your account.",
+      update_needs_confirmation: "You updated your account successfully, but we need to verify your new email address. Please check your email and follow the confirm link to confirm your new email address.",
+      updated: "Your account has been updated successfully."
+    }
+  end
+
+  def errors
+    {
+      messages: {
+        already_confirmed: "was already confirmed, please try signing in",
+        confirmation_period_expired: "needs to be confirmed within %{period}, please request a new one",
+        expired: "has expired, please request a new one",
+        not_found: "not found",
+        not_locked: "was not locked",
+        not_saved: {
+          one: "1 error prohibited this %{resource} from being saved:",
+          other: "%{count} errors prohibited this %{resource} from being saved:"
+        }
+      }
+    }
+  end
+end
+# rubocop:enable Metrics/LineLength

data/app/handlers/peak_flow_utils/file_handler.rb

@@ -0,0 +1,42 @@
+class PeakFlowUtils::FileHandler < PeakFlowUtils::ApplicationHandler
+  def groups
+    ArrayEnumerator.new do |yielder|
+      erb_inspector.files.each do |file|
+        id = file.file_path.gsub(/[^A-z0-9]/, "_")
+
+        group = PeakFlowUtils::GroupService.new(
+          id: id,
+          handler: self,
+          data: {
+            name: file.file_path,
+            root_path: file.root_path,
+            full_path: file.full_path,
+            file_path: file.file_path
+          }
+        )
+
+        yielder << group if translations_for_group(group).any?
+      end
+    end
+  end
+
+  def translations_for_group(group)
+    ArrayEnumerator.new do |yielder|
+      translations_found = {}
+
+      file = erb_inspector.file(group.data.fetch(:root_path), group.data.fetch(:file_path))
+      file.translations.each do |translation|
+        next if translations_found.key?(translation.full_key)
+
+        translations_found[translation.full_key] = true
+        yielder << translation.model
+      end
+    end
+  end
+
+private
+
+  def erb_inspector
+    @erb_inspector ||= PeakFlowUtils::ErbInspector.new
+  end
+end

data/app/handlers/peak_flow_utils/model_handler.rb

@@ -0,0 +1,123 @@
+class PeakFlowUtils::ModelHandler < 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_names(model_inspector).each { |translation| yielder << translation }
+      active_record_attributes(model_inspector).each { |translation| yielder << translation }
+      paperclip_attachments(model_inspector).each { |translation| yielder << translation }
+      relationships(model_inspector).each { |translation| yielder << translation }
+      monetized_attributes(model_inspector).each { |translation| yielder << translation }
+      globalize_attributes(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", "models", class_name)
+
+    dir_path.to_s
+  end
+
+  def active_record_attributes(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.i18n_key,
+        dir: dir_path(model_inspector)
+      )
+    end
+
+    result
+  end
+
+  def paperclip_attachments(model_inspector)
+    result = []
+
+    model_inspector.paperclip_attachments do |name|
+      result << PeakFlowUtils::TranslationService.new(
+        key: model_inspector.attribute_key(name),
+        dir: dir_path(model_inspector)
+      )
+    end
+
+    result
+  end
+
+  def model_names(model_inspector)
+    result = []
+    result << PeakFlowUtils::TranslationService.new(
+      key: model_inspector.class_key_one,
+      dir: dir_path(model_inspector)
+    )
+    result << PeakFlowUtils::TranslationService.new(
+      key: model_inspector.class_key_other,
+      dir: dir_path(model_inspector)
+    )
+
+    result
+  end
+
+  def relationships(model_inspector)
+    result = []
+
+    model_inspector.relationships do |_key, reflection|
+      result << PeakFlowUtils::TranslationService.new(
+        key: model_inspector.attribute_key(reflection.name),
+        dir: dir_path(model_inspector)
+      )
+    end
+
+    result
+  end
+
+  def monetized_attributes(model_inspector)
+    result = []
+
+    model_inspector.money_attributes do |name|
+      result << PeakFlowUtils::TranslationService.new(
+        key: model_inspector.attribute_key(name),
+        dir: dir_path(model_inspector)
+      )
+    end
+
+    result
+  end
+
+  def globalize_attributes(model_inspector)
+    result = []
+
+    model_inspector.globalize_attributes do |name|
+      result << PeakFlowUtils::TranslationService.new(
+        key: model_inspector.attribute_key(name),
+        dir: dir_path(model_inspector)
+      )
+    end
+
+    result
+  end
+end