central-support 0.9.0

data/lib/central/support/concerns/project_concern/scopes.rb

@@ -0,0 +1,26 @@
+module Central
+  module Support
+    module ProjectConcern
+      module Scopes
+        extend ActiveSupport::Concern
+
+        included do
+          scope :not_archived, -> { where(archived_at: nil) }
+          scope :archived, -> { where.not(archived_at: nil) }
+        end
+
+        def archived
+          !!(archived_at)
+        end
+
+        def archived=(value)
+          if !value || value == "0"
+            self.archived_at = nil
+          else
+            self.archived_at = Time.current
+          end
+        end
+      end
+    end
+  end
+end

data/lib/central/support/concerns/project_concern/validations.rb

@@ -0,0 +1,43 @@
+module Central
+  module Support
+    module ProjectConcern
+      module Validations
+        extend ActiveSupport::Concern
+
+        included do
+          # These are the valid point scales for a project. These represent
+          # the set of valid points estimate values for a story in this project.
+          POINT_SCALES = {
+            'fibonacci'     => [1,2,3,5,8].freeze,
+            'powers_of_two' => [1,2,4,8].freeze,
+            'linear'        => [1,2,3,4,5].freeze,
+          }.freeze
+
+          validates_inclusion_of :point_scale, in: POINT_SCALES.keys,
+            message: "%{value} is not a valid estimation scheme"
+
+          ITERATION_LENGTH_RANGE = (1..4).freeze
+
+          validates_numericality_of :iteration_length,
+            greater_than_or_equal_to: ITERATION_LENGTH_RANGE.min,
+            less_than_or_equal_to: ITERATION_LENGTH_RANGE.max, only_integer: true,
+            message: "must be between 1 and 4 weeks"
+
+          validates_numericality_of :iteration_start_day,
+            greater_than_or_equal_to: 0, less_than_or_equal_to: 6,
+            only_integer: true, message: "must be an integer between 0 and 6"
+
+          validates :name, presence: true
+
+          validates_numericality_of :default_velocity, greater_than: 0,
+                                    only_integer: true
+        end
+
+        # Returns an array of the valid points values for this project
+        def point_values
+          POINT_SCALES[point_scale]
+        end
+      end
+    end
+  end
+end

data/lib/central/support/concerns/story_concern.rb

@@ -0,0 +1,7 @@
+require 'central/support/concerns/story_concern/attributes'
+require 'central/support/concerns/story_concern/associations'
+require 'central/support/concerns/story_concern/validations'
+require 'central/support/concerns/story_concern/transitions'
+require 'central/support/concerns/story_concern/scopes'
+require 'central/support/concerns/story_concern/callbacks'
+require 'central/support/concerns/story_concern/csv'

data/lib/central/support/concerns/story_concern/associations.rb

@@ -0,0 +1,23 @@
+module Central
+  module Support
+    module StoryConcern
+      module Associations
+        extend ActiveSupport::Concern
+        included do
+          belongs_to :project, counter_cache: true
+          belongs_to :requested_by, class_name: 'User'
+          belongs_to :owned_by, class_name: 'User'
+
+          has_many :users, through: :project
+        end
+
+        # The list of users that should be notified when a new note is added to this
+        # story.  Includes the requestor, the owner, and any other users who have
+        # added notes to the story.
+        def stakeholders_users
+          ([requested_by, owned_by] + notes.map(&:user)).compact.uniq
+        end
+      end
+    end
+  end
+end

data/lib/central/support/concerns/story_concern/attributes.rb

@@ -0,0 +1,29 @@
+module Central
+  module Support
+    module StoryConcern
+      module Attributes
+        extend ActiveSupport::Concern
+
+        included do
+          delegate :suppress_notifications, to: :project
+
+          # This attribute is used to store the user who is acting on a story, for
+          # example delivering or modifying it.  Usually set by the controller.
+          attr_accessor :acting_user, :base_uri
+          attr_accessor :iteration_number, :iteration_start_date # helper fields for IterationService
+          attr_accessor :iteration_service
+        end
+
+        def to_s
+          title
+        end
+
+        def cycle_time_in(unit = :days)
+          raise 'wrong unit' unless %i[days weeks months years].include?(unit)
+          ( cycle_time / 1.send(unit) ).round
+        end
+
+      end
+    end
+  end
+end

data/lib/central/support/concerns/story_concern/callbacks.rb

