ramaze-fnordmetric 0.0.9

data/lib/ramaze/helper/fnordmetric/spec/helper.rb

@@ -0,0 +1,6 @@
+require 'bacon'
+require File.expand_path('../bacon/color_output', __FILE__)
+require 'ramaze/spec/bacon'
+
+Bacon.extend(Bacon::ColorOutput)
+Bacon.summary_on_exit

data/ramaze-fnordmetric.gemspec

@@ -0,0 +1,25 @@
+path = File.expand_path('../', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'ramaze-fnordmetric'
+  s.version     = '0.0.9'
+  s.date        = '2012-06-21'
+  s.authors     = ['Michel Blanc']
+  s.email       = 'mblanc@erasme.org'
+  s.summary     = 'A simple fnordmetric helper for Ramaze.'
+  s.homepage    = 'https://github.com/leucos/ramaze-fnordmetric'
+  s.description = s.summary
+  s.files       = `cd #{path}; git ls-files`.split("\n").sort
+  s.has_rdoc    = 'yard'
+
+  s.add_dependency('ramaze', ['>= 2011.07.25'])
+  s.add_dependency('redis', ['>= 2.2.0'])
+  s.add_dependency('fnordmetric', ['>= 0.9.7'])
+
+  s.add_development_dependency('rake'     , ['>= 0.9.2'])
+  s.add_development_dependency('yard'     , ['>= 0.7.2'])
+  s.add_development_dependency('bacon'    , ['>= 1.1.0'])
+  s.add_development_dependency('rdiscount', ['>= 1.6.8'])
+  s.add_development_dependency('rack-test', ['>= 0.6.1'])
+  s.add_development_dependency('simplecov')
+end

data/spec/helper.rb

@@ -0,0 +1,2 @@
+require File.expand_path('../../lib/ramaze/helper/fnordmetric', __FILE__)
+require File.expand_path('../../lib/ramaze/helper/fnordmetric/spec/helper', __FILE__)

data/spec/ramaze_fnordmetric/fnordmetric.rb

@@ -0,0 +1,209 @@
+require File.expand_path('../../helper', __FILE__)
+
+# re-open logging stuff so we can trap when R:H:Fnordmetric spits out errors on
+# console
+module Innate
+  class LogHub
+    # Override error so we can be sure something broke
+    def error(message)
+      @@last_error = message
+    end
+
+    def last_error
+      @@last_error
+    end
+  end
+end
+
+# Re-open helper class to mock redis-related methods
+module Ramaze
+
+  module Helper
+    module Fnordmetric
+
+      def self.redis
+        @@redis
+      end
+
+      def self.fnord
+        @@fnord
+      end
+
+      # Redis mocking class
+      class RedisMock
+        attr_accessor :list
+
+        def initialize(whatever)
+          @list = Array.new
+        end
+
+        def lpush(key, value)
+          # We just don't care about key
+          @list.push value
+        end
+
+        def lpop(key)
+          @list.pop
+        end
+
+        def expire(key, ttl)
+          # don't care
+        end
+
+        def llen(key)
+          @list.count
+        end
+
+        def del(key)
+          @list = []
+        end
+
+        def [](index)
+          @list[index]
+        end
+      end
+
+      # Fnordmetric mocking class
+      class FnordMock
+        attr_accessor :last
+
+        def initialize(whatever)
+          @last = nil
+        end
+
+        # This is called by Ramaze::Helper::Fnordmetric
+        # and already formatted Fnordmetric-style
+        def event(evt, args = {})
+          @last = evt
+        end
+      end
+
+      def _connect
+        @@fnord = FnordMock.new(:redis_url => "mocked, muahahah")
+        @@redis = RedisMock.new(:url => "mocked too, niark niark")
+      end
+
+    end
+  end
+end
+
+# TODO: may be we should check if a redis server is available, and if not load
+# the above code from a specific file
+
+# guinea pig controller
+class GuineaPig < Ramaze::Controller
+  map '/'
+  helper :fnordmetric
+
+  def event_test(key, value)
+    event(key, { :somefield => value })
+  end
+
+  def set_picture_test(url)
+    set_picture(url)
+  end
+
+  def set_name_test(name)
+    set_name(name)
+  end
+
+  def pageview_test(url)
+    pageview(url)
+  end
+
+  def push_pop_test(name, value)
+    push_timer(name, :somevalue => value)
+    # noop
+    pop_timer
+  end
+
+  def times_test(key, value)
+    times(key, :somevalue => value) do
+      true
+    end
+  end
+
+  def clock_test
+  end
+  clock :clock_test, :i_like_to_clock_it_clock_it, :somevalue => "clo(a)cked !"
+
+  def clear_timers_test
+    clear_timers
+  end
+
+  def push_only_test(name, value)
+    # This will leave an un-popped key in the redis stack
+    push_timer(name, value)
+  end
+
+  def pop_only_test
+    pop_timer
+  end
+end
+
+# Convenience function to test multiple values
+def check(args)
+  args.each_pair do |k,v|
+    Ramaze::Helper::Fnordmetric.fnord.last[k].should == v
+  end
+end
+
+# Convenience debugging function
+def debug(what)
+  what = what.class == Array ? what : [ what ]
+  pp Ramaze::Helper::Fnordmetric.fnord.last if what.include?(:fnord)
+  pp Ramaze::Helper::Fnordmetric.redis.list if what.include?(:redis)
+end
+
+
+describe('Ramaze::Helper::Fnordmetric') do
+  behaves_like :rack_test
+
+  should 'send events' do
+    get('/event_test/abcd/12').status.should == 200
+    check({:_type => "abcd", :somefield => "12"})
+  end
+
+  should 'set picture' do
+    get('/set_picture_test/this_is_my_pic_url').status.should == 200
+    check({:_type => "_set_picture", :url => "this_is_my_pic_url"})
+  end
+
+  should 'set name' do
+    get('/set_name_test/this_is_my_name').status.should == 200
+    check({:_type => "_set_name", :name => "this_is_my_name"})
+  end
+
+  should 'handle pageview' do
+    get('/pageview_test/my_fancy_url').status.should == 200
+    check({:_type => "_pageview", :url => "my_fancy_url"})
+  end
+
+  should 'handle push_pop' do
+    get('/push_pop_test/push_pop_url/push_pop_value').status.should == 200
+    check({:_type => "push_pop_url", "somevalue" => "push_pop_value"})
+    Ramaze::Helper::Fnordmetric.fnord.last[:time].should > 0
+  end
+
+  should 'handle clocking a block with times' do
+    get('/times_test/times_url/times_value').status.should == 200
+    check({:_type => "times_url", "somevalue" => "times_value"})
+  end
+
+  should 'handle clocking a block with times' do
+    get('/clock_test').status.should == 200
+    check({:_type => "i_like_to_clock_it_clock_it", "somevalue" => "clo(a)cked !"})
+  end
+
+  should 'clear timers' do
+    get('/push_only_test/abcd/12').status.should == 200
+    get('/clear_timers_test').status.should == 200
+    Ramaze::Helper::Fnordmetric.redis.list.should.be.empty
+  end
+
+  should 'handle popping and empty stack gracefuly' do
+    get('/pop_only_test').status.should == 200
+    Ramaze::Log.last_error.should =~ /Unable to pop timer/
+  end
+
+end

data/task/bacon.rake

@@ -0,0 +1,16 @@
+desc "Runs bacon tests with code coverage"
+task :bacon do
+  require 'simplecov'
+  require 'bacon'
+
+  Bacon.const_set :Backtraces, false unless ENV['BACON_MUTE'].nil? 
+
+  SimpleCov.command_name 'bacon'
+  SimpleCov.start do
+    add_filter "spec/"
+    add_filter "vendor/"
+    add_filter "config"
+  end if ENV["COVERAGE"] 
+
+  require File.expand_path('spec/ramaze_fnordmetric/fnordmetric.rb')
+end

data/task/build.rake

@@ -0,0 +1,34 @@
+# Task group used for building various elements such as the Gem and the
+# documentation.
+namespace :build do
+  desc 'Builds the documentation using YARD'
+  task :doc do
+    gem_path = File.expand_path('../../', __FILE__)
+    command  = "yard doc #{gem_path}/lib -m markdown -M rdiscount -o #{gem_path}/doc "
+    command += "-r #{gem_path}/README.md --private --protected"
+
+    sh(command)
+  end
+
+  desc 'Builds a new Gem'
+  task :gem do
+    gem_path     = File.expand_path('../../', __FILE__)
+    gemspec_path = File.join(
+      gem_path,
+      "#{Ramaze::Helper::Fnordmetric::Gemspec.name}-" \
+        "#{Ramaze::Helper::Fnordmetric::Gemspec.version.version}.gem"
+    )
+
+    pkg_path = File.join(
+      gem_path,
+      'pkg',
+      "#{Ramaze::Helper::Fnordmetric::Gemspec.name}-" \
+        "#{Ramaze::Helper::Fnordmetric::Gemspec.version.version}.gem"
+    )
+
+    # Build and install the gem
+    sh('gem', 'build'     , File.join(gem_path, 'ramaze-fnordmetric.gemspec'))
+    sh('mv' , gemspec_path, pkg_path)
+  end
+end # namespace :build
+

data/task/clean.rake

@@ -0,0 +1,4 @@
+require 'rake/clean'
+
+CLOBBER.include('coverage/', 'doc/', '.yardoc/')
+

data/task/test.rake

@@ -0,0 +1,8 @@
+desc 'Runs all the tests'
+task :test do
+  files = Dir.glob(File.expand_path('../../spec/ramaze_fnordmetric/*.rb', __FILE__))
+
+  files.each do |file|
+    require(file)
+  end
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: ramaze-fnordmetric
+version: !ruby/object:Gem::Version
+  version: 0.0.9
+  prerelease: 
+platform: ruby
+authors:
+- Michel Blanc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ramaze
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2011.07.25
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2011.07.25
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: fnordmetric
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple fnordmetric helper for Ramaze.
+email: mblanc@erasme.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/README.md
+- examples/example.rb
+- examples/fn.rb
+- lib/ramaze/helper/fnordmetric.rb
+- lib/ramaze/helper/fnordmetric/spec/bacon/color_output.rb
+- lib/ramaze/helper/fnordmetric/spec/helper.rb
+- pkg/.gitkeep
+- ramaze-fnordmetric.gemspec
+- spec/helper.rb
+- spec/ramaze_fnordmetric/fnordmetric.rb
+- task/bacon.rake
+- task/build.rake
+- task/clean.rake
+- task/test.rake
+homepage: https://github.com/leucos/ramaze-fnordmetric
+licenses: []
+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: 3737029466321666576
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3737029466321666576
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple fnordmetric helper for Ramaze.
+test_files: []
+has_rdoc: yard