caprese 0.3.24 → 0.3.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ab60011a9ebcc4df7f6db15aa5fddaf4d45e17e
-  data.tar.gz: 1fc4b7e07dd201f6630cf313c0a8b509b02ee2ed
+  metadata.gz: 34252b10961eccda9b87897794f97016566a8e2d
+  data.tar.gz: f8b6e715a0cbbdbd9b71a81ef864872c09ab8aaa
 SHA512:
-  metadata.gz: b9c5bd9541636bc733733ae8d1f06be612e73f37b665a784d2ed69b0c9640c134e60c1629a867711e8ce104306348c2c289bc3baffe5b1e25a493e3b16ee2960
-  data.tar.gz: b7cf51285324c5647cfd5827e8089cc56e647362feccd61f0a0f36fcfd410a6d9beabb1f42aff54f0176a225ce7663568b3c97b662eebf1da48c5ad66fc7227b
+  metadata.gz: 289224faf57d9e726b555d8b10bf4114127f40d8469157f5320f7a30b6e5c01a7fdfeaf9802e61739beb4f6c2d966ead2fc7881c1ea99797c8e97ab2df2aecea
+  data.tar.gz: 525fb2eff4783c7f1c584db0ee9d4fb7ca2f0bd133661538d8ef28fb1f670898c631a965940c27b83190e86e0c29d081f4947afaa51f758de77b56cd82a33286

data/CHANGELOG.md

@@ -136,4 +136,8 @@
 
 ## 0.3.24
 
-* Add `Caprese.config.isolated_namespace` to enable Caprese to work with isolate_namespace Engines
+* Add `Caprese.config.isolated_namespace` to enable Caprese to work with isolate_namespace Engines by trimming the `isolated_namespace` off the front of the result of calls to `version_module`, `version_path`, `version_name`, etc.
+
+## 0.3.25
+
+* Add `namespaced_module` and `unnamespace` helper to Versioning that provides full module namespace when `config.isolate_namespace` is present (replaces the old functionality of `version_module` and `unversion`)

data/lib/caprese/concerns/url_helpers.rb

@@ -0,0 +1,20 @@
+require 'active_support/concern'
+
+module Caprese
+  module UrlHelpers
+    extend ActiveSupport::Concern
+
+    # Returns the proper route URL helpers based on whether or not Caprese is being used in an engine's
+    # isolated_namespace or just a regular application
+    def url_helpers
+      mod =
+        if namespace = Caprese.config.isolated_namespace
+          namespace::Engine
+        else
+          Rails.application
+        end
+
+      mod.routes.url_helpers
+    end
+  end
+end

data/lib/caprese/concerns/versioning.rb

@@ -4,7 +4,74 @@ module Caprese
   module Versioning
     extend ActiveSupport::Concern
 
+    # Get full namespaced module name of object (class)
+    #
+    # @example
+    #   namespaced_module('OrdersController') => 'API::V1::OrdersController'
+    #
+    # @param [String] suffix the string to append, hypothetically a module in
+    #  this namespace's module space
+    # @return [String] the namespaced modulized name of the suffix passed in
+    def namespaced_module(suffix = nil)
+      mod = (self.is_a?(Class) ? self : self.class).name.deconstantize
+
+      name = suffix || mod
+      name = name.prepend("#{mod}::") unless suffix.nil? || (/^#{mod}::\.*/).match(suffix)
+
+      name
+    end
+
+    # Get full namespaced path (url)
+    #
+    # @example
+    #   namespaced_path('orders') => 'api/v1/orders'
+    #
+    # @param [String] suffix the string to append, hypothetically an extension in
+    #   this namespace's path space
+    # @return [String] the full namespaced path name of the suffix passed in
+    def namespaced_path(suffix = nil)
+      namespaced_module.downcase.split('::').push(suffix).reject(&:nil?).join('/')
+    end
+
+    # Get full namespaced dot path (translations)
+    #
+    # @example
+    #   namespaced_dot_path('orders') => 'api/v1/orders'
+    #
+    # @param [String] suffix the string to append, hypothetically an extension in
+    #   this namespace's dot space
+    # @return [String] the full namespaced dot path of the suffix passed in
+    def namespaced_dot_path(suffix = nil)
+      namespaced_module.downcase.split('::').push(suffix).reject(&:nil?).join('.')
+    end
+
+    # Get full namespaced underscore name (routes)
+    #
+    # @example
+    #   namespaced_name('orders') => 'api_v1_orders'
+    #
+    # @param [String] suffix the string to append, hypothetically a name that
+    #  needs to be namespaced
+    # @return [String] the namespaced name of the suffix passed in
+    def namespaced_name(suffix = nil)
+      namespaced_module.downcase.split('::').push(suffix).reject(&:nil?).join('_')
+    end
+
+    # Strips string to raw unnamespaced format regardless of input format
+    #
+    # @param [String] str the string to unversion
+    # @return [String] the stripped, unnamespaced name of the string passed in
+    def unnamespace(str)
+      str
+      .remove(namespaced_module(''))
+      .remove(namespaced_path(''))
+      .remove(namespaced_name(''))
+      .remove(namespaced_dot_path(''))
+    end
+
     # Get versioned module name of object (class)
+    # @note The difference between namespaced and versioned module names is that if an isolated_namespace
+    #   is present, version_module will return a module name without the isolated namespace
     #
     # @example
     #   version_module('OrdersController') => 'API::V1::OrdersController'
@@ -13,11 +80,11 @@ module Caprese
     #  this version's module space
     # @return [String] the versioned modulized name of the suffix passed in
     def version_module(suffix = nil)
-      name = (self.is_a?(Class) ? self : self.class).name.deconstantize
+      name = namespaced_module(suffix)
 
       name = name.gsub("#{Caprese.config.isolated_namespace}::", '') if Caprese.config.isolated_namespace
 
-      name + (suffix ? "::#{suffix}" : '')
+      name
     end
 
     # Get versioned path (url)
@@ -45,6 +112,8 @@ module Caprese
     end
 
     # Get versioned underscore name (routes)
+    # @note The difference between namespaced and versioned module names is that if an isolated_namespace
+    #   is present, version_module will return a module name without the isolated namespace
     #
     # @example
     #   version_name('orders') => 'api_v1_orders'

data/lib/caprese/controller/concerns/errors.rb

@@ -28,7 +28,7 @@ module Caprese
     # @param [Hash] t the interpolation params to be passed into I18n.t
     def error(field: nil, code: :invalid, t: {})
       Error.new(
-        controller: unversion(params[:controller]),
+        controller: unnamespace(params[:controller]),
         action: params[:action],
         field: field,
         code: code,

data/lib/caprese/controller/concerns/query.rb

@@ -169,7 +169,7 @@ module Caprese
     # @return [Relation] the record scope of the queried controller
     def queried_record_scope
       unless @queried_record_scope
-        scope = record_scope(unversion(params[:controller]).to_sym)
+        scope = record_scope(unnamespace(params[:controller]).to_sym)
 
         if scope.any? && query_params[:filter].try(:any?)
           if (valid_filters = query_params[:filter].select { |k, _| scope.column_names.include? actual_field(k).to_s }).present?

data/lib/caprese/controller/concerns/relationships.rb

@@ -58,11 +58,10 @@ module Caprese
       links = { self: request.original_url }
 
       if !target.respond_to?(:to_ary) &&
-        Rails.application.routes.url_helpers
-        .respond_to?(related_url = version_name("#{params[:relationship].singularize}_url"))
+        url_helpers.respond_to?(related_url = version_name("#{params[:relationship].singularize}_url"))
 
         links[:related] =
-          Rails.application.routes.url_helpers.send(
+          url_helpers.send(
             related_url,
             target.read_attribute(self.config.resource_primary_key),
             host: caprese_default_url_options_host
@@ -117,10 +116,10 @@ module Caprese
       links = { self: request.original_url }
 
       # Add related link for this relationship if it exists
-      if Rails.application.routes.url_helpers
-        .respond_to?(related_path = "relationship_data_#{version_name(unversion(params[:controller]).singularize)}_url")
+      if url_helpers
+        .respond_to?(related_path = "relationship_data_#{version_name(unnamespace(params[:controller]).singularize)}_url")
 
-        links[:related] = Rails.application.routes.url_helpers.send(
+        links[:related] = url_helpers.send(
           related_path,
           params[:id],
           params[:relationship],

data/lib/caprese/controller/concerns/rendering.rb

@@ -66,7 +66,7 @@ module Caprese
     # @return [Serializer] the serializer for the class
     def get_serializer_for(klass)
       begin
-        version_module("#{klass.name}Serializer").constantize
+        namespaced_module("#{klass.name}Serializer").constantize
       rescue NameError => e
         get_serializer_for(klass.superclass) if klass.superclass
       end

data/lib/caprese/controller/concerns/typing.rb

@@ -31,7 +31,7 @@ module Caprese
     #
     # @return [Class] the record class for the current controller
     def controller_record_class
-      record_class(unversion(params[:controller]))
+      record_class(unnamespace(params[:controller]))
     end
 
     # Checks if a given type mismatches the controller type

data/lib/caprese/controller.rb

@@ -1,5 +1,6 @@
 require 'action_controller'
 require 'active_support/configurable'
+require 'caprese/concerns/url_helpers'
 require 'caprese/concerns/versioning'
 require 'caprese/controller/concerns/aliasing'
 require 'caprese/controller/concerns/callbacks'
@@ -24,7 +25,9 @@ module Caprese
     include Relationships
     include Rendering
     include Typing
+    include UrlHelpers
     include Versioning
+    extend UrlHelpers
     extend Versioning
   end
 end

data/lib/caprese/serializer/concerns/links.rb

@@ -13,7 +13,7 @@ module Caprese
         #   links = { self: '/api/v1/orders/asd27hß' }
         link :self do
           if(url = serializer.class.route_for(object))
-            Rails.application.routes.url_helpers.send(
+            serializer.url_helpers.send(
               url,
               object.read_attribute(Caprese.config.resource_primary_key),
               host: serializer.class.send(:caprese_default_url_options_host)
@@ -84,9 +84,9 @@ module Caprese
 
           Proc.new do |serializer|
             link :self do
-              url = "relationship_definition_#{serializer.version_name("#{object.class.name.underscore}_url")}"
-              if Rails.application.routes.url_helpers.respond_to? url
-                Rails.application.routes.url_helpers.send(
+              url = "relationship_definition_#{serializer.version_name("#{serializer.unnamespace(object.class.name).underscore}_url")}"
+              if serializer.url_helpers.respond_to? url
+                serializer.url_helpers.send(
                   url,
                   id: object.read_attribute(primary_key),
                   relationship: reflection_name,
@@ -96,9 +96,9 @@ module Caprese
             end
 
             link :related do
-              url = "relationship_data_#{serializer.version_name("#{object.class.name.underscore}_url")}"
-              if Rails.application.routes.url_helpers.respond_to? url
-                Rails.application.routes.url_helpers.send(
+              url = "relationship_data_#{serializer.version_name("#{serializer.unnamespace(object.class.name).underscore}_url")}"
+              if serializer.url_helpers.respond_to? url
+                serializer.url_helpers.send(
                   url,
                   id: object.read_attribute(primary_key),
                   relationship: reflection_name,

data/lib/caprese/serializer/concerns/lookup.rb

@@ -54,7 +54,7 @@ module Caprese
         # @return [Serializer] the serializer for the class
         def get_serializer_for(klass)
           begin
-            version_module("#{klass.name}Serializer").constantize
+            namespaced_module("#{klass.name}Serializer").constantize
           rescue NameError => e
             get_serializer_for(klass.superclass) if klass.superclass
           end
@@ -68,7 +68,7 @@ module Caprese
         def get_route_for(klass)
           output = nil
           while klass.superclass do
-            if Rails.application.routes.url_helpers.respond_to?(url = version_name("#{klass.name.underscore}_url"))
+            if url_helpers.respond_to?(url = version_name("#{unnamespace(klass.name).underscore}_url"))
               output = url
               break
             end

data/lib/caprese/serializer.rb

@@ -1,4 +1,5 @@
 require 'active_model_serializers'
+require 'caprese/concerns/url_helpers'
 require 'caprese/concerns/versioning'
 require 'caprese/serializer/concerns/aliasing'
 require 'caprese/serializer/concerns/links'
@@ -7,7 +8,9 @@ require 'caprese/serializer/concerns/relationships'
 
 module Caprese
   class Serializer < ActiveModel::Serializer
+    extend UrlHelpers
     extend Versioning
+    include UrlHelpers
     include Versioning
     include Aliasing
     include Links

data/lib/caprese/version.rb

@@ -1,3 +1,3 @@
 module Caprese
-  VERSION = '0.3.24'
+  VERSION = '0.3.25'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caprese
 version: !ruby/object:Gem::Version
-  version: 0.3.24
+  version: 0.3.25
 platform: ruby
 authors:
 - Nick Landgrebe
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-29 00:00:00.000000000 Z
+date: 2017-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -222,6 +222,7 @@ files:
 - lib/caprese/adapter/json_api/pagination_links.rb
 - lib/caprese/adapter/json_api/relationship.rb
 - lib/caprese/adapter/json_api/resource_identifier.rb
+- lib/caprese/concerns/url_helpers.rb
 - lib/caprese/concerns/versioning.rb
 - lib/caprese/controller.rb
 - lib/caprese/controller/concerns/aliasing.rb