RubyGems - web_resource_bundler - Versions diffs - 0.0.13 - Mend

web_resource_bundler 0.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (56) hide show

data/.bundle/config +2 -0
data/.gitignore +21 -0
data/Gemfile +2 -0
data/Gemfile.lock +10 -0
data/README +118 -0
data/Rakefile +29 -0
data/VERSION +1 -0
data/lib/web_resource_bundler.rb +195 -0
data/lib/web_resource_bundler/content_management/block_data.rb +57 -0
data/lib/web_resource_bundler/content_management/block_parser.rb +63 -0
data/lib/web_resource_bundler/content_management/css_url_rewriter.rb +23 -0
data/lib/web_resource_bundler/content_management/resource_file.rb +35 -0
data/lib/web_resource_bundler/exceptions.rb +26 -0
data/lib/web_resource_bundler/file_manager.rb +30 -0
data/lib/web_resource_bundler/filters.rb +9 -0
data/lib/web_resource_bundler/filters/base_filter.rb +28 -0
data/lib/web_resource_bundler/filters/bundle_filter.rb +58 -0
data/lib/web_resource_bundler/filters/bundle_filter/resource_packager.rb +49 -0
data/lib/web_resource_bundler/filters/cdn_filter.rb +48 -0
data/lib/web_resource_bundler/filters/image_encode_filter.rb +56 -0
data/lib/web_resource_bundler/filters/image_encode_filter/css_generator.rb +85 -0
data/lib/web_resource_bundler/filters/image_encode_filter/image_data.rb +51 -0
data/lib/web_resource_bundler/rails_app_helpers.rb +65 -0
data/lib/web_resource_bundler/settings.rb +46 -0
data/lib/web_resource_bundler/web_resource_bundler_init.rb +17 -0
data/spec/public/foo.css +4 -0
data/spec/public/images/good.jpg +0 -0
data/spec/public/images/logo.jpg +0 -0
data/spec/public/images/sdfo.jpg +0 -0
data/spec/public/images/too_big_image.jpg +0 -0
data/spec/public/marketing.js +14 -0
data/spec/public/salog20.js +6 -0
data/spec/public/sample.css +6 -0
data/spec/public/seal.js +10 -0
data/spec/public/set_cookies.js +8 -0
data/spec/public/styles/boo.css +4 -0
data/spec/public/styles/for_import.css +7 -0
data/spec/public/temp.css +1 -0
data/spec/public/test.css +2 -0
data/spec/sample_block_helper.rb +81 -0
data/spec/spec_helper.rb +82 -0
data/spec/web_resource_bundler/content_management/block_data_spec.rb +33 -0
data/spec/web_resource_bundler/content_management/block_parser_spec.rb +100 -0
data/spec/web_resource_bundler/content_management/css_url_rewriter_spec.rb +27 -0
data/spec/web_resource_bundler/content_management/resource_file_spec.rb +37 -0
data/spec/web_resource_bundler/file_manager_spec.rb +60 -0
data/spec/web_resource_bundler/filters/bundle_filter/filter_spec.rb +40 -0
data/spec/web_resource_bundler/filters/bundle_filter/resource_packager_spec.rb +41 -0
data/spec/web_resource_bundler/filters/cdn_filter_spec.rb +76 -0
data/spec/web_resource_bundler/filters/image_encode_filter/css_generator_spec.rb +104 -0
data/spec/web_resource_bundler/filters/image_encode_filter/filter_spec.rb +73 -0
data/spec/web_resource_bundler/filters/image_encode_filter/image_data_spec.rb +53 -0
data/spec/web_resource_bundler/settings_spec.rb +45 -0
data/spec/web_resource_bundler/web_resource_bundler_spec.rb +90 -0
data/web_resource_bundler.gemspec +111 -0
metadata +146 -0

data/.bundle/config ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ ---
2	+ BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.gitignore ADDED Viewed

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+## TEXTMATE
+*.tmproj
+tmtags
+## EMACS
+*~
+\#*
+.\#*
+## VIM
+*.swp
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+## PROJECT::SPECIFIC

data/Gemfile ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ source "http://rubygems.org"
2	+ gem "rspec", '1.3.1'

data/Gemfile.lock ADDED Viewed

@@ -0,0 +1,10 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rspec (1.3.1)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  rspec (= 1.3.1)

data/README ADDED Viewed

