redminerb 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 347a49accfc5f3a6e6d4eea8e48976443773c6ab
-  data.tar.gz: 1352e7491d1e6675829e95e2b1c94ade493a9aa3
+  metadata.gz: 747f0c97c7d76ba854ec38522436b28472ff06cf
+  data.tar.gz: c865d6012d0e98fd83509f123271d7e384e203ea
 SHA512:
-  metadata.gz: a98f2a26498d4a7a1fce4b1f160901d755114b4b9d62d855389648657152144a06967688029fca52e0894e6b541e5bbb45761ca80c5490ba08a9c7717a0df600
-  data.tar.gz: e5958d2ad1fa6406815482acfb90068fa68e0f7eff5f3e925fdedc8d3248f7ef4c12df4e7c2b525be4696e392b2cbbd1575d448f31854fd38038d026c5107cfc
+  metadata.gz: 575252af1e2233e0743ca70a6324e4a0f2457756775c3c6836ab68c6f1e1ca1ece024653e1d136f79e4eeefbd1380aa016e787ccb6ae50d9c57252e823f5f4d4
+  data.tar.gz: 4a81b7ab83059a60cfd08e9228f38b4fbbccca846a10e03c31d9da07b95df84b3f9d29f181671a9b9bc1f72c888cf3c2eb4cd5a7933e8d46c3e1ae70d8257f52

data/CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+= CHANGELOG
+== 0.7, released 2015-10-05
+
+* Show subcommand's +--template+ option for user/issue command to indicate the .erb template to render.
+* Optimized & unified the default subcommand (list/show).
+* ASCII box chars "helpers" added to the Redminerb module singleton functions.
+* Two alternative views (*issue_boxie.erb* and *user_in_a_box.erb*).
+
 == 0.6, released 2015-09-28
 
 * +templates/issue.erb+ uses a recursive OStruct for internal objects -letting us for example say +issue.author.name+ instead of +issue.author['name']+

data/README.md

@@ -36,7 +36,6 @@ Or install it yourself as:
 
 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*.
 
@@ -50,19 +49,56 @@ Would be the same as having the following in your environment (declared in `~/.b
     export REDMINERB_URL=http://localhost:3000/
     export REDMINERB_API_KEY=69b47d74e36a6757bac5d45f8398dd23bfa8f52c
 
-If both present environment variables have priority.
+If both present **environment variables have priority**.
+
+As a general rule, the `list` subcomand is the one assumed when omitted, but if a number is given instead of a subcomand, then the `show` subcommand will be call using that number as param. For example `redminerb users 1` will show us the info of the first user of our Redmine. Notice that also the singular can be used for the command, which is nice for these cases (i.e. `redminerb user 1`, thanks Thor!)
+
+### Pagination
 
 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 could see the third user of your Redmine with:
 
+    $ redminerb users list --offset 3 --limit 1
+
+That is the same than asking for:
+
     $ 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).
+Because `list` is the default subcommand for the `users` command.
+
+### Custom ERB templates
+
+The output of **a single resource** obtained with **the `show` subcommand can be customized creating the corresponding `.erb` file** in the *.redminerb/templates* directory. In the template we can access to the resource using its generic name, e.g. `user` or `issue`.
+
+The default templates could be found in the *templates* directory.
+
+For example, to customize the output of an issue, we could write the following content in the `.redminerb/issue.erb`:
+
+    Number: <%= issue.id %>
+    Title: <%= issue.subject %>
 
 The *.redminerb* directory will be search in your current directory first, and then in your home directory.
 
+We can also create other templates and use them through **the `--template` option**. For example:
+
+    $ redminerb users show 34 --template user_in_a_box
+
+Will use the file `.redminerb/user_in_a_box.erb` as template, whose content could be the following:
+
+    <%= Redminerb.top %>
+    <%= Redminerb.line user.login %>
+    <%= Redminerb.bottom %>
+
+As you can see Redminerb give us also some functions to draw its output using old-school boxes. These functions are:
+
+* **Redminerb.top**: shows the top of the box (i.e. `┌──────┐`).
+* **Redminerb.middle**: shows a line in the middle of the box (i.e. `├──────┤`).
+* **Redminerb.bottom**: shows the bottom of the box (i.e. `└──────┘`).
+* **Redminerb.line** *string*: content into the box (i.e. `│ Example │`).
+* **Redminerb.separator**: a line from left to right (like *middle* wo/ box borders).
+
 ### Configuration (config)
 
 To see the current configuration used by Redminerb we have the `config` command:
@@ -110,7 +146,7 @@ the API key used to access the Rest API (hopefully your data :).
 
 #### Show user's data
 
-    $ redminerb users show <id>
+    $ redminerb users [show] <id> # aka "redminerb users <id>"
 
 Will give us the info associated with the user with the given *id*.
 
@@ -141,7 +177,7 @@ The **issues** command is the wrapper for part of the [Issues resource](http://w
 
 #### List issues
 
-    $ redminerb issues list
+    $ redminerb issues list # aka "redminerb issues"
 
 #### Show an issue
 
@@ -151,10 +187,6 @@ Shows the info of an issue with a number or id.
 
 For example, to see the info of the issue #12532 we'd launch:
 
-    $ redminerb issues show 12539
-
-*show* is the default subcommand, so the following order has the same output as the following:
-
     $ redminerb issues 12539
 
 ## Development

data/lib/redminerb/cli/issues.rb

@@ -5,22 +5,27 @@ module Redminerb
   module Cli
     # Thor's 'issues' subcommand definition
     class Issues < Thor
-      default_command :show
+      default_command :list
   
       desc 'list', 'Shows open issues in our Redmine'
       option :offset, aliases: :o
       option :limit, aliases: :l
-      def list
-        Redminerb.init!
-        Redminerb::Issues.list(options).each do |issue|
-          puts "[#{issue.id}] ".blue + issue.subject.green
+      def list(issue_id = nil)
+        if issue_id
+          show(issue_id)
+        else
+          Redminerb.init!
+          Redminerb::Issues.list(options).each do |issue|
+            puts "[#{issue.id}] ".blue + issue.subject.green
+          end
         end
       end
 
-      desc 'show <number>', 'Shows the data of the issue which id match with #<number>'
+      desc 'show <number>', 'Shows an issue (SHORTCUT: "redminerb issues <number>")'
+      option :template, aliases: :t
       def show(issue_id)
         Redminerb.init!
-        puts Redminerb::Template.render(:issue, Redminerb::Issues.read(issue_id))
+        puts Redminerb::Template.render(:issue, Redminerb::Issues.read(issue_id), options)
       end
     end
   end

data/lib/redminerb/cli/users.rb

@@ -12,11 +12,15 @@ module Redminerb
       option :name,   aliases: [:q, '--query'], banner: '<FILTER>'
       option :offset, aliases: :o
       option :limit, aliases: :l
-      def list
-        Redminerb.init!
-        fields = options.delete(:fields) || 'id:login:mail'
-        Redminerb::Users.list(options).each do |user|
-          puts fields.split(':').map {|f| user.send(f)}.join("\t").green
+      def list(user_id = nil)
+        if user_id
+          show user_id
+        else
+          Redminerb.init!
+          fields = options.delete(:fields) || 'id:login:mail'
+          Redminerb::Users.list(options).each do |user|
+            puts fields.split(':').map {|f| user.send(f)}.join("\t").green
+          end
         end
       end
   
@@ -39,10 +43,11 @@ module Redminerb
         end
       end
 
-      desc 'show <id>', 'Shows the info of the user with id <id>.'
+      desc 'show <id>', 'Shows a user (SHORTCUT: "redminerb users <id>").'
+      option :template, aliases: :t
       def show(user_id)
         Redminerb.init!
-        puts Redminerb::Template.render(:user, Redminerb::Users.read(user_id))
+        puts Redminerb::Template.render(:user, Redminerb::Users.read(user_id), options)
       end
     end
   end

data/lib/redminerb/client.rb

@@ -7,8 +7,6 @@ module Redminerb
   class Client
     class UnprocessableEntity < StandardError; end
 
-    attr_reader :connection
-
     def initialize(cfg)
       @connection = Faraday.new(url: cfg.url) do |f|
         f.adapter Faraday.default_adapter

data/lib/redminerb/template.rb

@@ -31,10 +31,10 @@ module Redminerb
       #   Redminerb::Template.render(:issue, {subject: 'Fixme!'})
       #
 
-      def render(name, resource)
+      def render(name, resource, options = {})
         b = binding
         b.local_variable_set(name, resource)
-        template = _read_template(name)
+        template = _read_template(options['template'] || name)
         ERB.new(template).result(b)
       end
 

data/lib/redminerb/version.rb

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

data/lib/redminerb.rb

@@ -43,14 +43,45 @@ module Redminerb
   end
 
   def config
+    init_required!
     @config
   end
 
   def client
+    init_required!
     @client
   end
 
+  # ASCII old-school box's part output functions
   def separator
-    @separator ||= ('─' * TermInfo.screen_columns).green
+    @separator ||= '─' * TermInfo.screen_columns
+  end
+  
+  def top
+    '┌' + separator[0..-3] + '┐'
+  end
+  
+  def middle
+    '├' + separator[0..-3] + '┤'
+  end
+  
+  def bottom
+    '└' + separator[0..-3] + '┘'
+  end
+  
+  def max_length
+    TermInfo.screen_columns - 4
+  end
+  
+  def line(string)
+    if string.size > max_length
+      "│ #{string[0..(max_length - 1)]} │\n#{line(string[max_length..-1])}" if string
+    else
+      "│ #{string}#{extra_espaces_for(string)} │"
+    end
+  end
+  
+  def extra_espaces_for(string)
+    ' ' * (max_length - string.size)
   end
 end

data/redminerb.gemspec

@@ -41,6 +41,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'climate_control' # fake ENV
+  spec.add_development_dependency 'minitest-vcr'
+  spec.add_development_dependency 'webmock'
 
   spec.add_development_dependency 'rubocop'
 

data/templates/issue.erb

@@ -1,12 +1,12 @@
-<%= Redminerb.separator %>
+<%= Redminerb.separator.green %>
 <%= "[#{issue.tracker.name}]".blue + "[#{issue.project.name}:##{issue.id}]".green %> <%= issue.subject %>
-<%= Redminerb.separator %>
+<%= Redminerb.separator.green %>
 Author:      <%= issue.author.name.red %>
 Assigned to: <%= issue.assigned_to.name.red %>
 Status:      <%= issue.status.name.red %>
 Priority:    <%= issue.priority.name.red %>
-<%= Redminerb.separator %>
+<%= Redminerb.separator.green %>
 <%= issue.description %>
-<%= Redminerb.separator %>
+<%= Redminerb.separator.green %>
 <%= Redminerb.config.url + "issues/#{issue.id}" %>
-<%= Redminerb.separator %>
+<%= Redminerb.separator.green %>

data/templates/issue_boxie.erb

@@ -0,0 +1,18 @@
+<%= 
+  [
+    Redminerb.top,
+    Redminerb.line("[#{issue.tracker.name}][#{issue.project.name}:##{issue.id}] #{issue.subject}"),
+    Redminerb.middle,
+    [
+      "Author: #{issue.author.name}",
+      "Assigned to: #{issue.assigned_to.name}",
+      "Status: #{issue.status.name}",
+      "Priority: #{issue.priority.name}"
+    ].map{|l| Redminerb.line l },
+    Redminerb.middle,
+    issue.description.lines.map {|raw_line| Redminerb.line raw_line.chomp },
+    Redminerb.middle,
+    Redminerb.line(Redminerb.config.url + "issues/#{issue.id}"),
+    Redminerb.bottom
+  ].flatten.join.green
+%>

data/templates/user.erb

@@ -1,13 +1,13 @@
-<%= Redminerb.separator %>
+<%= Redminerb.separator.green %>
   <%= user.login.upcase.green %>
-<%= Redminerb.separator %>
-   <%= "Id: #{user.id}".blue %>
+<%= Redminerb.separator.green %>
+   Id: <%= "##{user.id}" %>
    * Firstname: <%= user.firstname.red %>
    * Lastname:  <%= user.lastname.red %>
    * Login:     <%= user.login.red %>
    * E-Mail:    <%= user.mail.red %>
-<%= Redminerb.separator %>
+<%= Redminerb.separator.green %>
    * Created:    <%= user.created_on.blue %>
    * Last login: <%= user.last_login_on.blue %>
    * Status:     <%= user.status.to_s.blue %>
-<%= Redminerb.separator %>
+<%= Redminerb.separator.green %>

data/templates/user_in_a_box.erb

@@ -0,0 +1,21 @@
+<%= 
+  [
+    Redminerb.top,
+    Redminerb.line(user.login.upcase),
+    Redminerb.middle,
+    [
+      "* Id: #{user.id}",
+      "* Firstname:  #{user.firstname}",
+      "* Lastname:   #{user.lastname}",
+      "* Login:      #{user.login}",
+      "* E-Mail:     #{user.mail}"
+    ].map{|l| Redminerb.line l },
+    Redminerb.middle,
+    [
+      "* Created:    #{user.created_on}",
+      "* Last login: #{user.last_login_on}",
+      "* Status:     #{user.status}"
+    ].map{|l| Redminerb.line l },
+    Redminerb.bottom
+  ].join.green
+%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redminerb
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Fernando Garcia Samblas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-28 00:00:00.000000000 Z
+date: 2015-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -136,6 +136,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -198,7 +226,9 @@ files:
 - lib/redminerb/version.rb
 - redminerb.gemspec
 - templates/issue.erb
+- templates/issue_boxie.erb
 - templates/user.erb
+- templates/user_in_a_box.erb
 homepage: http://github.com/nando/redminerb
 licenses: []
 metadata: {}