gem_velocity 0.0.4 → 0.0.5

data/TODO

@@ -16,3 +16,14 @@ I want to be able to have a line be one version, or a few versions in one, mix t
   line_datas needs to be abstracted away. actually the versions concepts should be eliminated??
     so I need to have something abstract a version but it could be a few of them...
       move all the logic of changing version -> line_data into something and have that able to handle 1 or n.
+
+      the only thing that it implmeents is .graph() which returns the line_data result/info whatever.
+      then there's something in the middle that takes that and calls out to gruff builder.
+
+
+all derived classes need to pass back to base class, so we can pass on to builder:
+
+  line_data => title,version(s) 
+  n times whatever.
+
+  Add a Version?

data/lib/gem_velocity/velocitators/all.rb

@@ -0,0 +1,3 @@
+require "gem_velocity/velocitators/base_velocitator"
+require "gem_velocity/velocitators/single_velocitator"
+require "gem_velocity/velocitators/multiple_velocitator"

data/lib/gem_velocity/velocitators/base_velocitator.rb

@@ -0,0 +1,113 @@
+begin
+  require 'active_support/all'
+rescue
+  'you need activesupport. please install'
+end
+
+class BaseVelocitator
+
+  include ::Helpers
+
+  attr_accessor :gem_name, :versions
+
+  def graph(root_arg = nil, range = nil, min = nil, max = nil)
+    set_overwritable_attrs(root_arg,range,min,max)
+    gruff_builder.write
+  end
+
+  # modifiers on the end result image being rendered.
+  attr_reader :date_range, :max_value, :min_value, :root
+  def date_range=(args); @date_range = args && args.map{|t| time_format_str(t) } ;end
+  def max_value=(max); @max_value = max ;end
+  def min_value=(min); @min_value = min ;end
+  def root=(path); @root = path ;end
+
+  def effective_date_range
+    @date_range || [ default_start, default_end ]
+  end
+
+  private
+
+  def initialize(gem_name, versions)
+    @gem_name = gem_name || raise(ArgumentError, 'need a name')
+    @versions = versions || raise(ArgumentError, 'required versions')
+    validate_correct_gem
+    validate_correct_versions
+  end
+
+  def validate_correct_versions
+    versions.each do |v|
+      gem_data.versions.include?(v) || raise(NoSuchVersion,"version not found for #{versions}.")
+    end
+  end
+
+  def validate_correct_gem
+    # this will bomb out if bad version is passed.
+    gem_data.versions_metadata
+  end
+
+   # if it's nil, the defaults will be used
+  # basically these are the graph boundries
+  def set_overwritable_attrs(root_arg,range,min,max)
+    self.date_range = range
+    self.root = root_arg
+    self.max_value = max
+    self.min_value = min
+  end
+
+  def default_end
+    default_end = time_format_str(Time.now)
+  end
+
+  def default_min_value
+    0
+  end
+
+  def default_line_datas
+    # refactor me?
+    versions.map do |v|
+      specific_days_in_range.map do |day_in_range|
+        day_in_range = time_format_str_small(day_in_range) #conform to rubygems api format
+        if gem_data.downloads_day(v).map {|day,total| day}.include?(day_in_range)
+          # get the total for that day
+          total = Hash[gem_data.downloads_day(v)][day_in_range]
+        else
+          0
+        end
+      end
+    end
+  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 day instances
+  def specific_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
+  end
+
+  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)
+  end
+
+  # it's just shorter syntax
+  def time_built(version)
+    gem_data.versions_built_at[version]
+  end
+ 
+end

data/lib/gem_velocity/velocitators/multiple_velocitator.rb

@@ -0,0 +1,39 @@
+class MultipleVelocitator < BaseVelocitator
+
+  def initialize(gem_name, versions)
+    super(gem_name, versions)
+  end
+
+  def default_start
+    earliest_start = versions.map{|v| Date.parse(time_built(v)) }.min
+    default_start = time_format_str(earliest_start)
+  end
+
+  def default_max_value
+    totals = []
+    versions.each {|v|
+      totals << gem_data.downloads_day(v).map {|day,total| total}
+    }
+    totals.flatten.compact.max
+  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 => max_value || default_max_value,
+      :min_value => min_value || default_min_value,
+      :line_datas => line_datas
+    }
+  end
+
+  def line_datas
+    default_line_datas
+  end
+
+  def title
+    "MutlipleVelocitator:#{gem_name}"
+  end
+
+
+end

data/lib/gem_velocity/velocitators/single_velocitator.rb

@@ -0,0 +1,34 @@
+class SingleVelocitator < BaseVelocitator
+
+  def initialize(gem_name, version)
+    @version = version
+    super(gem_name, [version])
+  end
+
+  def default_start
+    time_format_str(Date.parse(time_built(@version)))
+  end
+
+  def default_max_value
+    gem_data.downloads_day(@version).map {|day,total| total}.max
+  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 => max_value || default_max_value,
+      :min_value => min_value || default_min_value,
+      :line_datas => line_datas
+    }
+  end
+
+  def line_datas
+    default_line_datas
+  end
+
+  def title
+    "SingleVelocitator:#{gem_name}"
+  end
+
+end

data/lib/gem_velocity/version.rb

@@ -1,3 +1,3 @@
 module GemVelocity
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/gem_velocity.rb

@@ -2,7 +2,7 @@ require "gem_velocity/version"
 require "gem_velocity/helpers"
 require "gem_velocity/gem_data"
 require "gem_velocity/gruff_builder"
-require "gem_velocity/velocitator"
+require "gem_velocity/velocitators/all"
 require "gem_velocity/errors"
 
 require 'active_support/all'

data/spec/gruff_builder_spec.rb

@@ -30,7 +30,7 @@ describe GruffBuilder do
 
   it "can not write a file if there is no line data" do
     builder = GruffBuilder.new(@tmp_dir,nil,["0.0.17"],"foo-baz", {})
-    lambda { builder.write }.should raise_error GruffBuilder::NoData
+    lambda { builder.write }.should raise_error NoData
   end
 
   it "can write out a file" do

data/spec/velocitator_spec.rb

@@ -1,124 +1,119 @@
 require 'spec_helper'
 
-describe Velocitator do
+describe SingleVelocitator do
 
   it 'raises if you dont pass name and version(s)' do
-    lambda { Velocitator.new(nil,nil) }.should raise_error ArgumentError
+    lambda { SingleVelocitator.new(nil,nil) }.should raise_error ArgumentError
   end
 
   it 'raises if the gem is not found' do
-    lambda { Velocitator.new("NOSICHGEMPlZ123","0.1") }.should raise_error NoSuchGem
+    lambda { SingleVelocitator.new("NOSICHGEMPlZ123","0.1") }.should raise_error NoSuchGem
   end
 
   it 'raises if the version is not found' do
-    # cause the .pre matters!!1
-    lambda { Velocitator.new("haml-i18n-extractor","100.999.42.666.pre") }.should raise_error NoSuchVersion
-  end
-
- describe "a specific version" do
-
-    it "sets a specific date range according to the gem's info" do
-      velocitator = Velocitator.new("haml-i18n-extractor", "0.0.17")
-      velocitator.effective_date_range.should eq ["2013-06-16T00:00:00Z", "2013-09-20T00:00:00Z"]
-    end
-
-    it "can override the default time ranges if its in the range" do
-      velocitator = Velocitator.new("haml-i18n-extractor", "0.0.17")
-      velocitator.date_range = [1.day.ago, Time.now]
-      velocitator.effective_date_range.should eq ["2013-09-19T00:00:00Z", "2013-09-20T00:00:00Z"]
-      velocitator.line_datas.size.should eq (velocitator.versions.size)
-    end
-
-    it "can set a max and min" do
-      velocitator = Velocitator.new("haml-i18n-extractor", "0.0.17")
-      lambda {
-        velocitator.max_value = 500
-        velocitator.min_value = 10
-      }.should_not raise_error
-    end
-
-    it "can render a graph" do
-      velocitator = Velocitator.new("haml-i18n-extractor", "0.0.17")
-      velocitator.date_range = [1.day.ago, Time.now]
-      velocitator.root = SpecHelper.tmpdir
-      builder = velocitator.gruff_builder
-
-      # FIXME
-      # also, pending on issue relating to
-      # https://github.com/shaiguitar/rubygems.org/compare/api_not_returning_all_results_over_90_days?expand=1
-      builder.line_datas.should == [[343, 344]]
-      builder.title.should == "haml-i18n-extractor-0.0.17"
-      builder.labels.should == ({1=>"2013-09-19", (builder.line_datas.first.size-2) =>"2013-09-20"})
-      builder.max_value.should == 344
-      builder.min_value.should == 0
-
-      file = builder.write
-      File.exist?(file).should be_true
-      #`open #{file} -a preview.app`
-      #Kernel.sleep(10)
-    end
-
-    it "has a shortcut graph method #1" do
-      velocitator = Velocitator.new("haml-i18n-extractor", "0.0.17")
-      file = velocitator.graph(SpecHelper.tmpdir,[1.day.ago, Time.now])
-      File.exist?(file).should be_true
-    end
-
-    it "has a shortcut graph method #2" do
-      velocitator = Velocitator.new("haml-i18n-extractor", "0.0.17")
-      file = velocitator.graph
-      File.exist?(file).should be_true
-    end
-
-    it "has a shortcut graph metho #3" do
-      velocitator = Velocitator.new("haml-i18n-extractor", "0.0.17")
-      file = velocitator.graph(nil,nil,0,1000)
-      File.exist?(file).should be_true
-    end
-
-  end
-
-  describe "Multiple versions" do
-    before do 
-      @some_versions = ["0.0.17", "0.0.5","0.0.10"]
-    end
-
-    it "can initialize multiple versions" do
-      velocitator = Velocitator.new("haml-i18n-extractor", @some_versions)
-      velocitator.versions.should == @some_versions
-    end
-
-    it "sets the earliest start range from to all of the versions info" do
-      # some_versions.map{|v| GemData.new("haml-i18n-extractor").versions_built_at[v]}
-      # => ["2013-06-16T00:00:00Z", "2013-03-22T00:00:00Z", "2013-05-06T00:00:00Z"]
-      velocitator = Velocitator.new("haml-i18n-extractor", @some_versions)
-      velocitator.effective_date_range.should eq ["2013-03-22T00:00:00Z", "2013-09-20T00:00:00Z"]
-    end
-
-    it "sets the max value to the max of all of versions" do
-      velocitator = Velocitator.new("haml-i18n-extractor", @some_versions)
-      velocitator.default_max_value.should eq 344
-    end
-
-    it "sets the max value to the max of all of versions" do
-      velocitator = Velocitator.new("haml-i18n-extractor", @some_versions)
-      velocitator.default_max_value.should eq 344
-    end
-
-    it "should set the line data to an array of versions.size with equal length which should be the max value of any one of them" do
-      velocitator = Velocitator.new("haml-i18n-extractor", @some_versions)
-      velocitator.line_datas.size.should == @some_versions.size
-      # all of them should be the same size, padded with 0's if there is no download info
-      velocitator.line_datas.map{|d| d.size }.uniq.size.should == 1
-    end
-
-    it "has a shortcut graph method" do
-      velocitator = Velocitator.new("haml-i18n-extractor", @some_versions)
-      file = velocitator.graph
-      File.exist?(file).should be_true
-    end
+    lambda { SingleVelocitator.new("haml-i18n-extractor","100.999.42.666.pre") }.should raise_error NoSuchVersion
   end
 
+  it "sets a specific date range according to the gem's info" do
+    velocitator = SingleVelocitator.new("haml-i18n-extractor", "0.0.17")
+    velocitator.effective_date_range.should eq ["2013-06-16T00:00:00Z", "2013-09-20T00:00:00Z"]
+  end
+
+  it "can override the default time ranges if its in the range" do
+    velocitator = SingleVelocitator.new("haml-i18n-extractor", "0.0.17")
+    velocitator.date_range = [1.day.ago, Time.now]
+    velocitator.effective_date_range.should eq ["2013-09-19T00:00:00Z", "2013-09-20T00:00:00Z"]
+  end
+
+  it "can override a max and min" do
+    velocitator = SingleVelocitator.new("haml-i18n-extractor", "0.0.17")
+    lambda {
+      velocitator.max_value = 500
+      velocitator.min_value = 10
+    }.should_not raise_error
+  end
+
+  it "has line datas" do
+    velocitator = SingleVelocitator.new("haml-i18n-extractor", "0.0.17")
+    velocitator.line_datas.size.should eq (velocitator.versions.size)
+  end
 
+  it "can render a graph" do
+    velocitator = SingleVelocitator.new("haml-i18n-extractor", "0.0.17")
+    velocitator.date_range = [1.day.ago, Time.now]
+    velocitator.root = SpecHelper.tmpdir
+    # FIX spec don't call out to gruff_builder, check the specific attrs in graph_options or such.
+    builder = velocitator.gruff_builder
+    # https://github.com/shaiguitar/rubygems.org/compare/api_not_returning_all_results_over_90_days?expand=1
+    builder.line_datas.should == [[343, 344]]
+    builder.title.should == "haml-i18n-extractor-0.0.17"
+    builder.labels.should == ({1=>"2013-09-19", (builder.line_datas.first.size-2) =>"2013-09-20"})
+    builder.max_value.should == 344
+    builder.min_value.should == 0
+
+    file = builder.write
+    File.exist?(file).should be_true
+    #`open #{file} -a preview.app`
+    #Kernel.sleep(10)
+  end
+
+  it "has a shortcut graph method #1" do
+    velocitator = SingleVelocitator.new("haml-i18n-extractor", "0.0.17")
+    file = velocitator.graph(SpecHelper.tmpdir,[1.day.ago, Time.now])
+    File.exist?(file).should be_true
+  end
+
+  it "has a shortcut graph method #2" do
+    velocitator = SingleVelocitator.new("haml-i18n-extractor", "0.0.17")
+    file = velocitator.graph
+    File.exist?(file).should be_true
+  end
+
+  it "has a shortcut graph metho #3" do
+    velocitator = SingleVelocitator.new("haml-i18n-extractor", "0.0.17")
+    file = velocitator.graph(nil,nil,0,1000)
+    File.exist?(file).should be_true
+  end
+end
+
+describe MultipleVelocitator do
+  before do 
+    @some_versions = ["0.0.17", "0.0.5","0.0.10"]
+  end
+
+  it "can initialize multiple versions" do
+    velocitator = MultipleVelocitator.new("haml-i18n-extractor", @some_versions)
+    velocitator.versions.should == @some_versions
+  end
+
+  it "sets the earliest start range from to all of the versions info" do
+    # some_versions.map{|v| GemData.new("haml-i18n-extractor").versions_built_at[v]}
+    # => ["2013-06-16T00:00:00Z", "2013-03-22T00:00:00Z", "2013-05-06T00:00:00Z"]
+    velocitator = MultipleVelocitator.new("haml-i18n-extractor", @some_versions)
+    velocitator.effective_date_range.should eq ["2013-03-22T00:00:00Z", "2013-09-20T00:00:00Z"]
+  end
+
+  it "sets the max value to the max of all of versions" do
+    velocitator = MultipleVelocitator.new("haml-i18n-extractor", @some_versions)
+    velocitator.default_max_value.should eq 344
+  end
+
+  it "sets the max value to the max of all of versions" do
+    velocitator = MultipleVelocitator.new("haml-i18n-extractor", @some_versions)
+    velocitator.default_max_value.should eq 344
+  end
+
+  it "should set the line data to an array of versions.size with equal length which should be the max value of any one of them" do
+    velocitator = MultipleVelocitator.new("haml-i18n-extractor", @some_versions)
+    velocitator.line_datas.size.should == @some_versions.size
+    # all of them should be the same size, padded with 0's if there is no download info
+    velocitator.line_datas.map{|d| d.size }.uniq.size.should == 1
+  end
+
+  it "has a shortcut graph method" do
+    velocitator = MultipleVelocitator.new("haml-i18n-extractor", @some_versions)
+    file = velocitator.graph
+    File.exist?(file).should be_true
+  end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gem_velocity
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Shai Rosenfeld
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-10-11 00:00:00 Z
+date: 2013-10-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: gruff
@@ -211,7 +211,10 @@ files:
 - lib/gem_velocity/gem_data.rb
 - lib/gem_velocity/gruff_builder.rb
 - lib/gem_velocity/helpers.rb
