gem_velocity 0.0.8 → 0.0.9

data/.gitignore

@@ -16,7 +16,7 @@ test/tmp
 test/version_tmp
 tmp
 spec/tmp
+./public/images/
 public/
-images/
 spec/fixtures/vcr_cassettes
 spec/fixtures/vcr_cassettes/

data/README.md

@@ -1,18 +1,22 @@
 # GemVelocity
 
-A way to see gem velocity. There are three ways you can view graphs. 
+A way to see gem velocity. There are two ways you can view graphs.
+
+`SingleVelocitator`
+
+This is a single line graph of a single version.
 
 `AggregatedVelocitator`
 
-`SingleVelocitator`
+This is a signle line graph that has an aggregated view of a major version (or bunch of single minor versions, etc).
 
-`MultipleVelocitator`
+See specs and examples for more info.
 
-Some examples are noted below.
+There is also the `Multiplexer`, this is a wrapper around being able to draw multiple lines at once. You pass it any number of the above and it will graph multiple lines together in one graph.
 
 ## Note
 
-There may be some inconstancies. These are outlined in:
+There may be some inconstancies due to bad data coming back from the api. These are outlined in:
 
 [https://gist.github.com/shaiguitar/d2af997b7f58e24fd305](https://gist.github.com/shaiguitar/d2af997b7f58e24fd305)
 
@@ -20,60 +24,25 @@ It seems it happens with older data. I'm investigating though with the help of t
 
 ## Requirements
 
-It draws graphs. So...you'll need imagemagick/rmagick. Any problems with installation let me know and I'll try to help out.
+It draws graphs. So you'll need imagemagick/rmagick. Any problems with installation let me know and I'll try to help out.
 
-There are plans to put it on the web somewhere, so if you wait long enough you may not even need to install it.
+`brew install imagemagick && brew link imagemagick && gem install gem_velocity`
 
 # Example
 
-<pre>
-  velocitator = MultipleVelocitator.new("rails", ["4.0.0","3.2.14","2.3.5"])
-  file = velocitator.graph("/tmp")
-</pre>
-
-Produces:
-
-![here](examples/rails-4.0.0-3.2.14-2.3.5.png)
-
-Notice the date range:
-
-<pre>
-  velocitator = MultipleVelocitator.new("rails", ["4.0.0","3.2.14","0.9.1"])
-  file = velocitator.graph("/tmp", [3.months.ago, Time.now])
-</pre>
-
-Produces:
+See [examples](examples/) for pictures. The specs have more examples as well.
 
-![here](examples/rails-4.0.0-3.2.14-0.9.1.png)
+Important to note, you should be able to pass in specific start time, end time, max and min values.
 
-<pre>
-  velocitator = AggregatedVelocitator.new("rails", "4")
-  # matches any version /^4.\d/ etc
-  file = velocitator.graph("/tmp")
-</pre>
-
-Produces:
-
-![here](examples/rails-4.0.1.rc1-4.0.0-4.0.0.rc2-4.0.0.rc1-4.0.0.beta1.png)
-
-Another: [celluloid](https://gist.github.com/shaiguitar/7e6d95971c5254fa3665)
-
-You could do the same with a `SingleVelocitator` as well: 
-
-<pre>
-  velocitator = SingleVelocitator.new("rails", "4.0.0")
-  file = velocitator.graph("/tmp")
-</pre>
-
-That image is left as an excerise to the reader. Actually it's late. But try it and see.
-
-Also, you should be able to pass in max,min values which completes you being able to manipulate the boundries of the graph in question.
+This essentially completes you being able to manipulate the boundries of the graph in question.
 
 ## Web UI
 
-Do you want to see this with ease (Hey, the api is easy. Whatever) on the web at `http://rubygems-velocity.org/gem/rails/4.0.0,3.2.14` or something similar? I could do it, but I need to know it's worth the hassle.
+Do you want to see this with ease (Hey, the api is easy. Whatever) on the web at `http://rubygems-velocity.org/gem/rails/4.0.0,3.2.14` or something similar?
+
+[Work](https://github.com/shaiguitar/gem_velocity_web) has been started to put it on a UI, but your feedback in necessary for it to be useful:
 
-Also, if you have any idea of how you'd like to use it, please leave a comment on the [issue](https://github.com/shaiguitar/gem_velocities/issues/3)
+So if you have any idea of how you'd like to use it, please put your thoughts on the [issue](https://github.com/shaiguitar/gem_velocities/issues/3)
 
 Lemme know.
 

data/TODO

@@ -1,11 +1,7 @@
-Web ui/embeddable links with those images.
-  can't remove images
-  have uniq name: hash the date_range,max,min,name,versions. (and time?)
-  shard the directories of where the image goes so it doesn't bomb out?
-
 Add a Version?
 
 currently, the versions in the base class are single versions, but they are essentially used for representing a specific line
+
 in default_line_datas.
 (and then used for titles, abd bs).
 
@@ -14,3 +10,9 @@ if rubygems 606 isn't solved, why not just put a total on there and let the inco
 rename time_format_str_small alias
 
 swap out gruff_builder to some other composing object of a builder, that can mash up the various velocitators?
+
+consolidate velocitator fixtrues or at least repeatable generators in specs.
+
+cassandra says to have an option to have the multiplexer start them from the same data (to see curve/adoption rate). I see it.
+
+hardcode a time limit of earliest_time since historical data is not reliable.

data/examples/README.md

@@ -0,0 +1 @@
+See generated images for the script here in [the images directory](public/images)

data/examples/generate_images.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+
+examples_dir  = File.expand_path(File.dirname(__FILE__))
+images_dir    = File.join(examples_dir, "public","images")
+project_root  = File.join(examples_dir, "..")
+project_lib   = File.join(project_root,"lib")
+
+$:.unshift(project_root)
+$:.unshift(project_lib)
+require 'lib/gem_velocity'
+
+puts "Cleaning images directory before generating again."
+FileUtils.rm_rf(images_dir)
+
+puts "SINGLE VELOCITATOR"
+@v1 = SingleVelocitator.new("haml-i18n-extractor", "0.0.17")
+@v1.max_value = 800
+file = @v1.graph
+
+puts "SINGLE VELOCITATOR"
+# these are basically equivalet:
+# BaseVelocitator.create(:gem_name => "haml-i18n-extractor", :version => "0.0.16")
+# BaseVelocitator.create(:full_name => "haml-i18n-extractor-0.0.16")
+@v2 = SingleVelocitator.new("haml-i18n-extractor", "0.0.16")
+@v2.max_value = 800
+file = @v2.graph
+
+puts "AGGREGATED VELOCITATOR"
+# these are basically equivalet:
+# BaseVelocitator.create(:gem_name => "haml-i18n-extractor", :version => "0.4.x")
+# BaseVelocitator.create(:full_name => "haml-i18n-extractor-0.4.x")
+@v3 = AggregatedVelocitator.new("haml-i18n-extractor", "0.4.x")
+@v3.max_value = 800
+file = @v3.graph
+
+puts "MULTIPLEXING"
+@velocitators = [@v1,@v2,@v3]
+@multiplexer = Multiplexer.new(@velocitators)
+file = @multiplexer.graph
+
+puts "MULIPLEXING AGAIN"
+@velocitators = []
+@velocitators << BaseVelocitator.create(:gem_name  => "haml-i18n-extractor", :version => "0.4.x")
+@velocitators << BaseVelocitator.create(:full_name => "haml-i18n-extractor-0.3.x")
+@multiplexer = Multiplexer.new(@velocitators)
+file = @multiplexer.graph

data/lib/gem_velocity/gem_data.rb

@@ -24,7 +24,7 @@ class GemData
     # it should be a hash
     if @versions_metadata.is_a?(String)
       if @versions_metadata.match(/This rubygem could not be found/)
-        raise(NoSuchGem, "This rubygem could not be found")
+        raise(NoSuchGem, "This rubygem #{gem_name} could not be found")
       end
     end
     @versions_metadata

data/lib/gem_velocity/gruff_builder.rb

@@ -14,16 +14,18 @@ class GruffBuilder
   attr_accessor :title, :labels, :line_datas, :min_value, :max_value, :hide_legend
 
   def initialize(root, relative_path, versions, gem_name, gruff_options = {})
-    @root = root || raise(ArgumentError,"you must set a root. default is root/public/images")
-    @relative_path = relative_path || "public/images/"
-    @versions = versions.is_a?(Array) ? versions : raise(ArgumentError,"versions must be an array")
-    @gem_name = gem_name
-    @title = gruff_options[:title] || ""
-    @labels = gruff_options[:labels] || {}
-    @line_datas = gruff_options[:line_datas]
-    @min_value = gruff_options[:min_value] || MIN_VALUE
-    @max_value = gruff_options[:max_value] || MAX_VALUE
-    @hide_legend = gruff_options[:hide_legend] || false
+    # just pass it in all in gruff_options?
+    @root           = root || raise(ArgumentError,"you must set a root. default is root/public/images")
+    @relative_path  = relative_path || "public/images/"
+    @versions       = versions.is_a?(Array) ? versions : raise(ArgumentError,"versions must be an array")
+    @gem_name       = gem_name
+    @title          = gruff_options[:title] || ""
+    @labels         = gruff_options[:labels] || {}
+    @line_datas     = gruff_options[:line_datas]
+    @min_value      = gruff_options[:min_value] || MIN_VALUE
+    @max_value      = gruff_options[:max_value] || MAX_VALUE
+    @hide_legend    = gruff_options[:hide_legend] || false
+    @type           = gruff_options[:type]
   end
 
   def relative_filename
@@ -31,7 +33,7 @@ class GruffBuilder
   end
 
   def filename
-    "#{graph_name(versions.join("-"))}.png"
+    "#{graph_name(@type, versions.join("-"))}.png"
   end
 
   def absolute_filename
@@ -63,9 +65,10 @@ class GruffBuilder
     FileUtils.mkdir_p(File.expand_path(absolute_destination))
   end
 
-  def graph_name(append_text = nil)
+  def graph_name(prepend_text = nil, append_text = nil)
+    prepend_text = prepend_text.nil? ? "" : "#{prepend_text}-"
     append_text = append_text.nil? ? "" : "-#{append_text}"
-    "#{gem_name}"+ append_text
+    prepend_text + "#{gem_name}"+ append_text
   end
 
   def gruff

data/lib/gem_velocity/helpers.rb

@@ -10,4 +10,30 @@ module Helpers
     Date.parse(whatever.to_s).strftime("%Y-%m-%d")
   end
 
+  def earliest_for(whatevers)
+    whatevers = whatevers.map{|s| Date.parse(s) } if whatevers.first.is_a?(String)
+    time_format_str(whatevers.sort.first)
+  end
+
+  def latest_for(whatevers)
+    whatevers = whatevers.map{|s| Date.parse(s) } if whatevers.first.is_a?(String)
+    time_format_str(whatevers.sort.last)
+  end
+
+  def compute_day_range_from_start_end(s,e)
+    all_days = []
+    s = Date.parse(s)
+    e = Date.parse(e)
+    i = s
+    while (i <= e )
+      all_days << i
+      i += 1.day
+    end
+    all_days.map{|d| time_format_str_small(d)}
+  end
+
+  def remove_trailing_x(str)
+    str.gsub(/[xX]$/,"")
+  end
+
 end

data/lib/gem_velocity/velocitators/aggregated_velocitator.rb

@@ -1,10 +1,18 @@
 class AggregatedVelocitator < BaseVelocitator
 
+  # TODO can probably get rid of this
   attr_reader :aggregated_versions
+
+  # the one with the wildcard
+  attr_reader :version
+
+  # all of the ones matched, aggregated_versions
+  attr_reader :versions
+
   def initialize(gem_name, top_level_ver)
     @gem_name = gem_name
-    @top_level_ver = top_level_ver
-    @aggregated_versions = gem_data.versions.select{|v| v.match(/^#{Regexp.escape(top_level_ver)}/) }
+    @version = top_level_ver #with a wildcard/x
+    @versions = @aggregated_versions = gem_data.versions.select{|v| v.match(/^#{Regexp.escape(remove_trailing_x(top_level_ver))}/) }
     super(gem_name, @aggregated_versions)
   end
 
@@ -16,29 +24,29 @@ class AggregatedVelocitator < BaseVelocitator
     base_max_for(@aggregated_versions) * @aggregated_versions.size
   end
 
-  def graph_options
-    opts = {
-      :title => title,
-      :labels => ({1 => time_format_str_small(effective_start_time), (line_datas.first.size-2) => time_format_str_small(effective_end_time) }),
-      :max_value => effective_max_value,
-      :min_value => effective_min_value,
-      :line_datas => line_datas,
-      :hide_legend => true
-    }
-  end
+  def line_data(start_t = nil, end_t = nil)
+    range = nil
+    if start_t && end_t
+      range = compute_day_range_from_start_end(start_t,end_t)
+    else
+      range = effective_days_in_range
+    end
 
-  def line_datas
     ret = Hash.new(0)
     @aggregated_versions.each do |v|
-      effective_days_in_range.each do |d|
+      range.each do |d|
         ret[d] += downloads_per_day(v)[d] || 0
       end
     end
-    [effective_days_in_range.map{|d| ret[d] }]
+    range.map{|d| ret[d] }
   end
 
   def title
-    "#{@gem_name}: #{@top_level_ver}X\n(downloads: #{num_downloads})"
+    "#{@gem_name}: #{@version}\n(downloads: #{num_downloads})"
+  end
+
+  def hide_legend?
+    true
   end
 
 end

data/lib/gem_velocity/velocitators/base_velocitator.rb

@@ -10,9 +10,27 @@ class BaseVelocitator
 
   attr_accessor :gem_name, :versions
 
-  def graph(root_arg = nil, range = nil, min = nil, max = nil)
+  def self.create(options)
+    Factory.new(options).velocitator
+  end
+
+  def graph(root_arg = root, range = effective_date_range, min = effective_min_value, max = effective_max_value)
     set_overwritable_attrs(root_arg,range,min,max)
-    gruff_builder.write
+    file = gruff_builder(root, graph_options).write
+    puts "Wrote graph to #{file}"
+    file
+  end
+
+  def graph_options
+    opts = {
+      :title => title,
+      :labels => ({1 => time_format_str_small(effective_start_time), (line_datas.first.size-2) => time_format_str_small(effective_end_time) }),
+      :max_value => effective_max_value,
+      :min_value => effective_min_value,
+      :line_datas => line_datas,
+      :hide_legend => hide_legend?,
+      :type => self.class.to_s
+    }
   end
 
   # modifiers on the end result image being rendered. Essentially these are the boundries
@@ -25,6 +43,13 @@ class BaseVelocitator
 
   def effective_date_range
     @passed_date_range || default_date_range
+  end 
+  # some sugar
+  def effective_start_time; effective_date_range.first ;end
+  def effective_end_time; effective_date_range.last ;end
+
+  def effective_days_in_range
+    compute_day_range_from_start_end(effective_start_time,effective_end_time)
   end
 
   def effective_max_value
@@ -46,6 +71,11 @@ class BaseVelocitator
     ActiveSupport::NumberHelper.number_to_delimited(sum)
   end
 
+  def time_built(version)
+    gem_data.versions_built_at[version]
+  end
+  alias :built_at :time_built
+
   private
 
   def initialize(gem_name, versions)
@@ -57,7 +87,7 @@ class BaseVelocitator
 
   def validate_correct_versions
     versions.each do |v|
-      gem_data.versions.include?(v) || raise(NoSuchVersion,"version not found for #{versions}.")
+      gem_data.versions.include?(v) || raise(NoSuchVersion,"version #{v} not found for #{gem_name}.")
     end
   end
 
@@ -85,12 +115,14 @@ class BaseVelocitator
     0
   end
 
-  def default_line_datas
-    versions.map do |v|
-      effective_days_in_range.map do |d|
-        downloads_per_day(v)[d] || 0
-      end
-    end
+  def line_datas
+    # aggregated and single are both just one, just line_data, but default to this
+    # because of the multiplexer, since it does have line_datas
+    [line_data]
+  end
+
+  def versions_for_legends
+    [version]
   end
 
   def base_earliest_time_for(verzionz)
@@ -106,11 +138,7 @@ class BaseVelocitator
     totals.flatten.compact.max
   end
 
-  def downloads_per_day(version)
-    # returns # "2013-10-10" => 45
-    accumulated_downloads_per_day(version)
-  end
-
+  # returns # "2013-10-10" => 45
   def accumulated_downloads_per_day(version)
     # downloads_metadata comes back ordered by date
     ret = Hash.new(0)
@@ -123,37 +151,15 @@ class BaseVelocitator
     end
     ret
   end
-
-  # a little sugar
-  def effective_start_time; effective_date_range.first ;end
-  def effective_end_time; effective_date_range.last ;end
-
-  # helper method to convert [start,end] into a 
-  # start..end range of days like "2013-10-10"
-  def effective_days_in_range
-    all_days = []
-    s = Date.parse(effective_start_time)
-    e = Date.parse(effective_end_time)
-    i = s
-    while (i <= e )
-      all_days << i
-      i += 1.day
-    end
-    all_days.map{|d| time_format_str_small(d)}
-  end
+  alias :downloads_per_day :accumulated_downloads_per_day
 
   def gem_data
     # need this memoized so the gem_data memoization works for the same instance
     @gem_data ||= GemData.new(@gem_name)
   end
 
-  def gruff_builder
-    GruffBuilder.new(@root || Dir.pwd,nil,versions,gem_name,graph_options)
+  def gruff_builder(path,graph_opts)
+    GruffBuilder.new(path || Dir.pwd, nil, versions_for_legends, gem_name, graph_opts)
   end
 
-  # it's just shorter syntax
-  def time_built(version)
-    gem_data.versions_built_at[version]
-  end
- 
 end

data/lib/gem_velocity/velocitators/factory.rb

@@ -0,0 +1,52 @@
+class Factory
+
+  include Helpers
+
+  attr_reader :gem_name, :version, :versions, :type
+
+  def initialize(options)
+
+    # one ver passed
+    if options[:gem_name] && options[:version]
+      @gem_name = options[:gem_name]
+      @version = options[:version]
+      @type = type_from_version(@version)
+      @versions = self.velocitator.versions
+    elsif options[:full_name]
+      @gem_name = name_from_full_name(options[:full_name])
+      @version = version_from_full_name(options[:full_name])
+      @type = type_from_version(@version)
+      @versions = self.velocitator.versions
+    end
+  end
+
+  def velocitator
+    if @type == :aggregated
+      AggregatedVelocitator.new(@gem_name, @version)
+    elsif @type == :single
+      SingleVelocitator.new(@gem_name, @version)
+    else
+      raise 'no velocitor found to generate!'
+    end
+  end
+
+  private
+
+  def name_from_full_name(str)
+    str.split("-")[0..-2].join("-")
+  end
+
+  def version_from_full_name(str)
+    str.split("-").last
+  end
+
+  def type_from_version(str)
+    if str.last.downcase == "x"
+      :aggregated
+    else
+      :single
+    end
+  end
+
+end
+

data/lib/gem_velocity/velocitators/multiplexer.rb

@@ -0,0 +1,65 @@
+class Multiplexer < BaseVelocitator
+
+  include ::Helpers
+  attr_reader :velocitators
+
+  def initialize(velocitators)
+    @velocitators = velocitators
+    # TODO what if there are multiple gem_names being multiplexed?
+    super(velocitators.first.gem_name, velocitators.map(&:versions).flatten)
+  end
+
+  def version
+    raise "The multiplexer does not have a single version. try @versions."
+  end
+
+  def root
+    velocitator_with_root = velocitators.detect{|v| v.root }
+    if velocitator_with_root
+      velocitator_with_root.root
+    else
+      Dir.pwd
+    end
+  end
+
+  def default_start
+    earliest_for(velocitators.map(&:effective_start_time))
+  end
+
+  def effective_end_time
+    latest_for(velocitators.map(&:effective_end_time))
+  end
+
+  def effective_min_value
+    velocitators.map(&:effective_min_value).min
+  end
+
+  def effective_max_value
+    velocitators.map(&:effective_max_value).max
+  end
+
+  def line_datas
+    velocitators.map do |velocitator|
+      velocitator.line_data(effective_start_time, effective_end_time)
+    end
+  end
+
+  def hide_legend?
+    false
+  end
+
+  def versions_for_legends
+    velocitators.map(&:version)
+  end
+
+  def title
+    "Composite: #{gem_names}"
+  end
+
+  private
+
+  def gem_names
+    velocitators.map(&:gem_name).sort.uniq.join(" ")
+  end
+
+end

data/lib/gem_velocity/velocitators/single_velocitator.rb

@@ -1,5 +1,7 @@
 class SingleVelocitator < BaseVelocitator
 
+  # the one passed in
+  # for :versions, it's just [version]
   attr_reader :version
 
   def initialize(gem_name, version)
@@ -19,24 +21,30 @@ class SingleVelocitator < BaseVelocitator
     accumulated_downloads_per_day(@version).map {|day,total| total}.max
   end
 
-  def graph_options
-    opts = {
-      :title => title,
-      # todo change the -2 to -4? so if ifits in? if it's abvoe 4 fcors
-      :labels => ({1 => time_format_str_small(effective_start_time), (line_datas.first.size-2) => time_format_str_small(effective_end_time) }),
-      :max_value => effective_max_value,
-      :min_value => effective_min_value,
-      :line_datas => line_datas,
-      :hide_legend => true
-    }
-  end
-
-  def line_datas
-    default_line_datas
+  def line_data(start_t = nil, end_t = nil)
+    range = nil
+    if start_t && end_t
+      range = compute_day_range_from_start_end(start_t,end_t)
+    else
+      range = effective_days_in_range
+    end
+
+    range.map do |d|
+      downloads_per_day(version)[d] || 0
+    end
   end
 
   def title
     "#{gem_name}-#{version}\n(downloads: #{num_downloads})"
   end
 
+  def time_built
+    super(@version)
+  end
+
+  def hide_legend?
+    true
+  end
+
+
 end

data/lib/gem_velocity/version.rb

@@ -1,3 +1,3 @@
 module GemVelocity
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end