Rename sp_type to share_type and sp_button_html to share_button_html

app/controllers/share/shares_controller.rb

@@ -41,7 +41,7 @@ def update
 
   def update_url
     @page.share_buttons.each do |button|
-      url = params[button.sp_type.to_sym]
+      url = params[button.share_type.to_sym]
 
       if url
         ShareVariantBuilder.update_button_url(url, button)

app/helpers/pages_helper.rb

@@ -158,10 +158,10 @@ def toggle_featured_link(page)
 
   def share_url(button)
     if button.share_progress?
-      "http://sumof.us/99/#{button.sp_id}/#{button.sp_type}"
+      "http://sumof.us/99/#{button.sp_id}/#{button.share_type}"
     else
-      # Extracts the share URL out of the sp_button_html field, which contains the markup for the button.
-      URI.extract(button.sp_button_html).first
+      # Extracts the share URL out of the share_button_html field, which contains the markup for the button.
+      URI.extract(button.share_button_html).first
     end
   end
 

app/lib/share_analytics.rb

@@ -32,6 +32,6 @@ def raw_data
   private
 
   def button
-    @button ||= Share::Button.find_by(page_id: @page.id, sp_type: @type)
+    @button ||= Share::Button.find_by(page_id: @page.id, share_type: @type)
   end
 end

app/liquid/shares.rb

@@ -9,23 +9,23 @@ class << self
     def get_all(page)
       buttons_with_variants(page).inject({}) do |shares, button|
         view_params = {
-          css_class: class_from_html(button.sp_button_html)
+          css_class: class_from_html(button.share_button_html)
         }
         unless button.share_progress?
-          variant = select_share_variant(button.sp_type, page)
+          variant = select_share_variant(button.share_type, page)
           view_params[:variant_id] = variant.id
           # Prepend the desired query parameters (uri encoded) into the url we want to share
           url = button.url << ERB::Util.url_encode("?src=whatsapp&variant_id=#{variant.id}")
-          view_params[:link_html] = button.sp_button_html.gsub('%7BLINK%7D', url)
+          view_params[:link_html] = button.share_button_html.gsub('%7BLINK%7D', url)
         end
-        shares[button.sp_type] = view_params
+        shares[button.share_type] = view_params
         shares
       end
     end
 
     def get_all_html(page)
       buttons_with_variants(page).inject({}) do |shares, button|
-        shares[button.sp_type] = button.sp_button_html.html_safe unless button.sp_button_html.blank?
+        shares[button.share_type] = button.share_button_html.html_safe unless button.share_button_html.blank?
         shares
       end
     end

app/models/share/button.rb

@@ -11,8 +11,8 @@
 #  updated_at     :datetime         not null
 #  sp_id          :string
 #  page_id        :integer
-#  sp_type        :string
-#  sp_button_html :string
+#  share_type        :string
+#  share_button_html :string
 #  analytics      :text
 #
 
@@ -22,8 +22,8 @@ class Share::Button < ApplicationRecord
 
   def share_progress?
     # the share types currently managed by share progress
-    %w[facebook twitter email].include? sp_type
+    %w[facebook twitter email].include? share_type
   end
 
-  scope :share_progress, -> { where sp_type: %w[facebook twitter email] }
+  scope :share_progress, -> { where share_type: %w[facebook twitter email] }
 end

app/services/share_variant_builder.rb

@@ -21,7 +21,7 @@ def update_button_url(url, button)
       if button.share_progress?
         sp_button = ShareProgress::Button.new(id: button.sp_id,
                                               page_url: url,
-                                              button_template: "sp_#{variant_initials(button.sp_type)}_large")
+                                              button_template: "sp_#{variant_initials(button.share_type)}_large")
         return unless sp_button.save
       end
       button.update(url: url)
@@ -48,22 +48,22 @@ def update
     @variant = variant_class.find(@id)
     @variant.assign_attributes(@params)
     return @variant if @variant.changed.empty? || @variant.invalid?
-    @button = Share::Button.find_by(sp_type: @variant_type, page_id: @page.id)
+    @button = Share::Button.find_by(share_type: @variant_type, page_id: @page.id)
     update_and_return
   end
 
   def create
     @variant = variant_class.new(@params)
     @variant.page = @page
     return @variant unless @variant.valid?
-    @button = Share::Button.find_or_initialize_by(sp_type: @variant_type, page_id: @page.id)
+    @button = Share::Button.find_or_initialize_by(share_type: @variant_type, page_id: @page.id)
     @variant.button = @button
     update_and_return
   end
 
   def destroy
     @variant = variant_class.find(@id)
