redmine-per_user_status 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 237f6295d21bc48cac6eb8b2e3c705907a0e2b6a
+  data.tar.gz: aa97ea8027717538f437b7d6437656ed022e6f35
+SHA512:
+  metadata.gz: 5b67ac46e412c2d1be344ebcc98a14f5c2c83e5d14cefea6fbc342f6f60b8834b095d6c4aea40b9e59dde01366c288767948dd775c221e5ac8a2b478502ef5f2
+  data.tar.gz: ecd92717ee48d4df2b39187dc8a65d4f95b76e168588d445b08f4c4cd6f249fe6722ce1ed78c2aec9afd1f316e0f19d63b2f69bac752c287d7273ef4532ef306

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+pkg
+.yardoc
+doc

data/.rubocop.yml

@@ -0,0 +1,12 @@
+StringLiterals:
+  EnforcedStyle: "double_quotes"
+
+Style/FileName:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Exclude:
+    - rakelib/rubocop.rake

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in candy_check.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jonas Thiel
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+[github]: https://github.com/neopoly/redmine-per_user_status
+[doc]: http://rubydoc.info/github/neopoly/redmine-per_user_status/master/file/README.md
+[gem]: https://rubygems.org/gems/redmine-per_user_status
+[gem-badge]: https://img.shields.io/gem/v/redmine-per_user_status.svg
+[inchpages]: https://inch-ci.org/github/neopoly/redmine-per_user_status
+[inchpages-badge]: https://inch-ci.org/github/neopoly/redmine-per_user_status.svg?branch=master&style=flat
+
+# redmine-per_user_status
+
+[![Gem Version][gem-badge]][gem]
+[![Inline docs][inchpages-badge]][inchpages]
+
+[Gem][gem] |
+[Source][github] |
+[Documentation][doc]
+
+
+Allows users to set a custom status which will be displayed next to their names when choosing as assignee.
+
+## Installation
+
+Ensure you have a `Gemfile.local` file in your Redmine installation. Add to your `Gemfile.local`:
+
+```ruby
+gem "redmine-per_user_status"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+This plugin ships with a migration. To update the database run:
+
+```
+$ rake redmine:plugins:migrate
+```
+
+Restart the Redmine application
+
+## Usage
+
+1. Install the gem and require the gem
+2. Switch to "My account" and set a custom status (Screenshot 1)
+3. Or change a user's status using the administration panel
+4. The custom user status will be displayed next to the full names
+
+**Screenshot: Status next to assignee**
+
+![Screenshot Issue](https://neopoly.github.io/redmine-per_user_status/images/screenshot1.png)
+
+**Screenshot: My account**
+
+![Screenshot MyAccount](https://neopoly.github.io/redmine-per_user_status/images/screenshot2.png)
+
+**Screenshot: Administration**
+
+![Screenshot Administration](https://neopoly.github.io/redmine-per_user_status/images/screenshot3.png)
+
+## Testing
+
+No automatic tests, sir! But this Redmine plugin is used in production.
+
+## TODO
+
+* Find a way to test this Redmine plugin
+
+## Contributing
+
+1. Fork it ( https://github.com/neopoly/redmine-per_user_status/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+task default: [:rubocop]

data/assets/stylesheets/per_user_status.css

@@ -0,0 +1,3 @@
+#user_custom_status {
+  width: 90%;
+}

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  per_user_status_form_custom_status: "Custom status"
+  per_user_status_form_hint: "E.g. 'Vacation 2015-03-23'"

data/db/migrate/20150505162200_add_custom_status_to_users.rb

@@ -0,0 +1,9 @@
+class AddCustomStatusToUsers < ActiveRecord::Migration
+  def self.up
+    add_column :users, :custom_status, :string
+  end
+
+  def self.down
+    remove_column :users, :custom_status
+  end
+end

data/lib/per_user_status/engine.rb

@@ -0,0 +1,10 @@
+require "per_user_status/redmine_plugin"
+
+module PerUserStatus
+  # Simple engine to support the Redmine plugin
+  class Engine < ::Rails::Engine
+    config.to_prepare do
+      RedminePlugin.new
+    end
+  end
+end

data/lib/per_user_status/hooks.rb

@@ -0,0 +1,68 @@
+module PerUserStatus
+  # Add custom CSS file to layout and includes an additional input field into
+  # the account settings and the user's administration pages
+  class Hooks < Redmine::Hook::ViewListener
+    # Inject stylesheet tags
+    # @param _context [Hash] ignored
+    def view_layouts_base_html_head(_context)
+      stylesheet_link_tag "per_user_status", plugin: "per_user_status"
+    end
+
+    # Inject input field into "My account" form
+    # @param context [Hash] hook context
+    def view_my_account(context)
+      extend_form(context)
+    end
+
+    # Inject input field into "Edit user" form
+    # @param context [Hash] hook context
+    def view_users_form(context)
+      extend_form(context)
+    end
+
+    private
+
+    def extend_form(context)
+      view_context = context[:controller].view_context
+      form = context[:form]
+      FormExtender.new(view_context, form).to_html
+    end
+
+    # @private
+    class FormExtender
+      attr_reader :view_context, :f
+
+      def initialize(view_context, f)
+        @view_context = view_context
+        @f = f
+      end
+
+      def to_html
+        content_tag(:p) do
+          input + hint
+        end
+      end
+
+      private
+
+      def hint
+        content_tag :span, class: "hint" do
+          l(:per_user_status_form_hint)
+        end
+      end
+
+      def input
+        label = l(:per_user_status_form_custom_status)
+        f.text_field :custom_status, label: label
+      end
+
+      def content_tag(*args, &block)
+        view_context.content_tag(*args, &block)
+      end
+
+      def l(*args)
+        view_context.l(*args)
+      end
+    end
+  end
+end

data/lib/per_user_status/infos.rb

@@ -0,0 +1,13 @@
+module PerUserStatus
+  # Shared plugin description
+  module Infos
+    NAME        = "redmine-per_user_status"
+    DESCRIPTION = "Allows users to set a custom status which will be " \
+                  "displayed next to their names when choosing as assignee"
+    LICENSE     = "MIT"
+    URL         = "https://github.com/neopoly/redmine-per_user_status"
+    AUTHORS     = {
+      "Jonas Thiel" => "jt@neopoly.de"
+    }.freeze
+  end
+end

data/lib/per_user_status/patches.rb

@@ -0,0 +1,17 @@
+require "per_user_status/patches/user_patch"
+
+module PerUserStatus
+  # This module holds all patches of a default Redmine application
+  module Patches
+    # Apply all patches
+    def self.apply!
+      apply_to(::User, UserPatch)
+    end
+
+    private
+
+    def self.apply_to(target, mod)
+      target.send(:include, mod)
+    end
+  end
+end

data/lib/per_user_status/patches/user_patch.rb

@@ -0,0 +1,26 @@
+module PerUserStatus
+  module Patches
+    # Patches the User#name method to allow injecting the
+    # current user status
+    module UserPatch
+      extend ActiveSupport::Concern
+
+      included do
+        alias_method_chain :name, :custom_status
+        safe_attributes :custom_status
+      end
+
+      # Appends the custom user status to the base user name
+      # @param formatter The formatter to use for the name
+      # @see User#name
+      def name_with_custom_status(formatter = nil)
+        default = name_without_custom_status(formatter)
+        if custom_status.present?
+          "#{default} (#{custom_status})"
+        else
+          default
+        end
+      end
+    end
+  end
+end

data/lib/per_user_status/redmine_plugin.rb

@@ -0,0 +1,53 @@
+require "per_user_status/patches"
+
+module PerUserStatus
+  # Registers this gems a Redmine plugin and applies the needed patches
+  class RedminePlugin
+    include PerUserStatus::Infos
+
+    def initialize
+      register!
+      patch_migration_directory!
+      boot!
+      mirror_assets!
+    end
+
+    # As this plugin is realized as a gem Redmine won't detect the
+    # migration automatically.
+    # @return [String] Absolute path to "db/migrate"
+    def self.migration_directory
+      File.expand_path("../../../db/migrate", __FILE__)
+    end
+
+    private
+
+    def register!
+      @plugin = Redmine::Plugin.register :per_user_status do
+        name NAME
+        author AUTHORS.keys.join(", ")
+        description DESCRIPTION
+        version VERSION
+        url URL
+        author_url URL
+        directory Engine.root
+      end
+    end
+
+    def boot!
+      require "per_user_status/hooks"
+      Patches.apply!
+    end
+
+    def patch_migration_directory!
+      @plugin.instance_eval do
+        def migration_directory
+          ::PerUserStatus::RedminePlugin.migration_directory
+        end
+      end
+    end
+
+    def mirror_assets!
+      @plugin.mirror_assets
+    end
+  end
+end

data/lib/per_user_status/version.rb

@@ -0,0 +1,3 @@
+module PerUserStatus
+  VERSION = "0.0.2"
+end

data/lib/redmine-per_user_status.rb

@@ -0,0 +1,7 @@
+require "per_user_status/version"
+require "per_user_status/infos"
+require "per_user_status/engine"
+
+# Redmine plugin to support a custom status per user
+module PerUserStatus
+end

data/rakelib/rubocop.rake

@@ -0,0 +1,18 @@
+begin
+  require "rubocop/rake_task"
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << "--display-cop-names"
+  end
+
+  namespace :rubocop do
+    desc "Generate a configuration file acting as a TODO list."
+    task :auto_gen_config do
+      exec "bundle exec rubocop --auto-gen-config"
+    end
+  end
+
+rescue LoadError
+end

data/redmine-per_user_status.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "per_user_status/version"
+require "per_user_status/infos"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redmine-per_user_status"
+  spec.version       = PerUserStatus::VERSION
+  spec.authors       = PerUserStatus::Infos::AUTHORS.keys
+  spec.email         = PerUserStatus::Infos::AUTHORS.values
+  spec.summary       = PerUserStatus::Infos::DESCRIPTION
+  spec.description   = PerUserStatus::Infos::DESCRIPTION
+  spec.homepage      = PerUserStatus::Infos::URL
+  spec.license       = PerUserStatus::Infos::LICENSE
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)\/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", "~> 4.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "inch"
+  spec.add_development_dependency "rubocop"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: redmine-per_user_status
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jonas Thiel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: inch
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows users to set a custom status which will be displayed next to their
+  names when choosing as assignee
+email:
+- jt@neopoly.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/stylesheets/per_user_status.css
+- config/locales/en.yml
+- db/migrate/20150505162200_add_custom_status_to_users.rb
+- lib/per_user_status/engine.rb
+- lib/per_user_status/hooks.rb
+- lib/per_user_status/infos.rb
+- lib/per_user_status/patches.rb
+- lib/per_user_status/patches/user_patch.rb
+- lib/per_user_status/redmine_plugin.rb
+- lib/per_user_status/version.rb
+- lib/redmine-per_user_status.rb
+- rakelib/rubocop.rake
+- redmine-per_user_status.gemspec
+homepage: https://github.com/neopoly/redmine-per_user_status
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Allows users to set a custom status which will be displayed next to their
+  names when choosing as assignee
+test_files: []
+has_rdoc: