Skip to content

Commit

Permalink
Further decouple from readium-cfi-js library by migrating over to ref…
Browse files Browse the repository at this point in the history
…erences to readium-shared-js
  • Loading branch information
Juan Corona authored and jccr committed Mar 16, 2018
1 parent e17cb47 commit 64d6118
Show file tree
Hide file tree
Showing 17 changed files with 68 additions and 103 deletions.
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ See [license.txt](./license.txt).

* `git clone --recursive -b BRANCH_NAME https://github.com/readium/readium-js-viewer.git readium-js-viewer` (replace "BRANCH_NAME" with e.g. "develop")
* `cd readium-js-viewer`
* `git submodule update --init --recursive` to ensure that the readium-js-viewer chain of dependencies is initialised (readium-js, readium-shared-js and readium-cfi-js)
* `git submodule update --init --recursive` to ensure that the readium-js-viewer chain of dependencies is initialised (readium-js, readium-shared-js)
* `git checkout BRANCH_NAME && git submodule foreach --recursive "git checkout BRANCH_NAME"` (or simply `cd` inside each repository / submodule, and manually enter the desired branch name: `git checkout BRANCH_NAME`) Git should automatically track the corresponding branch in the 'origin' remote.


Expand Down Expand Up @@ -96,7 +96,7 @@ Remark: logs of HTTP requests are preserved in two separate files `http_app.log`

### Forking

Assuming a fork of `https://github.com/readium/readium-js-viewer` is made under `USER` at `https://github.com/USER/readium-js-viewer`, the `.gitmodules` file ( https://github.com/readium/readium-js-viewer/blob/develop/.gitmodules ) will still point to the original submodule URL (at `readium`, instead of `USER`). Thankfully, one can simply modify the `.gitmodules` file by replacing `https://github.com/readium/` with `https://github.com/USER/`, and do this for every submodule (`readium-js-viewer` > `readium-js` > `readium-shared-js` > `readium-cfi-js`). Then the Git command `git submodule sync` can be invoked, for each submodule.
Assuming a fork of `https://github.com/readium/readium-js-viewer` is made under `USER` at `https://github.com/USER/readium-js-viewer`, the `.gitmodules` file ( https://github.com/readium/readium-js-viewer/blob/develop/.gitmodules ) will still point to the original submodule URL (at `readium`, instead of `USER`). Thankfully, one can simply modify the `.gitmodules` file by replacing `https://github.com/readium/` with `https://github.com/USER/`, and do this for every submodule (`readium-js-viewer` > `readium-js` > `readium-shared-js`). Then the Git command `git submodule sync` can be invoked, for each submodule.


### Plugins integration
Expand Down Expand Up @@ -261,12 +261,6 @@ Usage is demonstrated by the HTML file in the `dev` folder (trimmed for brevity)
<script type="text/javascript" src="../build-output/_multiple-bundles/RequireJS.js"> </script>
<!-- individual bundles: -->
<!-- readium CFI library -->
<script type="text/javascript" src="../build-output/_multiple-bundles/readium-cfi-js.js"> </script>
<!-- external libraries -->
<script type="text/javascript" src="../build-output/_multiple-bundles/readium-external-libs.js"> </script>
Expand Down
4 changes: 2 additions & 2 deletions build-config/RequireJS_config_multiple-bundles.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ require.config({
name: "readium-js-viewer",
create: true,
include: ["readium_js_viewer/ReadiumViewer"],
exclude: ["readium-js", "readium-external-libs", "readium-shared-js", "readium-cfi-js"],
exclude: ["readium-js", "readium-external-libs", "readium-shared-js"],
insertRequire: [
"readium_js_viewer/ReadiumViewer"
]
Expand All @@ -34,7 +34,7 @@ require.config({
name: "readium-js-viewer_LITE",
create: true,
include: ["readium_js_viewer/ReadiumViewerLite"],
exclude: ["readium-js", "readium-external-libs", "readium-shared-js", "readium-cfi-js"],
exclude: ["readium-js", "readium-external-libs", "readium-shared-js"],
insertRequire: [
"readium_js_viewer/ReadiumViewerLite"
]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ require.config({
create: true,
include: ["jath", "bootstrap", "bootstrapA11y", "hammerjs", "hogan", "jquery_hammer", "keymaster", "screenfull", "spin",
"mime-types", "zip", "zip-ext", "zip-fs", "cryptoJs/sha1", "cryptoJs/core",
'jquery',
'jquery', 'readium_cfi_js',
'underscore', 'URIjs', 'punycode', 'SecondLevelDomains', 'IPv6',
'jquerySizes', 'domReady', 'eventEmitter', 'console_shim',
'rangy', 'rangy-core', 'rangy-textrange', 'rangy-highlighter', 'rangy-cssclassapplier', 'rangy-position']
Expand Down
2 changes: 1 addition & 1 deletion build-config/RequireJS_config_single-bundle.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ require.config({
process._RJS_rootDir(2) + '/build-output/version',

"readium-js-viewer_all":
process._RJS_rootDir(2) + '/readium-js/readium-shared-js/readium-cfi-js/node_modules/almond/almond'
process._RJS_rootDir(2) + '/readium-js/readium-shared-js/node_modules/almond/almond'
}
});
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ require.config({
paths:
{
"readium-js-viewer_CHROMEAPP-WORKER":
process._RJS_rootDir(2) + '/readium-js/readium-shared-js/readium-cfi-js/node_modules/almond/almond',
process._RJS_rootDir(2) + '/readium-js/readium-shared-js/node_modules/almond/almond',

"readium_js_viewer_RJS-CONFIG":
process._RJS_rootDir(2) + '/src/chrome-app/requirejs-config',
Expand Down
2 changes: 1 addition & 1 deletion build-config/RequireJS_config_single-bundle_CHROMEAPP.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ require.config({
process._RJS_rootDir(2) + '/build-output/version',

"readium-js-viewer_all_CHROMEAPP":
process._RJS_rootDir(2) + '/readium-js/readium-shared-js/readium-cfi-js/node_modules/almond/almond',
process._RJS_rootDir(2) + '/readium-js/readium-shared-js/node_modules/almond/almond',

"readium_js_viewer_RJS-CONFIG":
process._RJS_rootDir(2) + '/src/chrome-app/requirejs-config',
Expand Down
2 changes: 1 addition & 1 deletion build-config/RequireJS_config_single-bundle_LITE.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ require.config({
process._RJS_rootDir(2) + '/build-output/version',

"readium-js-viewer_all_LITE":
process._RJS_rootDir(2) + '/readium-js/readium-shared-js/readium-cfi-js/node_modules/almond/almond'
process._RJS_rootDir(2) + '/readium-js/readium-shared-js/node_modules/almond/almond'
}
});
6 changes: 2 additions & 4 deletions build-config/versioning.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,14 @@ var path = require('path');
var path_readiumJSViewer = process.cwd();
var path_readiumJS = path.join(path_readiumJSViewer, '/readium-js');
var path_readiumSharedJS = path.join(path_readiumJS, '/readium-shared-js');
var path_readiumCfiJS = path.join(path_readiumSharedJS, '/readium-cfi-js');

var repoNamePaths = {
"readiumJsViewer": path_readiumJSViewer,
"readiumJs": path_readiumJS,
"readiumSharedJs": path_readiumSharedJS,
"readiumCfiJs": path_readiumCfiJS
"readiumSharedJs": path_readiumSharedJS
};

var filePath = path.join(process.cwd(), 'readium-js', 'readium-shared-js', 'readium-cfi-js', 'readium-build-tools', 'versionsMaker.js')
var filePath = path.join(process.cwd(), 'readium-js', 'readium-shared-js', 'readium-build-tools', 'versionsMaker.js')

var fs = require("fs");
fs.readFile(
Expand Down
6 changes: 1 addition & 5 deletions dev/index_RequireJS_multiple-bundles.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@
<script type="text/javascript" src="../build-output/_multiple-bundles/readium-external-libs.js.bundles.js"> </script>
<script type="text/javascript" src="../build-output/_multiple-bundles/readium-cfi-js.js.bundles.js"> </script>
<script type="text/javascript" src="../build-output/_multiple-bundles/readium-shared-js.js.bundles.js"> </script>
<script type="text/javascript" src="../build-output/_multiple-bundles/readium-plugin-example.js.bundles.js"> </script>
Expand All @@ -69,8 +67,6 @@

<script type="text/javascript" src="../build-output/_multiple-bundles/readium-external-libs.js"> </script>

<script type="text/javascript" src="../build-output/_multiple-bundles/readium-cfi-js.js"> </script>

<script type="text/javascript" src="../build-output/_multiple-bundles/readium-shared-js.js"> </script>

<script type="text/javascript" src="../build-output/_multiple-bundles/readium-plugin-example.js"> </script>
Expand All @@ -92,7 +88,7 @@

<script type="text/javascript">
window.process = undefined;
require(["readium_cfi_js/cfi_API", "readium_shared_js/globalsSetup"], function(){
require(["readium_shared_js/globalsSetup"], function(){
require(["jquery"], function(){
require(["readium_js_viewer/ReadiumViewer"], function(){});
});
Expand Down
6 changes: 1 addition & 5 deletions dev/index_RequireJS_multiple-bundles_LITE.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@
<script type="text/javascript" src="../build-output/_multiple-bundles/readium-external-libs.js.bundles.js"> </script>
<script type="text/javascript" src="../build-output/_multiple-bundles/readium-cfi-js.js.bundles.js"> </script>
<script type="text/javascript" src="../build-output/_multiple-bundles/readium-shared-js.js.bundles.js"> </script>
<script type="text/javascript" src="../build-output/_multiple-bundles/readium-plugin-example.js.bundles.js"> </script>
Expand All @@ -58,8 +56,6 @@

<script type="text/javascript" src="../build-output/_multiple-bundles/readium-external-libs.js"> </script>

<script type="text/javascript" src="../build-output/_multiple-bundles/readium-cfi-js.js"> </script>

<script type="text/javascript" src="../build-output/_multiple-bundles/readium-shared-js.js"> </script>

<script type="text/javascript" src="../build-output/_multiple-bundles/readium-plugin-example.js"> </script>
Expand All @@ -81,7 +77,7 @@

<script type="text/javascript">
window.process = undefined;
require(["readium_cfi_js/cfi_API", "readium_shared_js/globalsSetup"], function(){
require(["readium_shared_js/globalsSetup"], function(){
require(["jquery"], function(){
require(["readium_js_viewer/ReadiumViewerLite"], function(){});
});
Expand Down
5 changes: 2 additions & 3 deletions dev/index_RequireJS_no-optimize.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,11 @@



<script type="text/javascript" src="../readium-js/readium-shared-js/readium-cfi-js/node_modules/requirejs/require.js"> </script>
<script type="text/javascript" src="../readium-js/readium-shared-js/node_modules/requirejs/require.js"> </script>

<script type="text/javascript" src="../build-config/RequireJS_config_browser.js"> </script>
<script type="text/javascript" src="../readium-js/build-config/RequireJS_config_common.js"> </script>
<script type="text/javascript" src="../readium-js/readium-shared-js/build-config/RequireJS_config_common.js"> </script>
<script type="text/javascript" src="../readium-js/readium-shared-js/readium-cfi-js/build-config/RequireJS_config_common.js"> </script>
<script type="text/javascript" src="../build-config/RequireJS_config_common.js"> </script>

<script type="text/javascript" src="../readium-js/readium-shared-js/build-config/RequireJS_config_plugins.js"> </script>
Expand All @@ -55,7 +54,7 @@

<script type="text/javascript">
window.process = undefined;
require(["readium_cfi_js/cfi_API", "readium_shared_js/globalsSetup"], function(){
require(["readium_shared_js/globalsSetup"], function(){
require(["jquery"], function(){
require(["readium_js_viewer/ReadiumViewer"], function(){});
});
Expand Down
5 changes: 2 additions & 3 deletions dev/index_RequireJS_no-optimize_LITE.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,11 @@
<!-- link rel="stylesheet" type="text/css" href="../src/css/library.css" -->


<script type="text/javascript" src="../readium-js/readium-shared-js/readium-cfi-js/node_modules/requirejs/require.js"> </script>
<script type="text/javascript" src="../readium-js/readium-shared-js/node_modules/requirejs/require.js"> </script>

<script type="text/javascript" src="../build-config/RequireJS_config_browser.js"> </script>
<script type="text/javascript" src="../readium-js/build-config/RequireJS_config_common.js"> </script>
<script type="text/javascript" src="../readium-js/readium-shared-js/build-config/RequireJS_config_common.js"> </script>
<script type="text/javascript" src="../readium-js/readium-shared-js/readium-cfi-js/build-config/RequireJS_config_common.js"> </script>
<script type="text/javascript" src="../build-config/RequireJS_config_common.js"> </script>

<script type="text/javascript" src="../readium-js/readium-shared-js/build-config/RequireJS_config_plugins.js"> </script>
Expand All @@ -42,7 +41,7 @@

<script type="text/javascript">
window.process = undefined;
require(["readium_cfi_js/cfi_API", "readium_shared_js/globalsSetup"], function(){
require(["readium_shared_js/globalsSetup"], function(){
require(["jquery"], function(){
require(["readium_js_viewer/ReadiumViewerLite"], function(){});
});
Expand Down
4 changes: 0 additions & 4 deletions dev/version.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@
{
"name": "readiumSharedJs",
"path": "../readium-js/readium-shared-js"
},
{
"name": "readiumCfiJs",
"path": "../readium-js/readium-shared-js/readium-cfi-js"
}
]
}
Loading

0 comments on commit 64d6118

Please sign in to comment.