trax_controller 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2a0c3f89d4a18d3f4a2a657426d3cbbc171b2ebb
-  data.tar.gz: a6c561ef139611f7428793d35e2020c04e47b5cb
+SHA256:
+  metadata.gz: ed00dea1fdfcffa650fe001af13c9903a9e8cea3f8bcfaa1c944440c2ef8d293
+  data.tar.gz: f34a3dcd374fb0adddb5b126cc5e1f9a5ab69520ac1902e8b5399a2bf1e475cc
 SHA512:
-  metadata.gz: 8233b8ef9a6fb515e44e666bc42af3749c1c00790e2fc094c88b0d0d1f45fdf5d8cf5da6045855fdb45e3f46385556022d6297f039eba32c64d7fa9168b0df2d
-  data.tar.gz: 40c8a347d7552ba34035bf9264222b699d2ff0ae96d42762d401a06c20643017d8e2d98f1b18cd057ad0008db853b5d0fd65d60cd0723482bc6e040fbbd33f6e
+  metadata.gz: 9ff8023e73a5c5d27b0f337fccdc0f337fb5f4f91ec3e3ebbd5a4bce75c9fefa4c3373159848e86867ee3686e662e0eda6cec8814ac2f8cb830a5632731f34eb
+  data.tar.gz: 658915adb99f4b46f3fdb160abe4b217dccad146584df53949ddc47708ac3f9761bd7eb1baaae46e30d2b3d5619d4e998aa45a1380b38d31814bad7be55ba5b2

data/.gitignore

@@ -7,8 +7,10 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
 *.bundle
 *.so
 *.o
 *.a
+*.sqlite
 mkmf.log

data/Gemfile

@@ -2,8 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in trax_controller.gemspec
 gemspec
-# gem 'active_model_serializers', :github => 'rails-api/active_model_serializers', :branch => "0-10-stable"
-gem 'active_model_serializers', :github => 'rails-api/active_model_serializers', :branch => "0-10-stable", :ref => "6aba26049154712d65176708ffad55fcfe512ca0"
 
 group :test do
   gem 'activerecord'

data/lib/trax/controller/actions.rb

@@ -88,6 +88,16 @@ module Trax
         collection_root.singularize
       end
 
+      #this overwrite allows a separate set of params to be used for create/update
+      #i.e. product_params_for_create, product_params_for_update
+      def resource_params_method_name
+        if respond_to?("#{resource_instance_name}_params_for_#{params[:action]}", true)
+          "#{resource_instance_name}_params_for_#{params[:action]}"
+        else
+          super
+        end
+      end
+
       #will set the resource instance var to whatever you pass it, then render
       def render_resource!(object, **options)
         instance_variable_set(:"@#{self.class.resources_configuration[:self][:instance_name]}", object)
@@ -108,6 +118,17 @@ module Trax
         render json: { meta: { errors: errors } }, status: status, serializer: nil
       end
 
+      def render_resource_action_response(success_status: 200, failure_status: :method_not_allowed, **options)
+        respond_with_dual_blocks(resource, options) do |success, failure|
+          success.json do
+            render_resource(success_status, **options)
+          end
+          failure.json do
+            render_errors(failure_status, **options)
+          end
+        end
+      end
+
       def resource_error_messages(resource: _resource, **options)
         return nil unless resource.errors.any?
 

data/lib/trax/controller/collection/nested_search_scopes.rb

@@ -0,0 +1,29 @@
+module Trax
+  module Controller
+    module Collection
+      module NestedSearchScopes
+        extend ::ActiveSupport::Concern
+
+        module ClassMethods
+          def has_nested_scopes_for(scope_name, as:, model:, permitted_scopes: [], only: [:index, :search], type: :hash, **options)
+            has_scope(scope_name, as: as, only: only, type: type, **options) do |controller, scope, value|
+              scope_ivar_name = "@#{scope_name}_scope"
+              instance_variable_set(:"#{scope_ivar_name}", model)
+
+              value.each_pair do |k,v|
+                raise ::ActionController::ParameterMissing.new("Invalid search parameter #{k} #{v}") unless permitted_scopes.include?(k)
+
+                instance_variable_set(
+                  :"#{scope_ivar_name}",
+                  instance_variable_get(:"#{scope_ivar_name}").all.__send__(k, v)
+                )
+              end
+
+              scope.__send__(scope_name, instance_variable_get(:"#{scope_ivar_name}"))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trax/controller/collection/sortable.rb

