steroids 1.0.0 → 1.6.0

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  p 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Steroids'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/jobs/steroids/async_service_job.rb

@@ -0,0 +1,10 @@
+module Steroids
+  class AsyncServiceJob < ApplicationJob
+    queue_as Rails.application.config.active_job.queue_adapter
+
+    def perform(class_name:, params:)
+      service = class_name.constantize
+      service.new(**params).call
+    end
+  end
+end

data/app/serializers/steroids/error_serializer.rb

@@ -0,0 +1,35 @@
+module Steroids
+  class ErrorSerializer < Steroids::Serializers::Base
+    attribute :id
+    attribute :code
+    attribute :status
+    attribute :message
+    attribute :quote
+    attribute :errors
+    attribute :timestamp
+
+    attributes :exception,
+               :message,
+               if: -> { Rails.env.development? }
+
+    def exception
+      if @object.respond_to?(:cause) && @object.cause.present?
+        @object.cause.class.to_s&.demodulize
+      else
+        @object.class.to_s&.demodulize
+      end
+    end
+
+    def message
+      [
+        @object.message,
+        Rails.env.development? && @object.respond_to?(:cause) && @object.cause.present? ?
+          @object.cause : nil
+      ].compact.join(" - Cause by: ")
+    end
+
+    def timestamp
+      @object.timestamp
+    end
+  end
+end

data/lib/resources/quotes.yml

@@ -0,0 +1,114 @@
+- Dance like nobody is watching, code like everybody is."
+- "A deployed MVP is worth two prototyped."
+- "When you reach bearded-level, there are at least a hundred grey-beards above you."
+- "A/B Test twice, deploy changes once."
+- "Don't commit on master when drunk."
+- "Sleep on a force push."
+- "T_PAAMAYIM_NEKUDOTAYIM"
+- "SEGMENTATION_FAULT"
+- "A git pull a day, keeps the doctor away."
+- "Sometimes you have to cut legacy support to allow the new product to bloom."
+- "More hours worked, more commits made. Mostly reverts and bug-causing features."
+- "Even a greybeard will drop production DB."
+- "Scope creep makes a mountain."
+- "A hundred programmers won't make a two-year project in a week."
+- "Facebook wasn't built in a day."
+- "Just ship is no substitute for design."
+- "Today's fashion is tomorrow's legacy."
+- "Learning obscure and strange languages, yields better understanding and broader horizons."
+- "The better job you do, the easier others discount the level of difficulty."
+- "Testing is easier than debugging."
+- "Finish a product in a day, and people will expect a new product every day. Teach people about proper development cycles, and your company will flourish."
+- "Customers are the best testers."
+- "Absence is beauty, in error logs."
+- "Eternal sunshine of the stateless mind."
+- "Laziness is your best friend. Never do twice what you can automate once."
+- "Good test coverage + automated workflows = quiet cell phones and better sleep."
+- "The best code is no code at all."
+- "The best request is the one you don't make."
+- "If a system works perfectly, no one will care what is inside it. Once it breaks, systems design and architecture decides your fate."
+- "Leave architecture for applications that require long-term support."
+- "Architecture and design are preparations for problems and changes, not a key to runtime."
+- "Without a prototype, don't build a final product."
+- "Without boilerplate, there's no speedy development."
+- "Code frustration is a bad advisor for a refactor."
+- "The more technology you learn, the more you realize how little you know."
+- "An early BETA launch will teach you more than a delayed promise."
+- "All applications are pretty when your screen is off."
+- "Do not pick a framework for its demo page, instead pick it for its code."
+- "You cannot set a web standard alone."
+- "A poor programmer blames the language."
+- "The code's writin' but ain't nobody programming."
+- "Mañana often has the most tickets."
+- "Never optimize before measuring"
+- "Think about your dance moves when drunk, next time you try to code with some beers on your count."
+- "What happens in Git stays in Git"
+- "Simpler code has less bugs."
+- "Lock up your dependency versions and other valuables."
+- "Quantity of attempts often yields quality at the end. Commitment to refactoring legacy code yields better quality yet."
+- "Accept that some days you're the QA and some days you're the one fixing bugs."
+- "Give a programmer the correct code and he can do his work for a day. Teach a programmer to debug and he can do his work for a lifetime - by Chirag Gude"
+- "Debugging becomes significantly easier if you first admit that you are the problem."
+- "Figure out your data structures, and the code will follow."
+- "One thing should never do more than one thing."
+- "Success from a final version is a lie, there is only iteration. Through iteration, we gain better products. Through better products, we gain traction. Through traction, we gain success. Through success, misguided tech specs are broken. The development cycle shall free us."
+- "An open source developer does not act for personal fame."
+- "Public code review forces one to better oneself. It forces better practices, smarter solutions, growth as a developer... or being broken."
+- "Testing covers not testing."
+- "The most attractive pull requests are the ones wearing a lot of red."
+- "Coding styleguides without peer code reviews are like running a country on voluntary taxes"
+- "Deploying an unmonitored app is like going on a roadtrip without a gas gauge."
+- "Learn a programming language, become a new developer."
+- "Some old code never refactors, and breaks at the slightest change."
+- "A developer will spot a peer from far away"
+- "A developer that codes until burnout, lives without a mind."
+- "A marketer is not a QA, a developer does not advertise."
+- "A soft spoken developer will see his warnings of technical debt unheeded, and will suffer the blame."
+- "A well spoken developer can be hired hastily but at the last minute fail an easy test."
+- "One can self-learn the art of code but do not assume other crafts suffer of such low bar of entry."
+- "Find ease in your code; Code difficult to read and understand is code destined to be in troubled legacy."
+- "Collaborating on open source projects can bring about friendship and community just as it can create factions and flame wars."
+- "Refactor or rewrite, there is no patching unmaintainable legacy code"
+- "If you stop learning now and take the easy path, you will find yourself stuck in legacy software forever."
+- "A beautiful product which is pleasing to non-paying users is good only for frightening investors when it runs out of funding."
+- "A foreach loop avoided is a CPU cycle earned."
+- "You cannot prevent managers from asking too much of you, but you can prevent them from getting used to it."
+- "Any sufficiently complex app architecture is indistinguishable from spaghetti code."
+- "Writing requirements based code and walking on water are both relatively easy to do when frozen."
+- "It takes twice as much intelligence to debug than to program, therefore you peer review because you can never truly be smart enough to debug your own code."
+- "Hofstadter's Law will tell you to always add more time than you think you need to a project because it will take longer, even when you take into account Hofstadter's Law."
+- "Long lasting code is written only when you pretend that it will be peer reviewed or maintained by a violent psycopath who knows where you live."
+- "Small bug becomes a huge problem."
+- "Commiting is the only command I know, Commiting on you."
+- "Don't use `eval()` or unexpected bugs/horrible creatures from outer space might start popping-up."
+- "After three days without programming, life becomes meaningless."
+- "When the program is being tested, it is too late to make design changes."
+- "When you have learned to snatch the error code from the trap frame, it will be time for you to leave."
+- "A well-written program is its own heaven; a poorly-written program is its own hell."
+- "Though a program be but three lines long, someday it will have to be maintained."
+- "Let the programmer be many and the managers few - then all will be productive."
+- "You can demonstrate a program for a corporate executive, but you can't make him computer literate."
+- "Without the wind, the grass does not move. Without software, hardware is useless."
+- "A problem has been detected and Windows has been shut down to prevent damage to your computer."
+- "\"Fatal Exception 0E\" Error Message Attempting to Open Folder 176446 (Microsoft Internet Explorer for Win95)."
+- "Fatal exception 0E has occurred at 0028:C02B9568 in VXD IFSMGR(04) + 00012AEC 273918 (running the Sysinternal Filemon.exe program during Win Me Setup.)"
+- "NoMethodError (undefined method 'nil_class?' for nil:NilClass)"
+- "When you send information to the Internet, it might be possible for others to see that information. Do you want to continue?"
+- "Are you sure engineering is right for you? I heard the sales departement was looking for someone."
+- "Out of memory error: Kill process, score, or sacrifice child."
+- "Keyboard not responding. Press any key to continue."
+- "Task failed successfully (no comments)."
+- "Success! There was an error."
+- "The “Delete” operation will erase the contents of your hard.drive. Proceed or delete?"
+- "Something happened error, ¿but what?"
+- "Windows Phone Installation Disc Error."
+- "Guru Meditation error."
+- "Abort, Retry, Fail?"
+- "Critical error. All your files are exactly where you left them."
+- "Your Password Must Be at Least 18770 Characters"
+- "You are not authorized to view this error"
+- "Never in the history of boredom has anyone been more bored than I am right now."
+- "Artificial Intelligence usually beats natural stupidity."
+- "To err is human... to really foul up requires the root password."
+- "This problem exists between the chair and keyboard."
+- "1f u c4n r34d th1s u r34lly n33d t0 g37 l41d"

data/lib/steroids/controllers/methods.rb

@@ -0,0 +1,18 @@
+module Steroids
+  module Controllers
+    module Methods
+      extend ActiveSupport::Concern
+
+      included do
+        include RespondersHelper
+        include SerializersHelper
+        include Support::ServicableMethods
+
+        def context
+          Rails.logger.warn('Using context is deprecated and will be removed.') unless Rails.env.production?
+          @context ||= ActiveSupport::HashWithIndifferentAccess.new
+        end
+      end
+    end
+  end
+end

data/lib/{concerns/controller.rb → steroids/controllers/responders_helper.rb}

@@ -1,23 +1,30 @@
 module Steroids
-  module Concerns
-    module Controller
+  module Controllers
+    module RespondersHelper
       extend ActiveSupport::Concern
-      included do
-        before_action do
-          context.add(params: params)
-        end
 
+      included do
         protected
 
-        def respond_with(data, options = {})
-          options = __parse_options(data, options)
-          data = __apply_scopes(data, options)
-          data = __apply_pagination(data, options)
-          return __response(data, options)
+        def respond_with(*resources, &block)
+          resource = resources.first
+          respond_to do | format |
+            format.json {
+              options = resources.extract_options!
+              options = __parse_options(resource, options)
+              scoped_data = __apply_scopes(resource, options)
+              paginated_data = __apply_pagination(scoped_data, options)
+              return __response(paginated_data, options)
+            }
+            format.any {
+              return defined?(super) ? super(*resources, &block) : resource
+            }
+          end
         end
 
         def context
-          @context ||= Steroids::Base::Hash.new
+          Rails.logger.warn('Using context is deprecated and will be removed.') unless Rails.env.production?
+          @context ||= ActiveSupport::HashWithIndifferentAccess.new
         end
 
         private
@@ -53,20 +60,12 @@ module Steroids
           status = options[:status]
           if data
             options = options.merge({ json: data })
-            options = options.merge(@context)
+            options = options.merge(@context || {})
             render(options)
           else
             status ? head(status) : raise(Steroids::Errors::NotFoundError)
           end
         end
-
-        class << self
-          attr_accessor :serializer
-
-          def default_serializer(serializer)
-            @serializer = serializer
-          end
-        end
       end
     end
   end

data/lib/steroids/controllers/serializers_helper.rb

@@ -0,0 +1,15 @@
+module Steroids
+  module Controllers
+    module SerializersHelper
+      extend ActiveSupport::Concern
+
+      class_methods do
+        attr_accessor :serializer
+
+        def default_serializer(serializer)
+          @serializer = serializer
+        end
+      end
+    end
+  end
+end

data/lib/steroids/engine.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Steroids
+  class Engine < ::Rails::Engine
+    config.steroids = Steroids
+  end
+end

data/lib/steroids/errors/base.rb

@@ -0,0 +1,57 @@
+module Steroids
+  module Errors
+    class Base < StandardError
+      include ActiveModel::Serialization
+      include Context
+      include Quotes
+
+      OTPIONS = %i[status message errors code cause context log]
+
+      class_attribute :default_message, default: "Oops, something went wrong (Unknown error)"
+      class_attribute :default_status, default: :internal_server_error
+
+      attr_reader :id, :message, :cause, :code, :status, :errors,
+                      :record, :context, :timestamp, :logged
+
+      def initialize(message_string = nil, **options)
+        @caller = caller
+        extended_options = options.select{|key|OTPIONS.include?(key)}
+        splat_options = options.select{|key|!OTPIONS.include?(key)}
+        define_instance_variables_for(message_string, **extended_options)
+        super(**splat_options, message: message, cause: @cause)
+        set_backtrace(@cause&.backtrace || backtrace_locations || caller)
+        extended_options.fetch(:log, false) ? self.log! : self.quiet_log
+      end
+
+      def to_json
+        Steroids::ErrorSerializer.new(self).to_json
+      end
+
+      def log!
+        Steroids::Logger.print(self)
+        @logged = true
+      end
+
+      def cause_message
+        if cause
+          reflect_on(cause, :original_message) || reflect_on(cause, :message)
+        end
+      end
+
+      private
+
+      def reflect_on(cause, key)
+        logged = cause.respond_to?(:logged) && cause.logged
+        cause.respond_to?(key) && logged != true ? cause.public_send(key) : nil
+      end
+
+      def quiet_log
+        Steroids::Logger.print(
+          "#{Rainbow("▶").magenta} #{Rainbow(self.class.name).red} -- #{Rainbow(self.message).magenta} (quiet)",
+          verbosity: :concise,
+          format: :raw
+        )
+      end
+    end
+  end
+end

data/lib/steroids/errors/context.rb

@@ -0,0 +1,70 @@
+module Steroids
+  module Errors
+    module Context
+      extend ActiveSupport::Concern
+
+      included do |base|
+        private
+
+        def define_instance_variables_for(
+          message_string,
+          status: false,
+          message: false,
+          errors: nil,
+          code: nil,
+          cause: nil,
+          context: false,
+          log: false,
+          **splat
+        )
+          @timestamp = DateTime.now
+          @id = SecureRandom.uuid
+          @message = assert_message(cause, message_string || message)
+          @context = assert_context(cause, context)
+          @errors = assert_errors(cause, errors)
+          @status = assert_status(cause, status)
+          @code = assert_code(code)
+          @record = assert_record(cause)
+          @quote = quote
+          @cause = cause
+        end
+
+        # ------------------------------------------------------------------------------------------
+        # DERIVE ERROR ATTRIBUTES
+        # ------------------------------------------------------------------------------------------
+
+        def assert_message(cause, message)
+          message || self.default_message
+        end
+
+        def assert_context(cause, context)
+          context || reflect_on(cause, :context)
+        end
+
+        def assert_status(cause, status)
+          status || reflect_on(cause, :status) || assert_status_from_error(cause) || self.default_status || :unknown_error
+        end
+
+        def assert_status_from_error(cause)
+          error_class = cause.is_a?(Exception) ? cause.class : self.class
+          ActionDispatch::ExceptionWrapper.rescue_responses[error_class.name] || :internal_server_error
+        end
+
+        def assert_code(status)
+          status ? Rack::Utils.status_code(status) : 520
+        end
+
+        def assert_errors(cause, errors = [])
+          cause_errors = reflect_on(cause, :errors) || []
+          record_instance = reflect_on(cause, :record)
+          validations_errors = Array(reflect_on(record_instance, :errors)) || []
+          [Array(errors), cause_errors, validations_errors].flatten.compact.uniq
+        end
+
+        def assert_record(cause, errors = [])
+          reflect_on(cause, :record)
+        end
+      end
+    end
+  end
+end

data/lib/steroids/errors/quotes.rb

