Skip to content

Commit c88b8b9

Browse files
committed
Rename children -> assets in Resource
1 parent 26369f9 commit c88b8b9

File tree

4 files changed

+17
-21
lines changed

4 files changed

+17
-21
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Makes requests to `urls` and saves all files found with `sources` to `directory`
6262
- `result`: if error - `null`, if success - array of [Resource](https://github.com/s0ph1e/node-website-scraper/blob/master/lib/resource.js) objects containing:
6363
- `url`: url of loaded page
6464
- `filename`: filename where page was saved (relative to `directory`)
65-
- `children`: array of children Resources
65+
- `assets`: array of children Resources
6666

6767
### Filename Generators
6868
The filename generator determines where the scraped files are saved.

lib/resource.js

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ function getTypeByHtmlData (htmlData) {
1313
function Resource (url, filename) {
1414
this.url = url;
1515
this.filename = filename;
16-
this.children = [];
16+
this.assets = [];
1717
}
1818

1919
Resource.prototype.createChild = function createChild (url, filename) {
@@ -24,22 +24,18 @@ Resource.prototype.createChild = function createChild (url, filename) {
2424
child.setParent(this);
2525
child.setDepth(++currentDepth);
2626

27-
this.children.push(child);
27+
this.assets.push(child);
2828

2929
return child;
3030
};
3131

3232
Resource.prototype.updateChild = function updateChild (oldChild, newChild) {
33-
var index = _.indexOf(this.children, oldChild);
33+
var index = _.indexOf(this.assets, oldChild);
3434
if (index >= 0) {
35-
this.children[index] = newChild;
35+
this.assets[index] = newChild;
3636
}
3737
};
3838

39-
Resource.prototype.getChildren = function getChildren () {
40-
return this.children;
41-
};
42-
4339
Resource.prototype.getUrl = function getUrl () {
4440
return this.url;
4541
};

test/functional/base-test.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -69,19 +69,19 @@ describe('Functional base', function() {
6969
result.should.be.instanceOf(Array).and.have.length(3);
7070

7171
result[0].should.have.properties({ url: 'http://example.com/', filename: 'index.html' });
72-
result[0].should.have.properties('children');
73-
result[0].children.should.be.instanceOf(Array).and.have.length(4);
74-
result[0].children[0].should.be.instanceOf(Resource);
72+
result[0].should.have.properties('assets');
73+
result[0].assets.should.be.instanceOf(Array).and.have.length(4);
74+
result[0].assets[0].should.be.instanceOf(Resource);
7575

7676
result[1].should.have.properties({ url: 'http://example.com/about', filename: 'about.html' });
77-
result[1].should.have.properties('children');
78-
result[1].children.should.be.instanceOf(Array).and.have.length(4);
79-
result[1].children[0].should.be.instanceOf(Resource);
77+
result[1].should.have.properties('assets');
78+
result[1].assets.should.be.instanceOf(Array).and.have.length(4);
79+
result[1].assets[0].should.be.instanceOf(Resource);
8080

8181
result[2].should.have.properties({ url: 'http://blog.example.com/', filename: 'blog.html' }); // url after redirect
82-
result[2].should.have.properties('children');
83-
result[2].children.should.be.instanceOf(Array).and.have.length(1);
84-
result[2].children[0].should.be.instanceOf(Resource);
82+
result[2].should.have.properties('assets');
83+
result[2].assets.should.be.instanceOf(Array).and.have.length(1);
84+
result[2].assets[0].should.be.instanceOf(Resource);
8585

8686
// should create directory and subdirectories
8787
fs.existsSync(testDirname).should.be.eql(true);

test/unit/scraper-test.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ describe('Scraper', function () {
210210
}).catch(done);
211211
});
212212

213-
it('should return array of objects with url, filename and childre', function(done) {
213+
it('should return array of objects with url, filename and assets', function(done) {
214214
nock('http://first-url.com').get('/').reply(200, 'OK');
215215
nock('http://second-url.com').get('/').reply(500);
216216

@@ -225,8 +225,8 @@ describe('Scraper', function () {
225225
s.prepare().bind(s).then(s.load).then(function(res) {
226226
res.should.be.instanceOf(Array);
227227
res.should.have.length(2);
228-
res[0].should.be.instanceOf(Resource).and.have.properties(['url', 'filename', 'children']);
229-
res[1].should.be.instanceOf(Resource).and.have.properties(['url', 'filename', 'children']);
228+
res[0].should.be.instanceOf(Resource).and.have.properties(['url', 'filename', 'assets']);
229+
res[1].should.be.instanceOf(Resource).and.have.properties(['url', 'filename', 'assets']);
230230
done();
231231
}).catch(done);
232232
});

0 commit comments

Comments
 (0)