central-support 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 451d424f9bc9a13d968d8eade8c6a63552cb6bed
+  data.tar.gz: 5302040325454b5352264f0a1391612c8c205f87
+SHA512:
+  metadata.gz: 662a9c310d13e5774305c3f1f0b5e1b316c769c0e0fc867e8e2d9431de11025f174b558a901c77e1842d1b59759b9f8ee79d9c92d47a355f6eb6fa4e64b72a35
+  data.tar.gz: 03d2b03f614ea4b32d5ac53a48e2c0802abdadd177f607bb7b0b53b79a8f61385e79953605caf1961a318a84343a9add473b2c4fb196275953af49017ef9114f

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.log
+*.sqlite3
+*.gem
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5
+
+before_script:
+  - "cd spec/support/rails_app"
+  - "bundle install"
+  - "cd ../../.."
+
+script:
+  - "bundle exec rake spec"

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+eval_gemfile File.join(File.dirname(__FILE__), "spec/support/rails_app/Gemfile")

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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.

data/README.md

@@ -0,0 +1,49 @@
+# Central::Support
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/central/support`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+This is a library that moves away some of the logic from [Central](https://github.com/Codeminer42/cm42-central) so we can reuse in other projects. Particularly the Iteration calculation.
+
+[![Code Climate](https://codeclimate.com/repos/57e072af8a0f4603260024d5/badges/3ed30d50ad1a44162204/gpa.svg)](https://codeclimate.com/repos/57e072af8a0f4603260024d5/feed)
+[![Test Coverage](https://codeclimate.com/repos/57e072af8a0f4603260024d5/badges/3ed30d50ad1a44162204/coverage.svg)](https://codeclimate.com/repos/57e072af8a0f4603260024d5/coverage)
+[![Build Status](https://travis-ci.org/Codeminer42/cm42-central-support.svg?branch=master)](https://travis-ci.org/Codeminer42/cm42-central-support0)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'central-support'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install central-support
+
+## Usage
+
+This library expects a very specific set of pre-existing models (Team, Project, Story, User, Activity, Enrollment, Membership, and Ownership).
+
+They are all models that exist in Central and they must also follow a specific database schema.
+
+If you want to use this library in another application, refer to the `spec/support/rails_app/` so you know exactly how your new app should look like.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Codeminer-42/central-support.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "central/support"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/central-support.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'central/support/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "central-support"
+  spec.version       = Central::Support::VERSION
+  spec.authors       = ["Fabio Akita"]
+  spec.email         = ["boss@akitaonrails.com"]
+
+  spec.summary       = %q{Support library for the Central project}
+  spec.description   = %q{Extraction of part of the intelligence behind Central}
+  spec.homepage      = "https://github.com/Codeminer-42/central-support"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", "~> 3.2"
+  spec.add_runtime_dependency "activerecord", "~> 3.2"
+  spec.add_runtime_dependency 'enumerize', "~> 2.0"
+  spec.add_runtime_dependency 'transitions', "~> 0.1.9"
+end

data/lib/central/support.rb

@@ -0,0 +1,27 @@
+require 'csv'
+
+require "central/support/version"
+require "central/support/iteration_service"
+require "central/support/iteration"
+require "central/support/mattermost"
+
+require 'enumerize'
+require 'transitions'
+require 'active_record/transitions'
+require 'active_support/concern'
+
+require 'central/support/validators/belongs_to_project_validator'
+require 'central/support/validators/estimate_validator'
+require 'central/support/validators/changed_validator'
+
+require 'central/support/concerns/story_concern'
+require 'central/support/concerns/project_concern'
+require 'central/support/concerns/user_concern'
+require 'central/support/concerns/team_concern'
+require 'central/support/concerns/activity_concern'
+
+# Ccompatibility mode for drop-in replacement into Central
+# TODO: must remove this after the migration from Central is complete
+IterationService = Central::Support::IterationService
+Iteration        = Central::Support::Iteration
+Mattermost       = Central::Support::Mattermost

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

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

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

@@ -0,0 +1,15 @@
+module Central
+  module Support
+    module ActivityConcern
+      module Associations
+        extend ActiveSupport::Concern
+
+        included do
+          belongs_to :project
+          belongs_to :user
+          belongs_to :subject, polymorphic: true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Central
+  module Support
+    module ActivityConcern
+      module Callbacks
+        extend ActiveSupport::Concern
+
+        included do
+          serialize :subject_changes, Hash
+
+          before_save :parse_changes
+        end
+
+        def parse_changes
+          if action == 'update'
+            self.subject_changes = subject.changes
+          elsif action == 'destroy'
+            self.subject_changes = subject.attributes
+            self.subject_destroyed_type = subject.class.name
+            self.subject = nil
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module Central
+  module Support
+    module ActivityConcern
+      module Scopes
+        extend ActiveSupport::Concern
+
+        included do
+          scope :projects, ->(ids) {
+            where(project_id: ids) if ids
+          }
+
+          scope :since, ->(date) {
+            where("created_at > ?", date.beginning_of_day) if date
+          }
+        end
+
+        module ClassMethods
+          def fetch_polymorphic(ids, since)
+            stories = where("subject_type in ('Project', 'Story')").includes(:user, :subject).projects(ids).since(since).to_a
+            stories + where("subject_type in ('Note', 'Task')").includes(:user, subject: [:story]).projects(ids).since(since).to_a
+          end
+
+          def grouped_activities(allowed_projects, since)
+            fetch_polymorphic(allowed_projects.pluck(:id), since).group_by { |activity|
+              activity.created_at.beginning_of_day
+            }.
+            map { |date, activities|
+              [
+                date,
+                activities.group_by { |activity|
+                  activity.project_id
+                }.
+                map { |project_id, activities|
+                  [
+                    allowed_projects.find { |p| p.id == project_id },
+                    activities.group_by { |activity|
+                      activity.subject_destroyed_type || activity.subject_type
+                    }.
+                    map { |subject_type, activities|
+                      [
+                        subject_type,
+                        activities.map(&:decorate)
+                      ]
+                    }
+                  ]
+                }
+              ]
+            }
+          end
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,17 @@
+module Central
+  module Support
+    module ActivityConcern
+      module Validations
+        extend ActiveSupport::Concern
+
+        included do
+          validates :action, presence: true, inclusion: { in: %w(create update destroy) }
+          validates :project, presence: true
+          validates :user, presence: true
+          validates :subject, presence: true, changed: true
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,5 @@
+require 'central/support/concerns/project_concern/attributes'
+require 'central/support/concerns/project_concern/associations'
+require 'central/support/concerns/project_concern/validations'
+require 'central/support/concerns/project_concern/scopes'
+require 'central/support/concerns/project_concern/csv'

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

@@ -0,0 +1,27 @@
+module Central
+  module Support
+    module ProjectConcern
+      module Associations
+        extend ActiveSupport::Concern
+
+        included do
+          has_many :ownerships
+          has_many :teams, through: :ownerships
+
+          has_many :memberships, dependent: :destroy
+          has_many :users, -> { distinct }, through: :memberships
+
+          has_many :stories, dependent: :destroy do
+            def with_dependencies
+              includes(:notes, :tasks, :document_files)
+            end
+
+            include Central::Support::ProjectConcern::CSV::Import
+          end
+
+          accepts_nested_attributes_for :users, reject_if: :all_blank
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Central
+  module Support
+    module ProjectConcern
+      module Attributes
+        extend ActiveSupport::Concern
+
+        included do
+          attr_writer :suppress_notifications
+        end
+
+        def suppress_notifications
+          @suppress_notifications || false
+        end
+
+        def to_s
+          name
+        end
+
+        def iteration_service(since = nil)
+          @iteration_service ||= Central::Support::IterationService.new(self, since)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+module Central
+  module Support
+    module ProjectConcern
+      module CSV
+        module InstanceMethods
+          def csv_filename
+            "#{name}-#{Time.now.strftime('%Y%m%d_%I%M')}.csv"
+          end
+        end
+
+        module Import
+          # Populates the stories collection from a CSV string.
+          def from_csv(csv_string)
+
+            # Eager load this so that we don't have to make multiple db calls when
+            # searching for users by full name from the CSV.
+            users = proxy_association.owner.users
+
+            csv = ::CSV.parse(csv_string, headers: true)
+            csv.map do |row|
+              row_attrs = row.to_hash
+              story = build({
+                title:        ( row_attrs["Title"] || row_attrs["Story"] || "").truncate(255, omission: '...'),
+                story_type:   (row_attrs["Type"] || row_attrs["Story Type"]).downcase,
+                requested_by: users.detect {|u| u.name == row["Requested By"]},
+                owned_by:     users.detect {|u| u.name == row["Owned By"]},
+                accepted_at:  row_attrs["Accepted at"],
+                estimate:     row_attrs["Estimate"],
+                labels:       row_attrs["Labels"],
+                description:  row_attrs["Description"]
+              })
+
+              row_state = ( row_attrs["Current State"] || 'unstarted').downcase
+              if Story.available_states.include?(row_state.to_sym)
+                story.state = row_state
+              end
+              story.requested_by_name = ( row["Requested By"] || "").truncate(255)
+              story.owned_by_name = ( row["Owned By"] || "").truncate(255)
+              story.owned_by_initials = ( row["Owned By"] || "" ).split(' ').map { |n| n[0].upcase }.join('')
+
+              tasks = []
+              row.each do |header, value|
+                tasks << "* #{value}" if header == 'Task' && value
+              end
+              story.description = "#{story.description}\n\nTasks:\n\n#{tasks.join("\n")}" unless tasks.empty?
+              story.project.suppress_notifications = true # otherwise the import will generate massive notifications!
+              story.save
+
+              # Generate notes for this story if any are present
+              story.notes.from_csv_row(row)
+
+              story
+            end
+          end
+        end
+      end
+    end
+  end
+end