granite 0.9.5 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5ed01c6853ba3bf3e13e4881c89aac4bdaa5d58737237878602df69ae494bba
-  data.tar.gz: 8c4a75737a577c8f1fb36a8fbb12413aaa0d2d5722e990135f43d6cea52ef619
+  metadata.gz: 6899733124529783eda1187a978475dea09fe5c716349d50f4dbf02f0c70a90c
+  data.tar.gz: 81113bf6131ba438bb21af75c0b870ca3e0f8e07cbd8d754c274c259311ae640
 SHA512:
-  metadata.gz: e8b7af99f9099f4e2b49bcd1a6addbab8d03d0439371d65365b652d529b622312ce4ae9c553d55222ddaf6b91b4ba9f0562c5fc15c27834f7c4c306e70c485ed
-  data.tar.gz: 939fb9e924c7a14b08430d85b83b864ae8afb7880f8476b58ecc61e7ec23c6c1906c87ab73d1542f9b25cab701dd54bb75be308e982b3d25f6b528759e628aee
+  metadata.gz: 1f6715806d76f01ec2f017c83bacecc3a33dc3ed9099493a2f245f84eadabe87abe5835bcfcb16fda8fc2f5b71022c84053291a1f4d4c829691cfaf216068d46
+  data.tar.gz: ec7f880050ff0a6b7de11d576d22038d5dcca6d0e3e71c2c7a2c4adb59280f153e05210bf7c7e4df519ddada2d5d337c12fdec34c3fddb060cf5dd82520ae3ff

data/app/controllers/granite/controller.rb

@@ -1,9 +1,9 @@
-require 'granite/projector/translations/helper'
 require 'action_controller'
 
 module Granite
   class Controller < Granite.base_controller_class
-    include Granite::Projector::Translations::Helper
+    include Controller::Translations
+    helper Controller::Translations
 
     singleton_class.__send__(:attr_accessor, :projector_class)
     singleton_class.delegate :projector_path, :projector_name, :action_class, to: :projector_class

data/app/controllers/granite/controller/translations.rb

@@ -0,0 +1,16 @@
+module Granite
+  class Controller
+    module Translations
+      def i18n_scopes
+        Granite::Translations.combine_paths(projector.i18n_scopes, [*action_name, nil])
+      end
+
+      def translate(*args, **options)
+        key, options = Granite::Translations.scope_translation_args(i18n_scopes, *args, **options)
+        super(key, **options)
+      end
+
+      alias t translate
+    end
+  end
+end

data/config/rubocop-default.yml

@@ -0,0 +1,3 @@
+Lint/UselessAccessModifier:
+  ContextCreatingMethods:
+    - projector

data/lib/granite.rb

@@ -4,6 +4,7 @@ require 'action_controller'
 require 'granite/version'
 require 'granite/config'
 require 'granite/context'
+require 'granite/util'
 
 module Granite
   def self.config

data/lib/granite/action.rb

@@ -7,10 +7,12 @@ require 'granite/action/types'
 require 'granite/action/error'
 require 'granite/action/performing'
 require 'granite/action/performer'
+require 'granite/action/precondition'
 require 'granite/action/preconditions'
 require 'granite/action/policies'
 require 'granite/action/projectors'
 require 'granite/action/subject'
+require 'granite/action/translations'
 
 module Granite
   class Action
@@ -38,6 +40,7 @@ module Granite
     end
 
     include Base
+    include Translations
     include Performing
     include Subject
     include Performer
@@ -64,10 +67,6 @@ module Granite
       end
     end
 
-    def self.i18n_scope
-      :granite_action
-    end
-
     # Almost the same as Dirty `#changed?` method, but
     # doesn't check subject reference key
     def attributes_changed?(except: [])

data/lib/granite/action/performing.rb

@@ -42,7 +42,7 @@ module Granite
       # @return [Object] result of execute_perform! method execution or false in case of errors
       def perform(context: nil, **options)
         transaction do
-          valid?(context) && perform_action(options)
+          valid?(context) && perform_action(**options)
         end
       end
 
@@ -94,7 +94,7 @@ module Granite
       def perform_action(raise_errors: false, **options)
         result = run_callbacks(:execute_perform) do
           apply_association_changes!
-          execute_perform!(options)
+          execute_perform!(**options)
         end
         @_action_performed = true
         result || true

data/lib/granite/action/policies.rb

@@ -55,17 +55,17 @@ module Granite
         end
       end
 
-      def try_perform!(*)
+      def try_perform!(*, **)
         authorize!
         super
       end
 
-      def perform(*)
+      def perform(*, **)
         authorize!
         super
       end
 
-      def perform!(*)
+      def perform!(*, **)
         authorize!
         super
       end

data/lib/granite/action/precondition.rb

@@ -0,0 +1,38 @@
+module Granite
+  class Action
+    class Precondition < BasicObject
+      UNDEFINED = ::Object.new.freeze
+
+      def self.description(text = UNDEFINED)
+        case text
+        when UNDEFINED
+          @description
+        else
+          @description = text
+        end
+      end
+
+      def initialize(context)
+        @context = context
+      end
+
+      def call(*)
+        fail NotImplementedError, "#call method must be implemented for #{self.class}"
+      end
+
+      def method_missing(method_name, *args, &blk)
+        super unless @context.respond_to?(method_name)
+
+        @context.__send__(method_name, *args, &blk)
+      end
+
+      def respond_to_missing?(method_name, _include_private = false)
+        @context.respond_to?(method_name)
+      end
+
+      private
+
+      attr_reader :context
+    end
+  end
+end

data/lib/granite/action/preconditions.rb

@@ -1,5 +1,6 @@
 require 'granite/action/preconditions/base_precondition'
 require 'granite/action/preconditions/embedded_precondition'
+require 'granite/action/preconditions/object_precondition'
 
 module Granite
   class Action
@@ -13,6 +14,10 @@ module Granite
       extend ActiveSupport::Concern
 
       class PreconditionsCollection
+        include Enumerable
+
+        delegate :each, to: :@preconditions
+
         def initialize(*preconditions)
           @preconditions = preconditions.flatten
         end
@@ -43,16 +48,10 @@ module Granite
           options = args.extract_options!
           if block
             add_precondition(BasePrecondition, options, &block)
+          elsif args.first.is_a?(Class)
+            add_precondition(ObjectPrecondition, *args, options)
           else
-            common_options = options.extract!(:if, :unless)
-            args.each do |type|
-              precondition common_options.merge(type => {})
-            end
-            options.each do |key, value|
-              value = Array.wrap(value)
-              precondition_options = value.extract_options!
-              add_precondition(klass(key), *value, precondition_options.merge!(common_options))
-            end
+            add_preconditions_hash(*args, **options)
           end
         end
 
@@ -65,6 +64,18 @@ module Granite
           end || fail(NameError, "No precondition class for #{key}Precondition")
         end
 
+        def add_preconditions_hash(*args, **options)
+          common_options = options.extract!(:if, :unless, :desc, :description)
+          args.each do |type|
+            precondition common_options.merge(type => {})
+          end
+          options.each do |key, value|
+            value = Array.wrap(value)
+            precondition_options = value.extract_options!
+            add_precondition(klass(key), *value, precondition_options.merge!(common_options))
+          end
+        end
+
         def add_precondition(klass, *args, &block)
           self._preconditions += klass.new(*args, &block)
         end

data/lib/granite/action/preconditions/base_precondition.rb

@@ -9,10 +9,7 @@ module Granite
         end
 
         def execute!(context)
-          return if @options[:if] && !context.instance_exec(&@options[:if])
-          return if @options[:unless] && context.instance_exec(&@options[:unless])
-
-          _execute(context)
+          _execute(context) if context.conditions_satisfied?(**@options)
         end
 
         private

data/lib/granite/action/preconditions/object_precondition.rb

@@ -0,0 +1,15 @@
+require 'granite/action/preconditions/base_precondition'
+
+module Granite
+  class Action
+    module Preconditions
+      class ObjectPrecondition < BasePrecondition
+        private
+
+        def _execute(context)
+          @args.first.new(context).call(**@options.except(:if, :unless))
+        end
+      end
+    end
+  end
+end

data/lib/granite/action/translations.rb

@@ -0,0 +1,25 @@
+module Granite
+  class Action
+    module Translations
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def i18n_scope
+          :granite_action
+        end
+
+        def i18n_scopes
+          lookup_ancestors.flat_map do |klass|
+            :"#{klass.i18n_scope}.#{klass.model_name.i18n_key}"
+          end + [nil]
+        end
+      end
+
+      def translate(*args, **options)
+        key, options = Granite::Translations.scope_translation_args(self.class.i18n_scopes, *args, **options)
+        I18n.translate(key, **options)
+      end
+      alias t translate
+    end
+  end
+end

data/lib/granite/base.rb

@@ -18,7 +18,7 @@ module Granite
     include ActiveData::Model::Primary
     include ActiveModel::Validations::Callbacks
 
-    include Granite::Translations
+    include Granite::Util
     include Granite::Represents
   end
 end

data/lib/granite/dispatcher.rb

@@ -25,7 +25,7 @@ class Granite::Dispatcher
   end
 
   def controller(params, *_args)
-    projector(params.slice(:granite_action, :granite_projector).symbolize_keys)&.controller_class
+    projector(*params.values_at(:granite_action, :granite_projector))&.controller_class
   end
 
   def prepare_params!(params, *_args)
@@ -39,19 +39,19 @@ class Granite::Dispatcher
       controller(req.params),
       action_name(
         req.request_method_symbol,
-        req.params.slice(:granite_action, :granite_projector, :projector_action).symbolize_keys
+        *req.params.values_at(:granite_action, :granite_projector, :projector_action)
       )
     ]
   end
 
-  memoize def action_name(request_method_symbol, granite_action:, granite_projector:, projector_action: '')
-    projector = projector(granite_action: granite_action, granite_projector: granite_projector)
+  memoize def action_name(request_method_symbol, granite_action, granite_projector, projector_action = '')
+    projector = projector(granite_action, granite_projector)
     return unless projector
 
     projector.action_for(request_method_symbol, projector_action)
   end
 
-  memoize def projector(granite_action:, granite_projector:)
+  memoize def projector(granite_action, granite_projector)
     action = business_action(granite_action)
 
     action.public_send(granite_projector) if action.respond_to?(granite_projector)

data/lib/granite/projector/controller_actions.rb

@@ -23,11 +23,11 @@ module Granite
             controller_class.__send__(:define_method, name, &block)
             class_eval <<-METHOD, __FILE__, __LINE__ + 1
               def #{name}_url(options = {})
-                action_url(:#{name}, options.symbolize_keys)
+                action_url(:#{name}, **options.symbolize_keys)
               end
 
               def #{name}_path(options = {})
-                action_path(:#{name}, options.symbolize_keys)
+                action_path(:#{name}, **options.symbolize_keys)
               end
             METHOD
           else

data/lib/granite/projector/translations.rb

@@ -1,52 +1,18 @@
 module Granite
   class Projector
     module Translations
-      extend ActiveSupport::Concern
+      include ActionView::Helpers::TranslationHelper
 
-      class TranslationsWrapper
-        include ActionView::Helpers::TranslationHelper
+      def i18n_scopes
+        Granite::Translations.combine_paths(action_class.i18n_scopes, [:"#{projector_name}"])
       end
 
-      def translate(*args)
-        TranslationsWrapper.new.translate(*self.class.scope_translation_args_by_projector(args))
+      def translate(*args, **options)
+        key, options = Granite::Translations.scope_translation_args(i18n_scopes, *args, **options)
+        super(key, **options)
       end
-      alias t translate
-
-      module ClassMethods
-        def scope_translation_args_by_projector(args, action_name: nil)
-          options = args.extract_options!
-
-          lookups = expand_relative_key(args.first, action_name).map(&:to_sym)
-          lookups += [options[:default]]
-          lookups = lookups.flatten.compact
-
-          key = lookups.shift
-          options[:default] = lookups
-
-          [key, options]
-        end
-
-        private
 
-        def expand_relative_key(key, action_name = nil)
-          return [key] unless key.is_a?(String) && key.start_with?('.')
-
-          base_keys = extract_base_keys(key, action_name)
-
-          action_class.lookup_ancestors.map do |klass|
-            base_keys.map do |base_key|
-              :"#{klass.i18n_scope}.#{klass.model_name.i18n_key}.#{base_key}"
-            end
-          end.flatten + base_keys
-        end
-
-        def extract_base_keys(key, action_name)
-          undotted_key = key.sub(/^\./, '')
-          base_keys = [:"#{projector_name}.#{undotted_key}"]
-          base_keys.unshift :"#{projector_name}.#{action_name}.#{undotted_key}" if action_name
-          base_keys
-        end
-      end
+      alias t translate
     end
   end
 end

data/lib/granite/represents/attribute.rb

@@ -11,9 +11,7 @@ module Granite
       end
 
       def sync
-        return if reference.nil?
-
-        reference.public_send(writer, read)
+        reference.public_send(writer, read) if reference.respond_to?(writer)
       end
 
       def typecast(value)

data/lib/granite/routing/mapper.rb

@@ -5,8 +5,8 @@ module Granite
   module Routing
     module Mapper
       def granite(projector_path, **options)
-        route = Route.new(projector_path, options.extract!(:path, :as, :projector_prefix))
-        Declarer.declare(self, route, options)
+        route = Route.new(projector_path, **options.extract!(:path, :as, :projector_prefix))
+        Declarer.declare(self, route, **options)
       end
     end
   end

data/lib/granite/translations.rb

@@ -1,19 +1,14 @@
 module Granite
-  module Translations
-    extend ActiveSupport::Concern
-
-    def translate(*args)
-      I18n.translate(*self.class.scope_translation_args(args))
-    end
-    alias t translate
-
-    module ClassMethods
-      def scope_translation_args(args)
-        options = args.extract_options!
+  class Translations
+    class << self
+      def combine_paths(paths1, paths2)
+        paths1.flat_map do |path1|
+          paths2.map { |path2| [*path1, *path2].join('.') }
+        end
+      end
 
-        lookups = expand_relative_key(args.first).map(&:to_sym)
-        lookups += [options[:default]]
-        lookups = lookups.flatten.compact
+      def scope_translation_args(scopes, key, *, **options)
+        lookups = expand_relative_key(scopes, key) + Array(options[:default])
 
         key = lookups.shift
         options[:default] = lookups
@@ -23,14 +18,10 @@ module Granite
 
       private
 
-      def expand_relative_key(key)
+      def expand_relative_key(scopes, key)
         return [key] unless key.is_a?(String) && key.start_with?('.')
 
-        base_key = key.sub(/^\./, '')
-
-        lookup_ancestors.map do |klass|
-          :"#{klass.i18n_scope}.#{klass.model_name.i18n_key}.#{base_key}"
-        end.flatten + [base_key]
+        combine_paths(scopes, [key.sub(/^\./, '')]).map(&:to_sym)
       end
     end
   end

data/lib/granite/util.rb

@@ -0,0 +1,51 @@
+module Granite
+  module Util
+    extend ActiveSupport::Concern
+
+    # Evaluates value and returns result based on what was passed:
+    # - if Proc was passed, then executes it in context of self
+    # - if Symbol was passed, then calls a method with that name and returns result
+    # - otherwise just returns the value itself
+    # @param value [Object] value to evaluate
+    # @return [Object] result of evaluation
+    def evaluate(value)
+      case value
+      when Proc
+        evaluate_proc(value)
+      when Symbol
+        evaluate_symbol(value)
+      else
+        value
+      end
+    end
+
+    # Evaluates `if` or `unless` conditions present in the supplied
+    # `options` being it a symbol or callable.
+    #
+    # @param [Hash] options The method options to evaluate.
+    # @option options :if method name or callable
+    # @option options :unless method name or callable
+    # @return [Boolean] whether conditions are satisfied
+    def conditions_satisfied?(**options)
+      fail ArgumentError, 'You cannot specify both if and unless' if options.key?(:if) && options.key?(:unless)
+
+      if options.key?(:if)
+        evaluate(options[:if])
+      elsif options.key?(:unless)
+        !evaluate(options[:unless])
+      else
+        true
+      end
+    end
+
+    private
+
+    def evaluate_proc(value)
+      instance_exec(&value)
+    end
+
+    def evaluate_symbol(value)
+      __send__(value)
+    end
+  end
+end

data/lib/granite/version.rb

@@ -1,3 +1,3 @@
 module Granite
-  VERSION = '0.9.5'.freeze
+  VERSION = '0.10.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: granite
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.10.0
 platform: ruby
 authors:
-- Arkadiy Zabazhanov & friends
+- Toptal Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-05 00:00:00.000000000 Z
+date: 2021-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -302,6 +302,8 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - app/controllers/granite/controller.rb
+- app/controllers/granite/controller/translations.rb
+- config/rubocop-default.yml
 - lib/generators/USAGE
 - lib/generators/granite/install_controller_generator.rb
 - lib/generators/granite_generator.rb
@@ -319,14 +321,17 @@ files:
 - lib/granite/action/policies/always_allow_strategy.rb
 - lib/granite/action/policies/any_strategy.rb
 - lib/granite/action/policies/required_performer_strategy.rb
+- lib/granite/action/precondition.rb
 - lib/granite/action/preconditions.rb
 - lib/granite/action/preconditions/base_precondition.rb
 - lib/granite/action/preconditions/embedded_precondition.rb
+- lib/granite/action/preconditions/object_precondition.rb
 - lib/granite/action/projectors.rb
 - lib/granite/action/subject.rb
 - lib/granite/action/transaction.rb
 - lib/granite/action/transaction_manager.rb
 - lib/granite/action/transaction_manager/transactions_stack.rb
+- lib/granite/action/translations.rb
 - lib/granite/action/types.rb
 - lib/granite/action/types/collection.rb
 - lib/granite/base.rb
@@ -341,8 +346,6 @@ files:
 - lib/granite/projector/error.rb
 - lib/granite/projector/helpers.rb
 - lib/granite/projector/translations.rb
-- lib/granite/projector/translations/helper.rb
-- lib/granite/projector/translations/view_helper.rb
 - lib/granite/rails.rb
 - lib/granite/represents.rb
 - lib/granite/represents/attribute.rb
@@ -362,6 +365,7 @@ files:
 - lib/granite/rspec/satisfy_preconditions.rb
 - lib/granite/translations.rb
 - lib/granite/typecasters.rb
+- lib/granite/util.rb
 - lib/granite/version.rb
 - lib/rubocop-granite.rb
 - lib/rubocop/granite.rb
@@ -385,7 +389,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Another business actions architecture for Rails apps

data/lib/granite/projector/translations/helper.rb

@@ -1,22 +0,0 @@
-require 'granite/projector/translations/view_helper'
-
-module Granite
-  class Projector
-    module Translations
-      module Helper
-        extend ActiveSupport::Concern
-
-        included do
-          delegate :scope_translation_args_by_projector, to: :projector_class
-          helper_method :scope_translation_args_by_projector
-          helper ViewHelper
-        end
-
-        def translate(*args)
-          super(*scope_translation_args_by_projector(args, action_name: action_name))
-        end
-        alias t translate
-      end
-    end
-  end
-end

data/lib/granite/projector/translations/view_helper.rb

@@ -1,12 +0,0 @@
-module Granite
-  class Projector
-    module Translations
-      module ViewHelper
-        def translate(*args)
-          super(*scope_translation_args_by_projector(args, action_name: action_name))
-        end
-        alias t translate
-      end
-    end
-  end
-end