redmine_crm 0.0.23 → 0.0.53

data/lib/redmine_crm/acts_as_draftable/rcrm_acts_as_draftable.rb

@@ -0,0 +1,172 @@
+# The MIT License (MIT)
+
+# Copyright (c) 2016-2018 Georg Ledermann
+
+# 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.
+
+module RedmineCrm
+  module ActsAsDraftable #:nodoc: all
+    module Base
+      ALLOWED_DRAFT_OPTIONS = [:parent]
+
+      def draftable?
+        false
+      end
+
+      def rcrm_acts_as_draftable(options = {})
+        raise ArgumentError unless options.is_a?(Hash)
+        raise ArgumentError unless options.keys.all? { |k| ALLOWED_DRAFT_OPTIONS.include?(k) }
+
+        class_attribute :draft_parent
+
+        if options[:parent]
+          parent_class = self.reflect_on_all_associations(:belongs_to).find { |a| a.name == options[:parent] }.try(:klass)
+          raise ArgumentError unless parent_class
+
+          unless parent_class.method_defined?(:drafts)
+            parent_class.class_eval do
+              def drafts(user)
+                Draft.where(user: user, parent: self)
+              end
+
+              def self.child_drafts(user)
+                Draft.where(user: user, parent_type: self.base_class.name)
+              end
+            end
+          end
+
+          self.draft_parent = options[:parent]
+        end
+
+        attr_accessor :draft_id
+        before_save :clear_draft
+
+        extend RedmineCrm::ActsAsDraftable::ClassMethods
+        include RedmineCrm::ActsAsDraftable::InstanceMethods
+      end
+    end # Base
+
+    module ClassMethods
+      def draftable?
+        true
+      end
+
+      def from_draft(draft_or_id)
+        draft = draft_or_id.is_a?(Draft) ? draft_or_id : Draft.find(draft_or_id)
+        raise ArgumentError unless draft.target_type == name
+
+        target = draft.target_type.constantize.new
+        target.load_from_draft(draft.data)
+
+        target.draft_id = draft.id
+        target
+      end
+
+      def drafts(user = nil)
+        drafts = Draft.where(target_type: name)
+        drafts = drafts.where(user_id: user.id) if user
+        drafts
+      end
+    end # ClassMethods
+
+    module InstanceMethods
+      def save_draft
+        return false unless new_record? || changed?
+
+        draft = self.draft || Draft.new
+        draft.data = dump_to_draft
+        draft.user_id = User.current.try(:id)
+        draft.parent = parent_for_draft
+        draft.target_type = self.class.name
+
+        result = draft.save
+        self.draft_id = draft.id if result
+        result
+      end
+
+      def update_draft(attributes)
+        with_transaction_returning_status do
+          assign_attributes(attributes)
+          save_draft
+        end
+      end
+
+      def draft
+        Draft.find_by_id(draft_id)
+      end
+
+      def parent_for_draft
+        return self if id.present?
+
+        self.class.draft_parent.present? ? send(self.class.draft_parent) : self
+      end
+
+      def last_draft
+        @last_draft ||= RedmineCrm::ActsAsDraftable::Draft.where(
+          target_type: self.class.name,
+          parent_type: parent_for_draft.try(:class).try(:to_s),
+          parent_id:   parent_for_draft.try(:id),
+          user_id:     User.current.try(:id)
+        ).last
+      end
+
+      def dump_to_draft
+        instance_values.default = nil
+        Marshal.dump(instance_values)
+      end
+
+      def load_from_draft(string)
+        values = Marshal.load(string)
+
+        values.each do |name, value|
+          instance_variable_set("@#{name}", value)
+        end
+      end
+
+      def clear_draft
+        if last_draft && last_draft.destroy
+          self.draft_id = nil
+        end
+      end
+    end # InstanceMethods
+
+    module Migration
+      def create_drafts_table
+        return if connection.table_exists?(:drafts)
+
+        connection.create_table :drafts do |t|
+          t.string :target_type, limit: 150, null: false
+          t.references :user
+          t.references :parent, polymorphic: true
+          t.binary :data, limit: 16777215, null: false
+          t.datetime :updated_at, null: false
+        end
+
+        connection.add_index :drafts, [:user_id, :target_type]
+      end
+
+      def drop_drafts_table
+        connection.drop_table :drafts if connection.table_exists?(:drafts)
+      end
+    end # Migration
+  end
+end
+
+ActiveRecord::Base.extend RedmineCrm::ActsAsDraftable::Base
+ActiveRecord::Base.extend RedmineCrm::ActsAsDraftable::Migration

data/lib/redmine_crm/acts_as_list/list.rb

@@ -0,0 +1,282 @@
+module RedmineCrm
+  module ActsAsList
+    module List
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      # This +acts_as+ extension provides the capabilities for sorting and reordering a number of objects in a list.
+      # The class that has this specified needs to have a +position+ column defined as an integer on
+      # the mapped database table.
+      #
+      # Todo list example:
+      #
+      #   class TodoList < ActiveRecord::Base
+      #     has_many :todo_items, :order => "position"
+      #   end
+      #
+      #   class TodoItem < ActiveRecord::Base
+      #     belongs_to :todo_list
+      #     acts_as_list :scope => :todo_list
+      #   end
+      #
+      #   todo_list.first.move_to_bottom
+      #   todo_list.last.move_higher
+      module ClassMethods
+        # Configuration options are:
+        #
+        # * +column+ - specifies the column name to use for keeping the position integer (default: +position+)
+        # * +scope+ - restricts what is to be considered a list. Given a symbol, it'll attach <tt>_id</tt>
+        #   (if it hasn't already been added) and use that as the foreign key restriction. It's also possible
+        #   to give it an entire string that is interpolated if you need a tighter scope than just a foreign key.
+        #   Example: <tt>acts_as_list :scope => 'todo_list_id = #{todo_list_id} AND completed = 0'</tt>
+        def rcrm_acts_as_list(options = {})
+
+          configuration = { :column => "position", :scope => "1 = 1" }
+          configuration.update(options) if options.is_a?(Hash)
+
+          configuration[:scope] = "#{configuration[:scope]}_id".intern if configuration[:scope].is_a?(Symbol) && configuration[:scope].to_s !~ /_id$/
+
+          if configuration[:scope].is_a?(Symbol)
+            scope_condition_method = %(
+              def scope_condition
+                if #{configuration[:scope].to_s}.nil?
+                  "#{configuration[:scope].to_s} IS NULL"
+                else
+                  "#{configuration[:scope].to_s} = \#{#{configuration[:scope].to_s}}"
+                end
+              end
+            )
+          else
+            scope_condition_method = "def scope_condition() \"#{configuration[:scope]}\" end"
+          end
+
+          class_eval <<-EOV
+            include RedmineCrm::ActsAsList::List::InstanceMethods
+
+            def rcrm_acts_as_list_class
+              ::#{self.name}
+            end
+
+            def position_column
+              '#{configuration[:column]}'
+            end
+
+            #{scope_condition_method}
+
+            before_destroy :remove_from_list
+            before_create  :add_to_list_bottom
+          EOV
+        end
+      end
+
+      # All the methods available to a record that has had <tt>acts_as_list</tt> specified. Each method works
+      # by assuming the object to be the item in the list, so <tt>chapter.move_lower</tt> would move that chapter
+      # lower in the list of all chapters. Likewise, <tt>chapter.first?</tt> would return +true+ if that chapter is
+      # the first in the list of all chapters.
+      module InstanceMethods
+        # Insert the item at the given position (defaults to the top position of 1).
+        def insert_at(position = 1)
+          insert_at_position(position)
+        end
+
+        # Swap positions with the next lower item, if one exists.
+        def move_lower
+          return unless lower_item
+
+          rcrm_acts_as_list_class.transaction do
+            lower_item.decrement_position
+            increment_position
+          end
+        end
+
+        # Swap positions with the next higher item, if one exists.
+        def move_higher
+          return unless higher_item
+
+          rcrm_acts_as_list_class.transaction do
+            higher_item.increment_position
+            decrement_position
+          end
+        end
+
+        # Move to the bottom of the list. If the item is already in the list, the items below it have their
+        # position adjusted accordingly.
+        def move_to_bottom
+          return unless in_list?
+          rcrm_acts_as_list_class.transaction do
+            decrement_positions_on_lower_items
+            assume_bottom_position
+          end
+        end
+
+        # Move to the top of the list. If the item is already in the list, the items above it have their
+        # position adjusted accordingly.
+        def move_to_top
+          return unless in_list?
+          rcrm_acts_as_list_class.transaction do
+            increment_positions_on_higher_items
+            assume_top_position
+          end
+        end
+
+        # Move to the given position
+        def move_to=(pos)
+          case pos.to_s
+          when 'highest'
+            move_to_top
+          when 'higher'
+            move_higher
+          when 'lower'
+            move_lower
+          when 'lowest'
+            move_to_bottom
+          end
+          reset_positions_in_list
+        end
+
+        def reset_positions_in_list
+          rcrm_acts_as_list_class.where(scope_condition).reorder("#{position_column} ASC, id ASC").each_with_index do |item, i|
+            unless item.send(position_column) == (i + 1)
+              rcrm_acts_as_list_class.where({:id => item.id}).
+                update_all({position_column => (i + 1)})
+            end
+          end
+        end
+
+        # Removes the item from the list.
+        def remove_from_list
+          if in_list?
+            decrement_positions_on_lower_items
+            update_attribute position_column, nil
+          end
+        end
+
+        # Increase the position of this item without adjusting the rest of the list.
+        def increment_position
+          return unless in_list?
+          update_attribute position_column, self.send(position_column).to_i + 1
+        end
+
+        # Decrease the position of this item without adjusting the rest of the list.
+        def decrement_position
+          return unless in_list?
+          update_attribute position_column, self.send(position_column).to_i - 1
+        end
+
+        # Return +true+ if this object is the first in the list.
+        def first?
+          return false unless in_list?
+          self.send(position_column) == 1
+        end
+
+        # Return +true+ if this object is the last in the list.
+        def last?
+          return false unless in_list?
+          self.send(position_column) == bottom_position_in_list
+        end
+
+        # Return the next higher item in the list.
+        def higher_item
+          return nil unless in_list?
+          rcrm_acts_as_list_class.where(
+            "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i - 1).to_s}"
+          ).first
+        end
+
+        # Return the next lower item in the list.
+        def lower_item
+          return nil unless in_list?
+          rcrm_acts_as_list_class.where(
+            "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i + 1).to_s}"
+          ).first
+        end
+
+        # Test if this record is in a list
+        def in_list?
+          !send(position_column).nil?
+        end
+
+        private
+
+        def add_to_list_top
+          increment_positions_on_all_items
+        end
+
+        def add_to_list_bottom
+          self[position_column] = bottom_position_in_list.to_i + 1
+        end
+
+        # Overwrite this method to define the scope of the list changes
+        def scope_condition() "1" end
+
+        # Returns the bottom position number in the list.
+        #   bottom_position_in_list    # => 2
+        def bottom_position_in_list(except = nil)
+          item = bottom_item(except)
+          item ? item.send(position_column) : 0
+        end
+
+        # Returns the bottom item
+        def bottom_item(except = nil)
+          conditions = scope_condition
+          conditions = "#{conditions} AND #{self.class.primary_key} != #{except.id}" if except
+          rcrm_acts_as_list_class.where(conditions).reorder("#{position_column} DESC").first
+        end
+
+        # Forces item to assume the bottom position in the list.
+        def assume_bottom_position
+          update_attribute(position_column, bottom_position_in_list(self).to_i + 1)
+        end
+
+        # Forces item to assume the top position in the list.
+        def assume_top_position
+          update_attribute(position_column, 1)
+        end
+
+        # This has the effect of moving all the higher items up one.
+        def decrement_positions_on_higher_items(position)
+          rcrm_acts_as_list_class.
+            where("#{scope_condition} AND #{position_column} <= #{position}").
+            update_all("#{position_column} = (#{position_column} - 1)")
+        end
+
+        # This has the effect of moving all the lower items up one.
+        def decrement_positions_on_lower_items
+          return unless in_list?
+          rcrm_acts_as_list_class.
+            where("#{scope_condition} AND #{position_column} > #{send(position_column).to_i}").
+            update_all("#{position_column} = (#{position_column} - 1)")
+        end
+
+        # This has the effect of moving all the higher items down one.
+        def increment_positions_on_higher_items
+          return unless in_list?
+          rcrm_acts_as_list_class.
+            where("#{scope_condition} AND #{position_column} < #{send(position_column).to_i}").
+            update_all("#{position_column} = (#{position_column} + 1)")
+        end
+
+        # This has the effect of moving all the lower items down one.
+        def increment_positions_on_lower_items(position)
+          rcrm_acts_as_list_class.
+            where("#{scope_condition} AND #{position_column} >= #{position}").
+            update_all("#{position_column} = (#{position_column} + 1)")
+        end
+
+        # Increments position (<tt>position_column</tt>) of all items in the list.
+        def increment_positions_on_all_items
+          rcrm_acts_as_list_class.
+            where("#{scope_condition}").
+            update_all("#{position_column} = (#{position_column} + 1)")
+        end
+
+        def insert_at_position(position)
+          remove_from_list
+          increment_positions_on_lower_items(position)
+          self.update_attribute(position_column, position)
+        end
+      end
+    end
+  end
+end