snfoil-controller 1.0.0

data/lib/snfoil/deserializer/base.rb

@@ -0,0 +1,128 @@
+# 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 'active_support/core_ext/string/inflections'
+
+module SnFoil
+  module Deserializer
+    # ActiveSupport::Concern for base deserializer functionality
+    # Add the following class methods:
+    # * attribute
+    # * attributes
+    # * belongs_to
+    # * has_many
+    # * has_one
+    # * key_transform
+    #
+    # @author Matthew Howes
+    #
+    # @since 0.1.0
+    module Base
+      extend ActiveSupport::Concern
+
+      class_methods do
+        attr_reader :snfoil_attribute_transforms,
+                    :snfoil_key_transform
+
+        def key_transform(transform = nil, &block)
+          @snfoil_key_transform = transform || block
+        end
+
+        def attribute(key, **options, &block)
+          (@snfoil_attribute_transforms ||= {})[key] = options.merge(transform_type: :attribute, block: block)
+        end
+
+        def attributes(*fields, **options, &block)
+          fields.each { |field| attribute(field, **options, &block) }
+        end
+
+        def belongs_to(key, deserializer:, **options, &block)
+          (@snfoil_attribute_transforms ||= {})[key] = options.merge(deserializer: deserializer, transform_type: :has_one, block: block)
+        end
+        alias_method :has_one, :belongs_to
+
+        def has_many(key, deserializer:, **options, &block) # rubocop:disable Naming/PredicateName
+          (@snfoil_attribute_transforms ||= {})[key] = options.merge(deserializer: deserializer, transform_type: :has_many, block: block)
+        end
+
+        def inherited(subclass)
+          super
+
+          instance_variables.grep(/@snfoil_.+/).each do |i|
+            subclass.instance_variable_set(i, instance_variable_get(i).dup)
+          end
+        end
+      end
+
+      included do
+        attr_reader :data, :config
+
+        def initialize(input, **config)
+          @data = normalize_keys(input)
+          @config = config
+        end
+
+        def parse
+          raise '#parse not implemented'
+        end
+
+        def to_hash
+          parse
+        end
+
+        alias_method :to_hash, :parse
+        alias_method :to_h, :parse
+      end
+
+      protected
+
+      def normalize_keys(input)
+        input = input.transform_keys do |key|
+          apply_key_normalize(key)
+        end
+
+        input.transform_values do |value|
+          check_deep_keys(value)
+        end
+      end
+
+      def check_deep_keys(value)
+        case value
+        when Hash
+          normalize_keys(value)
+        when Array
+          value.map { |v| check_deep_keys(v) }
+        else
+          value
+        end
+      end
+
+      def apply_key_normalize(key)
+        @snfoil_key_transform ||= self.class.snfoil_key_transform ||
+                                  :underscore
+        case @snfoil_key_transform
+        when Symbol
+          key.to_s.send(@snfoil_key_transform)
+        when Proc
+          @snfoil_key_transform.call(key.to_s)
+        else
+          key
+        end.to_sym
+      end
+    end
+  end
+end

data/lib/snfoil/deserializer/json.rb

@@ -0,0 +1,98 @@
+# 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_relative 'base'
+
+module SnFoil
+  module Deserializer
+    # ActiveSupport::Concern for JSON deserializer functionality
+    # Initialize class with json payload and call #parse to output normalized hash
+    #
+    # @author Matthew Howes
+    #
+    # @since 0.1.0
+    module JSON
+      extend ActiveSupport::Concern
+
+      included do # rubocop:disable Metrics/BlockLength reason: These methods need to be in included to be overridable
+        include SnFoil::Deserializer::Base
+
+        def parse
+          apply_transforms({}, data)
+        end
+
+        protected
+
+        def apply_transforms(output, input)
+          (self.class.snfoil_attribute_transforms || {}).reduce(output) do |transformed_output, transform|
+            apply_transform(transformed_output, input, transform[0], **transform[1])
+          end
+        end
+
+        def apply_transform(output, input, key, **options)
+          case options[:transform_type]
+          when :attribute
+            parse_attribute_transform(output, input, key, **options)
+          when :has_one
+            parse_has_one_transform(output, input, key, **options)
+          when :has_many
+            parse_has_many_transform(output, input, key, **options)
+          end
+        end
+
+        def parse_attribute_transform(output, input, key, **options)
+          value = find_attribute(input, key, **options)
+          return output unless value
+
+          output.merge key => value
+        end
+
+        def parse_has_one_transform(output, input, key, deserializer:, **options)
+          resource_data = find_attribute(input, key, **options)
+          return output unless resource_data
+
+          output[key] = deserializer.new(resource_data, **options).parse
+          output
+        end
+
+        def parse_has_many_transform(output, input, key, deserializer:, **options)
+          array_data = find_attribute(input, key, **options)
+          return output unless array_data
+
+          array_data = [array_data] if array_data.is_a? Hash
+          output[key] = array_data.map { |r| deserializer.new(r, **options).parse }
+          output
+        end
+
+        def find_attribute(input, key, block: nil, with: nil, **options)
+          return unless input
+
+          if block
+            instance_exec(input, key, **options, &block)
+          elsif with
+            send(with, input, key, **options)
+          else
+            value_key = options.fetch(:key) { key }
+            value_key = "#{options[:prefix]}#{key}".to_sym if options[:prefix]
+
+            input[value_key.to_sym]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/snfoil/deserializer/jsonapi.rb

