spree_analytics_trackers 1.0.0 → 1.0.1

data/config/routes.rb

@@ -0,0 +1,5 @@
+Spree::Core::Engine.add_routes do
+  namespace :admin, path: Spree.admin_path do
+    resources :trackers
+  end
+end

data/db/migrate/20171013160337_create_spree_trackers.rb

@@ -0,0 +1,20 @@
+class CreateSpreeTrackers < SpreeExtension::Migration[4.2]
+  def change
+    if table_exists?(:spree_trackers)
+      add_index :spree_trackers, :active unless index_exists?(:spree_trackers, :active)
+      remove_column :spree_trackers, :environment if column_exists?(:spree_trackers, :environment)
+      unless column_exists?(:spree_trackers, :engine)
+        add_column :spree_trackers, :kind, :integer, default: 0, null: false, index: true unless column_exists?(:spree_trackers, :kind)
+        rename_column :spree_trackers, :kind, :engine if column_exists?(:spree_trackers, :kind)
+      end
+    else
+      create_table :spree_trackers do |t|
+        t.string 'analytics_id'
+        t.boolean 'active', default: true, index: true
+        t.datetime 'created_at', null: false
+        t.datetime 'updated_at', null: false
+        t.integer 'engine', default: 0, null: false, index: true
+      end
+    end
+  end
+end

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/spree_3_5.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "spree", "~> 3.5.0"
+gem "spree_auth_devise", "~> 3.3.0"
+gem "rails-controller-testing"
+
+gemspec path: "../"

data/gemfiles/spree_3_7.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "spree", "~> 3.7.0"
+gem "spree_auth_devise", "~> 3.5.0"
+gem "rails-controller-testing"
+
+gemspec path: "../"

data/gemfiles/spree_master.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "spree", github: "spree/spree", branch: "master"
+gem "spree_auth_devise", github: "spree/spree_auth_devise", branch: "master"
+gem "mysql2", "~> 0.5.1"
+gem "rails-controller-testing"
+
+gemspec path: "../"

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

@@ -0,0 +1,20 @@
+module SpreeAnalyticsTrackers
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_analytics_trackers'
+      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_analytics_trackers.rb

@@ -0,0 +1,4 @@
+require 'spree_core'
+require 'spree_extension'
+require 'spree_analytics_trackers/engine'
+require 'spree_analytics_trackers/version'

data/lib/spree_analytics_trackers/engine.rb

@@ -0,0 +1,20 @@
+module SpreeAnalyticsTrackers
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_analytics_trackers'
+
+    # 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_analytics_trackers/factories.rb

@@ -0,0 +1,9 @@
+unless FactoryBot.factories.registered?(:tracker)
+  FactoryBot.define do
+    factory :tracker, class: Spree::Tracker do
+      analytics_id { 'A100' }
+      active { true }
+      engine { :google_analytics }
+    end
+  end
+end

data/lib/spree_analytics_trackers/version.rb

@@ -0,0 +1,17 @@
+module SpreeAnalyticsTrackers
+  module_function
+
+  # Returns the version of the currently loaded SpreeAnalyticsTrackers as a
+  # <tt>Gem::Version</tt>.
+  def version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
+  end
+end

data/spec/features/admin/configuration/analytics_tracker_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe 'Analytics Tracker', type: :feature do
+  stub_authorization!
+
+  context 'index' do
+    before(:each) do
+      create(:tracker)
+      create(:tracker, analytics_id: 'A200')
+      visit spree.admin_trackers_path
+    end
+
+    it 'should have the right content' do
+      expect(page).to have_content('Analytics Trackers')
+    end
+
+    it 'should have the right tabular values displayed' do
+      within_row(1) do
+        expect(column_text(1)).to eq('A100')
+        expect(column_text(2)).to eq('Google analytics')
+        expect(column_text(3)).to eq('Yes')
+      end
+
+      within_row(2) do
+        expect(column_text(1)).to eq('A200')
+        expect(column_text(2)).to eq('Google analytics')
+        expect(column_text(3)).to eq('Yes')
+      end
+    end
+  end
+
+  context 'create' do
+    before(:each) do
+      visit spree.admin_trackers_path
+    end
+
+    it 'should be able to create a new analytics tracker' do
+      click_link 'admin_new_tracker_link'
+      fill_in 'tracker_analytics_id', with: 'A100'
+      click_button 'Create'
+
+      expect(page).to have_content('successfully created!')
+      within_row(1) do
+        expect(column_text(1)).to eq('A100')
+        expect(column_text(2)).to eq('Google analytics')
+        expect(column_text(3)).to eq('Yes')
+      end
+    end
+  end
+end

data/spec/models/spree/tracker_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Spree::Tracker, type: :model do
+  describe 'current' do
+    it 'returns the first active tracker' do
+      tracker = create(:tracker)
+      tracker.clear_cache
+      expect(Spree::Tracker.current).to eq(tracker)
+    end
+
+    it 'does not return an inactive tracker' do
+      tracker = create(:tracker, active: false)
+      tracker.clear_cache
+      expect(Spree::Tracker.current).to be_nil
+    end
+  end
+end

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_analytics_trackers/factories.rb
+require 'spree_analytics_trackers/factories'
+
+RSpec.configure do |config|
+  config.include FactoryBot::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_analytics_trackers.gemspec

