mobiusloop 0.1.3 → 0.1.5

data/gherkin-languages.json

@@ -562,7 +562,8 @@
     ],
     "given": [
       "* ",
-      "Given "
+      "Given ",
+      "Baseline: "
     ],
     "name": "English",
     "native": "English",
@@ -577,11 +578,13 @@
     ],
     "then": [
       "* ",
-      "Then "
+      "Then ",
+      "Scale: "
     ],
     "when": [
       "* ",
-      "When "
+      "When ",
+      "Target: "
     ]
   },
   "en-Scouse": {

data/lib/cucumber/cli/main.rb

@@ -46,7 +46,7 @@ module Cucumber
         @err.puts("Couldn't open #{e.path}")
         exit_unable_to_finish
       rescue FeatureFolderNotFoundException => e
-        @err.puts(e.message + ". You can use `mobiusloop --init` to get started.")
+        @err.puts("Could not find goals directory. Try this: mobiusloop --init")
         exit_unable_to_finish
       rescue ProfilesNotDefinedError, YmlLoadError, ProfileNotFound => e
         @err.puts(e.message)

data/lib/cucumber/project_initializer.rb

@@ -3,6 +3,8 @@ module Cucumber
   # Generates generic file structure for a cucumber project
   class ProjectInitializer
     def run
+      puts "file expand path = #{File.expand_path(__FILE__)}"
+      @version = File.read(File.expand_path("../../../lib/mobiusloop/version", __FILE__))
       # normal cucumber init, replacing /features for /goals
       create_directory('goals')
       create_directory('goals/step_definitions')
@@ -10,7 +12,9 @@ module Cucumber
       create_file('goals/support/env.rb')
 
       # extra mobiusloop initiialization
-      copy_step_defs('mobius_steps.rb', 'goals/step_definitions') # install mobius_steps.rb step definition
+      copy_step_defs('mobius_steps.rb', 'goals/step_definitions')
+      copy_step_defs('hooks.rb', 'goals/support')
+      copy_step_defs('config/config.yml', 'goals/support')
       copy_step_defs('scales/page_response_scale.rb', 'goals/step_definitions') # example scale to measure response time
       copy_gherkin_languages('gherkin-languages.json')    # copy modified gherkin-languages.json file to gherkin gem(s)
       copy_example_file('total_articles_scale.rb', 'goals/step_definitions')
@@ -22,22 +26,24 @@ module Cucumber
 
     def copy_step_defs(spec_file, target)
       gem_dir = `gem environment gemdir`
-      steps_file = gem_dir.gsub("\n","") + "/gems/mobiusloop-?.?.?/lib/mobiusloop/" + spec_file
+      steps_file = gem_dir.gsub("\n","") + "/gems/mobiusloop-#{@version}/lib/mobiusloop/" + spec_file
       report_copying(spec_file, target)
       copy_file(steps_file, target)
     end
 
+    # note: this is penned to v3.2.0 of gherkin because 4.0.0 was causing issues
+    # this is not very elegant, but works for now
     def copy_gherkin_languages(gherkin_file)
       gem_dir = `gem environment gemdir`
-      source_gherkin = gem_dir.gsub("\n","") + "/gems/mobiusloop-?.?.?/" + gherkin_file
-      target_gherkin = gem_dir.gsub("\n","") + "/gems/gherkin-?.?.?/lib/gherkin/"
+      source_gherkin = gem_dir.gsub("\n","") + "/gems/mobiusloop-#{@version}/" + gherkin_file
+      target_gherkin = gem_dir.gsub("\n","") + "/gems/gherkin-3.2.0/lib/gherkin/"
       report_copying(gherkin_file, target_gherkin)
       copy_file(source_gherkin, target_gherkin)
     end
 
     def copy_example_file(file, target)
       gem_dir = `gem environment gemdir`
-      steps_file = gem_dir.gsub("\n","") + "/gems/mobiusloop-?.?.?/examples/mobiusloop/" + file
+      steps_file = gem_dir.gsub("\n","") + "/gems/mobiusloop-#{@version}/examples/mobiusloop/" + file
       report_copying(file, target)
       copy_file(steps_file, target)
     end
@@ -63,7 +69,6 @@ module Cucumber
                   end
 
       report_exists(file_name) || return if File.exists?(file_name)
-
       report_creating(file_name)
       FileUtils.send file_type, file_name
     end

data/lib/mobiusloop/config/config.yml

@@ -0,0 +1,9 @@
+# This contains configuration options
+
+measures:
+  save: false       # whether to save each run as .json file under goals/measures/
+                    # set to true to enable, false to disable
+progress:
+  good_percent: 10   # this percent or less deviation from target is "green"
+  bad_percent: 30   # this percent or greater deviation from target is "red"
+                         # good must be less than bad and between these two numbers is "yellow"

data/lib/mobiusloop/config/config_file.rb

@@ -0,0 +1,20 @@
+require 'yaml'
+
+class ConfigFile
+
+  # Loads YAML file at config_path and returns Hash of key/value pairs
+  def self.load_template(config_file)
+    if config_file == nil || File.exists?(config_file) == false
+      raise SyntaxError, "config file: #{File.expand_path(config_file)} not found"
+    end
+
+    #puts "  config: #{File.expand_path(config_file)}".colorize(:blue)
+    config_yaml = YAML.load_file(config_file)
+    config = Hash.new
+    for item in config_yaml
+      config.store(item[0], item[1])
+    end
+    return config
+  end
+
+end

data/lib/mobiusloop/hooks.rb

@@ -0,0 +1,22 @@
+require 'mobiusloop/objective'
+require 'mobiusloop/config/config_file'
+
+Before do |scenario|
+  Objective.add_current(scenario.feature.name)
+  #puts "scenario name #{scenario.name}"
+end
+
+After do |scenario|
+  config_dir =  File.dirname(File.absolute_path(__FILE__))
+  config_filepath = "#{config_dir}/config.yml"
+  config = ConfigFile.load_template(config_filepath)
+
+  if config.has_key?('measures') && config['measures'].has_key?('save')
+    persist = config['measures']['save']
+    if persist
+      objective = Objective.get_current
+      objective.save
+    end
+  end
+
+end

data/lib/mobiusloop/mobius_steps.rb

@@ -1,5 +1,6 @@
 require 'mobiusloop/outcome'
 require 'mobiusloop/scale'
+require 'mobiusloop/objective'
 
 @name = nil
 @outcome = nil
@@ -21,16 +22,17 @@ Given(/^a target of (\d+) "([^"]*)" by "([^"]*)"$/) do |arg1, arg2, arg3|
   @target_date = arg3
 end
 
-When(/^we measure progress with "([^"]*)"$/) do |arg1|
+# Replace outcome name with scenario name (in hooks.rb)
+Then(/^measure progress with "([^"]*)"$/) do |arg1|
+  objective = Objective.get_current
   scale_class = arg1.gsub(/\s+/, "") # turns 'My Custom Scale' into MyCustomScale
   @outcome = Outcome.new(@name, Object::const_get(scale_class).new())
+  objective.add_outcome(@outcome)
+
   @outcome.baseline = @baseline.to_i
   @outcome.baseline_date = @baseline_date
   @outcome.target = @target.to_i
   @outcome.target_date = @target_date
   puts @outcome.measure
-end
-
-Then(/^report progress towards targets$/) do
   puts @outcome.report
-end
+end

data/lib/mobiusloop/objective.rb

@@ -1,10 +1,76 @@
+require 'json'
+require 'fileutils'
 
 class Objective
 
-  attr_accessor :name
+  @@objectives = Array.new   # class array holds instances of objectives one per .goal file
+
+  # needs to just be adding 1
+  def self.add_current(name)
+    objective = Objective.new(name)
+    if @@objectives.include?(objective) == false
+      @@objectives.push(objective)
+    end
+    self.get_current
+  end
+
+  def self.get_current
+    @@objectives.last
+  end
+
+  def self.get_all
+    @@objectives
+  end
+
+
+  attr_reader :name
+  attr_reader :outcomes
 
   def initialize(name)
     @name = name
+    @outcomes = []
+  end
+
+
+  def add_outcome(outcome)
+    @outcomes.push(outcome)
+  end
+
+
+  # persist the results. May be overridden by subclasses
+  def save
+    filename = Time.now.strftime("measures-%Y-%m-%d-%H%M%S.json")
+    dirname = "goals/measures"
+    hash = { "objective" => @name}
+    @outcomes.each {|o|
+      hash.store("outcome", o.name)
+      hash.store("scale", "#{o.scale.class.name}.rb")
+      hash.store("baseline", o.baseline)
+      hash.store("baseline date", o.baseline_date)
+      hash.store("target", o.target)
+      hash.store("target date", o.target_date)
+      hash.store("measure", o.last_measure.value)
+      hash.store("measure date", Time.now.strftime("%b %-d, %Y"))
+    }
+
+    if !File.exists? dirname
+      FileUtils.mkdir_p dirname
+    end
+
+    File.open("#{dirname}/#{filename}","a") do |f|
+      f.write(JSON.pretty_generate(hash))
+      f.write("\n")
+    end
+  end
+
+
+  def ==(other)
+    other.class == self.class && other.name == self.name
+  end
+
+
+  def state
+    self.instance_variables.map { |variable| self.instance_variable_get variable }
   end
 
 end

