est 0.1

data/cucumber.yml

@@ -0,0 +1,3 @@
+default: --format pretty
+travis: --format progress
+html_report: --format progress --format html --out=features_report.html

data/est.gemspec

@@ -0,0 +1,59 @@
+# 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 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.
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'est/version'
+
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  if s.respond_to? :required_rubygems_version=
+    s.required_rubygems_version = Gem::Requirement.new('>= 0')
+  end
+  s.rubygems_version = '2.2.2'
+  s.required_ruby_version = '>= 1.9.3'
+  s.name = 'est'
+  s.version = Est::VERSION
+  s.license = 'MIT'
+  s.summary = 'Estimates Automated'
+  s.description = 'Estimate project size'
+  s.authors = ['Yegor Bugayenko']
+  s.email = 'yegor@teamed.io'
+  s.homepage = 'http://github.com/teamed/est'
+  s.files = `git ls-files`.split($RS)
+  s.executables = s.files.grep(/^bin\//) { |f| File.basename(f) }
+  s.test_files = s.files.grep(/^(test|spec|features)\//)
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
+  s.add_runtime_dependency 'nokogiri', '1.6.5'
+  s.add_runtime_dependency 'ruby-filemagic', '0.6.1'
+  s.add_runtime_dependency 'slop', '3.6.0'
+  s.add_runtime_dependency 'rake', '10.4.2'
+  s.add_development_dependency 'coveralls', '0.7.2'
+  s.add_development_dependency 'rdoc', '4.2.0'
+  s.add_development_dependency 'cucumber', '1.3.17'
+  s.add_development_dependency 'minitest', '5.5.0'
+  s.add_development_dependency 'rubocop', '0.24.1'
+  s.add_development_dependency 'rubocop-rspec', '1.2.1'
+  s.add_development_dependency 'rspec-rails', '3.1.0'
+end

data/features/cli.feature

@@ -0,0 +1,51 @@
+Feature: Command Line Processing
+  As an estimator I want to be able to
+  call Est as a command line tool
+
+  Scenario: Help can be printed
+    When I run bin/est with "-h"
+    Then Exit code is zero
+    And Stdout contains "-v, --verbose"
+
+  Scenario: Version can be printed
+    When I run bin/est with "--version"
+    Then Exit code is zero
+
+  Scenario: Simple estimate calculating
+    Given I have a "sample.est" file with content:
+    """
+    id: 789
+    date: 19-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
+    """
+    When I run bin/est with "-v -d . -f out.xml"
+    Then Exit code is zero
+    And Stdout contains "reading ."
+    And XML file "out.xml" matches "/estimate[total='54']"
+
+  Scenario: Rejects unknown options
+    Given I have a "test.est" file with content:
+    """
+    """
+    When I run bin/est with "--some-unknown-option"
+    Then Exit code is not zero

data/features/gem_package.feature

@@ -0,0 +1,22 @@
+Feature: Gem Package
+  As a source code writer I want to be able to
+  package the Gem into .gem file
+
+  Scenario: Gem can be packaged
+    Given I have a "execs.rb" file with content:
+    """
+    #!/usr/bin/env ruby
+    require 'rubygems'
+    spec = Gem::Specification::load('./spec.rb')
+    fail 'no executables' if spec.executables.empty?
+    """
+    When I run bash with
+    """
+    set -e
+    cd est
+    gem build est.gemspec
+    gem specification --ruby est-*.gem > ../spec.rb
+    cd ..
+    ruby execs.rb
+    """
+    Then Exit code is zero

data/features/step_definitions/steps.rb

@@ -0,0 +1,110 @@
+# 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'
+require 'nokogiri'
+require 'tmpdir'
+require 'slop'
+require 'English'
+
+Before do
+  @cwd = Dir.pwd
+  @dir = Dir.mktmpdir('test')
+  FileUtils.mkdir_p(@dir) unless File.exist?(@dir)
+  Dir.chdir(@dir)
+  @opts = Slop.parse ['-v', '-s', @dir] do
+    on 'v', 'verbose'
+    on 's', 'source', argument: :required
+  end
+end
+
+After do
+  Dir.chdir(@cwd)
+  FileUtils.rm_rf(@dir) if File.exist?(@dir)
+end
+
+Given(/^I have a "([^"]*)" file with content:$/) do |file, text|
+  FileUtils.mkdir_p(File.dirname(file)) unless File.exist?(file)
+  File.open(file, 'w') do |f|
+    f.write(text)
+  end
+end
+
+When(/^I run est$/) do
+  @xml = Nokogiri::XML.parse(Est::Base.new(@opts).xml)
+end
+
+Then(/^XML matches "([^"]+)"$/) do |xpath|
+  fail "XML doesn't match \"#{xpath}\":\n#{@xml}" if @xml.xpath(xpath).empty?
+end
+
+When(/^I run est it fails with "([^"]*)"$/) do |txt|
+  begin
+    Est::Base.new(@opts).xml
+    passed = true
+  rescue Est::Error => ex
+    unless ex.message.include?(txt)
+      raise "Est failed but exception doesn't contain \"#{txt}\": #{ex.message}"
+    end
+  end
+  fail "Est didn't fail" if passed
+end
+
+When(/^I run bin\/est with "([^"]*)"$/) do |arg|
+  home = File.join(File.dirname(__FILE__), '../..')
+  @stdout = `ruby -I#{home}/lib #{home}/bin/est #{arg}`
+  @exitstatus = $CHILD_STATUS.exitstatus
+end
+
+Then(/^Stdout contains "([^"]*)"$/) do |txt|
+  unless @stdout.include?(txt)
+    fail "STDOUT doesn't contain '#{txt}':\n#{@stdout}"
+  end
+end
+
+Then(/^Stdout is empty$/) do
+  fail "STDOUT is not empty:\n#{@stdout}" unless @stdout == ''
+end
+
+Then(/^XML file "([^"]+)" matches "([^"]+)"$/) do |file, xpath|
+  fail "File #{file} doesn't exit" unless File.exist?(file)
+  xml = Nokogiri::XML.parse(File.read(file))
+  xml.remove_namespaces!
+  if xml.xpath(xpath).empty?
+    fail "XML file #{file} doesn't match \"#{xpath}\":\n#{xml}"
+  end
+end
+
+Then(/^Exit code is zero$/) do
+  fail "Non-zero exit code #{@exitstatus}" unless @exitstatus == 0
+end
+
+Then(/^Exit code is not zero$/) do
+  fail 'Zero exit code' if @exitstatus == 0
+end
+
+When(/^I run bash with$/) do |text|
+  FileUtils.copy_entry(@cwd, File.join(@dir, 'est'))
+  @stdout = `#{text}`
+  @exitstatus = $CHILD_STATUS.exitstatus
+end

data/features/support/env.rb

@@ -0,0 +1,25 @@
+# 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'

data/lib/est.rb

@@ -0,0 +1,123 @@
+# 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 'est/estimates'
+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
+  # If it breaks.
+  class Error < StandardError
+  end
+
+  # If it violates XSD schema.
+  class SchemaError < Error
+  end
+
+  # Get logger.
+  def self.log
+    unless @logger
+      @logger = Logger.new(STDOUT)
+      @logger.formatter = proc { |severity, _, _, msg|
+        "#{severity}: #{msg.dump}\n"
+      }
+      @logger.level = Logger::ERROR
+    end
+    @logger
+  end
+
+  class << self
+    attr_writer :logger
+  end
+
+  # Code base abstraction
+  class Base
+    # Ctor.
+    # +opts+:: Options
+    def initialize(opts)
+      @opts = opts
+      Est.log.level = Logger::INFO if @opts.verbose?
+      Est.log.info "my version is #{Est::VERSION}"
+    end
+
+    # Generate XML.
+    def xml
+      dir = @opts.dir? ? @opts[:dir] : Dir.pwd
+      Est.log.info "reading #{dir}"
+      estimates = Estimates.new(dir)
+      sanitize(
+        Nokogiri::XML::Builder.new do |xml|
+          xml << "<?xml-stylesheet type='text/xsl' href='#{xsl}'?>"
+          xml.estimate(attrs) do
+            xml.total estimates.total
+            xml.ests do
+              estimates.iterate.each do |est|
+                xml.est('id' => est.id) do
+                  xml.date est.date
+                  xml.total est.total
+                  xml.author est.author
+                end
+              end
+            end
+          end
+        end.to_xml
+      )
+    end
+
+    private
+
+    def attrs
+      {
+        'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+        'xsi:noNamespaceSchemaLocation' => "#{host('xsd')}/#{Est::VERSION}.xsd",
+        'version' => Est::VERSION,
+        'date' => Time.now.utc.iso8601
+      }
+    end
+
+    def host(suffix)
+      "http://est-#{suffix}.teamed.io"
+    end
+
+    def xsl
+      "#{host('xsl')}/#{Est::VERSION}.xsl"
+    end
+
+    def sanitize(xml)
+      xsd = Nokogiri::XML::Schema(
+        File.read(File.join(File.dirname(__FILE__), '../assets/est.xsd'))
+      )
+      errors = xsd.validate(Nokogiri::XML(xml)).map(&:message)
+      errors.each { |e| Est.log.error e }
+      Est.log.error(xml) unless errors.empty?
+      fail SchemaError, errors.join('; ') unless errors.empty?
+      xml
+    end
+  end
+end

data/lib/est/estimate.rb

@@ -0,0 +1,65 @@
+# 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 'est/methods/champions'
+require 'logger'
+require 'yaml'
+
+# Single estimate.
+# Author:: Yegor Bugayenko (yegor@teamed.io)
+# Copyright:: Copyright (c) 2014 Yegor Bugayenko
+# License:: MIT
+module Est
+  # Estimate.
+  class Estimate
+    # Ctor.
+    # +file+:: File with YAML estimate
+    def initialize(file)
+      @yaml = YAML.load_file(file)
+      fail "failed to read file #{file}" unless @yaml
+    end
+
+    # Get id.
+    def id
+      @yaml['id']
+    end
+
+    # Get date.
+    def date
+      Date.strptime(@yaml['date'], '%d-%m-%Y')
+    end
+
+    # Get author.
+    def author
+      @yaml['author']
+    end
+
+    # Get total estimate.
+    def total
+      method = @yaml['method']
+      fail "unsupported method #{method}" unless method == 'champions.pert'
+      Champions.new(@yaml).total
+    end
+  end
+end