granite 0.9.8 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a481550ca7df8de031fb4d8c118fac213c93d5e604217a0012c33b8a9d6b38c7
-  data.tar.gz: 10a9a6b2edce626d410095bede6c239b8745d077389570669cd0594071f127fc
+  metadata.gz: 8a6546b162c712c95bf1c954a99143418186c5392548e7a6f767755d7715854c
+  data.tar.gz: 2cd60295ca235be9d5a561f92777a8a7db2920481f33309c93b6730587df14e3
 SHA512:
-  metadata.gz: f05bce79f8219eebee3a527aa1cf2ac451c9bac2d5e273123fdf599e050a6ec7000b669c78513bd00124f6b09f8305436dfdbede296b0d906ff3a5e5438151ef
-  data.tar.gz: daf3016428d057e31f14e140823278eb5b9150a43e805def99669269435ab48b1e97f2479d3dfda3c4f11d883e3fe08e7d1949ebdaefe7f47d56e867a6d3d08d
+  metadata.gz: 89dbff44372428da1723b72f28181880a69428845fd6e0665b981fbb9f13e4323176f1b888f93986f15da104618f2674b01f445f21ca13ce6472595bf26009be
+  data.tar.gz: df01fdaec830de6c86fe291a608e7e32df1feefcfe2e92964b435e95505ffd027705e531f912bc5e7ee2a779a88485c7a9a1c439366a01de1bec6a88eda5a3b8

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/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/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/preconditions/base_precondition.rb

@@ -9,7 +9,7 @@ module Granite
         end
 
         def execute!(context)
-          _execute(context) if context.conditions_satisfied?(@options)
+          _execute(context) if context.conditions_satisfied?(**@options)
         end
 
         private

data/lib/granite/action/preconditions.rb

@@ -51,15 +51,7 @@ module Granite
           elsif args.first.is_a?(Class)
             add_precondition(ObjectPrecondition, *args, options)
           else
-            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
+            add_preconditions_hash(*args, **options)
           end
         end
 
@@ -72,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/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/action.rb

@@ -12,6 +12,7 @@ require 'granite/action/preconditions'
 require 'granite/action/policies'
 require 'granite/action/projectors'
 require 'granite/action/subject'
+require 'granite/action/translations'
 
 module Granite
   class Action
@@ -39,6 +40,7 @@ module Granite
     end
 
     include Base
+    include Translations
     include Performing
     include Subject
     include Performer
@@ -65,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/assign_data.rb

@@ -0,0 +1,40 @@
+module Granite
+  module AssignData
+    DataAssignment = Struct.new(:method, :options)
+
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :data_assignments
+      self.data_assignments = []
+
+      alias_method :only_run_validations!, :run_validations!
+      protected :only_run_validations! # rubocop:disable Style/AccessModifierDeclarations
+    end
+
+    module ClassMethods
+      # Defines a callback to call when assigning data from business action to model.
+      # @param methods [Array<Symbol>] list of methods to call
+      # @param block [Proc] a block to call
+      # @option options [Symbol, Proc, Object] :if call methods/block if this condition evaluates to true
+      # @option options [Symbol, Proc, Object] :unless call method/block unless this condition evaluates to true
+      def assign_data(*methods, **options, &block)
+        self.data_assignments += methods.map { |method| DataAssignment.new(method, options) }
+        self.data_assignments += [DataAssignment.new(block, options)] if block
+      end
+    end
+
+    protected
+
+    def assign_data
+      data_assignments.each { |assignment| evaluate(assignment.method) if conditions_satisfied?(**assignment.options) }
+    end
+
+    private
+
+    def run_validations!
+      assign_data
+      super
+    end
+  end
+end

data/lib/granite/base.rb

@@ -5,8 +5,11 @@ require 'active_data/model/associations'
 
 require 'granite/translations'
 require 'granite/represents'
+require 'granite/assign_data'
 
 module Granite
+  # Base included in Granite::Action, but also used by ActiveData when building data objects (e.g. when using
+  # embeds_many)
   module Base
     extend ActiveSupport::Concern
 
@@ -19,7 +22,7 @@ module Granite
     include ActiveModel::Validations::Callbacks
 
     include Granite::Util
-    include Granite::Translations
+    include Granite::AssignData
     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)
+    projector.action_for(request_method_symbol, projector_action.to_s)
   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.rb

@@ -13,10 +13,7 @@ module Granite
         fields.each do |field|
           add_attribute Granite::Represents::Reflection, field, options, &block
 
-          before_validation do
-            attribute(field).sync if attribute(field).changed?
-            true
-          end
+          assign_data { attribute(field).sync if attribute(field).changed? }
         end
       end
     end

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

@@ -26,7 +26,7 @@ module Granite
     # @option options :if method name or callable
     # @option options :unless method name or callable
     # @return [Boolean] whether conditions are satisfied
-    def conditions_satisfied?(options)
+    def conditions_satisfied?(**options)
       fail ArgumentError, 'You cannot specify both if and unless' if options.key?(:if) && options.key?(:unless)
 
       if options.key?(:if)

data/lib/granite/version.rb

@@ -1,3 +1,3 @@
 module Granite
-  VERSION = '0.9.8'.freeze
+  VERSION = '0.11.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: granite
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.11.1
 platform: ruby
 authors:
-- Arkadiy Zabazhanov & friends
+- Toptal Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -302,6 +302,7 @@ 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
@@ -330,8 +331,10 @@ files:
 - 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/assign_data.rb
 - lib/granite/base.rb
 - lib/granite/config.rb
 - lib/granite/context.rb
@@ -344,8 +347,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
@@ -389,7 +390,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+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