techcor 0.0.1

data/lib/commands/describe_project.rb

@@ -0,0 +1,26 @@
+class DescribeProject < Struct.new :project_name, :date_format
+  def call formatter = formatter, records = records
+    formatter.present records
+  end
+
+  def project project_name = project_name
+    Project.find_by name: project_name
+  end
+
+  def records project = project
+    project.metrics
+  end
+
+  def formatter format = format
+    ConsoleFormatter.new format
+  end
+
+  def format date_format = date_format
+    {
+        'Metric' => 'name',
+        'Value' => 'value',
+        'Changed at' => "last_updated_at.strftime('#{date_format}')",
+        'Changed by' => "last_updated_by"
+    }
+  end
+end

data/lib/commands/edit_property.rb

@@ -0,0 +1,9 @@
+class EditProperty < Struct.new :project_name, :metric_name, :value, :author
+  def call project = project, metric_name = metric_name, value = value, author = author
+    project.edit_property(metric_name, value, author)
+  end
+
+  def project project_name = project_name
+    Project.find_by(name: project_name)
+  end
+end

data/lib/commands/gli/add.rb

@@ -0,0 +1,12 @@
+class TcCli
+  desc "Adds new project"
+  long_desc "Allows to create new project"
+  arg_name '{project_name}'
+  command :add do |command|
+    command.action do |global, options, args|
+      name = args.first
+      puts "Project #{name} was successfully added." if AddProject.new(name).call
+    end
+  end
+
+end

data/lib/commands/gli/add_metric.rb

@@ -0,0 +1,23 @@
+class TcCli
+  desc "Adds new metric to the project"
+  long_desc "Allows to add new metric to the project"
+  arg_name '{metric_name}'
+  command :add_metric do |command|
+    command.arg_name 'project name'
+    command.desc 'name of the project, to which you want to add metric'
+    command.flag :pn, :project_name
+
+    command.arg_name 'metric type'
+    command.desc 'type of the metric you want to add (string, number, boolean)'
+    command.default_value "string"
+    command.flag :mt, :metric_type
+
+    command.action do |global, options, args|
+      project_name = options[:project_name]
+      metric_type = options[:metric_type]
+      metric_name = args.first
+      puts "Metric #{metric_name} with type #{metric_type} was successfully added to project #{project_name}." if AddMetric.new(project_name, metric_type, metric_name).call
+    end
+  end
+
+end

data/lib/commands/gli/describe.rb

@@ -0,0 +1,16 @@
+class TcCli
+  desc "Describes current state of the project"
+  long_desc "Displays current metrics of the project, date and author of last modification"
+  arg_name '{project_name}'
+  command :describe do |command|
+    command.arg_name 'date format'
+    command.desc 'ruby date format to display time of change'
+    command.default_value "%d-%m-%Y"
+    command.flag :df, :date_format
+
+    command.action do |global, options, args|
+      puts DescribeProject.new(args.first, options[:date_format]).call
+    end
+  end
+
+end

data/lib/commands/gli/edit_property.rb

@@ -0,0 +1,22 @@
+class TcCli
+  desc "Edits one metric of the project"
+  long_desc "Allows to edit one of the project's metrics"
+  arg_name '{value}'
+  command :edit_property do |command|
+    command.arg_name 'project name'
+    command.desc 'name of the project, property of which you want to edit'
+    command.flag :pn, :project_name
+
+    command.arg_name 'metric name'
+    command.desc 'name of the metric, which you want to edit'
+    command.flag :mn, :metric_name
+
+    command.action do |global, options, args|
+      project_name = options[:project_name]
+      metric_name = options[:metric_name]
+      value = args.first
+      puts "Metric #{metric_name} in project #{project_name} now has value #{value}." if EditProperty.new(project_name, metric_name, value, `whoami`).call
+    end
+  end
+
+end

data/lib/commands/gli/history.rb

@@ -0,0 +1,19 @@
+class TcCli
+  desc "Displays property history"
+  long_desc "Displays one or more properties history (list of values over time)"
+  arg_name '[{property}],[{another_property}],[...]'
+  command :history do |command|
+    command.arg_name 'project name'
+    command.desc 'name of the project, property of which you want to edit'
+    command.flag :pn, :project_name
+
+    command.arg_name 'date format'
+    command.desc 'ruby date format to display time of change'
+    command.default_value "%d-%m-%Y"
+    command.flag :df, :date_format
+
+    command.action do |global, options, args|
+      puts ViewHistory.new(options[:project_name], options[:date_format], args.first.try(:split, ',')).call
+    end
+  end
+end