@@ -0,0 +1,44 @@
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'spree_analytics_trackers/version'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_analytics_trackers'
+  s.version     = SpreeAnalyticsTrackers.version
+  s.summary     = 'Adds analytics trackers functionality to Spree'
+  s.description = 'Supports Google Analytics '
+  s.required_ruby_version = '>= 2.2.7'
+
+  s.author    = 'Spark Solutions'
+  s.email     = 'we@sparksolutions.co'
+  s.homepage  = 'https://github.com/spree-contrib/spree_analytics_trackers'
+  s.license = 'BSD-3-Clause'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- spec/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  spree_version = '>= 3.1.0', '< 5.0'
+  s.add_dependency 'spree_core', spree_version
+  s.add_dependency 'spree_backend', spree_version
+  s.add_dependency 'spree_extension'
+
+  s.add_development_dependency 'appraisal'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'capybara-screenshot'
+  s.add_development_dependency 'chromedriver-helper'
+  s.add_development_dependency 'coffee-rails'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_bot', '~> 4.7'
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'mysql2'
+  s.add_development_dependency 'pg'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'sass-rails'
+  s.add_development_dependency 'selenium-webdriver'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'sqlite3', '~> 1.3.6'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_analytics_trackers
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Spark Solutions
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-07 00:00:00.000000000 Z
+date: 2019-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
@@ -264,22 +264,86 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
 description: 'Supports Google Analytics '
 email: we@sparksolutions.co
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/spree/admin/trackers_controller.rb
+- app/controllers/spree/store_controller_decorator.rb
+- app/helpers/spree/trackers_helper.rb
+- app/models/spree/line_item_decorator.rb
+- app/models/spree/order_decorator.rb
+- app/models/spree/product_decorator.rb
+- app/models/spree/tracker.rb
+- app/models/spree/user_decorator.rb
+- app/overrides/add_analytics_to_admin_sidebar.rb
+- app/overrides/add_cart_viewed_to_orders_edit.rb
+- app/overrides/add_checkout_step_viewed_to_checkout_edit.rb
+- app/overrides/add_google_analytics_to_spree_application.rb
+- app/overrides/add_google_checkout_to_checkout_edit.rb
+- app/overrides/add_google_purchase_to_orders_show.rb
+- app/overrides/add_order_complete_to_orders_show.rb
+- app/overrides/add_product_added_to_orders_edit.rb
+- app/overrides/add_product_list_filtered_to_taxons_show.rb
+- app/overrides/add_product_list_viewed_to_products_list.rb
+- app/overrides/add_product_viewed_to_products_show.rb
+- app/overrides/add_products_searched_to_products_list.rb
+- app/overrides/add_segment_initializer_to_layout.rb
+- app/views/spree/admin/shared/_analytics_sidebar_menu.html.erb
+- app/views/spree/admin/trackers/_form.html.erb
+- app/views/spree/admin/trackers/edit.html.erb
+- app/views/spree/admin/trackers/index.html.erb
+- app/views/spree/admin/trackers/new.html.erb
+- app/views/spree/shared/_google_add_items.html.erb
+- app/views/spree/shared/_google_analytics.html.erb
+- app/views/spree/shared/_google_checkout.html.erb
+- app/views/spree/shared/_google_purchase.html.erb
+- app/views/spree/shared/trackers/segment/_cart_viewed.js.erb
+- app/views/spree/shared/trackers/segment/_checkout_step_viewed.js.erb
+- app/views/spree/shared/trackers/segment/_initializer.js.erb
+- app/views/spree/shared/trackers/segment/_order_complete.js.erb
+- app/views/spree/shared/trackers/segment/_product_added.js.erb
+- app/views/spree/shared/trackers/segment/_product_list_filtered.js.erb
+- app/views/spree/shared/trackers/segment/_product_list_viewed.js.erb
+- app/views/spree/shared/trackers/segment/_product_viewed.js.erb
+- app/views/spree/shared/trackers/segment/_products_searched.js.erb
+- bin/rails
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20171013160337_create_spree_trackers.rb
+- gemfiles/.bundle/config
+- gemfiles/spree_3_5.gemfile
+- gemfiles/spree_3_7.gemfile
+- gemfiles/spree_master.gemfile
+- lib/generators/spree_analytics_trackers/install/install_generator.rb
+- lib/spree_analytics_trackers.rb
+- lib/spree_analytics_trackers/engine.rb
+- lib/spree_analytics_trackers/factories.rb
+- lib/spree_analytics_trackers/version.rb
+- spec/features/admin/configuration/analytics_tracker_spec.rb
+- spec/models/spree/tracker_spec.rb
+- spec/spec_helper.rb
+- spree_analytics_trackers.gemspec
 homepage: https://github.com/spree-contrib/spree_analytics_trackers
 licenses:
 - BSD-3-Clause
@@ -304,4 +368,7 @@ rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Adds analytics trackers functionality to Spree
-test_files: []
+test_files:
+- spec/features/admin/configuration/analytics_tracker_spec.rb
+- spec/models/spree/tracker_spec.rb
+- spec/spec_helper.rb