middleman-segment 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 131761cacf7d834b49918069ad2e4368eea2c80c
+  data.tar.gz: 50c8dbbb8dd577347e3ce94554922d3f63e33756
+SHA512:
+  metadata.gz: 1df1eee0d6ffcf1a4d0116a1ee901bda525ab3829dc0c001f30c0c03254ff0e7f4841b48e5aeeffa2329e70c7b7d6c3824d1e49494bde762551d7496ddad9b5e
+  data.tar.gz: 4b779cf0da45a16ced88e32489daa8b6657347c30f21e1d3ab5e1f75aabe2672411fdcf4b022dbd3464e1fc1944606082f984b29bbae27577a3c0699eaf1b1d0

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+pkg
+tmp

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+### Added
+### Changed
+### Fixed
+
+## [0.1.0] - 2018-02-03
+- Initial release.

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "rake", "~> 12.3.0"
+  gem "rdoc", "~> 6.0.1"
+end
+
+group :test do
+  gem "aruba", "~> 0.14.3"
+  gem "capybara", "~> 2.17.0"
+  gem "cucumber", "~> 3.1.0"
+  gem "rspec", "~> 3.7.0"
+end

data/README.md

@@ -0,0 +1,51 @@
+# Middleman Segment
+[![Dependency Status](https://gemnasium.com/badges/github.com/bnadlerjr/middleman-segment.svg)](https://gemnasium.com/github.com/bnadlerjr/middleman-segment)
+[![Build Status](https://travis-ci.org/bnadlerjr/middleman-segment.svg?branch=master)](https://travis-ci.org/bnadlerjr/middleman-segment)
+
+A [Middleman](https://middlemanapp.com/) extension to handle generating your Segment tracking code.
+
+## Installation
+Specify the dependency in your project's `Gemfile`:
+
+    gem "middleman-segment", "~> 0.1.0"
+
+## Usage
+Activate the extension in your `config.rb`:
+
+    activate :middleman_segment, write_key: <YOUR SEGMENT WRITE KEY>
+
+Include the Segment snippet in any of your templates (most likely in `layout.erb`):
+
+    <%= segment_tag %>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+Copyright (c) 2018 Bob Nadler, Jr.
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,14 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "cucumber/rake/task"
+
+Cucumber::Rake::Task.new(:cucumber, "Cucumber feature tests") do |t|
+  t.cucumber_opts = "--color --tags ~@wip --strict"
+end
+
+require "rake/clean"
+
+task test: ["cucumber"]
+
+task default: :test

data/features/segment.feature

@@ -0,0 +1,13 @@
+Feature: Segment tracking code
+  Scenario: Tracking code helper is on the page
+    Given the Server is running at "segment"
+    When I go to "/index.html"
+    Then I should see:
+      """
+      <script type="text/javascript">
+        !function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment.com/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="4.0.0";
+        analytics.load("MY_SEGMENT_WRITE_KEY");
+        analytics.page();
+        }}();
+      </script>
+      """

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require "middleman-core"
+require "middleman-core/step_definitions"
+require File.join(PROJECT_ROOT_PATH, "lib", "middleman-segment")

data/fixtures/segment/config.rb

@@ -0,0 +1 @@
+activate :middleman_segment, write_key: "MY_SEGMENT_WRITE_KEY"

data/fixtures/segment/source/index.html.erb

@@ -0,0 +1 @@
+<%= segment_tag %>

data/lib/middleman-segment.rb

@@ -0,0 +1,6 @@
+require "middleman-core"
+
+Middleman::Extensions.register :middleman_segment do
+  require "middleman-segment/extension"
+  MiddlemanSegment
+end

data/lib/middleman-segment/extension.rb

@@ -0,0 +1,26 @@
+require "middleman-core"
+
+class MiddlemanSegment < ::Middleman::Extension
+  option :write_key, nil, "Segment write key"
+
+  def initialize(app, options_hash={}, &block)
+    super
+    require "erubis"
+  end
+
+  def after_configuration
+    unless options.write_key
+      $stderr.puts("Segment requires a write key")
+      raise ArgumentError, "No segment write key given" if app.build?
+    end
+  end
+
+  helpers do
+    def segment_tag
+      options = extensions[:middleman_segment].options
+      template_path = File.join(File.dirname(__FILE__), "segment.html.erb")
+      erb = Erubis::FastEruby.new(File.read(template_path))
+      erb.evaluate({options: options})
+    end
+  end
+end

data/lib/middleman-segment/segment.html.erb

@@ -0,0 +1,6 @@
+<script type="text/javascript">
+  !function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment.com/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="4.0.0";
+  analytics.load("<%= @options.write_key %>");
+  analytics.page();
+  }}();
+</script>

data/middleman-segment.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-segment"
+  s.version     = "0.1.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bob Nadler, Jr."]
+  s.homepage    = "https://github.com/bnadlerjr/middleman-segment"
+  s.summary     = %q{A Middleman extension to handle generating your Segment tracking code.}
+
+  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"]
+
+  s.add_runtime_dependency("middleman-core", [">= 4.2.1"])
+  s.add_runtime_dependency("erubis", ["~> 2.7.0"])
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: middleman-segment
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bob Nadler, Jr.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- features/segment.feature
+- features/support/env.rb
+- fixtures/segment/config.rb
+- fixtures/segment/source/index.html.erb
+- lib/middleman-segment.rb
+- lib/middleman-segment/extension.rb
+- lib/middleman-segment/segment.html.erb
+- middleman-segment.gemspec
+homepage: https://github.com/bnadlerjr/middleman-segment
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A Middleman extension to handle generating your Segment tracking code.
+test_files:
+- features/segment.feature
+- features/support/env.rb