data/lib/commands/gli/hooks.rb

@@ -0,0 +1,8 @@
+class TcCli
+  pre do
+    ENV['RACK_ENV'] ||= 'production'
+    require 'hirb'
+    require 'tc'
+    true
+  end
+end

data/lib/commands/gli/list.rb

@@ -0,0 +1,14 @@
+class TcCli
+  desc "List projects from catalog"
+  long_desc "Lists projects from catalog matching specified criteria"
+  arg_name '{criteria}'
+  command :list do |command|
+    command.arg_name 'table format'
+    command.desc 'ruby code for table format'
+    command.flag :fm, :format
+
+    command.action do |global, options, args|
+      puts ListProjects.new(options[:format], args.first).call
+    end
+  end
+end

data/lib/commands/gli/program.rb

@@ -0,0 +1,5 @@
+class TcCli
+  program_desc 'Command Line Interface for Technical Coordination'
+  version '0.0.1'
+
+end

data/lib/commands/list_projects.rb

@@ -0,0 +1,32 @@
+class ListProjects < Struct.new :format, :criteria
+  def call formatter = formatter, projects = projects
+    formatter.present projects
+  end
+
+  def projects catalog = ProjectCatalog.load, criteria = criteria
+    catalog.projects criteria
+  end
+
+  def formatter(format = format.present? ? eval(format) : default_format)
+    ConsoleFormatter.new format
+  end
+
+  def default_format projects = projects
+    {'Name' => 'name'}.merge list_properties_format properties
+  end
+
+  private
+
+  def list_properties_format properties
+    Hash[properties.map { |p| [p, "property('#{p}').try(:value)"] }]
+  end
+
+  def properties
+    metrics.collect(&:name).flatten
+  end
+
+  def metrics
+    projects.collect(&:metrics).flatten
+  end
+
+end

data/lib/commands/view_history.rb

@@ -0,0 +1,37 @@
+class ViewHistory < Struct.new :project_name, :date_format, :properties
+  def call formatter = formatter, records = records
+    formatter.present records
+  end
+
+  def project project_name = project_name
+    Project.find_by name: project_name
+  end
+
+  def records metrics = metrics
+    metrics.collect(&:values).flatten
+  end
+
+  def formatter format = format
+    ConsoleFormatter.new format
+  end
+
+  def properties project = project
+    self[:properties].present? ? self[:properties] : project.metrics.collect(&:name)
+  end
+
+  def metrics project = project, properties = properties
+    properties.map do |property|
+      project.property property
+    end.compact
+  end
+
+  def format date_format = date_format, metrics = metrics
+    {'Date' => "created_at.strftime('#{date_format}')"}.merge list_metrics_format(metrics)
+  end
+
+  private
+
+  def list_metrics_format metrics
+    Hash[metrics.map { |m| [m.name, "metric.name == '#{m.name}' ? value : ''"] }]
+  end
+end

data/lib/console_formatter.rb

@@ -0,0 +1,18 @@
+class ConsoleFormatter < Struct.new :format
+
+  def present records, format = format
+    Hirb::Helpers::AutoTable.render(render_each(records), fields: format.keys, resize: false)
+  end
+
+  def render_each records
+    records.map { |record|
+      render_record record
+    }
+  end
+
+  def render_record record, format = format
+    format.merge(format) do |_, expression|
+      record.instance_eval expression
+    end
+  end
+end

data/lib/gli_interface.rb

@@ -0,0 +1,15 @@
+require 'gli'
+ENV["COLUMNS"] = "1000"
+ENV["LINES"] = "1000"
+
+$:.unshift File.expand_path(File.dirname(File.realpath(__FILE__)))
+
+class TcCli
+  extend GLI::App
+  commands_from 'commands/gli'
+
+  def self.exec argv
+    commands[:help] = GLI::Commands::Help.new(self)
+    run(argv)
+  end
+end

data/lib/metrics/boolean_metric.rb

@@ -0,0 +1,7 @@
+class BooleanMetric < Metric
+
+  def convert value
+    !!value
+  end
+
+end

data/lib/metrics/metric.rb

