redminerb 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86ab53553c2c822bbd2eca3a1509d0cbf5398e55
-  data.tar.gz: 4fa29701cab649703cb0e724530e5a21b43b2de1
+  metadata.gz: e9f4f24f3042eab942ba77d07143a61b70bbed04
+  data.tar.gz: 83f92876f8e3f995bf552e42edefd631f9a59c46
 SHA512:
-  metadata.gz: a1fa0e876a7043e7c7276b097647c6572e97ad90bbf97f658c10a85ece9f3281401c05e372cd72045d51c3fc0e3da2e79e5704d181e39da89b87de1aca5ec075
-  data.tar.gz: 1b73b40315e6d8c78c265811d7d2719c49413898b57afe601272e5240cb7435268003b1469b69e4dce9ee11c0d848402388f8c1ff88af7182dbce6edfcf91775
+  metadata.gz: d077f662066d6838ab71cd26877358deb77a4d87980f14b2f702f455d5fabd7f6693db270daa9493112dd24705067e0be67bca386dd1a80fa4f562f7e2a8b315
+  data.tar.gz: a64a0ee960d56e34ee43282c6a2712cf20266b87c111c7fc3a6aeb97377d98ca7961b106ee519a038573b5bf4e4c224b0429bc29b0cef3c1f413614f92d8a423

data/CHANGELOG.rdoc

@@ -1,17 +1,21 @@
+== 0.5, released 2015-09-23
+
+* Local or home +.redminerb/templates+ directory for resource output customizations
+
 == 0.4, released 2015-09-22
 
-* 'redminerb users show <id>' to see a user's info.
+* +redminerb users show <id>+ to see a user's info
 
 == 0.3, released 2015-09-22
 
-* 'redminerb issues [show] <number>' to see an issue's info
-* 'redminerb issues list' to see open issues
+* +redminerb issues [show] <number>+ to see an issue's info
+* +redminerb issues list+ to see open issues
 
 == 0.2, released 2015-09-17
 
-* 'redminerb users create' to create a brand new user!
+* +redminerb users create+ to create a brand new user!
 
 == 0.1, released 2015-09-16
 
-* 'redminerb config' to get current config
-* 'redminerb users [list]' to see current users
+* +redminerb config+ to get current config
+* +redminerb users [list]+ to see current users

data/README.md

@@ -34,27 +34,35 @@ Or install it yourself as:
 
 ## Usage
 
-The URL and the API key of your Redmine REST API must be in your environment
-using *REDMINERB_URL* and *REDMINERB_API_KEY*, or in the `~/.redminerb.yml` as values
-of the *url* and *api_key* keys.
+In order to use `redminerb` the URL and the API key of your Redmine REST API must be available in one of the following places:
+
+
+1. **In your environment**: using *REDMINERB_URL* and *REDMINERB_API_KEY* env. vars.
+2. **In `~/.redminerb.yml`**: as values of *url* and *api_key*.
 
 For example, this `~/.redminerb.yml`:
 
     url: http://localhost:3000/
     api_key: 69b47d74e36a6757bac5d45f8398dd23bfa8f52c
 
-Would be the same as having the following in your `.bashrc`:
+Would be the same as having the following in your environment (declared in `.bashrc`, for example):
 
     export REDMINERB_URL=http://localhost:3000/
     export REDMINERB_API_KEY=69b47d74e36a6757bac5d45f8398dd23bfa8f52c
 
-GET request on a collection ressources give us the results as indicated by the
-[Redmine pagination documentation](http://www.redmine.org/projects/redmine/wiki/Rest_api#Collection-resources-and-pagination). You can use the *--limit (-l)* and *--offset (-o)* options.
+If both present environment variables have priority.
+
+Collections of resources will give us the results as indicated by the
+[Redmine pagination documentation](http://www.redmine.org/projects/redmine/wiki/Rest_api#Collection-resources-and-pagination) and the *--limit (-l)* and *--offset (-o)* options can be used.
 
-For example, you can see the third user of your Redmine with:
+For example, you could see the third user of your Redmine with:
 
     $ redminerb users -o 3 -l 1
 
+The output of particular resources can be customized creating the corresponding `.erb` file in the *.redminerb/templates* directory (the default templates could be found in the *templates* directory).
+
+The *.redminerb* directory will be search in your current directory first, and then in your home directory.
+
 ### Configuration (config)
 
 To see the current configuration used by Redminerb we have the `config` command:

data/lib/redminerb/template.rb

@@ -2,8 +2,10 @@
 require 'erb'
 
 module Redminerb
-  # Class to read Redminerb's ERB templates
+  # Class to render Redminerb's ERB templates
   class Template
+    TEMPLATES_DIR = '.redminerb/templates'
+
     class << self
       # Renders the template +name+ using +resource+ assigned to a local
       # variable with that same name in its binding (i.e. the template will
@@ -44,8 +46,24 @@ module Redminerb
       end
 
       def _filepath(name)
+        _localfile(name) || _homefile(name) || _gemfile(name)
+      end
+
+      def _localfile(name)
+        _filepath_or_nil "#{TEMPLATES_DIR}/#{name}.erb"
+      end
+
+      def _homefile(name)
+        _filepath_or_nil "#{ENV['HOME']}/#{TEMPLATES_DIR}/#{name}.erb"
+      end
+
+      def _gemfile(name)
         File.join(File.dirname(__FILE__)[0..-15], 'templates', "#{name}.erb")
       end
+
+      def _filepath_or_nil(filepath)
+        filepath if File.exist?(filepath)
+      end
     end
   end
 end

data/lib/redminerb/version.rb

@@ -1,4 +1,4 @@
 # Copyright (c) The Cocktail Experience S.L. (2015)
 module Redminerb
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redminerb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Fernando Garcia Samblas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-22 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor