spree_gtm 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e14458a5d72e3278735b10990c61767ecd3df01b
-  data.tar.gz: f7e9d7837143de274a695ce8bb485f0c78a8b113
+  metadata.gz: 7a521ac101c9a3bcd672359fa18096718737b13e
+  data.tar.gz: cdc48eea47006b9246e6652b1ed3455e5c4b7ee4
 SHA512:
-  metadata.gz: fbdd722c8e2d9e28d408a533052f3d5d8c3476fd6ee44237a6bb9373ae996bb3f15af95ea3a22481bbe3dd855bc953da2894994f019c34f5878407f676b23aeb
-  data.tar.gz: feb9a71d15098f7fdfbb0b91e372b504ca23010cbed31def96cdf2b412f651c88bec29f46e9016c489948d3f2533833e99dd43b38574cce0c49fffd7ffb97b95
+  metadata.gz: bfdfbc16e0babbe9cf04b7d186621c34fbfdd14c42bf4105381996e858a36252506abc03fea8153d2bb74176e6c933caff968cc8a82852e5d84fb5f9dfdd1f13
+  data.tar.gz: 8bcce70a18a4177a28a6978efe19e97d69009616db18e6f0c88af6baaf2f2091faae715f501a71532b0d97ef2a317a3c2a1559445b27f71f95f5d7489bbd92ab

data/.gitignore

@@ -0,0 +1,19 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+.bundle
+.rvmrc
+.ruby-version
+.ruby-gemset
+spree_gtm*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.3.1
+sudo: false
+cache: bundler
+before_script:
+  - sh -e /etc/init.d/xvfb start
+  - bundle exec rake test_app
+script:
+  - export DISPLAY=:99.0
+  - bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'spree', github: 'spree/spree', branch: '3-1-stable'
+# Provides basic authentication functionality for testing parts of your engine
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: '3-1-stable'
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2016 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,20 @@
+ Spree Google Tag Maneger Plugin
+--------------------------------
+
+[![Gem Version](https://badge.fury.io/rb/spree_gtm.svg)](https://badge.fury.io/rb/spree_gtm)
+ [![Code Climate](https://codeclimate.com/github/RostislavKorin/spree_gtm/badges/gpa.svg)](https://codeclimate.com/github/RostislavKorin/spree_gtm)
+ [![Build Status](https://travis-ci.org/RostislavKorin/spree_gtm.svg?branch=master)](https://travis-ci.org/RostislavKorin/spree_gtm)
+
+Installation
+============
+
+Add to your spree shop Gemfile
+
+    gem 'spree_gtm'
+
+Run bundle install
+
+Configuration
+=============
+
+Go to admin >  Configuration > gtm, fill in your gtm account id

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_gtm'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/spree_gtm.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js'

data/app/assets/javascripts/spree/frontend/spree_gtm.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/spree_gtm.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/

data/app/assets/stylesheets/spree/frontend/spree_gtm.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

data/app/controllers/spree/admin/gtms_controller.rb

@@ -0,0 +1,13 @@
+class Spree::Admin::GtmsController < Spree::Admin::ResourceController
+
+  def index
+    @gtm = Spree::Gtm.first || Spree::Gtm.new
+  end
+
+  def new
+  end
+
+  def edit
+    @gtm = Spree::Gtm.first
+  end
+end

data/app/models/spree/gtm.rb

@@ -0,0 +1,9 @@
+class Spree::Gtm < ActiveRecord::Base
+  validates :gtm_accountid, presence: true
+
+
+  def self.gtm_accountid
+      first.gtm_accountid
+    end
+
+end

data/app/models/spree.rb

@@ -0,0 +1,5 @@
+module Spree
+  def self.table_name_prefix
+    'spree_'
+  end
+end

data/app/overrides/spree/admin/shared/sub_menu/_configuration/add_gtm_to_admin_configurations_sidebar_menu.html.erb.deface

@@ -0,0 +1,2 @@
+<!-- insert_bottom "[data-hook='admin_configurations_sidebar_menu']" -->
+<%= configurations_sidebar_menu_item t('gtm'), admin_gtms_path %>

data/app/overrides/spree/gtm.rb

@@ -0,0 +1,11 @@
+Deface::Override.new(:virtual_path => "spree/layouts/spree_application",
+                     :name => "gtm_head",
+                     :insert_bottom => "[data-hook='inside_head']",
+                     :partial => "spree/gtm/google_tag_manager_head",
+                     :disabled => false)
+
+Deface::Override.new(:virtual_path => "spree/layouts/spree_application",
+                     :name => "gtm_body",
+                     :insert_bottom => "[data-hook='body']",
+                     :partial => "spree/gtm/google_tag_manager_body",
+                     :disabled => false)

data/app/views/spree/admin/gtms/_form.html.erb

@@ -0,0 +1,4 @@
+<%= f.label :gtm_accountid %>
+<%= f.text_field :gtm_accountid, :class => 'form-control' %>
+<br />
+<%= f.submit 'Save', :name => 'save', :class => 'btn btn-primary'%>

data/app/views/spree/admin/gtms/edit.html.erb

@@ -0,0 +1,13 @@
+<% if @gtm.errors.any? %>
+   <h2>Errors:</h2>
+   <ul>
+     <% @gtm.errors.full_messages.each do |message| %>
+       <li><%= message %></li>
+     <% end %>
+   </ul>
+<% end %>
+
+
+<%= form_for [:admin, @gtm] do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+<% end %>

data/app/views/spree/admin/gtms/index.html.erb

@@ -0,0 +1,14 @@
+<h1><%= t('spree.gtm') %></h1>
+<div class="col-md-6">
+  <br />
+  <br />
+  <% if @gtm.new_record? %>
+    <%= form_for [:admin, @gtm] do |f| %>
+      <%= render :partial => "form", :locals => { :f => f } %>
+    <% end %>
+  <% else %>
+    <%= form_for [:admin, @gtm], :method => :put do |f| %>
+      <%= render :partial => "form", :locals => { :f => f } %>
+    <% end %>
+  <% end %>
+</div>

data/app/views/spree/gtm/_google_tag_manager_body.html.erb

@@ -0,0 +1,7 @@
+<!-- Google Tag Manager (noscript) -->
+<noscript>
+  <iframe src="//www.googletagmanager.com/ns.html?id=<%=  Spree::Gtm.gtm_accountid  %>"
+    height="0" width="0" style="display:none;visibility:hidden">
+  </iframe>
+</noscript>
+<!-- End Google Tag Manager (noscript) -->

data/app/views/spree/gtm/_google_tag_manager_head.html.erb

@@ -0,0 +1,10 @@
+<!-- Google Tag Manager -->
+
+<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=
+  'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+})(window,document,'script','dataLayer','<%= Spree::Gtm.gtm_accountid %>');
+</script>
+<!-- End Google Tag Manager -->

data/bin/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_gtm/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/config/routes.rb

@@ -0,0 +1,5 @@
+Spree::Core::Engine.routes.draw do
+  namespace :admin do
+    resources :gtms
+  end
+end

data/db/migrate/20161217192741_create_spree_gtm.rb

@@ -0,0 +1,7 @@
+class CreateSpreeGtm < ActiveRecord::Migration
+  def change
+    create_table :spree_gtms do |t|
+      t.string :gtm_accountid
+    end
+  end
+end

data/lib/generators/spree_gtm/install/install_generator.rb

@@ -0,0 +1,31 @@
+module SpreeGtm
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, :type => :boolean, :default => false
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/spree_gtm\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/spree_gtm\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/spree_gtm\n", :before => /\*\//, :verbose => true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/spree_gtm\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_gtm'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_gtm/engine.rb

@@ -0,0 +1,20 @@
+module SpreeGtm
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_gtm'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_gtm/factories.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_gtm/factories'
+end

data/lib/spree_gtm.rb

@@ -0,0 +1,2 @@
+require 'spree_core'
+require 'spree_gtm/engine'

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+# Run Coverage report
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec/dummy'
+  add_group 'Controllers', 'app/controllers'
+  add_group 'Helpers', 'app/helpers'
+  add_group 'Mailers', 'app/mailers'
+  add_group 'Models', 'app/models'
+  add_group 'Views', 'app/views'
+  add_group 'Libraries', 'lib'
+end
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+
+require 'rspec/rails'
+require 'database_cleaner'
+require 'ffaker'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+# Requires factories and other useful helpers defined in spree_core.
+require 'spree/testing_support/authorization_helpers'
+require 'spree/testing_support/capybara_ext'
+require 'spree/testing_support/controller_requests'
+require 'spree/testing_support/factories'
+require 'spree/testing_support/url_helpers'
+
+# Requires factories defined in lib/spree_gtm/factories.rb
+require 'spree_gtm/factories'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  # Infer an example group's spec type from the file location.
+  config.infer_spec_type_from_file_location!
+
+  # == URL Helpers
+  #
+  # Allows access to Spree's routes in specs:
+  #
+  # visit spree.admin_path
+  # current_path.should eql(spree.products_path)
+  config.include Spree::TestingSupport::UrlHelpers
+
+  # == Requests support
+  #
+  # Adds convenient methods to request Spree's controllers
+  # spree_get :index
+  config.include Spree::TestingSupport::ControllerRequests, type: :controller
+
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+  config.color = true
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # Capybara javascript drivers require transactional fixtures set to false, and we use DatabaseCleaner
+  # to cleanup after each test instead.  Without transactional fixtures set to false the records created
+  # to setup a test will be unavailable to the browser, which runs under a separate server instance.
+  config.use_transactional_fixtures = false
+
+  # Ensure Suite is set to use transactions for speed.
+  config.before :suite do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  # Before each spec check if it is a Javascript test and switch between using database transactions or not where necessary.
+  config.before :each do
+    DatabaseCleaner.strategy = RSpec.current_example.metadata[:js] ? :truncation : :transaction
+    DatabaseCleaner.start
+  end
+
+  # After each spec clean the database.
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+
+  config.fail_fast = ENV['FAIL_FAST'] || false
+  config.order = "random"
+end

data/spree_gtm.gemspec

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_gtm'
+  s.version     = '0.0.2'
+  s.summary     = 'some summary here'
+  s.description = 'some gem description here'
+  s.required_ruby_version = '>= 2.1.0'
+
+  s.authors    = ['Stanislav O. Pogrebnyak', 'Rostislav O. Korin']
+  s.email     = 'you@example.com'
+  # s.homepage  = 'http://www.spreecommerce.com'
+  s.license = 'BSD-3'
+
+  s.files       = `git ls-files`.split($/)
+  s.test_files  = s.files.grep(%r{^(test|spec|features)/})
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'spree_core', '~> 3.1.3'
+
+  s.add_development_dependency 'capybara', '~> 2.6'
+  s.add_development_dependency 'coffee-rails'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_girl', '~> 4.5'
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'rspec-rails', '~> 3.4'
+  s.add_development_dependency 'sass-rails', '~> 5.0.0'
+  s.add_development_dependency 'selenium-webdriver'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'sqlite3'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_gtm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Stanislav O. Pogrebnyak
@@ -170,7 +170,38 @@ email: you@example.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/spree/backend/spree_gtm.js
+- app/assets/javascripts/spree/frontend/spree_gtm.js
+- app/assets/stylesheets/spree/backend/spree_gtm.css
+- app/assets/stylesheets/spree/frontend/spree_gtm.css
+- app/controllers/spree/admin/gtms_controller.rb
+- app/models/spree.rb
+- app/models/spree/gtm.rb
+- app/overrides/spree/admin/shared/sub_menu/_configuration/add_gtm_to_admin_configurations_sidebar_menu.html.erb.deface
+- app/overrides/spree/gtm.rb
+- app/views/spree/admin/gtms/_form.html.erb
+- app/views/spree/admin/gtms/edit.html.erb
+- app/views/spree/admin/gtms/index.html.erb
+- app/views/spree/gtm/_google_tag_manager_body.html.erb
+- app/views/spree/gtm/_google_tag_manager_head.html.erb
+- bin/rails
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20161217192741_create_spree_gtm.rb
+- lib/generators/spree_gtm/install/install_generator.rb
+- lib/spree_gtm.rb
+- lib/spree_gtm/engine.rb
+- lib/spree_gtm/factories.rb
+- spec/spec_helper.rb
+- spree_gtm.gemspec
 homepage: 
 licenses:
 - BSD-3
@@ -196,4 +227,5 @@ rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: some summary here
-test_files: []
+test_files:
+- spec/spec_helper.rb