@@ -0,0 +1,118 @@
+=================== WebResourceBundler gem README ============================
+Content:
+1. Purpose
+2. Functional description
+3. Installation
+4. Usage
+=================== 1. Purpose ===============================================
+The main purpose of WebResourceBundler gem is to minimize request & response
+round-trips count. This could be done by bundling particular resource (css or js) in
+one file. Encoding images in base64 and putting then in css directly.
+=================== 2. Functional description ================================
+WebResourceBundler parse your head html block, finding all css and js resource
+files.
+It can bundle resource of particular type in one single file. Base64 filter
+encodes images in base64 putting them in css directly. Separate files for IE
+and other browsers created. Conditional comments (like <!--[if IE 6]>) also
+supported. You can use external image hosts to server images in css:
+cdn filter can rewrite image urls for you. Resulted filename is a md5(filenames.sort)
+=================== 3. Installation ==========================================
+gem install web_resource_bundler
+It's pretty easy, yeah?
+=================== 4. Usage =================================================
+Firstly you should create your settings file in config dir.
+You can set separate settings for each environment
+-------------- config/web_resource_bundler.yml --------------
+development:
+  :base64_filter:
+    :use: true
+    :max_image_size: 23
+    :protocol: http
+    :domain: localhost:3000
+  :bundle_filter:
+    :use: true
+  :cdn_filter:
+    :use: true
+    :http_hosts: ['http://localhost:3000']
+    :https_hosts: ['https://localhost:3000']
+------------------------------------------------------------
+Then you should create initializer file in
+/path/to/your/rails_app/config/initializers/ directory
+Let's say it will be web_resource_bundler_init.rb
+Then you should put content like this in it.
+------------- config/initializers/web_resource_bundler_init.rb ---------------
+require 'web_resource_bundler'
+require 'yaml'
+root_dir = Rails.root #or RAILS_ROOT if you are using older rails version than 3
+environment = Rails.env #or RAILS_ENV in case rails <= 2.3
+settings = { }
+settings_file_path = File.join(root_dir, 'config', 'web_resource_bundler.yml')
+if File.exist?(settings_file_path)
+  settings_file = File.open(settings_file_path)
+  all_settings = YAML::load(settings_file)
+  if all_settings[environment]
+    settings = all_settings[environment]
+    settings[:resource_dir] = File.join(root_dir, 'public')
+  end
+end
+WebResourceBundler::Bundler.instance.set_settings(settings)
+ActionView::Base.send(:include, WebResourceBundler::RailsAppHelpers)
+------------------------------------------------------------------------------
+Now in your view files you can call web_resource_bundler_process helper like this:
+<head>
+<% web_resource_bundler_process do %>
+  <%= stylesheet_link_tag :scaffold %>
+  <%= javascript_include_tag :defaults %>
+  <link type="text/css" rel="stylesheet" href="/stylesheets/somestyle.css"/>
+  <%=yield :head %>
+	<!--[if lte IE 7]>
+	   <link type="text/css" rel="stylesheet" href="/stylesheets/ie7fix.css"/>
+	   <link type="text/css" rel="stylesheet" href="/stylesheets/pngfix.css"/>
+	<![endif]-->
+<% end %>
+</head>
+Notice:
+For Rails < 3
+you should use <% web_resource_bundler_process do %>
+And For Rails >= 3
+use <%= web_resource_bundler_process do %>
+And as result you'll have
+<link href="/cache/base64_style_d880a502addaa493b889c0970616430b.css?1290594873" media="screen" rel="stylesheet" type="text/css" />
+<script src="/cache/script_275d311037da40e9c9b8c919a8c08b55.js?1290594873" type="text/javascript"></script>
+<!--[if lte IE 7]>
+   <link href="/cache/base64_ie_style_d880a502addaa493b889c0970616430b.css?1290594873" media="screen" rel="stylesheet" type="text/css" />
+<![endif]-->
+<!--[if lte IE 7]>
+   <link type="text/css" rel="stylesheet" href="/cache/base64_style_ad801w02addaa493b889c0970616430b"/>
+<![endif]-->
+!!!
+Don't forget to clean your cache directory after deploy to clean old bundles
+To disable bundling and see raw results add no_bundler param
+mysite.com/?no_bundler=1

data/Rakefile ADDED Viewed

