cran 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cca72f620b46bffca847bbff603eeb6c6a6ea59
-  data.tar.gz: 59bc4cb09361733031b2e81e2a236fa172ab0e7f
+  metadata.gz: 5fbbe9eb76874a07cd133c56e9fc08b04d0920bf
+  data.tar.gz: 244301ad73937595b98704610b24d534c2607321
 SHA512:
-  metadata.gz: fe1653daafe986b0a0e9ed27e46d99b8f8bfd3be4c3b8063804af8590f63875fda656a49f466ddc4340bf0a68b7b967ee16af4d3136bb32d531fe2a3eca8ae2c
-  data.tar.gz: ffdd263e9e9827aa0cebe80e2c77393d8492b85838100aa3da9eb0037de3b496d7a89c35487e1e179264db9389e34e24a992700166ce339f8b3d19889c094127
+  metadata.gz: 299efceb1b8e4f94c1567fa8d7b74af31858040f9622dbbef60b8a270d4fc7e187b04fc985067ace4afd0a9b2c93988237fd5c41410c0853ea095d47d9517252
+  data.tar.gz: 66645a1953a1d58540f977a60c6a6a01a0b0e498ed69ec5cd42417eb616ec062c8f572a0cac05a9a1dcfa6be5447884f489cd56004cd499a2e82ffcce010bb92

data/.semver

@@ -1,5 +1,5 @@
 ---
 :major: 0
 :minor: 0
-:patch: 15
+:patch: 16
 :special: ''

data/README.md

@@ -1,16 +1,14 @@
 # Cran
 
-TODO: Write a gem description
-
 ## Installation
 
-Add this line to your application's Gemfile:
+Checkout the repository:
 
-    gem 'cran'
+    git co https://github.com/nakedmoon/cran
 
-And then execute:
+and do
 
-    $ bundle
+    bundle
 
 Or install it yourself as:
 
@@ -18,13 +16,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it ( http://github.com/<my-github-username>/cran/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-# cran
+    cran_indexer (or bundle exec bin/cran_indexer from the project directory)
+
+    Commands:
+      cran_indexer help [COMMAND]      # Describe available commands or one specific command
+      cran_indexer info -U, --url=URL  # Get Package Info
+      cran_indexer list                # List Indexed Files
+      cran_indexer reset               # Reset Indexed Files
+      cran_indexer start               # Start Cran Indexer
+
+### Indexer
+
+    cran_indexer help start (or bundle exec bin/cran_indexer from the project directory)
+
+    Usage:
+      cran_indexer start
+
+    Options:
+      -U, [--url=URL]                          # Repository URL
+                                               # Default: http://cran.r-project.org/src/contrib/
+      -E, [--raise-error], [--no-raise-error]  # Skip invalid files without raise an error
+      -L, [--limit=N]                          # Limit results items
+                                               # Default: 100
+      -P, [--processes=N]                      # Number of parallel processes during indexing
+                                               # Default: 4
+## Note
+* Indexer index new files on each launch
+* You can run it periodically at fixed times, dates, or intervals:
+    - Put the command in your crontab
+    - Use background service (DelayedJob, Sidekick, Resque) and instantiate the Repository class
+* Use of PStore as Key/Value storage (the closest filesystem structure)
+* You can easily create a new adapter (for example for Redis) extending the Cran::Adapter
+* Default logs in the log directory
+* Use semantic versioning (use semver CL to increase major/minor/patch)
+* It use parallel gem to parallelize the index process (speed up blocking operations like downloads)
+* Fully customizable log severity/adapters with Yell (you can change the severity updating the file cran.yaml)
+
+
+## Test
+
+    rake spec (from the project directory)
+
+### TODO
+* Check for process running writing a pid file
+* Move db file and logs in a system folder

data/config/cran.yml

@@ -1,6 +1,6 @@
 db:
   adapter: PStore
-  filename: cran
+  filename: cran_db
 
 package:
   content_type: 'application/x-gzip'
@@ -13,4 +13,4 @@ repository:
   limit: 100
 
 log:
-  level: warn
+  level: info

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cran
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Andrea Tore