granite 0.15.4 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2c26504cf64e66471237d5e225ec9a764c97a7d0a7e4fe70506b707402fb758
-  data.tar.gz: 1a4e0f6d7713d2d3c2c3f8b4a0651c3a42aeb60bdc0057a92ebae516c7bf8cab
+  metadata.gz: de7f652f9f341a639c08c1f535e9bae3d07527ba5efc09599accf18895472607
+  data.tar.gz: f2792a296afbf39f20de772bf8d735ae778415f7214f1280dccde2dac58015e6
 SHA512:
-  metadata.gz: 4385e90e1084b85136a23a6b441ce2f22ec709658ac70c4459bf178ec8de9145666886fececfcbb18d846e8edb28260f2c43313fd2f2e209a37fa22035074046
-  data.tar.gz: 59b8b496841fbc135f11ccba324bc45036a85f808f3340b045ef5b92aa3cd72cfc43bd0e5c8e68740c866a6b4102dfbff6ba4ea078baee0ad214eef169f9b9c4
+  metadata.gz: 209c96c7464851ab67c3cc21c3b8b241c9874de746640924c322cb48a237e7c8f91a483e84d438247910103138215fe2cf5bdebe9855ae6633c5f180dc142b17
+  data.tar.gz: 8a27c93316cfdfbd050033567ff99ffeabe9cf73725810a73ed3c7ae76bfafde321c6b3e4f6b85bf7bb151517d61d36fd42fa084bf173c29bf784d44e7c5bd74

data/lib/generators/granite_generator.rb

@@ -5,11 +5,11 @@ class GraniteGenerator < Rails::Generators::NamedBase
   class_option :collection, type: :boolean, aliases: '-C', desc: 'Generate collection action'
 
   def create_action
-    template 'granite_action.rb.erb', "apq/actions/ba/#{file_path}.rb"
-    template 'granite_business_action.rb.erb', "apq/actions/ba/#{class_path.join('/')}/business_action.rb" unless options.collection?
+    template 'granite_action.rb.erb', "apq/actions/#{file_path}.rb"
+    template 'granite_business_action.rb.erb', "apq/actions/#{class_path.join('/')}/business_action.rb" unless options.collection?
     template 'granite_base_action.rb.erb', 'apq/actions/base_action.rb', skip: true
-    template 'granite_action_spec.rb.erb', "spec/apq/actions/ba/#{file_path}_spec.rb"
-    empty_directory "apq/actions/ba/#{file_path}/#{projector}" if projector
+    template 'granite_action_spec.rb.erb', "spec/apq/actions/#{file_path}_spec.rb"
+    empty_directory "apq/actions/#{file_path}/#{projector}" if projector
   end
 
   private
@@ -18,7 +18,7 @@ class GraniteGenerator < Rails::Generators::NamedBase
     if options.collection?
       'BaseAction'
     else
-      "BA::#{class_path.join('/').camelize}::BusinessAction"
+      "#{class_path.join('/').camelize}::BusinessAction"
     end
   end
 

data/lib/generators/templates/granite_action.rb.erb

@@ -1,4 +1,4 @@
-class BA::<%= class_name %> < <%= base_class_name %>
+class <%= class_name %> < <%= base_class_name %>
 <% if projector -%>
   projector :<%= projector %>
 

data/lib/generators/templates/granite_action_spec.rb.erb

@@ -1,6 +1,6 @@
 require 'rails_helper'
 
-RSpec.describe BA::<%= class_name %> do
+RSpec.describe <%= class_name %> do
 <% if options.collection? -%>
   subject(:action) { described_class.as(performer).new(attributes) }
 

data/lib/generators/templates/granite_business_action.rb.erb

@@ -1,3 +1,3 @@
-class BA::<%= class_path.join('/').camelize %>::BusinessAction < BaseAction
+class <%= class_path.join('/').camelize %>::BusinessAction < BaseAction
   subject :<%= subject_name %>
 end

data/lib/granite/action/performing.rb

@@ -42,7 +42,9 @@ 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)
+          fail Rollback unless valid?(context)
+
+          perform_action(**options)
         end
       end
 
@@ -93,7 +95,6 @@ module Granite
 
       def perform_action(raise_errors: false, **options)
         result = run_callbacks(:execute_perform) do
-          apply_association_changes!
           execute_perform!(**options)
         end
         @_action_performed = true

data/lib/granite/action/transaction.rb

@@ -6,20 +6,8 @@ module Granite
       extend ActiveSupport::Concern
 
       included do
