redmine_plugin_asset_pipeline 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f69a414b7ef365a32b7a3a817bc5af4db18a61ca
-  data.tar.gz: c3e4d2fcca90345cdce76bbcbde18b374cfb8b81
+  metadata.gz: ee102d458d074760cad0bf032033b4b63880d3b5
+  data.tar.gz: c6d21a56a11b8976f810d3ff2e714dfbfb2bc5f0
 SHA512:
-  metadata.gz: 4cb2b4951b8bcfc39666ab1c23ad660d1a63094df00b93b29b6f804ab1399627460923ba90e0b5f6c1846c15762a6de0cc9f33c33d5c4a6e3dc76108be54952d
-  data.tar.gz: 7ad912d8ba8b3613872f649e0b4115967615a0f99aeb840c89215ff1b48da47806017cd305f222a7fd2a9a801787e4b9135e2a9c3e684b6fddda1a3d7c0676b7
+  metadata.gz: 403e98dab4c715b8d8183e2356191a10a822f6a6e8fc181e1905adec677a0c7264bf637d61508c6f359d264fe72b58ee4d269fe66d555e05738271254c450b2e
+  data.tar.gz: 6758219cad88f5d3b54f91a4e2352a7ba9258a5df309aa2afb08bfaa42ef41a01454c1367facb098ca33bd85612f07c511be5880dbc10a430d4d6fb7cab6cb53

data/README.md

@@ -1,41 +1,52 @@
-Redmine Asset Pipeline plugin
+Redmine Plugin Asset Pipeline plugin
 =============================
 
-This plugin adds asset pipeline awesomeness to Redmine and Redmine plugins.
+This plugin adds asset pipeline features 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.
+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).
+By default, Redmine not support asset pipeline feature (many rewrites of standard rails
+functionality).
 
-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.
+Having the asset pipeline enabled would be interesting though if you have a lot of plugins
+or when you want to have possibility for normal usage different preprocessors like sass,
+less, CoffeeScript.
 
 How ?
 -----
-The plugin reconfigures asset-related options in the main app.
+The plugin try to restore normal pipeline functionality in Redmine and add some features
+for comfortable Redmine plugins development.
 
 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
+* serve main app assets with the asset pipeline
+* serve plugin assets with the asset pipeline
+* ability for concatenate .css and .js assets in one file (just create `_common_application.(js/css)`
+  in your plugin and use sprocket directives in those files, than create aggregating css/js in one
+  of your plugin and use sprocket directive require_redmine_plugins on it)
+  e.g. `//= require_redmine_plugins javascripts` for js
+* minify assets in the pipeline
+* support digest option of asset pipeline config
+* in development environment you have assets src directory than have symlinks to the plugin
+  directories, so you don't need run `redmine:plugins:assets` or restart server every time
+  when you edit asset in your plugin
 
 Known problems
 --------------
-* for now it seems that all_plugins.js loads everything already loaded in all_core.js, resulting in unecessary wasted bandwith.
+* Redmine themes are not processed through the pipeline
+* Plugin code looks a little ugly
 
 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:
+Add this line to your redmine's Gemfile:
 
     gem 'redmine_plugin_asset_pipeline'
 
@@ -43,6 +54,27 @@ And then execute:
 
     $ bundle install
 
+Configure assets in your application (core `Redmine config/application.rb`)
+Unfortunately you can't configure pipeline in gem or in redmine plugin, many gems may work
+wrong if pipeline functionality enabled not in application (according to order of gem loading).
+
+You can set `config.assets.paths` to public directory of Redmine but that can provoke some
+problems with preprocessors (if you precompile assets).
+Also problems may occur if you leave standard Redmine assets in root of public (possible
+conflicts with rails routes).
+
+Our recommendations:
+
+* Move redmine assets to directory `private/assets` (simple create it in root of Redmine)
+* Run `rails generate redmine_pipeline:private_assets_initializer` (that create initializer
+  `35-patch_assets_mirror`, that patch Plugin class of Redmine for copy plugin assets to
+  private directory)
+* Unfortunately file from previous step shouldn't work well without modification of standard
+  Redmine initializer. For fix it move all lines started on: `Redmine::Plugin.load` from `30-redmine.rb`
+  to new initializer goes after `35-patch_assets_mirror`. For example `36-redmine_plugin_init`
+* Set `config.assets.prefix` to avoid a potential conflicts
+* Fix standard Redmine \*.css files (some paths in css hardcoded to the public root)
+
 Then restart your Redmine instance.
 
 Note that general instructions for plugins [here](http://www.redmine.org/wiki/redmine/Plugins) don't apply here.

data/lib/redmine_plugin_asset_pipeline/plugin_patch.rb

@@ -28,13 +28,20 @@ module RedminePluginAssetPipeline
       def mirror_assets_to_private
         source = assets_directory
         destination = private_directory
+
+        unless File.exist?(self.class.private_directory)
+          FileUtils.mkdir_p(self.class.private_directory)
+        end
+
         if File.exist?(destination)
           FileUtils.rm_rf(destination)
         end
         return unless File.directory?(source)
 
         if RedminePluginAssetPipeline.config.use_ln
-          FileUtils.ln_s(source, destination)
+          if File.exist?(source)
+            FileUtils.ln_s(source, destination)
+          end
         else
           source_files = Dir[source + "/**/*"]
           source_dirs = source_files.select { |d| File.directory?(d) }

data/lib/redmine_plugin_asset_pipeline/version.rb

@@ -1,3 +1,3 @@
 module RedminePluginAssetPipeline
-  VERSION = '0.0.12'
+  VERSION = '0.0.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine_plugin_asset_pipeline
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Tab10id
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2014-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler