graphite_builder 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "minitest", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    minitest (2.6.1)
+    rake (0.9.2)
+    rcov (0.9.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  minitest
+  rcov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Edward Muller
+
+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.

data/README.rdoc

@@ -0,0 +1,19 @@
+= graphite_builder
+
+Description goes here.
+
+== Contributing to graphite_builder
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Edward Muller. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "graphite_builder"
+  gem.homepage = "http://github.com/freeformz/graphite_builder"
+  gem.license = "MIT"
+  gem.summary = %q{A DSL: for generating graphite graph urls.}
+  gem.description =  %q{A DSL for generating graphite graph urls. Meant to enable copy-and-paste from the graphite UI + simple substitution.}
+  gem.email = "edward@heroku.com"
+  gem.authors = ["Edward Muller"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "graphite_builder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/graphite_builder.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{graphite_builder}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Edward Muller}]
+  s.date = %q{2011-10-11}
+  s.description = %q{A DSL for generating graphite graph urls. Meant to enable copy-and-paste from the graphite UI + simple substitution.}
+  s.email = %q{edward@heroku.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "graphite_builder.gemspec",
+    "lib/graphite_builder.rb",
+    "test/helper.rb",
+    "test/test_graphite_builder.rb"
+  ]
+  s.homepage = %q{http://github.com/freeformz/graphite_builder}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{A DSL: for generating graphite graph urls.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/graphite_builder.rb

@@ -0,0 +1,107 @@
+require 'uri'
+require 'cgi'
+
+module Graphite
+
+  # Encapsulates a small DSL for enabling the cut-n-paste of data from the graphite UI and interpolating/
+  # modifying them for inclusion in a server side template
+  class Builder
+
+    # Raised when no targets are defined for a graph and #render is called
+    class NoTargetsDefined < RuntimeError; end
+
+    # Raised when we don't understand the function signature
+    # i.e. the user did something wrong or we need to implement the
+    # specific function signature
+    class UnknownFunctionSignature < RuntimeError; end
+
+    def initialize(opts=nil, &block)
+      @args = {}
+      @targets = []
+      data opts
+      @args[:base_url] = @data.delete(:base_url) if @data[:base_url]
+      if block
+        self.instance_eval(&block)
+      end
+    end
+
+    def target(value)
+      @targets << value
+    end
+
+    def data(opts=nil)
+      case opts
+      when Hash, Array
+        @data = opts
+      when String, Symbol, Fixnum
+        @data[opts]
+      when NilClass
+        @data
+      else
+        raise RuntimeError.new("Unknown options: #{opts}")
+      end
+    end
+
+    def sumSeries(*args)
+      array_argument_wrapper('sumSeries', args)
+    end
+
+    def asPercent(is, of)
+      array_argument_wrapper('asPercent', is, of)
+    end
+
+    def secondYAxis(arg)
+      single_argument_wrapper('secondYAxis',arg)
+    end
+
+    def stacked(arg)
+      single_argument_wrapper('stacked',arg)
+    end
+
+    def method_missing(meth,*args,&block)
+      if args.length == 2
+        if meth == :legend
+          meth = :alias
+        end
+        quoted_array_argument_wrapper(meth, args)
+      elsif args.length == 1
+        @args[meth.to_sym] = args.first
+      else
+        raise ::Graphite::Builder::UnknownFunctionSignature.new("#{meth}(#{args.join(',')})")
+      end
+    end
+
+    def render
+      raise ::Graphite::Builder::NoTargetsDefined.new if @targets.empty?
+      '<img src="' <<
+      @args.delete(:base_url) << '?' <<
+        (@args.map do |k ,v|
+          if v.is_a?(Array)
+            v.map { |item| url_param(k, item) }.join("&")
+          else
+            url_param(k, v)
+          end
+        end + @targets.map {|target| "target=#{target}" }).join('&') << '"/>'
+    end
+
+    private
+
+    def single_argument_wrapper(meth, arg)
+      "#{meth}(#{arg})"
+    end
+
+    def array_argument_wrapper(meth, *args)
+      "#{meth}(#{args.join(",")})"
+    end
+
+    def quoted_array_argument_wrapper(meth, *args)
+      args = args[0] if args[0].is_a? Array
+      "#{meth}(#{args.shift},#{args.map { |a| "'#{CGI::escape(a.to_s)}'"}.join(',')})"
+    end
+
+    def url_param(param, value)
+      "#{URI.escape(param.to_s)}=#{CGI::escape(value.to_s)}"
+    end
+
+  end
+end

data/test/helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest/spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'graphite_builder'
+
+class MiniTest::Unit::TestCase
+end
+
+MiniTest::Unit.autorun

data/test/test_graphite_builder.rb

@@ -0,0 +1,182 @@
+require 'helper'
+
+describe Graphite::Builder do
+
+  describe 'when initialized with a block' do
+
+    describe '#render' do
+
+      describe 'when no targets are defined' do
+        it 'should raise a NoTargetsDefined error' do
+          Proc.new do
+            Graphite::Builder.new(base_url: 'http://foo.bar/render', foo: :bar) do
+              width 800
+            end.render
+          end.must_raise Graphite::Builder::NoTargetsDefined
+        end
+      end
+
+      describe 'when a target is defined' do
+
+        describe 'whithout using data' do
+          it 'should render the correct <img/> tag' do
+            Graphite::Builder.new(base_url: 'http://localhost/render', foo: :bar) do
+              target '1.2.3'
+            end.render.must_equal '<img src="http://localhost/render?target=1.2.3"/>'
+          end
+        end
+
+        describe 'using data' do
+          it 'should render the correct <img/> tag' do
+            Graphite::Builder.new(base_url: 'http://localhost/render', foo: :bar) do
+              target data :foo
+              target "#{data :foo}.stuff"
+            end.render.must_equal '<img src="http://localhost/render?target=bar&target=bar.stuff"/>'
+          end
+
+          describe 'setting params' do
+
+            it 'should render the correct <img/> tag' do
+              Graphite::Builder.new(base_url: 'http://localhost/render', foo: :bar) do
+                width 800
+                height 200
+                target 'a.b.c'
+              end.render.must_equal "<img src=\"http://localhost/render?width=800&height=200&target=a.b.c\"/>"
+            end
+          end
+
+          describe 'and applying a "function"' do
+            it 'should render the correct <img/> tag' do
+              Graphite::Builder.new(base_url: 'http://localhost/render', foo: :bar) do
+                target data :foo
+                target color("#{data :foo}.stuff", 'red')
+              end.render.must_equal "<img src=\"http://localhost/render?target=bar&target=color(bar.stuff,'red')\"/>"
+            end
+          end
+
+          describe 'and nesting functions' do
+            it 'should render the correct <img/> tag' do
+              Graphite::Builder.new(base_url: 'http://localhost/render', foo: :bar) do
+                target data :foo
+                target legend(color("#{data :foo}.stuff", 'red'), 'foozle')
+              end.render.must_equal "<img src=\"http://localhost/render?target=bar&target=alias(color(bar.stuff,'red'),'foozle')\"/>"
+            end
+          end
+
+        end
+
+      end
+
+      describe 'DSL functions' do
+
+        describe 'sumSeries' do
+
+          describe 'with a single data point' do
+            it 'should render the correct <img/> tag' do
+              Graphite::Builder.new(base_url: 'http://localhost/render', foo: :bar) do
+                target sumSeries('a.b.*')
+              end.render.must_equal "<img src=\"http://localhost/render?target=sumSeries(a.b.*)\"/>"
+            end
+          end
+
+          describe 'with multiple data points' do
+            it 'should render the correct <img/> tag' do
+              Graphite::Builder.new(base_url: 'http://localhost/render', foo: :bar) do
+                target sumSeries('a.b.*','a.c.*','a.d.*')
+              end.render.must_equal "<img src=\"http://localhost/render?target=sumSeries(a.b.*,a.c.*,a.d.*)\"/>"
+            end
+          end
+        end
+
+        describe 'asPercent' do
+
+          describe 'with a single argument' do
+            it 'should raise an ArgumentError' do
+              Proc.new do
+                Graphite::Builder.new(base_url: 'http://localhost/render', foo: :bar) do
+                  target asPercent(1)
+                end.render
+              end.must_raise ArgumentError
+            end
+          end
+
+          describe 'with two arguments' do
+            it 'should render the correct <img/> tag' do
+              Graphite::Builder.new(base_url: 'http://localhost/render', foo: :bar) do
+                target asPercent('a.b.c','a.c.b')
+              end.render.must_equal "<img src=\"http://localhost/render?target=asPercent(a.b.c,a.c.b)\"/>"
+            end
+          end
+        end
+
+        describe 'secondYAxis' do
+
+          describe 'with a single argument' do
+            it 'should render the correct <img/> tag' do
+              Graphite::Builder.new(base_url: 'http://localhost/render', foo: :bar) do
+                target secondYAxis('a.b.c')
+              end.render.must_equal "<img src=\"http://localhost/render?target=secondYAxis(a.b.c)\"/>"
+            end
+          end
+
+        end
+
+        describe 'stacked' do
+
+          describe 'with a single argument' do
+            it 'should render the correct <img/> tag' do
+              Graphite::Builder.new(base_url: 'http://localhost/render', foo: :bar) do
+                target stacked('a.b.c')
+              end.render.must_equal "<img src=\"http://localhost/render?target=stacked(a.b.c)\"/>"
+            end
+          end
+
+        end
+
+        describe 'legend' do
+
+          describe 'with a single argument' do
+            it 'should render the correct <img/> tag' do
+              Graphite::Builder.new(base_url: 'http://localhost/render', foo: :bar) do
+                target legend('a.b.c','A B C')
+              end.render.must_equal "<img src=\"http://localhost/render?target=alias(a.b.c,'A+B+C')\"/>"
+            end
+          end
+
+        end
+
+        describe 'an unknown function' do
+
+          it 'should raise an UnknownFunctionSignature exception' do
+            Proc.new do
+              Graphite::Builder.new(base_url: 'http://localhost/render', foo: :bar) do
+                target blargen(1,2,3)
+              end.render
+            end.must_raise Graphite::Builder::UnknownFunctionSignature
+          end
+
+        end
+
+      end
+
+      describe "some complex graphs" do
+
+        it "should render the correct <img/> tag" do
+
+          Graphite::Builder.new(:hostname => 'foo') do
+            base_url 'http://my_graphite.host/render/'
+            width 800
+            height 200
+            areaMode :stacked
+            from '-2hours'
+            target(legend(color(sumSeries("#{data :hostname}.cpu-*.cpu-steal.value"), :red), 'Steal'))
+            target(legend(color(sumSeries("#{data :hostname}.cpu-*.cpu-steal.value"), :green), 'Idle'))
+          end.render.must_equal "<img src=\"http://my_graphite.host/render/?width=800&height=200&areaMode=stacked&from=-2hours&target=alias(color(sumSeries(foo.cpu-*.cpu-steal.value),'red'),'Steal')&target=alias(color(sumSeries(foo.cpu-*.cpu-steal.value),'green'),'Idle')\"/>"
+        end
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: graphite_builder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Edward Muller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70338624977220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70338624977220
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70338624976320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70338624976320
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70338624975440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70338624975440
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70338624974560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70338624974560
+description: A DSL for generating graphite graph urls. Meant to enable copy-and-paste
+  from the graphite UI + simple substitution.
+email: edward@heroku.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- graphite_builder.gemspec
+- lib/graphite_builder.rb
+- test/helper.rb
+- test/test_graphite_builder.rb
+homepage: http://github.com/freeformz/graphite_builder
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 372793677429185885
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: ! 'A DSL: for generating graphite graph urls.'
+test_files: []