onsi 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11cdb10f50e5e342639f7957e3e2cf867decc2773065232c3a880983936a5122
-  data.tar.gz: f37f95aaddd5d3736a7f165b4362876ef7a7a60865bae5183b7b850ba4ad6746
+  metadata.gz: 298c09a10a76e2ae896cd679cc6db43ae6da637f6048c572722c1285d5616fd9
+  data.tar.gz: c58a5048a9795d2b8a260f615915837d240e59809864088d67900e2e290bf38c
 SHA512:
-  metadata.gz: fce49cd88116a547bd44bdc835b5def7a2dc5d54b07360d0185bf99008ba66c02a7821dadcc77cf9909bc62549ce57af5d30fd27c1eed9068d67041bdd943638
-  data.tar.gz: 452661c725d56fc43dd03a16499321614063830a4cfc6d4af29fb122d6c8349e71f4d122d8d56637fa80eaee80bc89be3a36e55a7aa6b20415db83ffaae6e2e4
+  metadata.gz: 8255c49dda505912b3378d72a1ecd0f568141b9551f11ede3ec5df78b5dcf3ceee7b07130b8d0573fda914e8affb2c92b9a75235b5423cf93d4cb1e141eda7e7
+  data.tar.gz: 9330c0a7162ac3100d0079d1cfc241449b83e715ca5591f8b7005c794a62c0671379a96a1f10f0bff7f8783fdc5e7f7b35a6f83efd3c024a1100b082e31546a5

data/lib/onsi/error_responder.rb

@@ -1,6 +1,8 @@
 require 'active_support/concern'
 
 module Onsi
+  ##
+  # Handles default errors and builds JSON-API responses.
   module ErrorResponder
     extend ActiveSupport::Concern
 
@@ -99,6 +101,7 @@ module Onsi
       return nil unless Rails.configuration.consider_all_requests_local
       {
         exception: {
+          '_note' => '`exception` will be removed if Rails.configuration.consider_all_requests_local is false',
           class: error.class.name,
           message: error.message,
           backtrace: error.backtrace

data/lib/onsi/params.rb

@@ -1,5 +1,12 @@
 module Onsi
+  ##
+  # Used to handle parsing JSON-API formated params
   class Params
+    ##
+    # Raised when using `Params#safe_fetch`
+    #
+    # The ErrorResponder will rescue from this and return an appropriate
+    # error to the user
     class RelationshipNotFound < StandardError
       attr_reader :key
 
@@ -9,6 +16,11 @@ module Onsi
       end
     end
 
+    ##
+    # Raised when a required attribute has a nil value. `Params#require`
+    #
+    # The ErrorResponder will rescue from this and return an appropriate
+    # error to the user
     class MissingReqiredAttribute < StandardError
       attr_reader :attribute
 
@@ -68,14 +80,22 @@ module Onsi
       @relationships = relationships
     end
 
+    ##
+    # Flatten an merge the attributes & relationships into one hash.
     def flatten
-      attributes.to_h.merge(relationships.to_h).with_indifferent_access
+      attrs_hash.to_h.merge(relationships.to_h).with_indifferent_access
     end
 
+    ##
+    # Fetch a value from the attributes or return the passed default value
     def fetch(key, default = nil)
       attrs_hash[key] || default
     end
 
+    ##
+    # Make an attributes key required.
+    #
+    # Throws MissingReqiredAttribute if the value is nil
     def require(key)
       value = attrs_hash[key]
       if value.nil?
@@ -84,16 +104,81 @@ module Onsi
       value
     end
 
+    ##
+    # Handle finding a relationship's object
+    #
+    # If an ActiveRecord::RecordNotFound is raised, a RelationshipNotFound error will
+    # be raised so the ErrorResponder can build an appropriate error message
+    #
+    # params.safe_fetch(:person) do |id|
+    #   Person.find(id)
+    # end
     def safe_fetch(key)
       yield(@relationships[key])
     rescue ActiveRecord::RecordNotFound
       raise RelationshipNotFound.new("Can't find relationship #{key}", key)
     end
 
+    ##
+    # Perform a transform on the value
+    #
+    # Any getter will run the value through the transform block.
+    #
+    # (The values are memoized)
+    #
+    # `params.transform(:date) { |date| Time.parse(date) }`
+    def transform(key, &block)
+      @attrs_hash = nil
+      transforms[key.to_sym] = block
+    end
+
+    ##
+    # Set a default value.
+    #
+    # This value will only be used if the key is missing from the passed attributes
+    #
+    # Can take any object. If the object responds to call (Lambda) it will be called when
+    # parsing attributes
+    def default(key, value)
+      @attrs_hash = nil
+      defaults[key.to_sym] = value
+    end
+
     private
 
+    def transforms
+      @transforms ||= {}
+    end
+
+    def defaults
+      @defaults ||= {}
+    end
+
     def attrs_hash
-      @attrs_hash ||= attributes.to_h.with_indifferent_access
+      @attrs_hash ||= transform_attributes.merge(default_attributes).with_indifferent_access
+    end
+
+    def transform_attributes
+      attributes.to_h.each_with_object({}) do |(key, value), object|
+        transform = transforms[key.to_sym]
+        if transform
+          object[key] = transform.call(value)
+        else
+          object[key] = value
+        end
+      end
+    end
+
+    def default_attributes
+      raw_attrs = attributes.to_h.symbolize_keys
+      defaults.each_with_object({}) do |(key, value), object|
+        next if raw_attrs.key?(key)
+        if value.respond_to?(:call)
+          object[key] = value.call
+        else
+          object[key] = value
+        end
+      end
     end
   end
 end

data/lib/onsi/version.rb

@@ -1,3 +1,3 @@
 module Onsi
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/onsi.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'onsi/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onsi
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Skylar Schipper
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2018-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails