commons_yellowme 0.11.0 → 0.11.1

data/spec/commons/serializers/precondition_failed_spec.rb

@@ -0,0 +1,46 @@
+RSpec.describe Commons::Errors::PreconditionFailed, type: :serializer do
+  let(:title) { Faker::Name.name }
+  let(:message) { Faker::Name.name }
+  let(:detail) { Faker::Name.name }
+  let(:meta) { { data: Faker::Name.name } }
+  let(:error) { described_class.new }
+  subject do
+    serializer = Commons::Errors::ErrorSerializer.new(error)
+    serializer.serializable_hash
+  end
+
+  describe 'serialize the model' do
+    context 'should validate required attributes' do
+      it do
+        serialized = subject
+        expect(serialized.keys).to include :status
+        expect(serialized.keys).to include :code
+        expect(serialized.keys).to include :title
+        expect(serialized.keys).to include :detail
+      end
+    end
+
+    context 'should work with default values' do
+      it do
+        serialized = subject
+        expect(serialized[:status]).to eq error.status
+        expect(serialized[:code]).to eq error.code
+        expect(serialized[:title]).to eq error.title
+        expect(serialized[:detail]).to eq error.detail
+        expect(serialized[:meta]).to eq error.meta
+      end
+    end
+
+    context 'should work with custom values' do
+      let(:error) { described_class.new(message, title: title, detail: detail, meta: meta) }
+      it do
+        serialized = subject
+        expect(serialized[:status]).to eq error.status
+        expect(serialized[:title]).to eq title
+        expect(serialized[:detail]).to eq detail
+        expect(serialized[:meta][:message]).to eq message
+        expect(serialized[:meta][:data]).to eq meta[:data]
+      end
+    end
+  end
+end

data/spec/commons/serializers/route_not_found_spec.rb

@@ -0,0 +1,46 @@
+RSpec.describe Commons::Errors::RouteNotFound, type: :serializer do
+  let(:title) { Faker::Name.name }
+  let(:message) { Faker::Name.name }
+  let(:detail) { Faker::Name.name }
+  let(:meta) { { data: Faker::Name.name } }
+  let(:error) { described_class.new }
+  subject do
+    serializer = Commons::Errors::ErrorSerializer.new(error)
+    serializer.serializable_hash
+  end
+
+  describe 'serialize the model' do
+    context 'should validate required attributes' do
+      it do
+        serialized = subject
+        expect(serialized.keys).to include :status
+        expect(serialized.keys).to include :code
+        expect(serialized.keys).to include :title
+        expect(serialized.keys).to include :detail
+      end
+    end
+
+    context 'should work with default values' do
+      it do
+        serialized = subject
+        expect(serialized[:status]).to eq error.status
+        expect(serialized[:code]).to eq error.code
+        expect(serialized[:title]).to eq error.title
+        expect(serialized[:detail]).to eq error.detail
+        expect(serialized[:meta]).to eq error.meta
+      end
+    end
+
+    context 'should work with custom values' do
+      let(:error) { described_class.new(message, title: title, detail: detail, meta: meta) }
+      it do
+        serialized = subject
+        expect(serialized[:status]).to eq error.status
+        expect(serialized[:title]).to eq title
+        expect(serialized[:detail]).to eq detail
+        expect(serialized[:meta][:message]).to eq message
+        expect(serialized[:meta][:data]).to eq meta[:data]
+      end
+    end
+  end
+end

data/spec/commons/serializers/unauthorized_spec.rb

@@ -0,0 +1,46 @@
+RSpec.describe Commons::Errors::Unauthorized, type: :serializer do
+  let(:title) { Faker::Name.name }
+  let(:message) { Faker::Name.name }
+  let(:detail) { Faker::Name.name }
+  let(:meta) { { data: Faker::Name.name } }
+  let(:error) { described_class.new }
+  subject do
+    serializer = Commons::Errors::ErrorSerializer.new(error)
+    serializer.serializable_hash
+  end
+
+  describe 'serialize the model' do
+    context 'should validate required attributes' do
+      it do
+        serialized = subject
+        expect(serialized.keys).to include :status
+        expect(serialized.keys).to include :code
+        expect(serialized.keys).to include :title
+        expect(serialized.keys).to include :detail
+      end
+    end
+
+    context 'should work with default values' do
+      it do
+        serialized = subject
+        expect(serialized[:status]).to eq error.status
+        expect(serialized[:code]).to eq error.code
+        expect(serialized[:title]).to eq error.title
+        expect(serialized[:detail]).to eq error.detail
+        expect(serialized[:meta]).to eq error.meta
+      end
+    end
+
+    context 'should work with custom values' do
+      let(:error) { described_class.new(message, title: title, detail: detail, meta: meta) }
+      it do
+        serialized = subject
+        expect(serialized[:status]).to eq error.status
+        expect(serialized[:title]).to eq title
+        expect(serialized[:detail]).to eq detail
+        expect(serialized[:meta][:message]).to eq message
+        expect(serialized[:meta][:data]).to eq meta[:data]
+      end
+    end
+  end
+end

data/spec/commons/serializers/unprocessable_entity_spec.rb

@@ -0,0 +1,46 @@
+RSpec.describe Commons::Errors::UnprocessableEntity, type: :serializer do
+  let(:title) { Faker::Name.name }
+  let(:message) { Faker::Name.name }
+  let(:detail) { Faker::Name.name }
+  let(:meta) { { data: Faker::Name.name } }
+  let(:error) { described_class.new }
+  subject do
+    serializer = Commons::Errors::ErrorSerializer.new(error)
+    serializer.serializable_hash
+  end
+
+  describe 'serialize the model' do
+    context 'should validate required attributes' do
+      it do
+        serialized = subject
+        expect(serialized.keys).to include :status
+        expect(serialized.keys).to include :code
+        expect(serialized.keys).to include :title
+        expect(serialized.keys).to include :detail
+      end
+    end
+
+    context 'should work with default values' do
+      it do
+        serialized = subject
+        expect(serialized[:status]).to eq error.status
+        expect(serialized[:code]).to eq error.code
+        expect(serialized[:title]).to eq error.title
+        expect(serialized[:detail]).to eq error.detail
+        expect(serialized[:meta]).to eq error.meta
+      end
+    end
+
+    context 'should work with custom values' do
+      let(:error) { described_class.new(message, title: title, detail: detail, meta: meta) }
+      it do
+        serialized = subject
+        expect(serialized[:status]).to eq error.status
+        expect(serialized[:title]).to eq title
+        expect(serialized[:detail]).to eq detail
+        expect(serialized[:meta][:message]).to eq message
+        expect(serialized[:meta][:data]).to eq meta[:data]
+      end
+    end
+  end
+end

data/spec/commons/shared-examples/user_spec.rb

@@ -0,0 +1,18 @@
+require 'support/shared-examples/dimorphic'
+require 'support/shared-examples/deletable'
+require 'support/shared-examples/undestroyable'
+require 'support/shared-examples/capitalizable'
+require 'support/shared-examples/stripable'
+
+RSpec.describe User, type: :model do
+  let(:user) { create(:user) }
+  subject { user }
+
+  context 'shared-example' do
+    it_behaves_like "undestroyable"
+    it_behaves_like "deletable"
+    it_behaves_like "dimorphic"
+    it_behaves_like "capitalizable", ['name']
+    it_behaves_like "stripable", ['name', 'last_name']
+  end
+end

data/spec/dummy/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.1

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/stylesheets/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/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/controllers/miscellaneous_controller.rb

@@ -0,0 +1,13 @@
+class MiscellaneousController < ApplicationController
+  include Commons::Authentication::AuthenticateByJWT
+  # always include your handlers first in order to preserve last priority
+  # https://stackoverflow.com/a/9121054/3287738
+  include DefaultHandling
+  include Commons::Errors::DefaultHandling
+
+  before_action :authorize_jwt!
+
+  def application_parameters
+    render json: [{}]
+  end
+end

data/spec/dummy/app/errors/default_handling.rb

@@ -0,0 +1,35 @@
+# :nocov:
+module DefaultHandling
+  def self.included(cls)
+    cls.class_eval do
+      include ErrorNotifier
+
+      # must go first in order to preserve last priority
+      # https://stackoverflow.com/a/9121054/3287738
+      rescue_from StandardError do |e|
+        report_error(e)
+        respond Commons::Errors::InternalServerError.new
+      end
+
+      rescue_from Commons::Errors::ErrorBase do |e|
+        if e.instance_of?(Commons::Errors::InternalServerError) ||
+           e.is_a?(Commons::Errors::InternalServerError) ||
+           Rails.env.development?
+          report_error(e)
+        end
+        respond e
+      end
+    end
+  end
+
+  def respond(error)
+    render json: [error],
+           status: error.status,
+           each_serializer: Commons::Errors::ErrorSerializer
+  end
+
+  def report_error(param)
+    print_trace(param)
+  end
+end
+# :nocov:

data/spec/dummy/app/errors/error_notifier.rb

@@ -0,0 +1,12 @@
+module ErrorNotifier
+  private
+
+  # :nocov:
+  def print_trace(e)
+    return if Rails.env.test? || e.nil?
+
+    puts e.message unless e.message.nil?
+    puts e.backtrace unless e.backtrace.nil?
+  end
+  # :nocov:
+end

data/spec/dummy/app/helpers/application_helper.rb

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

data/spec/dummy/app/javascript/packs/application.js

@@ -0,0 +1,15 @@
+// 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 rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/spec/dummy/app/mailers/application_mailer.rb

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

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/models/catalogs/application_parameter.rb

@@ -0,0 +1,6 @@
+module Catalogs
+  class ApplicationParameter < ApplicationRecord
+    validates :name, :value, presence: true
+    validates :name, uniqueness: true
+  end
+end

data/spec/dummy/app/models/employee.rb

@@ -0,0 +1,3 @@
+class Employee < ApplicationRecord
+  include Commons::Concerns::Extensions::Deleted
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,16 @@
+class User < ApplicationRecord
+  include Commons::Concerns::Attributes::Sex
+  include Commons::Concerns::Extensions::Deleted
+  include Commons::Concerns::Guard::Capitalizable
+  include Commons::Concerns::Validations::Undestroyable
+
+  capitalize only: [:name]
+
+  strip_attributes only: [:name, :last_name],
+                   allow_empty: true,
+                   collapse_spaces: true
+
+  validates :name,
+            :last_name,
+            presence: true
+end

data/spec/dummy/app/repositories/catalogs/application_parameter_repository.rb

@@ -0,0 +1,4 @@
+module Catalogs
+  class ApplicationParameterRepository < Commons::Repositories::Catalogs::BaseCatalog
+  end
+end

data/spec/dummy/app/repositories/employee_repository.rb

@@ -0,0 +1,2 @@
+class EmployeeRepository < Commons::Repositories::BaseRepository
+end

data/spec/dummy/app/repositories/user_repository.rb

@@ -0,0 +1,2 @@
+class UserRepository < Commons::Repositories::BaseRepository
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>