-- lib/gem_velocity/velocitator.rb
+- lib/gem_velocity/velocitators/all.rb
+- lib/gem_velocity/velocitators/base_velocitator.rb
+- lib/gem_velocity/velocitators/multiple_velocitator.rb
+- lib/gem_velocity/velocitators/single_velocitator.rb
 - lib/gem_velocity/version.rb
 - spec/gem_data_spec.rb
 - spec/gruff_builder_spec.rb

data/lib/gem_velocity/velocitator.rb

@@ -1,154 +0,0 @@
-begin
-  require 'active_support/all'
-rescue
-  'you need activesupport. please install'
-end
-
-class Velocitator
-
-  include ::Helpers
-
-  attr_accessor :gem_name, :versions
-
-  # modifiers on the end result image being rendered.
-  attr_accessor :date_range, :max_value, :min_value, :root
-
-  def initialize(gem_name, versions)
-    @gem_name = gem_name || raise(ArgumentError, 'need a name')
-    @versions = if versions.is_a?(String)
-                  [versions]
-                else
-                  versions
-                end || raise(ArgumentError, 'required versions')
-    validate_correct_gem
-    validate_correct_versions
-  end
-
-  def date_range=(args)
-    return nil if args.nil?
-    unless args.is_a?(Array) && args.size == 2
-      raise(ArgumentError, "must pass a range with time objects like [start,end]")
-    end
-    @date_range = args.map{|t| time_format_str(t) }
-  end
-
-  def effective_date_range
-    # we allow overwriting by passing a date range.
-    if @date_range.is_a?(Array) && @date_range.compact.size==2
-      @date_range
-    else
-      default_date_range
-    end
-  end
-
-  def title
-    "#{gem_name}-#{versions.join("-")}"
-  end
-
-  def line_datas
-    versions.map do |v|
-      specific_days_in_range.map do |day_in_range|
-        day_in_range = time_format_str_small(day_in_range) #conform to rubygems api format
-        if gem_data.downloads_day(v).map {|day,total| day}.include?(day_in_range)
-          total = Hash[gem_data.downloads_day(v)][day_in_range]
-        else
-          0
-        end
-      end
-    end
-  end
-
-  # after you set all the attributes you want.
-  # you can set (or there will be fallback defaults)
-  # max, min
-  # date_range (leave nil for default values in either start or end)
-  def gruff_builder
-    opts = {
-      :title => title,
-      # just the first and last dates. give a small offset so it fits into the pciture.
-      # line_datas.first.size -2 should be the max of any one of the line-datas, all should be same size.
-      :labels => ({1 => time_format_str_small(effective_start_time), (line_datas.first.size-2) => time_format_str_small(effective_end_time) }),
-      :max_value => max_value || default_max_value,
-      :min_value => min_value || default_min_value,
-      :line_datas => line_datas
-    }
-    builder = GruffBuilder.new(@root || Dir.pwd,nil,versions,gem_name,opts)
-    builder
-  end
-
-  def graph(root_arg = nil, range = nil, min = nil, max = nil)
-    # if nil, defaults will be used
-    self.date_range = range
-    self.root = root_arg
-    self.max_value = max
-    self.min_value = min
-    gruff_builder.write
-  end
-
-  def specific_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
-  end
-
-  def default_min_value
-    0
-  end
-
-  def default_max_value
-    totals = []
-    versions.each {|v|
-      totals << gem_data.downloads_day(v).map {|day,total| total}
-    }
-    totals.flatten.compact.max
-  end
-
-  private
-
-  def effective_start_time
-    effective_date_range.first
-  end
-
-  def effective_end_time
-    effective_date_range.last
-  end
-
-  def default_date_range
-    range = default_start, default_end
-  end
-
-  def default_start
-    earliest_start = versions.map{|v| Date.parse(time_built(v)) }.min
-    default_start = time_format_str(earliest_start)
-  end
-
-  def default_end
-    default_end = time_format_str(Time.now)
-  end
-
-  def time_built(version)
-    gem_data.versions_built_at[version]
-  end
-
-  def gem_data
-    @gem_data ||= GemData.new(@gem_name)
-  end
-
-  def validate_correct_versions
-    versions.each do |v|
-      gem_data.versions.include?(v) || raise(NoSuchVersion,"version not found for #{versions}.")
-    end
-  end
-
-  def validate_correct_gem
-    # this will bomb out if bad version is passed.
-    gem_data.versions_metadata
-  end
-
-end