[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[ https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14393657#comment-14393657 ] ASF GitHub Bot commented on CB-8596: Github user asfgit closed the pull request at: https://github.com/apache/cordova-lib/pull/177 > cordova-lib API for retrieval of platforms and plugins from config.xml > --- > > Key: CB-8596 > URL: https://issues.apache.org/jira/browse/CB-8596 > Project: Apache Cordova > Issue Type: New Feature >Reporter: Omar Mefire >Assignee: Omar Mefire > > IDE's and other apps using cordova's APIs need a way to access project's > metadata (platforms and plugins within config.xml) without going directly > through the ConfigParser. They should be abstracted away from the storage > details. > This modification is made even more important with the upcoming move to npm > that is going to necessitate moving platforms and plugins infos to > package.json. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[ https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14384081#comment-14384081 ] ASF GitHub Bot commented on CB-8596: Github user nikhilkh commented on the pull request: https://github.com/apache/cordova-lib/pull/177#issuecomment-86994521 Yes, #191 subsumes this PR. I believe @omefire is on vacation and he will be able to close this when he's back. > cordova-lib API for retrieval of platforms and plugins from config.xml > --- > > Key: CB-8596 > URL: https://issues.apache.org/jira/browse/CB-8596 > Project: Apache Cordova > Issue Type: New Feature >Reporter: Omar Mefire >Assignee: Omar Mefire > > IDE's and other apps using cordova's APIs need a way to access project's > metadata (platforms and plugins within config.xml) without going directly > through the ConfigParser. They should be abstracted away from the storage > details. > This modification is made even more important with the upcoming move to npm > that is going to necessitate moving platforms and plugins infos to > package.json. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[ https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14384069#comment-14384069 ] ASF GitHub Bot commented on CB-8596: Github user kamrik commented on the pull request: https://github.com/apache/cordova-lib/pull/177#issuecomment-86993019 Was this all taken care of with #191 ? > cordova-lib API for retrieval of platforms and plugins from config.xml > --- > > Key: CB-8596 > URL: https://issues.apache.org/jira/browse/CB-8596 > Project: Apache Cordova > Issue Type: New Feature >Reporter: Omar Mefire >Assignee: Omar Mefire > > IDE's and other apps using cordova's APIs need a way to access project's > metadata (platforms and plugins within config.xml) without going directly > through the ConfigParser. They should be abstracted away from the storage > details. > This modification is made even more important with the upcoming move to npm > that is going to necessitate moving platforms and plugins infos to > package.json. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[ https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14384058#comment-14384058 ] ASF GitHub Bot commented on CB-8596: Github user asfgit closed the pull request at: https://github.com/apache/cordova-lib/pull/191 > cordova-lib API for retrieval of platforms and plugins from config.xml > --- > > Key: CB-8596 > URL: https://issues.apache.org/jira/browse/CB-8596 > Project: Apache Cordova > Issue Type: New Feature >Reporter: Omar Mefire >Assignee: Omar Mefire > > IDE's and other apps using cordova's APIs need a way to access project's > metadata (platforms and plugins within config.xml) without going directly > through the ConfigParser. They should be abstracted away from the storage > details. > This modification is made even more important with the upcoming move to npm > that is going to necessitate moving platforms and plugins infos to > package.json. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[ https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14384056#comment-14384056 ] ASF GitHub Bot commented on CB-8596: Github user kamrik commented on the pull request: https://github.com/apache/cordova-lib/pull/191#issuecomment-86991348 LGTM. Merging. > cordova-lib API for retrieval of platforms and plugins from config.xml > --- > > Key: CB-8596 > URL: https://issues.apache.org/jira/browse/CB-8596 > Project: Apache Cordova > Issue Type: New Feature >Reporter: Omar Mefire >Assignee: Omar Mefire > > IDE's and other apps using cordova's APIs need a way to access project's > metadata (platforms and plugins within config.xml) without going directly > through the ConfigParser. They should be abstracted away from the storage > details. > This modification is made even more important with the upcoming move to npm > that is going to necessitate moving platforms and plugins infos to > package.json. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[ https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14384057#comment-14384057 ] ASF subversion and git services commented on CB-8596: - Commit 5bacee84cfbfa87da195d3e809b3aec17593a60b in cordova-lib's branch refs/heads/master from [~TimBarham] [ https://git-wip-us.apache.org/repos/asf?p=cordova-lib.git;h=5bacee8 ] CB-8596 Expose APIs to retrieve platforms and plugins saved in config.xml. Provides third parties access to platform and plugin information stored in config.xml without having to go through ConfigParser. Based on work by @omefire, with the following changes: * Tests simplified to use predefined config.xml. * Updated to use "plugin" calls instead of "feature" calls. * Updates plugin metadata to return variables as an array. * Maps platform 'version' to 'src' if it doesn't look like a version (to handle the fact that platform stores either version or source in the 'version' property). * Removed getProjectMetadata method and renamed getProjectMetadata property of cordova to projectMetadata. So api is now simply cordova.projectMetadata.getPlatforms() and cordova.projectMetadata.getPlugins(). GitHub: close #191 > cordova-lib API for retrieval of platforms and plugins from config.xml > --- > > Key: CB-8596 > URL: https://issues.apache.org/jira/browse/CB-8596 > Project: Apache Cordova > Issue Type: New Feature >Reporter: Omar Mefire >Assignee: Omar Mefire > > IDE's and other apps using cordova's APIs need a way to access project's > metadata (platforms and plugins within config.xml) without going directly > through the ConfigParser. They should be abstracted away from the storage > details. > This modification is made even more important with the upcoming move to npm > that is going to necessitate moving platforms and plugins infos to > package.json. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[ https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14380843#comment-14380843 ] ASF GitHub Bot commented on CB-8596: Github user nikhilkh commented on the pull request: https://github.com/apache/cordova-lib/pull/177#issuecomment-86228108 This PR needs to be closed as it is a dup of #191. > cordova-lib API for retrieval of platforms and plugins from config.xml > --- > > Key: CB-8596 > URL: https://issues.apache.org/jira/browse/CB-8596 > Project: Apache Cordova > Issue Type: New Feature >Reporter: Omar Mefire >Assignee: Omar Mefire > > IDE's and other apps using cordova's APIs need a way to access project's > metadata (platforms and plugins within config.xml) without going directly > through the ConfigParser. They should be abstracted away from the storage > details. > This modification is made even more important with the upcoming move to npm > that is going to necessitate moving platforms and plugins infos to > package.json. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[ https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14379291#comment-14379291 ] ASF GitHub Bot commented on CB-8596: GitHub user TimBarham opened a pull request: https://github.com/apache/cordova-lib/pull/191 CB-8596 Expose APIs to retrieve platforms and plugins from config.xml Provides third parties access to platform and plugin information stored in `config.xml` without having to go through ConfigParser. Based on work by @omefire, with the following changes: * Tests simplified to use predefined `config.xml`. * Updated to use `plugin` calls instead of `feature` calls (which have been removed). * Updates plugin metadata to return `variables` property as an array. * Maps platform `version` to `src` if it doesn't look like a version (to handle the fact that platform stores either version or source in the `version` property). * Removed `getProjectMetadata` method and renamed `getProjectMetadata` property to `projectMetadata`. So api is now simply `cordova.projectMetadata.getPlatforms()` and `cordova.projectMetadata.getPlugins()`. You can merge this pull request into a Git repository by running: $ git pull https://github.com/MSOpenTech/cordova-lib CB-8596-tbarham Alternatively you can review and apply these changes as the patch at: https://github.com/apache/cordova-lib/pull/191.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #191 commit 6a42ffd36320da7bea7e3ee1b29e7c4187869a1c Author: Tim Barham Date: 2015-03-24T01:04:03Z CB-8596 Expose APIs to retrieve platforms and plugins saved in config.xml. Provides third parties access to platform and plugin information stored in config.xml without having to go through ConfigParser. Based on work by @omefire, with the following changes: * Tests simplified to use predefined config.xml. * Updated to use "plugin" calls instead of "feature" calls. * Updates plugin metadata to return variables as an array. * Maps platform 'version' to 'src' if it doesn't look like a version (to handle the fact that platform stores either version or source in the 'version' property). * Removed getProjectMetadata method and renamed getProjectMetadata property of cordova to projectMetadata. So api is now simply cordova.projectMetadata.getPlatforms() and cordova.projectMetadata.getPlugins(). > cordova-lib API for retrieval of platforms and plugins from config.xml > --- > > Key: CB-8596 > URL: https://issues.apache.org/jira/browse/CB-8596 > Project: Apache Cordova > Issue Type: New Feature >Reporter: Omar Mefire >Assignee: Omar Mefire > > IDE's and other apps using cordova's APIs need a way to access project's > metadata (platforms and plugins within config.xml) without going directly > through the ConfigParser. They should be abstracted away from the storage > details. > This modification is made even more important with the upcoming move to npm > that is going to necessitate moving platforms and plugins infos to > package.json. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[ https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14355389#comment-14355389 ] ASF GitHub Bot commented on CB-8596: Github user nikhilkh commented on the pull request: https://github.com/apache/cordova-lib/pull/177#issuecomment-78115338 I noticed that the plugin metadata that is exposed is the id and version number. What if the source is a git URL - how is that exposed? > cordova-lib API for retrieval of platforms and plugins from config.xml > --- > > Key: CB-8596 > URL: https://issues.apache.org/jira/browse/CB-8596 > Project: Apache Cordova > Issue Type: New Feature >Reporter: Omar Mefire >Assignee: Omar Mefire > > IDE's and other apps using cordova's APIs need a way to access project's > metadata (platforms and plugins within config.xml) without going directly > through the ConfigParser. They should be abstracted away from the storage > details. > This modification is made even more important with the upcoming move to npm > that is going to necessitate moving platforms and plugins infos to > package.json. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[
https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14355433#comment-14355433
]
ASF GitHub Bot commented on CB-8596:
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-lib/pull/177#discussion_r26152048
--- Diff: cordova-lib/src/cordova/project_metadata.js ---
@@ -0,0 +1,64 @@
+/**
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+*/
+
+var cordova_util = require('./util'),
+ConfigParser = require('../configparser/ConfigParser'),
+Q= require('q');
+
+/** Returns all the platforms that are currently saved into config.xml
+ * @return Promise<{{name: string, version: string}[]}> A promise to the
list of {name: platformName, version: platformVersion} objects
+ * e.g: [ {name: 'android', version: '3.5.0'}, {name: 'wp8', version:
'C:/path/to/platform'}, {name: 'ios', version: 'git://...'} ]
+ * ToDo: Once we move to npm, this function should be updated to rely on
npm instead
+ */
+function getPlatforms(projectRoot){
+var xml = cordova_util.projectConfig(projectRoot);
+var cfg = new ConfigParser(xml);
+return Q(cfg.getEngines());
+}
+
+/** Returns all the plugins that are currently saved into config.xml
+ * @return Promise<{{name: string, version: string}[]}> A promise to the
list of {name: platformName, version: platformVersion} objects
--- End diff --
Did you mean to say plugin name or really plugin id - instead of
platformName.
> cordova-lib API for retrieval of platforms and plugins from config.xml
> ---
>
> Key: CB-8596
> URL: https://issues.apache.org/jira/browse/CB-8596
> Project: Apache Cordova
> Issue Type: New Feature
>Reporter: Omar Mefire
>Assignee: Omar Mefire
>
> IDE's and other apps using cordova's APIs need a way to access project's
> metadata (platforms and plugins within config.xml) without going directly
> through the ConfigParser. They should be abstracted away from the storage
> details.
> This modification is made even more important with the upcoming move to npm
> that is going to necessitate moving platforms and plugins infos to
> package.json.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
-
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[
https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14355434#comment-14355434
]
ASF GitHub Bot commented on CB-8596:
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-lib/pull/177#discussion_r26152050
--- Diff: cordova-lib/src/cordova/project_metadata.js ---
@@ -0,0 +1,64 @@
+/**
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+*/
+
+var cordova_util = require('./util'),
+ConfigParser = require('../configparser/ConfigParser'),
+Q= require('q');
+
+/** Returns all the platforms that are currently saved into config.xml
+ * @return Promise<{{name: string, version: string}[]}> A promise to the
list of {name: platformName, version: platformVersion} objects
+ * e.g: [ {name: 'android', version: '3.5.0'}, {name: 'wp8', version:
'C:/path/to/platform'}, {name: 'ios', version: 'git://...'} ]
+ * ToDo: Once we move to npm, this function should be updated to rely on
npm instead
+ */
+function getPlatforms(projectRoot){
+var xml = cordova_util.projectConfig(projectRoot);
+var cfg = new ConfigParser(xml);
+return Q(cfg.getEngines());
+}
+
+/** Returns all the plugins that are currently saved into config.xml
+ * @return Promise<{{name: string, version: string}[]}> A promise to the
list of {name: platformName, version: platformVersion} objects
+ * e.g: [ {id: 'org.apache.cordova.device', name: 'Device', APP_ID:
'my-app-id', APP_NAME: 'my-app-name'} ]
--- End diff --
This example is confusing and does not match with the comment above.
> cordova-lib API for retrieval of platforms and plugins from config.xml
> ---
>
> Key: CB-8596
> URL: https://issues.apache.org/jira/browse/CB-8596
> Project: Apache Cordova
> Issue Type: New Feature
>Reporter: Omar Mefire
>Assignee: Omar Mefire
>
> IDE's and other apps using cordova's APIs need a way to access project's
> metadata (platforms and plugins within config.xml) without going directly
> through the ConfigParser. They should be abstracted away from the storage
> details.
> This modification is made even more important with the upcoming move to npm
> that is going to necessitate moving platforms and plugins infos to
> package.json.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
-
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[
https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14355399#comment-14355399
]
ASF GitHub Bot commented on CB-8596:
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-lib/pull/177#discussion_r26150341
--- Diff: cordova-lib/spec-cordova/project-metadata-apis.spec.js ---
@@ -0,0 +1,85 @@
+/**
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+*/
+
+var cordova = require('../src/cordova/cordova'),
+helpers = require('./helpers'),
+shell = require('shelljs'),
+path= require('path');
+
+describe('retrieval of project metadata', function(){
+
+var appId = 'org.testing';
+var appName = 'ProjectMetadataRetrievalTests';
+
+var configNormal = {
+lib: {
+www: {
+url: path.join(__dirname, 'fixtures', 'base', 'www'),
+version: 'testProjectMetadataRetrieval',
+id: appName
+}
+}
+};
+
+var tmpDir = helpers.tmpDir('project_metadata_test');
+var projectRoot = path.join(tmpDir, appName);
+
+beforeEach(function(){
+shell.rm('-rf', tmpDir);
+shell.rm('-rf', projectRoot);
+shell.mkdir('-p', tmpDir);
+});
+
+afterEach(function() {
+process.chdir(path.join(__dirname, '..')); // Windows: Needed to
rm the dir on Windows.
+shell.rm('-rf', tmpDir);
+});
+
+it('retrieve platforms and plugins saved in config.xml',
function(done){
+var devicePlugin = 'org.apache.cordova.device@0.2.11';
--- End diff --
Wonder if you need to add test case for git url being specified?
> cordova-lib API for retrieval of platforms and plugins from config.xml
> ---
>
> Key: CB-8596
> URL: https://issues.apache.org/jira/browse/CB-8596
> Project: Apache Cordova
> Issue Type: New Feature
>Reporter: Omar Mefire
>Assignee: Omar Mefire
>
> IDE's and other apps using cordova's APIs need a way to access project's
> metadata (platforms and plugins within config.xml) without going directly
> through the ConfigParser. They should be abstracted away from the storage
> details.
> This modification is made even more important with the upcoming move to npm
> that is going to necessitate moving platforms and plugins infos to
> package.json.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
-
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[
https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14355263#comment-14355263
]
ASF GitHub Bot commented on CB-8596:
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-lib/pull/177#discussion_r26143818
--- Diff: cordova-lib/src/cordova/project_metadata.js ---
@@ -0,0 +1,60 @@
+/**
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+*/
+
+var cordova_util = require('./util'),
+ConfigParser = require('../configparser/ConfigParser'),
+Q= require('q');
+
+// Returns all the platforms that are currently saved into config.xml
+// Return type is a promise that is fulfilled with a list of objects with
name and version properties. e.g: [{name: 'android', version: '3.5.0'}, {name:
'wp8', version: 'C:/path/to/platform'}, {name: 'ios', version: 'git://...'}]
+// ToDo: Once we move to npm, this function should be updated to rely on
npm instead
+function getPlatforms(projectRoot){
+var xml = cordova_util.projectConfig(projectRoot);
+var cfg = new ConfigParser(xml);
+return Q(cfg.getEngines());
+}
+
+// Returns all the plugins that are currently saved into config.xml
+// Return type is a promise that is fulfilled with a list of objects with
name and version properties. e.g: [ {id: 'org.apache.cordova.device', name:
'Device', APP_ID: 'my-app-id', APP_NAME: 'my-app-name'} ]
--- End diff --
Thanks for the suggestion. definitely cleaner comments...
I just pushed cleaner, more readable comments.
> cordova-lib API for retrieval of platforms and plugins from config.xml
> ---
>
> Key: CB-8596
> URL: https://issues.apache.org/jira/browse/CB-8596
> Project: Apache Cordova
> Issue Type: New Feature
>Reporter: Omar Mefire
>Assignee: Omar Mefire
>
> IDE's and other apps using cordova's APIs need a way to access project's
> metadata (platforms and plugins within config.xml) without going directly
> through the ConfigParser. They should be abstracted away from the storage
> details.
> This modification is made even more important with the upcoming move to npm
> that is going to necessitate moving platforms and plugins infos to
> package.json.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
-
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[
https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14348170#comment-14348170
]
ASF GitHub Bot commented on CB-8596:
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-lib/pull/177#discussion_r25840412
--- Diff: cordova-lib/src/cordova/project_metadata.js ---
@@ -0,0 +1,60 @@
+/**
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+*/
+
+var cordova_util = require('./util'),
+ConfigParser = require('../configparser/ConfigParser'),
+Q= require('q');
+
+// Returns all the platforms that are currently saved into config.xml
+// Return type is a promise that is fulfilled with a list of objects with
name and version properties. e.g: [{name: 'android', version: '3.5.0'}, {name:
'wp8', version: 'C:/path/to/platform'}, {name: 'ios', version: 'git://...'}]
+// ToDo: Once we move to npm, this function should be updated to rely on
npm instead
+function getPlatforms(projectRoot){
+var xml = cordova_util.projectConfig(projectRoot);
+var cfg = new ConfigParser(xml);
+return Q(cfg.getEngines());
+}
+
+// Returns all the plugins that are currently saved into config.xml
+// Return type is a promise that is fulfilled with a list of objects with
name and version properties. e.g: [ {id: 'org.apache.cordova.device', name:
'Device', APP_ID: 'my-app-id', APP_NAME: 'my-app-name'} ]
+// ToDO: Once we move to npm, this function should be updated to rely on
npm instead
+function getPlugins(projectRoot){
--- End diff --
Ah..in that case it makes sense to remain consistent and return Q. Is this
API documented? JSDoc comments are easier to read and serve as good
documentation.
From: Omar Mefire [mailto:notificati...@github.com]
Sent: Wednesday, March 4, 2015 8:50 PM
To: apache/cordova-lib
Cc: Nikhil Khandelwal
Subject: Re: [cordova-lib] CB-8596 Expose APIs to retrieve platforms and
plugins saved in config.xml (#177)
In
cordova-lib/src/cordova/project_metadata.js:
> +ConfigParser = require('../configparser/ConfigParser'),
> +Q= require('q');
> +
> +// Returns all the platforms that are currently saved into config.xml
> +// Return type is a promise that is fulfilled with a list of objects
with name and version properties. e.g: [{name: 'android', version: '3.5.0'},
{name: 'wp8', version: 'C:/path/to/platform'}, {name: 'ios', version:
'git://...'}]
> +// ToDo: Once we move to npm, this function should be updated to rely on
npm instead
> +function getPlatforms(projectRoot){
> +var xml = cordova_util.projectConfig(projectRoot);
> +var cfg = new ConfigParser(xml);
> +return Q(cfg.getEngines());
> +}
> +
> +// Returns all the plugins that are currently saved into config.xml
> +// Return type is a promise that is fulfilled with a list of objects
with name and version properties. e.g: [ {id: 'org.apache.cordova.device',
name: 'Device', APP_ID: 'my-app-id', APP_NAME: 'my-app-name'} ]
> +// ToDO: Once we move to npm, this function should be updated to rely on
npm instead
> +function getPlugins(projectRoot){
valid point! however, we already return promises with all our other APIs.
—
Reply to this email directly or view it on
GitHub.
> cordova-lib API for retrieval of platforms and plugins from config.xml
> ---
>
> Key: CB-8596
> URL: https://issues.apache.org/jira/browse/CB-8596
> Project: Apache Cordova
> Issue Type: New Feature
>Reporter: Omar Mefire
>Assignee: Omar Mefire
>
> IDE's a
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[
https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14348126#comment-14348126
]
ASF GitHub Bot commented on CB-8596:
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-lib/pull/177#discussion_r25839537
--- Diff: cordova-lib/src/cordova/project_metadata.js ---
@@ -0,0 +1,60 @@
+/**
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+*/
+
+var cordova_util = require('./util'),
+ConfigParser = require('../configparser/ConfigParser'),
+Q= require('q');
+
+// Returns all the platforms that are currently saved into config.xml
+// Return type is a promise that is fulfilled with a list of objects with
name and version properties. e.g: [{name: 'android', version: '3.5.0'}, {name:
'wp8', version: 'C:/path/to/platform'}, {name: 'ios', version: 'git://...'}]
+// ToDo: Once we move to npm, this function should be updated to rely on
npm instead
+function getPlatforms(projectRoot){
+var xml = cordova_util.projectConfig(projectRoot);
+var cfg = new ConfigParser(xml);
+return Q(cfg.getEngines());
+}
+
+// Returns all the plugins that are currently saved into config.xml
+// Return type is a promise that is fulfilled with a list of objects with
name and version properties. e.g: [ {id: 'org.apache.cordova.device', name:
'Device', APP_ID: 'my-app-id', APP_NAME: 'my-app-name'} ]
+// ToDO: Once we move to npm, this function should be updated to rely on
npm instead
+function getPlugins(projectRoot){
--- End diff --
valid point! however, we already return promises with all our other APIs.
> cordova-lib API for retrieval of platforms and plugins from config.xml
> ---
>
> Key: CB-8596
> URL: https://issues.apache.org/jira/browse/CB-8596
> Project: Apache Cordova
> Issue Type: New Feature
>Reporter: Omar Mefire
>Assignee: Omar Mefire
>
> IDE's and other apps using cordova's APIs need a way to access project's
> metadata (platforms and plugins within config.xml) without going directly
> through the ConfigParser. They should be abstracted away from the storage
> details.
> This modification is made even more important with the upcoming move to npm
> that is going to necessitate moving platforms and plugins infos to
> package.json.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
-
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[ https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14347906#comment-14347906 ] ASF GitHub Bot commented on CB-8596: Github user nikhilkh commented on the pull request: https://github.com/apache/cordova-lib/pull/177#issuecomment-77288127 Looks like your new tests are timing out and you might need to increase the timeout value. > cordova-lib API for retrieval of platforms and plugins from config.xml > --- > > Key: CB-8596 > URL: https://issues.apache.org/jira/browse/CB-8596 > Project: Apache Cordova > Issue Type: New Feature >Reporter: Omar Mefire >Assignee: Omar Mefire > > IDE's and other apps using cordova's APIs need a way to access project's > metadata (platforms and plugins within config.xml) without going directly > through the ConfigParser. They should be abstracted away from the storage > details. > This modification is made even more important with the upcoming move to npm > that is going to necessitate moving platforms and plugins infos to > package.json. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[
https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14347888#comment-14347888
]
ASF GitHub Bot commented on CB-8596:
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-lib/pull/177#discussion_r25831932
--- Diff: cordova-lib/src/cordova/project_metadata.js ---
@@ -0,0 +1,60 @@
+/**
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+*/
+
+var cordova_util = require('./util'),
+ConfigParser = require('../configparser/ConfigParser'),
+Q= require('q');
+
+// Returns all the platforms that are currently saved into config.xml
+// Return type is a promise that is fulfilled with a list of objects with
name and version properties. e.g: [{name: 'android', version: '3.5.0'}, {name:
'wp8', version: 'C:/path/to/platform'}, {name: 'ios', version: 'git://...'}]
+// ToDo: Once we move to npm, this function should be updated to rely on
npm instead
+function getPlatforms(projectRoot){
+var xml = cordova_util.projectConfig(projectRoot);
+var cfg = new ConfigParser(xml);
+return Q(cfg.getEngines());
+}
+
+// Returns all the plugins that are currently saved into config.xml
+// Return type is a promise that is fulfilled with a list of objects with
name and version properties. e.g: [ {id: 'org.apache.cordova.device', name:
'Device', APP_ID: 'my-app-id', APP_NAME: 'my-app-name'} ]
+// ToDO: Once we move to npm, this function should be updated to rely on
npm instead
+function getPlugins(projectRoot){
--- End diff --
Should we return promises from an API? This couples our implementation with
Q. We should ideally return the data itself and document the shape of the data
rather than return a Q based promise
> cordova-lib API for retrieval of platforms and plugins from config.xml
> ---
>
> Key: CB-8596
> URL: https://issues.apache.org/jira/browse/CB-8596
> Project: Apache Cordova
> Issue Type: New Feature
>Reporter: Omar Mefire
>Assignee: Omar Mefire
>
> IDE's and other apps using cordova's APIs need a way to access project's
> metadata (platforms and plugins within config.xml) without going directly
> through the ConfigParser. They should be abstracted away from the storage
> details.
> This modification is made even more important with the upcoming move to npm
> that is going to necessitate moving platforms and plugins infos to
> package.json.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
-
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[
https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14347883#comment-14347883
]
ASF GitHub Bot commented on CB-8596:
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-lib/pull/177#discussion_r25831848
--- Diff: cordova-lib/src/cordova/project_metadata.js ---
@@ -0,0 +1,60 @@
+/**
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+*/
+
+var cordova_util = require('./util'),
+ConfigParser = require('../configparser/ConfigParser'),
+Q= require('q');
+
+// Returns all the platforms that are currently saved into config.xml
+// Return type is a promise that is fulfilled with a list of objects with
name and version properties. e.g: [{name: 'android', version: '3.5.0'}, {name:
'wp8', version: 'C:/path/to/platform'}, {name: 'ios', version: 'git://...'}]
+// ToDo: Once we move to npm, this function should be updated to rely on
npm instead
+function getPlatforms(projectRoot){
+var xml = cordova_util.projectConfig(projectRoot);
+var cfg = new ConfigParser(xml);
+return Q(cfg.getEngines());
+}
+
+// Returns all the plugins that are currently saved into config.xml
+// Return type is a promise that is fulfilled with a list of objects with
name and version properties. e.g: [ {id: 'org.apache.cordova.device', name:
'Device', APP_ID: 'my-app-id', APP_NAME: 'my-app-name'} ]
--- End diff --
Consider using JSDoc comments. It's got good syntax and structure to
specify return values and types.
> cordova-lib API for retrieval of platforms and plugins from config.xml
> ---
>
> Key: CB-8596
> URL: https://issues.apache.org/jira/browse/CB-8596
> Project: Apache Cordova
> Issue Type: New Feature
>Reporter: Omar Mefire
>Assignee: Omar Mefire
>
> IDE's and other apps using cordova's APIs need a way to access project's
> metadata (platforms and plugins within config.xml) without going directly
> through the ConfigParser. They should be abstracted away from the storage
> details.
> This modification is made even more important with the upcoming move to npm
> that is going to necessitate moving platforms and plugins infos to
> package.json.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
-
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[ https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14346610#comment-14346610 ] ASF GitHub Bot commented on CB-8596: Github user omefire commented on the pull request: https://github.com/apache/cordova-lib/pull/177#issuecomment-77117803 hmmm, the build failure is something that seem to happen randomly. > cordova-lib API for retrieval of platforms and plugins from config.xml > --- > > Key: CB-8596 > URL: https://issues.apache.org/jira/browse/CB-8596 > Project: Apache Cordova > Issue Type: New Feature >Reporter: Omar Mefire >Assignee: Omar Mefire > > IDE's and other apps using cordova's APIs need a way to access project's > metadata (platforms and plugins within config.xml) without going directly > through the ConfigParser. They should be abstracted away from the storage > details. > This modification is made even more important with the upcoming move to npm > that is going to necessitate moving platforms and plugins infos to > package.json. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[ https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14346512#comment-14346512 ] ASF GitHub Bot commented on CB-8596: Github user omefire commented on the pull request: https://github.com/apache/cordova-lib/pull/177#issuecomment-77107166 After migrating platforms & plugins to package.json, This implementation will be updated, but clients will remain unchanged. > cordova-lib API for retrieval of platforms and plugins from config.xml > --- > > Key: CB-8596 > URL: https://issues.apache.org/jira/browse/CB-8596 > Project: Apache Cordova > Issue Type: New Feature >Reporter: Omar Mefire >Assignee: Omar Mefire > > IDE's and other apps using cordova's APIs need a way to access project's > metadata (platforms and plugins within config.xml) without going directly > through the ConfigParser. They should be abstracted away from the storage > details. > This modification is made even more important with the upcoming move to npm > that is going to necessitate moving platforms and plugins infos to > package.json. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[ https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14346513#comment-14346513 ] ASF GitHub Bot commented on CB-8596: Github user omefire commented on the pull request: https://github.com/apache/cordova-lib/pull/177#issuecomment-77107191 @agrieve , @stevengill please review. > cordova-lib API for retrieval of platforms and plugins from config.xml > --- > > Key: CB-8596 > URL: https://issues.apache.org/jira/browse/CB-8596 > Project: Apache Cordova > Issue Type: New Feature >Reporter: Omar Mefire >Assignee: Omar Mefire > > IDE's and other apps using cordova's APIs need a way to access project's > metadata (platforms and plugins within config.xml) without going directly > through the ConfigParser. They should be abstracted away from the storage > details. > This modification is made even more important with the upcoming move to npm > that is going to necessitate moving platforms and plugins infos to > package.json. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-8596) cordova-lib API for retrieval of platforms and plugins from config.xml
[ https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14346496#comment-14346496 ] ASF GitHub Bot commented on CB-8596: GitHub user omefire opened a pull request: https://github.com/apache/cordova-lib/pull/177 CB-8596 Expose APIs to retrieve platforms and plugins saved in config.xml CB-8596 Expose APIs to retrieve platforms and plugins saved in config.xml so as to abstract clients away from the config.xml details. You can merge this pull request into a Git repository by running: $ git pull https://github.com/MSOpenTech/cordova-lib CB-8596 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/cordova-lib/pull/177.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #177 commit d7d5e5b89d014f0f038263b612486d07facb3ef7 Author: Omar Mefire Date: 2015-03-03T22:42:59Z CB-8596 Expose APIs to retrieve platforms and plugins saved in config.xml so as to abstract clients away from the config.xml details. After migrating platforms & plugins to package.json, This implementation will be updated, but clients will remain stable. commit cbebb6785616119e82cd5dd3cd885fab806ec2ce Author: Omar Mefire Date: 2015-03-04T06:52:14Z CB-8596 Cleaning up > cordova-lib API for retrieval of platforms and plugins from config.xml > --- > > Key: CB-8596 > URL: https://issues.apache.org/jira/browse/CB-8596 > Project: Apache Cordova > Issue Type: New Feature >Reporter: Omar Mefire >Assignee: Omar Mefire > > IDE's and other apps using cordova's APIs need a way to access project's > metadata (platforms and plugins within config.xml) without going directly > through the ConfigParser. They should be abstracted away from the storage > details. > This modification is made even more important with the upcoming move to npm > that is going to necessitate moving platforms and plugins infos to > package.json. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
