Merge pull request #14 from dakixr/main

First pull request

.gitignore

@@ -128,3 +128,7 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+.DS_Store
+
+.vscode/

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include src/scc/assets *

README.md

@@ -1,2 +1,16 @@
+
 # Software Catalog Creator
-A repository that given an organization URL, it will create a software catalog for browsing all repositories
+
+A repository that given an organization URL, it will create a software catalog for browsing all repositories.
+
+## Example
+
+Click [here](https://dakixr.github.io/scc/example/index.html) to see an interactive example.
+
+## Install from GitHub
+
+```text
+git clone https://github.com/dakixr/scc
+cd scc
+pip install -e .
+```

example/app.js

@@ -0,0 +1,299 @@
+// Load cards data
+let cards = [];
+const loadCardsData = async () => {
+    try {
+        const res = await fetch('cards_data.json');
+        cards = await res.json();
+        displayCards(cards);
+    } catch (error) {
+        console.error(error);
+    }
+}
+
+// References
+const searchBar = document.getElementById('searchBar');
+
+const acknowledgement = document.getElementById('acknowledgement');
+const citation = document.getElementById('citation');
+const docker = document.getElementById('docker');
+const documentation = document.getElementById('documentation');
+const identifier = document.getElementById('identifier');
+const download = document.getElementById('download');
+const installation = document.getElementById('installation');
+const license = document.getElementById('license');
+const notebook = document.getElementById('notebook');
+const requirements = document.getElementById('requirements');
+const paper = document.getElementById('paper');
+
+const title = document.getElementById('title');
+const stars = document.getElementById('stars');
+const releases = document.getElementById('releases');
+const last_updated = document.getElementById('last_updated');
+
+
+// Listeners
+searchBar.addEventListener('keyup', () => { search(); })
+
+acknowledgement.addEventListener('click', () => { 
+    state_acknowledgement = !state_acknowledgement;  
+    if (state_acknowledgement)
+        acknowledgement.classList.add("filter-selected");
+    else acknowledgement.classList.remove("filter-selected");
+    search(); 
+});
+
+citation.addEventListener('click', () => { 
+    state_citation = !state_citation; 
+    if (state_citation)
+        citation.classList.add("filter-selected");
+    else citation.classList.remove("filter-selected");
+    search(); 
+});
+
+docker.addEventListener('click', () => { 
+    state_docker = !state_docker; 
+    if (state_docker)
+        docker.classList.add("filter-selected");
+    else docker.classList.remove("filter-selected");
+    search(); 
+});
+
+documentation.addEventListener('click', () => {
+    state_documentation = !state_documentation;
+    if (state_documentation)
+        documentation.classList.add("filter-selected");
+    else documentation.classList.remove("filter-selected");
+    search(); 
+});
+
+identifier.addEventListener('click', () => { 
+    state_identifier = !state_identifier;
+    if (state_identifier)
+        identifier.classList.add("filter-selected");
+    else identifier.classList.remove("filter-selected");
+    search(); 
+});
+
+download.addEventListener('click', () => { 
+    state_download = !state_download;
+    if (state_download)
+        download.classList.add("filter-selected");
+    else download.classList.remove("filter-selected");
+    search(); 
+});
+
+installation.addEventListener('click', () => { 
+    state_installation = !state_installation;
+    if (state_installation)
+        installation.classList.add("filter-selected");
+    else installation.classList.remove("filter-selected");
+    search(); 
+});
+
+license.addEventListener('click', () =>{ 
+    state_license = !state_license; 
+    if (state_license)
+        license.classList.add("filter-selected");
+    else license.classList.remove("filter-selected");
+    search(); 
+});
+
+notebook.addEventListener('click', () => { 
+    state_notebook = !state_notebook;
+    if (state_notebook)
+        notebook.classList.add("filter-selected");
+    else notebook.classList.remove("filter-selected");
+    search(); 
+});
+requirements.addEventListener('click', () => { 
+    state_requirements = !state_requirements;
+    if (state_requirements)
+        requirements.classList.add("filter-selected");
+    else requirements.classList.remove("filter-selected");
+    search(); 
+});
+paper.addEventListener('click', () => { 
+    state_paper = !state_paper; 
+    if (state_paper)
+        paper.classList.add("filter-selected");
+    else paper.classList.remove("filter-selected");
+    search(); 
+});
+
+title.addEventListener('click', () => { 
+    state_title = !state_title; state_stars = false; state_releases = false; state_last_updated = false; 
+    if (state_title){ title.classList.add("filter-selected"); }
+    else { title.classList.remove("filter-selected"); }
+    stars.classList.remove("filter-selected");
+    releases.classList.remove("filter-selected");
+    last_updated.classList.remove("filter-selected");
+    search(); 
+}); 
+
+stars.addEventListener('click', () => { 
+    state_title = false; state_stars = !state_stars; state_releases = false; state_last_updated = false; 
+    if (state_stars){ stars.classList.add("filter-selected"); }
+    else { stars.classList.remove("filter-selected"); }
+    title.classList.remove("filter-selected");
+    releases.classList.remove("filter-selected");
+    last_updated.classList.remove("filter-selected");
+    search(); 
+}); 
+releases.addEventListener('click', () => { 
+    state_title = false; state_stars = false; state_releases = !state_releases; state_last_updated = false; 
+    if (state_releases){ releases.classList.add("filter-selected"); }
+    else { releases.classList.remove("filter-selected"); }
+    title.classList.remove("filter-selected");
+    stars.classList.remove("filter-selected");
+    last_updated.classList.remove("filter-selected");
+    search(); 
+});
+
+last_updated.addEventListener('click', () => { 
+     state_title = false; state_stars = false; state_releases = false; state_last_updated = !state_last_updated; 
+    if (state_last_updated){ last_updated.classList.add("filter-selected"); }
+    else { last_updated.classList.remove("filter-selected"); }
+    title.classList.remove("filter-selected");
+    stars.classList.remove("filter-selected");
+    releases.classList.remove("filter-selected");
+    search(); 
+}); 
+
+// States
+let state_acknowledgement = false;
+let state_citation = false;
+let state_docker = false;
+let state_documentation = false;
+let state_identifier = false;
+let state_download = false;
+let state_installation = false;
+let state_license = false;
+let state_notebook = false;
+let state_requirements = false;
+let state_paper = false;
+
+let state_title = false;
+let state_stars = false;
+let state_releases = false;
+let state_last_updated = false;
+
+// Search engine
+function search() {
+
+    const usr_query = searchBar.value.toLowerCase();
+    const filteredCards = cards.filter(card => {
+        return (card.name.toLowerCase().includes(usr_query) || card.description.toLowerCase().includes(usr_query))
+            && ( 
+                   ((state_acknowledgement)? card.acknowledgement : true) 
+                && ((state_citation)? card.citation : true)
+                && ((state_docker)? card.hasBuildFile : true)
+                && ((state_documentation)? card.hasDocumentation : true)
+                && ((state_identifier)? card.identifier : true) 
+                && ((state_download)? card.downloadUrl : true)
+                && ((state_license)? card.license : true)
+                && ((state_notebook)? card.hasExecutableNotebook : true)
+                && ((state_paper)? card.paper : true)
+                && ((state_requirements)? card.requirement : true)
+                && ((state_installation)? card.installation : true));
+    });
+
+    // Order by
+    ordered_cards = filteredCards.sort((a,b) => {
+        if (state_title) {
+            return (a.name > b.name)? 1 : -1;
+        }
+        if (state_stars) {
+            return b.stargazersCount - a.stargazersCount;
+        }
+        if (state_releases) {
+            return b.releases - a.releases;
+        }
+        if (state_last_updated) {
+            return a.recently_updated - b.recently_updated;
+        }
+    });
+
+    displayCards(ordered_cards);
+}
+
+const displayCards = (cards) => {
+    const htmlString = cards
+        .map((card) => {
+            return card.html_card
+        })
+        .join('');
+    document.getElementById('myCards').innerHTML = htmlString
+
+    add_tooltip();
+    add_copy_card();
+    add_modals();
+}
+
+function add_modals() {
+    cards_icons_list = document.getElementsByClassName('ref-repo-icons');
+    for(const cards_icons of cards_icons_list){
+        for(const card_icon of cards_icons.children){
+            const icon = card_icon.getElementsByClassName('icon')[0];
+            const modal = card_icon.getElementsByClassName('modal')[0];
+            const span_close = card_icon.getElementsByClassName('close')[0];
+            if (modal != undefined){
+                icon.addEventListener('click', () => { 
+                    modal.classList.add('modal-on');
+                });
+                span_close.addEventListener('click', () => { 
+                    modal.classList.remove('modal-on');
+                });
+            }
+        }
+
+        const license = cards_icons.getElementsByClassName('ref-license')[0];
+        if (license != undefined) {
+            license.addEventListener('click', () => { 
+                getGithub(license);
+            });
+        }
+
+    }
+
+}
+
+
+loadCardsData();
+
+function addList(element, iterable){
+    var list = document.createElement("ol");
+        for (let i of iterable) {
+            let item = document.createElement("li");
+            item.innerHTML = i.charAt(0).toUpperCase() + i.slice(1);
+            list.appendChild(item);
+        }
+        element.innerHTML = '';
+        element.appendChild(list);
+}
+
+async function getGithub(license){
+    if (license.dataset.url != 'None'){
+        const response = await fetch(license.dataset.url);
+        const response_aux = await response.clone();
+        try {
+            const data =  await response.json();
+
+            const name = license.getElementsByClassName('ref-name')[0];
+            const description = license.getElementsByClassName('ref-description')[0];
+            const permissions = license.getElementsByClassName('ref-permissions')[0];
+            const conditions = license.getElementsByClassName('ref-conditions')[0];
+            const limitations = license.getElementsByClassName('ref-limitations')[0];
+
+            name.innerHTML = await data.name;
+            description.innerHTML = await data.description;
+
+            addList(permissions, data.permissions);
+            addList(conditions, data.conditions);
+            addList(limitations, data.limitations);
+
+        } catch (error) {
+            const description = license.getElementsByClassName('ref-description-aux')[0];
+            description.innerHTML = '<pre style="font-family: monospace;">'+await response_aux.text()+'</pre>';
+        }
+    } else console.log('No license.');
+}