Merge pull request #463 from Shopify/paulinakhew-initialize-pre-commit

Paulinakhew · web-flow · commit 962521e2e6ac · 2021-02-17T16:34:55.000-05:00
Add pre-commit with end-of-file-fixer hook
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -0,0 +1,16 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+    - uses: pre-commit/action@v2.0.0
+      with:
+        extra_args: end-of-file-fixer --all-files
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,7 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+    -   id: end-of-file-fixer
diff --git a/README.md b/README.md
@@ -196,6 +196,13 @@ next_url = page1.next_page_url
 page2 = shopify.Product.find(from_=next_url)
 ```
 
+## Set up pre-commit locally [OPTIONAL]
+[Pre-commit](https://pre-commit.com/) is set up as a GitHub action that runs on pull requests and pushes to the `master` branch. If you want to run pre-commit locally, install it and set up the git hook scripts
+```shell
+pip install -r requirements.txt
+pre-commit install
+```
+
 ## Limitations
 
 Currently there is no support for:
diff --git a/test/api_version_test.py b/test/api_version_test.py
@@ -42,4 +42,3 @@ def test_two_release_versions_with_same_number_are_equal(self):
         version1 = shopify.Release('2019-01')
         version2 = shopify.Release('2019-01')
         self.assertEqual(version1, version2)
-
diff --git a/test/currency_test.py b/test/currency_test.py
@@ -20,4 +20,3 @@ def test_get_currencies(self):
         self.assertEqual("HKD", currencies[3].currency)
         self.assertEqual("2018-10-03T14:44:08-04:00", currencies[3].rate_updated_at)
         self.assertEqual(False, currencies[3].enabled)
-
diff --git a/test/discount_code_test.py b/test/discount_code_test.py
@@ -28,6 +28,3 @@ def test_delete_a_specific_discount_code(self):
       self.fake('price_rules/1213131/discount_codes/34', method='DELETE', body='destroyed')
       self.discount_code.destroy()
       self.assertEqual('DELETE', self.http.request.get_method())
-
-
-
diff --git a/test/event_test.py b/test/event_test.py
@@ -9,4 +9,3 @@ def test_prefix_uses_resource(self):
     def test_prefix_doesnt_need_resource(self):
         prefix = shopify.Event._prefix()
         self.assertEqual("https://this-is-my-test-show.myshopify.com/admin/api/unstable", prefix)
-
diff --git a/test/fixtures/access_scopes.json b/test/fixtures/access_scopes.json
@@ -10,4 +10,4 @@
       "handle": "read_orders"
     }
   ]
-}
+}
diff --git a/test/fixtures/api_version.json b/test/fixtures/api_version.json
@@ -1 +1 @@
-{"apis":[{"handle":"admin","versions":[{"handle":"2019-04","latest_supported":false,"display_name":"2019-04 (Unsupported)","supported":true},{"handle":"2019-07","latest_supported":false,"display_name":"2019-07 (Unsupported)","supported":true},{"handle":"2019-10","latest_supported":false,"display_name":"2019-10 (Unsupported)","supported":true},{"handle":"2020-01","latest_supported":false,"display_name":"2020-01","supported":true},{"handle":"2020-04","latest_supported":false,"display_name":"2020-04","supported":true},{"handle":"2020-07","latest_supported":false,"display_name":"2020-07","supported":true},{"handle":"2020-10","latest_supported":true,"display_name":"2020-10 (Latest)","supported":true},{"handle":"2021-01","latest_supported":false,"display_name":"2021-01 (Release candidate)","supported":false},{"handle":"unstable","latest_supported":false,"display_name":"unstable","supported":false}]},{"handle":"storefront","versions":[{"handle":"2019-07","latest_supported":false,"display_name":"2019-07 (Unsupported)","supported":true},{"handle":"2019-10","latest_supported":false,"display_name":"2019-10 (Unsupported)","supported":true},{"handle":"2020-01","latest_supported":false,"display_name":"2020-01","supported":true},{"handle":"2020-04","latest_supported":false,"display_name":"2020-04","supported":true},{"handle":"2020-07","latest_supported":false,"display_name":"2020-07","supported":true},{"handle":"2020-10","latest_supported":true,"display_name":"2020-10 (Latest)","supported":true},{"handle":"2021-01","latest_supported":false,"display_name":"2021-01 (Release candidate)","supported":false},{"handle":"unstable","latest_supported":false,"display_name":"unstable","supported":false}]}]}
+{"apis":[{"handle":"admin","versions":[{"handle":"2019-04","latest_supported":false,"display_name":"2019-04 (Unsupported)","supported":true},{"handle":"2019-07","latest_supported":false,"display_name":"2019-07 (Unsupported)","supported":true},{"handle":"2019-10","latest_supported":false,"display_name":"2019-10 (Unsupported)","supported":true},{"handle":"2020-01","latest_supported":false,"display_name":"2020-01","supported":true},{"handle":"2020-04","latest_supported":false,"display_name":"2020-04","supported":true},{"handle":"2020-07","latest_supported":false,"display_name":"2020-07","supported":true},{"handle":"2020-10","latest_supported":true,"display_name":"2020-10 (Latest)","supported":true},{"handle":"2021-01","latest_supported":false,"display_name":"2021-01 (Release candidate)","supported":false},{"handle":"unstable","latest_supported":false,"display_name":"unstable","supported":false}]},{"handle":"storefront","versions":[{"handle":"2019-07","latest_supported":false,"display_name":"2019-07 (Unsupported)","supported":true},{"handle":"2019-10","latest_supported":false,"display_name":"2019-10 (Unsupported)","supported":true},{"handle":"2020-01","latest_supported":false,"display_name":"2020-01","supported":true},{"handle":"2020-04","latest_supported":false,"display_name":"2020-04","supported":true},{"handle":"2020-07","latest_supported":false,"display_name":"2020-07","supported":true},{"handle":"2020-10","latest_supported":true,"display_name":"2020-10 (Latest)","supported":true},{"handle":"2021-01","latest_supported":false,"display_name":"2021-01 (Release candidate)","supported":false},{"handle":"unstable","latest_supported":false,"display_name":"unstable","supported":false}]}]}
diff --git a/test/fixtures/article.json b/test/fixtures/article.json
@@ -12,4 +12,4 @@
     "user_id": null,
     "tags": "consequuntur, cupiditate, repellendus"
   }
-}
+}
diff --git a/test/fixtures/articles.json b/test/fixtures/articles.json
@@ -36,4 +36,4 @@
     "user_id": 2221540,
     "tags": ""
   }]
-}
+}
diff --git a/test/fixtures/balance.json b/test/fixtures/balance.json
@@ -5,4 +5,4 @@
       "amount": "53.99"
     }
   ]
-}
+}
diff --git a/test/fixtures/blog.json b/test/fixtures/blog.json
@@ -10,4 +10,4 @@
     "feedburner": null,
     "commentable": "no"
   }
-}
+}
diff --git a/test/fixtures/blogs.json b/test/fixtures/blogs.json
@@ -10,4 +10,4 @@
     "feedburner": null,
     "commentable": "no"
   }]
-}
+}
diff --git a/test/fixtures/carts.json b/test/fixtures/carts.json
@@ -40,4 +40,4 @@
       ]
     }
   ]
-}
+}
diff --git a/test/fixtures/discount_code.json b/test/fixtures/discount_code.json
@@ -6,4 +6,4 @@
       "created_at": "2016-09-11T09:00:00-04:00",
       "updated_at": "2016-09-11T09:30:00-04:00"
     }
-}
+}
diff --git a/test/fixtures/discount_codes.json b/test/fixtures/discount_codes.json
@@ -8,4 +8,4 @@
       "updated_at": "2016-09-11T09:30:00-04:00"
     }
   ]
-}
+}
diff --git a/test/fixtures/dispute.json b/test/fixtures/dispute.json
@@ -13,4 +13,4 @@
     "finalized_on": null,
     "initiated_at": "2013-05-03T20:00:00-04:00"
   }
-}
+}
diff --git a/test/fixtures/disputes.json b/test/fixtures/disputes.json
@@ -99,4 +99,4 @@
       "initiated_at": "2013-05-03T20:00:00-04:00"
     }
   ]
-}
+}
diff --git a/test/fixtures/graphql.json b/test/fixtures/graphql.json
@@ -24,4 +24,3 @@
     "email": "steve@apple.com"
   }
 }
-
diff --git a/test/fixtures/payout.json b/test/fixtures/payout.json
@@ -18,4 +18,4 @@
       "retried_payouts_gross_amount": "0.00"
     }
   }
-}
+}
diff --git a/test/fixtures/payouts.json b/test/fixtures/payouts.json
@@ -115,4 +115,4 @@
       }
     }
   ]
-}
+}
diff --git a/test/fixtures/payouts_transactions.json b/test/fixtures/payouts_transactions.json
@@ -401,4 +401,4 @@
       "processed_at": "2012-11-11T19:00:00-05:00"
     }
   ]
-}
+}
diff --git a/test/fixtures/price_rule.json b/test/fixtures/price_rule.json
@@ -15,4 +15,4 @@
     "starts_at": "2017-05-30T04:13:56Z",
     "ends_at": null
   }
-}
+}
diff --git a/test/fixtures/price_rules.json b/test/fixtures/price_rules.json
@@ -33,4 +33,4 @@
       "ends_at": null
     }
   ]
-}
+}
diff --git a/test/fixtures/recurring_application_charges_no_active.json b/test/fixtures/recurring_application_charges_no_active.json
@@ -35,4 +35,4 @@
       "decorated_return_url": "http://yourapp.com?charge_id=455696195"
     }
   ]
-}
+}
diff --git a/test/fixtures/shipping_zones.json b/test/fixtures/shipping_zones.json
@@ -111,4 +111,4 @@
       ]
     }
   ]
-}
+}
diff --git a/test/fixtures/transaction.json b/test/fixtures/transaction.json
@@ -26,4 +26,4 @@
       "credit_card_company": "Visa"
     }
   }
-}
+}
diff --git a/test/gift_card_test.py b/test/gift_card_test.py
@@ -38,4 +38,4 @@ def test_search(self):
         self.fake("gift_cards/search.json?query=balance%3A10", extension=False, body=self.load_fixture('gift_cards_search'))
 
         results = shopify.GiftCard.search(query='balance:10')
-        self.assertEqual(results[0].balance, "10.00")
+        self.assertEqual(results[0].balance, "10.00")
diff --git a/test/graphql_test.py b/test/graphql_test.py
@@ -31,4 +31,4 @@ def setUp(self):
 
 
     def test_fetch_shop_with_graphql(self):
-        self.assertTrue(json.loads(self.result)['shop']['name'] == 'Apple Computers')
+        self.assertTrue(json.loads(self.result)['shop']['name'] == 'Apple Computers')
diff --git a/test/location_test.py b/test/location_test.py
@@ -27,4 +27,4 @@ def test_inventory_levels_returns_all_inventory_levels(self):
 
         self.assertEqual(location.id, inventory_levels[0].location_id)
         self.assertEqual(27, inventory_levels[0].available)
-        self.assertEqual(9, inventory_levels[1].available)
+        self.assertEqual(9, inventory_levels[1].available)

Original file line number	Diff line number	Diff line change
`@@ -10,4 +10,4 @@`
`10`	`10`	`"handle": "read_orders"`
`11`	`11`	`}`
`12`	`12`	`]`
`13`		`-}`
	`13`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-{"apis":[{"handle":"admin","versions":[{"handle":"2019-04","latest_supported":false,"display_name":"2019-04 (Unsupported)","supported":true},{"handle":"2019-07","latest_supported":false,"display_name":"2019-07 (Unsupported)","supported":true},{"handle":"2019-10","latest_supported":false,"display_name":"2019-10 (Unsupported)","supported":true},{"handle":"2020-01","latest_supported":false,"display_name":"2020-01","supported":true},{"handle":"2020-04","latest_supported":false,"display_name":"2020-04","supported":true},{"handle":"2020-07","latest_supported":false,"display_name":"2020-07","supported":true},{"handle":"2020-10","latest_supported":true,"display_name":"2020-10 (Latest)","supported":true},{"handle":"2021-01","latest_supported":false,"display_name":"2021-01 (Release candidate)","supported":false},{"handle":"unstable","latest_supported":false,"display_name":"unstable","supported":false}]},{"handle":"storefront","versions":[{"handle":"2019-07","latest_supported":false,"display_name":"2019-07 (Unsupported)","supported":true},{"handle":"2019-10","latest_supported":false,"display_name":"2019-10 (Unsupported)","supported":true},{"handle":"2020-01","latest_supported":false,"display_name":"2020-01","supported":true},{"handle":"2020-04","latest_supported":false,"display_name":"2020-04","supported":true},{"handle":"2020-07","latest_supported":false,"display_name":"2020-07","supported":true},{"handle":"2020-10","latest_supported":true,"display_name":"2020-10 (Latest)","supported":true},{"handle":"2021-01","latest_supported":false,"display_name":"2021-01 (Release candidate)","supported":false},{"handle":"unstable","latest_supported":false,"display_name":"unstable","supported":false}]}]}
	`1`	+{"apis":[{"handle":"admin","versions":[{"handle":"2019-04","latest_supported":false,"display_name":"2019-04 (Unsupported)","supported":true},{"handle":"2019-07","latest_supported":false,"display_name":"2019-07 (Unsupported)","supported":true},{"handle":"2019-10","latest_supported":false,"display_name":"2019-10 (Unsupported)","supported":true},{"handle":"2020-01","latest_supported":false,"display_name":"2020-01","supported":true},{"handle":"2020-04","latest_supported":false,"display_name":"2020-04","supported":true},{"handle":"2020-07","latest_supported":false,"display_name":"2020-07","supported":true},{"handle":"2020-10","latest_supported":true,"display_name":"2020-10 (Latest)","supported":true},{"handle":"2021-01","latest_supported":false,"display_name":"2021-01 (Release candidate)","supported":false},{"handle":"unstable","latest_supported":false,"display_name":"unstable","supported":false}]},{"handle":"storefront","versions":[{"handle":"2019-07","latest_supported":false,"display_name":"2019-07 (Unsupported)","supported":true},{"handle":"2019-10","latest_supported":false,"display_name":"2019-10 (Unsupported)","supported":true},{"handle":"2020-01","latest_supported":false,"display_name":"2020-01","supported":true},{"handle":"2020-04","latest_supported":false,"display_name":"2020-04","supported":true},{"handle":"2020-07","latest_supported":false,"display_name":"2020-07","supported":true},{"handle":"2020-10","latest_supported":true,"display_name":"2020-10 (Latest)","supported":true},{"handle":"2021-01","latest_supported":false,"display_name":"2021-01 (Release candidate)","supported":false},{"handle":"unstable","latest_supported":false,"display_name":"unstable","supported":false}]}]}
Original file line number	Diff line number	Diff line change
`@@ -12,4 +12,4 @@`
`12`	`12`	`"user_id": null,`
`13`	`13`	`"tags": "consequuntur, cupiditate, repellendus"`
`14`	`14`	`}`
`15`		`-}`
	`15`	`+}`