snfoil-rails 1.0.0 → 1.0.2

data/lib/snfoil/rails/api/show.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative '../concerns/inject_id'
+require_relative '../concerns/inject_include'
+require_relative '../concerns/inject_request_params'
+require_relative '../concerns/inject_request_id'
+require 'snfoil/controller'
+
+module SnFoil
+  module Rails
+    module API
+      module Show
+        extend ActiveSupport::Concern
+
+        included do
+          include SnFoil::Controller
+
+          include InjectRequestId
+          include InjectId
+          include InjectInclude
+          include InjectRequestParams
+
+          endpoint :show, with: :render_show
+
+          setup_show with: :inject_request_id
+          setup_show with: :inject_request_params
+          setup_show with: :inject_id
+          setup_show with: :inject_include
+
+          process_show with: :run_context
+
+          def render_show(**options)
+            render json: serialize(options[:object], **options), status: :ok
+          end
+        end
+      end
+    end
+  end
+end

data/lib/snfoil/rails/api/update.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative '../concerns/inject_deserialized'
+require_relative '../concerns/inject_id'
+require_relative '../concerns/inject_include'
+require_relative '../concerns/inject_request_params'
+require_relative '../concerns/inject_request_id'
+require 'snfoil/controller'
+
+module SnFoil
+  module Rails
+    module API
+      module Update
+        extend ActiveSupport::Concern
+
+        included do
+          include SnFoil::Controller
+
+          include InjectRequestId
+          include InjectDeserialized
+          include InjectId
+          include InjectInclude
+          include InjectRequestParams
+
+          endpoint :update, with: :render_update
+
+          setup_update with: :inject_request_id
+          setup_update with: :inject_request_params
+          setup_update with: :inject_id
+          setup_update with: :inject_deserialized
+          setup_update with: :inject_include
+
+          process_update with: :run_context
+
+          def render_update(**options)
+            if options[:object].errors.empty?
+              render json: serialize(options[:object], **options), status: :ok
+            else
+              render json: options[:object].errors, status: :unprocessable_entity
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/snfoil/rails/api_controller.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative 'api/create'
+require_relative 'api/destroy'
+require_relative 'api/index'
+require_relative 'api/show'
+require_relative 'api/update'
+
+module SnFoil
+  module Rails
+    class APIController < ActionController::API
+      include SnFoil::Rails::API::Create
+      include SnFoil::Rails::API::Show
+      include SnFoil::Rails::API::Update
+      include SnFoil::Rails::API::Destroy
+      include SnFoil::Rails::API::Index
+    end
+  end
+end

data/lib/snfoil/rails/concerns/inject_deserialized.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/concern'
+
+module SnFoil
+  module Rails
+    module InjectDeserialized
+      extend ActiveSupport::Concern
+
+      def inject_deserialized(**options)
+        options[:params] = deserialize(options[:params], **options)
+
+        options
+      end
+    end
+  end
+end

data/lib/snfoil/rails/concerns/inject_id.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/concern'
+
+module SnFoil
+  module Rails
+    module InjectId
+      extend ActiveSupport::Concern
+
+      def inject_id(**options)
+        return options if options[:id]
+
+        options[:id] = id if defined? id
+        options[:id] ||= options[:params][:id]
+        options
+      end
+    end
+  end
+end

data/lib/snfoil/rails/concerns/inject_include.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/concern'
+
+module SnFoil
+  module Rails
+    module InjectInclude
+      extend ActiveSupport::Concern
+
+      def inject_include(**options)
+        return options if options[:include]
+        return options unless options.dig(:params, :include)
+
+        options[:include] = options.dig(:params, :include)
+                                   .split(',')
+                                   .map { |item| item.underscore.to_sym }
+        options
+      end
+    end
+  end
+end

data/lib/snfoil/rails/concerns/inject_request_id.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/concern'
+
+module SnFoil
+  module Rails
+    module InjectRequestId
+      extend ActiveSupport::Concern
+
+      def inject_request_id(**options)
+        options[:request_id] = request.request_id
+
+        options
+      end
+    end
+  end
+end

data/lib/snfoil/rails/concerns/inject_request_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/concern'
+
+module SnFoil
+  module Rails
+    module InjectRequestParams
+      extend ActiveSupport::Concern
+
+      def inject_request_params(**options)
+        return options if options[:params]
+        return options unless params
+
+        options[:params] = params.to_unsafe_h.deep_symbolize_keys
+        options[:request_params] = options[:params].deep_dup
+        options
+      end
+    end
+  end
+end

data/lib/snfoil/rails/concerns/process_pagination.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/concern'
+
+module SnFoil
+  module Rails
+    module ProcessPagination
+      extend ActiveSupport::Concern
+
+      def paginate(**options)
+        return options[:object] unless options[:object].respond_to?(:page)
+
+        options[:object].page(pagination_page(**options))
+                        .per(pagination_per_page(**options))
+      end
+
+      def pagination_page(**options)
+        (options.dig(:request_params, :page) || 1).to_i
+      end
+
+      def pagination_per_page(**options)
+        per_page_param = (options.dig(:request_params, :per_page) || 10).to_i
+        return 1000 if per_page_param.zero? || per_page_param > 1000
+
+        per_page_param
+      end
+
+      def pagination_count(**options)
+        options[:object].count if options[:object].respond_to? :count
+      end
+
+      def pagination_pages(**options)
+        count = pagination_count(**options)
+        per_page = pagination_per_page(**options)
+        return unless count && per_page
+
+        (count.to_f / per_page).ceil.to_i
+      end
+
+      def pagination_meta(**options)
+        {
+          page: pagination_page(**options),
+          pages: pagination_pages(**options),
+          total: pagination_count(**options),
+          per: pagination_per_page(**options)
+        }
+      end
+
+      def process_pagination(**options)
+        options[:meta] = pagination_meta(**options)
+        options[:object] = paginate(**options)
+
+        options
+      end
+    end
+  end
+end

data/lib/snfoil/rails/engine.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module SnFoil
+  module Rails
+    class Engine < ::Rails::Engine
+      require 'snfoil'
+      require 'snfoil/policy'
+      require 'snfoil/searcher'
+      require 'snfoil/context'
+      require 'snfoil/controller'
+      require 'snfoil/deserializer/json'
+      require 'snfoil/deserializer/jsonapi'
+
+      require_relative 'api/create'
+      require_relative 'api/destroy'
+      require_relative 'api/index'
+      require_relative 'api/show'
+      require_relative 'api/update'
+
+      require_relative 'searcher'
+      require_relative 'api_controller'
+    end
+  end
+end

data/lib/snfoil/rails/searcher.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/concern'
+require 'snfoil/searcher'
+
+module SnFoil
+  module Rails
+    module Searcher
+      extend ActiveSupport::Concern
+      ASC = 'ASC'
+      DESC = 'DESC'
+
+      included do
+        include SnFoil::Searcher
+
+        # patch the additional search capabilities into the method
+        def search(params = {})
+          filtered_scope = super(**params)
+          additional_search(filtered_scope, params)
+        end
+      end
+
+      class_methods do
+        attr_reader :snfoil_include_params, :snfoil_order_method, :snfoil_order_block,
+                    :snfoil_order_by_attr, :snfoil_order_by_direction, :snfoil_is_distinct
+
+        def order(method = nil, &block)
+          @snfoil_order_method = method
+          @snfoil_order_block = block
+        end
+
+        def order_by(attr, direction = nil)
+          @snfoil_order_by_attr = attr
+          @snfoil_order_by_direction = direction
+        end
+
+        def distinct(bool = true) # rubocop:disable Style/OptionalBooleanParameter reason: class configuration looks better this way
+          @snfoil_is_distinct = bool
+        end
+
+        def includes(*array)
+          @snfoil_include_params ||= [] # create new array if none exists
+          @snfoil_include_params |= array # combine unique elements of both arrays
+        end
+      end
+
+      def order_by(params = {})
+        if params[:order_by].present?
+          params[:order_by] = params[:order_by].to_s.underscore
+          return params[:order_by].to_sym if model.attribute_names.include?(params[:order_by])
+        end
+
+        self.class.snfoil_order_by_attr || :id
+      end
+
+      def order(params = {})
+        if params[:order].present?
+          params[:order] = params[:order].to_s.upcase
+          return params[:order] if params[:order].eql?(ASC) || params[:order].eql?(DESC)
+        end
+
+        self.class.snfoil_order_by_direction || ASC
+      end
+
+      private
+
+      def additional_search(filtered_scope, params = {})
+        filtered_scope = apply_order(filtered_scope, params)
+        filtered_scope = apply_includes(filtered_scope)
+        apply_distinct(filtered_scope, params)
+      end
+
+      def apply_includes(filtered_scope)
+        return filtered_scope unless self.class.snfoil_include_params
+
+        filtered_scope.includes(*self.class.snfoil_include_params)
+      end
+
+      def apply_order(filtered_scope, params)
+        return order_method(filtered_scope, params) if order_method_present?
+        return order_block(filtered_scope, params) if order_block_present?
+
+        if params[:order_by].blank? && params[:order].blank?
+          filtered_scope.order(order_by => order)
+        else
+          filtered_scope.order(order_by(params) => order(params))
+        end
+      end
+
+      def order_method_present?
+        self.class.snfoil_order_method.present?
+      end
+
+      def order_block_present?
+        self.class.snfoil_order_block.present?
+      end
+
+      def order_method(filtered_scope, params)
+        send(self.class.snfoil_order_method, filtered_scope, params)
+      end
+
+      def order_block(filtered_scope, params)
+        instance_exec filtered_scope, params, &self.class.snfoil_order_block
+      end
+
+      def apply_distinct(filtered_scope, params)
+        return filtered_scope unless self.class.snfoil_is_distinct || params[:distinct] == true
+
+        filtered_scope.distinct
+      end
+    end
+  end
+end

data/lib/snfoil/rails/version.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module SnFoil
+  module Rails
+    VERSION = '1.0.2'
+  end
+end

data/lib/snfoil/rails.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module SnFoil
+  module Rails
+    require 'snfoil/rails/engine' if Object.const_defined?(:Rails)
+  end
+end

data/lib/tasks/snfoil/rails_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :snfoil do
+#   # Task goes here
+# end

data/snfoil-rails.gemspec

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'lib/snfoil/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'snfoil-rails'
+  spec.version       = SnFoil::Rails::VERSION
+  spec.authors       = ['Matthew Howes', 'Danny Murphy', 'Cliff Campbell']
+  spec.email         = ['howeszy@gmail.com', 'dmurph24@gmail.com', 'cliffcampbell@hey.com']
+
+  spec.summary       = 'Snfoil Rails Helpers'
+  spec.description   = 'Additional functionality gem for using SnFoil with Rails'
+  spec.homepage      = 'https://github.com/limited-effort/snfoil-rails'
+  spec.license       = 'Apache-2.0'
+  spec.required_ruby_version = '>= 2.6'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/limited-effort/snfoil-rails/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  ignore_list = %r{\A(?:test/|spec/|bin/|features/|Rakefile|\.\w)}
+  spec.files = Dir.chdir(File.expand_path(__dir__)) { `git ls-files -z`.split("\x0").reject { |f| f.match(ignore_list) } }
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 5.2.6'
+  spec.add_dependency 'snfoil', '>= 1.0.1', '< 2.0'
+  spec.add_dependency 'snfoil-controller', '>= 1.1.1', '< 2.0'
+
+  spec.add_development_dependency 'blueprinter'
+  spec.add_development_dependency 'bundle-audit', '~> 0.1.0'
+  spec.add_development_dependency 'database_cleaner-active_record'
+  spec.add_development_dependency 'factory_bot', '~> 6.0'
+  spec.add_development_dependency 'fasterer', '~> 0.10.0'
+  spec.add_development_dependency 'kaminari'
+  spec.add_development_dependency 'net-smtp'
+  spec.add_development_dependency 'oj'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'puma'
+  spec.add_development_dependency 'rails', '~> 6.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec-rails', '~> 5.0'
+  spec.add_development_dependency 'rubocop', '1.33'
+  spec.add_development_dependency 'rubocop-performance', '1.14.3'
+  spec.add_development_dependency 'rubocop-rails', '~> 2.14'
+  spec.add_development_dependency 'rubocop-rspec', '2.12.1'
+  spec.add_development_dependency 'sqlite3'
+end