flan 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in flan.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,24 @@
+# The MIT License
+
+Copyright (c) 2011 Kristján Pétursson
+
+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.md

@@ -0,0 +1,23 @@
+## 1-2-3 Go
+
+### Controller
+
+    include Flan
+
+    def create
+      # ...
+      flan(:pageview, 'pudding/creation')
+      # ...
+    end
+
+### Layout
+
+    %head
+      -# Initialize Google Analytics
+      = flan_js
+
+### Generates
+
+    <script type="text/javascript">
+      _gaq.push(['_trackPageview', '/_virtual/pudding/creation']);
+    </script>

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/flan.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "flan/version"
+
+Gem::Specification.new do |s|
+  s.name        = "flan"
+  s.version     = Flan::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kristán Pétursson"]
+  s.email       = ["kristjan@gmail.com`"]
+  s.homepage    = "https://github.com/kristjan/flan"
+  s.summary     = %q{FLash ANalytics}
+  s.description = %q{A server-client bridge to Google Analytics using Rails' flash}
+
+  s.rubyforge_project = "flan"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/flan.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), 'flan', 'controller_methods')
+require File.join(File.dirname(__FILE__), 'flan', 'view_helpers')
+
+module Flan
+  def self.included(base)
+    base.send(:include, Flan::ControllerMethods)
+    base.send(:helper,  Flan::ViewHelpers)
+  end
+end

data/lib/flan/controller_methods.rb

@@ -0,0 +1,10 @@
+module Flan
+  module ControllerMethods
+    private # Included in controllers, shouldn't be exposed as actions
+
+      def flan(type, name)
+        flash["flan_#{type}"] ||= []
+        flash["flan_#{type}"] << name
+      end
+  end
+end

data/lib/flan/version.rb

@@ -0,0 +1,3 @@
+module Flan
+  VERSION = "0.1.0"
+end

data/lib/flan/view_helpers.rb

@@ -0,0 +1,28 @@
+module Flan
+  module ViewHelpers
+    def flan_command(key)
+      match = /flan_(.*)/.match(key.to_s)
+      raise ArgumentError.new("#{key} wasn't generated by Flan") unless match
+      "_track#{match[1].capitalize}"
+    end
+
+    def flan_js
+      js = []
+      flan_keys.each do |key|
+        flash[key].each do |page|
+          js << "_gaq.push(['#{flan_command(key)}', '#{flan_path(page)}']);"
+        end
+      end
+      js.empty? ? '' : content_tag(:script, js.join("\n"),
+                                   :type => 'text/javascript')
+    end
+
+    def flan_keys
+      flan_keys = flash.keys.select{|k| k.to_s =~ /^flan_/}
+    end
+
+    def flan_path(path)
+      "/_virtual/#{path}".gsub('//', '/')
+    end
+  end
+end

data/spec/lib/flan/controller_methods_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Flan::ControllerMethods do
+  context "#flan" do
+    before(:all) do
+      TestController.send(:include, Flan)
+      TestController.send(:public, :flan)
+    end
+
+    before(:each) do
+      @controller = TestController.new
+      @controller.flan :pudding, "caramel"
+    end
+
+    it "sets the flash key" do
+      @controller.flash.should have_key('flan_pudding')
+    end
+
+    it "stores the value" do
+      @controller.flash['flan_pudding'].size.should == 1
+      @controller.flash['flan_pudding'].should include('caramel')
+    end
+
+    it "stores multiple values" do
+      @controller.flan :pudding, 'chocolate'
+      @controller.flash['flan_pudding'].size.should == 2
+      @controller.flash['flan_pudding'].should include('caramel')
+      @controller.flash['flan_pudding'].should include('chocolate')
+    end
+  end
+end

data/spec/lib/flan/view_helpers_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Flan::ViewHelpers do
+  include Flan::ViewHelpers
+
+  def content_tag(tag, content, options={})
+    attrs = options.map{|k,v| %[#{k}="#{v}"]}.join(' ')
+    ["<#{tag}#{' ' + attrs if attrs.any?}>", content, "</#{tag}>"].join("\n")
+  end
+
+  context "#flan_command" do
+    it "generates the right GA command from a key" do
+      flan_command(:flan_pageview).should == '_trackPageview'
+    end
+
+    it "yells if the input isn't a Flan key" do
+      expect { flan_command(:notice) }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "#flan_js" do
+    context "when there are no pageviews to track" do
+      let(:flash) do
+        {
+          :notice => "Flan is delicious!",
+        }
+      end
+
+      it "generates nothing" do
+        flan_js.should be_empty
+      end
+    end
+
+    context "when there are pageviews to track" do
+      let(:flash) do
+        {
+          :notice => "Flan is delicious!",
+          :flan_pageview => ["/flan/caramel", "flan/chocolate"],
+        }
+      end
+
+      it "generates a script tag" do
+        flan_js.should =~ %r{<script type="text/javascript">.*</script>}m
+      end
+
+      it "generates a push call for each page" do
+        flan_js.should(
+          include(%{_gaq.push(['_trackPageview', '/_virtual/flan/caramel']);}))
+        flan_js.should(
+          include(%{_gaq.push(['_trackPageview', '/_virtual/flan/chocolate']);}))
+      end
+    end
+  end
+
+  context "#flan_keys" do
+    let(:flash) do
+      {
+        :notice => "Flan is delicious!",
+        :flan_key_a => [],
+        :flan_key_b => [],
+      }
+    end
+
+    it "finds keys that start with flan_" do
+      flan_keys.should =~ [:flan_key_a, :flan_key_b]
+    end
+
+    it "ignores keys that do not start with flan_" do
+      flan_keys.should_not include(:notice)
+    end
+  end
+
+  context "#flan_path" do
+    it "prefixes a path with /_virtual" do
+      flan_path('desserts/caramel').should == '/_virtual/desserts/caramel'
+    end
+
+    it "squishes duplicate slashes" do
+      flan_path('/desserts/caramel').should == '/_virtual/desserts/caramel'
+    end
+  end
+end

data/spec/lib/flan_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Flan do
+  context "including Flan" do
+    it "adds #flan as a private method" do
+      TestController.send(:include, Flan)
+      TestController.new.private_methods.should include('flan')
+    end
+
+    it "adds the ViewHelpers" do
+      TestController.should_receive(:helper).with(Flan::ViewHelpers)
+      TestController.send(:include, Flan)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+Dir['lib/**/*.rb'].each {|f| require f}
+
+RSpec.configure do |config|
+end
+
+class TestController
+  def self.helper(helper)
+    # Pass
+  end
+
+  def flash
+    @flash ||= {}
+  end
+end
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: flan
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Krist\xC3\xA1n P\xC3\xA9tursson"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A server-client bridge to Google Analytics using Rails' flash
+email: 
+- kristjan@gmail.com`
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- flan.gemspec
+- lib/flan.rb
+- lib/flan/controller_methods.rb
+- lib/flan/version.rb
+- lib/flan/view_helpers.rb
+- spec/lib/flan/controller_methods_spec.rb
+- spec/lib/flan/view_helpers_spec.rb
+- spec/lib/flan_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/kristjan/flan
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: flan
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: FLash ANalytics
+test_files: 
+- spec/lib/flan/controller_methods_spec.rb
+- spec/lib/flan/view_helpers_spec.rb
+- spec/lib/flan_spec.rb
+- spec/spec_helper.rb