@@ -0,0 +1,29 @@
+require 'rake'
+require 'spec/rake/spectask'
+require 'rubygems'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "web_resource_bundler"
+    gem.summary = %Q{lib for css and js content bundling and managment}
+    gem.description = %Q{this lib could bundle you css/js files in single file, encode images in base64, rewrite images urls to your cdn hosts}
+    gem.email = "anotheroneman@yahoo.com"
+    gem.homepage = "http://github.com/gregolsen/web-bundler"
+    gem.authors = ["gregolsen"]
+    gem.add_development_dependency "rspec", "1.3.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+namespace :spec do
+  desc "Run specs with RCov"
+    Spec::Rake::SpecTask.new('rcov' ) do |t|
+      t.spec_files = FileList['spec/**/*_spec.rb' ]
+      t.rcov = true
+    end
+end

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 0.0.13

data/lib/web_resource_bundler.rb ADDED Viewed

@@ -0,0 +1,195 @@
+$:.unshift File.join(File.dirname(__FILE__), 'web_resource_bundler')
+require 'content_management/block_parser'
+require 'content_management/block_data'
+require 'content_management/css_url_rewriter'
+require 'content_management/resource_file'
+require 'settings'
+require 'file_manager'
+require 'logger'
+require 'filters'
+require 'exceptions'
+require 'rails_app_helpers'
+require 'yaml'
+require 'singleton'
+module WebResourceBundler
+  class Bundler
+    include Singleton
+    attr_reader :settings, :settings_correct, :filters
+    @@logger = nil
+    def self.logger
+      @@logger
+    end
+    def initialize
+      @filters = {}
+      @settings = nil
+      @file_manager = nil
+      @parser = BlockParser.new
+      @@logger = nil
+      @settings_correct = false
+    end
+    #could be used also when settings are different on each request
+    def set_settings(settings)
+      #all methods user call from rails should not raise any exception
+      begin
+        @settings = Settings.new settings
+        if @settings.resource_dir
+          @@logger = create_logger(@settings)
+          unless @settings.cache_dir
+            @settings.cache_dir = 'cache'
+          end
+          #if file manager is nil it should be created
+          unless @file_manager
+            @file_manager = FileManager.new(@settings.resource_dir, @settings.cache_dir)
+          else
+            #if manager already exist than its settings chaged
+            @file_manager.resource_dir, @file_manager.cache_dir = @settings.resource_dir, @settings.cache_dir
+          end
+          set_filters(@settings, @file_manager)
+          #used to determine if bundler in correct state and could be used
+          @settings_correct = true
+        end
+      rescue Exception => e
+        @@logger.error("Incorrect settings initialization, #{settings}\n#{e.to_s}") if @@logger
+        @settings_correct = false
+      end
+    end
+    #main method to process html text block
+    def process(block)
+      begin
+        filters = filters_array
+        #parsing html text block, creating BlockData instance
+        block_data = @parser.parse(block)
+        #if filters set and no bundle files exists we should process block data
+        unless filters.empty? or bundle_upto_date?(block_data)
+          #reading files content and populating block_data
+          read_resources!(block_data)
+          #applying filters to block_data
+          block_data.apply_filters(filters)
+          #writing resulted files with filtered content on disk
+          write_files_on_disk(block_data)
+          @@logger.info("files written on disk")
+          return block_data
+        end
+        #bundle up to date, returning existing block with modified file names
+        block_data.apply_filters(filters)
+        return block_data
+      rescue Exceptions::WebResourceBundlerError => e
+        @@logger.error(e.to_s)
+        return nil
+      rescue Exception => e
+        @@logger.error(e.backtrace.join("\n") + "Unknown error occured: " + e.to_s)
+        return nil
+      end
+    end
+    private
+    #giving filters array in right sequence (bundle filter should be first)
+    def filters_array
+      filters = []
+      %w{bundle_filter base64_filter cdn_filter}.each do |key|
+        filters << @filters[key.to_sym] if @filters[key.to_sym]
+      end
+      filters
+    end
+    #creates filters or change their settings
+    def set_filters(settings, file_manager)
+      #common settings same for all filters
+      common_sets = {
+        :resource_dir => settings.resource_dir,
+        :cache_dir => settings.cache_dir
+      }
+      #used to craete filters
+      filters_data = {
+        :bundle_filter => 'BundleFilter',
+        :base64_filter => 'ImageEncodeFilter',
+        :cdn_filter => 'CdnFilter'
+      }
+      filters_data.each_pair do |key, filter_class|
+        if settings[key] and settings[key][:use]
+          filter_settings = settings[key].merge(common_sets)
+          if @filters[key]
+            @filters[key].set_settings(filter_settings)
+          else
+            #creating filter instance with settings
+            @filters[key] = eval("Filters::" + filter_class + "::Filter").new(filter_settings, file_manager)
+          end
+        else
+          #this filter turned off in settings so should be deleted
+          @filters.delete(key)
+        end
+      end
+      @filters
+    end
+    def create_logger(settings)
+      begin
+        #creating default log file in rails log directory called web_resource_bundler.log
+        unless settings.log_path
+          log_dir = File.expand_path('../log', settings.resource_dir)
+          log_name = 'web_resource_bundler.log'
+          settings[:log_path] = File.join(log_dir, log_name)
+          Dir.mkdir(log_dir) unless File.exist?(log_dir)
+        end
+        file = File.open(settings.log_path, File::WRONLY | File::APPEND | File::CREAT)
+        logger = Logger.new(file)
+      rescue Exception => e
+        logger = Logger.new(STDOUT)
+        logger.error("Can't create log file, check log path: #{settings.log_path}\n#{e.to_s}")
+      end
+      logger
+    end
+    #checks if resulted files exist for current @filters and block data
+    def bundle_upto_date?(block_data)
+      #we don't want to change original parsed block data
+      #so just making a clone, using overriden clone method in BlockData
+      block_data_copy = block_data.clone
+      #modifying clone to obtain resulted files
+      #apply_filters will just compute resulted file paths
+      #because block_data isn't populated with files content yet
+      block_data_copy.apply_filters(filters_array)
+      #cheking if resulted files exist on disk in cache folder
+      block_data_copy.files.each do |file|
+        return false unless File.exist?(File.join(@settings.resource_dir, file.path))
+      end
+      true
+    end
+    #reads block data resource files content from disk and populating block_data
+    def read_resources!(block_data)
+      #iterating through each resource files
+      block_data.files.each do |file|
+        content = @file_manager.get_content(file.path)
+        #rewriting url to absolute if content is css
+        WebResourceBundler::CssUrlRewriter.rewrite_content_urls!(file.path, content) if file.type[:ext] == 'css'
+        file.content = content
+      end
+      #making the same for each child blocks, recursively
+      block_data.child_blocks.each do |block|
+        read_resources!(block)
+      end
+    end
+    #recursive method to write all resulted files on disk
+    def write_files_on_disk(block_data)
+      @file_manager.create_cache_dir
+      block_data.files.each do |file|
+        File.open(File.join(@settings.resource_dir, file.path), "w") do |f|
+          f.print(file.content)
+        end
+      end
+      block_data.child_blocks.each do |block|
+        write_files_on_disk(block)
+      end
+    end
+  end
+end

data/lib/web_resource_bundler/content_management/block_data.rb ADDED Viewed

@@ -0,0 +1,57 @@
+module WebResourceBundler
+  class BlockData
+    attr_accessor :files, :inline_block, :condition, :child_blocks
+    def initialize(condition = "")
+      @inline_block = ""
+      @files = []
+      @condition = condition
+      @child_blocks = []
+    end
+    def styles
+      @files.select do |f|
+        [WebResourceBundler::ResourceFileType::CSS,
+          WebResourceBundler::ResourceFileType::IE_CSS].include?(f.type)
+      end
+    end
+    def scripts
+      @files.select {|f| f.type == WebResourceBundler::ResourceFileType::JS}
+    end
+    def clone
+      clon = self.dup
+      clon.files = self.files.map {|f| f.clone}
+      if clon.child_blocks.size > 0
+        clon.child_blocks = self.child_blocks.map do |block|
+          block.clone
+        end
+      else
+        clon.child_blocks = []
+      end
+      clon
+    end
+    def self.all_childs(block_data)
+      result = []
+      result << block_data
+      block_data.child_blocks.each do |child|
+        result += BlockData.all_childs(child)
+      end
+      return result
+    end
+    def apply_filters(filters)
+      unless filters.empty?
+        filters.each do |filter|
+          items = BlockData.all_childs(self)
+          items.each do |block_data|
+            filter.apply!(block_data)
+          end
+        end
+      end
+    end
+  end
+end