statesman_mongoid 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12b141e7bcaf520970181af415dcdfe5256b148573fd01e3a4639d6585811f97
-  data.tar.gz: 536f5ef0cd30da45fa1abb42ff78fcb80f1be5362fa57257c515580d32676c9a
+  metadata.gz: e91c70458d4fc19660876de07d0943d6556dd74b21128224fac9fbff5e949bc3
+  data.tar.gz: 7c334f7ab383ba19a2ea4a023069c295f61011fbad0a104dd0953b866201cb01
 SHA512:
-  metadata.gz: 836739d3e0bc37bebcb07a509bf4e5609715545b3aa564954999d6da5823a0f2442e0f60ef1756e1ce47163a6d1481e284c1591608b6c8f9376f30293fda4805
-  data.tar.gz: 90d396cfbec77f2e354970e214a7f845e5dac8bbeac546ac2262a41cead4abe11da8d9485e3aa9dcdfc576d538c60b66fbc5059cdddcc8cc9da88a2bac18caed
+  metadata.gz: 6774cea42364ac55c0be27f00de380f6a4404069099b7a0656c4ac36969dfb67d4d8125b05abbf56775b2f0530f1d843270c0f736f5ec9ccfa22302b2f2982ad
+  data.tar.gz: b277d6b9e6611b538955fcce1cb75b088f600d053c0e8d0297f6cd5239ba534f01d9af98bc77a1ee7c8ada6afd2807f0530eb9e8b53168b4b10881477c0f797f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    statesman_mongoid (0.1.1)
+    statesman_mongoid (0.4.0)
       statesman (~> 10.0)
 
 GEM

data/README.md

@@ -1,6 +1,10 @@
 # Statesman Mongoid
 
-Restored mongoid adapters for the Statesman gem.
+Mongoid adapters for [Statesman](https://github.com/gocardless/statesman). 
+
+TODO: Restore & update specs
+
+NOTE: Restored Statesman's mongoid support with some fixes & updates. This project is in an early stage, please report any bugs or missing features. Use at your own risk and feel free to contribute.
 
 ## Installation
 
@@ -20,7 +24,19 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+TODO: Expand usage instructions 
+
+Follow instructions in the Statesman's doc and replace invoked classes with these ones when approriate:
+``` ruby
+Statesman::Adapters::Mongoid
+Statesman::Adapters::MongoidTransition
+Statesman::Adapters::MongoidQueries
+```
+
+Generator:
+```
+rails generate statesman:mongoid_transition Order OrderTransition
+```
 
 ## Development
 
@@ -30,7 +46,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/statesman_mongoid.
+Bug reports and pull requests are welcome on GitHub at https://github.com/oz-tal/statesman_mongoid.
 
 ## License
 

data/lib/generators/statesman/mongoid_transition_generator.rb

@@ -0,0 +1,27 @@
+# Extracted from commit b9906ee1cf0ac6c1bbdd56c003ffe407c2f59833
+
+require "rails/generators"
+require "generators/statesman/generator_helpers"
+
+module Statesman
+  class MongoidTransitionGenerator < Rails::Generators::Base
+    include Statesman::GeneratorHelpers
+
+    desc "Create a Mongoid-based transition model with the required attributes"
+
+    argument :parent, type: :string, desc: "Your parent model name"
+    argument :klass, type: :string, desc: "Your transition model name"
+
+    source_root File.expand_path("templates", __dir__)
+
+    def create_model_file
+      template("mongoid_transition_model.rb.erb", model_file_name)
+    end
+
+    private
+
+    def collection_name
+      klass.underscore.pluralize
+    end
+  end
+end

data/lib/generators/statesman/templates/mongoid_transition_model.rb.erb

@@ -0,0 +1,7 @@
+class <%= klass %>
+  include Statesman::Adapters::MongoidTransition
+
+  index({ sort_key: 1 })
+
+  belongs_to :<%= parent %><%= class_name_option %>, index: true
+end

data/lib/statesman/adapters/mongoid.rb

@@ -1,4 +1,4 @@
-# Restored mongoid support, untouched
+# Restored mongoid support with feature parity
 # Extracted from commit b9906ee1cf0ac6c1bbdd56c003ffe407c2f59833
 
 module Statesman
@@ -33,18 +33,25 @@ module Statesman
         @last_transition = nil
       end
 
-      def history(*)
+      def history(force_reload: false)
+        reset if force_reload
         transitions_for_parent.asc(:sort_key)
       end
 
       def last(force_reload: false)
         if force_reload
-          @last_transition = history.last
+          @last_transition = history(force_reload: true).last
         else
           @last_transition ||= history.last
         end
       end
 
+      def reset
+        # Aggressive, but the query cache can't be targeted at a more granular level
+        ::Mongoid::QueryCache.clear_cache
+      end
+
+
       private
 
       def transition_class_hash_fields

data/lib/statesman/adapters/mongoid_queries.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+# Based on the somewhat compatible ActiveRecordQueries at commit 455a21dd74bb7d3b7555de0dd66e2ece9461c22d
+
+module Statesman
+  module Adapters
+    module MongoidQueries
+      def self.check_missing_methods!(base)
+        missing_methods = %i[transition_class initial_state].
+          reject { |m| base.respond_to?(m) }
+        return if missing_methods.none?
+
+        raise NotImplementedError,
+              "#{missing_methods.join(', ')} method(s) should be defined on " \
+              "the model. Alternatively, use the new form of `include " \
+              "Statesman::Adapters::MongoidQueries[" \
+              "transition_class: MyTransition, " \
+              "initial_state: :some_state]`"
+      end
+
+      def self.included(base)
+        check_missing_methods!(base)
+
+        base.include(
+          ClassMethods.new(
+            transition_class: base.transition_class,
+            initial_state: base.initial_state,
+            most_recent_transition_alias: base.try(:most_recent_transition_alias),
+            transition_name: base.try(:transition_name),
+          ),
+        )
+      end
+
+      def self.[](**args)
+        ClassMethods.new(**args)
+      end
+
+      class ClassMethods < Module
+        def initialize(**args)
+          @args = args
+        end
+
+        def included(base)
+          ensure_inheritance(base)
+
+          query_builder = QueryBuilder.new(base, **@args)
+
+          define_in_state(base, query_builder)
+          define_not_in_state(base, query_builder)
+
+          define_method(:reload) do |*a|
+            instance = super(*a)
+            if instance.respond_to?(:state_machine, true)
+              instance.state_machine.reset
+            end
+            instance
+          end
+        end
+
+        private
+
+        def ensure_inheritance(base)
+          klass = self
+          existing_inherited = base.method(:inherited)
+          base.define_singleton_method(:inherited) do |subclass|
+            existing_inherited.call(subclass)
+            subclass.send(:include, klass)
+          end
+        end
+
+        def define_in_state(base, query_builder)
+          base.define_singleton_method(:in_state) do |*states|
+            query_builder.states_where(states.flatten)
+          end
+        end
+
+        def define_not_in_state(base, query_builder)
+          base.define_singleton_method(:not_in_state) do |*states|
+            query_builder.states_where_not(states.flatten)
+          end
+        end
+      end
+
+      class QueryBuilder
+        def initialize(model, transition_class:, initial_state:,
+                       most_recent_transition_alias: nil,
+                       transition_name: nil)
+          @model = model
+          @transition_class = transition_class
+          @initial_state = initial_state
+          @most_recent_transition_alias = most_recent_transition_alias
+          @transition_name = transition_name
+        end
+
+        def states_where(states)
+          ids = aggregate_ids_for_most_recent(states, inclusive_match: true)
+          model.where(_id: { '$in' => ids })
+        end
+
+        def states_where_not(states)
+          ids = aggregate_ids_for_most_recent(states, inclusive_match: false)
+          model.where(_id: { '$in' => ids })
+        end
+
+        def aggregate_ids_for_most_recent(states, inclusive_match: true)
+          aggregation = [
+            # Sort most recent
+            { '$sort': { sort_key: -1 } },
+            # Group by foreign key & get most recent states
+            {
+              '$group': {
+                _id: "$#{model_foreign_key}",
+                to_state: { '$first': '$to_state' },
+                model_foreign_key => { '$first': "$#{model_foreign_key}" },
+              },
+            },
+            # Include/exclude states by provided states
+            { '$match': { to_state: { (inclusive_match ? '$in' : '$nin') => states } } },
+            # Trim response to only the foreign key
+            { '$project': { _id: 0, to_state: 0 } },
+          ]
+
+          # Hit the database and return a flat array of ids
+          transition_class.collection.aggregate(aggregation).pluck(model_foreign_key)
+        end
+
+
+        private
+
+        attr_reader :model, :transition_class, :initial_state
+
+        def transition_name
+          @transition_name || transition_class.collection.name.to_sym
+        end
+
+        def transition_reflection
+          model.reflect_on_all_associations(:has_many).each do |value|
+            return value if value.klass == transition_class
+          end
+
+          raise MissingTransitionAssociation,
+                "Could not find has_many association between #{self.class} " \
+                "and #{transition_class}."
+        end
+
+        def model_primary_key
+          transition_reflection.primary_key
+        end
+
+        def model_foreign_key
+          transition_reflection.foreign_key
+        end
+
+        def model_table
+          transition_reflection.name
+        end
+
+        def most_recent_transition_alias
+          @most_recent_transition_alias ||
+            "most_recent_#{transition_name.to_s.singularize}"
+        end
+      end
+    end
+  end
+end

data/lib/statesman_mongoid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StatesmanMongoid
-  VERSION = "0.1.1"
+  VERSION = "0.4.0"
 end

data/lib/statesman_mongoid.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "statesman_mongoid/version"
-require_relative "statesman/adapters/mongoid"
-require_relative "statesman/adapters/mongoid_transition"
+# require_relative "statesman_mongoid/version"
+Dir[__dir__ + '/statesman/adapters/*'].each &method(:require)
 
 module StatesmanMongoid
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statesman_mongoid
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - oz-tal
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-03 00:00:00.000000000 Z
+date: 2023-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statesman
@@ -36,7 +36,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/statesman/mongoid_transition_generator.rb
+- lib/generators/statesman/templates/mongoid_transition_model.rb.erb
 - lib/statesman/adapters/mongoid.rb
+- lib/statesman/adapters/mongoid_queries.rb
 - lib/statesman/adapters/mongoid_transition.rb
 - lib/statesman_mongoid.rb
 - lib/statesman_mongoid/version.rb