cran 0.0.15 → 0.0.16

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/.semver +1 -1
  3. data/README.md +48 -16
  4. data/config/cran.yml +2 -2
  5. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 1cca72f620b46bffca847bbff603eeb6c6a6ea59
4
- data.tar.gz: 59bc4cb09361733031b2e81e2a236fa172ab0e7f
3
+ metadata.gz: 5fbbe9eb76874a07cd133c56e9fc08b04d0920bf
4
+ data.tar.gz: 244301ad73937595b98704610b24d534c2607321
5
5
  SHA512:
6
- metadata.gz: fe1653daafe986b0a0e9ed27e46d99b8f8bfd3be4c3b8063804af8590f63875fda656a49f466ddc4340bf0a68b7b967ee16af4d3136bb32d531fe2a3eca8ae2c
7
- data.tar.gz: ffdd263e9e9827aa0cebe80e2c77393d8492b85838100aa3da9eb0037de3b496d7a89c35487e1e179264db9389e34e24a992700166ce339f8b3d19889c094127
6
+ metadata.gz: 299efceb1b8e4f94c1567fa8d7b74af31858040f9622dbbef60b8a270d4fc7e187b04fc985067ace4afd0a9b2c93988237fd5c41410c0853ea095d47d9517252
7
+ data.tar.gz: 66645a1953a1d58540f977a60c6a6a01a0b0e498ed69ec5cd42417eb616ec062c8f572a0cac05a9a1dcfa6be5447884f489cd56004cd499a2e82ffcce010bb92
data/.semver CHANGED
@@ -1,5 +1,5 @@
1
1
  ---
2
2
  :major: 0
3
3
  :minor: 0
4
- :patch: 15
4
+ :patch: 16
5
5
  :special: ''
data/README.md CHANGED
@@ -1,16 +1,14 @@
1
1
  # Cran
2
2
 
3
- TODO: Write a gem description
4
-
5
3
  ## Installation
6
4
 
7
- Add this line to your application's Gemfile:
5
+ Checkout the repository:
8
6
 
9
- gem 'cran'
7
+ git co https://github.com/nakedmoon/cran
10
8
 
11
- And then execute:
9
+ and do
12
10
 
13
- $ bundle
11
+ bundle
14
12
 
15
13
  Or install it yourself as:
16
14
 
@@ -18,13 +16,47 @@ Or install it yourself as:
18
16
 
19
17
  ## Usage
20
18
 
21
- TODO: Write usage instructions here
22
-
23
- ## Contributing
24
-
25
- 1. Fork it ( http://github.com/<my-github-username>/cran/fork )
26
- 2. Create your feature branch (`git checkout -b my-new-feature`)
27
- 3. Commit your changes (`git commit -am 'Add some feature'`)
28
- 4. Push to the branch (`git push origin my-new-feature`)
29
- 5. Create new Pull Request
30
- # cran
19
+ cran_indexer (or bundle exec bin/cran_indexer from the project directory)
20
+
21
+ Commands:
22
+ cran_indexer help [COMMAND] # Describe available commands or one specific command
23
+ cran_indexer info -U, --url=URL # Get Package Info
24
+ cran_indexer list # List Indexed Files
25
+ cran_indexer reset # Reset Indexed Files
26
+ cran_indexer start # Start Cran Indexer
27
+
28
+ ### Indexer
29
+
30
+ cran_indexer help start (or bundle exec bin/cran_indexer from the project directory)
31
+
32
+ Usage:
33
+ cran_indexer start
34
+
35
+ Options:
36
+ -U, [--url=URL] # Repository URL
37
+ # Default: http://cran.r-project.org/src/contrib/
38
+ -E, [--raise-error], [--no-raise-error] # Skip invalid files without raise an error
39
+ -L, [--limit=N] # Limit results items
40
+ # Default: 100
41
+ -P, [--processes=N] # Number of parallel processes during indexing
42
+ # Default: 4
43
+ ## Note
44
+ * Indexer index new files on each launch
45
+ * You can run it periodically at fixed times, dates, or intervals:
46
+ - Put the command in your crontab
47
+ - Use background service (DelayedJob, Sidekick, Resque) and instantiate the Repository class
48
+ * Use of PStore as Key/Value storage (the closest filesystem structure)
49
+ * You can easily create a new adapter (for example for Redis) extending the Cran::Adapter
50
+ * Default logs in the log directory
51
+ * Use semantic versioning (use semver CL to increase major/minor/patch)
52
+ * It use parallel gem to parallelize the index process (speed up blocking operations like downloads)
53
+ * Fully customizable log severity/adapters with Yell (you can change the severity updating the file cran.yaml)
54
+
55
+
56
+ ## Test
57
+
58
+ rake spec (from the project directory)
59
+
60
+ ### TODO
61
+ * Check for process running writing a pid file
62
+ * Move db file and logs in a system folder
data/config/cran.yml CHANGED
@@ -1,6 +1,6 @@
1
1
  db:
2
2
  adapter: PStore
3
- filename: cran
3
+ filename: cran_db
4
4
 
5
5
  package:
6
6
  content_type: 'application/x-gzip'
@@ -13,4 +13,4 @@ repository:
13
13
  limit: 100
14
14
 
15
15
  log:
16
- level: warn
16
+ level: info
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cran
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.15
4
+ version: 0.0.16
5
5
  platform: ruby
6
6
  authors:
7
7
  - Andrea Tore