wallaby-her 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a2434677a3ae9ba231c0abf2baff2792ede04d441c26a63fc123a113e2baf13
+  data.tar.gz: 7c3d8bc9ef28b4e16fc7ae41426d5639f2076f37de309fd893fecf4c11c92984
+SHA512:
+  metadata.gz: a282ef7b4e0c92ea744ce38cf2ba5791ee47f16335a5a45ca7d801a230e8cf1e5ec9f3fca400931d7c22d17c210978edc6b264063a1587a910c47b408b28e71a
+  data.tar.gz: 5b709969562097a838d9c414928b7ed04951164fa2021758c3308e30e61fb7445f6a903615dc3bcd0793ce74fa3a902ca8a74100940654c7baaf4654ef1776e9

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010-2019 Google LLC. http://angular.io/license
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Wallaby::Her
+
+This gem contains the HER ORM adapter for Wallaby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wallaby-her'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install wallaby-her
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wallaby-rails/wallaby-her.
+
+## License
+
+This project is [MIT Licensed](LICENSE)

data/lib/adapters/wallaby/her.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Wallaby
+  # Her mode
+  class Her < Mode
+  end
+end

data/lib/adapters/wallaby/her/cancancan_provider.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Her
+    # Cancancan provider for Her
+    class CancancanProvider < CancancanAuthorizationProvider
+    end
+  end
+end

data/lib/adapters/wallaby/her/default_provider.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Her
+    # Default provider for Her
+    class DefaultProvider < DefaultAuthorizationProvider
+    end
+  end
+end

data/lib/adapters/wallaby/her/model_decorator.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Her
+    # Modal decorator for Her
+    class ModelDecorator < ::Wallaby::ModelDecorator
+      # Generally, in Her, attribute methods are generated with this suffix
+      ATTRIBUTE_SUFFIX = '_will_change!'
+
+      # Origin metadata directly coming from Her.
+      #
+      # It needs to be frozen so that we can keep the metadata integrity
+      # @example sample fields:
+      #   model_decorator.fields
+      #   # =>
+      #   {
+      #     # general field
+      #     id: { type: 'integer', label: 'Id' },
+      #     # association field
+      #     category: {
+      #       'type' => 'belongs_to',
+      #       'label' => 'Category',
+      #       'is_association' => true
+      #     }
+      #   }
+      # @return [ActiveSupport::HashWithIndifferentAccess] metadata
+      def fields
+        @fields ||= ::ActiveSupport::HashWithIndifferentAccess.new.tap do |hash|
+          hash.merge! general_fields
+          hash.merge! association_fields
+        end.freeze
+      end
+
+      # A copy of {#fields} for index page
+      # @return [ActiveSupport::HashWithIndifferentAccess] metadata
+      def index_fields
+        @index_fields ||= Utils.clone fields
+      end
+
+      # A copy of {#fields} for show page
+      # @return [ActiveSupport::HashWithIndifferentAccess] metadata
+      def show_fields
+        @show_fields ||= Utils.clone fields
+      end
+
+      # A copy of {#fields} for form (new/edit) page
+      # @return [ActiveSupport::HashWithIndifferentAccess] metadata
+      def form_fields
+        @form_fields ||= Utils.clone fields
+      end
+
+      # @return [Array<String>] a list of field names for index page
+      def index_field_names
+        @index_field_names ||=
+          index_fields.reject do |_field_name, metadata|
+            metadata[:is_association]
+          end.keys
+      end
+
+      # @return [Array<String>] a list of field names for form (new/edit) page
+      def form_field_names
+        @form_field_names ||=
+          Utils.clone(index_field_names)
+               .delete_if { |field_name| field_name == primary_key.to_s }
+      end
+
+      # @return [ActiveModel::Errors, Hash] errors for resource
+      # @see https://www.rubydoc.info/gems/her/Her/Model/Attributes/ClassMethods#store_response_errors-instance_method
+      #   Her::Model::Attributes.store_response_errors
+      def form_active_errors(resource)
+        resource.errors.presence \
+          || resource.instance_variable_get(:@response_errors)
+      end
+
+      # @return [String] primary key for the resource
+      def primary_key
+        @primary_key ||= @model_class.primary_key
+      end
+
+      # To guess the title for resource.
+      #
+      # It will go through the fields and try to find out the one that looks
+      # like a name or text to represent this resource. Otherwise, it will fall
+      # back to primary key.
+      # @param resource [Object]
+      # @return [String] the title of given resource
+      def guess_title(resource)
+        ModuleUtils.try_to resource, possible_title_field
+      end
+
+      protected
+
+      # @return [Hash] a hash containing metadata for general fields
+      def general_fields
+        @general_fields ||=
+          her_attributes.each_with_object({}) do |attribute, fields|
+            fields[attribute.to_sym] = {
+              type: 'string',
+              label: @model_class.human_attribute_name(attribute)
+            }
+          end
+      end
+
+      # @return [Hash] a hash containing metadata for association fields
+      def association_fields
+        @association_fields ||=
+          @model_class.associations.each_with_object({}) do |(type, arr), hash|
+            arr.each do |assoc|
+              hash[assoc[:name]] = {
+                type: type.to_s.freeze,
+                label: @model_class.human_attribute_name(assoc[:name]),
+                is_association: true, sort_disabled: true
+              }
+            end
+          end
+      end
+
+      # @return [String] a field name that can be used as title (fall back to {#primary_key}).
+      def possible_title_field
+        @possible_title_field ||= begin
+          target_field = general_fields.keys.find do |field_name|
+            TITLE_NAMES.any? { |v| field_name.to_s.index v }
+          end
+          target_field || primary_key
+        end
+      end
+
+      # **Her::Model::Attributes.attributes** will produce seven methods for an
+      # attribute to track dirty data like ActiveModel
+      # @see https://www.rubydoc.info/gems/her/Her/Model/Attributes/ClassMethods#attributes-instance_method
+      #   Her::Model::Attributes.attributes
+      # @return [Array<String>] a list of fields captured from instance methods
+      def her_attributes
+        instance_methods = @model_class.instance_methods
+        possible_attributes =
+          instance_methods.grep(/#{ATTRIBUTE_SUFFIX}$/).map do |method_id|
+            method_id.to_s[0...-ATTRIBUTE_SUFFIX.length]
+          end
+        attributes = possible_attributes.select do |attribute|
+          instance_methods.grep(/^#{attribute}\=?$/).length == 2 \
+            && attribute !~ /(index_|show_|form_)?fields/
+        end
+        attributes.unshift(primary_key)
+      end
+    end
+  end
+end

data/lib/adapters/wallaby/her/model_finder.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Her
+    # Model finder
+    class ModelFinder < ::Wallaby::ModelFinder
+      # Find out all the classes that include Her::Model
+      # @return [Array<Class>] a list of Her classes
+      def all
+        ObjectSpace
+          .each_object(Class)
+          .select do |klass|
+            klass < ::Her::Model && !ModuleUtils.anonymous_class?(klass)
+          end
+      end
+    end
+  end
+end

data/lib/adapters/wallaby/her/model_pagination_provider.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Her
+    # Model pagination provider
+    class ModelPaginationProvider < ::Wallaby::ModelPaginationProvider
+      # By default, it doesn't support pagination as Her doesn't support
+      # @return [false]
+      def paginatable?
+        false
+      end
+    end
+  end
+end

data/lib/adapters/wallaby/her/model_service_provider.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Her
+    # Model service provider for HER ORM
+    class ModelServiceProvider < ::Wallaby::ModelServiceProvider
+      # Only the general fields will be permitted.
+      # It's less possible to guess what nested attributes should be permitted.
+      # @see Wallaby::ModelServiceProvider#permit
+      # @param params [ActionController::Parameters]
+      # @return [ActionController::Parameters] whitelisted parameters
+      def permit(params, action, authorizer)
+        authorized_fields = authorizer.permit_params action, @model_class
+        params.require(param_key).permit(authorized_fields || permitted_fields)
+      end
+
+      # No general practices of how ordering and searching can be done in Her.
+      # Therefore, it will just return all
+      #
+      # NOTE: pagination free here.
+      # Since somewhere might need the collection without any pagination
+      # @see Wallaby::ModelServiceProvider#collection
+      # @param _params [ActionController::Parameters]
+      # @param _authorizer [Ability] for now
+      # @return [ActiveRecord::Relation]
+      def collection(_params, _authorizer)
+        @model_class.all
+      end
+
+      # No general practices of how pagination can be done in Her.
+      # Therefore, it will just return all
+      #
+      # @see Wallaby::ModelServiceProvider#paginate
+      # @param query [ActiveRecord::Relation]
+      # @param _params [ActionController::Parameters]
+      # @return [ActiveRecord::Relation] paginated query
+      def paginate(query, _params)
+        query.all
+      end
+
+      # @see Wallaby::ModelServiceProvider#new
+      def new(_params, _authorizer)
+        @model_class.new
+      end
+
+      # @see Wallaby::ModelServiceProvider#find
+      # @param id [String]
+      def find(id, _params, _authorizer)
+        resource = @model_class.find id
+        raise ResourceNotFound, id unless resource
+
+        resource
+      end
+
+      # @see Wallaby::ModelServiceProvider#create
+      # @param resource [Object]
+      # @param params [ActionController::Parameters]
+      def create(resource, params, authorizer)
+        save __callee__, resource, params, authorizer
+      end
+
+      # @see Wallaby::ModelServiceProvider#update
+      # @param resource [Object]
+      # @param params [ActionController::Parameters]
+      def update(resource, params, authorizer)
+        save __callee__, resource, params, authorizer
+      end
+
+      # @see Wallaby::ModelServiceProvider#destroy
+      # @param resource [Object]
+      # @param _params [ActionController::Parameters]
+      def destroy(resource, _params, _authorizer)
+        resource.destroy
+      end
+
+      protected
+
+      # Save the record
+      # @param action [String] `create`, `update`
+      # @param resource [Object]
+      # @param params [ActionController::Parameters]
+      # @param authorizer [Object]
+      # @return resource itself
+      def save(action, resource, params, authorizer)
+        resource.assign_attributes params.to_h
+        ensure_attributes_for authorizer, action, resource
+        resource.save if resource.valid?
+        resource
+      rescue ActionController::UnfilteredParameters => e
+        resource.errors.add :base, e.message
+        resource
+      end
+
+      # To make sure that the record can be updated with the values that are
+      # allowed to.
+      # @param authorizer [Object]
+      # @param action [String]
+      # @param resource [Object]
+      def ensure_attributes_for(authorizer, action, resource)
+        return if authorizer.blank?
+
+        restricted_conditions = authorizer.attributes_for action, resource
+        resource.assign_attributes restricted_conditions
+      end
+
+      # @return [String] the params key
+      def param_key
+        @model_class.model_name.param_key
+      end
+
+      # The list of attributes to whitelist.
+      # For now, only general fields can be whitelisted.
+      # @return [Array]
+      def permitted_fields
+        @permitted_fields ||=
+          @model_decorator.fields.reject do |_field_name, metadata|
+            metadata[:is_association]
+          end.keys
+      end
+    end
+  end
+end

data/lib/adapters/wallaby/her/pundit_provider.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Her
+    # Pundit provider for Her
+    class PunditProvider < PunditAuthorizationProvider
+      # Find out the class and filter scope.
+      # @param _action [Symbol, String]
+      # @param scope [Object]
+      # @return [Object]
+      def accessible_for(_action, scope)
+        klass =
+          if scope.is_a? ::Her::Model::Relation
+            scope.instance_variable_get :@parent
+          else
+            scope
+          end
+        scope_policy = Pundit::PolicyFinder.new(klass).scope
+        scope_policy ? scope_policy.new(user, scope).resolve : scope
+      end
+    end
+  end
+end

data/lib/wallaby/her.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'wallaby/core'
+
+require 'wallaby/her/version'
+
+# All files here is for HER ORM
+require 'her'
+require 'adapters/wallaby/her'
+require 'adapters/wallaby/her/model_finder'
+
+# ModelDecorator: begin
+require 'adapters/wallaby/her/model_decorator'
+# ModelDecorator: end
+
+# ModelPaginationProvider: begin
+require 'adapters/wallaby/her/model_pagination_provider'
+# ModelPaginationProvider: end
+
+# ModelServiceProvider: begin
+require 'adapters/wallaby/her/model_service_provider'
+# ModelServiceProvider: end
+
+# AuthorizationProvider: begin
+require 'adapters/wallaby/her/default_provider'
+require 'adapters/wallaby/her/cancancan_provider'
+require 'adapters/wallaby/her/pundit_provider'
+# AuthorizationProvider: end

data/lib/wallaby/her/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Wallaby
+  module HerGem
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: wallaby-her
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tian Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: her
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wallaby-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cancancan
+  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: pundit
+  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: rspec-rails
+  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: wallaby-cop
+  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'
+description: Wallaby's HER ORM adapter
+email:
+- me@tian.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/adapters/wallaby/her.rb
+- lib/adapters/wallaby/her/cancancan_provider.rb
+- lib/adapters/wallaby/her/default_provider.rb
+- lib/adapters/wallaby/her/model_decorator.rb
+- lib/adapters/wallaby/her/model_finder.rb
+- lib/adapters/wallaby/her/model_pagination_provider.rb
+- lib/adapters/wallaby/her/model_service_provider.rb
+- lib/adapters/wallaby/her/pundit_provider.rb
+- lib/wallaby/her.rb
+- lib/wallaby/her/version.rb
+homepage: https://github.com/wallaby-rails/wallaby-her
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wallaby-rails/wallaby-her
+  source_code_uri: https://github.com/wallaby-rails/wallaby-her
+  changelog_uri: https://github.com/wallaby-rails/wallaby-her/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Wallaby's HER ORM adapter
+test_files: []