RubyGems - middleman-facebook-pixel - Versions diffs - 0.1.0 - Mend

middleman-facebook-pixel 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

checksums.yaml +7 -0
data/.gitignore +6 -0
data/.travis.yml +24 -0
data/Gemfile +17 -0
data/LICENSE +21 -0
data/README.md +52 -0
data/Rakefile +14 -0
data/features/basic.feature +19 -0
data/features/support/env.rb +4 -0
data/fixtures/basic/config.rb +1 -0
data/fixtures/basic/source/index.html.erb +1 -0
data/lib/middleman-facebook-pixel.rb +6 -0
data/lib/middleman-facebook-pixel/extension.rb +11 -0
data/lib/middleman-facebook-pixel/facebook-pixel.html.erb +12 -0
data/lib/middleman-facebook-pixel/helpers.rb +20 -0
data/lib/middleman-facebook-pixel/version.rb +5 -0
data/middleman-facebook-pixel.gemspec +27 -0
metadata +88 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92e9f098043a89c9e81060856e1fc159de5a197b
+  data.tar.gz: 9854bc585d19353d940405c5bae721f94d649c0e
+SHA512:
+  metadata.gz: 32b28a8f9291b346b94df145a967a6ee4f1e4b58df1985f6594424cdaec6c33a6bd1fe6c1a9f45fa32cb937b72f0e5bd37c8dd0376082eab5a26674677c4dc80
+  data.tar.gz: 978b951e01c765bbd04dd66840c048df4e3cbf87492563bede026038c8bd16b24163525822807282f8bdd66356d9aedda4b3e8e7403b7d40ac496e9ca119efe7

data/.gitignore ADDED

@@ -0,0 +1,6 @@
+Gemfile.lock
+.ruby-version
+*.gem
+/pkg
+/tmp

data/.travis.yml ADDED

@@ -0,0 +1,24 @@
+language: ruby
+sudo: false
+cache: bundler
+before_script:
+  - bundle update
+rvm:
+  - ruby-head
+  - 2.2
+  - 2.1
+  - 2.0
+os:
+  - linux
+  # - osx
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+script: bundle exec rake test
+env: TEST=true

data/Gemfile ADDED

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+gem 'middleman-core', '~> 3.4.1'
+gemspec
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/LICENSE ADDED

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2016 Kairat Jenishev
+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 ADDED

@@ -0,0 +1,52 @@
+# middleman-facebook-pixel [![Build Status](https://travis-ci.org/xcopy/middleman-facebook-pixel.svg?branch=master)](https://travis-ci.org/xcopy/middleman-facebook-pixel)
+**middleman-facebook-pixel** is a [Middleman](http://middlemanapp.com) extension that generates Facebook Pixel code, and keeps your config in `config.rb`, where it belongs.
+## Installation
+Specify the dependency in your project's `Gemfile`:
+  ```ruby
+  gem 'middleman-facebook-pixel'
+  ```
+Activate the Facebook Pixel extension in your project's `config.rb`:
+  ```ruby
+  # ...
+  activate :facebook_pixel, id: 1234567890
+  # ...
+  ```
+In your layout, in `<head>` section, call `facebook_pixel` helper:
+  **Haml:**
+  ```haml
+  # Facebook Pixel
+  = facebook_pixel
+  ```
+  **ERB:**
+  ```erb
+  # Facebook Pixel
+  <%= facebook_pixel %>
+  ```
+That's it!
+## 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 a new Pull Request
+## License
+Copyright (c) 2016 Kairat Jenishev. See [LICENSE](./LICENSE) for details.
+Inspired by [middleman-google-analytics](https://github.com/danielbayerlein/middleman-google-analytics)

data/Rakefile ADDED

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

data/features/basic.feature ADDED

@@ -0,0 +1,19 @@
+Feature: Facebook Pixel
+  Scenario: Basic
+    Given the Server is running at "basic"
+    When I go to "/index.html"
+    Then I should see:
+      """
+      <!-- Facebook Pixel Code -->
+      <script>
+      !function(f,b,e,v,n,t,s){if(f.fbq)return;n=f.fbq=function(){n.callMethod?
+      n.callMethod.apply(n,arguments):n.queue.push(arguments)};if(!f._fbq)f._fbq=n;
+      n.push=n;n.loaded=!0;n.version='2.0';n.queue=[];t=b.createElement(e);t.async=!0;
+      t.src=v;s=b.getElementsByTagName(e)[0];s.parentNode.insertBefore(t,s)}(window,
+      document,'script','https://connect.facebook.net/en_US/fbevents.js');
+      fbq('init', '1234567890000000');
+      fbq('track', 'PageView');
+      </script>
+      <noscript><img height="1" width="1" style="display:none" src="https://www.facebook.com/tr?id=1234567890000000&ev=PageView&noscript=1"/></noscript>
+      <!-- End Facebook Pixel Code -->
+      """

data/features/support/env.rb ADDED

@@ -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-facebook-pixel')

data/fixtures/basic/config.rb ADDED

	@@ -0,0 +1 @@
1	+ activate :facebook_pixel, id: 1234567890000000

data/fixtures/basic/source/index.html.erb ADDED

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

data/lib/middleman-facebook-pixel.rb ADDED

@@ -0,0 +1,6 @@
+require 'middleman-core'
+::Middleman::Extensions.register(:facebook_pixel) do
+  require 'middleman-facebook-pixel/extension'
+  ::Middleman::FacebookPixelExtension
+end

data/lib/middleman-facebook-pixel/extension.rb ADDED

@@ -0,0 +1,11 @@
+require 'middleman-facebook-pixel/helpers'
+module Middleman
+  class FacebookPixelExtension < Extension
+    option :id, nil, 'Facebook Pixel ID'
+    helpers do
+      include ::Middleman::FacebookPixel::Helpers
+    end
+  end
+end

data/lib/middleman-facebook-pixel/facebook-pixel.html.erb ADDED

@@ -0,0 +1,12 @@
+<!-- Facebook Pixel Code -->
+<script>
+!function(f,b,e,v,n,t,s){if(f.fbq)return;n=f.fbq=function(){n.callMethod?
+n.callMethod.apply(n,arguments):n.queue.push(arguments)};if(!f._fbq)f._fbq=n;
+n.push=n;n.loaded=!0;n.version='2.0';n.queue=[];t=b.createElement(e);t.async=!0;
+t.src=v;s=b.getElementsByTagName(e)[0];s.parentNode.insertBefore(t,s)}(window,
+document,'script','https://connect.facebook.net/en_US/fbevents.js');
+fbq('init', '<%= @options.id %>');
+fbq('track', 'PageView');
+</script>
+<noscript><img height="1" width="1" style="display:none" src="https://www.facebook.com/tr?id=<%= @options.id %>&ev=PageView&noscript=1"/></noscript>
+<!-- End Facebook Pixel Code -->

data/lib/middleman-facebook-pixel/helpers.rb ADDED

@@ -0,0 +1,20 @@
+require 'erubis'
+module Middleman
+  module FacebookPixel
+    module Helpers
+      def facebook_pixel
+        # get configuration options
+        options = extensions[:facebook_pixel].options
+        # path to Facebook Pixel template
+        path = File.join(File.dirname(__FILE__), 'facebook-pixel.html.erb')
+        # set template context
+        context = {options: options}
+        # init ERB engine
+        erb = Erubis::FastEruby.new(File.read(path))
+        # return compiled HTML
+        erb.evaluate(context)
+      end
+    end
+  end
+end

data/lib/middleman-facebook-pixel/version.rb ADDED

@@ -0,0 +1,5 @@
+module Middleman
+  module FacebookPixel
+    VERSION = '0.1.0'
+  end
+end

data/middleman-facebook-pixel.gemspec ADDED

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'middleman-facebook-pixel/version'
+Gem::Specification.new do |s|
+  s.name = 'middleman-facebook-pixel'
+  s.version = Middleman::FacebookPixel::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.author = 'Kairat Jenishev'
+  s.email = 'kairat.jenishev@gmail.com'
+  s.homepage = 'https://github.com/xcopy/middleman-facebook-pixel'
+  s.summary = 'A Middleman plugin for handling Facebook Pixel code'
+  s.description = '"middleman-facebook-pixel" is a Middleman extension that generates Facebook Pixel code, and keeps your config in config.rb, where it belongs'
+  s.license = 'MIT'
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = []
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 2.0'
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency 'middleman-core', '~> 3.4'
+  # Additional dependencies
+  s.add_runtime_dependency 'erubis', '~> 2.7'
+end

metadata ADDED

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: middleman-facebook-pixel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kairat Jenishev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: '"middleman-facebook-pixel" is a Middleman extension that generates Facebook
+  Pixel code, and keeps your config in config.rb, where it belongs'
+email: kairat.jenishev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- features/basic.feature
+- features/support/env.rb
+- fixtures/basic/config.rb
+- fixtures/basic/source/index.html.erb
+- lib/middleman-facebook-pixel.rb
+- lib/middleman-facebook-pixel/extension.rb
+- lib/middleman-facebook-pixel/facebook-pixel.html.erb
+- lib/middleman-facebook-pixel/helpers.rb
+- lib/middleman-facebook-pixel/version.rb
+- middleman-facebook-pixel.gemspec
+homepage: https://github.com/xcopy/middleman-facebook-pixel
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: A Middleman plugin for handling Facebook Pixel code
+test_files: []