gauges-rails 0.0.1 → 0.2.0

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+bin
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -1,2 +1,3 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
+
 gemspec

data/{MIT-LICENSE → LICENSE}

@@ -1,4 +1,6 @@
-Copyright 2011 Jason Coene
+Copyright (c) 2012 Tyler Hunt
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,36 +1,54 @@
-# Gauges-rails
+# Gauges::Rails
+
+A Rails engine to add [Gauges][] tracking code to Rails apps.
+
+[gauges]: http://gaug.es/
 
-Easily (and neatly) add Gaug.es to your Rails 3 application!
 
 ## Installation
 
-**First, add gauges-rails to your Gemfile:**
+Add this line to your application's Gemfile:
 
     gem 'gauges-rails'
 
-**Next, set your Gaug.es site id in your config/application.rb file:**
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gauges-rails
+
+
+## Configuration
+
+Set your Gauges site ID in the `config/application.rb` file:
+
+    config.gauges.site_id = GAUGES_SITE_ID
+
+Your site ID can be found on the Gauges dashboard under "Tracking Code".
 
-    # Set our Gaug.es site id
-    config.gauges.site_id = 'YOUR_SITE_ID_HERE'
 
-You can obtain the site id from your Gaug.es dashboard. It should resemble an MD5 hash.
+## Usage
 
-**Finally, include the tracking code in one of your views.**
+Include the JavaScript tracking code at the bottom of your layout template:
 
-You can do this in a layout file (typically app/views/layouts/application.html.erb), or on a per-view basis (such as in app/views/dingdongs/index.html.erb). Insert the code as follows:
+    <%= javascript_include_tag('gauges') %>
 
-    <%= gauges_tracking_code %>
+Or, if your template is using Haml:
 
-*Gauges-rails should work fine with any view template engine. For instancing, HAML users will want to use:*
+    = javascript_include_tag('gauges')
 
-    = gauges_tracking_code
 
-## Customization
+## Contributing
 
-### Using more than one site id
+1. Fork it.
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Added some feature'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create a new Pull Request.
 
-You can pass a hash of arguments to the *gauges_tracking_code* helper method. Example:
 
-    <%= gauges_tracking_code :site_id => 'MY_CUSTOM_SITE_ID_HERE' %>
+## Copyright
 
-That's all for now, folks!
+Copyright © 2012 Tyler Hunt. See LICENSE for details.

data/Rakefile

@@ -1,34 +1,3 @@
-# encoding: UTF-8
-require 'rubygems'
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
+#!/usr/bin/env rake
 
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require 'gauges/rails/version'
-
-require 'rake'
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :build do
-  system "gem build gauges-rails.gemspec"
-end
-
-task :install => :build do
-  system "gem install gauges-rails-#{Gauges::Rails::VERSION}.gem"
-end
-
-task :release => :build do
-  system "git tag -a #{Gauges::Rails::VERSION} -m 'Tagging #{Gauges::Rails::VERSION}'"
-  system "git push --tags"
-  system "gem push gauges-rails-#{Gauges::Rails::VERSION}.gem"
-  system "rm gauges-rails-#{Gauges::Rails::VERSION}.gem"
-end
-
-task :default => :spec
+require 'bundler/gem_tasks'

data/gauges-rails.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/gauges/rails/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Tyler Hunt']
+  gem.email         = ['tyler@tylerhunt.com']
+  gem.description   = %q{An engine to add Gauges tracking code to Rails apps.}
+  gem.summary       = %q{An engine to add Gauges tracking code to Rails apps.}
+  gem.homepage      = 'http://github.com/tylerhunt/gauges-rails'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = 'gauges-rails'
+  gem.require_paths = ['lib']
+  gem.version       = Gauges::Rails::VERSION
+
+  gem.add_dependency 'rails', '~> 3.1'
+  gem.add_development_dependency 'rspec', '~> 2.0'
+end

data/lib/gauges/rails.rb

@@ -1 +1 @@
-require 'gauges/rails/railtie' if defined?(Rails)
+require 'gauges/rails/engine'

data/lib/gauges/rails/engine.rb

@@ -0,0 +1,10 @@
+require 'gauges/rails/version'
+
+module Gauges
+  module Rails
+    class Engine < ::Rails::Engine
+      config.gauges = ActiveSupport::OrderedOptions.new
+      config.gauges.site_id = nil
+    end
+  end
+end

data/lib/gauges/rails/version.rb

@@ -1,5 +1,5 @@
 module Gauges
   module Rails
-    VERSION = '0.0.1'
+    VERSION = '0.2.0'
   end
 end

data/spec/gauges-rails_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Gauges::Rails::Engine do
+  let(:site_id) { SecureRandom.hex(12) }
+
+  subject { described_class }
+
+  context 'configuration' do
+    subject { GaugesRailsTestApp.config.gauges }
+
+    it { should be_a(ActiveSupport::OrderedOptions) }
+
+    its(:site_id) { should be_nil }
+
+    context 'site_id=' do
+      specify do
+        subject.site_id = site_id
+        expect { subject.site_id = nil }.to change(subject, :site_id).to(nil)
+      end
+    end
+  end
+
+  describe 'assets' do
+    include Rack::Test::Methods
+
+    let(:app) { GaugesRailsTestApp }
+
+    before { GaugesRailsTestApp.config.gauges.site_id = site_id }
+
+    it 'interpolates the site_id' do
+      get '/assets/gauges.js'
+      last_response.body.should include(site_id)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rails'
+require 'active_support/core_ext/numeric'
+require 'action_controller/railtie'
+require 'sprockets/railtie'
+
+require 'gauges/rails'
+
+GaugesRailsTestApp = Class.new(Rails::Application) do
+  config.active_support.deprecation = :stderr
+  config.secret_token = SecureRandom.uuid
+  config.logger = Logger.new('/dev/null')
+
+  config.assets.enabled = true
+  config.assets.cache_store = [:memory_store, :size => 1.megabyte]
+end
+
+GaugesRailsTestApp.initialize!
+GaugesRailsTestApp.routes.clear!
+
+Rails.application = GaugesRailsTestApp

data/vendor/assets/javascripts/gauges.js.erb

@@ -0,0 +1,11 @@
+var _gauges = _gauges || [];
+(function() {
+  var t   = document.createElement('script');
+  t.type  = 'text/javascript';
+  t.async = true;
+  t.id    = 'gauges-tracker';
+  t.setAttribute('data-site-id', '<%= Rails.application.config.gauges.site_id %>');
+  t.src = '//secure.gaug.es/track.js';
+  var s = document.getElementsByTagName('script')[0];
+  s.parentNode.insertBefore(t, s);
+})();

metadata

@@ -1,88 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: gauges-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
-- Jason Coene
+- Tyler Hunt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-19 00:00:00.000000000Z
+date: 2012-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70180790271600 !ruby/object:Gem::Requirement
+  requirement: &70200658128380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.0.rc
-  type: :development
-  prerelease: false
-  version_requirements: *70180790271600
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: &70180790269660 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.6.1
-  type: :development
-  prerelease: false
-  version_requirements: *70180790269660
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: &70180790267680 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.1
-  type: :development
+        version: '3.1'
+  type: :runtime
   prerelease: false
-  version_requirements: *70180790267680
+  version_requirements: *70200658128380
 - !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: &70180790256520 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &70200658127860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70180790256520
-- !ruby/object:Gem::Dependency
-  name: launchy
-  requirement: &70180790255000 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.0.5
-  type: :development
-  prerelease: false
-  version_requirements: *70180790255000
-description: Simple helper to add Gaug.es support to your Rails application.
+  version_requirements: *70200658127860
+description: An engine to add Gauges tracking code to Rails apps.
 email:
-- jcoene@gmail.com
+- tyler@tylerhunt.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/gauges/rails/helper.rb
-- lib/gauges/rails/railtie.rb
-- lib/gauges/rails/version.rb
-- lib/gauges/rails.rb
-- lib/gauges-rails.rb
-- MIT-LICENSE
-- Rakefile
+- .gitignore
+- .rspec
 - Gemfile
+- LICENSE
 - README.md
-homepage: http://github.com/jcoene/gauges-rails
+- Rakefile
+- gauges-rails.gemspec
+- lib/gauges-rails.rb
+- lib/gauges/rails.rb
+- lib/gauges/rails/engine.rb
+- lib/gauges/rails/version.rb
+- spec/gauges-rails_spec.rb
+- spec/spec_helper.rb
+- vendor/assets/javascripts/gauges.js.erb
+homepage: http://github.com/tylerhunt/gauges-rails
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -94,22 +66,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3602843286404034390
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3602843286404034390
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: Use Gaug.es with your Rails app.
-test_files: []
+summary: An engine to add Gauges tracking code to Rails apps.
+test_files:
+- spec/gauges-rails_spec.rb
+- spec/spec_helper.rb

data/lib/gauges/rails/helper.rb

@@ -1,15 +0,0 @@
-module Gauges
-  module Rails
-    module Helper
-      def gauges_tracking_code(options={})
-        options[:site_id] = ::Rails.application.config.gauges.site_id unless options.key?(:site_id)
-        if options[:site_id].nil?
-          raise "Please set a Gaug.es site ID in your application configuration or as an argument to gauges_tracking_code, example: gauges_tracking_code(:site_id => '12345')"
-        else
-          "<script type=\"text/javascript\"> var _gauges = _gauges || []; (function() { var t = document.createElement('script'); t.type  = 'text/javascript'; t.async = true; t.id = 'gauges-tracker'; t.setAttribute('data-site-id', '#{options[:site_id]}'); t.src = '//secure.gaug.es/track.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(t, s); })(); </script>".html_safe
-        end
-      end
-    end
-  end
-end
-

data/lib/gauges/rails/railtie.rb

@@ -1,19 +0,0 @@
-require 'rails/railtie'
-require 'gauges/rails/helper'
-
-module Gauges
-  module Rails
-    class Railtie < ::Rails::Railtie
-
-      config.gauges = ActiveSupport::OrderedOptions.new
-      config.gauges.site_id = nil
-
-      initializer :setup_gauges_rails do |app|
-        ActiveSupport.on_load(:action_view) do
-          include Gauges::Rails::Helper
-        end
-      end
-
-    end
-  end
-end