@@ -0,0 +1,24 @@
+class Metric
+
+  def edit value, user
+    values << PropertyValue.new(value: convert(value), created_by: user)
+    self
+  end
+
+  def value
+    values.last.try :value
+  end
+
+  def last_updated_by
+    values.last.try :created_by
+  end
+
+  def last_updated_at
+    values.last.try :created_at
+  end
+
+  def convert value
+    value
+  end
+
+end

data/lib/metrics/number_metric.rb

@@ -0,0 +1,7 @@
+class NumberMetric < Metric
+
+  def convert value
+    value.to_f
+  end
+
+end

data/lib/metrics/string_metric.rb

@@ -0,0 +1,7 @@
+class StringMetric < Metric
+
+  def convert value
+    value.to_s
+  end
+
+end

data/lib/project.rb

@@ -0,0 +1,15 @@
+class Project
+  def add_metric metric
+    metrics << metric
+    self
+  end
+
+  def edit_property name, value, user
+    property(name).edit value, user
+    self
+  end
+
+  def property name
+    metrics.find_by(name: name)
+  end
+end

data/lib/project_catalog.rb

@@ -0,0 +1,34 @@
+class ProjectCatalog
+
+  def initialize
+    @projects = []
+  end
+
+  def projects criteria = nil
+    result = @projects.sort_by(&:name)
+
+    return result if criteria.blank?
+    result.find_all { |project|
+      project.instance_eval criteria
+    }
+  end
+
+  def add_project project
+    @projects << project
+    self
+  end
+
+  def save
+    @projects.all? &:save
+    self
+  end
+
+  def load
+    @projects = Project.all
+    self
+  end
+
+  def self.load
+    self.new.load
+  end
+end

data/lib/property_value.rb

@@ -0,0 +1,3 @@
+class PropertyValue
+
+end

data/lib/storage/metric_mongo.rb

@@ -0,0 +1,11 @@
+class Metric
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :name
+  validates :name, uniqueness: true
+
+  embedded_in :project
+
+  embeds_many :values, class_name: 'PropertyValue', cascade_callbacks: true
+end

data/lib/storage/project_mongo.rb

@@ -0,0 +1,9 @@
+class Project
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :name
+  validates :name, uniqueness: true
+
+  embeds_many :metrics, cascade_callbacks: true
+end

data/lib/storage/property_value_mongo.rb

@@ -0,0 +1,10 @@
+class PropertyValue
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :value
+  field :created_by
+  validates :created_by, presence: true
+
+  embedded_in :metric
+end

data/lib/tc/version.rb

@@ -0,0 +1,9 @@
+class TC
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

data/lib/tc.rb

@@ -0,0 +1,27 @@
+require 'hirb'
+require 'mongoid'
+
+config_folder = File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../config')
+`cp #{config_folder}/mongoid.yml.sample #{config_folder}/mongoid.yml` unless File.exists? "#{config_folder}/mongoid.yml"
+
+Mongoid.load!("#{config_folder}/mongoid.yml")
+
+$: << File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+require 'project'
+require 'property_value'
+require 'project_catalog'
+require 'console_formatter'
+require 'metrics/metric'
+require 'metrics/number_metric'
+require 'metrics/string_metric'
+require 'metrics/boolean_metric'
+require 'commands/list_projects'
+require 'commands/add_project'
+require 'commands/add_metric'
+require 'commands/edit_property'
+require 'commands/view_history'
+require 'commands/describe_project'
+require 'storage/metric_mongo'
+require 'storage/project_mongo'
+require 'storage/property_value_mongo'

data/spec/integration/mongo_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe ProjectCatalog do
+
+  before { Project.delete_all }
+
+  subject {
+    ProjectCatalog.new.
+        add_project(Project.new(name: '1').add_metric(NumberMetric.new(name: 'length')).edit_property('length', 3, 'user')).
+        add_project(Project.new(name: '2').add_metric(NumberMetric.new(name: 'length')).edit_property('length', 2, 'user')).
+        add_project(Project.new(name: '3').add_metric(NumberMetric.new(name: 'length')).edit_property('length', 1, 'user'))
+  }
+
+  it 'loads list of saved projects' do
+    subject.save
+
+    ProjectCatalog.load.projects.should have_exactly(3).items
+  end
+end

data/spec/lib/commands/add_metric_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe AddMetric do
+  it 'adds metric to the project' do
+    result = stub(:result)
+    metric = stub(:metric)
+    project = stub(:project).tap { |p| p.should_receive(:add_metric).with(metric) { result } }
+    subject.call(project, metric)
+  end
+
+  it 'find project' do
+    result = stub(:result)
+    project_name = stub(:project_name)
+    Project.should_receive(:find_by).with(name: project_name) { result }
+    subject.project(project_name).should == result
+  end
+
+  it 'creates appropriate metric class' do
+    subject.metric_class(:string).should == StringMetric
+    subject.metric_class(:number).should == NumberMetric
+    subject.metric_class(nil).should == Metric
+  end
+
+  it 'creates metric' do
+    result = stub(:result)
+    name = stub(:name)
+    metric_class = stub(:metric_class).tap { |mc| mc.should_receive(:new).with(name: name) { result } }
+
+    subject.metric(metric_class, name).should == result
+  end
+end

data/spec/lib/commands/add_project_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe AddProject do
+  it 'adds new project to the database' do
+    name = stub(:name)
+    project = stub(:project)
+    Project.should_receive(:create).with(name: name) { project }
+    subject.call(name).should == project
+  end
+end

data/spec/lib/commands/describe_project_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe DescribeProject do
+  it 'presents properties to table view' do
+    result = stub(:result)
+
+    records = stub(:records)
+    formatter = stub(:formatter).tap { |f| f.should_receive(:present).with(records) { result } }
+
+    subject.call(formatter, records).should == result
+  end
+
+  it 'passes format to console formatter' do
+    format = stub(:format)
+    ConsoleFormatter.should_receive(:new).with(format)
+
+    subject.formatter(format)
+  end
+
+  it 'collects metrics from project' do
+    metrics = stub(:metrics)
+    project = stub(:project, :metrics => metrics)
+    subject.records(project).should == metrics
+  end
+
+  it 'constructs format for console formatter' do
+    subject.format("DATE_FORMAT").should == {
+        'Metric' => 'name',
+        'Value' => 'value',
+        'Changed at' => "last_updated_at.strftime('DATE_FORMAT')",
+        'Changed by' => "last_updated_by"
+    }
+  end
+
+  it 'finds project by its name' do
+    name, result = stub(:name), stub(:result)
+    Project.should_receive(:find_by).with(name: name) { result }
+
+    subject.project(name).should == result
+  end
+
+end

data/spec/lib/commands/edit_property_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe EditProperty do
+  it 'edits property of the project' do
+    result = stub(:result)
+    metric_name = stub(:metric_name)
+    value = stub(:value)
+    author = stub(:author)
+    project = stub(:project).tap { |p| p.should_receive(:edit_property).with(metric_name, value, author) { result } }
+    subject.call(project, metric_name, value, author).should == result
+  end
+
+  it 'find project' do
+    result = stub(:result)
+    project_name = stub(:project_name)
+    Project.should_receive(:find_by).with(name: project_name) { result }
+    subject.project(project_name).should == result
+  end
+end

data/spec/lib/commands/list_projects_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe ListProjects do
+  it 'passes format to console formatter' do
+    format = '42'
+    ConsoleFormatter.should_receive(:new).with(eval(format))
+
+    ListProjects.new(format).formatter
+  end
+
+  it 'gets list of projects from catalog according to criteria' do
+    result = stub(:result)
+
+    criteria = stub(:criteria)
+    catalog = stub(:catalog).tap { |c| c.should_receive(:projects).with(criteria) { result } }
+
+    subject.projects(catalog, criteria).should == result
+  end
+
+  it 'presents projects to table view' do
+    result = stub(:result)
+
+    projects = stub(:projects)
+    formatter = stub(:formatter).tap { |f| f.should_receive(:present).with(projects) { result } }
+
+    subject.call(formatter, projects).should == result
+  end
+
+  it 'uses default format if no format string was specified' do
+    result = stub(:result)
+
+    command = ListProjects.new(nil)
+    command.should_receive(:default_format) { result }
+
+    command.formatter
+  end
+
+  it 'builds default format as list of all metrics for all projects' do
+    subject.stub(:projects => [
+        stub(:metrics => [stub(:name => 'metric1'), stub(:name => 'metric2')]),
+        stub(:metrics => [stub(:name => 'metric3')])])
+    subject.default_format.should == {'Name' => 'name',
+                                      'metric1' => "property('metric1').try(:value)",
+                                      'metric2' => "property('metric2').try(:value)",
+                                      'metric3' => "property('metric3').try(:value)"}
+  end
+end