redmine-user_wiki_macro 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d785be13e4ddf9dde9e20a2c5bf4bca0475abb8d
+  data.tar.gz: 30d551125580685eed45b91b90175415877610bf
+SHA512:
+  metadata.gz: 81a96675e5c8d682baf9955b5d6f04f90abd9e0f545f39a845ead1b7da7c9d4d8705f92456d31f370583160915485cf8f835ebee7aeba77ffb156c7ad6227b23
+  data.tar.gz: c54045ef95d8cbbb26993e7f659bb8bbeab33b336af2de22477ccf803f288cccec5897498703ac1a6e0a2962970c2a30a8655a6c4046d7c1a9ce90413deb2148

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,8 @@
+StringLiterals:
+  EnforcedStyle: "double_quotes"
+
+Style/FileName:
+  Enabled: false
+
+Documentation:
+  Enabled: false

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,39 @@
+# redmine-user_wiki_macro
+
+Adds a `{{user(login_name)}}` macro to the Redmine's wiki engine
+
+## Installation
+
+Ensure you have a `Gemfile.local` file in your Redmine installation. Add to your `Gemfile.local`:
+
+```ruby
+gem "redmine-user_wiki_macro"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Restart the Redmine application
+
+## Usage
+
+No further steps needed
+
+## 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/[my-github-username]/redmine-user_wiki_macro/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,8 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:rubocop]

data/assets/stylesheets/user_wiki_macro.css

@@ -0,0 +1,9 @@
+span.user-wiki-macro-user img{
+  padding: 2px;
+  border: 1px solid #d5d5d5;
+  background: #fff;
+}
+
+span.user-wiki-macro-user span{
+  padding-left: 5px;
+}

data/lib/redmine-user_wiki_macro.rb

@@ -0,0 +1,8 @@
+require "user_wiki_macro/version"
+require "user_wiki_macro/infos"
+require "user_wiki_macro/engine"
+
+# Redmine plugin to support HTTP basic authentication based
+# authentication mechanism
+module UserWikiMacro
+end

data/lib/user_wiki_macro/engine.rb

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

data/lib/user_wiki_macro/hooks.rb

@@ -0,0 +1,7 @@
+module UserWikiMacro
+  class ApplicationHooks < Redmine::Hook::ViewListener
+    def view_layouts_base_html_head(_context)
+      stylesheet_link_tag "user_wiki_macro", plugin: "user_wiki_macro"
+    end
+  end
+end

data/lib/user_wiki_macro/infos.rb

@@ -0,0 +1,11 @@
+module UserWikiMacro
+  module Infos
+    NAME        = "redmine-user_wiki_macro"
+    DESCRIPTION = "Adds a {{user(login_name)}} macro to Redmine's wiki engine"
+    LICENSE     = "MIT"
+    URL         = "https://github.com/neopoly/redmine-user_wiki_macro"
+    AUTHORS     = {
+      "Jonas Thiel" => "jt@neopoly.de"
+    }.freeze
+  end
+end

data/lib/user_wiki_macro/macros.rb

@@ -0,0 +1,34 @@
+module UserWikiMacro
+  USER_SIZES = {
+    "default" => 24,
+    "small"   => 14,
+    "large"   => 50
+  }.freeze
+
+  Redmine::WikiFormatting::Macros.register do
+    desc "Creates link to a user page including an avatar. Examples:\n\n" \
+         "{{user(the_user_login)}}\n" \
+         "{{user(the_user_login, size=small)}}"
+    macro :user do |_obj, args|
+      args, options = extract_macro_options(args, :size)
+      return nil unless args.first.present?
+      username = args.first.strip
+      user     = User.find_by_login(username)
+      return nil unless user
+
+      content_tag :span, class: "user-wiki-macro user-wiki-macro-user" do
+        label = avatar(user, size: UserWikiMacro.determine_size(options))
+        label += content_tag(:span, user.login)
+        link_to label, user_path(user)
+      end
+    end
+  end
+
+  def self.determine_size(options)
+    if options[:size]
+      USER_SIZES[options[:size]] || options[:size]
+    else
+      USER_SIZES["default"]
+    end
+  end
+end

data/lib/user_wiki_macro/redmine_plugin.rb

@@ -0,0 +1,35 @@
+module UserWikiMacro
+  # Registers this gems a Redmine plugin and applies the needed patches
+  class RedminePlugin
+    include UserWikiMacro::Infos
+
+    def initialize
+      register!
+      boot!
+      mirror_assets!
+    end
+
+    private
+
+    def register!
+      @plugin = Redmine::Plugin.register :user_wiki_macro do
+        name NAME
+        author AUTHORS.keys.join(", ")
+        description DESCRIPTION
+        version VERSION
+        url URL
+        author_url URL
+        directory Engine.root
+      end
+    end
+
+    def boot!
+      require "user_wiki_macro/hooks"
+      require "user_wiki_macro/macros"
+    end
+
+    def mirror_assets!
+      @plugin.mirror_assets
+    end
+  end
+end

data/lib/user_wiki_macro/version.rb

@@ -0,0 +1,3 @@
+module UserWikiMacro
+  VERSION = "0.0.1"
+end

data/redmine-user_wiki_macro.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "user_wiki_macro/version"
+require "user_wiki_macro/infos"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redmine-user_wiki_macro"
+  spec.version       = UserWikiMacro::VERSION
+  spec.authors       = UserWikiMacro::Infos::AUTHORS.keys
+  spec.email         = UserWikiMacro::Infos::AUTHORS.values
+  spec.summary       = UserWikiMacro::Infos::DESCRIPTION
+  spec.description   = UserWikiMacro::Infos::DESCRIPTION
+  spec.homepage      = UserWikiMacro::Infos::URL
+  spec.license       = UserWikiMacro::Infos::LICENSE
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(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 "rubocop"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: redmine-user_wiki_macro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonas Thiel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-18 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: 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: Adds a {{user(login_name)}} macro to Redmine's wiki engine
+email:
+- jt@neopoly.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/stylesheets/user_wiki_macro.css
+- lib/redmine-user_wiki_macro.rb
+- lib/user_wiki_macro/engine.rb
+- lib/user_wiki_macro/hooks.rb
+- lib/user_wiki_macro/infos.rb
+- lib/user_wiki_macro/macros.rb
+- lib/user_wiki_macro/redmine_plugin.rb
+- lib/user_wiki_macro/version.rb
+- redmine-user_wiki_macro.gemspec
+homepage: https://github.com/neopoly/redmine-user_wiki_macro
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Adds a {{user(login_name)}} macro to Redmine's wiki engine
+test_files: []
+has_rdoc: