RubyGems - google-tag-manager-rails - Versions diffs - 0.1.0 → 0.1.1 - Mend

google-tag-manager-rails 0.1.0 → 0.1.1

Files changed (48) hide show

data/{LICENSE.txt → MIT-LICENSE} +1 -1
data/README.md +44 -0
data/Rakefile +28 -39
data/lib/google-tag-manager-rails.rb +31 -0
data/lib/google-tag-manager/rails/railtie.rb +9 -0
data/lib/google-tag-manager/rails/view_helpers.rb +11 -0
data/lib/google-tag-manager/version.rb +3 -0
data/lib/tasks/google-tag-manager_tasks.rake +4 -0
data/test/dummy/README.rdoc +261 -0
data/test/dummy/Rakefile +7 -0
data/test/dummy/app/assets/javascripts/application.js +15 -0
data/test/dummy/app/assets/stylesheets/application.css +13 -0
data/test/dummy/app/controllers/application_controller.rb +3 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/config/application.rb +59 -0
data/test/dummy/config/boot.rb +10 -0
data/test/dummy/config/database.yml +25 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +37 -0
data/test/dummy/config/environments/production.rb +67 -0
data/test/dummy/config/environments/test.rb +37 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/inflections.rb +15 -0
data/test/dummy/config/initializers/mime_types.rb +5 -0
data/test/dummy/config/initializers/secret_token.rb +7 -0
data/test/dummy/config/initializers/session_store.rb +8 -0
data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
data/test/dummy/config/locales/en.yml +5 -0
data/test/dummy/config/routes.rb +58 -0
data/test/dummy/log/development.log +2 -0
data/test/dummy/public/404.html +26 -0
data/test/dummy/public/422.html +26 -0
data/test/dummy/public/500.html +25 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/dummy/script/rails +6 -0
data/test/google-tag-manager_test.rb +7 -0
data/test/test_helper.rb +15 -0
metadata +83 -76
data/.document +0 -5
data/.rspec +0 -1
data/Gemfile +0 -14
data/README.rdoc +0 -19
data/VERSION +0 -1
data/google-tag-manager-rails.gemspec +0 -62
data/spec/google-tag-manager-rails_spec.rb +0 -7
data/spec/spec_helper.rb +0 -12

data/{LICENSE.txt → MIT-LICENSE} RENAMED Viewed

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Ryan Sorensen
+Copyright 2012 YOURNAME
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md ADDED Viewed

@@ -0,0 +1,44 @@
+Installation
+=============
+Add the following to your Gemfile:
+``
+  gem 'google-tag-manager-rails'
+``
+Then run:
+``
+  bundle install
+``
+Example Configuration
+====
+In config/environments/production.rb :
+```ruby
+GoogleTagManager.gtm_id = "GTM-XXXX" # Where GTM-XXXX is your container ID from Google Tag Manager
+```
+In app/views/layouts/application.html.erb:
+```erb
+<body>
+  <%= google_tag_manager %>
+  ...
+```
+Per environment config
+----
+google-tag-manager-rails will only write out a tag if `GoogleTagManager.gtm_id` is set. If you don't set the value in your development, testing, or staging environments, no tags will be written.
+If you'd like to add them, in config/environments/{development,staging}.rb :
+```ruby
+GoogleTagManager.gtm_id = "GTM-XXXX" # Where GTM-XXXX is your container ID from Google Tag Manager
+```

data/Rakefile CHANGED Viewed

@@ -1,49 +1,38 @@
-# encoding: utf-8
-require 'rubygems'
-require 'bundler'
+#!/usr/bin/env rake
 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
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 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 = "google-tag-manager-rails"
-  gem.homepage = "http://github.com/rcs/google-tag-manager-rails"
-  gem.license = "MIT"
-  gem.summary = %Q{Google Tag Manager helpers for Rails}
-  gem.description = %Q{Use Google Tag Manager ( http://www.google.com/tagmanager/ ) in your Rails application.}
-  gem.email = "rcsorensen@gmail.com"
-  gem.authors = ["Ryan Sorensen"]
-  # dependencies defined in Gemfile
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
 end
-Jeweler::RubygemsDotOrgTasks.new
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GoogleTagManager'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-task :default => :spec
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "google-tag-manager-rails #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+Bundler::GemHelper.install_tasks
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
 end
+task :default => :test

data/lib/google-tag-manager-rails.rb CHANGED Viewed

@@ -0,0 +1,31 @@
+if Rails
+  require 'google-tag-manager/rails/railtie'
+end
+module GoogleTagManager
+  PLACEHOLDER_GTM_ID = "GTM-XXXX"
+  def self.valid_gtm_id?
+     gtm_id.nil? || gtm_id == "" || gtm_id == PLACEHOLDER_GTM_ID ? false : true
+  end
+  def self.gtm_id
+    @@gtm_id ||= PLACEHOLDER_GTM_ID
+  end
+  def self.gtm_id=(gtm_id)
+    @@gtm_id = gtm_id
+  end
+  def self.to_html
+    <<-HTML
+<!-- Google Tag Manager -->
+<noscript><iframe src="//www.googletagmanager.com/ns.html?id=#{gtm_id}"
+height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
+<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+'//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+})(window,document,'script','dataLayer','#{gtm_id}');</script>
+<!-- End Google Tag Manager -->
+    HTML
+  end
+end

data/lib/google-tag-manager/rails/railtie.rb ADDED Viewed

@@ -0,0 +1,9 @@
+require 'google-tag-manager/rails/view_helpers'
+module GoogleTagManager::Rails
+  class Railtie < ::Rails::Railtie
+    initializer "google-tag-manager-rails" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/google-tag-manager/rails/view_helpers.rb ADDED Viewed

@@ -0,0 +1,11 @@
+require 'active_support/core_ext/string/output_safety'
+module GoogleTagManager::Rails
+  module ViewHelpers
+    def google_tag_manager
+      return "" unless GoogleTagManager.valid_gtm_id?
+      GoogleTagManager.to_html.html_safe
+    end
+  end
+end

data/lib/google-tag-manager/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module GoogleTagManager
+  VERSION = "0.1.1"
+end

data/lib/tasks/google-tag-manager_tasks.rake ADDED Viewed

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :google-tag-manager do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc ADDED Viewed

@@ -0,0 +1,261 @@
+== Welcome to Rails
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+== Getting Started
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+== Debugging Rails
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+The result will be a message in your log file along the lines of:
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+== Debugger
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+...and even better, you can examine how your runtime objects actually work:
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+Finally, when you're ready to resume execution, you can enter "cont".
+== Console
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+To start the console, run <tt>rails console</tt> from the application
+directory.
+Options:
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+== dbconsole
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+== Description of Contents
+The default directory structure of a generated Ruby on Rails application:
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+app
+  Holds all the code that's specific to this particular application.
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+script
+  Helper scripts for automation and generation.
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.