@@ -0,0 +1,116 @@
+# 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_relative 'json'
+
+module SnFoil
+  module Deserializer
+    # ActiveSupport::Concern for JSONAPI deserializer functionality
+    # Initialize class with jsonapi payload and call #parse to output normalized hash
+    #
+    # @author Matthew Howes
+    #
+    # @since 0.1.0
+    module JSONAPI
+      extend ActiveSupport::Concern
+
+      included do # rubocop:disable Metrics/BlockLength reason: These methods need to be in included to be overridable
+        include SnFoil::Deserializer::JSON
+
+        module_eval do
+          def parse
+            input = data[:data] || data
+            return apply_transforms(data_id({}, input), input) unless input.is_a? Array
+
+            input.map { |d| apply_transforms(data_id({}, d), d) }
+          end
+        end
+
+        def included
+          @included ||= config[:included] || data[:included]
+        end
+
+        private
+
+        def data_id(output, data)
+          if data[:id]
+            output[:id] = data[:id]
+          elsif data[:'local:id']
+            output[:'local:id'] = data[:'local:id']
+          end
+
+          output
+        end
+
+        def parse_attribute_transform(output, input, key, **options)
+          value = find_attribute(input[:attributes], key, **options)
+          return output unless value
+
+          output.merge key => value
+        end
+
+        def parse_has_one_transform(output, input, key, deserializer:, **options)
+          resource_data = find_relationship(input, key, **options)
+          return output unless resource_data
+
+          output[key] = deserializer.new(resource_data, **options, included: included).parse
+          output
+        end
+
+        def parse_has_many_transform(output, input, key, deserializer:, **options)
+          resource_data = find_relationships(input, key, **options)
+          return output unless resource_data
+
+          output[key] = resource_data.map { |r| deserializer.new(r, **options, included: included).parse }
+          output
+        end
+
+        def find_relationships(input, key, **options)
+          array_data = find_attribute(input[:relationships], key, **options)
+          return unless array_data
+
+          array_data = array_data[:data]
+          array_data = [array_data] unless array_data.is_a? Array
+          array_data.map do |resource_data|
+            lookup_relationship(**resource_data) || resource_data
+          end
+        end
+
+        def find_relationship(input, key, **options)
+          resource_data = find_attribute(input[:relationships], key, **options)
+          return unless resource_data
+
+          lookup_relationship(**resource_data[:data]) || resource_data
+        end
+
+        def lookup_relationship(type:, **options)
+          id = options[:id]
+          lid = options[:'local:id']
+
+          included&.find do |x|
+            x[:type].eql?(type) &&
+              if id
+                x[:id].eql?(id)
+              elsif lid
+                x[:'local:id'].eql?(lid)
+              end
+          end
+        end
+      end
+    end
+  end
+end

data/snfoil-controller.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'lib/snfoil/controller/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'snfoil-controller'
+  spec.version       = SnFoil::Controller::VERSION
+  spec.authors       = ['Matthew Howes', 'Cliff Campbell']
+  spec.email         = ['howeszy@gmail.com', 'cliffcampbell@hey.com']
+
+  spec.summary       = 'Seperate Display Logic from Business Logic'
+  spec.description   = 'A context-like experience for your controllers'
+  spec.homepage      = 'https://github.com/limited-effort/snfoil-controller'
+  spec.license       = 'Apache-2.0'
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/limited-effort/snfoil-controller/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 'jsonapi-serializer', '~> 2.2'
+  spec.add_dependency 'snfoil-context', '~> 1.0'
+
+  spec.add_development_dependency 'bundle-audit', '~> 0.1.0'
+  spec.add_development_dependency 'fasterer', '~> 0.10.0'
+  spec.add_development_dependency 'oj'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '1.29'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.11'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.5'
+end

metadata

@@ -0,0 +1,228 @@
+--- !ruby/object:Gem::Specification
+name: snfoil-controller
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthew Howes
+- Cliff Campbell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.6
+- !ruby/object:Gem::Dependency
+  name: jsonapi-serializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: snfoil-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundle-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: fasterer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.29'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: A context-like experience for your controllers
+email:
+- howeszy@gmail.com
+- cliffcampbell@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/snfoil/controller.rb
+- lib/snfoil/controller/version.rb
+- lib/snfoil/deserializer/base.rb
+- lib/snfoil/deserializer/json.rb
+- lib/snfoil/deserializer/jsonapi.rb
+- snfoil-controller.gemspec
+homepage: https://github.com/limited-effort/snfoil-controller
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/limited-effort/snfoil-controller
+  source_code_uri: https://github.com/limited-effort/snfoil-controller
+  changelog_uri: https://github.com/limited-effort/snfoil-controller/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Seperate Display Logic from Business Logic
+test_files: []