mobiusloop 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f8aeb0ff8c00b5bc92a1746d916eefbff900728
-  data.tar.gz: 7f93d1d2a066f66a5ca4b2db2086c17d53956a2c
+  metadata.gz: 0e6bd4113018108ce0d474e02243c13e5e8701f9
+  data.tar.gz: ccda4bfa5a8026be4c646f884cf5aaaf8b8275d0
 SHA512:
-  metadata.gz: 5b9a4dffb7ecdba4d028869f7f9fc5586037bc543c52b57eda4c5b70ed318824c88226ea46f27743f12a80f8a8907c3917b4471c72105cec78a9dd5e3d8ae036
-  data.tar.gz: b124626976da7218379aef1c4f04f8deb5828aa2410245a9802920008cb16da06ddac145f1166277cbcc23b78a18352d0cafa814ec712e11f882e58734cc01cf
+  metadata.gz: 8fc115d1b44f03d233997ee9dde71744b75ae8377bbf6e6b5d9d1ab1abf22d3f275fc0f76cd523783b1c8a51d0fa1212c37d23ccc3ce71e78322d1dc6896eaf7
+  data.tar.gz: 8b20b671d419e975385d6e7ea87bf98fad1475c16648be055cd3f0f85d00778240617f5fc105fe6731114fb48e6830992d5a342d821bcfbbbb3de3af61e1f2d9

data/README.md

@@ -130,23 +130,17 @@ end
 ## getting started
 
 Adding `mobiusloop` to your product is easy, but requires some command-line chops.
-If this section looks like Greek, then as nicely as possible ask a developer on your team to help.
+If this section looks like Greek, then as nicely as possible ask a developer on your team for help.
 
-**Note:** Currently only Linux and OSX are supported platforms. Windows will be added in the future.
-
-**TODO:** Simplify the installation steps to `gem install mobiusloop`. For now download the source and build a .gem locally.
-
-Download the [source code](https://github.com/ryanshriver/mobiusloop-ruby) into a working directory (e.g. /workspace/mobiusloop-ruby)
+**Note:** Currently only Ruby on Linux and OSX are tested platforms. Windows will be added in the future.
 
 If [Ruby](https://www.ruby-lang.org/en/), [gem](https://rubygems.org) and [bundle](http://bundler.io) are not installed, install them first.
-Then from the working directory, run these commands:
 
-    $ gem build mobiusloop.gemspec
-    $ gem install mobiusloop-0.1.1.gem
+Then install `mobiusloop` with this command:
 
-Replace `mobiusloop-0.1.1.gem` with whatever version was built.
+    $ gem install mobiusloop
 
-Finally, create a symbolic link for the `mobiusloop` command. First locate your ruby executable path:
+Once installed, create a symbolic link for the `mobiusloop` command. First locate your ruby executable path:
 
     $ gem env
 
@@ -155,11 +149,10 @@ Then create a symbolic link:
 
     $ ln -s </path/to/executable/directory/mobiusloop /usr/local/bin/mobiusloop
 
-**TODO:** Find a way to create symbolic link as part of gem install
+**TODO:** Find a way to create symbolic link as part of gem install to remove this manual step
 
 
-
-## Adding `mobiusloop` to your app
+## adding mobiusloop to your app
 
 To create and run your own goals, let's start with a working example and modify it.
 
@@ -168,102 +161,68 @@ Change to the root directory of your app and run `mobiusloop`:
     $ cd product_home
     $ mobiusloop
 
-You will see that `mobiousloop` is not initialized. So let's do that:
+You get feedback that `mobiousloop` is not initialized. So let's do that:
 
     $ mobiusloop --init
 
-You will see that `mobiusloop` created a `goals/` directory and put some files in there. Let's run our example:
+`mobiusloop` just created a `goals/` directory and put some files in there. Let's run our example:
 
     $ mobiusloop
 
-If all goes well, you will see something like this:
-
- ```Ruby
- Objective: Get a million paying customers by Q3 2016
-
-   Outcome: Increase Journal Readership to 1,000,000
-     Given a baseline of 500000 "readers" on "Oct 1, 2015"
-     And a target of 1000000 "readers" by "Oct 1, 2016"
-     When we measure progress with "Total Readers Scale"
-       Success! found 820,000 readers in 0.0 seconds!
-     Then report progress towards targets
-       Hooray! You are on track!
-       64% progress to target using 63% of the time (231 days)
-       36% remaining to target in 134 days
-
-   Outcome: Increase Published Articles by 25%
-     Given a baseline of 40000 "articles" on "Jan 1, 2016"
-     And a target of 50000 "articles" by "Oct 1, 2016"
-     When we measure progress with "Total Articles Scale"
-       Success! found 420,00 articles in 0.0 seconds!
-     Then report progress towards targets
-       Sorry, you are not on track
-       20% progress to target using 51% of the time (139 days)
-       80% remaining to target in 134 days
-
- 2 scenarios (2 passed)
- 8 steps (8 passed)
- 0m0.025s
- ```
-Congrats `mobiusloop` is running for your product! Now let's customize it for your needs.
+If all goes well, you get feedback that `mobiusloop` is running for your product! Now let's customize it for your needs.
 
 
-## Create your first `.goal`
+## create your first .goal
 
-First, open `goals/increase_readers.goal` in a text editor, change the baseline or target value, save and run the example again.
-Did you notice changes in the progress and status? Change the baseline and target dates and try again. Get the hang of it?
+First, open `goals/increase_readers.goal` in a text editor, change the baseline or target value, save and run again.
+Did you notice changes in the progress and status? Change the baseline and target dates and try again. Getting the hang of it?
 
-Let's pretend you have a product outcome to improve response time from 4.5 seconds to 1.5 seconds for your app.
-We know your product would never be this slow, but let's just pretend. Start by copying our working example:
+Now let's pretend you have a product outcome to **improve response time** for your product from 4.5 seconds to 1 second.
+Start by copying our working example:
 
     $ cp goals/increase_readers.goal goals/improve_response_time.goal
 
 
-#### Create Objectives and Outcomes
+#### create objectives and outcomes
 
 Open the new `improve_response_time.goal` in your text editor and make some changes:
 
- - Update `Objective:` to reflect our new goal. Something like <i>improve our digital customer experience</i>.
- - Let's only start with one `Outcome`, so delete from `Outcome: Increase Published Articles` to the end of the file
+ - Update `Objective:` to reflect our new goal. How about <i>Improve our digital customer experience this year</i>.
+ - Let's only start with one `Outcome`, so delete from `Outcome: Increase Published Articles by 25%` to the end of the file
  - Now update your `Outcome:` keeping it short and sweet. Something like <i>Improve Response Time</i>
 
 Now save the file and run again:
 
     $ mobiusloop
 
-Cool, now we have multiple running goals! As you add more `.goal` files to `goals/` folder, `mobiusloop` runs them.
+This runs all the `.goal` files to `goals/` folder. We can just run our new one with this command:
 
-If you only wanted to run one `.goal`, you could do that easily:
-
-    $ mobiusloop goals/increase_readers.goal
+    $ mobiusloop goals/improve_response_time.goal
 
 We don't need the example anymore, so let's remove it:
 
     $ rm goals/increase_readers.goal
 
-#### Define baselines and targets
-
-Open `improve_response_time.goal` again and let's update the baselines and targets.
-Let's pretend as of last October your app's home page takes 4.5 seconds to load. That's your baseline. Make a change:
 
- - In the row starting with `Given`, change 50000 to 4.5
+#### define baselines and targets
 
-Your product owner has said <i>sub-second</i> is how fast it should load. That's your target. Make another change:
+Open `improve_response_time.goal` again and let's update the baselines and targets.
+Let's pretend as of October 1, 2015 your app's home page takes 5 seconds to load. That's your baseline. Make a change:
 
- - In the row starting with `And`, change 1000000 to 1
+ - In the row starting with `Given`, change 50000 to 5 and "readers" to "seconds"
 
-Finally, your unit of measure is not "readers", so let's fix that:
+Your product owner has said <i>sub-second</i> is their goal. That's your target. Make another change:
 
- - Change "readers" to "seconds" for both target and baseline rows
+ - In the row starting with `And`, change 1000000 to 1 and "readers" to "second"
 
 Now save the file and run again:
 
     $ mobiusloop
 
-This works, but the scale says we have 820,000 seconds! That's not right, so let's fix it.
+This works, but we have 820,000 seconds! That's not right, so let's fix it.
 
 
-#### Define scales
+#### define scales
 
 Open `improve_response_time.goal` again and let's change the scale to record response times, not total readers.
 
@@ -275,15 +234,15 @@ Now save the file and run again.
 
 Wow, much better! The "Page Response Scale" requested google.com and compared the response time to your target.
 
-How did you do? Depending on your internet speed, hopefully you hit the target.
+How did you do? Did you hit the target?
 
 
-## Developing with `mobiusloop`
+## developing with mobiusloop
 
-Hopefully by now you're getting the hang of it. When developing with `mobiusloop` there are three basic steps:
+Hopefully by now you're getting the hang of `mobiusloop`. During development there are three basic steps:
 
 
-#### Step 1: Create a new `.goal` file in the `goals/` directory
+#### step 1: create a new .goal file in the goals/ directory
 
 You can copy an example or start from scratch. When done, do a dry run to ensure your syntax is valid:
 
@@ -292,7 +251,7 @@ You can copy an example or start from scratch. When done, do a dry run to ensure
 Replacing `your_objective.goal` with your filename. If there's any syntax problems, fix them and run again until you get a clean run.
 
 
-#### Step 2: Optionally create a step definition
+#### step 2: optionally create a step definition
 
 `mobiusloop` ships with one step definition `goals/step_definitions/mobius_steps.rb`. If you write your objectives,
 problems, outcomes and key results in the format above there's no need to create one. However if you want to create your own
@@ -305,7 +264,7 @@ Copy and paste this into a new file `your_name_steps.rb` and save it to the `goa
 info on step definitions, see [Cucumber's reference](https://cucumber.io/docs/reference#step-definitions).
 
 
-#### Step 3: Create a new `Scale`
+#### step 3: create a new Scale
 
 Create a new Ruby class to perform the measurement. For example, if your .`goal` file contains "My Custom Scale", the Ruby class would be:
 
@@ -322,22 +281,22 @@ class MyCustomScale < Scale
 
 end
 ```
-Replace the line `total = fetch_your_total` with your custom logic. The last line should be `Measure.new(total)` to return a new measure.
+This code lives in `my_custom.scale.rb`.
+Replace the line `total = fetch_your_total` with your custom logic.
+The last line `Measure.new(total)` returns a new measure.
 
 We recommend writing unit tests around any custom scales you create to ensure they work as expected before integrating with `mobiusloop`
 
-When done, run:
+To run a single `.goal`, try this:
 
     $ mobiusloop goals/your_objective.goal
 
-To run a single `.goal`, or:
+Where `your_objective.goal` is the name of your custom goal. You can run all the `.goal` files in `/goals` folder with this:
 
     $ mobiusloop
 
-To run all the `.goal` files in `/goals` folder.
-
 
-## Advanced Features
+## advanced features
 
 Because `mobiusloop` is an extension of [Cucumber](http://cucumber.io), there are many features in Cucumber that also
 exist in `mobiusloop`. A few examples:
@@ -353,7 +312,6 @@ Will only run those Objectives, Problems, Outcomes or Key Results associated wit
 JSON or other formats. See [Cucumber reports](https://cucumber.io/docs/reference#reports) for more details.
 
 
-
 ## Testing
 
 `mobiusloop` is built using a test-first approach. We're proud of our tests, but we're always looking to add more.

data/lib/cucumber/project_initializer.rb

@@ -11,6 +11,7 @@ module Cucumber
 
       # extra mobiusloop initiialization
       copy_step_defs('mobius_steps.rb', 'goals/step_definitions') # install mobius_steps.rb step definition
+      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')
       copy_example_file('total_readers_scale.rb', 'goals/step_definitions')

data/lib/mobiusloop/outcome.rb

@@ -24,7 +24,7 @@ class Outcome
       start_time = Time.now
       @scale.record_measurement
       elapsed_time = (Time.now - start_time)
-      return "Success! found " + format_number(@scale.measurements.last) + " " + @name + " in #{elapsed_time.round(1)} seconds!"
+      return "Success! Measure is " + format_number(@scale.measurements.last) + " " + @name + " in #{elapsed_time.round(1)} seconds!"
     rescue Exception => e
       return "Error! Measurement failed with message: " + e.message
     end
@@ -33,12 +33,22 @@ class Outcome
   # used to report progress towards goals
   def report
     report = ""
-    report << status
+    # report << status
     report << report_progress
     report << report_remaining
     report
   end
 
+  # format number for display (1000000 => 1,000,000)
+  # unless number starts with 0 or .
+  def format_number(measure)
+    if measure != nil || measure.value != nil
+      whole, decimal = measure.value.to_s.split(".")
+      whole_with_commas = whole.chars.to_a.reverse.each_slice(3).map(&:join).join(",").reverse
+      [whole_with_commas, decimal].compact.join(".")
+    end
+  end
+
   private
 
   # report the status. Very simplistic now, need to validate if there is need
@@ -61,7 +71,11 @@ class Outcome
 
   # report remaining progress towards the target
   def report_remaining
-    "#{percent_remaining.round(0)}% remaining to target in #{remaining_days} days\n"
+    if percent_remaining.round(0) <= 0
+      "Target achieved!"
+    else
+      "#{percent_remaining.round(0)}% remaining to target in #{remaining_days} days\n"
+    end
   end
 
   # percentage progress towards target as of now
@@ -91,9 +105,4 @@ class Outcome
     (DateTime.parse(target_date) - DateTime.now).to_i
   end
 
-  # format number for display (1000000 => 1,000,000)
-  def format_number(measure)
-    measure.value.to_s.gsub(/(\d{3})(?=\d)/, '\\1,') unless measure == nil
-  end
-
 end

data/lib/mobiusloop/scales/page_response_scale.rb

@@ -0,0 +1,20 @@
+require 'benchmark'
+require 'mobiusloop/scale'
+
+require "net/http"
+require "uri"
+
+# Records the response time of a web page
+class PageResponseScale < Scale
+
+  attr_accessor :location
+
+  # returns a new Measure with response time of the :location
+  def measure
+    @location = "http://google.com" if @location == nil
+    time = Benchmark.measure do
+      response = Net::HTTP.get_response(URI.parse(@location))
+    end
+    Measure.new(time.real)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobiusloop
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ryan Shriver
@@ -791,6 +791,7 @@ files:
 - lib/mobiusloop/objective.rb
 - lib/mobiusloop/outcome.rb
 - lib/mobiusloop/scale.rb
+- lib/mobiusloop/scales/page_response_scale.rb
 - lib/simplecov_setup.rb
 - major_changes_to_cucumber.md
 - mobiusloop.gemspec
@@ -870,7 +871,7 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: mobiusloop-0.1.2
+summary: mobiusloop-0.1.3
 test_files:
 - features/docs/api/list_step_defs_as_json.feature
 - features/docs/api/listen_for_events.feature