@@ -0,0 +1,50 @@
+module Central
+  module Support
+    module StoryConcern
+      module Callbacks
+        extend ActiveSupport::Concern
+
+        included do
+          before_validation :set_position_to_last
+          before_save :set_started_at
+          before_save :set_accepted_at
+          before_save :cache_user_names
+          before_destroy { |record| raise ActiveRecord::ReadOnlyRecord if record.readonly? }
+        end
+
+        def set_position_to_last
+          return true if position
+          return true unless project
+          last = project.stories.order(position: :desc).first
+          self.position = last ? ( last.position + 1 ) : 1
+        end
+
+        def set_started_at
+          return unless state_changed?
+          return unless state == 'started'
+          self.started_at = Time.current if started_at.nil?
+          if owned_by.nil? && acting_user
+            self.owned_by = acting_user
+          end
+        end
+
+        def set_accepted_at
+          return unless state_changed?
+          return unless state == 'accepted'
+          self.accepted_at = Time.current if accepted_at.nil?
+          if started_at
+            self.cycle_time = accepted_at - started_at
+          end
+        end
+
+        def cache_user_names
+          self.requested_by_name = requested_by.name unless requested_by.nil?
+          if owned_by.present?
+            self.owned_by_name     = owned_by.name
+            self.owned_by_initials = owned_by.initials
+          end
+        end
+      end
+    end
+  end
+end

data/lib/central/support/concerns/story_concern/csv.rb

@@ -0,0 +1,81 @@
+module Central
+  module Support
+    module StoryConcern
+      module CSV
+        extend ActiveSupport::Concern
+
+        included do
+          CSV_HEADERS = [
+            "Id", "Story","Labels","Iteration","Iteration Start","Iteration End",
+            "Story Type","Estimate","Current State","Started At", "Created at","Accepted at",
+            "Deadline","Requested By","Owned By","Description","URL"
+          ]
+
+          # Returns an array, in the correct order, of the headers to be added to
+          # a CSV render of a list of stories
+          def self.csv_headers
+            CSV_HEADERS
+          end
+
+          has_many :notes, -> { order(:created_at) }, dependent: :destroy do
+
+            # Creates a collection of rows on this story from a CSV::Row instance
+            # Each 'Note' field in the CSV will usually be in the following format:
+            #
+            #   "This is the note body text (Note Author - Dec 25, 2011)"
+            #
+            # This method will attempt to set the user and created_at timestamps
+            # according to the values in the parens.  If the parens are missing, or
+            # their contents cannot be matched or parsed, user and created_at will
+            # not be set.
+            def from_csv_row(row)
+              # Ensure no email notifications get sent during CSV import
+              project = proxy_association.owner.project
+              project.suppress_notifications
+
+              # Each row can have muliple Note headers.  Extract any of them from
+              # this row.
+              notes = []
+              row.each do |header, value|
+                if %w{Note Comment}.include?(header) && value
+                  next if value.blank? || value =~ /^Commit by/
+                  value.gsub!("\n", "")
+                  next unless matches = /(.*)\((.*) - (.*)\)$/.match(value)
+                  next if matches[1].strip.blank?
+                  note = build(note: matches[1].strip,
+                    user: project.users.find_by_username(matches[2]),
+                    user_name: matches[2],
+                    created_at: matches[3])
+                  notes << note
+                end
+              end
+              notes
+            end
+          end
+        end
+
+        def to_csv
+          [
+            id,                       # Id
+            title,                    # Story
+            labels,                   # Labels
+            nil,                      # Iteration
+            nil,                      # Iteration Start
+            nil,                      # Iteration End
+            story_type,               # Story Type
+            estimate,                 # Estimate
+            state,                    # Current State
+            started_at,               # Started at
+            created_at,               # Created at
+            accepted_at,              # Accepted at
+            nil,                      # Deadline
+            requested_by_name,        # Requested By
+            owned_by_name,            # Owned By
+            description,              # Description
+            nil                       # URL
+          ].concat(notes.map(&:to_s))
+        end
+      end
+    end
+  end
+end

data/lib/central/support/concerns/story_concern/scopes.rb

@@ -0,0 +1,16 @@
+module Central
+  module Support
+    module StoryConcern
+      module Scopes
+        extend ActiveSupport::Concern
+
+        included do
+          scope :done,        -> { where(state: :accepted) }
+          scope :in_progress, -> { where(state: [:started, :finished, :delivered]) }
+          scope :backlog,     -> { where(state: :unstarted) }
+          scope :chilly_bin,  -> { where(state: :unscheduled) }
+        end
+      end
+    end
+  end
+end

data/lib/central/support/concerns/story_concern/transitions.rb