-        define_callbacks :commit
-      end
-
-      module ClassMethods
-        delegate :transaction, to: :'Granite::Action::TransactionManager'
-
-        private
-
-        # Defines a callback which will be triggered right after transaction committed
-        # Uses the same arguments as `ActiveSupport::Callbacks.set_callback` except for the first two
-        #
-        def after_commit(*args, &block)
-          set_callback :commit, :after, *args, &block
-        end
+        define_model_callbacks :commit, only: :after
+        singleton_class.delegate :transaction, to: :'Granite::Action::TransactionManager'
       end
 
       def run_callbacks(event)
@@ -36,10 +24,10 @@ module Granite
 
       private
 
-      attr_accessor :granite_in_transaction
+      attr_accessor :in_transaction
 
       def transaction(&block)
-        if granite_in_transaction
+        if in_transaction
           yield
         else
           run_in_transaction(&block)
@@ -47,14 +35,14 @@ module Granite
       end
 
       def run_in_transaction
-        self.granite_in_transaction = true
+        self.in_transaction = true
 
         TransactionManager.transaction do
           TransactionManager.after_commit(self)
           yield
         end
       ensure
-        self.granite_in_transaction = false
+        self.in_transaction = false
       end
     end
   end

data/lib/granite/action/transaction_manager.rb

@@ -62,7 +62,7 @@ module Granite
           collected_errors = []
 
           callbacks.reverse_each do |callback|
-            callback.respond_to?(:run_callbacks) ? callback.run_callbacks(:commit) : callback.call
+            callback.respond_to?(:_run_commit_callbacks) ? callback._run_commit_callbacks : callback.call
           rescue StandardError => e
             collected_errors << e
           end

data/lib/granite/action.rb

@@ -3,7 +3,6 @@ require 'active_record/errors'
 require 'active_record/validations'
 require 'active_support/callbacks'
 
-require 'granite/action/types'
 require 'granite/action/error'
 require 'granite/action/instrumentation'
 require 'granite/action/performing'
@@ -63,6 +62,13 @@ module Granite
       merge_errors(e.action.errors)
     end
 
+    define_model_callbacks :initialize, only: :after
+
+    def initialize(*)
+      super
+      _run_initialize_callbacks
+    end
+
     if ActiveModel.version < Gem::Version.new('6.1.0')
       def merge_errors(other_errors)
         errors.messages.deep_merge!(other_errors.messages) do |_, this, other|

data/lib/granite/assign_data.rb

@@ -10,6 +10,8 @@ module Granite
 
       alias_method :only_run_validations!, :run_validations!
       protected :only_run_validations!
+
+      assign_data :sync_attributes
     end
 
     module ClassMethods

data/lib/granite/base.rb

@@ -1,10 +1,8 @@
 require 'granite/form/model'
 require 'granite/form/model/primary'
-require 'granite/form/model/lifecycle'
 require 'granite/form/model/associations'
 
 require 'granite/translations'
-require 'granite/represents'
 require 'granite/assign_data'
 
 module Granite
@@ -12,8 +10,8 @@ module Granite
   # embeds_many)
   module Base
     extend ActiveSupport::Concern
+    extend ActiveModel::Callbacks
 
-    include ActiveSupport::Callbacks
     include Granite::Form::Model
     include Granite::Form::Model::Representation
     include Granite::Form::Model::Dirty
@@ -21,8 +19,6 @@ module Granite
     include Granite::Form::Model::Primary
     include ActiveModel::Validations::Callbacks
 
-    include Granite::Util
     include Granite::AssignData
-    include Granite::Represents
   end
 end

data/lib/granite/projector/helpers.rb

@@ -5,7 +5,7 @@ module Granite
     class ActionNotMountedError < Error
       def initialize(projector)
         super("Seems like #{projector.class} was not mounted. \
-Do you have #{projector.action_class.name.underscore}##{projector.projector_name} declared in routes?", projector)
+Do you have #{projector.action_name}##{projector.projector_name} declared in routes?", projector)
       end
     end
 
@@ -43,7 +43,7 @@ Do you have #{projector.action_class.name.underscore}##{projector.projector_name
       end
 
       def route_id
-        [action_class.name.underscore, projector_name]
+        [action_name, projector_name]
       end
 
       def url_options

data/lib/granite/projector.rb

@@ -12,7 +12,7 @@ module Granite
     include Translations
 
     singleton_class.__send__(:attr_accessor, :action_class)
-    delegate :action_class, :projector_name, to: 'self.class'
+    delegate :action_class, :projector_name, :action_name, to: 'self.class'
     attr_reader :action
 
     def self.controller_class
@@ -31,6 +31,10 @@ module Granite
       @projector_name ||= name.demodulize.remove(/Projector$/).underscore
     end
 
+    def self.action_name
+      @action_name ||= action_class.name.underscore
+    end
+
     def initialize(*args)
       @action = if args.first.is_a?(Granite::Action) # Temporary solutions for backwards compatibility.
                   args.first

data/lib/granite/rspec/projector_helpers.rb

@@ -1,9 +1,8 @@
 module Granite::ProjectorHelpers
   extend ActiveSupport::Concern
+  include RSpec::Rails::ControllerExampleGroup
 
   included do
-    include RSpec::Rails::ControllerExampleGroup
-    include RSpec::Rails::RequestExampleGroup
     before { Granite::Routing::Declarer.dispatcher.unmemoize_all }
   end
 
@@ -23,16 +22,17 @@ module Granite::ProjectorHelpers
     end
 
     def projector(&block)
-      setup_controller(&block)
+      setup_controller
       setup_view_context
+      let(:projector_class, &block)
       let(:projector) { controller.projector }
     end
 
     private
 
-    def setup_controller(&block)
+    def setup_controller
       define_method :setup_controller_request_and_response do
-        @controller ||= instance_eval(&block).controller_class.new
+        @controller ||= projector_class.controller_class.new
         super()
       end
     end
@@ -42,6 +42,12 @@ module Granite::ProjectorHelpers
       after { Granite.view_context = nil }
     end
   end
+
+  # Overrides ActionController::TestCase::Behavior#process to include granite_action and granite_projector
+  def process(action, **options)
+    projector_params = {granite_action: projector_class.action_name, granite_projector: projector_class.projector_name}
+    super(action, **options, params: projector_params.reverse_merge(options[:params] || {}))
+  end
 end
 
 RSpec.configuration.define_derived_metadata(file_path: %r{spec/apq/projectors/}) { |metadata| metadata[:type] ||= :granite_projector }

data/lib/granite/version.rb

@@ -1,3 +1,3 @@
 module Granite
-  VERSION = '0.15.4'.freeze
+  VERSION = '0.16.0'.freeze
 end

data/lib/granite.rb

@@ -5,7 +5,6 @@ require 'ruby2_keywords'
 require 'granite/version'
 require 'granite/config'
 require 'granite/context'
-require 'granite/util'
 
 module Granite
   def self.config
@@ -25,7 +24,6 @@ require 'granite/dispatcher'
 require 'granite/action'
 require 'granite/projector'
 require 'granite/routing'
-require 'granite/typecasters'
-require 'granite/rails' if defined?(::Rails)
+require 'granite/rails' if defined?(Rails)
 
 Granite::Form.base_concern = Granite::Base

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: granite
 version: !ruby/object:Gem::Version
-  version: 0.15.4
+  version: 0.16.0
 platform: ruby
 authors:
 - Toptal Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-19 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +120,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  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: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -355,8 +369,6 @@ files:
 - 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
@@ -372,9 +384,6 @@ files:
 - lib/granite/projector/helpers.rb
 - lib/granite/projector/translations.rb
 - lib/granite/rails.rb
-- lib/granite/represents.rb
-- lib/granite/represents/attribute.rb
-- lib/granite/represents/reflection.rb
 - lib/granite/routing.rb
 - lib/granite/routing/cache.rb
 - lib/granite/routing/caching.rb
@@ -390,8 +399,6 @@ files:
 - lib/granite/rspec/raise_validation_error.rb
 - 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
@@ -415,7 +422,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Another business actions architecture for Rails apps

data/lib/granite/action/types/collection.rb

@@ -1,13 +0,0 @@
-module Granite
-  class Action
-    module Types
-      class Collection
-        attr_reader :subtype
-
-        def initialize(subtype)
-          @subtype = subtype
-        end
-      end
-    end
-  end
-end

data/lib/granite/action/types.rb

@@ -1 +0,0 @@
-require 'granite/action/types/collection'

data/lib/granite/represents/attribute.rb

@@ -1,109 +0,0 @@
-module Granite
-  module Represents
-    class Attribute < Granite::Form::Model::Attributes::Attribute
-      types = {}
-      types[ActiveRecord::Enum::EnumType] = String if defined?(ActiveRecord)
-      TYPES = types.freeze
-      delegate :writer, :reader, :reader_before_type_cast, to: :reflection
-
-      def initialize(*_args)
-        super
-
-        set_default_value
-        set_default_value_before_type_cast
-      end
-
-      def sync
-        reference.public_send(writer, read) if reference.respond_to?(writer)
-      end
-
-      def typecast(value)
-        return value if value.class == type # rubocop:disable Style/ClassEqualityComparison
-
-        typecaster.call(value, self) unless value.nil?
-      end
-
-      def type
-        return reflection.options[:type] if reflection.options[:type].present?
-
-        granite_form_type || type_from_type_for_attribute || super
-      end
-
-      def typecaster
-        @typecaster ||= begin
-          type_class = type.instance_of?(Class) ? type : type.class
-          @typecaster = Granite::Form.typecaster(type_class.ancestors.grep(Class))
-        end
-      end
-
-      def changed?
-        if reflection.options.key?(:default)
-          reference.public_send(reader) != read
-        else
-          owner.public_send("#{name}_changed?")
-        end
-      end
-
-      private
-
-      def reference
-        owner.__send__(reflection.reference)
-      end
-
-      def set_default_value
-        return unless reference.respond_to?(reader)
-
-        variable_cache(:value) do
-          normalize(enumerize(typecast(defaultize(reference.public_send(reader)))))
-        end
-      end
-
-      def set_default_value_before_type_cast
-        return unless reference.respond_to?(reader_before_type_cast)
-
-        variable_cache(:value_before_type_cast) do
-          defaultize(reference.public_send(reader_before_type_cast))
-        end
-      end
-
-      def granite_form_type
-        return nil unless reference.is_a?(Granite::Form::Model)
-
-        reference_attribute = reference.attribute(name)
-
-        return nil if reference_attribute.nil?
-
-        return Granite::Action::Types::Collection.new(reference_attribute.type) if [
-          Granite::Form::Model::Attributes::ReferenceMany,
-          Granite::Form::Model::Attributes::Collection,
-          Granite::Form::Model::Attributes::Dictionary
-        ].any? { |klass| reference_attribute.is_a? klass }
-
-        reference_attribute.type # TODO: create `type_for_attribute` method inside of Granite::Form
-      end
-
-      def type_from_type_for_attribute
-        return nil unless reference.respond_to?(:type_for_attribute)
-
-        attribute_type = reference.type_for_attribute(attribute_name.to_s)
-
-        return TYPES[attribute_type.class] if TYPES.key?(attribute_type.class)
-        return Granite::Action::Types::Collection.new(convert_type_to_value_class(attribute_type.subtype)) if attribute_type.respond_to?(:subtype)
-
-        convert_type_to_value_class(attribute_type)
-      end
-
-      def attribute_name
-        return name if ActiveModel.version >= Gem::Version.new('6.1.0')
-
-        reference.class.attribute_aliases[name.to_s] || name
-      end
-
-      def convert_type_to_value_class(attribute_type)
-        return attribute_type.value_class if attribute_type.respond_to?(:value_class)
-
-        Granite::Form::Model::Associations::PersistenceAdapters::ActiveRecord::TYPES[attribute_type.type&.to_sym]
-      end
-    end
-  end
-end

data/lib/granite/represents/reflection.rb

@@ -1,24 +0,0 @@
-require 'granite/represents/attribute'
-
-module Granite
-  module Represents
-    class Reflection < Granite::Form::Model::Attributes::Reflections::Represents
-      class << self
-        def build(target, generated_methods, name, *args, &block)
-          options = args.last
-
-          reference = target.reflect_on_association(options[:of]) if target.respond_to?(:reflect_on_association)
-          reference ||= target.reflect_on_attribute(options[:of]) if target.respond_to?(:reflect_on_attribute)
-
-          target.validates_presence_of(reference.name) if reference
-
-          super(target, generated_methods, name, *args, &block)
-        end
-
-        def attribute_class
-          @attribute_class ||= Granite::Represents::Attribute
-        end
-      end
-    end
-  end
-end

data/lib/granite/represents.rb

@@ -1,21 +0,0 @@
-require 'granite/represents/reflection'
-
-module Granite
-  module Represents
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-      private
-
-      def represents(*fields, &block)
-        options = fields.extract_options!.symbolize_keys
-
-        fields.each do |field|
-          add_attribute Granite::Represents::Reflection, field, options, &block
-
-          assign_data { attribute(field).sync if attribute(field).changed? }
-        end
-      end
-    end
-  end
-end

data/lib/granite/typecasters.rb

@@ -1,10 +0,0 @@
-require 'granite/form'
-
-Granite::Form.typecaster('Granite::Action::Types::Collection') do |value, attribute|
-  typecaster = Granite::Form.typecaster(attribute.type.subtype)
-  if value.respond_to? :transform_values
-    value.transform_values { |v| typecaster.call(v, attribute) }
-  elsif value.respond_to?(:map)
-    value.map { |v| typecaster.call(v, attribute) }
-  end
-end

data/lib/granite/util.rb

@@ -1,51 +0,0 @@
-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