data/lib/mobiusloop/outcome.rb

@@ -1,30 +1,39 @@
 # Represents a specific outcome or key result to be achieved
 
+require 'json'
+require 'colorize'
+
 class Outcome
 
+  FILENAME = 'measures'
+
   attr_reader   :name
   attr_accessor :baseline
   attr_accessor :baseline_date
   attr_accessor :target
   attr_accessor :target_date
   attr_reader   :scale
+  attr_accessor :persist
+  attr_reader   :last_measure
 
   # register a name (String) and scale (Scale) of measurement at creation time
-  def initialize(name, scale)
+  def initialize(name, scale, persist = false)
     raise "name must not be nil" if name == nil
     raise "scale must be of type Scale" unless scale.is_a? Scale
     @name = name
     @scale = scale
+    @persist = persist
   end
 
   # perform the measurement using the provide scale
   # delegate the details to any class extending Scale
+  # TODO: Change measurement to benchmark
   def measure
     begin
       start_time = Time.now
-      @scale.record_measurement
+      @last_measure = @scale.measure
       elapsed_time = (Time.now - start_time)
-      return "Success! Measure is " + format_number(@scale.measurements.last) + " " + @name + " in #{elapsed_time.round(1)} seconds!"
+      return "Success! Measured " + format_number(@last_measure) + " " + @name + " in #{elapsed_time.round(1)} seconds!"
     rescue Exception => e
       return "Error! Measurement failed with message: " + e.message
     end
@@ -33,7 +42,6 @@ class Outcome
   # used to report progress towards goals
   def report
     report = ""
-    # report << status
     report << report_progress
     report << report_remaining
     report
@@ -49,13 +57,13 @@ class Outcome
     end
   end
 
+
   private
 
   # report the status. Very simplistic now, need to validate if there is need
   # for this or we should just drop and let others determine status
   def status
     status = percent_progress - percent_schedule
-
     # this value of 10 is temporary. TODO: need to make this more flexible and explainable
     if status.abs < 10
       "Hooray! You are on track!\n"
@@ -66,21 +74,69 @@ class Outcome
 
   # report percentage progress towards the target
   def report_progress
-    "#{percent_progress.round(0)}% progress to target using #{percent_schedule.round(0)}% of the time (" + progress_days.to_s + " days)\n"
+    config = ConfigFile.load_template("#{Dir.pwd}/goals/support/config.yml")
+
+    progress = percent_progress.round(0)
+    schedule = percent_schedule.round(0)
+    delta = (progress - schedule).abs
+    days = progress_days
+    result = ""
+
+    # TODO: FIX LOGIC, ADD MORE TEST CASES
+
+    if config.has_key?('progress') && config['progress'].has_key?('green_threshold') &&
+        config['progress'].has_key?('red_threshold')
+      good = config['progress']['green_threshold'].to_i
+      bad = config['progress']['red_threshold'].to_i
+
+      if (delta <= good)
+        result = "#{progress}% progress to target using #{schedule}% of the time (#{days} days)\n".colorize(:green)
+      elsif (delta >= bad)
+        result =  "#{progress}% progress to target using #{schedule}% of the time (#{days} days)\n".colorize(:red)
+      else
+        result =  "#{progress}% progress to target using #{schedule}% of the time (#{days} days)\n".colorize(:yellow)
+      end
+    end
+    result
   end
 
-  # report remaining progress towards the target
   def report_remaining
-    if percent_remaining.round(0) <= 0
-      "Target achieved!"
-    else
-      "#{percent_remaining.round(0)}% remaining to target in #{remaining_days} days\n"
+    config = ConfigFile.load_template("#{Dir.pwd}/goals/support/config.yml")
+    days_remaining = remaining_days
+    remaining = percent_remaining.round(0)
+    progress = percent_progress.round(0)
+    schedule = percent_schedule.round(0)
+    delta = (progress - schedule).abs
+    result = ""
+
+    if config.has_key?('progress') &&
+        config['progress'].has_key?('good_percent') &&
+        config['progress'].has_key?('bad_percent')
+
+      good = config['progress']['good_percent'].to_i
+      bad = config['progress']['bad_percent'].to_i
+
+      # if delta is positive, green
+      # if delta is negative, but still within green threshold, green
+      # if delta is negative, and greater than red threshold, red
+      # else yellow
+
+      if (delta >= 0)
+        result = "#{remaining}% remaining to target in #{days_remaining} days\n".colorize(:green)
+      elsif (delta < 0 && delta <= good)
+        result = "#{remaining}% remaining to target in #{days_remaining} days\n".colorize(:green)
+      elsif (delta < 0 && delta >= bad)
+        result =  "#{remaining}% remaining to target in #{days_remaining} days\n".colorize(:red)
+      else
+        result =  "#{remaining}% remaining to target in #{days_remaining} days\n".colorize(:yellow)
+      end
     end
+    result
   end
 
   # percentage progress towards target as of now
   def percent_progress
-    ((@scale.measurements.last.value.to_i - @baseline.to_i).to_f /
+    ((@last_measure.value.to_i - @baseline.to_i).to_f /
         (@target.to_i - @baseline.to_i).to_f * 100)
   end
 

data/lib/mobiusloop/scale.rb

@@ -2,21 +2,13 @@
 # Designed to be extended with the measure method implemented
 # by the specific
 
-class Scale
 
-  attr_reader :measurements
+class Scale
 
   # creates internal array to store measurements
-  # if sub-classes need their own initialize logic
-  # call super first
+  # by default, persisting measures is turned off
+  # if sub-classes need their own initialize logic call super first
   def initialize
-    @measurements = Array.new
-  end
-
-  # performs measurement and adds to internal array
-  def record_measurement()
-    new_measure = measure
-    add(new_measure)
   end
 
   # method to perform a measurement, should return an instance of Measure
@@ -24,9 +16,4 @@ class Scale
     raise "Someone forgot to override Scale.measure with their unique logic"
   end
 
-  # adds a new measure to end of array
-  def add(measure)
-    @measurements.push(measure)
-  end
-
 end

data/lib/mobiusloop/version

@@ -0,0 +1 @@
+0.1.5

data/mobiusloop.gemspec

@@ -10,23 +10,22 @@ Gem::Specification.new do |s|
   s.homepage    = "http://mobiusloop.com"
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = ">= 1.9.3"
-  s.add_dependency 'cucumber-core', '~> 1.4.0'
-  s.add_dependency 'builder', '>= 2.1.2'
-  s.add_dependency 'diff-lcs', '>= 1.1.3'
-  s.add_dependency 'gherkin', '~> 3.2'
+  s.add_dependency 'cucumber-core', '~> 1.4', '= 1.4.0'
+  s.add_dependency 'builder', '~> 3.2', '>= 3.2.0'
+  s.add_dependency 'diff-lcs', '~> 1.1', '>= 1.1.3'
+  s.add_dependency 'gherkin', '~> 3.2', '= 3.2.0'
   s.add_dependency 'multi_json', '>= 1.7.5', '< 2.0'
-  s.add_dependency 'multi_test', '>= 0.1.2'
-  s.add_dependency 'cucumber-wire', '~> 0.0.1'
-
+  s.add_dependency 'multi_test', '~> 0.1', '>= 0.1.2'
+  s.add_dependency 'cucumber-wire', '~> 0.0.1', '>= 0.0.1'
   s.add_development_dependency 'aruba', '~> 0.6.1'
   s.add_development_dependency 'json', '~> 1.7'
   s.add_development_dependency 'nokogiri', '~> 1.5'
-  s.add_development_dependency 'rake', '>= 0.9.2'
-  s.add_development_dependency 'rspec', '>= 3.0'
-  s.add_development_dependency 'simplecov', '>= 0.6.2'
+  s.add_development_dependency 'rake', '~> 11.1', '>= 11.1'
+  s.add_development_dependency 'simplecov', '~> 0.6', '>= 0.6.2'
   s.add_development_dependency 'coveralls', '~> 0.7'
-  s.add_development_dependency 'syntax', '>= 1.0.0'
-  s.add_development_dependency 'pry'
+  s.add_development_dependency 'syntax', '~> 1.0', '>= 1.0.0'
+  s.add_development_dependency 'pry', '~> 0'
+  s.add_development_dependency 'rspec', '~> 3.0', '>= 3.0'
 
   # For Documentation:
   s.add_development_dependency 'bcat', '~> 0.6.2'
@@ -34,9 +33,12 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'yard', '~> 0.8.0'
 
   # Needed for examples (rake examples)
-  s.add_development_dependency 'capybara', '>= 2.1'
-  s.add_development_dependency 'rack-test', '>= 0.6.1'
-  s.add_development_dependency 'sinatra', '>= 1.3.2'
+  s.add_development_dependency 'capybara', '~> 2.1', '>= 2.1'
+  s.add_development_dependency 'rack-test', '~> 0.6', '>= 0.6.1'
+  s.add_development_dependency 'sinatra', '~> 1.3', '>= 1.3.2'
+
+  # Added by Mobius
+  s.add_dependency 'colorize', '~> 0.8.1'
 
   s.rubygems_version = ">= 1.6.1"
   s.files            = `git ls-files`.split("\n").reject {|path| path =~ /\.gitignore$/ }