-    @button = Share::Button.find_by(sp_type: @variant_type, page_id: @page.id)
+    @button = Share::Button.find_by(share_type: @variant_type, page_id: @page.id)
 
     if @variant.share_progress?
       sp_button = ShareProgress::Button.new(share_progress_button_params(@variant, @button))
@@ -96,7 +96,7 @@ def update_button
     case @variant_type
     when :whatsapp
       @button.update(
-        sp_button_html: '<a class="whatsapp_large" href="https://api.whatsapp.com'\
+        share_button_html: '<a class="whatsapp_large" href="https://api.whatsapp.com'\
         "/send?text=#{ERB::Util.url_encode(@variant.text)}\"></a>",
         url: @url
       )
@@ -106,7 +106,7 @@ def update_button
   def update_sp_resources
     sp_button = ShareProgress::Button.new(share_progress_button_params(@variant, @button))
     if sp_button.save
-      @button.update(sp_id: sp_button.id, sp_button_html: sp_button.share_button_html, url: sp_button.page_url)
+      @button.update(sp_id: sp_button.id, share_button_html: sp_button.share_button_html, url: sp_button.page_url)
       @variant.update(sp_id: sp_button.variants[@variant_type].last[:id])
     else
       add_sp_errors_to_variant(sp_button, @variant)

app/views/pages/_links_to_share_progress.slim

@@ -5,6 +5,6 @@
     td colspan='7'
       - links = buttons.map do |btn|
         - url = "https://run.shareprogress.org/analytics/#{btn.sp_id}"
-        - "<a href='#{url}' target='_blank'>#{btn.sp_type}</a>"
+        - "<a href='#{url}' target='_blank'>#{btn.share_type}</a>"
       .shares-editor__stats-heading class="#{only_stats ? '' : 'hidden-closed'}"
         = I18n.t('pages.edit.more_on_sp', {link: links.to_sentence}).html_safe

app/views/share/_update_urls_form.html.slim

@@ -9,7 +9,7 @@
       = form_tag page_share_endpoint_path(@page), method: :put, remote: true
         - @page.share_buttons.each do |button|
           .form-group
-            = label_tag button.sp_type, "URL to share on #{button.sp_type.capitalize}"
-            = text_field_tag button.sp_type, button.url, class: 'form-control'
+            = label_tag button.share_type, "URL to share on #{button.share_type.capitalize}"
+            = text_field_tag button.share_type, button.url, class: 'form-control'
         = submit_tag t('common.save'), class: 'btn btn-primary xhr-feedback', 'data-disable-with' => t('common.saving')
 

db/migrate/20180614131526_rename_share_progress_columns.rb

@@ -0,0 +1,6 @@
+class RenameShareProgressColumns < ActiveRecord::Migration[5.1]
+  def change
+    rename_column :share_buttons, :sp_type, :share_type
+    rename_column :share_buttons, :sp_button_html, :share_button_html
+  end
+end

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20180611102745) do
+ActiveRecord::Schema.define(version: 20180614131526) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -563,8 +563,8 @@
     t.datetime "updated_at", null: false
     t.string "sp_id"
     t.integer "page_id"
-    t.string "sp_type"
-    t.string "sp_button_html"
+    t.string "share_type"
+    t.string "share_button_html"
     t.text "analytics"
     t.index ["page_id"], name: "index_share_buttons_on_page_id"
   end

lib/tasks/button_ids.rake

@@ -5,7 +5,7 @@ namespace :champaign do
   task associate_buttons: :environment do
     Share::Variant.all.each do |variant|
       # ALERT - this needs good testing before running it on production
-      variant.button_id = Share::Button.find_by(page_id: variant.page_id, sp_type: variant.class.to_s.demodulize.downcase).id
+      variant.button_id = Share::Button.find_by(page_id: variant.page_id, share_type: variant.class.to_s.demodulize.downcase).id
       variant.save
     end
   end

spec/factories/share_buttons.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # == Schema Information
 #
 # Table name: share_buttons
@@ -10,8 +11,8 @@
 #  updated_at     :datetime         not null
 #  sp_id          :string
 #  page_id        :integer
-#  sp_type        :string
-#  sp_button_html :string
+#  share_type        :string
+#  share_button_html :string
 #  analytics      :text
 #
 
@@ -23,18 +24,18 @@
     sp_id 2
 
     trait :facebook do
-      sp_type 'facebook'
-      sp_button_html "<div class='sp_162041 sp_fb_large' ></div>"
+      share_type 'facebook'
+      share_button_html "<div class='sp_162041 sp_fb_large' ></div>"
     end
 
     trait :twitter do
-      sp_type 'twitter'
-      sp_button_html "<div class='sp_162043 sp_tw_large' ></div>"
+      share_type 'twitter'
+      share_button_html "<div class='sp_162043 sp_tw_large' ></div>"
     end
 
     trait :email do
-      sp_type 'email'
-      sp_button_html "<div class='sp_162130 sp_em_large' ></div>"
+      share_type 'email'
+      share_button_html "<div class='sp_162130 sp_em_large' ></div>"
     end
   end
 end

spec/helpers/pages_helper_spec.rb

@@ -243,7 +243,7 @@
   end
 
   describe '#share_url' do
-    let(:button) { double(sp_id: '2', sp_type: 'facebook', share_progress?: true) }
+    let(:button) { double(sp_id: '2', share_type: 'facebook', share_progress?: true) }
 
     it 'returns share url' do
       expect(helper.share_url(button)).to eq('http://sumof.us/99/2/facebook')

spec/models/share/button_spec.rb

@@ -11,8 +11,8 @@
 #  updated_at     :datetime         not null
 #  sp_id          :string
 #  page_id        :integer
-#  sp_type        :string
-#  sp_button_html :string
+#  share_type        :string
+#  share_button_html :string
 #  analytics      :text
 #
 
@@ -48,8 +48,8 @@
   end
 
   describe '.share_progress?' do
-    let(:facebook) { create :share_button, sp_type: 'facebook' }
-    let(:whatsapp) { create :share_button, sp_type: 'whatsapp' }
+    let(:facebook) { create :share_button, share_type: 'facebook' }
+    let(:whatsapp) { create :share_button, share_type: 'whatsapp' }
     it 'returns true if the share type is managed by ShareProgress' do
       expect(facebook.share_progress?).to eq true
       expect(whatsapp.share_progress?).to eq false
@@ -58,10 +58,10 @@
 
   describe 'scopes' do
     describe 'share_progress' do
-      let(:facebook) { create :share_button, sp_type: 'facebook' }
-      let(:whatsapp) { create :share_button, sp_type: 'whatsapp' }
-      let(:twitter) { create :share_button, sp_type: 'twitter' }
-      let(:email) { create :share_button, sp_type: 'email' }
+      let(:facebook) { create :share_button, share_type: 'facebook' }
+      let(:whatsapp) { create :share_button, share_type: 'whatsapp' }
+      let(:twitter) { create :share_button, share_type: 'twitter' }
+      let(:email) { create :share_button, share_type: 'email' }
       it 'returns buttons types that are managed by ShareProgress' do
         expect(Share::Button.share_progress).to include(facebook, twitter, email)
         expect(Share::Button.share_progress).to_not include(whatsapp)

spec/services/share_variant_builder_spec.rb

@@ -91,7 +91,7 @@
 
         button = Share::Button.first
         expect(button.sp_id).to eq('1')
-        expect(button.sp_button_html).to eq('<div />')
+        expect(button.share_button_html).to eq('<div />')
         expect(button.url).to eq 'http://example.com/foo'
       end
 
@@ -176,7 +176,7 @@
 
   describe '.update' do
     let!(:share) { create(:share_facebook, title: 'Foo') }
-    let!(:button) { create(:share_button, sp_type: 'facebook', page: page, sp_id: 23) }
+    let!(:button) { create(:share_button, share_type: 'facebook', page: page, sp_id: 23) }
     let(:params) { { title: 'Bar' } }
 
     subject(:update_variant) do
@@ -242,7 +242,7 @@
     end
 
     describe 'success' do
-      let!(:button) { create(:share_button, sp_type: 'facebook', page: page, sp_id: 24) }
+      let!(:button) { create(:share_button, share_type: 'facebook', page: page, sp_id: 24) }
       let!(:share) { create(:share_facebook, title: 'herpaderp', sp_id: 24) }
       let(:params) { { title: 'Bar' } }
 
@@ -269,7 +269,7 @@
     end
 
     describe 'failure' do
-      let!(:button) { create(:share_button, sp_type: 'facebook', page: page, sp_id: nil) }
+      let!(:button) { create(:share_button, share_type: 'facebook', page: page, sp_id: nil) }
       let!(:share) { create(:share_facebook, title: 'herpaderp', sp_id: nil) }
       let(:params) { { title: 'Bar' } }
 

spec/views/smoke_tests_spec.rb

@@ -45,7 +45,7 @@
         assign :sp_variations, [build(:share_facebook,
                                       id: 1,
                                       button:
-                                        build(:share_button, sp_id: 2, sp_type: 'facebook'))]
+                                        build(:share_button, sp_id: 2, share_type: 'facebook'))]
         assign :local_variations, []
         expect { render template: 'pages/edit' }.not_to raise_error
       end