Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use ES2015 classes instead of having prototype-based functions #73

Merged
merged 28 commits into from
Oct 22, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
8615ed8
Use classes in channels.js
tomasko126 Sep 4, 2016
86fcca1
Turn domainset.js into ES2015 classes
tomasko126 Sep 4, 2016
93f2f45
Turn filterset.js code into classes
tomasko126 Sep 5, 2016
fc3c164
Turn filtertypes.js into classes
tomasko126 Sep 5, 2016
32b397e
Fixed typo
tomasko126 Sep 5, 2016
4c923b1
Fixed not calling super() and unitialized filter cache
tomasko126 Sep 5, 2016
a3a2a0c
Turn myfilters.js into class
tomasko126 Sep 5, 2016
41c91b6
Turn ElementChain into a class
tomasko126 Sep 5, 2016
ee51eb9
Turn overlay.js into a class + backport #69 fix
tomasko126 Sep 5, 2016
6ac7aab
Turn clickwatcher.js into a class
tomasko126 Sep 5, 2016
b8f40bf
Turn blacklistui.js into a class
tomasko126 Sep 5, 2016
ef5fdd7
Remove unneeded code
tomasko126 Sep 5, 2016
7079fbd
Turn filters.js into a class
tomasko126 Sep 5, 2016
2dbe96b
Change prototype fn to the static fn
tomasko126 Sep 5, 2016
17133fe
Change another fn to the static one
tomasko126 Sep 5, 2016
b71b1d9
Change Settings from prototype-based fn to a class
tomasko126 Sep 5, 2016
058b691
Change getExtensionFilters method to a static one, since it's used di…
tomasko126 Sep 5, 2016
8cbfe27
Revert last commit, access getExtensionFilters method from a prototype
tomasko126 Sep 5, 2016
71b2cc4
Prevent classes to be redefined
tomasko126 Sep 5, 2016
8c09490
Add moved files, which weren't added in the previous commit
tomasko126 Sep 5, 2016
09eaa6d
For..of is available since Safari 7.1, hence droppping support for Sa…
tomasko126 Sep 6, 2016
26bec99
Well, ES2015 classes are available in Safari 9 after all, dropping su…
tomasko126 Sep 6, 2016
948b469
Fix Codacy issues
tomasko126 Sep 6, 2016
6e0d899
Add removed arguments to the setEnabled method of Channels class
tomasko126 Sep 7, 2016
30069bc
Merge branch 'master' into es2015-classes
tomasko126 Sep 16, 2016
0db82a5
Merge branch 'master' into es2015-classes
tomasko126 Oct 22, 2016
8276388
Update README.md file
tomasko126 Oct 22, 2016
22f17f0
Remove unneded comments
tomasko126 Oct 22, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.project
.settings/.jsdtscope
.settings/org.eclipse.wst.jsdt.ui.superType.container
.settings/org.eclipse.wst.jsdt.ui.superType.name
.settings/org.eclipse.wst.jsdt.ui.superType.name
.DS_Store
80 changes: 31 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,72 +4,54 @@ CatBlock
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/cc8d000f77bb427caa8b0293d9b5d225)](https://www.codacy.com/app/tomastaro/catblock?utm_source=github.com&utm_medium=referral&utm_content=CatBlock/catblock&utm_campaign=Badge_Grade)
[![GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/CatBlock/catblock/blob/master/LICENSE.txt)

## Overview
CatBlock (previously known as "AdBlock with CatBlock") is like an ad blocking extension, but instead of blocking ads it shows you pictures of cats by default (configurable).

You can also disable replacing ads by cats, so CatBlock can work as a standard ad blocking extension (useful for when you're doing presentations anywhere!)

This project aims at maintaining and improving the original [CatBlock](http://blog.getadblock.com/2012/04/catblock-lives-on.html) project by Michael Gundlach, the creator of [AdBlock](https://getadblock.com) and CatBlock.
If you want to find out the history of this extension, you can check it out [here](https://github.com/CatBlock/catblock/wiki/History).

If you want to keep an eye on (or even contribute to) the behind-the-scenes stuff, check out our [Trello Board](https://trello.com/catblock).
## Goals
This project aims at maintaining and improving the original [CatBlock](http://catblock.getadblock.com) project by Michael Gundlach (the creator of [AdBlock](https://getadblock.com) and CatBlock), which is built on top of the AdBlock code.

## Installation:
Available in [Chrome Web Store](https://chrome.google.com/webstore/detail/catblock/mdcgnhlfpnbeieiiccmebgkfdebafodo),
[Opera Extensions Store](https://addons.opera.com/sk/extensions/details/adblock-with-catblock/?display=en) and [Firefox Addons Store](https://addons.mozilla.org/en/firefox/addon/adblock-with-catblock/).
Right now, CatBlock is not available in the [Safari Extensions Store](https://safari-extensions.apple.com), or in the Windows Store (for Edge insiders).
AdBlock has recently switched to the Adblock Plus codebase in version 3.0, but instead of importing those changes to CatBlock, we think it would be better to improve the original codebase.

## Tools used for testing:
We use many different services to help keep CatBlock working! We use [Travis](http://travis-ci.org) to build new versions automatically for us. We're looking into a way of making a "nightly" version of CatBlock, with bleeding-edge (probably broken) code for testing.
## Installation
CatBlock is available in [Chrome Web Store](https://chrome.google.com/webstore/detail/catblock/mdcgnhlfpnbeieiiccmebgkfdebafodo),
[Opera Extensions Store](https://addons.opera.com/sk/extensions/details/adblock-with-catblock/?display=en) and [Firefox Addons Store](https://addons.mozilla.org/en/firefox/addon/adblock-with-catblock/).

We also have Travis connected to [BrowserStack](http://browserstack.com), to run a few automated tests for us. If "builds:passing" shows at the top of this README, then it's probably working fine, otherwise the current version of the code might not work so well.
Right now, CatBlock is not available in the [Safari Extensions Store](https://safari-extensions.apple.com), or in the [Windows Store](https://www.microsoft.com/en-us/windows/windows-10-apps), but we are looking into releasing CatBlock there as well!

## Compatibility:
Chrome: 49+
Opera: 35+
Safari: 6+
Firefox: 48+
Edge: 38.14342+
If you can't wait for an official release of CatBlock on Windows Store, [find out](https://github.com/CatBlock/catblock/wiki/Building-the-extension#in-microsoft-edge) how to sideload CatBlock on Edge right now.

## Live chat:
[![Slack](http://catblock-slackin.herokuapp.com/badge.svg)](http://catblock-slackin.herokuapp.com)
## Supported browsers
CatBlock is compatible with following browsers:
- Chrome: 49+
- Opera: 35+
- Safari: 6+
- Firefox: 48+
- Edge: Windows 10 Anniversary - version 1607

We use Slack a lot - make an account at <http://catblock-slackin.herokuapp.com> and log in at <https://catblock.slack.com>. You can ask questions there (the main contributors are all in Europe, so anyone in Australia should expect a bit of a wait).
## Tools we use
We use many different services to help keep CatBlock working! We use [Travis](http://travis-ci.org) to build new versions automatically for us.

If you want to contribute any improvements, please go ahead and send us a pull request from a fork of this repo!
We also have Travis connected to [BrowserStack](http://browserstack.com), to run a few automated unit tests for us. If "builds:passing" shows at the top of this README, then it's probably working fine, otherwise the current version of the code might not work so well.

## Developers

0. Fork this repository.
1. Switch to your working directory.
2. Clone the development repository.

### In Chrome
### How to build the extension or create a development environment?
The [development guide](https://github.com/CatBlock/catblock/wiki/Building-the-extension) will make your life easier if you need to build CatBlock or create an unpacked development environment and change the source code.

3. Go to the Chrome menu > **Tools** > **Extensions**.
4. Check **Developer mode** then press **Load unpacked extension...** .
5. Find your working directory & select it.
6. To test after you make a change, be sure to click on **Reload** button on **chrome://extensions** page.
7. Push your changes.
8. Send us pull request!
### Do you want to contribute?
If you want to contribute any improvements to the code, please go ahead and send us a pull request from a fork of this repo!

### In Safari

3. First, you need to obtain a Safari Developer Certificate from [Apple](https://developer.apple.com/programs/safari/)
4. Go to **Develop** > **Show Extension Builder**.
5. Click **+** then select **Add Extension...** .
6. Find your working directory & select it.
7. Click **Install**.
8. To test after you make a change, be sure to click on **Reload** button in Extension Builder.
9. Push your changes.
10. Send us pull request!
If we see that you are a dedicated contributor, we may provide you with contributor permissions.
The people to contact for this project are [@kpeckett](https://github.com/kpeckett) and [@tomasko126](https://github.com/tomasko126).

### In Opera
### Do you want to know more about our project?
If you want to keep an eye on CatBlock or even know more about it, check out our [Wiki page](https://github.com/CatBlock/catblock/wiki), where you can find all important information.

3. Go to **about://extensions**.
4. Press **Developer Mode** then press **Load Unpacked Extension...** .
5. Find your working directory & select it.
6. To test after you make a change, be sure to click on **Reload** button on **about://extensions** page.
7. Push your changes.
8. Send us pull request!
## Get in touch with us
[![Slack](http://catblock-slackin.herokuapp.com/badge.svg)](http://catblock-slackin.herokuapp.com)

If we see that you are a dedicated contributor, we may provide you with contributor permissions.
The people to contact for this project are @kpeckett and @tomasko126
We use Slack a lot - make an account at <http://catblock-slackin.herokuapp.com> and log in at <https://catblock.slack.com>. You can ask questions there (the main contributors are all in Europe, so anyone in Australia should expect a bit of a wait).
Loading