@@ -0,0 +1,29 @@
+module Steroids
+  module Errors
+    module Quotes
+      extend ActiveSupport::Concern
+
+      included do
+        QUOTES_FILEPATH = "lib/resources/quotes.yml"
+
+        protected
+
+        def load_quotes
+          File.join(Steroids.root_path, QUOTES_FILEPATH)
+        end
+
+        def quote
+          Rails.cache.fetch("steroids/quotes") do
+            begin
+                YAML.load_file(path)
+            rescue StandardError => e
+              Rails.logger.error(e)
+              quotes = ["One little bug..."]
+            end
+            quotes.sample
+          end
+        end
+      end
+    end
+  end
+end

data/lib/steroids/errors.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+module Steroids
+  module Errors
+    # ##############################################################################################
+    # Steroids errors
+    # ##############################################################################################
+
+    class GenericError < Steroids::Errors::Base
+      self.default_message = "Steroids error (Generic)"
+      self.default_status = :generic_error
+    end
+
+    # ##############################################################################################
+    # HTTP Error Codes (API)
+    # ##############################################################################################
+
+    # ----------------------------------------------------------------------------------------------
+    # BadRequestError
+    # ----------------------------------------------------------------------------------------------
+
+    class BadRequestError < Steroids::Errors::Base
+      self.default_message = "Request failed (BadRequestError)."
+      self.default_status = :bad_request
+    end
+
+    # ----------------------------------------------------------------------------------------------
+    # ConflictError
+    # ----------------------------------------------------------------------------------------------
+
+    class ConflictError < Steroids::Errors::Base
+      self.default_message = "Already exists (InternalConflictError)"
+      self.default_status = :conflict
+    end
+
+    # ----------------------------------------------------------------------------------------------
+    # ForbiddenError
+    # ----------------------------------------------------------------------------------------------
+
+    class ForbiddenError < Steroids::Errors::Base
+      self.default_message = "You shall not pass! (ForbiddenError)"
+      self.default_status = :forbidden
+    end
+
+    # ----------------------------------------------------------------------------------------------
+    # InternalServerError
+    # ----------------------------------------------------------------------------------------------
+
+    class InternalServerError < Steroids::Errors::Base
+      self.default_message = "Oops, something went wrong (InternalServerError)"
+      self.default_status = :internal_server_error
+    end
+
+    # ----------------------------------------------------------------------------------------------
+    # NotFoundError
+    # ----------------------------------------------------------------------------------------------
+
+    class NotFoundError < Steroids::Errors::Base
+      self.default_message = "We couldn't find what you were looking for (NotfoundError)"
+      self.default_status = :not_found
+    end
+
+    # ----------------------------------------------------------------------------------------------
+    # NotImplementedError
+    # ----------------------------------------------------------------------------------------------
+
+    class NotImplementedError < Steroids::Errors::Base
+      self.default_message = "This feature hasn't been implemented yet (NotImplementedError)"
+      self.default_status = :not_implemented
+    end
+
+    # ----------------------------------------------------------------------------------------------
+    # UnauthorizedError
+    # ----------------------------------------------------------------------------------------------
+
+    class UnauthorizedError < Steroids::Errors::Base
+      self.default_message = "You shall not pass! (Unauthorized)"
+      self.default_status = :unauthorized
+    end
+
+    # ----------------------------------------------------------------------------------------------
+    # UnprocessableEntityError
+    # ----------------------------------------------------------------------------------------------
+
+    class UnprocessableEntityError < Steroids::Errors::Base
+      self.default_message = "We couldn't understand your request (UnprocessableEntityError)"
+      self.default_status = :unprocessable_entity
+    end
+  end
+end

data/lib/steroids/extensions/array_extension.rb

@@ -0,0 +1,25 @@
+module Steroids
+  module Extensions
+    module ArrayExtension
+      class ElementNotFound < StandardError; end
+
+      def cast(value)
+        self.find { |item| item == value } or raise ElementNotFound.new("Cast: Element not found (#{value})")
+      end
+
+      def find_map(&block)
+        return enum_for(:find_map) unless block_given?
+
+        each do |element|
+          result = yield(element)
+
+          return result if result
+        end
+
+        nil
+      end
+    end
+  end
+end
+
+Array.include(Steroids::Extensions::ArrayExtension)