Skip to content

Instantly share code, notes, and snippets.

@becckitt
Last active August 16, 2017 20:48
Show Gist options
  • Save becckitt/6bd903051e99d4c85ea47034ab96daf2 to your computer and use it in GitHub Desktop.
Save becckitt/6bd903051e99d4c85ea47034ab96daf2 to your computer and use it in GitHub Desktop.
Trackers_plan.md

Backend of app:

  • migrations (changing tracker & hymnal ad table)
  • fixing models
  • Tests (3 days)

Hymnal UI

  • Fixing form (1 day)

Publishing

  • Make sure trackers are added correctly when ad is published (timing tbd)
  • app/controllers/publishes_controller.rb
  • app/views/ads/show.html.erb (maybe?)
  • app/models/published_ad.rb
  • app/views/publishes/_sidebar_publishes.erb
  • lib/ad_publisher.rb (?)
  • Fix publishing tests
  • test/lib/ad_publisher_test.rb
  • test/models/published_ad_test.rb

Compiling

  • fixing how trackers get added to ads (4 days)

Rake task

  • Add the rake task (1 day)

Cleaning up the mess I just made

  • deleting metrics files (1 day)

Separate PR

  • running migration to get rid of metrics table (1 day)

Backend of app

Design changes:

  • db/schema.rb
  • config/routes.rb
  • config/application.rb
  • app/controllers/hymnal_ads_controller.rb
  • app/controllers/trackers_controller.rb
  • app/models/hymnal_ad.rb

Tests:

  • test/factories.rb
  • test/models/ad_server_test.rb
  • test/models/hymnal_ad_test.rb
  • test/controllers/metrics_instrumentations_controller_test.rb
  • test/controllers/trackers_controller_test.rb

Hymnal UI

  • app/views/hymnal_ads/_sidebar_tracking.html.erb
  • app/views/hymnal_ads/_hymnal_ads_footer.html.erb
  • app/views/hymnal_ads/preview.html.erb
  • app/views/hymnal_ads/preview_iframe.html
  • lib/sdk/js/ad.js
  • lib/sdk/js/hymnal.js
  • lib/sdk/js/metric_google_analytics.js
  • lib/sdk/js/metric_reporting.js
  • lib/sdk/js/metrics.js
  • lib/sdk/js/video_element.js

Are these being used?

  • app/views/shared/_svgs.html.erb
  • app/views/shared/_buttons.html.erb

Compiling an Ad

  • lib/compilers/hymnal_compiler.rb
  • lib/compilers/ad/ad.js.erb
  • config/adcompiler-manifest/default.yml

Publishing an Ad

  • app/controllers/publishes_controller.rb
  • app/models/published_ad.rb
  • app/views/publishes/_sidebar_publishes.erb (is this being used anywhere?)
  • test/lib/ad_publisher_test.rb
  • test/models/published_ad_test.rb

Cleanup:

Updating documentation:

  • doc/help_pages/debugging_ads.md
  • doc/help_pages/how_hymnal_ads_work.md
  • doc/help_pages/metrics_definitions.md
  • doc/help_pages/working_with_ad_javascript.md

To delete:

  • app/assets/javascripts/metrics_instrumentations.js
  • app/controllers/metrics_instrumentations_controller.rb
  • app/models/metrics_instrumentation.rb
  • app/models/metrics_instrumentations/basic_tracking.rb
  • test/models/metrics_instrumentation_test.rb
  • lib/metrics_instrumentation/templates/basic_tracking/setup.js.erb
  • lib/metrics_instrumentation/templates/metrics_instrumentation.js.erb

**Files with a mention but I am pretty sure they are not being used/ do not need to change for various reasons **

  • app/assets/stylesheets/legacy/pages/_m-ad.scss Irrelevant reference to metrics:
  • app/views/tools/apple_tag.html.erb
  • app/views/auth/failure_for_iframe.html.erb
  • app/controllers/designs_controller.rb
  • app/views/home/index.html.erb
  • app/views/designs/preview.html.erb
  • lib/stats.rb

Not being used:

  • app/views/patterns/_navigation.html.erb
  • app/controllers/ads_controller.rb
  • app/views/ads/preview.html.erb
  • app/views/ads/tracking.html.erb
  • lib/ad_publisher.rb
  • test/models/ad_test.rb
  • app/models/ad.rb
  • lib/compilers/ad.rb
  • app/views/ads/show.html.erb
  • app/helpers/ads_helper.rb (also we might be able to get rid of metrics_provider logos too, they're not being used anywhere. Proof: ads_helper --> search for metrics_provider_logo --> app/views/ads/show.html.erb --> search for @metrics_providers_config --> realize it's only ever referenced in this file, but not defined in a controller)

Don't need to be updated just trust me i think at least idk we'll find out

  • lib/sdk/js/metric_pixels.js (this is the "lib" we'll use for video tracking)
  • lib/harp_migration.rb
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment