redmine_plugin_asset_pipeline 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8607b90303306caa6ac05676ebedc9c1c93e151
+  data.tar.gz: b3784b2ab2839be947d3c33107beeac1e3911b9a
+SHA512:
+  metadata.gz: 7c13d262d64bec8c75d3825756bb14bb8200b539fd1e95488f1cf1cb91fce1e12ecd40e59e90f8b6c343646182763337bb7012bbae33a8002b5a575a334e90b1
+  data.tar.gz: 7d017dc542ca8ca39d787c739f264363d00212fc1bcb8f37d15f05bb9b65a7bb174794ee8bb16ec76094f5a16ea5073ebf42716b4d0f265c71f9ead7c871b9d4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec :path => File.dirname(__FILE__)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 jbbarth
+
+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,57 @@
+Redmine Asset Pipeline plugin
+=============================
+
+This plugin adds asset pipeline awesomeness to Redmine and Redmine plugins.
+
+For who ?
+---------
+This plugin only targets plugin developers. You shouldn't try to install this without a deep understanding of the benefits and the way to make it work.
+
+Why ?
+-----
+By default, Redmine made the deliberate (and wise) choice to disable the asset pipeline for core development. Enabling the asset pipeline by default would bring a thousand questions for people who are not in Rails and have a deep understanding of how it works. See [some of my thoughs about this here](http://www.redmine.org/issues/11445#note-9).
+
+Having the asset pipeline enabled would be interesting though if you have a lot of plugins, which is my case. The average page on my biggest Redmine instance downloads ~50 js/css individual files, which is a big waste in terms of performance and bandwith. I'd really like them to be minified and bundled into one application.js and one application.css.
+
+How ?
+-----
+The plugin reconfigures asset-related options in the main app.
+
+Features of this plugin
+-----------------------
+* serve main app assets with the asset pipeline : disabled
+* serve plugin assets with the asset pipeline : disabled for standard plugins ; enabled for redmine gems
+* minify assets in the pipeline : disabled
+* concatenate all plugin assets into one js + one css : ok for redmine gems
+* concatenate core resources with the ones of plugins : abandonned (useless)
+* compile coffeescript/sass/etc. : not tested yet
+
+Known problems
+--------------
+* for now it seems that all_plugins.js loads everything already loaded in all_core.js, resulting in unecessary wasted bandwith.
+
+Installation
+------------
+
+This plugin is only compatible with Redmine 2.1.0+. It is distributed as a ruby gem.
+
+Add this line to your redmine's Gemfile.local:
+
+    gem 'redmine_asset_pipeline'
+
+And then execute:
+
+    $ bundle install
+
+Then restart your Redmine instance.
+
+Note that general instructions for plugins [here](http://www.redmine.org/wiki/redmine/Plugins) don't apply here.
+
+Contributing
+------------
+
+1. Fork it
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/init.rb

@@ -0,0 +1,10 @@
+require 'redmine'
+require 'redmine_plugin_asset_pipeline/version'
+
+Redmine::Plugin.register :redmine_plugin_asset_pipeline do
+  name 'Redmine Plugin Asset Pipeline plugin'
+  description 'This plugin adds asset pipeline support for redmine plugins'
+  url 'https://github.com/Tab10id/redmine_plugin_asset_pipeline'
+  version RedminePluginAssetPipeline::VERSION
+  requires_redmine :version_or_higher => '2.1.0'
+end

data/lib/generators/redmine_pipeline/private_assets_initializer/private_assets_initializer_generator.rb

@@ -0,0 +1,9 @@
+module RedminePipeline
+  class PrivateAssetsInitializerGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+    def copy_initializer_file
+      file_name = '35-patch_assets_mirror'
+      copy_file "#{file_name}.rb", "config/initializers/#{file_name}.rb"
+    end
+  end
+end

data/lib/generators/redmine_pipeline/private_assets_initializer/templates/35-patch_assets_mirror.rb

@@ -0,0 +1,6 @@
+Rails.configuration.before_configuration do
+  require_dependency 'redmine_plugin_asset_pipeline/plugin_patch'
+  unless Redmine::Plugin.included_modules.include? RedminePluginAssetPipeline::PluginPatch
+    Redmine::Plugin.send(:include, RedminePluginAssetPipeline::PluginPatch)
+  end
+end

data/lib/redmine_plugin_asset_pipeline.rb

@@ -0,0 +1,44 @@
+require 'redmine_plugin_asset_pipeline/version'
+
+module RedminePluginAssetPipeline
+  # Run the classic redmine plugin initializer after rails boot
+  class Plugin < ::Rails::Engine
+    config.after_initialize do
+      require File.expand_path('../../init', __FILE__)
+    end
+
+    #asset pipeline configuration
+    #enable asset pipeline before sprockets boots
+    initializer 'redmine.asset_pipeline', :before => 'sprockets.environment' do
+      RedmineApp::Application.configure do
+        config.assets.enabled = true
+        config.assets.paths << "#{config.root}/private/plugin_assets"
+        config.assets.precompile += %w(*/stylesheets/*.css */javascripts/*.js)
+
+        # Custom settings. Edit configs of your application
+        # See: http://guides.rubyonrails.org/asset_pipeline.html
+        #
+        # Redmine save all assets in root of public =(
+        # If you need to change that value
+        # manually move assets in public directory and edit it
+        # config.assets.prefix = ''
+        #
+        # config.assets.js_compressor = :uglifier
+        #
+        # config.assets.debug = true
+        #
+        # config.assets.compile = true
+        #
+        # config.assets.compress = false
+      end
+    end
+
+    config.after_initialize do
+      require_dependency 'redmine_plugin_asset_pipeline/application_helper_patch'
+      unless ApplicationHelper.included_modules.include? RedminePluginAssetPipeline::ApplicationHelperPatch
+        ApplicationHelper.send(:include, RedminePluginAssetPipeline::ApplicationHelperPatch)
+      end
+    end
+
+  end
+end

data/lib/redmine_plugin_asset_pipeline/application_helper_patch.rb

@@ -0,0 +1,54 @@
+module RedminePluginAssetPipeline
+  module ApplicationHelperPatch
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+      base.class_eval do
+        def assets_prefix
+          Rails.application.config.assets.prefix.gsub(/^\//, '')
+        end
+
+        def stylesheet_link_tag(*sources)
+          options = sources.last.is_a?(Hash) ? sources.pop : {}
+          plugin = options.delete(:plugin)
+          sources = sources.map do |source|
+            if plugin
+              "/#{[assets_prefix, "#{plugin}/stylesheets/#{source}"].join('/')}"
+            elsif current_theme && current_theme.stylesheets.include?(source)
+              current_theme.stylesheet_path(source)
+            else
+              "/#{[assets_prefix, "stylesheets/#{source}"].join('/')}"
+            end
+          end
+          super *sources, options
+        end
+
+        def javascript_include_tag(*sources)
+          options = sources.last.is_a?(Hash) ? sources.pop : {}
+          plugin = options.delete(:plugin)
+          sources = sources.map do |source|
+            if plugin
+              "/#{[assets_prefix, "#{plugin}/javascripts/#{source}"].join('/')}"
+            else
+              "/#{[assets_prefix, "javascripts/#{source}"].join('/')}"
+            end
+          end
+          super *sources, options
+        end
+
+        def image_tag(source, options={})
+          if plugin = options.delete(:plugin)
+            source = "/#{[assets_prefix, "#{plugin}/images/#{source}"].join('/')}"
+          elsif current_theme && current_theme.images.include?(source)
+            source = current_theme.image_path(source)
+          else
+            source = "/#{[assets_prefix, "images/#{source}"].join('/')}"
+          end
+          super source, options
+        end
+      end
+    end
+
+    module InstanceMethods
+    end
+  end
+end

data/lib/redmine_plugin_asset_pipeline/plugin_patch.rb

@@ -0,0 +1,70 @@
+# Patch for copy plugin assets sources to private directory
+module RedminePluginAssetPipeline
+  module PluginPatch
+    def self.included(base)
+
+      base.extend(ClassMethods)
+      base.send(:include, InstanceMethods)
+
+      base.class_eval do
+        class << self
+          cattr_accessor :private_directory
+          self.private_directory = File.join(Rails.root, 'private', 'plugin_assets')
+        end
+
+        alias_method :mirror_assets_to_public, :mirror_assets
+        alias_method :mirror_assets, :mirror_assets_to_private
+      end
+    end
+
+    module ClassMethods
+    end
+
+    module InstanceMethods
+      def private_directory
+        File.join(self.class.private_directory, id.to_s)
+      end
+
+      def mirror_assets_to_private
+        source = assets_directory
+        destination = private_directory
+        return unless File.directory?(source)
+
+        source_files = Dir[source + "/**/*"]
+        source_dirs = source_files.select { |d| File.directory?(d) }
+        source_files -= source_dirs
+
+        unless source_files.empty?
+          base_target_dir = File.join(destination, File.dirname(source_files.first).gsub(source, ''))
+          begin
+            FileUtils.mkdir_p(base_target_dir)
+          rescue Exception => e
+            raise "Could not create directory #{base_target_dir}: " + e.message
+          end
+        end
+
+        source_dirs.each do |dir|
+          # strip down these paths so we have simple, relative paths we can
+          # add to the destination
+          target_dir = File.join(destination, dir.gsub(source, ''))
+          begin
+            FileUtils.mkdir_p(target_dir)
+          rescue Exception => e
+            raise "Could not create directory #{target_dir}: " + e.message
+          end
+        end
+
+        source_files.each do |file|
+          begin
+            target = File.join(destination, file.gsub(source, ''))
+            unless File.exist?(target) && FileUtils.identical?(file, target)
+              FileUtils.cp(file, target)
+            end
+          rescue Exception => e
+            raise "Could not copy #{file} to #{target}: " + e.message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/redmine_plugin_asset_pipeline/version.rb

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

data/redmine_plugin_asset_pipeline.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redmine_plugin_asset_pipeline/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redmine_plugin_asset_pipeline"
+  spec.version       = RedminePluginAssetPipeline::VERSION
+  spec.authors       = ["Tab10id"]
+  spec.email         = ["tabloidmeister@gmail.com"]
+  spec.description   = %q{Asset pipeline for Redmine}
+  spec.summary       = %q{Asset pipeline for Redmine}
+  spec.homepage      = "https://github.com/Tab10id/redmine_plugin_asset_pipeline"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+# Load the normal Rails helper
+require File.expand_path(File.dirname(__FILE__) + '/../../../test/test_helper')

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: redmine_plugin_asset_pipeline
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tab10id
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Asset pipeline for Redmine
+email:
+- tabloidmeister@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- init.rb
+- lib/generators/redmine_pipeline/private_assets_initializer/private_assets_initializer_generator.rb
+- lib/generators/redmine_pipeline/private_assets_initializer/templates/35-patch_assets_mirror.rb
+- lib/redmine_plugin_asset_pipeline.rb
+- lib/redmine_plugin_asset_pipeline/application_helper_patch.rb
+- lib/redmine_plugin_asset_pipeline/plugin_patch.rb
+- lib/redmine_plugin_asset_pipeline/version.rb
+- redmine_plugin_asset_pipeline.gemspec
+- test/test_helper.rb
+homepage: https://github.com/Tab10id/redmine_plugin_asset_pipeline
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Asset pipeline for Redmine
+test_files:
+- test/test_helper.rb
+has_rdoc: