est 0.1

data/lib/est/estimates.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+#
+# Copyright (c) 2014 TechnoPark Corp.
+# Copyright (c) 2014 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require 'est/estimate'
+require 'nokogiri'
+require 'logger'
+require 'time'
+
+# Est main module.
+# Author:: Yegor Bugayenko (yegor@teamed.io)
+# Copyright:: Copyright (c) 2014 Yegor Bugayenko
+# License:: MIT
+module Est
+  # Estimates.
+  class Estimates
+    # Ctor.
+    # +dir+:: Directory with estimates
+    def initialize(dir)
+      @dir = dir
+    end
+
+    # Get total estimate.
+    def total
+      estimates = iterate
+      fail 'not enough estimates' if estimates.empty?
+      estimates.reduce(0) { |a, e| a + e.total } / estimates.size
+    end
+
+    # Iterate them all
+    def iterate
+      Dir.entries(@dir)
+        .reject { |f| f.index('.') == 0 }
+        .select { |f| f =~ /^.*\.est$/ }
+        .map { |f| Estimate.new(File.join(@dir, f)) }
+    end
+  end
+end

data/lib/est/methods/champions.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+#
+# Copyright (c) 2014 TechnoPark Corp.
+# Copyright (c) 2014 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require 'est/version'
+require 'logger'
+require 'yaml'
+
+# Single estimate.
+# Author:: Yegor Bugayenko (yegor@teamed.io)
+# Copyright:: Copyright (c) 2014 Yegor Bugayenko
+# License:: MIT
+module Est
+  # Scope Champions.
+  class Champions
+    # Ctor.
+    # +yaml+:: YAML config
+    def initialize(yaml)
+      @yaml = yaml
+    end
+
+    # Get total estimate.
+    def total
+      reqs = @yaml['scope']
+      champs = @yaml['champions']
+      (champs.map do |_, e|
+        (e['best-case'].to_i + e['worst'].to_i + e['most-likely'].to_i * 4) / 6
+      end.reduce(&:+) * 0.54 * (reqs.size / champs.size)).to_i
+    end
+  end
+end

data/lib/est/version.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+#
+# Copyright (c) 2014 TechnoPark Corp.
+# Copyright (c) 2014 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+# Est main module.
+# Author:: Yegor Bugayenko (yegor@teamed.io)
+# Copyright:: Copyright (c) 2014 Yegor Bugayenko
+# License:: MIT
+module Est
+  VERSION = '0.1'
+end

data/test/test__helper.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+#
+# Copyright (c) 2014 TechnoPark Corp.
+# Copyright (c) 2014 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require 'simplecov'
+require 'est'
+require 'minitest/autorun'

data/test/test_champions.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+#
+# Copyright (c) 2014 TechnoPark Corp.
+# Copyright (c) 2014 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require 'minitest/autorun'
+require 'est/methods/champions'
+require 'yaml'
+
+# Est main module test.
+# Author:: Yegor Bugayenko (yegor@teamed.io)
+# Copyright:: Copyright (c) 2014 Yegor Bugayenko
+# License:: MIT
+class TestChampions < Minitest::Test
+  def test_basic_calculation
+    method = Est::Champions.new(
+      YAML.load(
+        '''
+        scope:
+          1: basic Sinatra scaffolding
+          2: front-end HAML files
+          3: SASS stylesheet
+          4: five model classes with unit tests
+          5: PostgreSQL migrations
+          6: Cucumber tests for PostgreSQL
+          7: Capybara tests for HTML front
+          8: CasperJS tests
+          9: achieve 80% test coverage
+        champions:
+          7:
+            worst-case: 40
+            best-case: 10
+            most-likely: 18
+          4:
+            worst-case: 30
+            best-case: 8
+            most-likely: 16
+      '''
+      )
+    )
+    assert_equal 54, method.total
+  end
+end

data/test/test_est.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+#
+# Copyright (c) 2014 TechnoPark Corp.
+# Copyright (c) 2014 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require 'minitest/autorun'
+require 'nokogiri'
+require 'est'
+require 'tmpdir'
+require 'slop'
+
+# Est main module test.
+# Author:: Yegor Bugayenko (yegor@teamed.io)
+# Copyright:: Copyright (c) 2014 Yegor Bugayenko
+# License:: MIT
+class TestEst < Minitest::Test
+  def test_basic
+    Dir.mktmpdir 'test' do |dir|
+      opts = opts(['-v', '-d', dir])
+      File.write(
+        File.join(dir, 'sample.est'),
+        '''
+        id: 5
+        date: 12-07-2014
+        author: Yegor Bugayenko
+        method: champions.pert
+        scope:
+          1: basic Sinatra scaffolding
+          2: front-end HAML files
+          3: SASS stylesheet
+          4: five model classes with unit tests
+          5: PostgreSQL migrations
+          6: Cucumber tests for PostgreSQL
+          7: Capybara tests for HTML front
+          8: CasperJS tests
+          9: achieve 80% test coverage
+        champions:
+          7:
+            worst-case: 40
+            best-case: 10
+            most-likely: 18
+          4:
+            worst-case: 30
+            best-case: 8
+            most-likely: 16
+        '''
+      )
+      matches(
+        Nokogiri::XML(Est::Base.new(opts).xml),
+        [
+          '/processing-instruction("xml-stylesheet")[contains(.,".xsl")]',
+          '/estimate/@version',
+          '/estimate/@date',
+          '/estimate[total="54"]',
+          '/estimate/ests[count(est)=1]',
+          '/estimate/ests/est[@id="5"]'
+        ]
+      )
+    end
+  end
+
+  def opts(args)
+    Slop.parse args do
+      on 'v', 'verbose'
+      on 'd', 'dir', argument: :required
+    end
+  end
+
+  def matches(xml, xpaths)
+    xpaths.each do |xpath|
+      fail "doesn't match '#{xpath}': #{xml}" unless xml.xpath(xpath).size == 1
+    end
+  end
+end

data/test/test_estimate.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+#
+# Copyright (c) 2014 TechnoPark Corp.
+# Copyright (c) 2014 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require 'minitest/autorun'
+require 'nokogiri'
+require 'est/estimates'
+require 'tmpdir'
+require 'slop'
+
+# Est main module test.
+# Author:: Yegor Bugayenko (yegor@teamed.io)
+# Copyright:: Copyright (c) 2014 Yegor Bugayenko
+# License:: MIT
+class TestEstimate < Minitest::Test
+  def test_basic_calculation
+    Dir.mktmpdir 'test' do |dir|
+      file = File.join(dir, 'first.est')
+      File.write(
+        file,
+        '''
+        date: 18-12-2014
+        author: Jeff Lebowski
+        method: champions.pert
+        scope:
+          1: basic Sinatra scaffolding
+          2: front-end HAML files
+          3: SASS stylesheet
+          4: five model classes with unit tests
+          5: PostgreSQL migrations
+          6: Cucumber tests for PostgreSQL
+          7: Capybara tests for HTML front
+          8: CasperJS tests
+          9: achieve 80% test coverage
+        champions:
+          7:
+            worst-case: 40
+            best-case: 10
+            most-likely: 18
+          4:
+            worst-case: 30
+            best-case: 8
+            most-likely: 16
+        '''
+      )
+      estimate = Est::Estimate.new(file)
+      assert_equal Date.parse('18-12-2014'), estimate.date
+      assert_equal 'Jeff Lebowski', estimate.author
+      assert_equal 54, estimate.total
+    end
+  end
+end

data/test/test_estimates.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+#
+# Copyright (c) 2014 TechnoPark Corp.
+# Copyright (c) 2014 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require 'minitest/autorun'
+require 'nokogiri'
+require 'est/estimates'
+require 'tmpdir'
+require 'slop'
+
+# Est main module test.
+# Author:: Yegor Bugayenko (yegor@teamed.io)
+# Copyright:: Copyright (c) 2014 Yegor Bugayenko
+# License:: MIT
+class TestEstimates < Minitest::Test
+  def test_basic_calculation
+    Dir.mktmpdir 'test' do |dir|
+      File.write(
+        File.join(dir, 'first.est'),
+        '''
+        date: 12-08-2014
+        author: Yegor Bugayenko
+        method: champions.pert
+        scope:
+          1: basic Sinatra scaffolding
+          2: front-end HAML files
+          3: SASS stylesheet
+          4: five model classes with unit tests
+          5: PostgreSQL migrations
+          6: Cucumber tests for PostgreSQL
+          7: Capybara tests for HTML front
+          8: CasperJS tests
+          9: achieve 80% test coverage
+        champions:
+          7:
+            worst-case: 40
+            best-case: 10
+            most-likely: 18
+          4:
+            worst-case: 30
+            best-case: 8
+            most-likely: 16
+        '''
+      )
+      estimates = Est::Estimates.new(dir)
+      assert_equal 54, estimates.total
+    end
+  end
+end