@@ -0,0 +1,24 @@
+module Trax
+  module Controller
+    module Collection
+      module Sortable
+        extend ::ActiveSupport::Concern
+
+        SORT_DIRECTIONS = [ "asc", "desc" ].freeze
+
+        module ClassMethods
+          def has_sort_scope(sort_scope_name, only: [:index, :search], type: :boolean, **options)
+            SORT_DIRECTIONS.each do |dir|
+              _sort_scope_name = :"#{sort_scope_name}_#{dir}"
+              has_scope(_sort_scope_name, only: only, type: type, **options)
+            end
+          end
+
+          def has_sort_scopes(*names, **options)
+            names.each{ |_name| has_sort_scope(_name, **options) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trax/controller/collection.rb

@@ -4,8 +4,10 @@ module Trax
       extend ::ActiveSupport::Autoload
 
       autoload :Base
+      autoload :NestedSearchScopes
       autoload :ResponseMeta
       autoload :Searchable
+      autoload :Sortable
       autoload :Pageable
     end
   end

data/lib/trax/controller/engine.rb

@@ -2,7 +2,7 @@ module Trax
   module Controller
     class Engine < ::Rails::Engine
       initializer 'trax_controller.active_model_serializers' do |app|
-        ::ActiveModel::Serializer.config.adapter = Trax::Controller::Serialization::Adapters::Json
+        ::ActiveModel::Serializer.config.adapter = ::Trax::Controller::Serialization::Adapters::Json
       end
     end
   end

data/lib/trax/controller/permit_params_for.rb

@@ -0,0 +1,54 @@
+module Trax
+  module Controller
+    module PermitParamsFor
+      extend ::ActiveSupport::Concern
+
+      # Allows you to permit params by creating a Trax::Core::Types::Struct
+      # https://github.com/jasonayre/trax_core/blob/master/lib/trax/core/types/struct.rb
+      #  permitted_params_for_action :create do
+      #    string :title
+      #  end
+
+      included do
+        class_attribute :trax_params_permitters
+        self.trax_params_permitters = {}
+      end
+
+      def params_permitter_for_action
+        action = params[:action]
+        return self.trax_params_permitters[action.to_sym] if self.trax_params_permitters.key?(action.to_sym)
+        return self.trax_params_permitters[:save] if self.trax_params_permitters.key?(:save) && (action == 'create' || action == 'update' || action == 'first_or_create')
+        raise StandardError.new("No param permitter defined for action #{action}")
+      end
+
+      def build_resource_params
+        _params = request.parameters[resource_request_name]
+        self.class.trax_params_permitters[action_name.to_sym].new(_params).to_serializable_hash
+      end
+
+      def build_resource
+        get_resource_ivar || set_resource_ivar(end_of_association_chain.send(method_for_build, resource_params))
+      end
+
+      def update_resource(object, attributes)
+        object.update(attributes)
+      end
+
+      module ClassMethods
+        def permitted_params_for_action(action_name, &block)
+          _klass = ::Trax::Core::NamedClass.new("#{self.name}::PermittedParamsForAction#{action_name.to_s.classify}", Trax::Core::Types::Struct, &block)
+          self.trax_params_permitters[action_name] = _klass
+        end
+
+        def permitted_params_for_save(&block)
+          _update_klass = ::Trax::Core::NamedClass.new("#{self.name}::PermittedParamsForActionUpdate", Trax::Core::Types::Struct, &block)
+          _create_klass = ::Trax::Core::NamedClass.new("#{self.name}::PermittedParamsForActionCreate", Trax::Core::Types::Struct, &block)
+          _first_or_create_klass = ::Trax::Core::NamedClass.new("#{self.name}::PermittedParamsForActionFirstOrCreate", Trax::Core::Types::Struct, &block)
+          self.trax_params_permitters[:update] = _update_klass
+          self.trax_params_permitters[:create] = _create_klass
+          self.trax_params_permitters[:first_or_create] = _first_or_create_klass
+        end
+      end
+    end
+  end
+end

data/lib/trax/controller/serialization/adapters/json.rb

@@ -1,60 +1,11 @@
-# This adapter is a workaround for
-# https://github.com/rails-api/active_model_serializers/issues/835 until
-# https://github.com/rails-api/active_model_serializers/pull/952 is merged
-
 module Trax
   module Controller
     module Serialization
       module Adapters
-        class Json < ActiveModel::Serializer::Adapter::Json
-          def serializable_hash(options={})
-            result = is_collection? ? collection_serializable_hash(options) : resource_serializable_hash(options)
-            @options[:nested] ? result : { root =>  result }
-          end
-
-          private
-
-          def get_hash(serializer, options={})
-            self.class.new(serializer, :nested => true).serializable_hash(options)
-          end
-
-          def collection_serializable_hash(options={})
-            serializer.map { |s| get_hash(s, options) }
-          end
-
-          def is_collection?
-            serializer.respond_to?(:each)
-          end
-
-          def resource_serializable_hash(options={})
-            cached = cache_check(serializer){ serializer.attributes(options) }
-            resource_result = serialize_resource_associations
-            cached.merge(resource_result)
-          end
-
-          def serialize_resource_associations
-            resource_result = {}
-
-            serializer.associations.each do |association|
-              association_serializer = association.serializer
-              association_options = association.options
-
-              if association_serializer.respond_to?(:each)
-                array_serializer = association_serializer
-
-                resource_result[association.key] = array_serializer.map do |item|
-                  cache_check(item) { get_hash(item) }
-                end
-              else
-                resource_result[association.key] = if association_serializer && association_serializer.object
-                  cache_check(association_serializer) { get_hash(association_serializer) }
-                elsif association_options[:virtual_value]
-                  association_options[:virtual_value]
-                end
-              end
-            end
-
-            resource_result
+        class Json < ::ActiveModelSerializers::Adapter::Json
+          def initialize(serializer, options = {})
+            super
+            options[:include] = "**"
           end
         end
       end

data/lib/trax/controller.rb

@@ -24,6 +24,7 @@ module Trax
     autoload :Resource
     autoload :InheritResources
     autoload :ActionTypes
+    autoload :PermitParamsFor
     autoload :Serialization
 
     @configuration ||= ::Trax::Controller::Config.new

data/lib/trax_controller/version.rb

@@ -1,3 +1,3 @@
 module TraxController
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/spec/internal/app/controllers/categories_controller.rb

@@ -33,6 +33,10 @@ class CategoriesController < ::ApplicationController
     show(serializer: ::CategoriesSerializer, root: 'show_by_calling_original_action')
   end
 
+  def product_with_category
+    render_resource(serializer: ::ProductWithCategorySerializer, root: 'product', resource: Product.find(params[:id]))
+  end
+
   private
 
   def category_params

data/spec/internal/app/serializers/category_serializer.rb

@@ -2,7 +2,7 @@ class CategorySerializer < ::ActiveModel::Serializer
   attributes :name, :slug
 
   def slug
-    name.parameterize('-')
+    object.name.parameterize('-')
   end
 
   has_many :products, :serializer => ::ProductSerializer

data/spec/internal/app/serializers/category_with_subcategories_serializer.rb

@@ -0,0 +1,4 @@
+class CategoryWithSubcategorySerializer < ::ActiveModel::Serializer
+  attributes :name
+  has_many :subcategories, :serializer => CategoryWithSubcategorySerializer
+end

data/spec/internal/app/serializers/product_with_category_serializer.rb

@@ -0,0 +1,6 @@
+require "category_with_subcategories_serializer"
+
+class ProductWithCategorySerializer < ::ActiveModel::Serializer
+  attributes :name
+  has_one :category, :serializer => CategoryWithSubcategorySerializer
+end

data/spec/internal/config/routes.rb

@@ -13,6 +13,7 @@ Rails.application.routes.draw do
       get 'show_by_calling_original_action'
       get 'widget'
       get 'widget_with_renamed_root'
+      get 'product_with_category'
     end
   end
 end

data/spec/trax/controller_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+
 describe ::Trax::Controller do
 
 end

data/spec/trax/controllers/categories_controller_spec.rb

@@ -2,11 +2,14 @@ require 'spec_helper'
 
 ::RSpec.describe CategoriesController, :type => :controller do
   before(:all) do
-    @shoes_category = ::Category.create(:name => 'mens shoes')
-    @watches_category = ::Category.create(:name => 'mens watches')
-
-    @product1 = ::Product.create(:name => "DC Villan", :quantity => 0, :in_stock => false, :category => @shoes_category)
-    @product2 = ::Product.create(:name => "Nixon Rotolog", :quantity => 2, :in_stock => true, :category => @watches_category)
+    @shoes_category = ::Category.create!(:name => 'mens shoes')
+    @watches_category = ::Category.create!(:name => 'mens watches')
+    @apparels_category = ::Category.create!(:name => 'mens apparels')
+    @shirts_category = @apparels_category.subcategories.create(:name => 'mens shirts')
+
+    @product1 = ::Product.create!(:name => "DC Villan", :quantity => 0, :in_stock => false, :category => @shoes_category)
+    @product2 = ::Product.create!(:name => "Nixon Rotolog", :quantity => 2, :in_stock => true, :category => @watches_category)
+    @product3 = ::Product.create!(:name => "T-Shirt", :quantity => 3, :in_stock => true, :category => @apparels_category)
   end
 
   context '#index' do
@@ -69,6 +72,24 @@ require 'spec_helper'
         expect(json["show_by_calling_original_action"]["name"]).to eq @shoes_category.name
       end
     end
+
+    describe "#product_with_category" do
+      it "deeply serializes" do
+        get :product_with_category, :id => @product3.id
+        json = ::JSON.parse(response.body)
+        expect(json["product"]).to eq(
+          "name" => @product3.name,
+          "category" => {
+            "name" => @apparels_category.name,
+            "subcategories" => [
+              { "name" => @shirts_category.name,
+                "subcategories" => []
+              }
+            ]
+          }
+        )
+      end
+    end
   end
 
   context '#create_with_modified_resource' do

data/spec/trax/serialization/adapters/json_spec.rb

@@ -1,15 +1,5 @@
 require 'spec_helper'
 
-class NameCategorySerializer < ::ActiveModel::Serializer
-  attributes :name
-  has_many :subcategories, :serializer => NameCategorySerializer
-end
-
-class NameProductSerializer < ::ActiveModel::Serializer
-  attributes :name
-  has_one :category, :serializer => NameCategorySerializer
-end
-
 describe Trax::Controller::Serialization::Adapters::Json do
   let(:category_flat_heads){ ::Category.new(:name => "flat heads") }
   let(:category_screwdrivers){ ::Category.new(:name => "screwdrivers", :subcategories => [category_flat_heads]) }
@@ -17,7 +7,7 @@ describe Trax::Controller::Serialization::Adapters::Json do
   let(:category_tools){ ::Category.new(:name => "tools", :subcategories => [category_screwdrivers, category_knives]) }
   let(:product_tool){ ::Product.new(:name => "Generics Multi-Purpose Tool", :category => category_tools) }
   let(:root_key){ 'root_key' }
-  let(:serializer){ ::NameProductSerializer.new(product_tool, :root => root_key) }
+  let(:serializer){ ::ProductWithCategorySerializer.new(product_tool, :root => root_key) }
   let!(:expected_root_key){ root_key.to_sym }
   let!(:expected_tool_hash){ {
     :name => product_tool.name,
@@ -40,7 +30,7 @@ describe Trax::Controller::Serialization::Adapters::Json do
     let(:category_cookware){ ::Category.new(:name => "cookware") }
     let(:product_pot){ ::Product.new(:name => "Pot", :category => category_cookware) }
     let(:collection){ [product_tool, product_pot] }
-    let!(:expected_root_key){ root_key.pluralize.to_sym }
+    let(:root_key){ 'root_keys' }
     let!(:expected_pot_hash){ {
       :name => product_pot.name,
       :category => {
@@ -48,7 +38,7 @@ describe Trax::Controller::Serialization::Adapters::Json do
         :subcategories => []
       }
     }}
-    let(:serializer){ ::ActiveModel::Serializer::ArraySerializer.new(collection, :root => root_key, :serializer => ::NameProductSerializer) }
+    let(:serializer){ ::ActiveModel::Serializer::CollectionSerializer.new(collection, :root => root_key, :serializer => ::ProductWithCategorySerializer) }
 
     it { expect(serialized).to eq(expected_root_key => [expected_tool_hash, expected_pot_hash]) }
   end

data/trax_controller.gemspec

@@ -12,12 +12,14 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Resourceful, standardized controllers}
   spec.homepage      = "http://www.github.com/jasonayre"
   spec.license       = "MIT"
+  spec.required_ruby_version = '<= 3.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "active_model_serializers", "~> 0.10"
   spec.add_dependency "trax_core"
   spec.add_dependency "will_paginate"
   spec.add_dependency "has_scope"
@@ -35,7 +37,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-collection_matchers', '~> 1'
   spec.add_development_dependency 'guard', '~> 2'
   spec.add_development_dependency 'guard-bundler', '~> 2'
-  spec.add_development_dependency 'rb-fsevent'
+  spec.add_development_dependency 'listen', '~> 3.0.3'
+  spec.add_development_dependency 'rb-fsevent', '~> 0.9.6'
   spec.add_development_dependency 'terminal-notifier-guard'
   spec.add_development_dependency 'pundit'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: trax_controller
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Jason Ayre
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2024-07-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: trax_core
   requirement: !ruby/object:Gem::Requirement
@@ -248,20 +262,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.6
 - !ruby/object:Gem::Dependency
   name: terminal-notifier-guard
   requirement: !ruby/object:Gem::Requirement
@@ -327,12 +355,15 @@ files:
 - lib/trax/controller/authorize.rb
 - lib/trax/controller/collection.rb
 - lib/trax/controller/collection/base.rb
+- lib/trax/controller/collection/nested_search_scopes.rb
 - lib/trax/controller/collection/pageable.rb
 - lib/trax/controller/collection/response_meta.rb
 - lib/trax/controller/collection/searchable.rb
+- lib/trax/controller/collection/sortable.rb
 - lib/trax/controller/config.rb
 - lib/trax/controller/engine.rb
 - lib/trax/controller/inherit_resources.rb
+- lib/trax/controller/permit_params_for.rb
 - lib/trax/controller/resource.rb
 - lib/trax/controller/resource/base.rb
 - lib/trax/controller/resource/response_meta.rb
@@ -352,7 +383,9 @@ files:
 - spec/internal/app/policies/widget_policy.rb
 - spec/internal/app/serializers/categories_serializer.rb
 - spec/internal/app/serializers/category_serializer.rb
+- spec/internal/app/serializers/category_with_subcategories_serializer.rb
 - spec/internal/app/serializers/product_serializer.rb
+- spec/internal/app/serializers/product_with_category_serializer.rb
 - spec/internal/app/serializers/widget_serializer.rb
 - spec/internal/config/database.yml
 - spec/internal/config/routes.rb
@@ -371,24 +404,23 @@ homepage: http://www.github.com/jasonayre
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "<="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: Resourceful, standardized controllers
 test_files:
@@ -403,7 +435,9 @@ test_files:
 - spec/internal/app/policies/widget_policy.rb
 - spec/internal/app/serializers/categories_serializer.rb
 - spec/internal/app/serializers/category_serializer.rb
+- spec/internal/app/serializers/category_with_subcategories_serializer.rb
 - spec/internal/app/serializers/product_serializer.rb
+- spec/internal/app/serializers/product_with_category_serializer.rb
 - spec/internal/app/serializers/widget_serializer.rb
 - spec/internal/config/database.yml
 - spec/internal/config/routes.rb