@@ -0,0 +1,71 @@
+module Central
+  module Support
+    module StoryConcern
+      module Transitions
+        extend ActiveSupport::Concern
+        include ActiveRecord::Transitions
+
+        included do
+          state_machine do
+            state :unscheduled
+            state :unstarted
+            state :started
+            state :finished
+            state :delivered
+            state :accepted
+            state :rejected
+
+            event :start do
+              transitions to: :started, from: [:unstarted, :unscheduled]
+            end
+
+            event :finish do
+              transitions to: :finished, from: :started
+            end
+
+            event :deliver do
+              transitions to: :delivered, from: :finished
+            end
+
+            event :accept do
+              transitions to: :accepted, from: :delivered
+            end
+
+            event :reject do
+              transitions to: :rejected, from: :delivered
+            end
+
+            event :restart do
+              transitions to: :started, from: :rejected
+            end
+          end
+        end
+
+        # Returns the list of state change events that can operate on this story,
+        # based on its current state
+        def events
+          self.class.state_machine.events_for(current_state)
+        end
+
+        # Returns the CSS id of the column this story belongs in
+        def column
+          case state
+          when 'unscheduled'
+            '#chilly_bin'
+          when 'unstarted'
+            '#backlog'
+          when 'accepted'
+            if iteration_service
+              if iteration_service.current_iteration_number == iteration_service.iteration_number_for_date(accepted_at)
+                return '#in_progress'
+              end
+            end
+            '#done'
+          else
+            '#in_progress'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/central/support/concerns/story_concern/validations.rb

@@ -0,0 +1,45 @@
+module Central
+  module Support
+    module StoryConcern
+      module Validations
+        extend ActiveSupport::Concern
+
+        included do
+          validates :project, presence: true
+          validates :title, presence: true
+
+          validates :requested_by_id, belongs_to_project: true
+          validates :owned_by_id, belongs_to_project: true
+
+          ESTIMABLE_TYPES = %w[feature release]
+          STORY_TYPES = %i[feature chore bug release].freeze
+
+          extend Enumerize
+          enumerize :story_type, in: STORY_TYPES, predicates: true, scope: true
+          validates :story_type, presence: true
+          validates :estimate, estimate: true, allow_nil: true
+
+          validate :bug_chore_estimation
+        end
+
+        # Returns true or false based on whether the story has been estimated.
+        def estimated?
+          !estimate.nil?
+        end
+        alias :estimated :estimated?
+
+        # Returns true if this story can have an estimate made against it
+        def estimable?
+          feature? && !estimated?
+        end
+        alias :estimable :estimable?
+
+        def bug_chore_estimation
+          if !ESTIMABLE_TYPES.include?(story_type) && estimated?
+            errors.add(:estimate, :cant_estimate)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/central/support/concerns/team_concern.rb

@@ -0,0 +1,4 @@
+require 'central/support/concerns/team_concern/associations'
+require 'central/support/concerns/team_concern/validations'
+require 'central/support/concerns/team_concern/scopes'
+require 'central/support/concerns/team_concern/domain_validator'

data/lib/central/support/concerns/team_concern/associations.rb

@@ -0,0 +1,29 @@
+module Central
+  module Support
+    module TeamConcern
+      module Associations
+        extend ActiveSupport::Concern
+
+        included do
+          has_many :enrollments
+          has_many :users, through: :enrollments
+
+          has_many :ownerships
+          has_many :projects, through: :ownerships do
+            def not_archived
+              where(archived_at: nil)
+            end
+          end
+        end
+
+        def is_admin?(user)
+          enrollments.find_by_user_id(user.id)&.is_admin?
+        end
+
+        def owns?(project)
+          ownerships.find_by_project_id(project.id)&.is_owner
+        end
+      end
+    end
+  end
+end

data/lib/central/support/concerns/team_concern/domain_validator.rb

@@ -0,0 +1,19 @@
+module Central
+  module Support
+    module TeamConcern
+      module DomainValidator
+        DOMAIN_SEPARATORS_REGEX = /[,;\|\n]/
+
+        def allowed_domain?(email)
+          whitelist = ( registration_domain_whitelist || "" ).split(DOMAIN_SEPARATORS_REGEX).map(&:strip)
+          blacklist = ( registration_domain_blacklist || "" ).split(DOMAIN_SEPARATORS_REGEX).map(&:strip)
+          has_whitelist = true
+          has_whitelist = whitelist.any? { |domain| email.include?(domain) } unless whitelist.empty?
+          has_blacklist = false
+          has_blacklist = blacklist.any? { |domain| email.include?(domain) } unless blacklist.empty?
+          has_whitelist && !has_blacklist
+        end
+      end
+    end
+  end
+end